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 EnvDepCwd = "REDO_DEP_CWD"
46 EnvBuildUUID = "REDO_BUILD_UUID"
47 EnvStderrPrefix = "REDO_STDERR_PREFIX"
48 EnvTrace = "REDO_TRACE"
49 EnvStderrKeep = "REDO_LOGS"
50 EnvStderrSilent = "REDO_SILENT"
51 EnvNoSync = "REDO_NO_SYNC"
62 StderrKeep bool = false
63 StderrSilent bool = false
67 flagTrace = flag.Bool("x", false, "trace (sh -x) current targets")
68 flagTraceAll = flag.Bool("xx", false, fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
69 flagStderrKeep = flag.Bool("logs", false, fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
70 flagStderrSilent = flag.Bool("silent", false, fmt.Sprintf("do not print job's stderr (%s=1)", EnvStderrSilent))
83 func (e *RunErr) Name() string {
88 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
90 if e.Finished == nil {
93 return fmt.Sprintf("%s (%.3fs)", name, e.Finished.Sub(*e.Started).Seconds())
96 func (e RunErr) Error() string {
97 return fmt.Sprintf("%s: %s", e.Name(), e.Err)
100 func mkdirs(pth string) error {
101 if _, err := os.Stat(pth); err == nil {
104 return os.MkdirAll(pth, os.FileMode(0777))
107 func isModified(cwd, redoDir, tgt string) (bool, *Inode, error) {
108 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
110 if os.IsNotExist(err) {
111 return false, nil, nil
113 return false, nil, err
116 r := recfile.NewReader(fdDep)
119 m, err := r.NextMap()
124 return false, nil, err
126 if m["Target"] != tgt {
129 fd, err := os.Open(path.Join(cwd, tgt))
131 if os.IsNotExist(err) {
132 return false, nil, nil
134 return false, nil, err
136 ourInode, err = inodeFromFile(fd)
139 return false, nil, err
141 theirInode, err := inodeFromRec(m)
143 return false, nil, err
145 if !ourInode.Equals(theirInode) {
146 return true, ourInode, nil
150 return false, ourInode, nil
153 func syncDir(dir string) error {
154 fd, err := os.Open(dir)
163 func runScript(tgtOrig string, errs chan error, traced bool) error {
164 cwd, tgt := cwdAndTgt(tgtOrig)
165 redoDir := path.Join(cwd, RedoDir)
166 if err := mkdirs(redoDir); err != nil {
167 return TgtErr{tgtOrig, err}
171 fdLock, err := os.OpenFile(
172 path.Join(redoDir, tgt+LockSuffix),
173 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
177 return TgtErr{tgtOrig, err}
179 lockRelease := func() {
180 trace(CLock, "LOCK_UN: %s", fdLock.Name())
181 unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
184 trace(CLock, "LOCK_NB: %s", fdLock.Name())
186 // Waiting for job completion, already taken by someone else
187 if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
188 if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
190 return TgtErr{tgtOrig, err}
193 trace(CDebug, "waiting: %s", tgtOrig)
195 FdStatus.Write([]byte{StatusWait})
199 trace(CLock, "LOCK_EX: %s", fdLock.Name())
200 unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
202 trace(CDebug, "waiting done: %s", tgtOrig)
204 FdStatus.Write([]byte{StatusWaited})
207 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
209 if os.IsNotExist(err) {
210 err = errors.New("was not built: no .rec")
215 depInfo, err = depRead(fdDep)
219 if depInfo.build != BuildUUID {
220 err = errors.New("was not built: build differs")
224 err = TgtErr{tgtOrig, err}
231 // Check if target is not modified externally
232 modified, inodePrev, err := isModified(cwd, redoDir, tgt)
235 return TgtErr{tgtOrig, err}
238 trace(CWarn, "%s externally modified: not redoing", tgtOrig)
246 // Start preparing .rec
247 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
250 return TgtErr{tgtOrig, err}
252 fdDepPath := fdDep.Name()
256 os.Remove(fdDep.Name())
258 if _, err = recfile.NewWriter(fdDep).WriteFields(
259 recfile.Field{Name: "Build", Value: BuildUUID},
262 return TgtErr{tgtOrig, err}
266 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
269 return TgtErr{tgtOrig, err}
273 return TgtErr{tgtOrig, errors.New("no .do found")}
276 // Determine basename and DIRPREFIX
277 doFileRelPath := doFile
278 ents := strings.Split(cwd, "/")
279 ents = ents[len(ents)-upLevels:]
280 dirPrefix := path.Join(ents...)
282 for i := 0; i < upLevels; i++ {
283 cwd = path.Join(cwd, "..")
284 doFileRelPath = path.Join("..", doFileRelPath)
286 cwd = path.Clean(cwd)
287 doFilePath := path.Join(cwd, doFile)
289 runErr := RunErr{Tgt: tgtOrig}
290 if strings.HasPrefix(doFile, "default.") {
291 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
292 runErr.DoFile = doFileRelPath
295 if err = writeDep(fdDep, cwdOrig, doFileRelPath); err != nil {
297 return TgtErr{tgtOrig, err}
300 trace(CWait, "%s", runErr.Name())
302 // Prepare command line
305 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
307 args = make([]string, 0, 3)
310 if traced || TracedAll {
311 args = append(args, "-ex")
313 args = append(args, "-e")
315 args = append(args, doFile)
318 // Temporary file for stdout
319 fdStdout, err := tempfile(cwdOrig, tgt)
322 return TgtErr{tgtOrig, err}
324 stdoutPath := fdStdout.Name()
326 tmpPath := stdoutPath + ".3" // and for $3
327 tmpPathRel, err := filepath.Rel(cwd, tmpPath)
333 path.Join(dirPrefix, tgt),
334 path.Join(dirPrefix, basename),
338 cmd := exec.Command(cmdName, args...)
340 // cmd.Stdin reads from /dev/null by default
341 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
342 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
343 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
345 childStderrPrefix := tempsuffix()
346 cmd.Env = append(cmd.Env, fmt.Sprintf(
347 "%s=%s", EnvStderrPrefix, childStderrPrefix,
351 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
352 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
354 cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
355 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
359 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
361 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
362 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
367 var fdStderr *os.File
369 fdStderr, err = os.OpenFile(
370 path.Join(redoDir, tgt+LogSuffix),
371 os.O_WRONLY|os.O_CREATE,
376 return TgtErr{tgtOrig, err}
380 shCtx := fmt.Sprintf(
381 "sh: %s: %s %s cwd:%s dirprefix:%s",
382 tgtOrig, cmdName, args, cwd, dirPrefix,
384 trace(CDebug, "%s", shCtx)
388 jsToken := jsAcquire(shCtx)
391 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
393 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
394 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
395 cmd.Env = append(cmd.Env, fmt.Sprintf(
397 MakeFlagsName, MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
400 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
404 FdStatus.Write([]byte{StatusRun})
407 started := time.Now()
408 runErr.Started = &started
409 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
415 cmd.Stdout = fdStdout
416 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
422 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
423 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
425 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
428 jsRelease(shCtx, jsToken)
435 os.Remove(fdDep.Name())
436 os.Remove(fdStdout.Name())
438 os.Remove(fdLock.Name())
440 FdStatus.Write([]byte{StatusDone})
444 stderr, err := cmd.StderrPipe()
457 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
458 trace(CDebug, "%s runs %s", tgtOrig, pid)
460 stderrTerm := make(chan struct{}, 0)
462 scanner := bufio.NewScanner(stderr)
464 ts := new(tai64n.TAI64N)
466 line = scanner.Text()
467 if strings.HasPrefix(line, childStderrPrefix) {
468 line = line[len(childStderrPrefix):]
469 os.Stderr.WriteString(StderrPrefix + line + "\n")
473 ts.FromTime(time.Now())
475 fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
482 trace(CNone, "%s", line)
484 trace(CNone, "%s %s", pid, line)
490 // Wait for job completion
493 finished := time.Now()
494 runErr.Finished = &finished
502 if inodePrev != nil {
503 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
504 inode, err := inodeFromFile(fd)
506 if err == nil && !inode.Equals(inodePrev) {
507 runErr.Err = errors.New("$1 was explicitly touched")
514 // Does it produce both stdout and tmp?
515 fiStdout, err := os.Stat(fdStdout.Name())
522 _, err = os.Stat(tmpPath)
524 if fiStdout.Size() > 0 {
525 runErr.Err = errors.New("created both tmp and stdout")
530 } else if !os.IsNotExist(err) {
536 // Determine what file we must process at last
539 fd, err = os.Open(tmpPath)
544 } else if fiStdout.Size() > 0 {
548 // Do we need to ifcreate it, of ifchange with renaming?
550 os.Remove(path.Join(cwdOrig, tgt))
551 err = ifcreate(fdDep, tgt)
562 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
567 err = syncDir(cwdOrig)
572 err = writeDep(fdDep, cwdOrig, tgt)
585 err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
590 err = syncDir(redoDir)
602 func isOkRun(err error) bool {
606 if err, ok := err.(RunErr); ok && err.Err == nil {
607 trace(CRedo, "%s", err.Name())
610 trace(CErr, "%s", err)