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/>.
42 "go.cypherpunks.ru/recfile"
43 "go.cypherpunks.ru/tai64n/v2"
44 "golang.org/x/sys/unix"
48 EnvDepFd = "REDO_DEP_FD"
49 EnvDirPrefix = "REDO_DIRPREFIX"
50 EnvDepCwd = "REDO_DEP_CWD"
51 EnvBuildUUID = "REDO_BUILD_UUID"
52 EnvStderrPrefix = "REDO_STDERR_PREFIX"
53 EnvTrace = "REDO_TRACE"
54 EnvStderrKeep = "REDO_LOGS"
55 EnvStderrSilent = "REDO_SILENT"
56 EnvNoSync = "REDO_NO_SYNC"
57 EnvStopIfMod = "REDO_STOP_IF_MODIFIED"
64 LogRecSuffix = ".log-rec"
78 flagStderrSilent *bool
79 flagForcedIfchange *bool
83 RunningProcs = map[int]*os.Process{}
84 RunningProcsM sync.Mutex
86 Err1WasTouched = errors.New("$1 was explicitly touched")
91 if !(cmdName == CmdNameRedo || cmdName == CmdNameRedoIfchange) {
94 flagTrace = flag.Bool("x", false, "trace (sh -x) current targets")
95 flagTraceAll = flag.Bool("xx", false,
96 fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
97 flagStderrKeep = flag.Bool("k", false,
98 fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
99 flagStderrSilent = flag.Bool("s", false,
100 fmt.Sprintf("silent, do not print job's stderr (%s=1)", EnvStderrSilent))
101 flagForcedIfchange = flag.Bool("f", false, "forced redo-ifchange")
104 type RunError struct {
112 func (e *RunError) Name() string {
115 name = e.Tgt.String()
117 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
119 if e.Finished == nil {
122 return fmt.Sprintf("%s (%.3fs)", name, e.Finished.Sub(*e.Started).Seconds())
125 func (e RunError) Error() string {
126 return fmt.Sprintf("%s: %s", e.Name(), e.Err)
129 func mkdirs(pth string) error {
133 return os.MkdirAll(pth, os.FileMode(0777))
136 func isModified(depInfo *DepInfo, tgt *Tgt) (
137 modified bool, ourInode *Inode, hshPrev []byte, err error,
142 for _, dep := range depInfo.ifchanges {
143 if dep.tgt.a != tgt.a {
146 ourInode, err = inodeFromFileByPath(tgt.a)
148 if os.IsNotExist(err) {
156 modified = !ourInode.Equals(dep.inode)
162 func syncDir(dir string) error {
163 fd, err := os.Open(dir)
172 func runScript(tgt *Tgt, errs chan error, forced, traced bool) error {
173 redoDir := path.Join(tgt.h, RedoDir)
174 if err := mkdirs(redoDir); err != nil {
175 return TgtError{tgt, ErrLine(err)}
178 shCtx := fmt.Sprintf("sh: %s: cwd:%s", tgt, tgt.h)
179 jsToken := jsAcquire(shCtx)
180 jsNeedsRelease := true
183 jsRelease(shCtx, jsToken)
188 fdLock, err := os.OpenFile(
189 path.Join(redoDir, tgt.t+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 := depReadBuild(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 .rec")
255 err = TgtError{tgt, err}
262 // It scans the whole .rec file while searching for the single target,
263 // but that one is always located at the very end
264 depInfo, 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 && depInfo != nil && depInfo.build == BuildUUID {
281 // Check if target is not modified externally
282 modified, inodePrev, hshPrev, err := isModified(depInfo, 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 .rec
301 fdDep, err := tempfile(redoDir, tgt.t+DepSuffix)
304 return TgtError{tgt, ErrLine(err)}
307 fdDepPath := fdDep.Name()
313 os.Remove(fdDep.Name())
315 if _, err = recfile.NewWriter(fdDep).WriteFields(
316 recfile.Field{Name: "Build", Value: BuildUUID},
319 return TgtError{tgt, ErrLine(err)}
326 runErr := RunError{Tgt: tgt}
327 // Determine basename and DIRPREFIX
329 doFileRelPath, upLevels, err := findDo(fdDep, tgt.h, tgt.t)
332 return TgtError{tgt, ErrLine(err)}
334 if doFileRelPath == "" {
336 return TgtError{tgt, errors.New("no .do found")}
338 // ents := strings.Split(strings.TrimSuffix(tgt.h, "/"), "/")
339 ents := strings.Split(tgt.h, "/")
340 ents = ents[len(ents)-upLevels:]
341 dirPrefix = path.Join(ents...)
342 ups := make([]string, 0, upLevels+2)
343 ups = append(ups, tgt.h)
344 for i := 0; i < upLevels; i++ {
345 ups = append(ups, "..")
347 ups = append(ups, doFileRelPath)
348 cwd = path.Clean(path.Join(ups[:len(ups)-1]...))
349 doFile = NewTgt(path.Join(ups...))
350 if strings.HasPrefix(doFile.t, "default.") {
351 basename = basename[:len(basename)-(len(doFile.t)-len("default.")-len(".do"))-1]
352 runErr.DoFile = doFile.String()
356 if err = depWrite(fdDep, tgt.h, doFile, nil); err != nil {
358 return TgtError{tgt, ErrLine(err)}
362 tracef(CWait, "%s", runErr.Name())
364 // Prepare command line
367 if err = unix.Access(doFile.String(), unix.X_OK); err == nil {
369 args = make([]string, 0, 3)
372 if traced || TracedAll {
373 args = append(args, "-ex")
375 args = append(args, "-e")
377 args = append(args, doFile.t)
380 // Temporary file for stdout
381 fdStdout, err := tempfile(tgt.h, tgt.t)
384 return TgtError{tgt, ErrLine(err)}
386 stdoutPath := fdStdout.Name()
388 tmpPath := stdoutPath + ".3" // and for $3
389 tmpPathRel := mustRel(cwd, tmpPath)
392 path.Join(dirPrefix, tgt.t),
393 path.Join(dirPrefix, basename),
397 "sh: %s: %s %s cwd:%s dirprefix:%s",
398 tgt, cmdName, args, cwd, dirPrefix,
401 cmd := exec.Command(cmdName, args...)
403 // cmd.Stdin reads from /dev/null by default
404 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
405 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
406 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
408 childStderrPrefixRaw := make([]byte, 8)
409 if _, err = io.ReadFull(rand.Reader, childStderrPrefixRaw); err != nil {
412 childStderrPrefix := hex.EncodeToString(childStderrPrefixRaw)
413 cmd.Env = append(cmd.Env, fmt.Sprintf(
414 "%s=%s", EnvStderrPrefix, childStderrPrefix,
418 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
419 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
421 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
422 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
426 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
428 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
429 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
434 var fdStderr *os.File
436 fdStderr, err = os.OpenFile(
437 path.Join(redoDir, tgt.t+LogSuffix),
438 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
443 return TgtError{tgt, ErrLine(err)}
446 tracef(CDebug, "%s", shCtx)
448 jsNeedsRelease = false
453 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
455 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
456 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
457 makeFlags := fmt.Sprintf(
458 "%s %s%d,%d", MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
460 makeFlags = strings.Trim(makeFlags, " ")
461 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", MakeFlagsName, makeFlags))
463 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
467 if _, err = FdStatus.Write([]byte{StatusRun}); err != nil {
472 defer jsRelease(shCtx, jsToken)
474 var finished time.Time
475 var exitErr *exec.ExitError
476 started := time.Now()
477 runErr.Started = &started
478 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
487 cmd.Stdout = fdStdout
488 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
499 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
500 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
502 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
511 logRecPath := path.Join(redoDir, tgt.t+LogRecSuffix)
512 if fdStderr, err = os.OpenFile(
514 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
517 fields := []recfile.Field{
518 {Name: "Build", Value: BuildUUID},
519 {Name: "PPID", Value: strconv.Itoa(os.Getpid())},
520 {Name: "Cwd", Value: cwd},
522 if cmd.Process != nil {
523 fields = append(fields, recfile.Field{
524 Name: "PID", Value: strconv.Itoa(cmd.Process.Pid),
527 ts := new(tai64n.TAI64N)
529 fields = append(fields,
530 recfile.Field{Name: "Started", Value: tai64n.Encode(ts[:])},
532 ts.FromTime(finished)
533 fields = append(fields,
534 recfile.Field{Name: "Finished", Value: tai64n.Encode(ts[:])})
535 fields = append(fields, recfile.Field{
537 Value: strconv.FormatInt(finished.Sub(started).Nanoseconds(), 10),
539 fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
540 for _, arg := range args {
541 fields = append(fields, recfile.Field{Name: "Arg", Value: arg})
543 for _, env := range cmd.Env {
544 fields = append(fields, recfile.Field{Name: "Env", Value: env})
547 fields = append(fields, recfile.Field{
549 Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
553 w := bufio.NewWriter(fdStderr)
555 var ifchanges []string
556 ifchanges, err = depReadOnlyIfchanges(tgt.Dep())
561 for _, dep := range ifchanges {
562 fields = append(fields, recfile.Field{
568 _, err = recfile.NewWriter(w).WriteFields(fields...)
573 err = ErrLine(w.Flush())
577 os.Remove(logRecPath)
581 log.Println("can not open", logRecPath, ":", err)
585 os.Remove(fdDep.Name())
586 os.Remove(fdStdout.Name())
589 if _, err = FdStatus.Write([]byte{StatusDone}); err != nil {
595 stderr, err := cmd.StderrPipe()
609 RunningProcs[cmd.Process.Pid] = cmd.Process
610 RunningProcsM.Unlock()
611 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
612 tracef(CDebug, "%s runs %s", tgt, pid)
614 stderrTerm := make(chan struct{})
616 scanner := bufio.NewScanner(stderr)
618 ts := new(tai64n.TAI64N)
620 line = scanner.Text()
621 if strings.HasPrefix(line, childStderrPrefix) {
622 line = line[len(childStderrPrefix):]
623 os.Stderr.WriteString(StderrPrefix + line + "\n")
627 ts.FromTime(time.Now())
629 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
636 tracef(CNone, "%s", line)
638 tracef(CNone, "%s %s", pid, line)
644 // Wait for job completion
648 delete(RunningProcs, cmd.Process.Pid)
649 RunningProcsM.Unlock()
650 finished = time.Now()
651 runErr.Finished = &finished
653 exitErr = err.(*exec.ExitError)
660 if inode, err := inodeFromFileByPath(tgt.a); err == nil {
661 if inodePrev == nil {
662 runErr.Err = Err1WasTouched
671 if !inode.Equals(inodePrev) {
672 runErr.Err = Err1WasTouched
678 // Does it produce both stdout and tmp?
679 fiStdout, err := os.Stat(fdStdout.Name())
681 runErr.Err = ErrLine(err)
686 _, err = os.Stat(tmpPath)
688 if fiStdout.Size() > 0 {
689 runErr.Err = errors.New("created both tmp and stdout")
694 } else if !errors.Is(err, fs.ErrNotExist) {
695 runErr.Err = ErrLine(err)
700 // Determine what file we must process at last
703 fd, err = os.Open(tmpPath)
709 } else if fiStdout.Size() > 0 {
713 // Do we need to ifcreate it, or ifchange with renaming?
716 err = ifcreate(fdDep, tgt.t)
724 _, err = fd.Seek(0, io.SeekStart)
729 hsh, err = fileHash(fd)
734 if bytes.Equal(hsh, hshPrev) {
735 tracef(CDebug, "%s has same hash, not renaming", tgt)
736 err = ErrLine(os.Remove(fd.Name()))
740 err = ErrLine(os.Chtimes(tgt.a, finished, finished))
745 err = ErrLine(syncDir(tgt.h))
750 err = ErrLine(depWrite(fdDep, tgt.h, tgt, hsh))
758 err = ErrLine(fd.Sync())
763 err = ErrLine(os.Rename(fd.Name(), tgt.a))
768 err = ErrLine(syncDir(tgt.h))
773 err = ErrLine(depWrite(fdDep, tgt.h, tgt, hsh))
782 err = ErrLine(fdDep.Sync())
787 err = ErrLine(os.Rename(fdDep.Name(), tgt.Dep()))
792 err = ErrLine(syncDir(redoDir))
800 // Post-commit .rec sanitizing
801 if depInfo, err := depRead(tgt); err == nil {
802 ifchangeSeen := make(map[string]struct{}, len(depInfo.ifchanges))
803 for _, dep := range depInfo.ifchanges {
804 ifchangeSeen[dep.tgt.a] = struct{}{}
806 for _, dep := range depInfo.ifcreates {
807 if _, exists := ifchangeSeen[dep.a]; exists {
808 tracef(CWarn, "simultaneous ifcreate and ifchange records: %s", tgt)
811 } else if errors.Is(err, fs.ErrNotExist) {
825 func isOkRun(err error) bool {
830 if errors.As(err, &runErr) && runErr.Err == nil {
831 tracef(CRedo, "%s", runErr.Name())
834 tracef(CErr, "%s", err)