2 goredo -- djb's redo implementation on pure Go
3 Copyright (C) 2020-2022 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/>.
39 "go.cypherpunks.ru/recfile"
40 "go.cypherpunks.ru/tai64n/v2"
41 "golang.org/x/sys/unix"
45 EnvDepFd = "REDO_DEP_FD"
46 EnvDirPrefix = "REDO_DIRPREFIX"
47 EnvDepCwd = "REDO_DEP_CWD"
48 EnvBuildUUID = "REDO_BUILD_UUID"
49 EnvStderrPrefix = "REDO_STDERR_PREFIX"
50 EnvTrace = "REDO_TRACE"
51 EnvStderrKeep = "REDO_LOGS"
52 EnvStderrSilent = "REDO_SILENT"
53 EnvNoSync = "REDO_NO_SYNC"
54 EnvStopIfMod = "REDO_STOP_IF_MODIFIED"
61 LogRecSuffix = ".log-rec"
75 flagStderrSilent *bool
79 RunningProcs = map[int]*os.Process{}
80 RunningProcsM sync.Mutex
82 Err1WasTouched = errors.New("$1 was explicitly touched")
87 if !(cmdName == CmdNameRedo || cmdName == CmdNameRedoIfchange) {
90 flagTrace = flag.Bool("x", false, "trace (sh -x) current targets")
91 flagTraceAll = flag.Bool("xx", false,
92 fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
93 flagStderrKeep = flag.Bool("k", false,
94 fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
95 flagStderrSilent = flag.Bool("s", false,
96 fmt.Sprintf("silent, do not print job's stderr (%s=1)", EnvStderrSilent))
99 type RunError struct {
107 func (e *RunError) Name() string {
112 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
114 if e.Finished == nil {
117 return fmt.Sprintf("%s (%.3fs)", name, e.Finished.Sub(*e.Started).Seconds())
120 func (e RunError) Error() string {
121 return fmt.Sprintf("%s: %s", e.Name(), e.Err)
124 func mkdirs(pth string) error {
125 if _, err := os.Stat(pth); err == nil {
128 return os.MkdirAll(pth, os.FileMode(0777))
131 func isModified(cwd, redoDir, tgt string) (bool, *Inode, error) {
132 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
134 if os.IsNotExist(err) {
135 return false, nil, nil
137 return false, nil, err
140 r := recfile.NewReader(fdDep)
143 m, err := r.NextMap()
145 if errors.Is(err, io.EOF) {
148 return false, nil, err
150 if m["Type"] != DepTypeIfchange || m["Target"] != tgt {
153 fd, err := os.Open(path.Join(cwd, tgt))
155 if os.IsNotExist(err) {
156 return false, nil, nil
158 return false, nil, err
160 ourInode, err = inodeFromFile(fd)
163 return false, nil, err
165 theirInode, err := inodeFromRec(m)
167 return false, nil, err
169 if !ourInode.Equals(theirInode) {
170 return true, ourInode, nil
174 return false, ourInode, nil
177 func syncDir(dir string) error {
178 fd, err := os.Open(dir)
187 func runScript(tgtOrig string, errs chan error, traced bool) error {
188 cwd, tgt := cwdAndTgt(tgtOrig)
189 redoDir := path.Join(cwd, RedoDir)
190 if err := mkdirs(redoDir); err != nil {
191 return TgtError{tgtOrig, err}
195 fdLock, err := os.OpenFile(
196 path.Join(redoDir, tgt+LockSuffix),
197 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
201 return TgtError{tgtOrig, err}
203 flock := unix.Flock_t{
205 Whence: io.SeekStart,
207 lockRelease := func() {
208 tracef(CLock, "LOCK_UN: %s", fdLock.Name())
209 flock.Type = unix.F_UNLCK
210 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
215 tracef(CLock, "LOCK_NB: %s", fdLock.Name())
217 // Waiting for job completion, already taken by someone else
218 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
219 if uintptr(err.(syscall.Errno)) != uintptr(unix.EAGAIN) {
221 return TgtError{tgtOrig, err}
224 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_GETLK, &flock); err != nil {
227 tracef(CDebug, "waiting: %s (pid=%d)", tgtOrig, flock.Pid)
229 if _, err = FdStatus.Write([]byte{StatusWait}); err != nil {
235 tracef(CLock, "LOCK_EX: %s", fdLock.Name())
236 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLKW, &flock); err != nil {
240 tracef(CDebug, "waiting done: %s", tgtOrig)
242 if _, err = FdStatus.Write([]byte{StatusWaited}); err != nil {
247 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
249 if os.IsNotExist(err) {
250 err = errors.New("was not built: no .rec")
255 depInfo, err = depRead(fdDep)
259 if depInfo.build != BuildUUID {
260 err = errors.New("was not built: build differs")
264 err = TgtError{tgtOrig, err}
271 // Check if target is not modified externally
272 modified, inodePrev, err := isModified(cwd, redoDir, tgt)
275 return TgtError{tgtOrig, err}
280 return fmt.Errorf("%s externally modified", tgtOrig)
282 tracef(CWarn, "%s externally modified: not redoing", tgtOrig)
289 // Start preparing .rec
290 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
293 return TgtError{tgtOrig, err}
295 fdDepPath := fdDep.Name()
299 os.Remove(fdDep.Name())
301 if _, err = recfile.NewWriter(fdDep).WriteFields(
302 recfile.Field{Name: "Build", Value: BuildUUID},
305 return TgtError{tgtOrig, err}
309 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
312 return TgtError{tgtOrig, err}
316 return TgtError{tgtOrig, errors.New("no .do found")}
319 // Determine basename and DIRPREFIX
320 doFileRelPath := doFile
321 ents := strings.Split(cwd, "/")
322 ents = ents[len(ents)-upLevels:]
323 dirPrefix := path.Join(ents...)
325 for i := 0; i < upLevels; i++ {
326 cwd = path.Join(cwd, "..")
327 doFileRelPath = path.Join("..", doFileRelPath)
329 cwd = path.Clean(cwd)
330 doFilePath := path.Join(cwd, doFile)
332 runErr := RunError{Tgt: tgtOrig}
333 if strings.HasPrefix(doFile, "default.") {
334 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
335 runErr.DoFile = doFileRelPath
338 if err = depWrite(fdDep, cwdOrig, doFileRelPath); err != nil {
340 return TgtError{tgtOrig, err}
343 tracef(CWait, "%s", runErr.Name())
345 // Prepare command line
348 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
350 args = make([]string, 0, 3)
353 if traced || TracedAll {
354 args = append(args, "-ex")
356 args = append(args, "-e")
358 args = append(args, doFile)
361 // Temporary file for stdout
362 fdStdout, err := tempfile(cwdOrig, tgt)
365 return TgtError{tgtOrig, err}
367 stdoutPath := fdStdout.Name()
369 tmpPath := stdoutPath + ".3" // and for $3
370 tmpPathRel, err := filepath.Rel(cwd, tmpPath)
376 path.Join(dirPrefix, tgt),
377 path.Join(dirPrefix, basename),
381 cmd := exec.Command(cmdName, args...)
383 // cmd.Stdin reads from /dev/null by default
384 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
385 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
386 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
388 childStderrPrefix := tempsuffix()
389 cmd.Env = append(cmd.Env, fmt.Sprintf(
390 "%s=%s", EnvStderrPrefix, childStderrPrefix,
394 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
395 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
397 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
398 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
402 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
404 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
405 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
410 var fdStderr *os.File
412 fdStderr, err = os.OpenFile(
413 path.Join(redoDir, tgt+LogSuffix),
414 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
419 return TgtError{tgtOrig, err}
422 shCtx := fmt.Sprintf(
423 "sh: %s: %s %s cwd:%s dirprefix:%s",
424 tgtOrig, cmdName, args, cwd, dirPrefix,
426 tracef(CDebug, "%s", shCtx)
430 jsToken := jsAcquire(shCtx)
433 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
435 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
436 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
437 makeFlags := fmt.Sprintf(
438 "%s %s%d,%d", MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
440 makeFlags = strings.Trim(makeFlags, " ")
441 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", MakeFlagsName, makeFlags))
443 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
447 if _, err = FdStatus.Write([]byte{StatusRun}); err != nil {
452 var finished time.Time
453 var exitErr *exec.ExitError
454 started := time.Now()
455 runErr.Started = &started
456 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
462 cmd.Stdout = fdStdout
463 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
469 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
470 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
472 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
475 jsRelease(shCtx, jsToken)
480 logRecPath := path.Join(redoDir, tgt+LogRecSuffix)
481 if fdStderr, err = os.OpenFile(
483 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
486 fields := []recfile.Field{
487 {Name: "Build", Value: BuildUUID},
488 {Name: "PPID", Value: strconv.Itoa(os.Getpid())},
489 {Name: "Cwd", Value: cwd},
491 if cmd.Process != nil {
492 fields = append(fields, recfile.Field{
493 Name: "PID", Value: strconv.Itoa(cmd.Process.Pid),
496 ts := new(tai64n.TAI64N)
498 fields = append(fields,
499 recfile.Field{Name: "Started", Value: tai64n.Encode(ts[:])},
501 ts.FromTime(finished)
502 fields = append(fields,
503 recfile.Field{Name: "Finished", Value: tai64n.Encode(ts[:])})
504 fields = append(fields, recfile.Field{
506 Value: strconv.FormatInt(finished.Sub(started).Nanoseconds(), 10),
508 fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
509 for _, arg := range args {
510 fields = append(fields, recfile.Field{Name: "Arg", Value: arg})
512 for _, env := range cmd.Env {
513 fields = append(fields, recfile.Field{Name: "Env", Value: env})
516 fields = append(fields, recfile.Field{
518 Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
521 w := bufio.NewWriter(fdStderr)
524 fdDep, err := os.Open(fdDepPath)
528 depInfo, err = depRead(fdDep)
533 for _, dep := range depInfo.ifchanges {
534 fields = append(fields, recfile.Field{
536 Value: dep["Target"],
539 _, err = recfile.NewWriter(w).WriteFields(fields...)
547 os.Remove(logRecPath)
551 log.Println("can not open", logRecPath, ":", err)
555 os.Remove(fdDep.Name())
556 os.Remove(fdStdout.Name())
558 os.Remove(fdLock.Name())
560 if _, err = FdStatus.Write([]byte{StatusDone}); err != nil {
566 stderr, err := cmd.StderrPipe()
580 RunningProcs[cmd.Process.Pid] = cmd.Process
581 RunningProcsM.Unlock()
582 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
583 tracef(CDebug, "%s runs %s", tgtOrig, pid)
585 stderrTerm := make(chan struct{})
587 scanner := bufio.NewScanner(stderr)
589 ts := new(tai64n.TAI64N)
591 line = scanner.Text()
592 if strings.HasPrefix(line, childStderrPrefix) {
593 line = line[len(childStderrPrefix):]
594 os.Stderr.WriteString(StderrPrefix + line + "\n")
598 ts.FromTime(time.Now())
600 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
607 tracef(CNone, "%s", line)
609 tracef(CNone, "%s %s", pid, line)
615 // Wait for job completion
619 delete(RunningProcs, cmd.Process.Pid)
620 RunningProcsM.Unlock()
621 finished = time.Now()
622 runErr.Finished = &finished
624 exitErr = err.(*exec.ExitError)
631 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
632 if inodePrev == nil {
634 runErr.Err = Err1WasTouched
638 inode, err := inodeFromFile(fd)
645 if !inode.Equals(inodePrev) {
646 runErr.Err = Err1WasTouched
652 if inodePrev != nil {
653 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
654 inode, err := inodeFromFile(fd)
656 if err == nil && !inode.Equals(inodePrev) {
657 runErr.Err = Err1WasTouched
664 // Does it produce both stdout and tmp?
665 fiStdout, err := os.Stat(fdStdout.Name())
672 _, err = os.Stat(tmpPath)
674 if fiStdout.Size() > 0 {
675 runErr.Err = errors.New("created both tmp and stdout")
680 } else if !os.IsNotExist(err) {
686 // Determine what file we must process at last
689 fd, err = os.Open(tmpPath)
694 } else if fiStdout.Size() > 0 {
698 // Do we need to ifcreate it, or ifchange with renaming?
700 os.Remove(path.Join(cwdOrig, tgt))
701 err = ifcreate(fdDep, tgt)
712 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
717 err = syncDir(cwdOrig)
722 err = depWrite(fdDep, cwdOrig, tgt)
735 fdDepPath = path.Join(redoDir, tgt+DepSuffix)
736 err = os.Rename(fdDep.Name(), fdDepPath)
741 err = syncDir(redoDir)
747 // Post-commit .rec sanitizing
749 if fdDepR, err := os.Open(fdDepPath); err == nil {
750 depInfo, err := depRead(fdDepR)
755 ifchangeSeen := make(map[string]struct{}, len(depInfo.ifchanges))
756 for _, dep := range depInfo.ifchanges {
757 ifchangeSeen[dep["Target"]] = struct{}{}
759 for _, dep := range depInfo.ifcreates {
760 if _, exists := ifchangeSeen[dep]; exists {
761 tracef(CWarn, "simultaneous ifcreate and ifchange records: %s", tgt)
773 func isOkRun(err error) bool {
778 if errors.As(err, &runErr) && runErr.Err == nil {
779 tracef(CRedo, "%s", runErr.Name())
782 tracef(CErr, "%s", err)