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"
73 flagStderrSilent *bool
77 RunningProcs = map[int]*os.Process{}
78 RunningProcsM sync.Mutex
80 Err1WasTouched = errors.New("$1 was explicitly touched")
85 if !(cmdName == CmdNameRedo || cmdName == CmdNameRedoIfchange) {
88 flagTrace = flag.Bool("x", false, "trace (sh -x) current targets")
89 flagTraceAll = flag.Bool("xx", false,
90 fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
91 flagStderrKeep = flag.Bool("k", false,
92 fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
93 flagStderrSilent = flag.Bool("s", false,
94 fmt.Sprintf("silent, do not print job's stderr (%s=1)", EnvStderrSilent))
97 type RunError struct {
105 func (e *RunError) Name() string {
110 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
112 if e.Finished == nil {
115 return fmt.Sprintf("%s (%.3fs)", name, e.Finished.Sub(*e.Started).Seconds())
118 func (e RunError) Error() string {
119 return fmt.Sprintf("%s: %s", e.Name(), e.Err)
122 func mkdirs(pth string) error {
123 if _, err := os.Stat(pth); err == nil {
126 return os.MkdirAll(pth, os.FileMode(0777))
129 func isModified(cwd, redoDir, tgt string) (bool, *Inode, error) {
130 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
132 if os.IsNotExist(err) {
133 return false, nil, nil
135 return false, nil, err
138 r := recfile.NewReader(fdDep)
141 m, err := r.NextMap()
143 if errors.Is(err, io.EOF) {
146 return false, nil, err
148 if m["Type"] != DepTypeIfchange || m["Target"] != tgt {
151 fd, err := os.Open(path.Join(cwd, tgt))
153 if os.IsNotExist(err) {
154 return false, nil, nil
156 return false, nil, err
158 ourInode, err = inodeFromFile(fd)
161 return false, nil, err
163 theirInode, err := inodeFromRec(m)
165 return false, nil, err
167 if !ourInode.Equals(theirInode) {
168 return true, ourInode, nil
172 return false, ourInode, nil
175 func syncDir(dir string) error {
176 fd, err := os.Open(dir)
185 func runScript(tgtOrig string, errs chan error, traced bool) error {
186 cwd, tgt := cwdAndTgt(tgtOrig)
187 redoDir := path.Join(cwd, RedoDir)
188 if err := mkdirs(redoDir); err != nil {
189 return TgtError{tgtOrig, err}
193 fdLock, err := os.OpenFile(
194 path.Join(redoDir, tgt+LockSuffix),
195 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
199 return TgtError{tgtOrig, err}
201 lockRelease := func() {
202 tracef(CLock, "LOCK_UN: %s", fdLock.Name())
203 if err := unix.Flock(int(fdLock.Fd()), unix.LOCK_UN); err != nil {
208 tracef(CLock, "LOCK_NB: %s", fdLock.Name())
210 // Waiting for job completion, already taken by someone else
211 if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
212 if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
214 return TgtError{tgtOrig, err}
217 tracef(CDebug, "waiting: %s", tgtOrig)
219 if _, err = FdStatus.Write([]byte{StatusWait}); err != nil {
225 tracef(CLock, "LOCK_EX: %s", fdLock.Name())
226 if err := unix.Flock(int(fdLock.Fd()), unix.LOCK_EX); err != nil {
230 tracef(CDebug, "waiting done: %s", tgtOrig)
232 if _, err = FdStatus.Write([]byte{StatusWaited}); err != nil {
237 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
239 if os.IsNotExist(err) {
240 err = errors.New("was not built: no .rec")
245 depInfo, err = depRead(fdDep)
249 if depInfo.build != BuildUUID {
250 err = errors.New("was not built: build differs")
254 err = TgtError{tgtOrig, err}
261 // Check if target is not modified externally
262 modified, inodePrev, err := isModified(cwd, redoDir, tgt)
265 return TgtError{tgtOrig, err}
268 tracef(CWarn, "%s externally modified: not redoing", tgtOrig)
276 // Start preparing .rec
277 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
280 return TgtError{tgtOrig, err}
282 fdDepPath := fdDep.Name()
286 os.Remove(fdDep.Name())
288 if _, err = recfile.NewWriter(fdDep).WriteFields(
289 recfile.Field{Name: "Build", Value: BuildUUID},
292 return TgtError{tgtOrig, err}
296 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
299 return TgtError{tgtOrig, err}
303 return TgtError{tgtOrig, errors.New("no .do found")}
306 // Determine basename and DIRPREFIX
307 doFileRelPath := doFile
308 ents := strings.Split(cwd, "/")
309 ents = ents[len(ents)-upLevels:]
310 dirPrefix := path.Join(ents...)
312 for i := 0; i < upLevels; i++ {
313 cwd = path.Join(cwd, "..")
314 doFileRelPath = path.Join("..", doFileRelPath)
316 cwd = path.Clean(cwd)
317 doFilePath := path.Join(cwd, doFile)
319 runErr := RunError{Tgt: tgtOrig}
320 if strings.HasPrefix(doFile, "default.") {
321 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
322 runErr.DoFile = doFileRelPath
325 if err = depWrite(fdDep, cwdOrig, doFileRelPath); err != nil {
327 return TgtError{tgtOrig, err}
330 tracef(CWait, "%s", runErr.Name())
332 // Prepare command line
335 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
337 args = make([]string, 0, 3)
340 if traced || TracedAll {
341 args = append(args, "-ex")
343 args = append(args, "-e")
345 args = append(args, doFile)
348 // Temporary file for stdout
349 fdStdout, err := tempfile(cwdOrig, tgt)
352 return TgtError{tgtOrig, err}
354 stdoutPath := fdStdout.Name()
356 tmpPath := stdoutPath + ".3" // and for $3
357 tmpPathRel, err := filepath.Rel(cwd, tmpPath)
363 path.Join(dirPrefix, tgt),
364 path.Join(dirPrefix, basename),
368 cmd := exec.Command(cmdName, args...)
370 // cmd.Stdin reads from /dev/null by default
371 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
372 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
373 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
375 childStderrPrefix := tempsuffix()
376 cmd.Env = append(cmd.Env, fmt.Sprintf(
377 "%s=%s", EnvStderrPrefix, childStderrPrefix,
381 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
382 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
384 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
385 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
389 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
391 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
392 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
397 var fdStderr *os.File
399 fdStderr, err = os.OpenFile(
400 path.Join(redoDir, tgt+LogSuffix),
401 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
406 return TgtError{tgtOrig, err}
409 shCtx := fmt.Sprintf(
410 "sh: %s: %s %s cwd:%s dirprefix:%s",
411 tgtOrig, cmdName, args, cwd, dirPrefix,
413 tracef(CDebug, "%s", shCtx)
417 jsToken := jsAcquire(shCtx)
420 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
422 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
423 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
424 makeFlags := fmt.Sprintf(
425 "%s %s%d,%d", MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
427 makeFlags = strings.Trim(makeFlags, " ")
428 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", MakeFlagsName, makeFlags))
430 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
434 if _, err = FdStatus.Write([]byte{StatusRun}); err != nil {
439 var finished time.Time
440 var exitErr *exec.ExitError
441 started := time.Now()
442 runErr.Started = &started
443 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
449 cmd.Stdout = fdStdout
450 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
456 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
457 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
459 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
462 jsRelease(shCtx, jsToken)
467 logRecPath := path.Join(redoDir, tgt+LogRecSuffix)
468 if fdStderr, err = os.OpenFile(
470 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
473 fields := []recfile.Field{
474 {Name: "Build", Value: BuildUUID},
475 {Name: "PPID", Value: strconv.Itoa(os.Getpid())},
476 {Name: "Cwd", Value: cwd},
478 if cmd.Process != nil {
479 fields = append(fields, recfile.Field{
480 Name: "PID", Value: strconv.Itoa(cmd.Process.Pid),
483 ts := new(tai64n.TAI64N)
485 fields = append(fields,
486 recfile.Field{Name: "Started", Value: tai64n.Encode(ts[:])},
488 ts.FromTime(finished)
489 fields = append(fields,
490 recfile.Field{Name: "Finished", Value: tai64n.Encode(ts[:])})
491 fields = append(fields, recfile.Field{
493 Value: strconv.FormatInt(finished.Sub(started).Nanoseconds(), 10),
495 fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
496 for _, arg := range args {
497 fields = append(fields, recfile.Field{Name: "Arg", Value: arg})
499 for _, env := range cmd.Env {
500 fields = append(fields, recfile.Field{Name: "Env", Value: env})
503 fields = append(fields, recfile.Field{
505 Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
508 w := bufio.NewWriter(fdStderr)
511 fdDep, err := os.Open(fdDepPath)
515 depInfo, err = depRead(fdDep)
520 for _, dep := range depInfo.ifchanges {
521 fields = append(fields, recfile.Field{
523 Value: dep["Target"],
526 _, err = recfile.NewWriter(w).WriteFields(fields...)
534 os.Remove(logRecPath)
538 log.Println("can not open", logRecPath, ":", err)
542 os.Remove(fdDep.Name())
543 os.Remove(fdStdout.Name())
545 os.Remove(fdLock.Name())
547 if _, err = FdStatus.Write([]byte{StatusDone}); err != nil {
553 stderr, err := cmd.StderrPipe()
567 RunningProcs[cmd.Process.Pid] = cmd.Process
568 RunningProcsM.Unlock()
569 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
570 tracef(CDebug, "%s runs %s", tgtOrig, pid)
572 stderrTerm := make(chan struct{})
574 scanner := bufio.NewScanner(stderr)
576 ts := new(tai64n.TAI64N)
578 line = scanner.Text()
579 if strings.HasPrefix(line, childStderrPrefix) {
580 line = line[len(childStderrPrefix):]
581 os.Stderr.WriteString(StderrPrefix + line + "\n")
585 ts.FromTime(time.Now())
587 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
594 tracef(CNone, "%s", line)
596 tracef(CNone, "%s %s", pid, line)
602 // Wait for job completion
606 delete(RunningProcs, cmd.Process.Pid)
607 RunningProcsM.Unlock()
608 finished = time.Now()
609 runErr.Finished = &finished
611 exitErr = err.(*exec.ExitError)
618 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
619 errTouched := Err1WasTouched
620 if inodePrev == nil {
622 runErr.Err = errTouched
626 inode, err := inodeFromFile(fd)
633 if !inode.Equals(inodePrev) {
634 runErr.Err = errTouched
640 if inodePrev != nil {
641 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
642 inode, err := inodeFromFile(fd)
644 if err == nil && !inode.Equals(inodePrev) {
645 runErr.Err = Err1WasTouched
652 // Does it produce both stdout and tmp?
653 fiStdout, err := os.Stat(fdStdout.Name())
660 _, err = os.Stat(tmpPath)
662 if fiStdout.Size() > 0 {
663 runErr.Err = errors.New("created both tmp and stdout")
668 } else if !os.IsNotExist(err) {
674 // Determine what file we must process at last
677 fd, err = os.Open(tmpPath)
682 } else if fiStdout.Size() > 0 {
686 // Do we need to ifcreate it, or ifchange with renaming?
688 os.Remove(path.Join(cwdOrig, tgt))
689 err = ifcreate(fdDep, tgt)
700 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
705 err = syncDir(cwdOrig)
710 err = depWrite(fdDep, cwdOrig, tgt)
723 fdDepPath = path.Join(redoDir, tgt+DepSuffix)
724 err = os.Rename(fdDep.Name(), fdDepPath)
729 err = syncDir(redoDir)
741 func isOkRun(err error) bool {
746 if errors.As(err, &runErr) && runErr.Err == nil {
747 tracef(CRedo, "%s", runErr.Name())
750 tracef(CErr, "%s", err)