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"
60 LogRecSuffix = ".log-rec"
65 StderrKeep bool = false
66 StderrSilent bool = false
73 flagStderrSilent *bool
80 if !(cmdName == CmdNameRedo || cmdName == CmdNameRedoIfchange) {
83 flagTrace = flag.Bool("x", false, "trace (sh -x) current targets")
84 flagTraceAll = flag.Bool("xx", false,
85 fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
86 flagStderrKeep = flag.Bool("k", false,
87 fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
88 flagStderrSilent = flag.Bool("s", false,
89 fmt.Sprintf("silent, do not print job's stderr (%s=1)", EnvStderrSilent))
100 func (e *RunErr) Name() string {
105 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
107 if e.Finished == nil {
110 return fmt.Sprintf("%s (%.3fs)", name, e.Finished.Sub(*e.Started).Seconds())
113 func (e RunErr) Error() string {
114 return fmt.Sprintf("%s: %s", e.Name(), e.Err)
117 func mkdirs(pth string) error {
118 if _, err := os.Stat(pth); err == nil {
121 return os.MkdirAll(pth, os.FileMode(0777))
124 func isModified(cwd, redoDir, tgt string) (bool, *Inode, error) {
125 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
127 if os.IsNotExist(err) {
128 return false, nil, nil
130 return false, nil, err
133 r := recfile.NewReader(fdDep)
136 m, err := r.NextMap()
141 return false, nil, err
143 if m["Target"] != tgt {
146 fd, err := os.Open(path.Join(cwd, tgt))
148 if os.IsNotExist(err) {
149 return false, nil, nil
151 return false, nil, err
153 ourInode, err = inodeFromFile(fd)
156 return false, nil, err
158 theirInode, err := inodeFromRec(m)
160 return false, nil, err
162 if !ourInode.Equals(theirInode) {
163 return true, ourInode, nil
167 return false, ourInode, nil
170 func syncDir(dir string) error {
171 fd, err := os.Open(dir)
180 func runScript(tgtOrig string, errs chan error, traced bool) error {
181 cwd, tgt := cwdAndTgt(tgtOrig)
182 redoDir := path.Join(cwd, RedoDir)
183 if err := mkdirs(redoDir); err != nil {
184 return TgtErr{tgtOrig, err}
188 fdLock, err := os.OpenFile(
189 path.Join(redoDir, tgt+LockSuffix),
190 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
194 return TgtErr{tgtOrig, err}
196 lockRelease := func() {
197 trace(CLock, "LOCK_UN: %s", fdLock.Name())
198 unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
201 trace(CLock, "LOCK_NB: %s", fdLock.Name())
203 // Waiting for job completion, already taken by someone else
204 if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
205 if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
207 return TgtErr{tgtOrig, err}
210 trace(CDebug, "waiting: %s", tgtOrig)
212 FdStatus.Write([]byte{StatusWait})
216 trace(CLock, "LOCK_EX: %s", fdLock.Name())
217 unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
219 trace(CDebug, "waiting done: %s", tgtOrig)
221 FdStatus.Write([]byte{StatusWaited})
224 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
226 if os.IsNotExist(err) {
227 err = errors.New("was not built: no .rec")
232 depInfo, err = depRead(fdDep)
236 if depInfo.build != BuildUUID {
237 err = errors.New("was not built: build differs")
241 err = TgtErr{tgtOrig, err}
248 // Check if target is not modified externally
249 modified, inodePrev, err := isModified(cwd, redoDir, tgt)
252 return TgtErr{tgtOrig, err}
255 trace(CWarn, "%s externally modified: not redoing", tgtOrig)
263 // Start preparing .rec
264 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
267 return TgtErr{tgtOrig, err}
269 fdDepPath := fdDep.Name()
273 os.Remove(fdDep.Name())
275 if _, err = recfile.NewWriter(fdDep).WriteFields(
276 recfile.Field{Name: "Build", Value: BuildUUID},
279 return TgtErr{tgtOrig, err}
283 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
286 return TgtErr{tgtOrig, err}
290 return TgtErr{tgtOrig, errors.New("no .do found")}
293 // Determine basename and DIRPREFIX
294 doFileRelPath := doFile
295 ents := strings.Split(cwd, "/")
296 ents = ents[len(ents)-upLevels:]
297 dirPrefix := path.Join(ents...)
299 for i := 0; i < upLevels; i++ {
300 cwd = path.Join(cwd, "..")
301 doFileRelPath = path.Join("..", doFileRelPath)
303 cwd = path.Clean(cwd)
304 doFilePath := path.Join(cwd, doFile)
306 runErr := RunErr{Tgt: tgtOrig}
307 if strings.HasPrefix(doFile, "default.") {
308 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
309 runErr.DoFile = doFileRelPath
312 if err = writeDep(fdDep, cwdOrig, doFileRelPath); err != nil {
314 return TgtErr{tgtOrig, err}
317 trace(CWait, "%s", runErr.Name())
319 // Prepare command line
322 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
324 args = make([]string, 0, 3)
327 if traced || TracedAll {
328 args = append(args, "-ex")
330 args = append(args, "-e")
332 args = append(args, doFile)
335 // Temporary file for stdout
336 fdStdout, err := tempfile(cwdOrig, tgt)
339 return TgtErr{tgtOrig, err}
341 stdoutPath := fdStdout.Name()
343 tmpPath := stdoutPath + ".3" // and for $3
344 tmpPathRel, err := filepath.Rel(cwd, tmpPath)
350 path.Join(dirPrefix, tgt),
351 path.Join(dirPrefix, basename),
355 cmd := exec.Command(cmdName, args...)
357 // cmd.Stdin reads from /dev/null by default
358 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
359 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
360 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
362 childStderrPrefix := tempsuffix()
363 cmd.Env = append(cmd.Env, fmt.Sprintf(
364 "%s=%s", EnvStderrPrefix, childStderrPrefix,
368 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
369 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
371 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
372 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
376 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
378 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
379 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
384 var fdStderr *os.File
386 fdStderr, err = os.OpenFile(
387 path.Join(redoDir, tgt+LogSuffix),
388 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
393 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+LogRecSuffix)
452 if fdStderr, err = os.OpenFile(
454 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
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 _, env := range cmd.Env {
480 fields = append(fields, recfile.Field{Name: "Env", Value: env})
483 fields = append(fields, recfile.Field{
485 Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
488 w := bufio.NewWriter(fdStderr)
491 fdDep, err := os.Open(fdDepPath)
495 depInfo, err = depRead(fdDep)
500 for _, dep := range depInfo.ifchanges {
501 fields = append(fields, recfile.Field{
503 Value: dep["Target"],
506 _, err = recfile.NewWriter(w).WriteFields(fields...)
514 os.Remove(logRecPath)
518 log.Println("can not open", logRecPath, ":", err)
522 os.Remove(fdDep.Name())
523 os.Remove(fdStdout.Name())
525 os.Remove(fdLock.Name())
527 FdStatus.Write([]byte{StatusDone})
531 stderr, err := cmd.StderrPipe()
544 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
545 trace(CDebug, "%s runs %s", tgtOrig, pid)
547 stderrTerm := make(chan struct{}, 0)
549 scanner := bufio.NewScanner(stderr)
551 ts := new(tai64n.TAI64N)
553 line = scanner.Text()
554 if strings.HasPrefix(line, childStderrPrefix) {
555 line = line[len(childStderrPrefix):]
556 os.Stderr.WriteString(StderrPrefix + line + "\n")
560 ts.FromTime(time.Now())
562 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
569 trace(CNone, "%s", line)
571 trace(CNone, "%s %s", pid, line)
577 // Wait for job completion
580 finished = time.Now()
581 runErr.Finished = &finished
583 exitErr = err.(*exec.ExitError)
590 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
591 errTouched := errors.New("$1 was explicitly touched")
592 if inodePrev == nil {
594 runErr.Err = errTouched
598 inode, err := inodeFromFile(fd)
605 if !inode.Equals(inodePrev) {
606 runErr.Err = errTouched
613 if inodePrev != nil {
614 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
615 inode, err := inodeFromFile(fd)
617 if err == nil && !inode.Equals(inodePrev) {
618 runErr.Err = errors.New("$1 was explicitly touched")
625 // Does it produce both stdout and tmp?
626 fiStdout, err := os.Stat(fdStdout.Name())
633 _, err = os.Stat(tmpPath)
635 if fiStdout.Size() > 0 {
636 runErr.Err = errors.New("created both tmp and stdout")
641 } else if !os.IsNotExist(err) {
647 // Determine what file we must process at last
650 fd, err = os.Open(tmpPath)
655 } else if fiStdout.Size() > 0 {
659 // Do we need to ifcreate it, of ifchange with renaming?
661 os.Remove(path.Join(cwdOrig, tgt))
662 err = ifcreate(fdDep, tgt)
673 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
678 err = syncDir(cwdOrig)
683 err = writeDep(fdDep, cwdOrig, tgt)
696 fdDepPath = path.Join(redoDir, tgt+DepSuffix)
697 err = os.Rename(fdDep.Name(), fdDepPath)
702 err = syncDir(redoDir)
714 func isOkRun(err error) bool {
718 if err, ok := err.(RunErr); ok && err.Err == nil {
719 trace(CRedo, "%s", err.Name())
722 trace(CErr, "%s", err)