/*
goredo -- redo implementation on pure Go
-Copyright (C) 2020 Sergey Matveev <stargrave@stargrave.org>
+Copyright (C) 2020-2021 Sergey Matveev <stargrave@stargrave.org>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
import (
"bufio"
- "encoding/hex"
"errors"
"flag"
"fmt"
"os"
"os/exec"
"path"
- "strconv"
+ "path/filepath"
"strings"
+ "sync"
"syscall"
"time"
"go.cypherpunks.ru/recfile"
+ "go.cypherpunks.ru/tai64n"
"golang.org/x/sys/unix"
)
EnvStderrKeep = "REDO_LOGS"
EnvStderrSilent = "REDO_SILENT"
EnvNoSync = "REDO_NO_SYNC"
- EnvStampPrev = "REDO_STAMP_PREV"
RedoDir = ".redo"
LockSuffix = ".lock"
)
var (
- Trace bool = false
NoSync bool = false
StderrKeep bool = false
StderrSilent bool = false
StderrPrefix string
- StampPrev string
+ Jobs sync.WaitGroup
- flagTrace = flag.Bool("x", false, "trace current target (sh -x) (set REDO_TRACE=1 for others too)")
- flagStderrKeep = flag.Bool("logs", false, "keep job's stderr (REDO_LOGS=1)")
- flagStderrSilent = flag.Bool("silent", false, "do not print job's stderr (REDO_SILENT=1)")
+ flagTrace = flag.Bool("x", false, "trace (sh -x) current targets")
+ flagTraceAll = flag.Bool("xx", false, fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
+ flagStderrKeep = flag.Bool("logs", false, fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
+ flagStderrSilent = flag.Bool("silent", false, fmt.Sprintf("do not print job's stderr (%s=1)", EnvStderrSilent))
)
type RunErr struct {
return os.MkdirAll(pth, os.FileMode(0777))
}
-func tempsuffix() string {
- return strconv.FormatInt((time.Now().UnixNano()+int64(os.Getpid()))&0xFFFFFFFF, 16)
-}
-
-func tempfile(dir, prefix string) (*os.File, error) {
- // It respects umask, unlike ioutil.TempFile
- name := path.Join(dir, TmpPrefix+prefix+"."+tempsuffix())
- return os.OpenFile(name, os.O_RDWR|os.O_CREATE|os.O_EXCL, os.FileMode(0666))
-}
-
-func isModified(cwd, redoDir, tgt string) (bool, error) {
+func isModified(cwd, redoDir, tgt string) (bool, string, error) {
fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
if err != nil {
if os.IsNotExist(err) {
- return false, nil
+ return false, "", nil
}
- return false, err
+ return false, "", err
}
defer fdDep.Close()
r := recfile.NewReader(fdDep)
+ var ourTs string
for {
m, err := r.NextMap()
if err != nil {
if err == io.EOF {
break
}
- return false, err
+ return false, "", err
}
if m["Target"] != tgt {
continue
fd, err := os.Open(path.Join(cwd, tgt))
if err != nil {
if os.IsNotExist(err) {
- return false, nil
+ return false, "", nil
}
- return false, err
+ return false, "", err
}
defer fd.Close()
- ourTs, err := fileCtime(fd)
+ ourTs, err = fileCtime(fd)
if err != nil {
- return false, err
+ return false, "", err
}
if ourTs != m["Ctime"] {
- return true, nil
+ return true, ourTs, nil
}
break
}
- return false, nil
+ return false, ourTs, nil
}
func syncDir(dir string) error {
return err
}
-func runScript(tgtOrig string, errs chan error, stampPrev string) error {
+func runScript(tgtOrig string, errs chan error, traced bool) error {
cwd, tgt := cwdAndTgt(tgtOrig)
redoDir := path.Join(cwd, RedoDir)
if err := mkdirs(redoDir); err != nil {
fdLock.Close()
return TgtErr{tgtOrig, err}
}
- trace(CDebug, "waiting: %s", tgtOrig)
Jobs.Add(1)
+ trace(CDebug, "waiting: %s", tgtOrig)
+ if FdStatus != nil {
+ FdStatus.Write([]byte{StatusWait})
+ }
go func() {
defer Jobs.Done()
trace(CLock, "LOCK_EX: %s", fdLock.Name())
unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
lockRelease()
trace(CDebug, "waiting done: %s", tgtOrig)
+ if FdStatus != nil {
+ FdStatus.Write([]byte{StatusWaited})
+ }
var depInfo *DepInfo
fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
if err != nil {
}
// Check if target is not modified externally
- modified, err := isModified(cwd, redoDir, tgt)
+ modified, tsPrev, err := isModified(cwd, redoDir, tgt)
if err != nil {
lockRelease()
return TgtErr{tgtOrig, err}
if modified {
trace(CWarn, "%s externally modified: not redoing", tgtOrig)
lockRelease()
- errs <- nil
- return TgtErr{tgtOrig, err}
+ go func() {
+ errs <- nil
+ }()
+ return nil
}
// Start preparing .dep
cleanup()
return TgtErr{tgtOrig, errors.New("no .do found")}
}
- if err = writeDep(fdDep, cwd, doFile); err != nil {
- cleanup()
- return TgtErr{tgtOrig, err}
- }
// Determine basename and DIRPREFIX
ents := strings.Split(cwd, "/")
cwd = path.Join(cwd, "..")
}
cwd = path.Clean(cwd)
+ doFilePath := path.Join(cwd, doFile)
basename := tgt
runErr := RunErr{Tgt: tgtOrig}
if strings.HasPrefix(doFile, "default.") {
basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
runErr.DoFile = doFile
}
+
+ if err = writeDep(fdDep, cwd, doFile); err != nil {
+ cleanup()
+ return TgtErr{tgtOrig, err}
+ }
trace(CWait, "%s", runErr.Name())
- doFile = path.Base(doFile)
// Prepare command line
var cmdName string
var args []string
- if err = unix.Access(path.Join(cwd, doFile), unix.X_OK); err == nil {
- // Ordinary executable file
- cmdName = doFile
+ if err = unix.Access(doFilePath, unix.X_OK); err == nil {
+ cmdName = doFilePath
args = make([]string, 0, 3)
} else {
- fd, err := os.Open(path.Join(cwd, doFile))
- if err != nil {
- cleanup()
- return TgtErr{tgtOrig, err}
- }
- buf := make([]byte, 512)
- n, err := fd.Read(buf)
- if err != nil {
- cleanup()
- return TgtErr{tgtOrig, err}
- }
- if n > 3 && string(buf[:3]) == "#!/" {
- // Shebanged
- t := string(buf[2:n])
- nlIdx := strings.Index(t, "\n")
- if nlIdx == -1 {
- cleanup()
- return TgtErr{tgtOrig, errors.New("not fully read shebang")}
- }
- args = strings.Split(t[:nlIdx], " ")
- cmdName, args = args[0], args[1:]
+ cmdName = "/bin/sh"
+ if traced {
+ args = append(args, "-ex")
} else {
- // Shell
- cmdName = "/bin/sh"
- if Trace {
- args = append(args, "-ex")
- } else {
- args = append(args, "-e")
- }
+ args = append(args, "-e")
}
args = append(args, doFile)
}
// Temporary file for stdout
- fdStdout, err := tempfile(cwd, tgt)
+ fdStdout, err := tempfile(cwdOrig, tgt)
if err != nil {
cleanup()
return TgtErr{tgtOrig, err}
}
tmpPath := fdStdout.Name() + ".3" // and for $3
- args = append(args, tgt, basename, path.Base(tmpPath))
+ tmpPathRel, err := filepath.Rel(cwd, tmpPath)
+ if err != nil {
+ panic(err)
+ }
+ args = append(
+ args,
+ path.Join(dirPrefix, tgt),
+ path.Join(dirPrefix, basename),
+ tmpPathRel,
+ )
cmd := exec.Command(cmdName, args...)
cmd.Dir = cwd
cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
- if stampPrev != "" {
- cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvStampPrev, stampPrev))
- }
-
childStderrPrefix := tempsuffix()
cmd.Env = append(cmd.Env, fmt.Sprintf(
"%s=%s", EnvStderrPrefix, childStderrPrefix,
))
- cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
fdNum := 0
+ cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
fdNum++
+
+ if FdStatus == nil {
+ cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
+ } else {
+ cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
+ cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
+ fdNum++
+ }
+
if JSR == nil {
// infinite jobs
cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJSFd))
} else {
cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
- cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d,%d", EnvJSFd, 3+fdNum+0, 3+fdNum+1))
+ cmd.Env = append(cmd.Env, fmt.Sprintf(
+ "%s=%d,%d", EnvJSFd, 3+fdNum+0, 3+fdNum+1,
+ ))
fdNum += 2
}
Jobs.Add(1)
go func() {
jsAcquire(shCtx)
+ if FdStatus != nil {
+ FdStatus.Write([]byte{StatusRun})
+ }
defer func() {
jsRelease(shCtx)
lockRelease()
os.Remove(fdStdout.Name())
os.Remove(tmpPath)
os.Remove(fdLock.Name())
+ if FdStatus != nil {
+ FdStatus.Write([]byte{StatusDone})
+ }
Jobs.Done()
}()
started := time.Now()
go func() {
scanner := bufio.NewScanner(stderr)
var line string
- ts := new(TAI64N)
+ ts := new(tai64n.TAI64N)
for scanner.Scan() {
line = scanner.Text()
if strings.HasPrefix(line, childStderrPrefix) {
continue
}
if fdStderr != nil {
- tai64nNow(ts)
- fmt.Fprintf(fdStderr, "@%s %s\n", hex.EncodeToString(ts[:]), line)
+ tai64n.FromTime(time.Now(), ts)
+ LogMutex.Lock()
+ fmt.Fprintf(fdStderr, "%s %s\n", ts.Encode(), line)
+ LogMutex.Unlock()
}
if StderrSilent {
continue
return
}
+ // Was $1 touched?
+ if tsPrev != "" {
+ if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
+ ts, err := fileCtime(fd)
+ fd.Close()
+ if err == nil && ts != tsPrev {
+ runErr.Err = errors.New("$1 was explicitly touched")
+ errs <- runErr
+ fd.Close()
+ return
+ }
+ }
+ }
+
// Does it produce both stdout and tmp?
fiStdout, err := os.Stat(fdStdout.Name())
if err != nil {
// Do we need to ifcreate it, of ifchange with renaming?
if fd == nil {
+ os.Remove(path.Join(cwdOrig, tgt))
err = ifcreate(fdDep, tgt)
if err != nil {
goto Finish
}()
return nil
}
+
+func isOkRun(err error) bool {
+ if err == nil {
+ return true
+ }
+ if err, ok := err.(RunErr); ok && err.Err == nil {
+ trace(CRedo, "%s", err.Name())
+ return true
+ }
+ trace(CErr, "%s", err)
+ return false
+}