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"
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))
80 func (e *RunErr) Name() string {
85 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
87 if e.Finished == nil {
90 return fmt.Sprintf("%s (%fsec)", name, e.Finished.Sub(*e.Started).Seconds())
93 func (e RunErr) Error() string {
94 return fmt.Sprintf("%s: %s", e.Name(), e.Err)
97 func mkdirs(pth string) error {
98 if _, err := os.Stat(pth); err == nil {
101 return os.MkdirAll(pth, os.FileMode(0777))
104 func isModified(cwd, redoDir, tgt string) (bool, *Inode, error) {
105 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
107 if os.IsNotExist(err) {
108 return false, nil, nil
110 return false, nil, err
113 r := recfile.NewReader(fdDep)
116 m, err := r.NextMap()
121 return false, nil, err
123 if m["Target"] != tgt {
126 fd, err := os.Open(path.Join(cwd, tgt))
128 if os.IsNotExist(err) {
129 return false, nil, nil
131 return false, nil, err
133 ourInode, err = inodeFromFile(fd)
136 return false, nil, err
138 theirInode, err := inodeFromRec(m)
140 return false, nil, err
142 if !ourInode.Equals(theirInode) {
143 return true, ourInode, nil
147 return false, ourInode, nil
150 func syncDir(dir string) error {
151 fd, err := os.Open(dir)
160 func runScript(tgtOrig string, errs chan error, traced bool) error {
161 cwd, tgt := cwdAndTgt(tgtOrig)
162 redoDir := path.Join(cwd, RedoDir)
163 if err := mkdirs(redoDir); err != nil {
164 return TgtErr{tgtOrig, err}
168 fdLock, err := os.OpenFile(
169 path.Join(redoDir, tgt+LockSuffix),
170 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
174 return TgtErr{tgtOrig, err}
176 lockRelease := func() {
177 trace(CLock, "LOCK_UN: %s", fdLock.Name())
178 unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
181 trace(CLock, "LOCK_NB: %s", fdLock.Name())
183 // Waiting for job completion, already taken by someone else
184 if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
185 if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
187 return TgtErr{tgtOrig, err}
190 trace(CDebug, "waiting: %s", tgtOrig)
192 FdStatus.Write([]byte{StatusWait})
196 trace(CLock, "LOCK_EX: %s", fdLock.Name())
197 unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
199 trace(CDebug, "waiting done: %s", tgtOrig)
201 FdStatus.Write([]byte{StatusWaited})
204 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
206 if os.IsNotExist(err) {
207 err = errors.New("was not built: no .rec")
212 depInfo, err = depRead(fdDep)
216 if depInfo.build != BuildUUID {
217 err = errors.New("was not built: build differs")
221 err = TgtErr{tgtOrig, err}
228 // Check if target is not modified externally
229 modified, inodePrev, err := isModified(cwd, redoDir, tgt)
232 return TgtErr{tgtOrig, err}
235 trace(CWarn, "%s externally modified: not redoing", tgtOrig)
243 // Start preparing .rec
244 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
247 return TgtErr{tgtOrig, err}
249 fdDepPath := fdDep.Name()
253 os.Remove(fdDep.Name())
255 if _, err = recfile.NewWriter(fdDep).WriteFields(
256 recfile.Field{Name: "Build", Value: BuildUUID},
259 return TgtErr{tgtOrig, err}
263 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
266 return TgtErr{tgtOrig, err}
270 return TgtErr{tgtOrig, errors.New("no .do found")}
273 // Determine basename and DIRPREFIX
274 doFileRelPath := doFile
275 ents := strings.Split(cwd, "/")
276 ents = ents[len(ents)-upLevels:]
277 dirPrefix := path.Join(ents...)
279 for i := 0; i < upLevels; i++ {
280 cwd = path.Join(cwd, "..")
281 doFileRelPath = path.Join("..", doFileRelPath)
283 cwd = path.Clean(cwd)
284 doFilePath := path.Join(cwd, doFile)
286 runErr := RunErr{Tgt: tgtOrig}
287 if strings.HasPrefix(doFile, "default.") {
288 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
289 runErr.DoFile = doFileRelPath
292 if err = writeDep(fdDep, cwdOrig, doFileRelPath); err != nil {
294 return TgtErr{tgtOrig, err}
297 trace(CWait, "%s", runErr.Name())
299 // Prepare command line
302 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
304 args = make([]string, 0, 3)
308 args = append(args, "-ex")
310 args = append(args, "-e")
312 args = append(args, doFile)
315 // Temporary file for stdout
316 fdStdout, err := tempfile(cwdOrig, tgt)
319 return TgtErr{tgtOrig, err}
321 stdoutPath := fdStdout.Name()
323 tmpPath := stdoutPath + ".3" // and for $3
324 tmpPathRel, err := filepath.Rel(cwd, tmpPath)
330 path.Join(dirPrefix, tgt),
331 path.Join(dirPrefix, basename),
335 cmd := exec.Command(cmdName, args...)
337 // cmd.Stdin reads from /dev/null by default
338 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
339 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
340 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
342 childStderrPrefix := tempsuffix()
343 cmd.Env = append(cmd.Env, fmt.Sprintf(
344 "%s=%s", EnvStderrPrefix, childStderrPrefix,
349 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
351 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
352 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
358 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJSFd))
360 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
361 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
362 cmd.Env = append(cmd.Env, fmt.Sprintf(
363 "%s=%d,%d", EnvJSFd, 3+fdNum+0, 3+fdNum+1,
369 var fdStderr *os.File
371 fdStderr, err = os.OpenFile(
372 path.Join(redoDir, tgt+LogSuffix),
373 os.O_WRONLY|os.O_CREATE,
378 return TgtErr{tgtOrig, err}
382 shCtx := fmt.Sprintf(
383 "sh: %s: %s %s cwd:%s dirprefix:%s",
384 tgtOrig, cmdName, args, cwd, dirPrefix,
386 trace(CDebug, "%s", shCtx)
392 FdStatus.Write([]byte{StatusRun})
395 started := time.Now()
396 runErr.Started = &started
397 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
403 cmd.Stdout = fdStdout
404 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
410 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
411 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
422 os.Remove(fdDep.Name())
423 os.Remove(fdStdout.Name())
425 os.Remove(fdLock.Name())
427 FdStatus.Write([]byte{StatusDone})
431 stderr, err := cmd.StderrPipe()
444 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
445 trace(CDebug, "%s runs %s", tgtOrig, pid)
447 stderrTerm := make(chan struct{}, 0)
449 scanner := bufio.NewScanner(stderr)
451 ts := new(tai64n.TAI64N)
453 line = scanner.Text()
454 if strings.HasPrefix(line, childStderrPrefix) {
455 line = line[len(childStderrPrefix):]
456 os.Stderr.WriteString(StderrPrefix + line + "\n")
460 tai64n.FromTime(time.Now(), ts)
462 fmt.Fprintf(fdStderr, "%s %s\n", ts.Encode(), line)
469 trace(CNone, "%s", line)
471 trace(CNone, "%s %s", pid, line)
477 // Wait for job completion
480 finished := time.Now()
481 runErr.Finished = &finished
489 if inodePrev != nil {
490 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
491 inode, err := inodeFromFile(fd)
493 if err == nil && !inode.Equals(inodePrev) {
494 runErr.Err = errors.New("$1 was explicitly touched")
501 // Does it produce both stdout and tmp?
502 fiStdout, err := os.Stat(fdStdout.Name())
509 _, err = os.Stat(tmpPath)
511 if fiStdout.Size() > 0 {
512 runErr.Err = errors.New("created both tmp and stdout")
517 } else if !os.IsNotExist(err) {
523 // Determine what file we must process at last
526 fd, err = os.Open(tmpPath)
531 } else if fiStdout.Size() > 0 {
535 // Do we need to ifcreate it, of ifchange with renaming?
537 os.Remove(path.Join(cwdOrig, tgt))
538 err = ifcreate(fdDep, tgt)
549 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
554 err = syncDir(cwdOrig)
559 err = writeDep(fdDep, cwdOrig, tgt)
572 err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
577 err = syncDir(redoDir)
589 func isOkRun(err error) bool {
593 if err, ok := err.(RunErr); ok && err.Err == nil {
594 trace(CRedo, "%s", err.Name())
597 trace(CErr, "%s", err)