2 goredo -- redo implementation on pure Go
3 Copyright (C) 2020 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/>.
36 "go.cypherpunks.ru/recfile"
37 "go.cypherpunks.ru/tai64n"
38 "golang.org/x/sys/unix"
42 EnvDepFd = "REDO_DEP_FD"
43 EnvDirPrefix = "REDO_DIRPREFIX"
44 EnvBuildUUID = "REDO_BUILD_UUID"
45 EnvStderrPrefix = "REDO_STDERR_PREFIX"
46 EnvTrace = "REDO_TRACE"
47 EnvStderrKeep = "REDO_LOGS"
48 EnvStderrSilent = "REDO_SILENT"
49 EnvNoSync = "REDO_NO_SYNC"
60 StderrKeep bool = false
61 StderrSilent bool = false
65 flagTrace = flag.Bool("x", false, "trace (sh -x) current targets")
66 flagTraceAll = flag.Bool("xx", false, fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
67 flagStderrKeep = flag.Bool("logs", false, fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
68 flagStderrSilent = flag.Bool("silent", false, fmt.Sprintf("do not print job's stderr (%s=1)", EnvStderrSilent))
79 func (e RunErr) Unwrap() error { return e.Err }
81 func (e *RunErr) Name() string {
86 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
88 if e.Finished == nil {
91 return fmt.Sprintf("%s (%fsec)", name, e.Finished.Sub(*e.Started).Seconds())
94 func (e RunErr) Error() string {
95 return fmt.Sprintf("%s: %s", e.Name(), e.Err)
98 func mkdirs(pth string) error {
99 if _, err := os.Stat(pth); err == nil {
102 return os.MkdirAll(pth, os.FileMode(0777))
105 func isModified(cwd, redoDir, tgt string) (bool, string, error) {
106 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
108 if os.IsNotExist(err) {
109 return false, "", nil
111 return false, "", err
114 r := recfile.NewReader(fdDep)
117 m, err := r.NextMap()
122 return false, "", err
124 if m["Target"] != tgt {
127 fd, err := os.Open(path.Join(cwd, tgt))
129 if os.IsNotExist(err) {
130 return false, "", nil
132 return false, "", err
135 ourTs, err = fileCtime(fd)
137 return false, "", err
139 if ourTs != m["Ctime"] {
140 return true, ourTs, nil
144 return false, ourTs, nil
147 func syncDir(dir string) error {
148 fd, err := os.Open(dir)
157 func runScript(tgtOrig string, errs chan error, traced bool) error {
158 cwd, tgt := cwdAndTgt(tgtOrig)
159 redoDir := path.Join(cwd, RedoDir)
160 if err := mkdirs(redoDir); err != nil {
161 return TgtErr{tgtOrig, err}
165 fdLock, err := os.OpenFile(
166 path.Join(redoDir, tgt+LockSuffix),
167 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
171 return TgtErr{tgtOrig, err}
173 lockRelease := func() {
174 trace(CLock, "LOCK_UN: %s", fdLock.Name())
175 unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
178 trace(CLock, "LOCK_NB: %s", fdLock.Name())
180 // Waiting for job completion, already taken by someone else
181 if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
182 if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
184 return TgtErr{tgtOrig, err}
187 trace(CDebug, "waiting: %s", tgtOrig)
189 FdStatus.Write([]byte{StatusWait})
193 trace(CLock, "LOCK_EX: %s", fdLock.Name())
194 unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
196 trace(CDebug, "waiting done: %s", tgtOrig)
198 FdStatus.Write([]byte{StatusWaited})
201 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
203 if os.IsNotExist(err) {
204 err = errors.New("was not built: no .dep")
209 depInfo, err = depRead(fdDep)
213 if depInfo.build != BuildUUID {
214 err = errors.New("was not built: build differs")
218 err = TgtErr{tgtOrig, err}
225 // Check if target is not modified externally
226 modified, tsPrev, err := isModified(cwd, redoDir, tgt)
229 return TgtErr{tgtOrig, err}
232 trace(CWarn, "%s externally modified: not redoing", tgtOrig)
240 // Start preparing .dep
241 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
244 return TgtErr{tgtOrig, err}
249 os.Remove(fdDep.Name())
251 if _, err = recfile.NewWriter(fdDep).WriteFields(
252 recfile.Field{Name: "Build", Value: BuildUUID},
255 return TgtErr{tgtOrig, err}
259 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
262 return TgtErr{tgtOrig, err}
266 return TgtErr{tgtOrig, errors.New("no .do found")}
269 // Determine basename and DIRPREFIX
270 ents := strings.Split(cwd, "/")
271 ents = ents[len(ents)-upLevels:]
272 dirPrefix := path.Join(ents...)
274 for i := 0; i < upLevels; i++ {
275 cwd = path.Join(cwd, "..")
277 cwd = path.Clean(cwd)
278 doFilePath := path.Join(cwd, doFile)
280 runErr := RunErr{Tgt: tgtOrig}
281 if strings.HasPrefix(doFile, "default.") {
282 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
283 runErr.DoFile = doFile
286 if err = writeDep(fdDep, cwd, doFile); err != nil {
288 return TgtErr{tgtOrig, err}
290 trace(CWait, "%s", runErr.Name())
292 // Prepare command line
295 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
297 args = make([]string, 0, 3)
301 args = append(args, "-ex")
303 args = append(args, "-e")
305 args = append(args, doFile)
308 // Temporary file for stdout
309 fdStdout, err := tempfile(cwd, tgt)
312 return TgtErr{tgtOrig, err}
314 tmpPath := fdStdout.Name() + ".3" // and for $3
315 args = append(args, tgt, basename, path.Base(tmpPath))
317 cmd := exec.Command(cmdName, args...)
319 cmd.Stdout = fdStdout
320 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
321 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
322 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
324 childStderrPrefix := tempsuffix()
325 cmd.Env = append(cmd.Env, fmt.Sprintf(
326 "%s=%s", EnvStderrPrefix, childStderrPrefix,
330 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
331 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
335 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
337 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
338 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
344 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJSFd))
346 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
347 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
348 cmd.Env = append(cmd.Env, fmt.Sprintf(
349 "%s=%d,%d", EnvJSFd, 3+fdNum+0, 3+fdNum+1,
355 stderr, err := cmd.StderrPipe()
359 var fdStderr *os.File
361 fdStderr, err = os.OpenFile(
362 path.Join(redoDir, tgt+LogSuffix),
363 os.O_WRONLY|os.O_CREATE,
368 return TgtErr{tgtOrig, err}
372 shCtx := fmt.Sprintf("sh: %s: %s %s [%s]", tgtOrig, cmdName, args, cwd)
373 trace(CDebug, "%s", shCtx)
379 FdStatus.Write([]byte{StatusRun})
389 os.Remove(fdDep.Name())
390 os.Remove(fdStdout.Name())
392 os.Remove(fdLock.Name())
394 FdStatus.Write([]byte{StatusDone})
398 started := time.Now()
399 runErr.Started = &started
406 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
407 trace(CDebug, "%s runs %s", tgtOrig, pid)
409 stderrTerm := make(chan struct{}, 0)
411 scanner := bufio.NewScanner(stderr)
413 ts := new(tai64n.TAI64N)
415 line = scanner.Text()
416 if strings.HasPrefix(line, childStderrPrefix) {
417 line = line[len(childStderrPrefix):]
418 os.Stderr.WriteString(StderrPrefix + line + "\n")
422 tai64n.FromTime(time.Now(), ts)
424 fmt.Fprintf(fdStderr, "%s %s\n", ts.Encode(), line)
431 trace(CNone, "%s", line)
433 trace(CNone, "%s %s", pid, line)
439 // Wait for job completion
442 finished := time.Now()
443 runErr.Finished = &finished
451 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
452 ts, err := fileCtime(fd)
454 if err == nil && ts != tsPrev {
455 runErr.Err = errors.New("$1 was explicitly touched")
462 // Does it produce both stdout and tmp?
463 fiStdout, err := os.Stat(fdStdout.Name())
470 _, err = os.Stat(tmpPath)
472 if fiStdout.Size() > 0 {
473 runErr.Err = errors.New("created both tmp and stdout")
478 } else if !os.IsNotExist(err) {
484 // Determine what file we must process at last
487 fd, err = os.Open(tmpPath)
492 } else if fiStdout.Size() > 0 {
496 // Do we need to ifcreate it, of ifchange with renaming?
498 err = ifcreate(fdDep, tgt)
509 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
514 err = syncDir(cwdOrig)
519 err = writeDep(fdDep, cwdOrig, tgt)
532 err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
537 err = syncDir(redoDir)
549 func isOkRun(err error) bool {
553 if err, ok := err.(RunErr); ok && err.Err == nil {
554 trace(CRedo, "%s", err.Name())
557 trace(CErr, "%s", err)