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 {
129 if _, err := os.Stat(pth); err == nil {
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 fd, err := os.Open(path.Join(cwd, tgt))
161 if os.IsNotExist(err) {
162 return false, nil, "", nil
164 return false, nil, "", err
166 ourInode, err = inodeFromFile(fd)
169 return false, nil, "", err
171 theirInode, err := inodeFromRec(m)
173 return false, nil, "", err
176 modified = !ourInode.Equals(theirInode)
179 return modified, ourInode, hshPrev, nil
182 func syncDir(dir string) error {
183 fd, err := os.Open(dir)
192 func runScript(tgtOrig string, errs chan error, traced bool) error {
193 cwd, tgt := cwdAndTgt(tgtOrig)
194 redoDir := path.Join(cwd, RedoDir)
195 if err := mkdirs(redoDir); err != nil {
196 return TgtError{tgtOrig, err}
199 shCtx := fmt.Sprintf("sh: %s: cwd:%s", tgtOrig, cwd)
200 jsToken := jsAcquire(shCtx)
201 jsNeedsRelease := true
204 jsRelease(shCtx, jsToken)
209 fdLock, err := os.OpenFile(
210 path.Join(redoDir, tgt+LockSuffix),
211 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
215 return TgtError{tgtOrig, err}
217 flock := unix.Flock_t{
219 Whence: io.SeekStart,
221 lockRelease := func() {
222 tracef(CLock, "LOCK_UN: %s", fdLock.Name())
223 flock.Type = unix.F_UNLCK
224 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
229 tracef(CLock, "LOCK_NB: %s", fdLock.Name())
231 // Waiting for job completion, already taken by someone else
232 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
233 if uintptr(err.(syscall.Errno)) != uintptr(unix.EAGAIN) {
235 return TgtError{tgtOrig, err}
238 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_GETLK, &flock); err != nil {
241 tracef(CDebug, "waiting: %s (pid=%d)", tgtOrig, flock.Pid)
243 if _, err = FdStatus.Write([]byte{StatusWait}); err != nil {
249 tracef(CLock, "LOCK_EX: %s", fdLock.Name())
250 if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLKW, &flock); err != nil {
254 tracef(CDebug, "waiting done: %s", tgtOrig)
256 if _, err = FdStatus.Write([]byte{StatusWaited}); err != nil {
261 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
263 if os.IsNotExist(err) {
264 err = errors.New("was not built: no .rec")
269 depInfo, err = depRead(fdDep)
273 if depInfo.build != BuildUUID {
274 err = errors.New("was not built: build differs")
278 err = TgtError{tgtOrig, err}
286 // Check if target is not modified externally
287 modified, inodePrev, hshPrev, err := isModified(cwd, redoDir, tgt)
290 return TgtError{tgtOrig, err}
295 return fmt.Errorf("%s externally modified", tgtOrig)
297 tracef(CWarn, "%s externally modified: not redoing", tgtOrig)
304 // Start preparing .rec
305 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
308 return TgtError{tgtOrig, err}
310 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, err}
324 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
327 return TgtError{tgtOrig, 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, ""); err != nil {
355 return TgtError{tgtOrig, err}
358 tracef(CWait, "%s", runErr.Name())
360 // Prepare command line
363 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
365 args = make([]string, 0, 3)
368 if traced || TracedAll {
369 args = append(args, "-ex")
371 args = append(args, "-e")
373 args = append(args, doFile)
376 // Temporary file for stdout
377 fdStdout, err := tempfile(cwdOrig, tgt)
380 return TgtError{tgtOrig, err}
382 stdoutPath := fdStdout.Name()
384 tmpPath := stdoutPath + ".3" // and for $3
385 tmpPathRel, err := filepath.Rel(cwd, tmpPath)
391 path.Join(dirPrefix, tgt),
392 path.Join(dirPrefix, basename),
396 "sh: %s: %s %s cwd:%s dirprefix:%s",
397 tgtOrig, cmdName, args, cwd, dirPrefix,
400 cmd := exec.Command(cmdName, args...)
402 // cmd.Stdin reads from /dev/null by default
403 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
404 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
405 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
407 childStderrPrefixRaw := make([]byte, 8)
408 if _, err = io.ReadFull(rand.Reader, childStderrPrefixRaw); err != nil {
411 childStderrPrefix := hex.EncodeToString(childStderrPrefixRaw)
412 cmd.Env = append(cmd.Env, fmt.Sprintf(
413 "%s=%s", EnvStderrPrefix, childStderrPrefix,
417 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
418 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
420 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
421 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
425 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
427 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
428 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
433 var fdStderr *os.File
435 fdStderr, err = os.OpenFile(
436 path.Join(redoDir, tgt+LogSuffix),
437 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
442 return TgtError{tgtOrig, err}
445 tracef(CDebug, "%s", shCtx)
447 jsNeedsRelease = false
452 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
454 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
455 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
456 makeFlags := fmt.Sprintf(
457 "%s %s%d,%d", MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
459 makeFlags = strings.Trim(makeFlags, " ")
460 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", MakeFlagsName, makeFlags))
462 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
466 if _, err = FdStatus.Write([]byte{StatusRun}); err != nil {
471 defer jsRelease(shCtx, jsToken)
473 var finished time.Time
474 var exitErr *exec.ExitError
475 started := time.Now()
476 runErr.Started = &started
477 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
486 cmd.Stdout = fdStdout
487 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
497 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
498 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
500 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
507 logRecPath := path.Join(redoDir, tgt+LogRecSuffix)
508 if fdStderr, err = os.OpenFile(
510 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
513 fields := []recfile.Field{
514 {Name: "Build", Value: BuildUUID},
515 {Name: "PPID", Value: strconv.Itoa(os.Getpid())},
516 {Name: "Cwd", Value: cwd},
518 if cmd.Process != nil {
519 fields = append(fields, recfile.Field{
520 Name: "PID", Value: strconv.Itoa(cmd.Process.Pid),
523 ts := new(tai64n.TAI64N)
525 fields = append(fields,
526 recfile.Field{Name: "Started", Value: tai64n.Encode(ts[:])},
528 ts.FromTime(finished)
529 fields = append(fields,
530 recfile.Field{Name: "Finished", Value: tai64n.Encode(ts[:])})
531 fields = append(fields, recfile.Field{
533 Value: strconv.FormatInt(finished.Sub(started).Nanoseconds(), 10),
535 fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
536 for _, arg := range args {
537 fields = append(fields, recfile.Field{Name: "Arg", Value: arg})
539 for _, env := range cmd.Env {
540 fields = append(fields, recfile.Field{Name: "Env", Value: env})
543 fields = append(fields, recfile.Field{
545 Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
548 w := bufio.NewWriter(fdStderr)
551 fdDep, err := os.Open(fdDepPath)
555 depInfo, err = depRead(fdDep)
560 for _, dep := range depInfo.ifchanges {
561 fields = append(fields, recfile.Field{
563 Value: dep["Target"],
566 _, err = recfile.NewWriter(w).WriteFields(fields...)
574 os.Remove(logRecPath)
578 log.Println("can not open", logRecPath, ":", err)
582 os.Remove(fdDep.Name())
583 os.Remove(fdStdout.Name())
585 os.Remove(fdLock.Name())
587 if _, err = FdStatus.Write([]byte{StatusDone}); err != nil {
593 stderr, err := cmd.StderrPipe()
607 RunningProcs[cmd.Process.Pid] = cmd.Process
608 RunningProcsM.Unlock()
609 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
610 tracef(CDebug, "%s runs %s", tgtOrig, pid)
612 stderrTerm := make(chan struct{})
614 scanner := bufio.NewScanner(stderr)
616 ts := new(tai64n.TAI64N)
618 line = scanner.Text()
619 if strings.HasPrefix(line, childStderrPrefix) {
620 line = line[len(childStderrPrefix):]
621 os.Stderr.WriteString(StderrPrefix + line + "\n")
625 ts.FromTime(time.Now())
627 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
634 tracef(CNone, "%s", line)
636 tracef(CNone, "%s %s", pid, line)
642 // Wait for job completion
646 delete(RunningProcs, cmd.Process.Pid)
647 RunningProcsM.Unlock()
648 finished = time.Now()
649 runErr.Finished = &finished
651 exitErr = err.(*exec.ExitError)
658 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
659 if inodePrev == nil {
661 runErr.Err = Err1WasTouched
665 inode, err := inodeFromFile(fd)
672 if !inode.Equals(inodePrev) {
673 runErr.Err = Err1WasTouched
679 if inodePrev != nil {
680 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
681 inode, err := inodeFromFile(fd)
683 if err == nil && !inode.Equals(inodePrev) {
684 runErr.Err = Err1WasTouched
691 // Does it produce both stdout and tmp?
692 fiStdout, err := os.Stat(fdStdout.Name())
699 _, err = os.Stat(tmpPath)
701 if fiStdout.Size() > 0 {
702 runErr.Err = errors.New("created both tmp and stdout")
707 } else if !os.IsNotExist(err) {
713 // Determine what file we must process at last
716 fd, err = os.Open(tmpPath)
721 } else if fiStdout.Size() > 0 {
725 // Do we need to ifcreate it, or ifchange with renaming?
727 os.Remove(path.Join(cwdOrig, tgt))
728 err = ifcreate(fdDep, tgt)
735 _, err = fd.Seek(0, io.SeekStart)
739 hsh, err = fileHash(fd)
744 tracef(CDebug, "%s has same hash, not renaming", tgtOrig)
745 err = os.Remove(fd.Name())
749 err = os.Chtimes(path.Join(cwdOrig, tgt), finished, finished)
754 err = syncDir(cwdOrig)
759 err = depWrite(fdDep, cwdOrig, tgt, hshPrev)
772 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
777 err = syncDir(cwdOrig)
782 err = depWrite(fdDep, cwdOrig, tgt, hsh)
796 fdDepPath = path.Join(redoDir, tgt+DepSuffix)
797 err = os.Rename(fdDep.Name(), fdDepPath)
802 err = syncDir(redoDir)
808 // Post-commit .rec sanitizing
810 if fdDepR, err := os.Open(fdDepPath); err == nil {
811 depInfo, err := depRead(fdDepR)
816 ifchangeSeen := make(map[string]struct{}, len(depInfo.ifchanges))
817 for _, dep := range depInfo.ifchanges {
818 ifchangeSeen[dep["Target"]] = struct{}{}
820 for _, dep := range depInfo.ifcreates {
821 if _, exists := ifchangeSeen[dep]; exists {
822 tracef(CWarn, "simultaneous ifcreate and ifchange records: %s", tgt)
834 func isOkRun(err error) bool {
839 if errors.As(err, &runErr) && runErr.Err == nil {
840 tracef(CRedo, "%s", runErr.Name())
843 tracef(CErr, "%s", err)