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/>.
41 "go.cypherpunks.ru/recfile"
42 "go.cypherpunks.ru/tai64n/v2"
43 "golang.org/x/sys/unix"
47 EnvDepFd = "REDO_DEP_FD"
48 EnvDirPrefix = "REDO_DIRPREFIX"
49 EnvDepCwd = "REDO_DEP_CWD"
50 EnvBuildUUID = "REDO_BUILD_UUID"
51 EnvStderrPrefix = "REDO_STDERR_PREFIX"
52 EnvTrace = "REDO_TRACE"
53 EnvStderrKeep = "REDO_LOGS"
54 EnvStderrSilent = "REDO_SILENT"
55 EnvNoSync = "REDO_NO_SYNC"
56 EnvStopIfMod = "REDO_STOP_IF_MODIFIED"
63 LogRecSuffix = ".log-rec"
77 flagStderrSilent *bool
78 flagForcedIfchange *bool
82 RunningProcs = map[int]*os.Process{}
83 RunningProcsM sync.Mutex
85 Err1WasTouched = errors.New("$1 was explicitly touched")
90 if !(cmdName == CmdNameRedo || cmdName == CmdNameRedoIfchange) {
93 flagTrace = flag.Bool("x", false, "trace (sh -x) current targets")
94 flagTraceAll = flag.Bool("xx", false,
95 fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
96 flagStderrKeep = flag.Bool("k", false,
97 fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
98 flagStderrSilent = flag.Bool("s", false,
99 fmt.Sprintf("silent, do not print job's stderr (%s=1)", EnvStderrSilent))
100 flagForcedIfchange = flag.Bool("f", false, "forced redo-ifchange")
103 type RunError struct {
111 func (e *RunError) Name() string {
114 name = e.Tgt.String()
116 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
118 if e.Finished == nil {
121 return fmt.Sprintf("%s (%.3fs)", name, e.Finished.Sub(*e.Started).Seconds())
124 func (e RunError) Error() string {
125 return fmt.Sprintf("%s: %s", e.Name(), e.Err)
128 func mkdirs(pth string) error {
132 return os.MkdirAll(pth, os.FileMode(0777))
135 func isModified(depInfo *DepInfo, tgt *Tgt) (
136 modified bool, ourInode *Inode, hshPrev string, err error,
141 for _, dep := range depInfo.ifchanges {
142 if dep.tgt.a != tgt.a {
145 ourInode, err = inodeFromFileByPath(tgt.a)
147 if os.IsNotExist(err) {
155 modified = !ourInode.Equals(dep.inode)
161 func syncDir(dir string) error {
162 fd, err := os.Open(dir)
171 func runScript(tgt *Tgt, errs chan error, forced, traced bool) error {
172 redoDir := path.Join(tgt.h, RedoDir)
173 if err := mkdirs(redoDir); err != nil {
174 return TgtError{tgt, ErrLine(err)}
177 shCtx := fmt.Sprintf("sh: %s: cwd:%s", tgt, tgt.h)
178 jsToken := jsAcquire(shCtx)
179 jsNeedsRelease := true
182 jsRelease(shCtx, jsToken)
187 fdLock, err := os.OpenFile(
188 path.Join(redoDir, tgt.t+LockSuffix),
189 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
193 return TgtError{tgt, ErrLine(err)}
195 flock := unix.Flock_t{
197 Whence: io.SeekStart,
199 lockRelease := func() {
200 tracef(CLock, "LOCK_UN: %s", fdLock.Name())
201 flock.Type = unix.F_UNLCK
202 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
203 log.Fatalln(err, fdLock.Name())
207 tracef(CLock, "LOCK_NB: %s", fdLock.Name())
209 // Waiting for job completion, already taken by someone else
210 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
211 if uintptr(err.(syscall.Errno)) != uintptr(unix.EAGAIN) {
213 return TgtError{tgt, ErrLine(err)}
216 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_GETLK, &flock); err != nil {
217 log.Fatalln(err, fdLock.Name())
219 tracef(CDebug, "waiting: %s (pid=%d)", tgt, flock.Pid)
221 if _, err = FdStatus.Write([]byte{StatusWait}); err != nil {
227 tracef(CLock, "LOCK_EX: %s", fdLock.Name())
229 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLKW, &flock); err != nil {
230 if errors.Is(err, unix.EDEADLK) {
231 time.Sleep(10 * time.Millisecond)
234 log.Fatalln(err, fdLock.Name())
237 tracef(CDebug, "waiting done: %s", tgt)
239 if _, err = FdStatus.Write([]byte{StatusWaited}); err != nil {
243 build, err := depReadBuild(tgt.Dep())
245 if build != BuildUUID {
246 err = errors.New("was not built: build differs")
249 if errors.Is(err, fs.ErrNotExist) {
250 err = errors.New("was not built: no .rec")
254 err = TgtError{tgt, err}
261 // It scans the whole .rec file while searching for the single target,
262 // but that one is always located at the very end
263 depInfo, err := depRead(tgt)
265 if errors.Is(err, fs.ErrNotExist) {
269 return TgtError{tgt, ErrLine(err)}
273 // Check if it was already built in parallel
274 if !forced && depInfo != nil && depInfo.build == BuildUUID {
280 // Check if target is not modified externally
281 modified, inodePrev, hshPrev, err := isModified(depInfo, tgt)
284 return TgtError{tgt, ErrLine(err)}
289 return fmt.Errorf("%s externally modified", tgt)
291 tracef(CWarn, "%s externally modified: not redoing", tgt)
299 // Start preparing .rec
300 fdDep, err := tempfile(redoDir, tgt.t+DepSuffix)
303 return TgtError{tgt, ErrLine(err)}
313 os.Remove(fdDep.Name())
316 if _, err = recfile.NewWriter(fdDep).WriteFields(
317 recfile.Field{Name: "Build", Value: BuildUUID},
320 return TgtError{tgt, ErrLine(err)}
327 runErr := RunError{Tgt: tgt}
328 // Determine basename and DIRPREFIX
330 doFileRelPath, upLevels, err := findDo(fdDep, tgt.h, tgt.t)
333 return TgtError{tgt, ErrLine(err)}
335 if doFileRelPath == "" {
337 return TgtError{tgt, errors.New("no .do found")}
339 // ents := strings.Split(strings.TrimSuffix(tgt.h, "/"), "/")
340 ents := strings.Split(tgt.h, "/")
341 ents = ents[len(ents)-upLevels:]
342 dirPrefix = path.Join(ents...)
343 ups := make([]string, 0, upLevels+2)
344 ups = append(ups, tgt.h)
345 for i := 0; i < upLevels; i++ {
346 ups = append(ups, "..")
348 ups = append(ups, doFileRelPath)
349 cwd = path.Clean(path.Join(ups[:len(ups)-1]...))
350 doFile = NewTgt(path.Join(ups...))
351 if strings.HasPrefix(doFile.t, "default.") {
352 basename = basename[:len(basename)-(len(doFile.t)-len("default.")-len(".do"))-1]
353 runErr.DoFile = doFile.String()
357 if err = depWrite(fdDep, tgt.h, doFile, ""); err != nil {
359 return TgtError{tgt, ErrLine(err)}
363 tracef(CWait, "%s", runErr.Name())
365 // Prepare command line
368 if err = unix.Access(doFile.String(), unix.X_OK); err == nil {
370 args = make([]string, 0, 3)
373 if traced || TracedAll {
374 args = append(args, "-ex")
376 args = append(args, "-e")
378 args = append(args, doFile.t)
381 // Temporary file for stdout
382 fdStdout, err := tempfile(tgt.h, tgt.t)
385 return TgtError{tgt, ErrLine(err)}
388 tmpPath := fdStdout.Name() + ".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(fdStdout.Name(), os.O_RDWR, os.FileMode(0666))
487 cmd.Stdout = fdStdout
488 fdDep, err = os.OpenFile(fdDep.Name(), 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)
586 os.Remove(fdDep.Name())
588 os.Remove(fdStdout.Name())
591 if _, err = FdStatus.Write([]byte{StatusDone}); err != nil {
597 stderr, err := cmd.StderrPipe()
611 RunningProcs[cmd.Process.Pid] = cmd.Process
612 RunningProcsM.Unlock()
613 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
614 tracef(CDebug, "%s runs %s", tgt, pid)
616 stderrTerm := make(chan struct{})
618 scanner := bufio.NewScanner(stderr)
620 ts := new(tai64n.TAI64N)
622 line = scanner.Text()
623 if strings.HasPrefix(line, childStderrPrefix) {
624 line = line[len(childStderrPrefix):]
625 os.Stderr.WriteString(StderrPrefix + line + "\n")
629 ts.FromTime(time.Now())
631 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
638 tracef(CNone, "%s", line)
640 tracef(CNone, "%s %s", pid, line)
646 // Wait for job completion
650 delete(RunningProcs, cmd.Process.Pid)
651 RunningProcsM.Unlock()
652 finished = time.Now()
653 runErr.Finished = &finished
655 exitErr = err.(*exec.ExitError)
662 if inode, err := inodeFromFileByPath(tgt.a); err == nil {
663 if inodePrev == nil {
664 runErr.Err = Err1WasTouched
673 if !inode.Equals(inodePrev) {
674 runErr.Err = Err1WasTouched
680 // Does it produce both stdout and tmp?
681 fiStdout, err := os.Stat(fdStdout.Name())
683 runErr.Err = ErrLine(err)
688 _, err = os.Stat(tmpPath)
690 if fiStdout.Size() > 0 {
691 runErr.Err = errors.New("created both tmp and stdout")
696 } else if !errors.Is(err, fs.ErrNotExist) {
697 runErr.Err = ErrLine(err)
702 // Determine what file we must process at last
705 fd, err = os.Open(tmpPath)
711 } else if fiStdout.Size() > 0 {
715 // Do we need to ifcreate it, or ifchange with renaming?
718 err = ifcreate(fdDep, tgt.t)
726 _, err = fd.Seek(0, io.SeekStart)
731 hsh, err = fileHash(fd)
737 tracef(CDebug, "%s has same hash, not renaming", tgt)
738 err = ErrLine(os.Remove(fd.Name()))
742 err = ErrLine(os.Chtimes(tgt.a, finished, finished))
747 err = ErrLine(syncDir(tgt.h))
752 err = ErrLine(depWrite(fdDep, tgt.h, tgt, hsh))
760 err = ErrLine(fd.Sync())
765 err = ErrLine(os.Rename(fd.Name(), tgt.a))
770 err = ErrLine(syncDir(tgt.h))
775 err = ErrLine(depWrite(fdDep, tgt.h, tgt, hsh))
784 err = ErrLine(fdDep.Sync())
789 err = ErrLine(os.Rename(fdDep.Name(), tgt.Dep()))
795 err = ErrLine(syncDir(redoDir))
803 // Post-commit .rec sanitizing
804 if depInfo, err := depRead(tgt); err == nil {
805 ifchangeSeen := make(map[string]struct{}, len(depInfo.ifchanges))
806 for _, dep := range depInfo.ifchanges {
807 ifchangeSeen[dep.tgt.a] = struct{}{}
809 for _, dep := range depInfo.ifcreates {
810 if _, exists := ifchangeSeen[dep.a]; exists {
811 tracef(CWarn, "simultaneous ifcreate and ifchange records: %s", tgt)
814 } else if errors.Is(err, fs.ErrNotExist) {
828 func isOkRun(err error) bool {
833 if errors.As(err, &runErr) && runErr.Err == nil {
834 tracef(CRedo, "%s", runErr.Name())
837 tracef(CErr, "%s", err)