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/>.
37 "go.cypherpunks.ru/recfile"
38 "go.cypherpunks.ru/tai64n/v2"
39 "golang.org/x/sys/unix"
43 EnvDepFd = "REDO_DEP_FD"
44 EnvDirPrefix = "REDO_DIRPREFIX"
45 EnvBuildUUID = "REDO_BUILD_UUID"
46 EnvStderrPrefix = "REDO_STDERR_PREFIX"
47 EnvTrace = "REDO_TRACE"
48 EnvStderrKeep = "REDO_LOGS"
49 EnvStderrSilent = "REDO_SILENT"
50 EnvNoSync = "REDO_NO_SYNC"
61 StderrKeep bool = false
62 StderrSilent bool = false
66 flagTrace = flag.Bool("x", false, "trace (sh -x) current targets")
67 flagTraceAll = flag.Bool("xx", false, fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
68 flagStderrKeep = flag.Bool("logs", false, fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
69 flagStderrSilent = flag.Bool("silent", false, fmt.Sprintf("do not print job's stderr (%s=1)", EnvStderrSilent))
82 func (e *RunErr) Name() string {
87 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
89 if e.Finished == nil {
92 return fmt.Sprintf("%s (%.3fs)", name, e.Finished.Sub(*e.Started).Seconds())
95 func (e RunErr) Error() string {
96 return fmt.Sprintf("%s: %s", e.Name(), e.Err)
99 func mkdirs(pth string) error {
100 if _, err := os.Stat(pth); err == nil {
103 return os.MkdirAll(pth, os.FileMode(0777))
106 func isModified(cwd, redoDir, tgt string) (bool, *Inode, error) {
107 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
109 if os.IsNotExist(err) {
110 return false, nil, nil
112 return false, nil, err
115 r := recfile.NewReader(fdDep)
118 m, err := r.NextMap()
123 return false, nil, err
125 if m["Target"] != tgt {
128 fd, err := os.Open(path.Join(cwd, tgt))
130 if os.IsNotExist(err) {
131 return false, nil, nil
133 return false, nil, err
135 ourInode, err = inodeFromFile(fd)
138 return false, nil, err
140 theirInode, err := inodeFromRec(m)
142 return false, nil, err
144 if !ourInode.Equals(theirInode) {
145 return true, ourInode, nil
149 return false, ourInode, nil
152 func syncDir(dir string) error {
153 fd, err := os.Open(dir)
162 func runScript(tgtOrig string, errs chan error, traced bool) error {
163 cwd, tgt := cwdAndTgt(tgtOrig)
164 redoDir := path.Join(cwd, RedoDir)
165 if err := mkdirs(redoDir); err != nil {
166 return TgtErr{tgtOrig, err}
170 fdLock, err := os.OpenFile(
171 path.Join(redoDir, tgt+LockSuffix),
172 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
176 return TgtErr{tgtOrig, err}
178 lockRelease := func() {
179 trace(CLock, "LOCK_UN: %s", fdLock.Name())
180 unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
183 trace(CLock, "LOCK_NB: %s", fdLock.Name())
185 // Waiting for job completion, already taken by someone else
186 if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
187 if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
189 return TgtErr{tgtOrig, err}
192 trace(CDebug, "waiting: %s", tgtOrig)
194 FdStatus.Write([]byte{StatusWait})
198 trace(CLock, "LOCK_EX: %s", fdLock.Name())
199 unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
201 trace(CDebug, "waiting done: %s", tgtOrig)
203 FdStatus.Write([]byte{StatusWaited})
206 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
208 if os.IsNotExist(err) {
209 err = errors.New("was not built: no .rec")
214 depInfo, err = depRead(fdDep)
218 if depInfo.build != BuildUUID {
219 err = errors.New("was not built: build differs")
223 err = TgtErr{tgtOrig, err}
230 // Check if target is not modified externally
231 modified, inodePrev, err := isModified(cwd, redoDir, tgt)
234 return TgtErr{tgtOrig, err}
237 trace(CWarn, "%s externally modified: not redoing", tgtOrig)
245 // Start preparing .rec
246 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
249 return TgtErr{tgtOrig, err}
251 fdDepPath := fdDep.Name()
255 os.Remove(fdDep.Name())
257 if _, err = recfile.NewWriter(fdDep).WriteFields(
258 recfile.Field{Name: "Build", Value: BuildUUID},
261 return TgtErr{tgtOrig, err}
265 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
268 return TgtErr{tgtOrig, err}
272 return TgtErr{tgtOrig, errors.New("no .do found")}
275 // Determine basename and DIRPREFIX
276 doFileRelPath := doFile
277 ents := strings.Split(cwd, "/")
278 ents = ents[len(ents)-upLevels:]
279 dirPrefix := path.Join(ents...)
281 for i := 0; i < upLevels; i++ {
282 cwd = path.Join(cwd, "..")
283 doFileRelPath = path.Join("..", doFileRelPath)
285 cwd = path.Clean(cwd)
286 doFilePath := path.Join(cwd, doFile)
288 runErr := RunErr{Tgt: tgtOrig}
289 if strings.HasPrefix(doFile, "default.") {
290 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
291 runErr.DoFile = doFileRelPath
294 if err = writeDep(fdDep, cwdOrig, doFileRelPath); err != nil {
296 return TgtErr{tgtOrig, err}
299 trace(CWait, "%s", runErr.Name())
301 // Prepare command line
304 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
306 args = make([]string, 0, 3)
309 if traced || TracedAll {
310 args = append(args, "-ex")
312 args = append(args, "-e")
314 args = append(args, doFile)
317 // Temporary file for stdout
318 fdStdout, err := tempfile(cwdOrig, tgt)
321 return TgtErr{tgtOrig, err}
323 stdoutPath := fdStdout.Name()
325 tmpPath := stdoutPath + ".3" // and for $3
326 tmpPathRel, err := filepath.Rel(cwd, tmpPath)
332 path.Join(dirPrefix, tgt),
333 path.Join(dirPrefix, basename),
337 cmd := exec.Command(cmdName, args...)
339 // cmd.Stdin reads from /dev/null by default
340 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
341 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
342 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
344 childStderrPrefix := tempsuffix()
345 cmd.Env = append(cmd.Env, fmt.Sprintf(
346 "%s=%s", EnvStderrPrefix, childStderrPrefix,
350 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
351 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
353 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
354 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
358 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
360 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
361 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
366 var fdStderr *os.File
368 fdStderr, err = os.OpenFile(
369 path.Join(redoDir, tgt+LogSuffix),
370 os.O_WRONLY|os.O_CREATE,
375 return TgtErr{tgtOrig, err}
379 shCtx := fmt.Sprintf(
380 "sh: %s: %s %s cwd:%s dirprefix:%s",
381 tgtOrig, cmdName, args, cwd, dirPrefix,
383 trace(CDebug, "%s", shCtx)
387 jsToken := jsAcquire(shCtx)
390 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
392 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
393 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
394 cmd.Env = append(cmd.Env, fmt.Sprintf(
396 MakeFlagsName, MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
399 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
403 FdStatus.Write([]byte{StatusRun})
406 started := time.Now()
407 runErr.Started = &started
408 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
414 cmd.Stdout = fdStdout
415 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
421 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
422 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
426 jsRelease(shCtx, jsToken)
433 os.Remove(fdDep.Name())
434 os.Remove(fdStdout.Name())
436 os.Remove(fdLock.Name())
438 FdStatus.Write([]byte{StatusDone})
442 stderr, err := cmd.StderrPipe()
455 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
456 trace(CDebug, "%s runs %s", tgtOrig, pid)
458 stderrTerm := make(chan struct{}, 0)
460 scanner := bufio.NewScanner(stderr)
462 ts := new(tai64n.TAI64N)
464 line = scanner.Text()
465 if strings.HasPrefix(line, childStderrPrefix) {
466 line = line[len(childStderrPrefix):]
467 os.Stderr.WriteString(StderrPrefix + line + "\n")
471 ts.FromTime(time.Now())
473 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
480 trace(CNone, "%s", line)
482 trace(CNone, "%s %s", pid, line)
488 // Wait for job completion
491 finished := time.Now()
492 runErr.Finished = &finished
500 if inodePrev != nil {
501 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
502 inode, err := inodeFromFile(fd)
504 if err == nil && !inode.Equals(inodePrev) {
505 runErr.Err = errors.New("$1 was explicitly touched")
512 // Does it produce both stdout and tmp?
513 fiStdout, err := os.Stat(fdStdout.Name())
520 _, err = os.Stat(tmpPath)
522 if fiStdout.Size() > 0 {
523 runErr.Err = errors.New("created both tmp and stdout")
528 } else if !os.IsNotExist(err) {
534 // Determine what file we must process at last
537 fd, err = os.Open(tmpPath)
542 } else if fiStdout.Size() > 0 {
546 // Do we need to ifcreate it, of ifchange with renaming?
548 os.Remove(path.Join(cwdOrig, tgt))
549 err = ifcreate(fdDep, tgt)
560 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
565 err = syncDir(cwdOrig)
570 err = writeDep(fdDep, cwdOrig, tgt)
583 err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
588 err = syncDir(redoDir)
600 func isOkRun(err error) bool {
604 if err, ok := err.(RunErr); ok && err.Err == nil {
605 trace(CRedo, "%s", err.Name())
608 trace(CErr, "%s", err)