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/>.
38 "go.cypherpunks.ru/recfile"
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 current target (sh -x) (set REDO_TRACE=1 for others too)")
67 flagStderrKeep = flag.Bool("logs", false, "keep job's stderr (REDO_LOGS=1)")
68 flagStderrSilent = flag.Bool("silent", false, "do not print job's stderr (REDO_SILENT=1)")
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 tempsuffix() string {
106 return strconv.FormatInt((time.Now().UnixNano()+int64(os.Getpid()))&0xFFFFFFFF, 16)
109 func tempfile(dir, prefix string) (*os.File, error) {
110 // It respects umask, unlike ioutil.TempFile
111 name := path.Join(dir, TmpPrefix+prefix+"."+tempsuffix())
112 return os.OpenFile(name, os.O_RDWR|os.O_CREATE|os.O_EXCL, os.FileMode(0666))
115 func isModified(cwd, redoDir, tgt string) (bool, string, error) {
116 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
118 if os.IsNotExist(err) {
119 return false, "", nil
121 return false, "", err
124 r := recfile.NewReader(fdDep)
127 m, err := r.NextMap()
132 return false, "", err
134 if m["Target"] != tgt {
137 fd, err := os.Open(path.Join(cwd, tgt))
139 if os.IsNotExist(err) {
140 return false, "", nil
142 return false, "", err
145 ourTs, err = fileCtime(fd)
147 return false, "", err
149 if ourTs != m["Ctime"] {
150 return true, ourTs, nil
154 return false, ourTs, nil
157 func syncDir(dir string) error {
158 fd, err := os.Open(dir)
167 func runScript(tgtOrig string, errs chan error, traced bool) error {
168 cwd, tgt := cwdAndTgt(tgtOrig)
169 redoDir := path.Join(cwd, RedoDir)
170 if err := mkdirs(redoDir); err != nil {
171 return TgtErr{tgtOrig, err}
175 fdLock, err := os.OpenFile(
176 path.Join(redoDir, tgt+LockSuffix),
177 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
181 return TgtErr{tgtOrig, err}
183 lockRelease := func() {
184 trace(CLock, "LOCK_UN: %s", fdLock.Name())
185 unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
188 trace(CLock, "LOCK_NB: %s", fdLock.Name())
190 // Waiting for job completion, already taken by someone else
191 if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
192 if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
194 return TgtErr{tgtOrig, err}
196 trace(CDebug, "waiting: %s", tgtOrig)
200 trace(CLock, "LOCK_EX: %s", fdLock.Name())
201 unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
203 trace(CDebug, "waiting done: %s", tgtOrig)
205 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
207 if os.IsNotExist(err) {
208 err = errors.New("was not built: no .dep")
213 depInfo, err = depRead(fdDep)
217 if depInfo.build != BuildUUID {
218 err = errors.New("was not built: build differs")
222 err = TgtErr{tgtOrig, err}
229 // Check if target is not modified externally
230 modified, tsPrev, err := isModified(cwd, redoDir, tgt)
233 return TgtErr{tgtOrig, err}
236 trace(CWarn, "%s externally modified: not redoing", tgtOrig)
244 // Start preparing .dep
245 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
248 return TgtErr{tgtOrig, err}
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")}
272 if err = writeDep(fdDep, cwd, doFile); err != nil {
274 return TgtErr{tgtOrig, err}
277 // Determine basename and DIRPREFIX
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, "..")
285 cwd = path.Clean(cwd)
287 runErr := RunErr{Tgt: tgtOrig}
288 if strings.HasPrefix(doFile, "default.") {
289 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
290 runErr.DoFile = doFile
292 trace(CWait, "%s", runErr.Name())
293 doFile = path.Base(doFile)
295 // Prepare command line
298 if err = unix.Access(path.Join(cwd, doFile), unix.X_OK); err == nil {
299 // Ordinary executable file
301 args = make([]string, 0, 3)
303 fd, err := os.Open(path.Join(cwd, doFile))
306 return TgtErr{tgtOrig, err}
308 buf := make([]byte, 512)
309 n, err := fd.Read(buf)
312 return TgtErr{tgtOrig, err}
314 if n > 3 && string(buf[:3]) == "#!/" {
316 t := string(buf[2:n])
317 nlIdx := strings.Index(t, "\n")
320 return TgtErr{tgtOrig, errors.New("not fully read shebang")}
322 args = strings.Split(t[:nlIdx], " ")
323 cmdName, args = args[0], args[1:]
328 args = append(args, "-ex")
330 args = append(args, "-e")
333 args = append(args, doFile)
336 // Temporary file for stdout
337 fdStdout, err := tempfile(cwd, tgt)
340 return TgtErr{tgtOrig, err}
342 tmpPath := fdStdout.Name() + ".3" // and for $3
343 args = append(args, tgt, basename, path.Base(tmpPath))
345 cmd := exec.Command(cmdName, args...)
347 cmd.Stdout = fdStdout
348 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
349 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
350 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
352 childStderrPrefix := tempsuffix()
353 cmd.Env = append(cmd.Env, fmt.Sprintf(
354 "%s=%s", EnvStderrPrefix, childStderrPrefix,
357 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
359 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
363 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJSFd))
365 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
366 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
367 cmd.Env = append(cmd.Env, fmt.Sprintf(
368 "%s=%d,%d", EnvJSFd, 3+fdNum+0, 3+fdNum+1,
374 stderr, err := cmd.StderrPipe()
378 var fdStderr *os.File
380 fdStderr, err = os.OpenFile(
381 path.Join(redoDir, tgt+LogSuffix),
382 os.O_WRONLY|os.O_CREATE,
387 return TgtErr{tgtOrig, err}
391 shCtx := fmt.Sprintf("sh: %s: %s %s [%s]", tgtOrig, cmdName, args, cwd)
392 trace(CDebug, "%s", shCtx)
405 os.Remove(fdDep.Name())
406 os.Remove(fdStdout.Name())
408 os.Remove(fdLock.Name())
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)
428 line = scanner.Text()
429 if strings.HasPrefix(line, childStderrPrefix) {
430 line = line[len(childStderrPrefix):]
431 os.Stderr.WriteString(StderrPrefix + line + "\n")
436 fmt.Fprintf(fdStderr, "@%s %s\n", hex.EncodeToString(ts[:]), line)
442 trace(CNone, "%s", line)
444 trace(CNone, "%s %s", pid, line)
450 // Wait for job completion
453 finished := time.Now()
454 runErr.Finished = &finished
462 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
463 ts, err := fileCtime(fd)
465 if err == nil && ts != tsPrev {
466 runErr.Err = errors.New("$1 was explicitly touched")
473 // Does it produce both stdout and tmp?
474 fiStdout, err := os.Stat(fdStdout.Name())
481 _, err = os.Stat(tmpPath)
483 if fiStdout.Size() > 0 {
484 runErr.Err = errors.New("created both tmp and stdout")
489 } else if !os.IsNotExist(err) {
495 // Determine what file we must process at last
498 fd, err = os.Open(tmpPath)
503 } else if fiStdout.Size() > 0 {
507 // Do we need to ifcreate it, of ifchange with renaming?
509 err = ifcreate(fdDep, tgt)
520 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
525 err = syncDir(cwdOrig)
530 err = writeDep(fdDep, cwdOrig, tgt)
543 err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
548 err = syncDir(redoDir)
560 func isOkRun(err error) bool {
564 if err, ok := err.(RunErr); ok && err.Err == nil {
565 trace(CRedo, "%s", err.Name())
568 trace(CErr, "%s", err)