2 goredo -- djb's redo implementation on pure Go
3 Copyright (C) 2020-2021 Sergey Matveev <stargrave@stargrave.org>
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, version 3 of the License.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
37 "go.cypherpunks.ru/recfile"
38 "go.cypherpunks.ru/tai64n/v2"
39 "golang.org/x/sys/unix"
43 EnvDepFd = "REDO_DEP_FD"
44 EnvDirPrefix = "REDO_DIRPREFIX"
45 EnvDepCwd = "REDO_DEP_CWD"
46 EnvBuildUUID = "REDO_BUILD_UUID"
47 EnvStderrPrefix = "REDO_STDERR_PREFIX"
48 EnvTrace = "REDO_TRACE"
49 EnvStderrKeep = "REDO_LOGS"
50 EnvStderrSilent = "REDO_SILENT"
51 EnvNoSync = "REDO_NO_SYNC"
62 StderrKeep bool = false
63 StderrSilent bool = false
70 flagStderrSilent *bool
77 if !(cmdName == CmdNameRedo || cmdName == CmdNameRedoIfchange) {
80 flagTrace = flag.Bool("x", false, "trace (sh -x) current targets")
81 flagTraceAll = flag.Bool("xx", false,
82 fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
83 flagStderrKeep = flag.Bool("k", false,
84 fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
85 flagStderrSilent = flag.Bool("s", false,
86 fmt.Sprintf("silent, do not print job's stderr (%s=1)", EnvStderrSilent))
97 func (e *RunErr) Name() string {
102 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
104 if e.Finished == nil {
107 return fmt.Sprintf("%s (%.3fs)", name, e.Finished.Sub(*e.Started).Seconds())
110 func (e RunErr) Error() string {
111 return fmt.Sprintf("%s: %s", e.Name(), e.Err)
114 func mkdirs(pth string) error {
115 if _, err := os.Stat(pth); err == nil {
118 return os.MkdirAll(pth, os.FileMode(0777))
121 func isModified(cwd, redoDir, tgt string) (bool, *Inode, error) {
122 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
124 if os.IsNotExist(err) {
125 return false, nil, nil
127 return false, nil, err
130 r := recfile.NewReader(fdDep)
133 m, err := r.NextMap()
138 return false, nil, err
140 if m["Target"] != tgt {
143 fd, err := os.Open(path.Join(cwd, tgt))
145 if os.IsNotExist(err) {
146 return false, nil, nil
148 return false, nil, err
150 ourInode, err = inodeFromFile(fd)
153 return false, nil, err
155 theirInode, err := inodeFromRec(m)
157 return false, nil, err
159 if !ourInode.Equals(theirInode) {
160 return true, ourInode, nil
164 return false, ourInode, nil
167 func syncDir(dir string) error {
168 fd, err := os.Open(dir)
177 func runScript(tgtOrig string, errs chan error, traced bool) error {
178 cwd, tgt := cwdAndTgt(tgtOrig)
179 redoDir := path.Join(cwd, RedoDir)
180 if err := mkdirs(redoDir); err != nil {
181 return TgtErr{tgtOrig, err}
185 fdLock, err := os.OpenFile(
186 path.Join(redoDir, tgt+LockSuffix),
187 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
191 return TgtErr{tgtOrig, err}
193 lockRelease := func() {
194 trace(CLock, "LOCK_UN: %s", fdLock.Name())
195 unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
198 trace(CLock, "LOCK_NB: %s", fdLock.Name())
200 // Waiting for job completion, already taken by someone else
201 if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
202 if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
204 return TgtErr{tgtOrig, err}
207 trace(CDebug, "waiting: %s", tgtOrig)
209 FdStatus.Write([]byte{StatusWait})
213 trace(CLock, "LOCK_EX: %s", fdLock.Name())
214 unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
216 trace(CDebug, "waiting done: %s", tgtOrig)
218 FdStatus.Write([]byte{StatusWaited})
221 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
223 if os.IsNotExist(err) {
224 err = errors.New("was not built: no .rec")
229 depInfo, err = depRead(fdDep)
233 if depInfo.build != BuildUUID {
234 err = errors.New("was not built: build differs")
238 err = TgtErr{tgtOrig, err}
245 // Check if target is not modified externally
246 modified, inodePrev, err := isModified(cwd, redoDir, tgt)
249 return TgtErr{tgtOrig, err}
252 trace(CWarn, "%s externally modified: not redoing", tgtOrig)
260 // Start preparing .rec
261 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
264 return TgtErr{tgtOrig, err}
266 fdDepPath := fdDep.Name()
270 os.Remove(fdDep.Name())
272 if _, err = recfile.NewWriter(fdDep).WriteFields(
273 recfile.Field{Name: "Build", Value: BuildUUID},
276 return TgtErr{tgtOrig, err}
280 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
283 return TgtErr{tgtOrig, err}
287 return TgtErr{tgtOrig, errors.New("no .do found")}
290 // Determine basename and DIRPREFIX
291 doFileRelPath := doFile
292 ents := strings.Split(cwd, "/")
293 ents = ents[len(ents)-upLevels:]
294 dirPrefix := path.Join(ents...)
296 for i := 0; i < upLevels; i++ {
297 cwd = path.Join(cwd, "..")
298 doFileRelPath = path.Join("..", doFileRelPath)
300 cwd = path.Clean(cwd)
301 doFilePath := path.Join(cwd, doFile)
303 runErr := RunErr{Tgt: tgtOrig}
304 if strings.HasPrefix(doFile, "default.") {
305 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
306 runErr.DoFile = doFileRelPath
309 if err = writeDep(fdDep, cwdOrig, doFileRelPath); err != nil {
311 return TgtErr{tgtOrig, err}
314 trace(CWait, "%s", runErr.Name())
316 // Prepare command line
319 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
321 args = make([]string, 0, 3)
324 if traced || TracedAll {
325 args = append(args, "-ex")
327 args = append(args, "-e")
329 args = append(args, doFile)
332 // Temporary file for stdout
333 fdStdout, err := tempfile(cwdOrig, tgt)
336 return TgtErr{tgtOrig, err}
338 stdoutPath := fdStdout.Name()
340 tmpPath := stdoutPath + ".3" // and for $3
341 tmpPathRel, err := filepath.Rel(cwd, tmpPath)
347 path.Join(dirPrefix, tgt),
348 path.Join(dirPrefix, basename),
352 cmd := exec.Command(cmdName, args...)
354 // cmd.Stdin reads from /dev/null by default
355 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
356 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
357 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
359 childStderrPrefix := tempsuffix()
360 cmd.Env = append(cmd.Env, fmt.Sprintf(
361 "%s=%s", EnvStderrPrefix, childStderrPrefix,
365 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
366 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
368 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
369 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
373 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
375 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
376 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
381 var fdStderr *os.File
383 fdStderr, err = os.OpenFile(
384 path.Join(redoDir, tgt+LogSuffix),
385 os.O_WRONLY|os.O_CREATE,
390 return TgtErr{tgtOrig, err}
394 shCtx := fmt.Sprintf(
395 "sh: %s: %s %s cwd:%s dirprefix:%s",
396 tgtOrig, cmdName, args, cwd, dirPrefix,
398 trace(CDebug, "%s", shCtx)
402 jsToken := jsAcquire(shCtx)
405 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
407 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
408 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
409 cmd.Env = append(cmd.Env, fmt.Sprintf(
411 MakeFlagsName, MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
414 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
418 FdStatus.Write([]byte{StatusRun})
421 started := time.Now()
422 runErr.Started = &started
423 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
429 cmd.Stdout = fdStdout
430 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
436 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
437 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
439 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
442 jsRelease(shCtx, jsToken)
449 os.Remove(fdDep.Name())
450 os.Remove(fdStdout.Name())
452 os.Remove(fdLock.Name())
454 FdStatus.Write([]byte{StatusDone})
458 stderr, err := cmd.StderrPipe()
471 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
472 trace(CDebug, "%s runs %s", tgtOrig, pid)
474 stderrTerm := make(chan struct{}, 0)
476 scanner := bufio.NewScanner(stderr)
478 ts := new(tai64n.TAI64N)
480 line = scanner.Text()
481 if strings.HasPrefix(line, childStderrPrefix) {
482 line = line[len(childStderrPrefix):]
483 os.Stderr.WriteString(StderrPrefix + line + "\n")
487 ts.FromTime(time.Now())
489 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
496 trace(CNone, "%s", line)
498 trace(CNone, "%s %s", pid, line)
504 // Wait for job completion
507 finished := time.Now()
508 runErr.Finished = &finished
516 if inodePrev != nil {
517 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
518 inode, err := inodeFromFile(fd)
520 if err == nil && !inode.Equals(inodePrev) {
521 runErr.Err = errors.New("$1 was explicitly touched")
528 // Does it produce both stdout and tmp?
529 fiStdout, err := os.Stat(fdStdout.Name())
536 _, err = os.Stat(tmpPath)
538 if fiStdout.Size() > 0 {
539 runErr.Err = errors.New("created both tmp and stdout")
544 } else if !os.IsNotExist(err) {
550 // Determine what file we must process at last
553 fd, err = os.Open(tmpPath)
558 } else if fiStdout.Size() > 0 {
562 // Do we need to ifcreate it, of ifchange with renaming?
564 os.Remove(path.Join(cwdOrig, tgt))
565 err = ifcreate(fdDep, tgt)
576 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
581 err = syncDir(cwdOrig)
586 err = writeDep(fdDep, cwdOrig, tgt)
599 err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
604 err = syncDir(redoDir)
616 func isOkRun(err error) bool {
620 if err, ok := err.(RunErr); ok && err.Err == nil {
621 trace(CRedo, "%s", err.Name())
624 trace(CErr, "%s", err)