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/>.
37 "go.cypherpunks.ru/recfile"
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, fmt.Sprintf("trace current target (sh -x) (set %s=1 for all others)", EnvTrace))
66 flagStderrKeep = flag.Bool("logs", false, fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
67 flagStderrSilent = flag.Bool("silent", false, fmt.Sprintf("do not print job's stderr (%s=1)", EnvStderrSilent))
78 func (e RunErr) Unwrap() error { return e.Err }
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 ents := strings.Split(cwd, "/")
270 ents = ents[len(ents)-upLevels:]
271 dirPrefix := path.Join(ents...)
273 for i := 0; i < upLevels; i++ {
274 cwd = path.Join(cwd, "..")
276 cwd = path.Clean(cwd)
277 doFilePath := path.Join(cwd, doFile)
279 runErr := RunErr{Tgt: tgtOrig}
280 if strings.HasPrefix(doFile, "default.") {
281 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
282 runErr.DoFile = doFile
285 if err = writeDep(fdDep, cwd, doFile); err != nil {
287 return TgtErr{tgtOrig, err}
289 trace(CWait, "%s", runErr.Name())
291 // Prepare command line
294 if err = unix.Access(doFilePath, unix.X_OK); err == nil {
296 args = make([]string, 0, 3)
300 args = append(args, "-ex")
302 args = append(args, "-e")
304 args = append(args, doFile)
307 // Temporary file for stdout
308 fdStdout, err := tempfile(cwd, tgt)
311 return TgtErr{tgtOrig, err}
313 tmpPath := fdStdout.Name() + ".3" // and for $3
314 args = append(args, tgt, basename, path.Base(tmpPath))
316 cmd := exec.Command(cmdName, args...)
318 cmd.Stdout = fdStdout
319 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
320 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
321 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
323 childStderrPrefix := tempsuffix()
324 cmd.Env = append(cmd.Env, fmt.Sprintf(
325 "%s=%s", EnvStderrPrefix, childStderrPrefix,
329 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
330 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
334 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
336 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
337 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
343 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJSFd))
345 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
346 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
347 cmd.Env = append(cmd.Env, fmt.Sprintf(
348 "%s=%d,%d", EnvJSFd, 3+fdNum+0, 3+fdNum+1,
354 stderr, err := cmd.StderrPipe()
358 var fdStderr *os.File
360 fdStderr, err = os.OpenFile(
361 path.Join(redoDir, tgt+LogSuffix),
362 os.O_WRONLY|os.O_CREATE,
367 return TgtErr{tgtOrig, err}
371 shCtx := fmt.Sprintf("sh: %s: %s %s [%s]", tgtOrig, cmdName, args, cwd)
372 trace(CDebug, "%s", shCtx)
378 FdStatus.Write([]byte{StatusRun})
388 os.Remove(fdDep.Name())
389 os.Remove(fdStdout.Name())
391 os.Remove(fdLock.Name())
393 FdStatus.Write([]byte{StatusDone})
397 started := time.Now()
398 runErr.Started = &started
405 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
406 trace(CDebug, "%s runs %s", tgtOrig, pid)
408 stderrTerm := make(chan struct{}, 0)
410 scanner := bufio.NewScanner(stderr)
414 line = scanner.Text()
415 if strings.HasPrefix(line, childStderrPrefix) {
416 line = line[len(childStderrPrefix):]
417 os.Stderr.WriteString(StderrPrefix + line + "\n")
423 fmt.Fprintf(fdStderr, "@%s %s\n", hex.EncodeToString(ts[:]), line)
430 trace(CNone, "%s", line)
432 trace(CNone, "%s %s", pid, line)
438 // Wait for job completion
441 finished := time.Now()
442 runErr.Finished = &finished
450 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
451 ts, err := fileCtime(fd)
453 if err == nil && ts != tsPrev {
454 runErr.Err = errors.New("$1 was explicitly touched")
461 // Does it produce both stdout and tmp?
462 fiStdout, err := os.Stat(fdStdout.Name())
469 _, err = os.Stat(tmpPath)
471 if fiStdout.Size() > 0 {
472 runErr.Err = errors.New("created both tmp and stdout")
477 } else if !os.IsNotExist(err) {
483 // Determine what file we must process at last
486 fd, err = os.Open(tmpPath)
491 } else if fiStdout.Size() > 0 {
495 // Do we need to ifcreate it, of ifchange with renaming?
497 err = ifcreate(fdDep, tgt)
508 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
513 err = syncDir(cwdOrig)
518 err = writeDep(fdDep, cwdOrig, tgt)
531 err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
536 err = syncDir(redoDir)
548 func isOkRun(err error) bool {
552 if err, ok := err.(RunErr); ok && err.Err == nil {
553 trace(CRedo, "%s", err.Name())
556 trace(CErr, "%s", err)