/*
-goredo -- redo implementation on pure Go
-Copyright (C) 2020 Sergey Matveev <stargrave@stargrave.org>
+goredo -- djb's redo implementation on pure Go
+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"
"io"
"os"
"os/exec"
"path"
- "strconv"
+ "path/filepath"
"strings"
+ "sync"
"syscall"
"time"
"go.cypherpunks.ru/recfile"
+ "go.cypherpunks.ru/tai64n"
"golang.org/x/sys/unix"
)
const (
+ EnvDepFd = "REDO_DEP_FD"
+ EnvDirPrefix = "REDO_DIRPREFIX"
+ EnvBuildUUID = "REDO_BUILD_UUID"
+ EnvStderrPrefix = "REDO_STDERR_PREFIX"
+ EnvTrace = "REDO_TRACE"
+ EnvStderrKeep = "REDO_LOGS"
+ EnvStderrSilent = "REDO_SILENT"
+ EnvNoSync = "REDO_NO_SYNC"
+
RedoDir = ".redo"
LockSuffix = ".lock"
- DepSuffix = ".dep"
+ DepSuffix = ".rec"
TmpPrefix = ".redo."
LogSuffix = ".log"
)
-func mkdirs(pth string) error {
- if _, err := os.Stat(pth); err == nil {
- return nil
+var (
+ NoSync bool = false
+ StderrKeep bool = false
+ StderrSilent bool = false
+ StderrPrefix string
+ Jobs sync.WaitGroup
+
+ 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 {
+ Tgt string
+ DoFile string
+ Started *time.Time
+ Finished *time.Time
+ Err error
+}
+
+func (e *RunErr) Name() string {
+ var name string
+ if e.DoFile == "" {
+ name = e.Tgt
+ } else {
+ name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
}
- return os.MkdirAll(pth, os.FileMode(0777))
+ if e.Finished == nil {
+ return name
+ }
+ return fmt.Sprintf("%s (%fsec)", name, e.Finished.Sub(*e.Started).Seconds())
}
-func tempsuffix() string {
- return strconv.FormatInt((time.Now().UnixNano()+int64(os.Getpid()))&0xFFFFFFFF, 16)
+func (e RunErr) Error() string {
+ return fmt.Sprintf("%s: %s", e.Name(), e.Err)
}
-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 mkdirs(pth string) error {
+ if _, err := os.Stat(pth); err == nil {
+ return nil
+ }
+ return os.MkdirAll(pth, os.FileMode(0777))
}
-func isModified(cwd, redoDir, tgt string) (bool, error) {
+func isModified(cwd, redoDir, tgt string) (bool, *Inode, error) {
fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
if err != nil {
if os.IsNotExist(err) {
- return false, nil
+ return false, nil, nil
}
- return false, err
+ return false, nil, err
}
defer fdDep.Close()
r := recfile.NewReader(fdDep)
+ var ourInode *Inode
for {
m, err := r.NextMap()
if err != nil {
if err == io.EOF {
break
}
- return false, err
+ return false, nil, 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, nil
}
- return false, err
+ return false, nil, err
}
- defer fd.Close()
- ourTs, err := fileCtime(fd)
+ ourInode, err = inodeFromFile(fd)
+ fd.Close()
if err != nil {
- return false, err
+ return false, nil, err
}
- if ourTs != m["Ctime"] {
- return true, nil
+ theirInode, err := inodeFromRec(m)
+ if err != nil {
+ return false, nil, err
+ }
+ if !ourInode.Equals(theirInode) {
+ return true, ourInode, nil
}
break
}
- return false, nil
+ return false, ourInode, nil
}
-func runScript(tgt string, errs chan error) error {
- tgtOrig := tgt
- cwd, tgt := cwdAndTgt(tgt)
- redoDir := path.Join(cwd, RedoDir)
- errf := func(err error) error {
- return fmt.Errorf("%s: %s", tgtOrig, err)
+func syncDir(dir string) error {
+ fd, err := os.Open(dir)
+ if err != nil {
+ return err
}
+ err = fd.Sync()
+ fd.Close()
+ return err
+}
+
+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 {
- return errf(err)
+ return TgtErr{tgtOrig, err}
}
// Acquire lock
fdLock, err := os.OpenFile(
- path.Join(redoDir, "lock."+tgt),
+ path.Join(redoDir, tgt+LockSuffix),
os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
os.FileMode(0666),
)
if err != nil {
- return errf(err)
+ return TgtErr{tgtOrig, err}
}
lockRelease := func() {
trace(CLock, "LOCK_UN: %s", fdLock.Name())
fdLock.Close()
}
trace(CLock, "LOCK_NB: %s", fdLock.Name())
+
+ // Waiting for job completion, already taken by someone else
if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
fdLock.Close()
- return errf(err)
+ 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)
- var builtNow bool
+ if FdStatus != nil {
+ FdStatus.Write([]byte{StatusWaited})
+ }
+ var depInfo *DepInfo
fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
if err != nil {
if os.IsNotExist(err) {
- err = fmt.Errorf("%s is not built", tgtOrig)
+ err = errors.New("was not built: no .rec")
}
goto Finish
}
- builtNow, _, err = isBuiltNow(fdDep)
+ defer fdDep.Close()
+ depInfo, err = depRead(fdDep)
if err != nil {
goto Finish
}
- if !builtNow {
- err = fmt.Errorf("%s is not built", tgtOrig)
+ if depInfo.build != BuildUUID {
+ err = errors.New("was not built: build differs")
}
Finish:
if err != nil {
- err = errf(err)
+ err = TgtErr{tgtOrig, err}
}
errs <- err
}()
}
// Check if target is not modified externally
- modified, err := isModified(cwd, redoDir, tgt)
+ modified, inodePrev, err := isModified(cwd, redoDir, tgt)
if err != nil {
lockRelease()
- return errf(err)
+ return TgtErr{tgtOrig, err}
}
if modified {
trace(CWarn, "%s externally modified: not redoing", tgtOrig)
lockRelease()
- Jobs.Add(1)
go func() {
errs <- nil
- Jobs.Done()
}()
return nil
}
- // Start preparing dep.
+ // Start preparing .rec
fdDep, err := tempfile(redoDir, tgt+DepSuffix)
if err != nil {
lockRelease()
- return errf(err)
+ return TgtErr{tgtOrig, err}
}
+ fdDepPath := fdDep.Name()
cleanup := func() {
lockRelease()
fdDep.Close()
recfile.Field{Name: "Build", Value: BuildUUID},
); err != nil {
cleanup()
- return errf(err)
+ return TgtErr{tgtOrig, err}
}
// Find .do
doFile, upLevels, err := findDo(fdDep, cwd, tgt)
if err != nil {
cleanup()
- return errf(err)
+ return TgtErr{tgtOrig, err}
}
if doFile == "" {
cleanup()
- return errf(errors.New("no .do found"))
- }
- if err = writeDep(fdDep, cwd, doFile); err != nil {
- cleanup()
- return errf(err)
+ return TgtErr{tgtOrig, errors.New("no .do found")}
}
// Determine basename and DIRPREFIX
+ doFileRelPath := doFile
ents := strings.Split(cwd, "/")
ents = ents[len(ents)-upLevels:]
dirPrefix := path.Join(ents...)
cwdOrig := cwd
for i := 0; i < upLevels; i++ {
cwd = path.Join(cwd, "..")
+ doFileRelPath = path.Join("..", doFileRelPath)
}
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]
- trace(CRedo, "%s (%s)", tgtOrig, doFile)
- } else {
- trace(CRedo, "%s", tgtOrig)
+ runErr.DoFile = doFileRelPath
}
- doFile = path.Base(doFile)
+
+ if err = writeDep(fdDep, cwdOrig, doFileRelPath); err != nil {
+ cleanup()
+ return TgtErr{tgtOrig, err}
+ }
+ fdDep.Close()
+ trace(CWait, "%s", runErr.Name())
// 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 errf(err)
- }
- buf := make([]byte, 512)
- n, err := fd.Read(buf)
- if err != nil {
- cleanup()
- return errf(err)
- }
- if n > 3 && string(buf[:3]) == "#!/" {
- // Shebanged
- t := string(buf[2:n])
- nlIdx := strings.Index(t, "\n")
- if nlIdx == -1 {
- cleanup()
- return errf(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 errf(err)
+ return TgtErr{tgtOrig, err}
}
- tmpPath := fdStdout.Name() + ".3" // and for $3
- args = append(args, tgt, basename, path.Base(tmpPath))
+ stdoutPath := fdStdout.Name()
+ fdStdout.Close()
+ tmpPath := stdoutPath + ".3" // and for $3
+ 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.Stdout = fdStdout
- cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", RedoLevelEnv, Level+1))
- cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", RedoDirPrefixEnv, dirPrefix))
- cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", RedoBuildUUIDEnv, BuildUUID))
+ // cmd.Stdin reads from /dev/null by default
+ cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
+ cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
+ cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
+
childStderrPrefix := tempsuffix()
- cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", RedoStderrPrefixEnv, childStderrPrefix))
- cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
- cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", RedoDepFdEnv, 3+0))
+ cmd.Env = append(cmd.Env, fmt.Sprintf(
+ "%s=%s", EnvStderrPrefix, childStderrPrefix,
+ ))
+
+ fdNum := 0
+ cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
+ cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
+ fdNum++
+ cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
+ cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 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", RedoJSRFdEnv))
- cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", RedoJSWFdEnv))
+ 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", RedoJSRFdEnv, 3+1))
- cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", RedoJSWFdEnv, 3+2))
+ cmd.Env = append(cmd.Env, fmt.Sprintf(
+ "%s=%d,%d", EnvJSFd, 3+fdNum+0, 3+fdNum+1,
+ ))
+ fdNum += 2
}
// Preparing stderr
- stderr, err := cmd.StderrPipe()
- if err != nil {
- panic(err)
- }
var fdStderr *os.File
if StderrKeep {
fdStderr, err = os.OpenFile(
)
if err != nil {
cleanup()
- return errf(err)
+ return TgtErr{tgtOrig, err}
}
fdStderr.Truncate(0)
}
- trace(CDebug, "sh: %s: %s %s [%s]", tgtOrig, cmdName, args, cwd)
+ shCtx := fmt.Sprintf(
+ "sh: %s: %s %s cwd:%s dirprefix:%s",
+ tgtOrig, cmdName, args, cwd, dirPrefix,
+ )
+ trace(CDebug, "%s", shCtx)
Jobs.Add(1)
go func() {
- jsAcquire()
+ jsAcquire(shCtx)
+ if FdStatus != nil {
+ FdStatus.Write([]byte{StatusRun})
+ }
+
started := time.Now()
+ runErr.Started = &started
+ fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
+ if err != nil {
+ runErr.Err = err
+ errs <- runErr
+ return
+ }
+ cmd.Stdout = fdStdout
+ fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
+ if err != nil {
+ runErr.Err = err
+ errs <- runErr
+ return
+ }
+ cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
+ cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
+ fdNum++
+
defer func() {
- jsRelease()
+ jsRelease(shCtx)
lockRelease()
fdDep.Close()
fdStdout.Close()
os.Remove(fdStdout.Name())
os.Remove(tmpPath)
os.Remove(fdLock.Name())
- finished := time.Now()
- trace(CDone, "%s (%fsec)", tgtOrig, finished.Sub(started).Seconds())
+ if FdStatus != nil {
+ FdStatus.Write([]byte{StatusDone})
+ }
Jobs.Done()
}()
- err := cmd.Start()
+ stderr, err := cmd.StderrPipe()
if err != nil {
- errs <- errf(err)
+ runErr.Err = err
+ errs <- runErr
+ return
+ }
+ started = time.Now()
+ err = cmd.Start()
+ if err != nil {
+ runErr.Err = err
+ errs <- runErr
return
}
pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
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
// Wait for job completion
<-stderrTerm
err = cmd.Wait()
+ finished := time.Now()
+ runErr.Finished = &finished
if err != nil {
- errs <- errf(err)
+ runErr.Err = err
+ errs <- runErr
return
}
+ // Was $1 touched?
+ if inodePrev != nil {
+ if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
+ inode, err := inodeFromFile(fd)
+ fd.Close()
+ if err == nil && !inode.Equals(inodePrev) {
+ runErr.Err = errors.New("$1 was explicitly touched")
+ errs <- runErr
+ return
+ }
+ }
+ }
+
// Does it produce both stdout and tmp?
fiStdout, err := os.Stat(fdStdout.Name())
if err != nil {
- errs <- errf(err)
+ runErr.Err = err
+ errs <- runErr
return
}
tmpExists := false
_, err = os.Stat(tmpPath)
if err == nil {
if fiStdout.Size() > 0 {
- errs <- errf(fmt.Errorf("%s created both tmp and stdout", tgtOrig))
+ runErr.Err = errors.New("created both tmp and stdout")
+ errs <- runErr
return
}
tmpExists = true
} else if !os.IsNotExist(err) {
- errs <- errf(err)
+ runErr.Err = err
+ errs <- runErr
return
}
if tmpExists {
fd, err = os.Open(tmpPath)
if err != nil {
- errs <- errf(err)
- return
+ goto Finish
}
defer fd.Close()
} else if fiStdout.Size() > 0 {
// Do we need to ifcreate it, of ifchange with renaming?
if fd == nil {
- if err = ifcreate(fdDep, tgt); err != nil {
- errs <- errf(err)
- return
+ os.Remove(path.Join(cwdOrig, tgt))
+ err = ifcreate(fdDep, tgt)
+ if err != nil {
+ goto Finish
}
} else {
if !NoSync {
- if err = fd.Sync(); err != nil {
- errs <- errf(err)
- return
+ err = fd.Sync()
+ if err != nil {
+ goto Finish
}
}
- if err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt)); err != nil {
- errs <- errf(err)
- return
+ err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
+ if err != nil {
+ goto Finish
}
if !NoSync {
- fdDir, err := os.Open(cwdOrig)
+ err = syncDir(cwdOrig)
if err != nil {
- errs <- errf(err)
- return
- }
- defer fdDir.Close()
- if err = fdDir.Sync(); err != nil {
- errs <- errf(err)
- return
+ goto Finish
}
}
- if err = writeDep(fdDep, cwdOrig, tgt); err != nil {
- errs <- errf(err)
- return
+ err = writeDep(fdDep, cwdOrig, tgt)
+ if err != nil {
+ goto Finish
}
}
- // Commit dep.
+ // Commit .rec
if !NoSync {
- if err = fdDep.Sync(); err != nil {
- errs <- errf(err)
- return
+ err = fdDep.Sync()
+ if err != nil {
+ goto Finish
}
}
- if err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix)); err != nil {
- errs <- errf(err)
- return
+ err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
+ if err != nil {
+ goto Finish
}
if !NoSync {
- fdDir, err := os.Open(redoDir)
+ err = syncDir(redoDir)
if err != nil {
- errs <- errf(err)
- return
- }
- defer fdDir.Close()
- if err = fdDir.Sync(); err != nil {
- errs <- errf(err)
- return
+ goto Finish
}
}
- errs <- nil
+ Finish:
+ runErr.Err = err
+ errs <- runErr
}()
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
+}