2 goredo -- 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, string, error) {
105 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
107 if os.IsNotExist(err) {
108 return false, "", nil
110 return false, "", err
113 r := recfile.NewReader(fdDep)
116 m, err := r.NextMap()
121 return false, "", err
123 if m["Target"] != tgt {
126 fd, err := os.Open(path.Join(cwd, tgt))
128 if os.IsNotExist(err) {
129 return false, "", nil
131 return false, "", err
134 ourTs, err = fileCtime(fd)
136 return false, "", err
138 if ourTs != m["Ctime"] {
139 return true, ourTs, nil
143 return false, ourTs, nil
146 func syncDir(dir string) error {
147 fd, err := os.Open(dir)
156 func runScript(tgtOrig string, errs chan error, traced bool) error {
157 cwd, tgt := cwdAndTgt(tgtOrig)
158 redoDir := path.Join(cwd, RedoDir)
159 if err := mkdirs(redoDir); err != nil {
160 return TgtErr{tgtOrig, err}
164 fdLock, err := os.OpenFile(
165 path.Join(redoDir, tgt+LockSuffix),
166 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
170 return TgtErr{tgtOrig, err}
172 lockRelease := func() {
173 trace(CLock, "LOCK_UN: %s", fdLock.Name())
174 unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
177 trace(CLock, "LOCK_NB: %s", fdLock.Name())
179 // Waiting for job completion, already taken by someone else
180 if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
181 if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
183 return TgtErr{tgtOrig, err}
186 trace(CDebug, "waiting: %s", tgtOrig)
188 FdStatus.Write([]byte{StatusWait})
192 trace(CLock, "LOCK_EX: %s", fdLock.Name())
193 unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
195 trace(CDebug, "waiting done: %s", tgtOrig)
197 FdStatus.Write([]byte{StatusWaited})
200 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
202 if os.IsNotExist(err) {
203 err = errors.New("was not built: no .dep")
208 depInfo, err = depRead(fdDep)
212 if depInfo.build != BuildUUID {
213 err = errors.New("was not built: build differs")
217 err = TgtErr{tgtOrig, err}
224 // Check if target is not modified externally
225 modified, tsPrev, err := isModified(cwd, redoDir, tgt)
228 return TgtErr{tgtOrig, err}
231 trace(CWarn, "%s externally modified: not redoing", tgtOrig)
239 // Start preparing .dep
240 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
243 return TgtErr{tgtOrig, err}
248 os.Remove(fdDep.Name())
250 if _, err = recfile.NewWriter(fdDep).WriteFields(
251 recfile.Field{Name: "Build", Value: BuildUUID},
254 return TgtErr{tgtOrig, err}
258 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
261 return TgtErr{tgtOrig, err}
265 return TgtErr{tgtOrig, errors.New("no .do found")}
268 // Determine basename and DIRPREFIX
269 doFileRelPath := doFile
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, "..")
276 doFileRelPath = path.Join("..", doFileRelPath)
278 cwd = path.Clean(cwd)
279 doFilePath := path.Join(cwd, doFile)
281 runErr := RunErr{Tgt: tgtOrig}
282 if strings.HasPrefix(doFile, "default.") {
283 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
284 runErr.DoFile = doFileRelPath
287 if err = writeDep(fdDep, cwdOrig, doFileRelPath); err != nil {
289 return TgtErr{tgtOrig, err}
291 trace(CWait, "%s", runErr.Name())
293 // Prepare command line
296 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
298 args = make([]string, 0, 3)
302 args = append(args, "-ex")
304 args = append(args, "-e")
306 args = append(args, doFile)
309 // Temporary file for stdout
310 fdStdout, err := tempfile(cwdOrig, tgt)
313 return TgtErr{tgtOrig, err}
315 tmpPath := fdStdout.Name() + ".3" // and for $3
316 tmpPathRel, err := filepath.Rel(cwd, tmpPath)
322 path.Join(dirPrefix, tgt),
323 path.Join(dirPrefix, basename),
327 cmd := exec.Command(cmdName, args...)
329 cmd.Stdout = fdStdout
330 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
331 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
332 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
334 childStderrPrefix := tempsuffix()
335 cmd.Env = append(cmd.Env, fmt.Sprintf(
336 "%s=%s", EnvStderrPrefix, childStderrPrefix,
340 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
341 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
345 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
347 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
348 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
354 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJSFd))
356 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
357 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
358 cmd.Env = append(cmd.Env, fmt.Sprintf(
359 "%s=%d,%d", EnvJSFd, 3+fdNum+0, 3+fdNum+1,
365 stderr, err := cmd.StderrPipe()
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})
402 os.Remove(fdDep.Name())
403 os.Remove(fdStdout.Name())
405 os.Remove(fdLock.Name())
407 FdStatus.Write([]byte{StatusDone})
411 started := time.Now()
412 runErr.Started = &started
419 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
420 trace(CDebug, "%s runs %s", tgtOrig, pid)
422 stderrTerm := make(chan struct{}, 0)
424 scanner := bufio.NewScanner(stderr)
426 ts := new(tai64n.TAI64N)
428 line = scanner.Text()
429 if strings.HasPrefix(line, childStderrPrefix) {
430 line = line[len(childStderrPrefix):]
431 os.Stderr.WriteString(StderrPrefix + line + "\n")
435 tai64n.FromTime(time.Now(), ts)
437 fmt.Fprintf(fdStderr, "%s %s\n", ts.Encode(), line)
444 trace(CNone, "%s", line)
446 trace(CNone, "%s %s", pid, line)
452 // Wait for job completion
455 finished := time.Now()
456 runErr.Finished = &finished
465 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
466 ts, err := fileCtime(fd)
468 if err == nil && ts != tsPrev {
469 runErr.Err = errors.New("$1 was explicitly touched")
477 // Does it produce both stdout and tmp?
478 fiStdout, err := os.Stat(fdStdout.Name())
485 _, err = os.Stat(tmpPath)
487 if fiStdout.Size() > 0 {
488 runErr.Err = errors.New("created both tmp and stdout")
493 } else if !os.IsNotExist(err) {
499 // Determine what file we must process at last
502 fd, err = os.Open(tmpPath)
507 } else if fiStdout.Size() > 0 {
511 // Do we need to ifcreate it, of ifchange with renaming?
513 os.Remove(path.Join(cwdOrig, tgt))
514 err = ifcreate(fdDep, tgt)
525 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
530 err = syncDir(cwdOrig)
535 err = writeDep(fdDep, cwdOrig, tgt)
548 err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
553 err = syncDir(redoDir)
565 func isOkRun(err error) bool {
569 if err, ok := err.(RunErr); ok && err.Err == nil {
570 trace(CRedo, "%s", err.Name())
573 trace(CErr, "%s", err)