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
77 RunningProcs = map[int]*os.Process{}
78 RunningProcsM sync.Mutex
83 if !(cmdName == CmdNameRedo || cmdName == CmdNameRedoIfchange) {
86 flagTrace = flag.Bool("x", false, "trace (sh -x) current targets")
87 flagTraceAll = flag.Bool("xx", false,
88 fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
89 flagStderrKeep = flag.Bool("k", false,
90 fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
91 flagStderrSilent = flag.Bool("s", false,
92 fmt.Sprintf("silent, do not print job's stderr (%s=1)", EnvStderrSilent))
103 func (e *RunErr) Name() string {
108 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
110 if e.Finished == nil {
113 return fmt.Sprintf("%s (%.3fs)", name, e.Finished.Sub(*e.Started).Seconds())
116 func (e RunErr) Error() string {
117 return fmt.Sprintf("%s: %s", e.Name(), e.Err)
120 func mkdirs(pth string) error {
121 if _, err := os.Stat(pth); err == nil {
124 return os.MkdirAll(pth, os.FileMode(0777))
127 func isModified(cwd, redoDir, tgt string) (bool, *Inode, error) {
128 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
130 if os.IsNotExist(err) {
131 return false, nil, nil
133 return false, nil, err
136 r := recfile.NewReader(fdDep)
139 m, err := r.NextMap()
144 return false, nil, err
146 if m["Target"] != tgt {
149 fd, err := os.Open(path.Join(cwd, tgt))
151 if os.IsNotExist(err) {
152 return false, nil, nil
154 return false, nil, err
156 ourInode, err = inodeFromFile(fd)
159 return false, nil, err
161 theirInode, err := inodeFromRec(m)
163 return false, nil, err
165 if !ourInode.Equals(theirInode) {
166 return true, ourInode, nil
170 return false, ourInode, nil
173 func syncDir(dir string) error {
174 fd, err := os.Open(dir)
183 func runScript(tgtOrig string, errs chan error, traced bool) error {
184 cwd, tgt := cwdAndTgt(tgtOrig)
185 redoDir := path.Join(cwd, RedoDir)
186 if err := mkdirs(redoDir); err != nil {
187 return TgtErr{tgtOrig, err}
191 fdLock, err := os.OpenFile(
192 path.Join(redoDir, tgt+LockSuffix),
193 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
197 return TgtErr{tgtOrig, err}
199 lockRelease := func() {
200 trace(CLock, "LOCK_UN: %s", fdLock.Name())
201 unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
204 trace(CLock, "LOCK_NB: %s", fdLock.Name())
206 // Waiting for job completion, already taken by someone else
207 if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
208 if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
210 return TgtErr{tgtOrig, err}
213 trace(CDebug, "waiting: %s", tgtOrig)
215 FdStatus.Write([]byte{StatusWait})
219 trace(CLock, "LOCK_EX: %s", fdLock.Name())
220 unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
222 trace(CDebug, "waiting done: %s", tgtOrig)
224 FdStatus.Write([]byte{StatusWaited})
227 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
229 if os.IsNotExist(err) {
230 err = errors.New("was not built: no .rec")
235 depInfo, err = depRead(fdDep)
239 if depInfo.build != BuildUUID {
240 err = errors.New("was not built: build differs")
244 err = TgtErr{tgtOrig, err}
251 // Check if target is not modified externally
252 modified, inodePrev, err := isModified(cwd, redoDir, tgt)
255 return TgtErr{tgtOrig, err}
258 trace(CWarn, "%s externally modified: not redoing", tgtOrig)
266 // Start preparing .rec
267 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
270 return TgtErr{tgtOrig, err}
272 fdDepPath := fdDep.Name()
276 os.Remove(fdDep.Name())
278 if _, err = recfile.NewWriter(fdDep).WriteFields(
279 recfile.Field{Name: "Build", Value: BuildUUID},
282 return TgtErr{tgtOrig, err}
286 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
289 return TgtErr{tgtOrig, err}
293 return TgtErr{tgtOrig, errors.New("no .do found")}
296 // Determine basename and DIRPREFIX
297 doFileRelPath := doFile
298 ents := strings.Split(cwd, "/")
299 ents = ents[len(ents)-upLevels:]
300 dirPrefix := path.Join(ents...)
302 for i := 0; i < upLevels; i++ {
303 cwd = path.Join(cwd, "..")
304 doFileRelPath = path.Join("..", doFileRelPath)
306 cwd = path.Clean(cwd)
307 doFilePath := path.Join(cwd, doFile)
309 runErr := RunErr{Tgt: tgtOrig}
310 if strings.HasPrefix(doFile, "default.") {
311 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
312 runErr.DoFile = doFileRelPath
315 if err = writeDep(fdDep, cwdOrig, doFileRelPath); err != nil {
317 return TgtErr{tgtOrig, err}
320 trace(CWait, "%s", runErr.Name())
322 // Prepare command line
325 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
327 args = make([]string, 0, 3)
330 if traced || TracedAll {
331 args = append(args, "-ex")
333 args = append(args, "-e")
335 args = append(args, doFile)
338 // Temporary file for stdout
339 fdStdout, err := tempfile(cwdOrig, tgt)
342 return TgtErr{tgtOrig, err}
344 stdoutPath := fdStdout.Name()
346 tmpPath := stdoutPath + ".3" // and for $3
347 tmpPathRel, err := filepath.Rel(cwd, tmpPath)
353 path.Join(dirPrefix, tgt),
354 path.Join(dirPrefix, basename),
358 cmd := exec.Command(cmdName, args...)
360 // cmd.Stdin reads from /dev/null by default
361 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
362 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
363 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
365 childStderrPrefix := tempsuffix()
366 cmd.Env = append(cmd.Env, fmt.Sprintf(
367 "%s=%s", EnvStderrPrefix, childStderrPrefix,
371 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
372 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
374 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
375 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
379 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
381 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
382 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
387 var fdStderr *os.File
389 fdStderr, err = os.OpenFile(
390 path.Join(redoDir, tgt+LogSuffix),
391 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
396 return TgtErr{tgtOrig, err}
399 shCtx := fmt.Sprintf(
400 "sh: %s: %s %s cwd:%s dirprefix:%s",
401 tgtOrig, cmdName, args, cwd, dirPrefix,
403 trace(CDebug, "%s", shCtx)
407 jsToken := jsAcquire(shCtx)
410 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
412 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
413 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
414 makeFlags := fmt.Sprintf(
415 "%s %s%d,%d", MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
417 makeFlags = strings.Trim(makeFlags, " ")
418 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", MakeFlagsName, makeFlags))
420 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
424 FdStatus.Write([]byte{StatusRun})
427 var finished time.Time
428 var exitErr *exec.ExitError
429 started := time.Now()
430 runErr.Started = &started
431 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
437 cmd.Stdout = fdStdout
438 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
444 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
445 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
447 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
450 jsRelease(shCtx, jsToken)
455 logRecPath := path.Join(redoDir, tgt+LogRecSuffix)
456 if fdStderr, err = os.OpenFile(
458 os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
461 fields := []recfile.Field{
462 {Name: "Build", Value: BuildUUID},
463 {Name: "PPID", Value: strconv.Itoa(os.Getpid())},
464 {Name: "Cwd", Value: cwd},
466 if cmd.Process != nil {
467 fields = append(fields, recfile.Field{
468 Name: "PID", Value: strconv.Itoa(cmd.Process.Pid),
471 ts := new(tai64n.TAI64N)
473 fields = append(fields,
474 recfile.Field{Name: "Started", Value: tai64n.Encode(ts[:])},
476 ts.FromTime(finished)
477 fields = append(fields,
478 recfile.Field{Name: "Finished", Value: tai64n.Encode(ts[:])})
479 fields = append(fields, recfile.Field{
481 Value: strconv.FormatInt(finished.Sub(started).Nanoseconds(), 10),
483 fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
484 for _, arg := range args {
485 fields = append(fields, recfile.Field{Name: "Arg", Value: arg})
487 for _, env := range cmd.Env {
488 fields = append(fields, recfile.Field{Name: "Env", Value: env})
491 fields = append(fields, recfile.Field{
493 Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
496 w := bufio.NewWriter(fdStderr)
499 fdDep, err := os.Open(fdDepPath)
503 depInfo, err = depRead(fdDep)
508 for _, dep := range depInfo.ifchanges {
509 fields = append(fields, recfile.Field{
511 Value: dep["Target"],
514 _, err = recfile.NewWriter(w).WriteFields(fields...)
522 os.Remove(logRecPath)
526 log.Println("can not open", logRecPath, ":", err)
530 os.Remove(fdDep.Name())
531 os.Remove(fdStdout.Name())
533 os.Remove(fdLock.Name())
535 FdStatus.Write([]byte{StatusDone})
539 stderr, err := cmd.StderrPipe()
553 RunningProcs[cmd.Process.Pid] = cmd.Process
554 RunningProcsM.Unlock()
555 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
556 trace(CDebug, "%s runs %s", tgtOrig, pid)
558 stderrTerm := make(chan struct{}, 0)
560 scanner := bufio.NewScanner(stderr)
562 ts := new(tai64n.TAI64N)
564 line = scanner.Text()
565 if strings.HasPrefix(line, childStderrPrefix) {
566 line = line[len(childStderrPrefix):]
567 os.Stderr.WriteString(StderrPrefix + line + "\n")
571 ts.FromTime(time.Now())
573 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
580 trace(CNone, "%s", line)
582 trace(CNone, "%s %s", pid, line)
588 // Wait for job completion
592 delete(RunningProcs, cmd.Process.Pid)
593 RunningProcsM.Unlock()
594 finished = time.Now()
595 runErr.Finished = &finished
597 exitErr = err.(*exec.ExitError)
604 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
605 errTouched := errors.New("$1 was explicitly touched")
606 if inodePrev == nil {
608 runErr.Err = errTouched
612 inode, err := inodeFromFile(fd)
619 if !inode.Equals(inodePrev) {
620 runErr.Err = errTouched
627 if inodePrev != nil {
628 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
629 inode, err := inodeFromFile(fd)
631 if err == nil && !inode.Equals(inodePrev) {
632 runErr.Err = errors.New("$1 was explicitly touched")
639 // Does it produce both stdout and tmp?
640 fiStdout, err := os.Stat(fdStdout.Name())
647 _, err = os.Stat(tmpPath)
649 if fiStdout.Size() > 0 {
650 runErr.Err = errors.New("created both tmp and stdout")
655 } else if !os.IsNotExist(err) {
661 // Determine what file we must process at last
664 fd, err = os.Open(tmpPath)
669 } else if fiStdout.Size() > 0 {
673 // Do we need to ifcreate it, of ifchange with renaming?
675 os.Remove(path.Join(cwdOrig, tgt))
676 err = ifcreate(fdDep, tgt)
687 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
692 err = syncDir(cwdOrig)
697 err = writeDep(fdDep, cwdOrig, tgt)
710 fdDepPath = path.Join(redoDir, tgt+DepSuffix)
711 err = os.Rename(fdDep.Name(), fdDepPath)
716 err = syncDir(redoDir)
728 func isOkRun(err error) bool {
732 if err, ok := err.(RunErr); ok && err.Err == nil {
733 trace(CRedo, "%s", err.Name())
736 trace(CErr, "%s", err)