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/>.
40 "go.cypherpunks.ru/recfile"
41 "go.cypherpunks.ru/tai64n/v2"
42 "golang.org/x/sys/unix"
46 EnvDepFd = "REDO_DEP_FD"
47 EnvDirPrefix = "REDO_DIRPREFIX"
48 EnvDepCwd = "REDO_DEP_CWD"
49 EnvBuildUUID = "REDO_BUILD_UUID"
50 EnvStderrPrefix = "REDO_STDERR_PREFIX"
51 EnvTrace = "REDO_TRACE"
52 EnvStderrKeep = "REDO_LOGS"
53 EnvStderrSilent = "REDO_SILENT"
54 EnvNoSync = "REDO_NO_SYNC"
55 EnvStopIfMod = "REDO_STOP_IF_MODIFIED"
62 LogRecSuffix = ".log-rec"
76 flagStderrSilent *bool
77 flagForcedIfchange *bool
81 RunningProcs = map[int]*os.Process{}
82 RunningProcsM sync.Mutex
84 Err1WasTouched = errors.New("$1 was explicitly touched")
89 if !(cmdName == CmdNameRedo || cmdName == CmdNameRedoIfchange) {
92 flagTrace = flag.Bool("x", false, "trace (sh -x) current targets")
93 flagTraceAll = flag.Bool("xx", false,
94 fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
95 flagStderrKeep = flag.Bool("k", false,
96 fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
97 flagStderrSilent = flag.Bool("s", false,
98 fmt.Sprintf("silent, do not print job's stderr (%s=1)", EnvStderrSilent))
99 flagForcedIfchange = flag.Bool("f", false, "forced redo-ifchange")
102 type RunError struct {
110 func (e *RunError) Name() string {
115 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
117 if e.Finished == nil {
120 return fmt.Sprintf("%s (%.3fs)", name, e.Finished.Sub(*e.Started).Seconds())
123 func (e RunError) Error() string {
124 return fmt.Sprintf("%s: %s", e.Name(), e.Err)
127 func mkdirs(pth string) error {
131 return os.MkdirAll(pth, os.FileMode(0777))
134 func isModified(cwd, redoDir, tgt string) (bool, *Inode, string, error) {
135 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
137 if os.IsNotExist(err) {
138 return false, nil, "", nil
140 return false, nil, "", ErrLine(err)
143 r := recfile.NewReader(fdDep)
148 m, err := r.NextMap()
150 if errors.Is(err, io.EOF) {
153 return false, nil, "", ErrLine(err)
155 if m["Type"] != DepTypeIfchange || m["Target"] != tgt {
158 ourInode, err = inodeFromFileByPath(path.Join(cwd, tgt))
160 if os.IsNotExist(err) {
161 return false, nil, "", nil
163 return false, nil, "", ErrLine(err)
165 theirInode, err := inodeFromRec(m)
167 return false, nil, "", ErrLine(err)
170 modified = !ourInode.Equals(theirInode)
173 return modified, ourInode, hshPrev, nil
176 func syncDir(dir string) error {
177 fd, err := os.Open(dir)
186 func runScript(tgtOrig string, errs chan error, forced, traced bool) error {
187 cwd, tgt := cwdAndTgt(tgtOrig)
188 redoDir := path.Join(cwd, RedoDir)
189 if err := mkdirs(redoDir); err != nil {
190 return TgtError{tgtOrig, ErrLine(err)}
193 shCtx := fmt.Sprintf("sh: %s: cwd:%s", tgtOrig, cwd)
194 jsToken := jsAcquire(shCtx)
195 jsNeedsRelease := true
198 jsRelease(shCtx, jsToken)
203 fdLock, err := os.OpenFile(
204 path.Join(redoDir, tgt+LockSuffix),
205 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
209 return TgtError{tgtOrig, ErrLine(err)}
211 flock := unix.Flock_t{
213 Whence: io.SeekStart,
215 lockRelease := func() {
216 tracef(CLock, "LOCK_UN: %s", fdLock.Name())
217 flock.Type = unix.F_UNLCK
218 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
219 log.Fatalln(err, fdLock.Name())
223 tracef(CLock, "LOCK_NB: %s", fdLock.Name())
225 // Waiting for job completion, already taken by someone else
226 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
227 if uintptr(err.(syscall.Errno)) != uintptr(unix.EAGAIN) {
229 return TgtError{tgtOrig, ErrLine(err)}
232 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_GETLK, &flock); err != nil {
233 log.Fatalln(err, fdLock.Name())
235 tracef(CDebug, "waiting: %s (pid=%d)", tgtOrig, flock.Pid)
237 if _, err = FdStatus.Write([]byte{StatusWait}); err != nil {
243 tracef(CLock, "LOCK_EX: %s", fdLock.Name())
245 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLKW, &flock); err != nil {
246 if errors.Is(err, unix.EDEADLK) {
247 time.Sleep(10 * time.Millisecond)
250 log.Fatalln(err, fdLock.Name())
253 tracef(CDebug, "waiting done: %s", tgtOrig)
255 if _, err = FdStatus.Write([]byte{StatusWaited}); err != nil {
259 build, err := depReadBuild(path.Join(redoDir, tgt+DepSuffix))
261 if errors.Is(err, fs.ErrNotExist) {
262 err = errors.New("was not built: no .rec")
266 if build != BuildUUID {
267 err = errors.New("was not built: build differs")
271 err = TgtError{tgtOrig, err}
279 // Check if it was already built in parallel
281 if build, err := depReadBuild(path.Join(redoDir, tgt+DepSuffix)); err == nil && build == BuildUUID {
288 // Check if target is not modified externally
289 modified, inodePrev, hshPrev, err := isModified(cwd, redoDir, tgt)
292 return TgtError{tgtOrig, err}
297 return fmt.Errorf("%s externally modified", tgtOrig)
299 tracef(CWarn, "%s externally modified: not redoing", tgtOrig)
306 // Start preparing .rec
307 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
310 return TgtError{tgtOrig, ErrLine(err)}
312 fdDepPath := fdDep.Name()
316 os.Remove(fdDep.Name())
318 if _, err = recfile.NewWriter(fdDep).WriteFields(
319 recfile.Field{Name: "Build", Value: BuildUUID},
322 return TgtError{tgtOrig, ErrLine(err)}
326 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
329 return TgtError{tgtOrig, ErrLine(err)}
333 return TgtError{tgtOrig, errors.New("no .do found")}
336 // Determine basename and DIRPREFIX
337 doFileRelPath := doFile
338 ents := strings.Split(cwd, "/")
339 ents = ents[len(ents)-upLevels:]
340 dirPrefix := path.Join(ents...)
342 for i := 0; i < upLevels; i++ {
343 cwd = path.Join(cwd, "..")
344 doFileRelPath = path.Join("..", doFileRelPath)
346 cwd = path.Clean(cwd)
347 doFilePath := path.Join(cwd, doFile)
349 runErr := RunError{Tgt: tgtOrig}
350 if strings.HasPrefix(doFile, "default.") {
351 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
352 runErr.DoFile = doFileRelPath
355 if err = depWrite(fdDep, cwdOrig, doFileRelPath, ""); err != nil {
357 return TgtError{tgtOrig, ErrLine(err)}
360 tracef(CWait, "%s", runErr.Name())
362 // Prepare command line
365 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
367 args = make([]string, 0, 3)
370 if traced || TracedAll {
371 args = append(args, "-ex")
373 args = append(args, "-e")
375 args = append(args, doFile)
378 // Temporary file for stdout
379 fdStdout, err := tempfile(cwdOrig, tgt)
382 return TgtError{tgtOrig, ErrLine(err)}
384 stdoutPath := fdStdout.Name()
386 tmpPath := stdoutPath + ".3" // and for $3
387 tmpPathRel := mustRel(cwd, tmpPath)
390 path.Join(dirPrefix, tgt),
391 path.Join(dirPrefix, basename),
395 "sh: %s: %s %s cwd:%s dirprefix:%s",
396 tgtOrig, cmdName, args, cwd, dirPrefix,
399 cmd := exec.Command(cmdName, args...)
401 // cmd.Stdin reads from /dev/null by default
402 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
403 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
404 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
406 childStderrPrefixRaw := make([]byte, 8)
407 if _, err = io.ReadFull(rand.Reader, childStderrPrefixRaw); err != nil {
410 childStderrPrefix := hex.EncodeToString(childStderrPrefixRaw)
411 cmd.Env = append(cmd.Env, fmt.Sprintf(
412 "%s=%s", EnvStderrPrefix, childStderrPrefix,
416 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
417 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
419 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
420 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
424 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
426 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
427 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
432 var fdStderr *os.File
434 fdStderr, err = os.OpenFile(
435 path.Join(redoDir, tgt+LogSuffix),
436 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
441 return TgtError{tgtOrig, ErrLine(err)}
444 tracef(CDebug, "%s", shCtx)
446 jsNeedsRelease = false
451 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
453 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
454 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
455 makeFlags := fmt.Sprintf(
456 "%s %s%d,%d", MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
458 makeFlags = strings.Trim(makeFlags, " ")
459 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", MakeFlagsName, makeFlags))
461 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
465 if _, err = FdStatus.Write([]byte{StatusRun}); err != nil {
470 defer jsRelease(shCtx, jsToken)
472 var finished time.Time
473 var exitErr *exec.ExitError
474 started := time.Now()
475 runErr.Started = &started
476 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
485 cmd.Stdout = fdStdout
486 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
496 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
497 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
499 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
506 logRecPath := path.Join(redoDir, tgt+LogRecSuffix)
507 if fdStderr, err = os.OpenFile(
509 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
512 fields := []recfile.Field{
513 {Name: "Build", Value: BuildUUID},
514 {Name: "PPID", Value: strconv.Itoa(os.Getpid())},
515 {Name: "Cwd", Value: cwd},
517 if cmd.Process != nil {
518 fields = append(fields, recfile.Field{
519 Name: "PID", Value: strconv.Itoa(cmd.Process.Pid),
522 ts := new(tai64n.TAI64N)
524 fields = append(fields,
525 recfile.Field{Name: "Started", Value: tai64n.Encode(ts[:])},
527 ts.FromTime(finished)
528 fields = append(fields,
529 recfile.Field{Name: "Finished", Value: tai64n.Encode(ts[:])})
530 fields = append(fields, recfile.Field{
532 Value: strconv.FormatInt(finished.Sub(started).Nanoseconds(), 10),
534 fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
535 for _, arg := range args {
536 fields = append(fields, recfile.Field{Name: "Arg", Value: arg})
538 for _, env := range cmd.Env {
539 fields = append(fields, recfile.Field{Name: "Env", Value: env})
542 fields = append(fields, recfile.Field{
544 Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
547 w := bufio.NewWriter(fdStderr)
550 fdDep, err := os.Open(fdDepPath)
555 depInfo, err = depRead(fdDep)
561 for _, dep := range depInfo.ifchanges {
562 fields = append(fields, recfile.Field{
564 Value: dep["Target"],
567 _, err = recfile.NewWriter(w).WriteFields(fields...)
572 err = ErrLine(w.Flush())
576 os.Remove(logRecPath)
580 log.Println("can not open", logRecPath, ":", err)
584 os.Remove(fdDep.Name())
585 os.Remove(fdStdout.Name())
588 if _, err = FdStatus.Write([]byte{StatusDone}); err != nil {
594 stderr, err := cmd.StderrPipe()
608 RunningProcs[cmd.Process.Pid] = cmd.Process
609 RunningProcsM.Unlock()
610 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
611 tracef(CDebug, "%s runs %s", tgtOrig, pid)
613 stderrTerm := make(chan struct{})
615 scanner := bufio.NewScanner(stderr)
617 ts := new(tai64n.TAI64N)
619 line = scanner.Text()
620 if strings.HasPrefix(line, childStderrPrefix) {
621 line = line[len(childStderrPrefix):]
622 os.Stderr.WriteString(StderrPrefix + line + "\n")
626 ts.FromTime(time.Now())
628 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
635 tracef(CNone, "%s", line)
637 tracef(CNone, "%s %s", pid, line)
643 // Wait for job completion
647 delete(RunningProcs, cmd.Process.Pid)
648 RunningProcsM.Unlock()
649 finished = time.Now()
650 runErr.Finished = &finished
652 exitErr = err.(*exec.ExitError)
659 if inode, err := inodeFromFileByPath(path.Join(cwdOrig, tgt)); err == nil {
660 if inodePrev == nil {
661 runErr.Err = Err1WasTouched
670 if !inode.Equals(inodePrev) {
671 runErr.Err = Err1WasTouched
677 if inodePrev != nil {
678 if inode, err := inodeFromFileByPath(path.Join(cwdOrig, tgt)); err == nil {
679 if !inode.Equals(inodePrev) {
680 runErr.Err = Err1WasTouched
687 // Does it produce both stdout and tmp?
688 fiStdout, err := os.Stat(fdStdout.Name())
690 runErr.Err = ErrLine(err)
695 _, err = os.Stat(tmpPath)
697 if fiStdout.Size() > 0 {
698 runErr.Err = errors.New("created both tmp and stdout")
703 } else if !errors.Is(err, fs.ErrNotExist) {
704 runErr.Err = ErrLine(err)
709 // Determine what file we must process at last
712 fd, err = os.Open(tmpPath)
718 } else if fiStdout.Size() > 0 {
722 // Do we need to ifcreate it, or ifchange with renaming?
724 os.Remove(path.Join(cwdOrig, tgt))
725 err = ifcreate(fdDep, tgt)
733 _, err = fd.Seek(0, io.SeekStart)
738 hsh, err = fileHash(fd)
744 tracef(CDebug, "%s has same hash, not renaming", tgtOrig)
745 err = ErrLine(os.Remove(fd.Name()))
749 err = ErrLine(os.Chtimes(path.Join(cwdOrig, tgt), finished, finished))
754 err = ErrLine(syncDir(cwdOrig))
759 err = ErrLine(depWrite(fdDep, cwdOrig, tgt, hshPrev))
767 err = ErrLine(fd.Sync())
772 err = ErrLine(os.Rename(fd.Name(), path.Join(cwdOrig, tgt)))
777 err = ErrLine(syncDir(cwdOrig))
782 err = ErrLine(depWrite(fdDep, cwdOrig, tgt, hsh))
791 err = ErrLine(fdDep.Sync())
796 fdDepPath = path.Join(redoDir, tgt+DepSuffix)
797 err = ErrLine(os.Rename(fdDep.Name(), fdDepPath))
802 err = ErrLine(syncDir(redoDir))
808 // Post-commit .rec sanitizing
810 if fdDepR, err := os.Open(fdDepPath); err == nil {
811 depInfo, err := depRead(fdDepR)
817 ifchangeSeen := make(map[string]struct{}, len(depInfo.ifchanges))
818 for _, dep := range depInfo.ifchanges {
819 ifchangeSeen[dep["Target"]] = struct{}{}
821 for _, dep := range depInfo.ifcreates {
822 if _, exists := ifchangeSeen[dep]; exists {
823 tracef(CWarn, "simultaneous ifcreate and ifchange records: %s", tgt)
835 func isOkRun(err error) bool {
840 if errors.As(err, &runErr) && runErr.Err == nil {
841 tracef(CRedo, "%s", runErr.Name())
844 tracef(CErr, "%s", err)