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/>.
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, 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 {
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 {
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())
245 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLKW, &flock); err != nil {
249 tracef(CDebug, "waiting done: %s", tgtOrig)
251 if _, err = FdStatus.Write([]byte{StatusWaited}); err != nil {
256 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
258 if os.IsNotExist(err) {
259 err = errors.New("was not built: no .rec")
264 depInfo, err = depRead(fdDep)
268 if depInfo.build != BuildUUID {
269 err = errors.New("was not built: build differs")
273 err = TgtError{tgtOrig, err}
281 // Check if target is not modified externally
282 modified, inodePrev, hshPrev, err := isModified(cwd, redoDir, tgt)
285 return TgtError{tgtOrig, err}
290 return fmt.Errorf("%s externally modified", tgtOrig)
292 tracef(CWarn, "%s externally modified: not redoing", tgtOrig)
299 // Start preparing .rec
300 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
303 return TgtError{tgtOrig, err}
305 fdDepPath := fdDep.Name()
309 os.Remove(fdDep.Name())
311 if _, err = recfile.NewWriter(fdDep).WriteFields(
312 recfile.Field{Name: "Build", Value: BuildUUID},
315 return TgtError{tgtOrig, err}
319 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
322 return TgtError{tgtOrig, err}
326 return TgtError{tgtOrig, errors.New("no .do found")}
329 // Determine basename and DIRPREFIX
330 doFileRelPath := doFile
331 ents := strings.Split(cwd, "/")
332 ents = ents[len(ents)-upLevels:]
333 dirPrefix := path.Join(ents...)
335 for i := 0; i < upLevels; i++ {
336 cwd = path.Join(cwd, "..")
337 doFileRelPath = path.Join("..", doFileRelPath)
339 cwd = path.Clean(cwd)
340 doFilePath := path.Join(cwd, doFile)
342 runErr := RunError{Tgt: tgtOrig}
343 if strings.HasPrefix(doFile, "default.") {
344 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
345 runErr.DoFile = doFileRelPath
348 if err = depWrite(fdDep, cwdOrig, doFileRelPath, ""); err != nil {
350 return TgtError{tgtOrig, err}
353 tracef(CWait, "%s", runErr.Name())
355 // Prepare command line
358 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
360 args = make([]string, 0, 3)
363 if traced || TracedAll {
364 args = append(args, "-ex")
366 args = append(args, "-e")
368 args = append(args, doFile)
371 // Temporary file for stdout
372 fdStdout, err := tempfile(cwdOrig, tgt)
375 return TgtError{tgtOrig, err}
377 stdoutPath := fdStdout.Name()
379 tmpPath := stdoutPath + ".3" // and for $3
380 tmpPathRel, err := filepath.Rel(cwd, tmpPath)
386 path.Join(dirPrefix, tgt),
387 path.Join(dirPrefix, basename),
391 "sh: %s: %s %s cwd:%s dirprefix:%s",
392 tgtOrig, cmdName, args, cwd, dirPrefix,
395 cmd := exec.Command(cmdName, args...)
397 // cmd.Stdin reads from /dev/null by default
398 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
399 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
400 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
402 childStderrPrefixRaw := make([]byte, 8)
403 if _, err = io.ReadFull(rand.Reader, childStderrPrefixRaw); err != nil {
406 childStderrPrefix := hex.EncodeToString(childStderrPrefixRaw)
407 cmd.Env = append(cmd.Env, fmt.Sprintf(
408 "%s=%s", EnvStderrPrefix, childStderrPrefix,
412 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
413 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
415 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
416 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
420 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
422 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
423 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
428 var fdStderr *os.File
430 fdStderr, err = os.OpenFile(
431 path.Join(redoDir, tgt+LogSuffix),
432 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
437 return TgtError{tgtOrig, err}
440 tracef(CDebug, "%s", shCtx)
442 jsNeedsRelease = false
447 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
449 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
450 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
451 makeFlags := fmt.Sprintf(
452 "%s %s%d,%d", MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
454 makeFlags = strings.Trim(makeFlags, " ")
455 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", MakeFlagsName, makeFlags))
457 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
461 if _, err = FdStatus.Write([]byte{StatusRun}); err != nil {
466 defer jsRelease(shCtx, jsToken)
468 var finished time.Time
469 var exitErr *exec.ExitError
470 started := time.Now()
471 runErr.Started = &started
472 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
481 cmd.Stdout = fdStdout
482 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
492 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
493 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
495 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
502 logRecPath := path.Join(redoDir, tgt+LogRecSuffix)
503 if fdStderr, err = os.OpenFile(
505 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
508 fields := []recfile.Field{
509 {Name: "Build", Value: BuildUUID},
510 {Name: "PPID", Value: strconv.Itoa(os.Getpid())},
511 {Name: "Cwd", Value: cwd},
513 if cmd.Process != nil {
514 fields = append(fields, recfile.Field{
515 Name: "PID", Value: strconv.Itoa(cmd.Process.Pid),
518 ts := new(tai64n.TAI64N)
520 fields = append(fields,
521 recfile.Field{Name: "Started", Value: tai64n.Encode(ts[:])},
523 ts.FromTime(finished)
524 fields = append(fields,
525 recfile.Field{Name: "Finished", Value: tai64n.Encode(ts[:])})
526 fields = append(fields, recfile.Field{
528 Value: strconv.FormatInt(finished.Sub(started).Nanoseconds(), 10),
530 fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
531 for _, arg := range args {
532 fields = append(fields, recfile.Field{Name: "Arg", Value: arg})
534 for _, env := range cmd.Env {
535 fields = append(fields, recfile.Field{Name: "Env", Value: env})
538 fields = append(fields, recfile.Field{
540 Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
543 w := bufio.NewWriter(fdStderr)
546 fdDep, err := os.Open(fdDepPath)
550 depInfo, err = depRead(fdDep)
555 for _, dep := range depInfo.ifchanges {
556 fields = append(fields, recfile.Field{
558 Value: dep["Target"],
561 _, err = recfile.NewWriter(w).WriteFields(fields...)
569 os.Remove(logRecPath)
573 log.Println("can not open", logRecPath, ":", err)
577 os.Remove(fdDep.Name())
578 os.Remove(fdStdout.Name())
580 os.Remove(fdLock.Name())
582 if _, err = FdStatus.Write([]byte{StatusDone}); err != nil {
588 stderr, err := cmd.StderrPipe()
602 RunningProcs[cmd.Process.Pid] = cmd.Process
603 RunningProcsM.Unlock()
604 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
605 tracef(CDebug, "%s runs %s", tgtOrig, pid)
607 stderrTerm := make(chan struct{})
609 scanner := bufio.NewScanner(stderr)
611 ts := new(tai64n.TAI64N)
613 line = scanner.Text()
614 if strings.HasPrefix(line, childStderrPrefix) {
615 line = line[len(childStderrPrefix):]
616 os.Stderr.WriteString(StderrPrefix + line + "\n")
620 ts.FromTime(time.Now())
622 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
629 tracef(CNone, "%s", line)
631 tracef(CNone, "%s %s", pid, line)
637 // Wait for job completion
641 delete(RunningProcs, cmd.Process.Pid)
642 RunningProcsM.Unlock()
643 finished = time.Now()
644 runErr.Finished = &finished
646 exitErr = err.(*exec.ExitError)
653 if inode, err := inodeFromFileByPath(path.Join(cwdOrig, tgt)); err == nil {
654 if inodePrev == nil {
655 runErr.Err = Err1WasTouched
664 if !inode.Equals(inodePrev) {
665 runErr.Err = Err1WasTouched
671 if inodePrev != nil {
672 if inode, err := inodeFromFileByPath(path.Join(cwdOrig, tgt)); err == nil {
673 if !inode.Equals(inodePrev) {
674 runErr.Err = Err1WasTouched
681 // Does it produce both stdout and tmp?
682 fiStdout, err := os.Stat(fdStdout.Name())
689 _, err = os.Stat(tmpPath)
691 if fiStdout.Size() > 0 {
692 runErr.Err = errors.New("created both tmp and stdout")
697 } else if !os.IsNotExist(err) {
703 // Determine what file we must process at last
706 fd, err = os.Open(tmpPath)
711 } else if fiStdout.Size() > 0 {
715 // Do we need to ifcreate it, or ifchange with renaming?
717 os.Remove(path.Join(cwdOrig, tgt))
718 err = ifcreate(fdDep, tgt)
725 _, err = fd.Seek(0, io.SeekStart)
729 hsh, err = fileHash(fd)
734 tracef(CDebug, "%s has same hash, not renaming", tgtOrig)
735 err = os.Remove(fd.Name())
739 err = os.Chtimes(path.Join(cwdOrig, tgt), finished, finished)
744 err = syncDir(cwdOrig)
749 err = depWrite(fdDep, cwdOrig, tgt, hshPrev)
762 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
767 err = syncDir(cwdOrig)
772 err = depWrite(fdDep, cwdOrig, tgt, hsh)
786 fdDepPath = path.Join(redoDir, tgt+DepSuffix)
787 err = os.Rename(fdDep.Name(), fdDepPath)
792 err = syncDir(redoDir)
798 // Post-commit .rec sanitizing
800 if fdDepR, err := os.Open(fdDepPath); err == nil {
801 depInfo, err := depRead(fdDepR)
806 ifchangeSeen := make(map[string]struct{}, len(depInfo.ifchanges))
807 for _, dep := range depInfo.ifchanges {
808 ifchangeSeen[dep["Target"]] = struct{}{}
810 for _, dep := range depInfo.ifcreates {
811 if _, exists := ifchangeSeen[dep]; exists {
812 tracef(CWarn, "simultaneous ifcreate and ifchange records: %s", tgt)
824 func isOkRun(err error) bool {
829 if errors.As(err, &runErr) && runErr.Err == nil {
830 tracef(CRedo, "%s", runErr.Name())
833 tracef(CErr, "%s", err)