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}
275 // Check if target is not modified externally
276 modified, inodePrev, hshPrev, err := isModified(cwd, redoDir, tgt)
279 return TgtError{tgtOrig, err}
284 return fmt.Errorf("%s externally modified", tgtOrig)
286 tracef(CWarn, "%s externally modified: not redoing", tgtOrig)
293 // Start preparing .rec
294 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
297 return TgtError{tgtOrig, err}
299 fdDepPath := fdDep.Name()
303 os.Remove(fdDep.Name())
305 if _, err = recfile.NewWriter(fdDep).WriteFields(
306 recfile.Field{Name: "Build", Value: BuildUUID},
309 return TgtError{tgtOrig, err}
313 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
316 return TgtError{tgtOrig, err}
320 return TgtError{tgtOrig, errors.New("no .do found")}
323 // Determine basename and DIRPREFIX
324 doFileRelPath := doFile
325 ents := strings.Split(cwd, "/")
326 ents = ents[len(ents)-upLevels:]
327 dirPrefix := path.Join(ents...)
329 for i := 0; i < upLevels; i++ {
330 cwd = path.Join(cwd, "..")
331 doFileRelPath = path.Join("..", doFileRelPath)
333 cwd = path.Clean(cwd)
334 doFilePath := path.Join(cwd, doFile)
336 runErr := RunError{Tgt: tgtOrig}
337 if strings.HasPrefix(doFile, "default.") {
338 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
339 runErr.DoFile = doFileRelPath
342 if err = depWrite(fdDep, cwdOrig, doFileRelPath, ""); err != nil {
344 return TgtError{tgtOrig, err}
347 tracef(CWait, "%s", runErr.Name())
349 // Prepare command line
352 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
354 args = make([]string, 0, 3)
357 if traced || TracedAll {
358 args = append(args, "-ex")
360 args = append(args, "-e")
362 args = append(args, doFile)
365 // Temporary file for stdout
366 fdStdout, err := tempfile(cwdOrig, tgt)
369 return TgtError{tgtOrig, err}
371 stdoutPath := fdStdout.Name()
373 tmpPath := stdoutPath + ".3" // and for $3
374 tmpPathRel, err := filepath.Rel(cwd, tmpPath)
380 path.Join(dirPrefix, tgt),
381 path.Join(dirPrefix, basename),
385 cmd := exec.Command(cmdName, args...)
387 // cmd.Stdin reads from /dev/null by default
388 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
389 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
390 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
392 childStderrPrefix := tempsuffix()
393 cmd.Env = append(cmd.Env, fmt.Sprintf(
394 "%s=%s", EnvStderrPrefix, childStderrPrefix,
398 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
399 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
401 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
402 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
406 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
408 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
409 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
414 var fdStderr *os.File
416 fdStderr, err = os.OpenFile(
417 path.Join(redoDir, tgt+LogSuffix),
418 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
423 return TgtError{tgtOrig, err}
426 shCtx := fmt.Sprintf(
427 "sh: %s: %s %s cwd:%s dirprefix:%s",
428 tgtOrig, cmdName, args, cwd, dirPrefix,
430 tracef(CDebug, "%s", shCtx)
434 jsToken := jsAcquire(shCtx)
437 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
439 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
440 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
441 makeFlags := fmt.Sprintf(
442 "%s %s%d,%d", MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
444 makeFlags = strings.Trim(makeFlags, " ")
445 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", MakeFlagsName, makeFlags))
447 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
451 if _, err = FdStatus.Write([]byte{StatusRun}); err != nil {
456 var finished time.Time
457 var exitErr *exec.ExitError
458 started := time.Now()
459 runErr.Started = &started
460 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
469 cmd.Stdout = fdStdout
470 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
480 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
481 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
483 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
486 jsRelease(shCtx, jsToken)
491 logRecPath := path.Join(redoDir, tgt+LogRecSuffix)
492 if fdStderr, err = os.OpenFile(
494 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
497 fields := []recfile.Field{
498 {Name: "Build", Value: BuildUUID},
499 {Name: "PPID", Value: strconv.Itoa(os.Getpid())},
500 {Name: "Cwd", Value: cwd},
502 if cmd.Process != nil {
503 fields = append(fields, recfile.Field{
504 Name: "PID", Value: strconv.Itoa(cmd.Process.Pid),
507 ts := new(tai64n.TAI64N)
509 fields = append(fields,
510 recfile.Field{Name: "Started", Value: tai64n.Encode(ts[:])},
512 ts.FromTime(finished)
513 fields = append(fields,
514 recfile.Field{Name: "Finished", Value: tai64n.Encode(ts[:])})
515 fields = append(fields, recfile.Field{
517 Value: strconv.FormatInt(finished.Sub(started).Nanoseconds(), 10),
519 fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
520 for _, arg := range args {
521 fields = append(fields, recfile.Field{Name: "Arg", Value: arg})
523 for _, env := range cmd.Env {
524 fields = append(fields, recfile.Field{Name: "Env", Value: env})
527 fields = append(fields, recfile.Field{
529 Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
532 w := bufio.NewWriter(fdStderr)
535 fdDep, err := os.Open(fdDepPath)
539 depInfo, err = depRead(fdDep)
544 for _, dep := range depInfo.ifchanges {
545 fields = append(fields, recfile.Field{
547 Value: dep["Target"],
550 _, err = recfile.NewWriter(w).WriteFields(fields...)
558 os.Remove(logRecPath)
562 log.Println("can not open", logRecPath, ":", err)
566 os.Remove(fdDep.Name())
567 os.Remove(fdStdout.Name())
569 os.Remove(fdLock.Name())
571 if _, err = FdStatus.Write([]byte{StatusDone}); err != nil {
577 stderr, err := cmd.StderrPipe()
591 RunningProcs[cmd.Process.Pid] = cmd.Process
592 RunningProcsM.Unlock()
593 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
594 tracef(CDebug, "%s runs %s", tgtOrig, pid)
596 stderrTerm := make(chan struct{})
598 scanner := bufio.NewScanner(stderr)
600 ts := new(tai64n.TAI64N)
602 line = scanner.Text()
603 if strings.HasPrefix(line, childStderrPrefix) {
604 line = line[len(childStderrPrefix):]
605 os.Stderr.WriteString(StderrPrefix + line + "\n")
609 ts.FromTime(time.Now())
611 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
618 tracef(CNone, "%s", line)
620 tracef(CNone, "%s %s", pid, line)
626 // Wait for job completion
630 delete(RunningProcs, cmd.Process.Pid)
631 RunningProcsM.Unlock()
632 finished = time.Now()
633 runErr.Finished = &finished
635 exitErr = err.(*exec.ExitError)
642 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
643 if inodePrev == nil {
645 runErr.Err = Err1WasTouched
649 inode, err := inodeFromFile(fd)
656 if !inode.Equals(inodePrev) {
657 runErr.Err = Err1WasTouched
663 if inodePrev != nil {
664 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
665 inode, err := inodeFromFile(fd)
667 if err == nil && !inode.Equals(inodePrev) {
668 runErr.Err = Err1WasTouched
675 // Does it produce both stdout and tmp?
676 fiStdout, err := os.Stat(fdStdout.Name())
683 _, err = os.Stat(tmpPath)
685 if fiStdout.Size() > 0 {
686 runErr.Err = errors.New("created both tmp and stdout")
691 } else if !os.IsNotExist(err) {
697 // Determine what file we must process at last
700 fd, err = os.Open(tmpPath)
705 } else if fiStdout.Size() > 0 {
709 // Do we need to ifcreate it, or ifchange with renaming?
711 os.Remove(path.Join(cwdOrig, tgt))
712 err = ifcreate(fdDep, tgt)
719 _, err = fd.Seek(0, io.SeekStart)
723 hsh, err = fileHash(fd)
728 tracef(CDebug, "%s has same hash, not renaming", tgtOrig)
729 err = os.Remove(fd.Name())
733 err = os.Chtimes(path.Join(cwdOrig, tgt), finished, finished)
738 err = syncDir(cwdOrig)
743 err = depWrite(fdDep, cwdOrig, tgt, hshPrev)
756 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
761 err = syncDir(cwdOrig)
766 err = depWrite(fdDep, cwdOrig, tgt, hsh)
780 fdDepPath = path.Join(redoDir, tgt+DepSuffix)
781 err = os.Rename(fdDep.Name(), fdDepPath)
786 err = syncDir(redoDir)
792 // Post-commit .rec sanitizing
794 if fdDepR, err := os.Open(fdDepPath); err == nil {
795 depInfo, err := depRead(fdDepR)
800 ifchangeSeen := make(map[string]struct{}, len(depInfo.ifchanges))
801 for _, dep := range depInfo.ifchanges {
802 ifchangeSeen[dep["Target"]] = struct{}{}
804 for _, dep := range depInfo.ifcreates {
805 if _, exists := ifchangeSeen[dep]; exists {
806 tracef(CWarn, "simultaneous ifcreate and ifchange records: %s", tgt)
818 func isOkRun(err error) bool {
823 if errors.As(err, &runErr) && runErr.Err == nil {
824 tracef(CRedo, "%s", runErr.Name())
827 tracef(CErr, "%s", err)