2 goredo -- djb's redo implementation on pure Go
3 Copyright (C) 2020-2023 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/>.
41 "go.cypherpunks.ru/recfile"
42 "go.cypherpunks.ru/tai64n/v2"
43 "golang.org/x/sys/unix"
47 EnvDepFd = "REDO_DEP_FD"
48 EnvDirPrefix = "REDO_DIRPREFIX"
49 EnvDepCwd = "REDO_DEP_CWD"
50 EnvBuildUUID = "REDO_BUILD_UUID"
51 EnvStderrPrefix = "REDO_STDERR_PREFIX"
52 EnvTrace = "REDO_TRACE"
53 EnvStderrKeep = "REDO_LOGS"
54 EnvStderrSilent = "REDO_SILENT"
55 EnvNoSync = "REDO_NO_SYNC"
56 EnvStopIfMod = "REDO_STOP_IF_MODIFIED"
63 LogRecSuffix = ".log-rec"
77 flagStderrSilent *bool
78 flagForcedIfchange *bool
82 RunningProcs = map[int]*os.Process{}
83 RunningProcsM sync.Mutex
85 Err1WasTouched = errors.New("$1 was explicitly touched")
90 if !(cmdName == CmdNameRedo || cmdName == CmdNameRedoIfchange) {
93 flagTrace = flag.Bool("x", false, "trace (sh -x) current targets")
94 flagTraceAll = flag.Bool("xx", false,
95 fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
96 flagStderrKeep = flag.Bool("k", false,
97 fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
98 flagStderrSilent = flag.Bool("s", false,
99 fmt.Sprintf("silent, do not print job's stderr (%s=1)", EnvStderrSilent))
100 flagForcedIfchange = flag.Bool("f", false, "forced redo-ifchange")
103 type RunError struct {
111 func (e *RunError) Name() string {
116 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
118 if e.Finished == nil {
121 return fmt.Sprintf("%s (%.3fs)", name, e.Finished.Sub(*e.Started).Seconds())
124 func (e RunError) Error() string {
125 return fmt.Sprintf("%s: %s", e.Name(), e.Err)
128 func mkdirs(pth string) error {
132 return os.MkdirAll(pth, os.FileMode(0777))
135 func isModified(dep *Dep, tgt *Tgt) (
136 modified bool, ourInode *Inode, hshPrev Hash, err error,
141 for _, ifchange := range dep.ifchanges {
142 if ifchange.tgt.a != tgt.a {
145 ourInode, err = inodeFromFileByPath(tgt.a)
147 if os.IsNotExist(err) {
154 hshPrev = ifchange.Hash()
155 modified = !ourInode.Equals(ifchange.Inode())
161 func syncDir(dir string) error {
162 fd, err := os.Open(dir)
171 func runScript(tgt *Tgt, errs chan error, forced, traced bool) error {
172 tgtH, tgtT := pathSplit(tgt.a)
173 redoDir := path.Join(tgtH, RedoDir)
174 if err := mkdirs(redoDir); err != nil {
175 return TgtError{tgt, ErrLine(err)}
178 shCtx := fmt.Sprintf("sh: %s: cwd:%s", tgt, tgtH)
179 jsToken := jsAcquire(shCtx)
180 jsNeedsRelease := true
183 jsRelease(shCtx, jsToken)
188 fdLock, err := os.OpenFile(
189 path.Join(redoDir, tgtT+LockSuffix),
190 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
194 return TgtError{tgt, ErrLine(err)}
196 flock := unix.Flock_t{
198 Whence: io.SeekStart,
200 lockRelease := func() {
201 tracef(CLock, "LOCK_UN: %s", fdLock.Name())
202 flock.Type = unix.F_UNLCK
203 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
204 log.Fatalln(err, fdLock.Name())
208 tracef(CLock, "LOCK_NB: %s", fdLock.Name())
210 // Waiting for job completion, already taken by someone else
211 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
212 if uintptr(err.(syscall.Errno)) != uintptr(unix.EAGAIN) {
214 return TgtError{tgt, ErrLine(err)}
217 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_GETLK, &flock); err != nil {
218 log.Fatalln(err, fdLock.Name())
220 tracef(CDebug, "waiting: %s (pid=%d)", tgt, flock.Pid)
222 if _, err = FdStatus.Write([]byte{StatusWait}); err != nil {
228 tracef(CLock, "LOCK_EX: %s", fdLock.Name())
230 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLKW, &flock); err != nil {
231 if errors.Is(err, unix.EDEADLK) {
232 time.Sleep(10 * time.Millisecond)
235 log.Fatalln(err, fdLock.Name())
238 tracef(CDebug, "waiting done: %s", tgt)
240 if _, err = FdStatus.Write([]byte{StatusWaited}); err != nil {
244 build, err := depBuildRead(tgt.dep)
246 if build != BuildUUID {
247 err = errors.New("was not built: build differs")
250 if errors.Is(err, fs.ErrNotExist) {
251 err = errors.New("was not built: no .dep")
255 err = TgtError{tgt, err}
262 // It scans the whole .dep file while searching for the single target,
263 // but that one is always located at the very end
264 dep, err := depRead(tgt)
266 if errors.Is(err, fs.ErrNotExist) {
270 return TgtError{tgt, ErrLine(err)}
274 // Check if it was already built in parallel
275 if !forced && dep != nil && dep.build == BuildUUID {
281 // Check if target is not modified externally
282 modified, inodePrev, hshPrev, err := isModified(dep, tgt)
285 return TgtError{tgt, ErrLine(err)}
290 return fmt.Errorf("%s externally modified", tgt)
292 tracef(CWarn, "%s externally modified: not redoing", tgt)
300 // Start preparing .dep
301 fdDep, err := tempfile(redoDir, tgtT+DepSuffix)
304 return TgtError{tgt, ErrLine(err)}
308 fdDepW := bufio.NewWriter(fdDep)
315 os.Remove(fdDep.Name())
318 if err = depBuildWrite(fdDepW, BuildUUID); err != nil {
320 return TgtError{tgt, ErrLine(err)}
328 runErr := RunError{Tgt: tgt}
329 // Determine basename and DIRPREFIX
331 doFileRelPath, upLevels, err := findDo(fdDepW, fdDep.Name(), tgtH, tgtT)
334 return TgtError{tgt, ErrLine(err)}
336 if doFileRelPath == "" {
338 return TgtError{tgt, errors.New("no .do found")}
340 ents := strings.Split(tgtH, "/")
341 ents = ents[len(ents)-upLevels:]
342 dirPrefix = path.Join(ents...)
343 ups := make([]string, 0, upLevels+2)
344 ups = append(ups, tgtH)
345 for i := 0; i < upLevels; i++ {
346 ups = append(ups, "..")
348 ups = append(ups, doFileRelPath)
349 cwd = path.Clean(path.Join(ups[:len(ups)-1]...))
350 doFile = NewTgt(path.Join(ups...))
351 doFileT = path.Base(doFile.a)
352 if strings.HasPrefix(doFileT, "default.") {
353 basename = basename[:len(basename)-(len(doFileT)-len("default.")-len(".do"))-1]
354 runErr.DoFile = doFile.rel
358 if err = depWrite(fdDepW, fdDep.Name(), tgtH, doFile, ""); err != nil {
360 return TgtError{tgt, ErrLine(err)}
362 if err = fdDepW.Flush(); err != nil {
364 return TgtError{tgt, ErrLine(err)}
368 tracef(CWait, "%s", runErr.Name())
370 // Prepare command line
373 if err = unix.Access(doFile.rel, unix.X_OK); err == nil {
375 args = make([]string, 0, 3)
378 if traced || TracedAll {
379 args = append(args, "-ex")
381 args = append(args, "-e")
383 args = append(args, doFileT)
386 // Temporary file for stdout
387 fdStdout, err := tempfile(tgtH, tgtT)
390 return TgtError{tgt, ErrLine(err)}
393 tmpPath := fdStdout.Name() + ".3" // and for $3
394 tmpPathRel := mustRel(cwd, tmpPath)
397 path.Join(dirPrefix, tgtT),
398 path.Join(dirPrefix, basename),
402 "sh: %s: %s %s cwd:%s dirprefix:%s",
403 tgt, cmdName, args, cwd, dirPrefix,
406 cmd := exec.Command(cmdName, args...)
408 // cmd.Stdin reads from /dev/null by default
409 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
410 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
411 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
413 childStderrPrefixRaw := make([]byte, 8)
414 if _, err = io.ReadFull(rand.Reader, childStderrPrefixRaw); err != nil {
417 childStderrPrefix := hex.EncodeToString(childStderrPrefixRaw)
418 cmd.Env = append(cmd.Env, fmt.Sprintf(
419 "%s=%s", EnvStderrPrefix, childStderrPrefix,
423 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
424 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
426 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
427 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
431 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
433 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
434 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
439 var fdStderr *os.File
441 fdStderr, err = os.OpenFile(
442 path.Join(redoDir, tgtT+LogSuffix),
443 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
448 return TgtError{tgt, ErrLine(err)}
451 tracef(CDebug, "%s", shCtx)
453 jsNeedsRelease = false
458 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
460 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
461 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
462 makeFlags := fmt.Sprintf(
463 "%s %s%d,%d", MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
465 makeFlags = strings.Trim(makeFlags, " ")
466 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", MakeFlagsName, makeFlags))
468 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
472 if _, err = FdStatus.Write([]byte{StatusRun}); err != nil {
477 defer jsRelease(shCtx, jsToken)
479 var finished time.Time
480 var exitErr *exec.ExitError
481 started := time.Now()
482 runErr.Started = &started
483 fdStdout, err = os.OpenFile(fdStdout.Name(), os.O_RDWR, os.FileMode(0666))
492 cmd.Stdout = fdStdout
493 fdDep, err = os.OpenFile(fdDep.Name(), os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
505 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
506 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
508 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
517 logRecPath := path.Join(redoDir, tgtT+LogRecSuffix)
518 if fdStderr, err = os.OpenFile(
520 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
523 fields := []recfile.Field{
524 {Name: "Build", Value: BuildUUID.String()},
525 {Name: "PPID", Value: strconv.Itoa(os.Getpid())},
526 {Name: "Cwd", Value: cwd},
528 if cmd.Process != nil {
529 fields = append(fields, recfile.Field{
530 Name: "PID", Value: strconv.Itoa(cmd.Process.Pid),
533 ts := new(tai64n.TAI64N)
535 fields = append(fields,
536 recfile.Field{Name: "Started", Value: tai64n.Encode(ts[:])},
538 ts.FromTime(finished)
539 fields = append(fields,
540 recfile.Field{Name: "Finished", Value: tai64n.Encode(ts[:])})
541 fields = append(fields, recfile.Field{
543 Value: strconv.FormatInt(finished.Sub(started).Nanoseconds(), 10),
545 fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
546 for _, arg := range args {
547 fields = append(fields, recfile.Field{Name: "Arg", Value: arg})
549 for _, env := range cmd.Env {
550 fields = append(fields, recfile.Field{Name: "Env", Value: env})
553 fields = append(fields, recfile.Field{
555 Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
559 w := bufio.NewWriter(fdStderr)
561 var ifchanges []string
562 ifchanges, err = depReadOnlyIfchanges(tgt.dep)
567 for _, ifchange := range ifchanges {
568 fields = append(fields, recfile.Field{
574 _, err = recfile.NewWriter(w).WriteFields(fields...)
579 err = ErrLine(w.Flush())
583 os.Remove(logRecPath)
587 log.Println("can not open", logRecPath, ":", err)
592 os.Remove(fdDep.Name())
594 os.Remove(fdStdout.Name())
597 if _, err = FdStatus.Write([]byte{StatusDone}); err != nil {
603 stderr, err := cmd.StderrPipe()
617 RunningProcs[cmd.Process.Pid] = cmd.Process
618 RunningProcsM.Unlock()
619 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
620 tracef(CDebug, "%s runs %s", tgt, pid)
622 stderrTerm := make(chan struct{})
624 scanner := bufio.NewScanner(stderr)
626 ts := new(tai64n.TAI64N)
628 line = scanner.Text()
629 if strings.HasPrefix(line, childStderrPrefix) {
630 line = line[len(childStderrPrefix):]
632 os.Stderr.WriteString(StderrPrefix + line + "\n")
637 ts.FromTime(time.Now())
638 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
644 tracef(CNone, "%s", line)
646 tracef(CNone, "%s %s", pid, line)
652 // Wait for job completion
656 delete(RunningProcs, cmd.Process.Pid)
657 RunningProcsM.Unlock()
658 finished = time.Now()
659 runErr.Finished = &finished
661 exitErr = err.(*exec.ExitError)
668 if inode, err := inodeFromFileByPath(tgt.a); err == nil {
669 if inodePrev == nil {
670 runErr.Err = Err1WasTouched
674 if !inode.Equals(inodePrev) {
675 runErr.Err = Err1WasTouched
681 // Does it produce both stdout and tmp?
682 fiStdout, err := os.Stat(fdStdout.Name())
684 runErr.Err = ErrLine(err)
689 _, err = os.Stat(tmpPath)
691 if fiStdout.Size() > 0 {
692 runErr.Err = errors.New("created both tmp and stdout")
697 } else if !errors.Is(err, fs.ErrNotExist) {
698 runErr.Err = ErrLine(err)
703 // Determine what file we must process at last
705 var chmod fs.FileMode
707 fd, err = os.Open(tmpPath)
713 if fi, rerr := fd.Stat(); rerr == nil {
719 } else if fiStdout.Size() > 0 {
723 // Do we need to ifcreate it, or ifchange with renaming?
726 err = ifcreate(fdDepW, fdDep.Name(), tgtT)
734 _, err = fd.Seek(0, io.SeekStart)
739 hsh, err = fileHash(fd)
745 tracef(CDebug, "%s has same hash, not renaming", tgt)
746 err = ErrLine(os.Remove(fd.Name()))
751 err = ErrLine(os.Chmod(tgt.a, chmod))
756 err = ErrLine(os.Chtimes(tgt.a, finished, finished))
761 err = ErrLine(syncDir(tgtH))
766 err = ErrLine(depWrite(fdDepW, fdDep.Name(), tgtH, tgt, hsh))
774 err = ErrLine(fd.Sync())
779 err = ErrLine(os.Rename(fd.Name(), tgt.a))
784 err = ErrLine(syncDir(tgtH))
789 err = ErrLine(depWrite(fdDepW, fdDep.Name(), tgtH, tgt, hsh))
797 err = ErrLine(fdDepW.Flush())
802 err = ErrLine(fdDep.Sync())
807 err = ErrLine(os.Rename(fdDep.Name(), tgt.dep))
813 err = ErrLine(syncDir(redoDir))
821 // Post-commit .dep sanitizing
822 dep, err = depRead(tgt)
824 ifchangeSeen := make(map[string]struct{}, len(dep.ifchanges))
825 for _, ifchange := range dep.ifchanges {
826 ifchangeSeen[ifchange.tgt.a] = struct{}{}
828 for _, ifcreate := range dep.ifcreates {
829 if _, exists := ifchangeSeen[ifcreate.a]; exists {
830 tracef(CWarn, "simultaneous ifcreate and ifchange records: %s", tgt)
833 } else if errors.Is(err, fs.ErrNotExist) {
847 func isOkRun(err error) bool {
852 if errors.As(err, &runErr) && runErr.Err == nil {
853 tracef(CRedo, "%s", runErr.Name())
856 tracef(CErr, "%s", err)