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, string, 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)
145 m, err := r.NextMap()
147 if errors.Is(err, io.EOF) {
150 return false, nil, "", err
152 if m["Type"] != DepTypeIfchange || m["Target"] != tgt {
155 fd, err := os.Open(path.Join(cwd, tgt))
157 if os.IsNotExist(err) {
158 return false, nil, "", nil
160 return false, nil, "", err
162 ourInode, err = inodeFromFile(fd)
165 return false, nil, "", err
167 theirInode, err := inodeFromRec(m)
169 return false, nil, "", err
172 modified = !ourInode.Equals(theirInode)
175 return modified, ourInode, hshPrev, nil
178 func syncDir(dir string) error {
179 fd, err := os.Open(dir)
188 func runScript(tgtOrig string, errs chan error, traced bool) error {
189 cwd, tgt := cwdAndTgt(tgtOrig)
190 redoDir := path.Join(cwd, RedoDir)
191 if err := mkdirs(redoDir); err != nil {
192 return TgtError{tgtOrig, err}
196 fdLock, err := os.OpenFile(
197 path.Join(redoDir, tgt+LockSuffix),
198 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
202 return TgtError{tgtOrig, err}
204 flock := unix.Flock_t{
206 Whence: io.SeekStart,
208 lockRelease := func() {
209 tracef(CLock, "LOCK_UN: %s", fdLock.Name())
210 flock.Type = unix.F_UNLCK
211 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
216 tracef(CLock, "LOCK_NB: %s", fdLock.Name())
218 // Waiting for job completion, already taken by someone else
219 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
220 if uintptr(err.(syscall.Errno)) != uintptr(unix.EAGAIN) {
222 return TgtError{tgtOrig, err}
225 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_GETLK, &flock); err != nil {
228 tracef(CDebug, "waiting: %s (pid=%d)", tgtOrig, flock.Pid)
230 if _, err = FdStatus.Write([]byte{StatusWait}); err != nil {
236 tracef(CLock, "LOCK_EX: %s", fdLock.Name())
237 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLKW, &flock); err != nil {
241 tracef(CDebug, "waiting done: %s", tgtOrig)
243 if _, err = FdStatus.Write([]byte{StatusWaited}); err != nil {
248 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
250 if os.IsNotExist(err) {
251 err = errors.New("was not built: no .rec")
256 depInfo, err = depRead(fdDep)
260 if depInfo.build != BuildUUID {
261 err = errors.New("was not built: build differs")
265 err = TgtError{tgtOrig, err}
272 // Check if target is not modified externally
273 modified, inodePrev, hshPrev, err := isModified(cwd, redoDir, tgt)
276 return TgtError{tgtOrig, err}
281 return fmt.Errorf("%s externally modified", tgtOrig)
283 tracef(CWarn, "%s externally modified: not redoing", tgtOrig)
290 // Start preparing .rec
291 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
294 return TgtError{tgtOrig, err}
296 fdDepPath := fdDep.Name()
300 os.Remove(fdDep.Name())
302 if _, err = recfile.NewWriter(fdDep).WriteFields(
303 recfile.Field{Name: "Build", Value: BuildUUID},
306 return TgtError{tgtOrig, err}
310 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
313 return TgtError{tgtOrig, err}
317 return TgtError{tgtOrig, errors.New("no .do found")}
320 // Determine basename and DIRPREFIX
321 doFileRelPath := doFile
322 ents := strings.Split(cwd, "/")
323 ents = ents[len(ents)-upLevels:]
324 dirPrefix := path.Join(ents...)
326 for i := 0; i < upLevels; i++ {
327 cwd = path.Join(cwd, "..")
328 doFileRelPath = path.Join("..", doFileRelPath)
330 cwd = path.Clean(cwd)
331 doFilePath := path.Join(cwd, doFile)
333 runErr := RunError{Tgt: tgtOrig}
334 if strings.HasPrefix(doFile, "default.") {
335 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
336 runErr.DoFile = doFileRelPath
339 if err = depWrite(fdDep, cwdOrig, doFileRelPath, ""); err != nil {
341 return TgtError{tgtOrig, err}
344 tracef(CWait, "%s", runErr.Name())
346 // Prepare command line
349 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
351 args = make([]string, 0, 3)
354 if traced || TracedAll {
355 args = append(args, "-ex")
357 args = append(args, "-e")
359 args = append(args, doFile)
362 // Temporary file for stdout
363 fdStdout, err := tempfile(cwdOrig, tgt)
366 return TgtError{tgtOrig, err}
368 stdoutPath := fdStdout.Name()
370 tmpPath := stdoutPath + ".3" // and for $3
371 tmpPathRel, err := filepath.Rel(cwd, tmpPath)
377 path.Join(dirPrefix, tgt),
378 path.Join(dirPrefix, basename),
382 cmd := exec.Command(cmdName, args...)
384 // cmd.Stdin reads from /dev/null by default
385 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
386 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
387 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
389 childStderrPrefix := tempsuffix()
390 cmd.Env = append(cmd.Env, fmt.Sprintf(
391 "%s=%s", EnvStderrPrefix, childStderrPrefix,
395 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
396 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
398 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
399 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
403 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
405 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
406 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
411 var fdStderr *os.File
413 fdStderr, err = os.OpenFile(
414 path.Join(redoDir, tgt+LogSuffix),
415 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
420 return TgtError{tgtOrig, err}
423 shCtx := fmt.Sprintf(
424 "sh: %s: %s %s cwd:%s dirprefix:%s",
425 tgtOrig, cmdName, args, cwd, dirPrefix,
427 tracef(CDebug, "%s", shCtx)
431 jsToken := jsAcquire(shCtx)
434 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
436 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
437 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
438 makeFlags := fmt.Sprintf(
439 "%s %s%d,%d", MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
441 makeFlags = strings.Trim(makeFlags, " ")
442 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", MakeFlagsName, makeFlags))
444 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
448 if _, err = FdStatus.Write([]byte{StatusRun}); err != nil {
453 var finished time.Time
454 var exitErr *exec.ExitError
455 started := time.Now()
456 runErr.Started = &started
457 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
463 cmd.Stdout = fdStdout
464 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
470 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
471 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
473 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
476 jsRelease(shCtx, jsToken)
481 logRecPath := path.Join(redoDir, tgt+LogRecSuffix)
482 if fdStderr, err = os.OpenFile(
484 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
487 fields := []recfile.Field{
488 {Name: "Build", Value: BuildUUID},
489 {Name: "PPID", Value: strconv.Itoa(os.Getpid())},
490 {Name: "Cwd", Value: cwd},
492 if cmd.Process != nil {
493 fields = append(fields, recfile.Field{
494 Name: "PID", Value: strconv.Itoa(cmd.Process.Pid),
497 ts := new(tai64n.TAI64N)
499 fields = append(fields,
500 recfile.Field{Name: "Started", Value: tai64n.Encode(ts[:])},
502 ts.FromTime(finished)
503 fields = append(fields,
504 recfile.Field{Name: "Finished", Value: tai64n.Encode(ts[:])})
505 fields = append(fields, recfile.Field{
507 Value: strconv.FormatInt(finished.Sub(started).Nanoseconds(), 10),
509 fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
510 for _, arg := range args {
511 fields = append(fields, recfile.Field{Name: "Arg", Value: arg})
513 for _, env := range cmd.Env {
514 fields = append(fields, recfile.Field{Name: "Env", Value: env})
517 fields = append(fields, recfile.Field{
519 Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
522 w := bufio.NewWriter(fdStderr)
525 fdDep, err := os.Open(fdDepPath)
529 depInfo, err = depRead(fdDep)
534 for _, dep := range depInfo.ifchanges {
535 fields = append(fields, recfile.Field{
537 Value: dep["Target"],
540 _, err = recfile.NewWriter(w).WriteFields(fields...)
548 os.Remove(logRecPath)
552 log.Println("can not open", logRecPath, ":", err)
556 os.Remove(fdDep.Name())
557 os.Remove(fdStdout.Name())
559 os.Remove(fdLock.Name())
561 if _, err = FdStatus.Write([]byte{StatusDone}); err != nil {
567 stderr, err := cmd.StderrPipe()
581 RunningProcs[cmd.Process.Pid] = cmd.Process
582 RunningProcsM.Unlock()
583 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
584 tracef(CDebug, "%s runs %s", tgtOrig, pid)
586 stderrTerm := make(chan struct{})
588 scanner := bufio.NewScanner(stderr)
590 ts := new(tai64n.TAI64N)
592 line = scanner.Text()
593 if strings.HasPrefix(line, childStderrPrefix) {
594 line = line[len(childStderrPrefix):]
595 os.Stderr.WriteString(StderrPrefix + line + "\n")
599 ts.FromTime(time.Now())
601 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
608 tracef(CNone, "%s", line)
610 tracef(CNone, "%s %s", pid, line)
616 // Wait for job completion
620 delete(RunningProcs, cmd.Process.Pid)
621 RunningProcsM.Unlock()
622 finished = time.Now()
623 runErr.Finished = &finished
625 exitErr = err.(*exec.ExitError)
632 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
633 if inodePrev == nil {
635 runErr.Err = Err1WasTouched
639 inode, err := inodeFromFile(fd)
646 if !inode.Equals(inodePrev) {
647 runErr.Err = Err1WasTouched
653 if inodePrev != nil {
654 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
655 inode, err := inodeFromFile(fd)
657 if err == nil && !inode.Equals(inodePrev) {
658 runErr.Err = Err1WasTouched
665 // Does it produce both stdout and tmp?
666 fiStdout, err := os.Stat(fdStdout.Name())
673 _, err = os.Stat(tmpPath)
675 if fiStdout.Size() > 0 {
676 runErr.Err = errors.New("created both tmp and stdout")
681 } else if !os.IsNotExist(err) {
687 // Determine what file we must process at last
690 fd, err = os.Open(tmpPath)
695 } else if fiStdout.Size() > 0 {
699 // Do we need to ifcreate it, or ifchange with renaming?
701 os.Remove(path.Join(cwdOrig, tgt))
702 err = ifcreate(fdDep, tgt)
709 _, err = fd.Seek(0, io.SeekStart)
713 hsh, err = fileHash(fd)
718 tracef(CDebug, "%s has same hash, not renaming", tgtOrig)
719 err = os.Remove(fd.Name())
723 err = os.Chtimes(path.Join(cwdOrig, tgt), finished, finished)
728 err = syncDir(cwdOrig)
733 err = depWrite(fdDep, cwdOrig, tgt, hshPrev)
746 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
751 err = syncDir(cwdOrig)
756 err = depWrite(fdDep, cwdOrig, tgt, hsh)
770 fdDepPath = path.Join(redoDir, tgt+DepSuffix)
771 err = os.Rename(fdDep.Name(), fdDepPath)
776 err = syncDir(redoDir)
782 // Post-commit .rec sanitizing
784 if fdDepR, err := os.Open(fdDepPath); err == nil {
785 depInfo, err := depRead(fdDepR)
790 ifchangeSeen := make(map[string]struct{}, len(depInfo.ifchanges))
791 for _, dep := range depInfo.ifchanges {
792 ifchangeSeen[dep["Target"]] = struct{}{}
794 for _, dep := range depInfo.ifcreates {
795 if _, exists := ifchangeSeen[dep]; exists {
796 tracef(CWarn, "simultaneous ifcreate and ifchange records: %s", tgt)
808 func isOkRun(err error) bool {
813 if errors.As(err, &runErr) && runErr.Err == nil {
814 tracef(CRedo, "%s", runErr.Name())
817 tracef(CErr, "%s", err)