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 {
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(cwd, redoDir, tgt string) (bool, *Inode, string, error) {
136 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
138 if os.IsNotExist(err) {
139 return false, nil, "", nil
141 return false, nil, "", err
144 r := recfile.NewReader(fdDep)
149 m, err := r.NextMap()
151 if errors.Is(err, io.EOF) {
154 return false, nil, "", err
156 if m["Type"] != DepTypeIfchange || m["Target"] != tgt {
159 ourInode, err = inodeFromFileByPath(path.Join(cwd, tgt))
161 if os.IsNotExist(err) {
162 return false, nil, "", nil
164 return false, nil, "", err
166 theirInode, err := inodeFromRec(m)
168 return false, nil, "", err
171 modified = !ourInode.Equals(theirInode)
174 return modified, ourInode, hshPrev, nil
177 func syncDir(dir string) error {
178 fd, err := os.Open(dir)
187 func runScript(tgtOrig string, errs chan error, forced, traced bool) error {
188 cwd, tgt := cwdAndTgt(tgtOrig)
189 redoDir := path.Join(cwd, RedoDir)
190 if err := mkdirs(redoDir); err != nil {
191 return TgtError{tgtOrig, err}
194 shCtx := fmt.Sprintf("sh: %s: cwd:%s", tgtOrig, cwd)
195 jsToken := jsAcquire(shCtx)
196 jsNeedsRelease := true
199 jsRelease(shCtx, jsToken)
204 fdLock, err := os.OpenFile(
205 path.Join(redoDir, tgt+LockSuffix),
206 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
210 return TgtError{tgtOrig, err}
212 flock := unix.Flock_t{
214 Whence: io.SeekStart,
216 lockRelease := func() {
217 tracef(CLock, "LOCK_UN: %s", fdLock.Name())
218 flock.Type = unix.F_UNLCK
219 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
220 log.Fatalln(err, fdLock.Name())
224 tracef(CLock, "LOCK_NB: %s", fdLock.Name())
226 // Waiting for job completion, already taken by someone else
227 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
228 if uintptr(err.(syscall.Errno)) != uintptr(unix.EAGAIN) {
230 return TgtError{tgtOrig, err}
233 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_GETLK, &flock); err != nil {
234 log.Fatalln(err, fdLock.Name())
236 tracef(CDebug, "waiting: %s (pid=%d)", tgtOrig, flock.Pid)
238 if _, err = FdStatus.Write([]byte{StatusWait}); err != nil {
244 tracef(CLock, "LOCK_EX: %s", fdLock.Name())
246 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLKW, &flock); err != nil {
247 log.Println(err, fdLock.Name())
248 time.Sleep(10 * time.Millisecond)
252 tracef(CDebug, "waiting done: %s", tgtOrig)
254 if _, err = FdStatus.Write([]byte{StatusWaited}); err != nil {
259 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
261 if os.IsNotExist(err) {
262 err = errors.New("was not built: no .rec")
267 depInfo, err = depRead(fdDep)
271 if depInfo.build != BuildUUID {
272 err = errors.New("was not built: build differs")
276 err = TgtError{tgtOrig, err}
284 // Check if it was already built in parallel
286 if fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix)); err == nil {
287 depInfo, err := depRead(fdDep)
289 if err == nil && depInfo.build == BuildUUID {
297 // Check if target is not modified externally
298 modified, inodePrev, hshPrev, err := isModified(cwd, redoDir, tgt)
301 return TgtError{tgtOrig, err}
306 return fmt.Errorf("%s externally modified", tgtOrig)
308 tracef(CWarn, "%s externally modified: not redoing", tgtOrig)
315 // Start preparing .rec
316 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
319 return TgtError{tgtOrig, err}
321 fdDepPath := fdDep.Name()
325 os.Remove(fdDep.Name())
327 if _, err = recfile.NewWriter(fdDep).WriteFields(
328 recfile.Field{Name: "Build", Value: BuildUUID},
331 return TgtError{tgtOrig, err}
335 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
338 return TgtError{tgtOrig, err}
342 return TgtError{tgtOrig, errors.New("no .do found")}
345 // Determine basename and DIRPREFIX
346 doFileRelPath := doFile
347 ents := strings.Split(cwd, "/")
348 ents = ents[len(ents)-upLevels:]
349 dirPrefix := path.Join(ents...)
351 for i := 0; i < upLevels; i++ {
352 cwd = path.Join(cwd, "..")
353 doFileRelPath = path.Join("..", doFileRelPath)
355 cwd = path.Clean(cwd)
356 doFilePath := path.Join(cwd, doFile)
358 runErr := RunError{Tgt: tgtOrig}
359 if strings.HasPrefix(doFile, "default.") {
360 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
361 runErr.DoFile = doFileRelPath
364 if err = depWrite(fdDep, cwdOrig, doFileRelPath, ""); err != nil {
366 return TgtError{tgtOrig, err}
369 tracef(CWait, "%s", runErr.Name())
371 // Prepare command line
374 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
376 args = make([]string, 0, 3)
379 if traced || TracedAll {
380 args = append(args, "-ex")
382 args = append(args, "-e")
384 args = append(args, doFile)
387 // Temporary file for stdout
388 fdStdout, err := tempfile(cwdOrig, tgt)
391 return TgtError{tgtOrig, err}
393 stdoutPath := fdStdout.Name()
395 tmpPath := stdoutPath + ".3" // and for $3
396 tmpPathRel, err := filepath.Rel(cwd, tmpPath)
402 path.Join(dirPrefix, tgt),
403 path.Join(dirPrefix, basename),
407 "sh: %s: %s %s cwd:%s dirprefix:%s",
408 tgtOrig, cmdName, args, cwd, dirPrefix,
411 cmd := exec.Command(cmdName, args...)
413 // cmd.Stdin reads from /dev/null by default
414 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
415 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
416 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
418 childStderrPrefixRaw := make([]byte, 8)
419 if _, err = io.ReadFull(rand.Reader, childStderrPrefixRaw); err != nil {
422 childStderrPrefix := hex.EncodeToString(childStderrPrefixRaw)
423 cmd.Env = append(cmd.Env, fmt.Sprintf(
424 "%s=%s", EnvStderrPrefix, childStderrPrefix,
428 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
429 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
431 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
432 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
436 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
438 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
439 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
444 var fdStderr *os.File
446 fdStderr, err = os.OpenFile(
447 path.Join(redoDir, tgt+LogSuffix),
448 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
453 return TgtError{tgtOrig, err}
456 tracef(CDebug, "%s", shCtx)
458 jsNeedsRelease = false
463 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
465 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
466 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
467 makeFlags := fmt.Sprintf(
468 "%s %s%d,%d", MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
470 makeFlags = strings.Trim(makeFlags, " ")
471 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", MakeFlagsName, makeFlags))
473 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
477 if _, err = FdStatus.Write([]byte{StatusRun}); err != nil {
482 defer jsRelease(shCtx, jsToken)
484 var finished time.Time
485 var exitErr *exec.ExitError
486 started := time.Now()
487 runErr.Started = &started
488 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
497 cmd.Stdout = fdStdout
498 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
508 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
509 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
511 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
518 logRecPath := path.Join(redoDir, tgt+LogRecSuffix)
519 if fdStderr, err = os.OpenFile(
521 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
524 fields := []recfile.Field{
525 {Name: "Build", Value: BuildUUID},
526 {Name: "PPID", Value: strconv.Itoa(os.Getpid())},
527 {Name: "Cwd", Value: cwd},
529 if cmd.Process != nil {
530 fields = append(fields, recfile.Field{
531 Name: "PID", Value: strconv.Itoa(cmd.Process.Pid),
534 ts := new(tai64n.TAI64N)
536 fields = append(fields,
537 recfile.Field{Name: "Started", Value: tai64n.Encode(ts[:])},
539 ts.FromTime(finished)
540 fields = append(fields,
541 recfile.Field{Name: "Finished", Value: tai64n.Encode(ts[:])})
542 fields = append(fields, recfile.Field{
544 Value: strconv.FormatInt(finished.Sub(started).Nanoseconds(), 10),
546 fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
547 for _, arg := range args {
548 fields = append(fields, recfile.Field{Name: "Arg", Value: arg})
550 for _, env := range cmd.Env {
551 fields = append(fields, recfile.Field{Name: "Env", Value: env})
554 fields = append(fields, recfile.Field{
556 Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
559 w := bufio.NewWriter(fdStderr)
562 fdDep, err := os.Open(fdDepPath)
566 depInfo, err = depRead(fdDep)
571 for _, dep := range depInfo.ifchanges {
572 fields = append(fields, recfile.Field{
574 Value: dep["Target"],
577 _, err = recfile.NewWriter(w).WriteFields(fields...)
585 os.Remove(logRecPath)
589 log.Println("can not open", logRecPath, ":", err)
593 os.Remove(fdDep.Name())
594 os.Remove(fdStdout.Name())
597 if _, err = FdStatus.Write([]byte{StatusDone}); err != nil {
603 stderr, err := cmd.StderrPipe()
617 RunningProcs[cmd.Process.Pid] = cmd.Process
618 RunningProcsM.Unlock()
619 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
620 tracef(CDebug, "%s runs %s", tgtOrig, pid)
622 stderrTerm := make(chan struct{})
624 scanner := bufio.NewScanner(stderr)
626 ts := new(tai64n.TAI64N)
628 line = scanner.Text()
629 if strings.HasPrefix(line, childStderrPrefix) {
630 line = line[len(childStderrPrefix):]
631 os.Stderr.WriteString(StderrPrefix + line + "\n")
635 ts.FromTime(time.Now())
637 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
644 tracef(CNone, "%s", line)
646 tracef(CNone, "%s %s", pid, line)
652 // Wait for job completion
656 delete(RunningProcs, cmd.Process.Pid)
657 RunningProcsM.Unlock()
658 finished = time.Now()
659 runErr.Finished = &finished
661 exitErr = err.(*exec.ExitError)
668 if inode, err := inodeFromFileByPath(path.Join(cwdOrig, tgt)); err == nil {
669 if inodePrev == nil {
670 runErr.Err = Err1WasTouched
679 if !inode.Equals(inodePrev) {
680 runErr.Err = Err1WasTouched
686 if inodePrev != nil {
687 if inode, err := inodeFromFileByPath(path.Join(cwdOrig, tgt)); err == nil {
688 if !inode.Equals(inodePrev) {
689 runErr.Err = Err1WasTouched
696 // Does it produce both stdout and tmp?
697 fiStdout, err := os.Stat(fdStdout.Name())
704 _, err = os.Stat(tmpPath)
706 if fiStdout.Size() > 0 {
707 runErr.Err = errors.New("created both tmp and stdout")
712 } else if !os.IsNotExist(err) {
718 // Determine what file we must process at last
721 fd, err = os.Open(tmpPath)
726 } else if fiStdout.Size() > 0 {
730 // Do we need to ifcreate it, or ifchange with renaming?
732 os.Remove(path.Join(cwdOrig, tgt))
733 err = ifcreate(fdDep, tgt)
740 _, err = fd.Seek(0, io.SeekStart)
744 hsh, err = fileHash(fd)
749 tracef(CDebug, "%s has same hash, not renaming", tgtOrig)
750 err = os.Remove(fd.Name())
754 err = os.Chtimes(path.Join(cwdOrig, tgt), finished, finished)
759 err = syncDir(cwdOrig)
764 err = depWrite(fdDep, cwdOrig, tgt, hshPrev)
777 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
782 err = syncDir(cwdOrig)
787 err = depWrite(fdDep, cwdOrig, tgt, hsh)
801 fdDepPath = path.Join(redoDir, tgt+DepSuffix)
802 err = os.Rename(fdDep.Name(), fdDepPath)
807 err = syncDir(redoDir)
813 // Post-commit .rec sanitizing
815 if fdDepR, err := os.Open(fdDepPath); err == nil {
816 depInfo, err := depRead(fdDepR)
821 ifchangeSeen := make(map[string]struct{}, len(depInfo.ifchanges))
822 for _, dep := range depInfo.ifchanges {
823 ifchangeSeen[dep["Target"]] = struct{}{}
825 for _, dep := range depInfo.ifcreates {
826 if _, exists := ifchangeSeen[dep]; exists {
827 tracef(CWarn, "simultaneous ifcreate and ifchange records: %s", tgt)
839 func isOkRun(err error) bool {
844 if errors.As(err, &runErr) && runErr.Err == nil {
845 tracef(CRedo, "%s", runErr.Name())
848 tracef(CErr, "%s", err)