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
76 flagForcedIfchange *bool
80 RunningProcs = map[int]*os.Process{}
81 RunningProcsM sync.Mutex
83 Err1WasTouched = errors.New("$1 was explicitly touched")
88 if !(cmdName == CmdNameRedo || cmdName == CmdNameRedoIfchange) {
91 flagTrace = flag.Bool("x", false, "trace (sh -x) current targets")
92 flagTraceAll = flag.Bool("xx", false,
93 fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
94 flagStderrKeep = flag.Bool("k", false,
95 fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
96 flagStderrSilent = flag.Bool("s", false,
97 fmt.Sprintf("silent, do not print job's stderr (%s=1)", EnvStderrSilent))
98 flagForcedIfchange = flag.Bool("f", false, "forced redo-ifchange")
101 type RunError struct {
109 func (e *RunError) Name() string {
114 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
116 if e.Finished == nil {
119 return fmt.Sprintf("%s (%.3fs)", name, e.Finished.Sub(*e.Started).Seconds())
122 func (e RunError) Error() string {
123 return fmt.Sprintf("%s: %s", e.Name(), e.Err)
126 func mkdirs(pth string) error {
127 if _, err := os.Stat(pth); err == nil {
130 return os.MkdirAll(pth, os.FileMode(0777))
133 func isModified(cwd, redoDir, tgt string) (bool, *Inode, string, error) {
134 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
136 if os.IsNotExist(err) {
137 return false, nil, "", nil
139 return false, nil, "", err
142 r := recfile.NewReader(fdDep)
147 m, err := r.NextMap()
149 if errors.Is(err, io.EOF) {
152 return false, nil, "", err
154 if m["Type"] != DepTypeIfchange || m["Target"] != tgt {
157 fd, err := os.Open(path.Join(cwd, tgt))
159 if os.IsNotExist(err) {
160 return false, nil, "", nil
162 return false, nil, "", err
164 ourInode, err = inodeFromFile(fd)
167 return false, nil, "", err
169 theirInode, err := inodeFromRec(m)
171 return false, nil, "", err
174 modified = !ourInode.Equals(theirInode)
177 return modified, ourInode, hshPrev, nil
180 func syncDir(dir string) error {
181 fd, err := os.Open(dir)
190 func runScript(tgtOrig string, errs chan error, traced bool) error {
191 cwd, tgt := cwdAndTgt(tgtOrig)
192 redoDir := path.Join(cwd, RedoDir)
193 if err := mkdirs(redoDir); err != nil {
194 return TgtError{tgtOrig, err}
198 fdLock, err := os.OpenFile(
199 path.Join(redoDir, tgt+LockSuffix),
200 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
204 return TgtError{tgtOrig, err}
206 flock := unix.Flock_t{
208 Whence: io.SeekStart,
210 lockRelease := func() {
211 tracef(CLock, "LOCK_UN: %s", fdLock.Name())
212 flock.Type = unix.F_UNLCK
213 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
218 tracef(CLock, "LOCK_NB: %s", fdLock.Name())
220 // Waiting for job completion, already taken by someone else
221 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
222 if uintptr(err.(syscall.Errno)) != uintptr(unix.EAGAIN) {
224 return TgtError{tgtOrig, err}
227 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_GETLK, &flock); err != nil {
230 tracef(CDebug, "waiting: %s (pid=%d)", tgtOrig, flock.Pid)
232 if _, err = FdStatus.Write([]byte{StatusWait}); err != nil {
238 tracef(CLock, "LOCK_EX: %s", fdLock.Name())
239 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLKW, &flock); err != nil {
243 tracef(CDebug, "waiting done: %s", tgtOrig)
245 if _, err = FdStatus.Write([]byte{StatusWaited}); err != nil {
250 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
252 if os.IsNotExist(err) {
253 err = errors.New("was not built: no .rec")
258 depInfo, err = depRead(fdDep)
262 if depInfo.build != BuildUUID {
263 err = errors.New("was not built: build differs")
267 err = TgtError{tgtOrig, err}
274 // Check if target is not modified externally
275 modified, inodePrev, hshPrev, err := isModified(cwd, redoDir, tgt)
278 return TgtError{tgtOrig, err}
283 return fmt.Errorf("%s externally modified", tgtOrig)
285 tracef(CWarn, "%s externally modified: not redoing", tgtOrig)
292 // Start preparing .rec
293 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
296 return TgtError{tgtOrig, err}
298 fdDepPath := fdDep.Name()
302 os.Remove(fdDep.Name())
304 if _, err = recfile.NewWriter(fdDep).WriteFields(
305 recfile.Field{Name: "Build", Value: BuildUUID},
308 return TgtError{tgtOrig, err}
312 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
315 return TgtError{tgtOrig, err}
319 return TgtError{tgtOrig, errors.New("no .do found")}
322 // Determine basename and DIRPREFIX
323 doFileRelPath := doFile
324 ents := strings.Split(cwd, "/")
325 ents = ents[len(ents)-upLevels:]
326 dirPrefix := path.Join(ents...)
328 for i := 0; i < upLevels; i++ {
329 cwd = path.Join(cwd, "..")
330 doFileRelPath = path.Join("..", doFileRelPath)
332 cwd = path.Clean(cwd)
333 doFilePath := path.Join(cwd, doFile)
335 runErr := RunError{Tgt: tgtOrig}
336 if strings.HasPrefix(doFile, "default.") {
337 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
338 runErr.DoFile = doFileRelPath
341 if err = depWrite(fdDep, cwdOrig, doFileRelPath, ""); err != nil {
343 return TgtError{tgtOrig, err}
346 tracef(CWait, "%s", runErr.Name())
348 // Prepare command line
351 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
353 args = make([]string, 0, 3)
356 if traced || TracedAll {
357 args = append(args, "-ex")
359 args = append(args, "-e")
361 args = append(args, doFile)
364 // Temporary file for stdout
365 fdStdout, err := tempfile(cwdOrig, tgt)
368 return TgtError{tgtOrig, err}
370 stdoutPath := fdStdout.Name()
372 tmpPath := stdoutPath + ".3" // and for $3
373 tmpPathRel, err := filepath.Rel(cwd, tmpPath)
379 path.Join(dirPrefix, tgt),
380 path.Join(dirPrefix, basename),
384 cmd := exec.Command(cmdName, args...)
386 // cmd.Stdin reads from /dev/null by default
387 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
388 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
389 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
391 childStderrPrefix := tempsuffix()
392 cmd.Env = append(cmd.Env, fmt.Sprintf(
393 "%s=%s", EnvStderrPrefix, childStderrPrefix,
397 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
398 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
400 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
401 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
405 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
407 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
408 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
413 var fdStderr *os.File
415 fdStderr, err = os.OpenFile(
416 path.Join(redoDir, tgt+LogSuffix),
417 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
422 return TgtError{tgtOrig, err}
425 shCtx := fmt.Sprintf(
426 "sh: %s: %s %s cwd:%s dirprefix:%s",
427 tgtOrig, cmdName, args, cwd, dirPrefix,
429 tracef(CDebug, "%s", shCtx)
433 jsToken := jsAcquire(shCtx)
436 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
438 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
439 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
440 makeFlags := fmt.Sprintf(
441 "%s %s%d,%d", MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
443 makeFlags = strings.Trim(makeFlags, " ")
444 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", MakeFlagsName, makeFlags))
446 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
450 if _, err = FdStatus.Write([]byte{StatusRun}); err != nil {
455 var finished time.Time
456 var exitErr *exec.ExitError
457 started := time.Now()
458 runErr.Started = &started
459 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
465 cmd.Stdout = fdStdout
466 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
472 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
473 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
475 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
478 jsRelease(shCtx, jsToken)
483 logRecPath := path.Join(redoDir, tgt+LogRecSuffix)
484 if fdStderr, err = os.OpenFile(
486 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
489 fields := []recfile.Field{
490 {Name: "Build", Value: BuildUUID},
491 {Name: "PPID", Value: strconv.Itoa(os.Getpid())},
492 {Name: "Cwd", Value: cwd},
494 if cmd.Process != nil {
495 fields = append(fields, recfile.Field{
496 Name: "PID", Value: strconv.Itoa(cmd.Process.Pid),
499 ts := new(tai64n.TAI64N)
501 fields = append(fields,
502 recfile.Field{Name: "Started", Value: tai64n.Encode(ts[:])},
504 ts.FromTime(finished)
505 fields = append(fields,
506 recfile.Field{Name: "Finished", Value: tai64n.Encode(ts[:])})
507 fields = append(fields, recfile.Field{
509 Value: strconv.FormatInt(finished.Sub(started).Nanoseconds(), 10),
511 fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
512 for _, arg := range args {
513 fields = append(fields, recfile.Field{Name: "Arg", Value: arg})
515 for _, env := range cmd.Env {
516 fields = append(fields, recfile.Field{Name: "Env", Value: env})
519 fields = append(fields, recfile.Field{
521 Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
524 w := bufio.NewWriter(fdStderr)
527 fdDep, err := os.Open(fdDepPath)
531 depInfo, err = depRead(fdDep)
536 for _, dep := range depInfo.ifchanges {
537 fields = append(fields, recfile.Field{
539 Value: dep["Target"],
542 _, err = recfile.NewWriter(w).WriteFields(fields...)
550 os.Remove(logRecPath)
554 log.Println("can not open", logRecPath, ":", err)
558 os.Remove(fdDep.Name())
559 os.Remove(fdStdout.Name())
561 os.Remove(fdLock.Name())
563 if _, err = FdStatus.Write([]byte{StatusDone}); err != nil {
569 stderr, err := cmd.StderrPipe()
583 RunningProcs[cmd.Process.Pid] = cmd.Process
584 RunningProcsM.Unlock()
585 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
586 tracef(CDebug, "%s runs %s", tgtOrig, pid)
588 stderrTerm := make(chan struct{})
590 scanner := bufio.NewScanner(stderr)
592 ts := new(tai64n.TAI64N)
594 line = scanner.Text()
595 if strings.HasPrefix(line, childStderrPrefix) {
596 line = line[len(childStderrPrefix):]
597 os.Stderr.WriteString(StderrPrefix + line + "\n")
601 ts.FromTime(time.Now())
603 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
610 tracef(CNone, "%s", line)
612 tracef(CNone, "%s %s", pid, line)
618 // Wait for job completion
622 delete(RunningProcs, cmd.Process.Pid)
623 RunningProcsM.Unlock()
624 finished = time.Now()
625 runErr.Finished = &finished
627 exitErr = err.(*exec.ExitError)
634 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
635 if inodePrev == nil {
637 runErr.Err = Err1WasTouched
641 inode, err := inodeFromFile(fd)
648 if !inode.Equals(inodePrev) {
649 runErr.Err = Err1WasTouched
655 if inodePrev != nil {
656 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
657 inode, err := inodeFromFile(fd)
659 if err == nil && !inode.Equals(inodePrev) {
660 runErr.Err = Err1WasTouched
667 // Does it produce both stdout and tmp?
668 fiStdout, err := os.Stat(fdStdout.Name())
675 _, err = os.Stat(tmpPath)
677 if fiStdout.Size() > 0 {
678 runErr.Err = errors.New("created both tmp and stdout")
683 } else if !os.IsNotExist(err) {
689 // Determine what file we must process at last
692 fd, err = os.Open(tmpPath)
697 } else if fiStdout.Size() > 0 {
701 // Do we need to ifcreate it, or ifchange with renaming?
703 os.Remove(path.Join(cwdOrig, tgt))
704 err = ifcreate(fdDep, tgt)
711 _, err = fd.Seek(0, io.SeekStart)
715 hsh, err = fileHash(fd)
720 tracef(CDebug, "%s has same hash, not renaming", tgtOrig)
721 err = os.Remove(fd.Name())
725 err = os.Chtimes(path.Join(cwdOrig, tgt), finished, finished)
730 err = syncDir(cwdOrig)
735 err = depWrite(fdDep, cwdOrig, tgt, hshPrev)
748 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
753 err = syncDir(cwdOrig)
758 err = depWrite(fdDep, cwdOrig, tgt, hsh)
772 fdDepPath = path.Join(redoDir, tgt+DepSuffix)
773 err = os.Rename(fdDep.Name(), fdDepPath)
778 err = syncDir(redoDir)
784 // Post-commit .rec sanitizing
786 if fdDepR, err := os.Open(fdDepPath); err == nil {
787 depInfo, err := depRead(fdDepR)
792 ifchangeSeen := make(map[string]struct{}, len(depInfo.ifchanges))
793 for _, dep := range depInfo.ifchanges {
794 ifchangeSeen[dep["Target"]] = struct{}{}
796 for _, dep := range depInfo.ifcreates {
797 if _, exists := ifchangeSeen[dep]; exists {
798 tracef(CWarn, "simultaneous ifcreate and ifchange records: %s", tgt)
810 func isOkRun(err error) bool {
815 if errors.As(err, &runErr) && runErr.Err == nil {
816 tracef(CRedo, "%s", runErr.Name())
819 tracef(CErr, "%s", err)