2 goredo -- djb's redo implementation on pure Go
3 Copyright (C) 2020-2021 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"
64 StderrKeep bool = false
65 StderrSilent bool = false
72 flagStderrSilent *bool
79 if !(cmdName == CmdNameRedo || cmdName == CmdNameRedoIfchange) {
82 flagTrace = flag.Bool("x", false, "trace (sh -x) current targets")
83 flagTraceAll = flag.Bool("xx", false,
84 fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
85 flagStderrKeep = flag.Bool("k", false,
86 fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
87 flagStderrSilent = flag.Bool("s", false,
88 fmt.Sprintf("silent, do not print job's stderr (%s=1)", EnvStderrSilent))
99 func (e *RunErr) Name() string {
104 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
106 if e.Finished == nil {
109 return fmt.Sprintf("%s (%.3fs)", name, e.Finished.Sub(*e.Started).Seconds())
112 func (e RunErr) Error() string {
113 return fmt.Sprintf("%s: %s", e.Name(), e.Err)
116 func mkdirs(pth string) error {
117 if _, err := os.Stat(pth); err == nil {
120 return os.MkdirAll(pth, os.FileMode(0777))
123 func isModified(cwd, redoDir, tgt string) (bool, *Inode, error) {
124 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
126 if os.IsNotExist(err) {
127 return false, nil, nil
129 return false, nil, err
132 r := recfile.NewReader(fdDep)
135 m, err := r.NextMap()
140 return false, nil, err
142 if m["Target"] != tgt {
145 fd, err := os.Open(path.Join(cwd, tgt))
147 if os.IsNotExist(err) {
148 return false, nil, nil
150 return false, nil, err
152 ourInode, err = inodeFromFile(fd)
155 return false, nil, err
157 theirInode, err := inodeFromRec(m)
159 return false, nil, err
161 if !ourInode.Equals(theirInode) {
162 return true, ourInode, nil
166 return false, ourInode, nil
169 func syncDir(dir string) error {
170 fd, err := os.Open(dir)
179 func runScript(tgtOrig string, errs chan error, traced bool) error {
180 cwd, tgt := cwdAndTgt(tgtOrig)
181 redoDir := path.Join(cwd, RedoDir)
182 if err := mkdirs(redoDir); err != nil {
183 return TgtErr{tgtOrig, err}
187 fdLock, err := os.OpenFile(
188 path.Join(redoDir, tgt+LockSuffix),
189 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
193 return TgtErr{tgtOrig, err}
195 lockRelease := func() {
196 trace(CLock, "LOCK_UN: %s", fdLock.Name())
197 unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
200 trace(CLock, "LOCK_NB: %s", fdLock.Name())
202 // Waiting for job completion, already taken by someone else
203 if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
204 if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
206 return TgtErr{tgtOrig, err}
209 trace(CDebug, "waiting: %s", tgtOrig)
211 FdStatus.Write([]byte{StatusWait})
215 trace(CLock, "LOCK_EX: %s", fdLock.Name())
216 unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
218 trace(CDebug, "waiting done: %s", tgtOrig)
220 FdStatus.Write([]byte{StatusWaited})
223 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
225 if os.IsNotExist(err) {
226 err = errors.New("was not built: no .rec")
231 depInfo, err = depRead(fdDep)
235 if depInfo.build != BuildUUID {
236 err = errors.New("was not built: build differs")
240 err = TgtErr{tgtOrig, err}
247 // Check if target is not modified externally
248 modified, inodePrev, err := isModified(cwd, redoDir, tgt)
251 return TgtErr{tgtOrig, err}
254 trace(CWarn, "%s externally modified: not redoing", tgtOrig)
262 // Start preparing .rec
263 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
266 return TgtErr{tgtOrig, err}
268 fdDepPath := fdDep.Name()
272 os.Remove(fdDep.Name())
274 if _, err = recfile.NewWriter(fdDep).WriteFields(
275 recfile.Field{Name: "Build", Value: BuildUUID},
278 return TgtErr{tgtOrig, err}
282 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
285 return TgtErr{tgtOrig, err}
289 return TgtErr{tgtOrig, errors.New("no .do found")}
292 // Determine basename and DIRPREFIX
293 doFileRelPath := doFile
294 ents := strings.Split(cwd, "/")
295 ents = ents[len(ents)-upLevels:]
296 dirPrefix := path.Join(ents...)
298 for i := 0; i < upLevels; i++ {
299 cwd = path.Join(cwd, "..")
300 doFileRelPath = path.Join("..", doFileRelPath)
302 cwd = path.Clean(cwd)
303 doFilePath := path.Join(cwd, doFile)
305 runErr := RunErr{Tgt: tgtOrig}
306 if strings.HasPrefix(doFile, "default.") {
307 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
308 runErr.DoFile = doFileRelPath
311 if err = writeDep(fdDep, cwdOrig, doFileRelPath); err != nil {
313 return TgtErr{tgtOrig, err}
316 trace(CWait, "%s", runErr.Name())
318 // Prepare command line
321 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
323 args = make([]string, 0, 3)
326 if traced || TracedAll {
327 args = append(args, "-ex")
329 args = append(args, "-e")
331 args = append(args, doFile)
334 // Temporary file for stdout
335 fdStdout, err := tempfile(cwdOrig, tgt)
338 return TgtErr{tgtOrig, err}
340 stdoutPath := fdStdout.Name()
342 tmpPath := stdoutPath + ".3" // and for $3
343 tmpPathRel, err := filepath.Rel(cwd, tmpPath)
349 path.Join(dirPrefix, tgt),
350 path.Join(dirPrefix, basename),
354 cmd := exec.Command(cmdName, args...)
356 // cmd.Stdin reads from /dev/null by default
357 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
358 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
359 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
361 childStderrPrefix := tempsuffix()
362 cmd.Env = append(cmd.Env, fmt.Sprintf(
363 "%s=%s", EnvStderrPrefix, childStderrPrefix,
367 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
368 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
370 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
371 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
375 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
377 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
378 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
383 var fdStderr *os.File
385 fdStderr, err = os.OpenFile(
386 path.Join(redoDir, tgt+LogSuffix),
387 os.O_WRONLY|os.O_CREATE,
392 return TgtErr{tgtOrig, err}
396 shCtx := fmt.Sprintf(
397 "sh: %s: %s %s cwd:%s dirprefix:%s",
398 tgtOrig, cmdName, args, cwd, dirPrefix,
400 trace(CDebug, "%s", shCtx)
404 jsToken := jsAcquire(shCtx)
407 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
409 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
410 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
411 cmd.Env = append(cmd.Env, fmt.Sprintf(
413 MakeFlagsName, MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
416 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
420 FdStatus.Write([]byte{StatusRun})
423 var finished time.Time
424 var exitErr *exec.ExitError
425 started := time.Now()
426 runErr.Started = &started
427 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
433 cmd.Stdout = fdStdout
434 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
440 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
441 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
443 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
446 jsRelease(shCtx, jsToken)
451 logRecPath := path.Join(redoDir, tgt+LogSuffix+DepSuffix)
452 if fdStderr, err = os.OpenFile(
454 os.O_WRONLY|os.O_CREATE,
458 fields := []recfile.Field{
459 {Name: "Build", Value: BuildUUID},
460 {Name: "PID", Value: strconv.Itoa(cmd.Process.Pid)},
461 {Name: "PPID", Value: strconv.Itoa(os.Getpid())},
462 {Name: "Cwd", Value: cwd},
464 ts := new(tai64n.TAI64N)
466 fields = append(fields,
467 recfile.Field{Name: "Started", Value: tai64n.Encode(ts[:])},
469 ts.FromTime(finished)
470 fields = append(fields,
471 recfile.Field{Name: "Finished", Value: tai64n.Encode(ts[:])})
472 fields = append(fields, recfile.Field{
474 Value: strconv.FormatInt(finished.Sub(started).Nanoseconds(), 10),
476 fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
477 for _, arg := range args {
478 fields = append(fields, recfile.Field{Name: "Cmd", Value: arg})
480 for _, env := range cmd.Env {
481 fields = append(fields, recfile.Field{Name: "Env", Value: env})
484 fields = append(fields, recfile.Field{
486 Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
489 w := bufio.NewWriter(fdStderr)
492 fdDep, err = os.Open(fdDep.Name())
496 depInfo, err = depRead(fdDep)
501 for _, dep := range depInfo.ifchanges {
502 fields = append(fields, recfile.Field{
504 Value: dep["Target"],
507 _, err = recfile.NewWriter(w).WriteFields(fields...)
515 os.Remove(logRecPath)
519 log.Println("can not open", logRecPath, ":", err)
523 os.Remove(fdDep.Name())
524 os.Remove(fdStdout.Name())
526 os.Remove(fdLock.Name())
528 FdStatus.Write([]byte{StatusDone})
532 stderr, err := cmd.StderrPipe()
545 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
546 trace(CDebug, "%s runs %s", tgtOrig, pid)
548 stderrTerm := make(chan struct{}, 0)
550 scanner := bufio.NewScanner(stderr)
552 ts := new(tai64n.TAI64N)
554 line = scanner.Text()
555 if strings.HasPrefix(line, childStderrPrefix) {
556 line = line[len(childStderrPrefix):]
557 os.Stderr.WriteString(StderrPrefix + line + "\n")
561 ts.FromTime(time.Now())
563 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
570 trace(CNone, "%s", line)
572 trace(CNone, "%s %s", pid, line)
578 // Wait for job completion
581 finished = time.Now()
582 runErr.Finished = &finished
584 exitErr = err.(*exec.ExitError)
591 if inodePrev != nil {
592 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
593 inode, err := inodeFromFile(fd)
595 if err == nil && !inode.Equals(inodePrev) {
596 runErr.Err = errors.New("$1 was explicitly touched")
603 // Does it produce both stdout and tmp?
604 fiStdout, err := os.Stat(fdStdout.Name())
611 _, err = os.Stat(tmpPath)
613 if fiStdout.Size() > 0 {
614 runErr.Err = errors.New("created both tmp and stdout")
619 } else if !os.IsNotExist(err) {
625 // Determine what file we must process at last
628 fd, err = os.Open(tmpPath)
633 } else if fiStdout.Size() > 0 {
637 // Do we need to ifcreate it, of ifchange with renaming?
639 os.Remove(path.Join(cwdOrig, tgt))
640 err = ifcreate(fdDep, tgt)
651 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
656 err = syncDir(cwdOrig)
661 err = writeDep(fdDep, cwdOrig, tgt)
674 err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
679 err = syncDir(redoDir)
691 func isOkRun(err error) bool {
695 if err, ok := err.(RunErr); ok && err.Err == nil {
696 trace(CRedo, "%s", err.Name())
699 trace(CErr, "%s", err)