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/>.
38 "go.cypherpunks.ru/recfile"
39 "go.cypherpunks.ru/tai64n/v2"
40 "golang.org/x/sys/unix"
44 EnvDepFd = "REDO_DEP_FD"
45 EnvDirPrefix = "REDO_DIRPREFIX"
46 EnvDepCwd = "REDO_DEP_CWD"
47 EnvBuildUUID = "REDO_BUILD_UUID"
48 EnvStderrPrefix = "REDO_STDERR_PREFIX"
49 EnvTrace = "REDO_TRACE"
50 EnvStderrKeep = "REDO_LOGS"
51 EnvStderrSilent = "REDO_SILENT"
52 EnvNoSync = "REDO_NO_SYNC"
63 StderrKeep bool = false
64 StderrSilent bool = false
71 flagStderrSilent *bool
78 if !(cmdName == CmdNameRedo || cmdName == CmdNameRedoIfchange) {
81 flagTrace = flag.Bool("x", false, "trace (sh -x) current targets")
82 flagTraceAll = flag.Bool("xx", false,
83 fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
84 flagStderrKeep = flag.Bool("k", false,
85 fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
86 flagStderrSilent = flag.Bool("s", false,
87 fmt.Sprintf("silent, do not print job's stderr (%s=1)", EnvStderrSilent))
98 func (e *RunErr) Name() string {
103 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
105 if e.Finished == nil {
108 return fmt.Sprintf("%s (%.3fs)", name, e.Finished.Sub(*e.Started).Seconds())
111 func (e RunErr) Error() string {
112 return fmt.Sprintf("%s: %s", e.Name(), e.Err)
115 func mkdirs(pth string) error {
116 if _, err := os.Stat(pth); err == nil {
119 return os.MkdirAll(pth, os.FileMode(0777))
122 func isModified(cwd, redoDir, tgt string) (bool, *Inode, error) {
123 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
125 if os.IsNotExist(err) {
126 return false, nil, nil
128 return false, nil, err
131 r := recfile.NewReader(fdDep)
134 m, err := r.NextMap()
139 return false, nil, err
141 if m["Target"] != tgt {
144 fd, err := os.Open(path.Join(cwd, tgt))
146 if os.IsNotExist(err) {
147 return false, nil, nil
149 return false, nil, err
151 ourInode, err = inodeFromFile(fd)
154 return false, nil, err
156 theirInode, err := inodeFromRec(m)
158 return false, nil, err
160 if !ourInode.Equals(theirInode) {
161 return true, ourInode, nil
165 return false, ourInode, nil
168 func syncDir(dir string) error {
169 fd, err := os.Open(dir)
178 func runScript(tgtOrig string, errs chan error, traced bool) error {
179 cwd, tgt := cwdAndTgt(tgtOrig)
180 redoDir := path.Join(cwd, RedoDir)
181 if err := mkdirs(redoDir); err != nil {
182 return TgtErr{tgtOrig, err}
186 fdLock, err := os.OpenFile(
187 path.Join(redoDir, tgt+LockSuffix),
188 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
192 return TgtErr{tgtOrig, err}
194 lockRelease := func() {
195 trace(CLock, "LOCK_UN: %s", fdLock.Name())
196 unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
199 trace(CLock, "LOCK_NB: %s", fdLock.Name())
201 // Waiting for job completion, already taken by someone else
202 if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
203 if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
205 return TgtErr{tgtOrig, err}
208 trace(CDebug, "waiting: %s", tgtOrig)
210 FdStatus.Write([]byte{StatusWait})
214 trace(CLock, "LOCK_EX: %s", fdLock.Name())
215 unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
217 trace(CDebug, "waiting done: %s", tgtOrig)
219 FdStatus.Write([]byte{StatusWaited})
222 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
224 if os.IsNotExist(err) {
225 err = errors.New("was not built: no .rec")
230 depInfo, err = depRead(fdDep)
234 if depInfo.build != BuildUUID {
235 err = errors.New("was not built: build differs")
239 err = TgtErr{tgtOrig, err}
246 // Check if target is not modified externally
247 modified, inodePrev, err := isModified(cwd, redoDir, tgt)
250 return TgtErr{tgtOrig, err}
253 trace(CWarn, "%s externally modified: not redoing", tgtOrig)
261 // Start preparing .rec
262 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
265 return TgtErr{tgtOrig, err}
267 fdDepPath := fdDep.Name()
271 os.Remove(fdDep.Name())
273 if _, err = recfile.NewWriter(fdDep).WriteFields(
274 recfile.Field{Name: "Build", Value: BuildUUID},
277 return TgtErr{tgtOrig, err}
281 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
284 return TgtErr{tgtOrig, err}
288 return TgtErr{tgtOrig, errors.New("no .do found")}
291 // Determine basename and DIRPREFIX
292 doFileRelPath := doFile
293 ents := strings.Split(cwd, "/")
294 ents = ents[len(ents)-upLevels:]
295 dirPrefix := path.Join(ents...)
297 for i := 0; i < upLevels; i++ {
298 cwd = path.Join(cwd, "..")
299 doFileRelPath = path.Join("..", doFileRelPath)
301 cwd = path.Clean(cwd)
302 doFilePath := path.Join(cwd, doFile)
304 runErr := RunErr{Tgt: tgtOrig}
305 if strings.HasPrefix(doFile, "default.") {
306 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
307 runErr.DoFile = doFileRelPath
310 if err = writeDep(fdDep, cwdOrig, doFileRelPath); err != nil {
312 return TgtErr{tgtOrig, err}
315 trace(CWait, "%s", runErr.Name())
317 // Prepare command line
320 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
322 args = make([]string, 0, 3)
325 if traced || TracedAll {
326 args = append(args, "-ex")
328 args = append(args, "-e")
330 args = append(args, doFile)
333 // Temporary file for stdout
334 fdStdout, err := tempfile(cwdOrig, tgt)
337 return TgtErr{tgtOrig, err}
339 stdoutPath := fdStdout.Name()
341 tmpPath := stdoutPath + ".3" // and for $3
342 tmpPathRel, err := filepath.Rel(cwd, tmpPath)
348 path.Join(dirPrefix, tgt),
349 path.Join(dirPrefix, basename),
353 cmd := exec.Command(cmdName, args...)
355 // cmd.Stdin reads from /dev/null by default
356 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
357 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
358 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
360 childStderrPrefix := tempsuffix()
361 cmd.Env = append(cmd.Env, fmt.Sprintf(
362 "%s=%s", EnvStderrPrefix, childStderrPrefix,
366 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
367 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
369 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
370 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
374 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
376 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
377 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
382 var fdStderr *os.File
384 fdStderr, err = os.OpenFile(
385 path.Join(redoDir, tgt+LogSuffix),
386 os.O_WRONLY|os.O_CREATE,
391 return TgtErr{tgtOrig, err}
395 shCtx := fmt.Sprintf(
396 "sh: %s: %s %s cwd:%s dirprefix:%s",
397 tgtOrig, cmdName, args, cwd, dirPrefix,
399 trace(CDebug, "%s", shCtx)
403 jsToken := jsAcquire(shCtx)
406 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
408 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
409 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
410 cmd.Env = append(cmd.Env, fmt.Sprintf(
412 MakeFlagsName, MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
415 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
419 FdStatus.Write([]byte{StatusRun})
422 var finished time.Time
423 var exitErr *exec.ExitError
424 started := time.Now()
425 runErr.Started = &started
426 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
432 cmd.Stdout = fdStdout
433 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
439 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
440 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
442 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
445 jsRelease(shCtx, jsToken)
450 logRecPath := path.Join(redoDir, tgt+LogSuffix+DepSuffix)
451 if fdStderr, err = os.OpenFile(
453 os.O_WRONLY|os.O_CREATE,
457 fields := []recfile.Field{
458 {Name: "Build", Value: BuildUUID},
459 {Name: "PID", Value: strconv.Itoa(cmd.Process.Pid)},
460 {Name: "PPID", Value: strconv.Itoa(os.Getpid())},
461 {Name: "Cwd", Value: cwd},
463 ts := new(tai64n.TAI64N)
465 fields = append(fields,
466 recfile.Field{Name: "Started", Value: tai64n.Encode(ts[:])},
468 ts.FromTime(finished)
469 fields = append(fields,
470 recfile.Field{Name: "Finished", Value: tai64n.Encode(ts[:])})
471 fields = append(fields, recfile.Field{
473 Value: strconv.FormatInt(finished.Sub(started).Nanoseconds(), 10),
475 fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
476 for _, arg := range args {
477 fields = append(fields, recfile.Field{Name: "Cmd", Value: arg})
479 for _, e := range cmd.Env {
480 fields = append(fields, recfile.Field{Name: "Env", Value: e})
483 fields = append(fields, recfile.Field{
485 Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
488 w := bufio.NewWriter(fdStderr)
489 _, err = recfile.NewWriter(w).WriteFields(fields...)
493 os.Remove(logRecPath)
498 os.Remove(fdDep.Name())
499 os.Remove(fdStdout.Name())
501 os.Remove(fdLock.Name())
503 FdStatus.Write([]byte{StatusDone})
507 stderr, err := cmd.StderrPipe()
520 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
521 trace(CDebug, "%s runs %s", tgtOrig, pid)
523 stderrTerm := make(chan struct{}, 0)
525 scanner := bufio.NewScanner(stderr)
527 ts := new(tai64n.TAI64N)
529 line = scanner.Text()
530 if strings.HasPrefix(line, childStderrPrefix) {
531 line = line[len(childStderrPrefix):]
532 os.Stderr.WriteString(StderrPrefix + line + "\n")
536 ts.FromTime(time.Now())
538 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
545 trace(CNone, "%s", line)
547 trace(CNone, "%s %s", pid, line)
553 // Wait for job completion
556 finished = time.Now()
557 runErr.Finished = &finished
559 // Try to commit .rec anyway
563 os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
565 err = syncDir(redoDir)
568 exitErr = err.(*exec.ExitError)
575 if inodePrev != nil {
576 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
577 inode, err := inodeFromFile(fd)
579 if err == nil && !inode.Equals(inodePrev) {
580 runErr.Err = errors.New("$1 was explicitly touched")
587 // Does it produce both stdout and tmp?
588 fiStdout, err := os.Stat(fdStdout.Name())
595 _, err = os.Stat(tmpPath)
597 if fiStdout.Size() > 0 {
598 runErr.Err = errors.New("created both tmp and stdout")
603 } else if !os.IsNotExist(err) {
609 // Determine what file we must process at last
612 fd, err = os.Open(tmpPath)
617 } else if fiStdout.Size() > 0 {
621 // Do we need to ifcreate it, of ifchange with renaming?
623 os.Remove(path.Join(cwdOrig, tgt))
624 err = ifcreate(fdDep, tgt)
635 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
640 err = syncDir(cwdOrig)
645 err = writeDep(fdDep, cwdOrig, tgt)
658 err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
663 err = syncDir(redoDir)
675 func isOkRun(err error) bool {
679 if err, ok := err.(RunErr); ok && err.Err == nil {
680 trace(CRedo, "%s", err.Name())
683 trace(CErr, "%s", err)