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 {
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, cwd, tgt string) (
137 modified bool, ourInode *Inode, hshPrev []byte, err error,
142 for _, dep := range depInfo.ifchanges {
146 ourInode, err = inodeFromFileByPath(path.Join(cwd, tgt))
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(tgtOrig string, errs chan error, forced, traced bool) error {
173 cwd, tgt := cwdAndTgt(tgtOrig)
174 redoDir := path.Join(cwd, RedoDir)
175 if err := mkdirs(redoDir); err != nil {
176 return TgtError{tgtOrig, ErrLine(err)}
179 shCtx := fmt.Sprintf("sh: %s: cwd:%s", tgtOrig, cwd)
180 jsToken := jsAcquire(shCtx)
181 jsNeedsRelease := true
184 jsRelease(shCtx, jsToken)
189 fdLock, err := os.OpenFile(
190 path.Join(redoDir, tgt+LockSuffix),
191 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
195 return TgtError{tgtOrig, ErrLine(err)}
197 flock := unix.Flock_t{
199 Whence: io.SeekStart,
201 lockRelease := func() {
202 tracef(CLock, "LOCK_UN: %s", fdLock.Name())
203 flock.Type = unix.F_UNLCK
204 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
205 log.Fatalln(err, fdLock.Name())
209 tracef(CLock, "LOCK_NB: %s", fdLock.Name())
211 // Waiting for job completion, already taken by someone else
212 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
213 if uintptr(err.(syscall.Errno)) != uintptr(unix.EAGAIN) {
215 return TgtError{tgtOrig, ErrLine(err)}
218 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_GETLK, &flock); err != nil {
219 log.Fatalln(err, fdLock.Name())
221 tracef(CDebug, "waiting: %s (pid=%d)", tgtOrig, flock.Pid)
223 if _, err = FdStatus.Write([]byte{StatusWait}); err != nil {
229 tracef(CLock, "LOCK_EX: %s", fdLock.Name())
231 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLKW, &flock); err != nil {
232 if errors.Is(err, unix.EDEADLK) {
233 time.Sleep(10 * time.Millisecond)
236 log.Fatalln(err, fdLock.Name())
239 tracef(CDebug, "waiting done: %s", tgtOrig)
241 if _, err = FdStatus.Write([]byte{StatusWaited}); err != nil {
245 build, err := depReadBuild(path.Join(redoDir, tgt+DepSuffix))
247 if build != BuildUUID {
248 err = errors.New("was not built: build differs")
251 if errors.Is(err, fs.ErrNotExist) {
252 err = errors.New("was not built: no .rec")
256 err = TgtError{tgtOrig, err}
263 // It scans the whole .rec file while searching for the single target,
264 // but that one is always located at the very end
265 depInfo, err := depRead(path.Join(redoDir, tgt+DepSuffix))
267 if errors.Is(err, fs.ErrNotExist) {
271 return TgtError{tgtOrig, err}
275 // Check if it was already built in parallel
276 if !forced && depInfo != nil && depInfo.build == BuildUUID {
282 // Check if target is not modified externally
283 modified, inodePrev, hshPrev, err := isModified(depInfo, cwd, tgt)
286 return TgtError{tgtOrig, err}
291 return fmt.Errorf("%s externally modified", tgtOrig)
293 tracef(CWarn, "%s externally modified: not redoing", tgtOrig)
301 // Start preparing .rec
302 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
305 return TgtError{tgtOrig, ErrLine(err)}
308 fdDepPath := fdDep.Name()
314 os.Remove(fdDep.Name())
316 if _, err = recfile.NewWriter(fdDep).WriteFields(
317 recfile.Field{Name: "Build", Value: BuildUUID},
320 return TgtError{tgtOrig, ErrLine(err)}
324 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
327 return TgtError{tgtOrig, ErrLine(err)}
331 return TgtError{tgtOrig, errors.New("no .do found")}
334 // Determine basename and DIRPREFIX
335 doFileRelPath := doFile
336 ents := strings.Split(cwd, "/")
337 ents = ents[len(ents)-upLevels:]
338 dirPrefix := path.Join(ents...)
340 for i := 0; i < upLevels; i++ {
341 cwd = path.Join(cwd, "..")
342 doFileRelPath = path.Join("..", doFileRelPath)
344 cwd = path.Clean(cwd)
345 doFilePath := path.Join(cwd, doFile)
347 runErr := RunError{Tgt: tgtOrig}
348 if strings.HasPrefix(doFile, "default.") {
349 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
350 runErr.DoFile = doFileRelPath
353 if err = depWrite(fdDep, cwdOrig, doFileRelPath, nil); err != nil {
355 return TgtError{tgtOrig, ErrLine(err)}
359 tracef(CWait, "%s", runErr.Name())
361 // Prepare command line
364 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
366 args = make([]string, 0, 3)
369 if traced || TracedAll {
370 args = append(args, "-ex")
372 args = append(args, "-e")
374 args = append(args, doFile)
377 // Temporary file for stdout
378 fdStdout, err := tempfile(cwdOrig, tgt)
381 return TgtError{tgtOrig, ErrLine(err)}
383 stdoutPath := fdStdout.Name()
385 tmpPath := stdoutPath + ".3" // and for $3
386 tmpPathRel := mustRel(cwd, tmpPath)
389 path.Join(dirPrefix, tgt),
390 path.Join(dirPrefix, basename),
394 "sh: %s: %s %s cwd:%s dirprefix:%s",
395 tgtOrig, cmdName, args, cwd, dirPrefix,
398 cmd := exec.Command(cmdName, args...)
400 // cmd.Stdin reads from /dev/null by default
401 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
402 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
403 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
405 childStderrPrefixRaw := make([]byte, 8)
406 if _, err = io.ReadFull(rand.Reader, childStderrPrefixRaw); err != nil {
409 childStderrPrefix := hex.EncodeToString(childStderrPrefixRaw)
410 cmd.Env = append(cmd.Env, fmt.Sprintf(
411 "%s=%s", EnvStderrPrefix, childStderrPrefix,
415 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
416 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
418 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
419 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
423 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
425 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
426 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
431 var fdStderr *os.File
433 fdStderr, err = os.OpenFile(
434 path.Join(redoDir, tgt+LogSuffix),
435 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
440 return TgtError{tgtOrig, ErrLine(err)}
443 tracef(CDebug, "%s", shCtx)
445 jsNeedsRelease = false
450 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
452 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
453 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
454 makeFlags := fmt.Sprintf(
455 "%s %s%d,%d", MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
457 makeFlags = strings.Trim(makeFlags, " ")
458 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", MakeFlagsName, makeFlags))
460 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
464 if _, err = FdStatus.Write([]byte{StatusRun}); err != nil {
469 defer jsRelease(shCtx, jsToken)
471 var finished time.Time
472 var exitErr *exec.ExitError
473 started := time.Now()
474 runErr.Started = &started
475 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
484 cmd.Stdout = fdStdout
485 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))
508 logRecPath := path.Join(redoDir, tgt+LogRecSuffix)
509 if fdStderr, err = os.OpenFile(
511 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
514 fields := []recfile.Field{
515 {Name: "Build", Value: BuildUUID},
516 {Name: "PPID", Value: strconv.Itoa(os.Getpid())},
517 {Name: "Cwd", Value: cwd},
519 if cmd.Process != nil {
520 fields = append(fields, recfile.Field{
521 Name: "PID", Value: strconv.Itoa(cmd.Process.Pid),
524 ts := new(tai64n.TAI64N)
526 fields = append(fields,
527 recfile.Field{Name: "Started", Value: tai64n.Encode(ts[:])},
529 ts.FromTime(finished)
530 fields = append(fields,
531 recfile.Field{Name: "Finished", Value: tai64n.Encode(ts[:])})
532 fields = append(fields, recfile.Field{
534 Value: strconv.FormatInt(finished.Sub(started).Nanoseconds(), 10),
536 fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
537 for _, arg := range args {
538 fields = append(fields, recfile.Field{Name: "Arg", Value: arg})
540 for _, env := range cmd.Env {
541 fields = append(fields, recfile.Field{Name: "Env", Value: env})
544 fields = append(fields, recfile.Field{
546 Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
549 w := bufio.NewWriter(fdStderr)
551 depInfo, err := depRead(fdDepPath)
556 for _, dep := range depInfo.ifchanges {
557 fields = append(fields, recfile.Field{
562 _, err = recfile.NewWriter(w).WriteFields(fields...)
567 err = ErrLine(w.Flush())
571 os.Remove(logRecPath)
575 log.Println("can not open", logRecPath, ":", err)
579 os.Remove(fdDep.Name())
580 os.Remove(fdStdout.Name())
583 if _, err = FdStatus.Write([]byte{StatusDone}); err != nil {
589 stderr, err := cmd.StderrPipe()
603 RunningProcs[cmd.Process.Pid] = cmd.Process
604 RunningProcsM.Unlock()
605 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
606 tracef(CDebug, "%s runs %s", tgtOrig, pid)
608 stderrTerm := make(chan struct{})
610 scanner := bufio.NewScanner(stderr)
612 ts := new(tai64n.TAI64N)
614 line = scanner.Text()
615 if strings.HasPrefix(line, childStderrPrefix) {
616 line = line[len(childStderrPrefix):]
617 os.Stderr.WriteString(StderrPrefix + line + "\n")
621 ts.FromTime(time.Now())
623 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
630 tracef(CNone, "%s", line)
632 tracef(CNone, "%s %s", pid, line)
638 // Wait for job completion
642 delete(RunningProcs, cmd.Process.Pid)
643 RunningProcsM.Unlock()
644 finished = time.Now()
645 runErr.Finished = &finished
647 exitErr = err.(*exec.ExitError)
654 if inode, err := inodeFromFileByPath(path.Join(cwdOrig, tgt)); err == nil {
655 if inodePrev == nil {
656 runErr.Err = Err1WasTouched
665 if !inode.Equals(inodePrev) {
666 runErr.Err = Err1WasTouched
672 if inodePrev != nil {
673 if inode, err := inodeFromFileByPath(path.Join(cwdOrig, tgt)); err == nil {
674 if !inode.Equals(inodePrev) {
675 runErr.Err = Err1WasTouched
682 // Does it produce both stdout and tmp?
683 fiStdout, err := os.Stat(fdStdout.Name())
685 runErr.Err = ErrLine(err)
690 _, err = os.Stat(tmpPath)
692 if fiStdout.Size() > 0 {
693 runErr.Err = errors.New("created both tmp and stdout")
698 } else if !errors.Is(err, fs.ErrNotExist) {
699 runErr.Err = ErrLine(err)
704 // Determine what file we must process at last
707 fd, err = os.Open(tmpPath)
713 } else if fiStdout.Size() > 0 {
717 // Do we need to ifcreate it, or ifchange with renaming?
719 os.Remove(path.Join(cwdOrig, tgt))
720 err = ifcreate(fdDep, tgt)
728 _, err = fd.Seek(0, io.SeekStart)
733 hsh, err = fileHash(fd)
738 if bytes.Equal(hsh, hshPrev) {
739 tracef(CDebug, "%s has same hash, not renaming", tgtOrig)
740 err = ErrLine(os.Remove(fd.Name()))
744 err = ErrLine(os.Chtimes(path.Join(cwdOrig, tgt), finished, finished))
749 err = ErrLine(syncDir(cwdOrig))
754 err = ErrLine(depWrite(fdDep, cwdOrig, tgt, hsh))
762 err = ErrLine(fd.Sync())
767 err = ErrLine(os.Rename(fd.Name(), path.Join(cwdOrig, tgt)))
772 err = ErrLine(syncDir(cwdOrig))
777 err = ErrLine(depWrite(fdDep, cwdOrig, tgt, hsh))
786 err = ErrLine(fdDep.Sync())
791 fdDepPath = path.Join(redoDir, tgt+DepSuffix)
792 err = ErrLine(os.Rename(fdDep.Name(), fdDepPath))
797 err = ErrLine(syncDir(redoDir))
805 // Post-commit .rec sanitizing
806 if depInfo, err := depRead(fdDepPath); err == nil {
807 ifchangeSeen := make(map[string]struct{}, len(depInfo.ifchanges))
808 for _, dep := range depInfo.ifchanges {
809 ifchangeSeen[dep.tgt] = struct{}{}
811 for _, dep := range depInfo.ifcreates {
812 if _, exists := ifchangeSeen[dep]; exists {
813 tracef(CWarn, "simultaneous ifcreate and ifchange records: %s", tgt)
816 } else if errors.Is(err, fs.ErrNotExist) {
830 func isOkRun(err error) bool {
835 if errors.As(err, &runErr) && runErr.Err == nil {
836 tracef(CRedo, "%s", runErr.Name())
839 tracef(CErr, "%s", err)