/*
-goredo -- redo implementation on pure Go
+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
"flag"
"fmt"
"io"
+ "log"
"os"
"os/exec"
"path"
"path/filepath"
+ "strconv"
"strings"
"sync"
"syscall"
"time"
"go.cypherpunks.ru/recfile"
- "go.cypherpunks.ru/tai64n"
+ "go.cypherpunks.ru/tai64n/v2"
"golang.org/x/sys/unix"
)
const (
EnvDepFd = "REDO_DEP_FD"
EnvDirPrefix = "REDO_DIRPREFIX"
+ EnvDepCwd = "REDO_DEP_CWD"
EnvBuildUUID = "REDO_BUILD_UUID"
EnvStderrPrefix = "REDO_STDERR_PREFIX"
EnvTrace = "REDO_TRACE"
EnvStderrSilent = "REDO_SILENT"
EnvNoSync = "REDO_NO_SYNC"
- RedoDir = ".redo"
- LockSuffix = ".lock"
- DepSuffix = ".dep"
- TmpPrefix = ".redo."
- LogSuffix = ".log"
+ RedoDir = ".redo"
+ LockSuffix = ".lock"
+ DepSuffix = ".rec"
+ TmpPrefix = ".redo."
+ LogSuffix = ".log"
+ LogRecSuffix = ".log-rec"
)
var (
- NoSync bool = false
- StderrKeep bool = false
- StderrSilent bool = false
+ NoSync = false
+ StderrKeep = false
+ StderrSilent = 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))
+ flagTrace *bool
+ flagTraceAll *bool
+ flagStderrKeep *bool
+ flagStderrSilent *bool
+
+ TracedAll bool
+
+ RunningProcs = map[int]*os.Process{}
+ RunningProcsM sync.Mutex
+
+ Err1WasTouched = errors.New("$1 was explicitly touched")
)
-type RunErr struct {
+func init() {
+ cmdName := CmdName()
+ if !(cmdName == CmdNameRedo || cmdName == CmdNameRedoIfchange) {
+ return
+ }
+ 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("k", false,
+ fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
+ flagStderrSilent = flag.Bool("s", false,
+ fmt.Sprintf("silent, do not print job's stderr (%s=1)", EnvStderrSilent))
+}
+
+type RunError struct {
Tgt string
DoFile string
Started *time.Time
Err error
}
-func (e *RunErr) Name() string {
+func (e *RunError) Name() string {
var name string
if e.DoFile == "" {
name = e.Tgt
if e.Finished == nil {
return name
}
- return fmt.Sprintf("%s (%fsec)", name, e.Finished.Sub(*e.Started).Seconds())
+ return fmt.Sprintf("%s (%.3fs)", name, e.Finished.Sub(*e.Started).Seconds())
}
-func (e RunErr) Error() string {
+func (e RunError) Error() string {
return fmt.Sprintf("%s: %s", e.Name(), e.Err)
}
return os.MkdirAll(pth, os.FileMode(0777))
}
-func isModified(cwd, redoDir, tgt string) (bool, string, 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 ourTs string
+ var ourInode *Inode
for {
m, err := r.NextMap()
if err != nil {
- if err == io.EOF {
+ if errors.Is(err, io.EOF) {
break
}
- return false, "", err
+ return false, nil, err
}
- if m["Target"] != tgt {
+ if m["Type"] != DepTypeIfchange || 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
+ }
+ ourInode, err = inodeFromFile(fd)
+ fd.Close()
+ if err != nil {
+ return false, nil, err
}
- defer fd.Close()
- ourTs, err = fileCtime(fd)
+ theirInode, err := inodeFromRec(m)
if err != nil {
- return false, "", err
+ return false, nil, err
}
- if ourTs != m["Ctime"] {
- return true, ourTs, nil
+ if !ourInode.Equals(theirInode) {
+ return true, ourInode, nil
}
break
}
- return false, ourTs, nil
+ return false, ourInode, nil
}
func syncDir(dir string) error {
cwd, tgt := cwdAndTgt(tgtOrig)
redoDir := path.Join(cwd, RedoDir)
if err := mkdirs(redoDir); err != nil {
- return TgtErr{tgtOrig, err}
+ return TgtError{tgtOrig, err}
}
// Acquire lock
os.FileMode(0666),
)
if err != nil {
- return TgtErr{tgtOrig, err}
+ return TgtError{tgtOrig, err}
}
lockRelease := func() {
- trace(CLock, "LOCK_UN: %s", fdLock.Name())
- unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
+ tracef(CLock, "LOCK_UN: %s", fdLock.Name())
+ if err := unix.Flock(int(fdLock.Fd()), unix.LOCK_UN); err != nil {
+ log.Fatalln(err)
+ }
fdLock.Close()
}
- trace(CLock, "LOCK_NB: %s", fdLock.Name())
+ tracef(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 TgtErr{tgtOrig, err}
+ return TgtError{tgtOrig, err}
}
Jobs.Add(1)
- trace(CDebug, "waiting: %s", tgtOrig)
+ tracef(CDebug, "waiting: %s", tgtOrig)
if FdStatus != nil {
- FdStatus.Write([]byte{StatusWait})
+ if _, err = FdStatus.Write([]byte{StatusWait}); err != nil {
+ log.Fatalln(err)
+ }
}
go func() {
defer Jobs.Done()
- trace(CLock, "LOCK_EX: %s", fdLock.Name())
- unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
+ tracef(CLock, "LOCK_EX: %s", fdLock.Name())
+ if err := unix.Flock(int(fdLock.Fd()), unix.LOCK_EX); err != nil {
+ log.Fatalln(err)
+ }
lockRelease()
- trace(CDebug, "waiting done: %s", tgtOrig)
+ tracef(CDebug, "waiting done: %s", tgtOrig)
if FdStatus != nil {
- FdStatus.Write([]byte{StatusWaited})
+ if _, err = FdStatus.Write([]byte{StatusWaited}); err != nil {
+ log.Fatalln(err)
+ }
}
var depInfo *DepInfo
fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
if err != nil {
if os.IsNotExist(err) {
- err = errors.New("was not built: no .dep")
+ err = errors.New("was not built: no .rec")
}
goto Finish
}
}
Finish:
if err != nil {
- err = TgtErr{tgtOrig, err}
+ err = TgtError{tgtOrig, err}
}
errs <- err
}()
}
// Check if target is not modified externally
- modified, tsPrev, err := isModified(cwd, redoDir, tgt)
+ modified, inodePrev, err := isModified(cwd, redoDir, tgt)
if err != nil {
lockRelease()
- return TgtErr{tgtOrig, err}
+ return TgtError{tgtOrig, err}
}
if modified {
- trace(CWarn, "%s externally modified: not redoing", tgtOrig)
+ tracef(CWarn, "%s externally modified: not redoing", tgtOrig)
lockRelease()
go func() {
errs <- nil
return nil
}
- // Start preparing .dep
+ // Start preparing .rec
fdDep, err := tempfile(redoDir, tgt+DepSuffix)
if err != nil {
lockRelease()
- return TgtErr{tgtOrig, err}
+ return TgtError{tgtOrig, err}
}
+ fdDepPath := fdDep.Name()
cleanup := func() {
lockRelease()
fdDep.Close()
recfile.Field{Name: "Build", Value: BuildUUID},
); err != nil {
cleanup()
- return TgtErr{tgtOrig, err}
+ return TgtError{tgtOrig, err}
}
// Find .do
doFile, upLevels, err := findDo(fdDep, cwd, tgt)
if err != nil {
cleanup()
- return TgtErr{tgtOrig, err}
+ return TgtError{tgtOrig, err}
}
if doFile == "" {
cleanup()
- return TgtErr{tgtOrig, errors.New("no .do found")}
+ return TgtError{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}
+ runErr := RunError{Tgt: tgtOrig}
if strings.HasPrefix(doFile, "default.") {
basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
- runErr.DoFile = doFile
+ runErr.DoFile = doFileRelPath
}
- if err = writeDep(fdDep, cwd, doFile); err != nil {
+ if err = depWrite(fdDep, cwdOrig, doFileRelPath); err != nil {
cleanup()
- return TgtErr{tgtOrig, err}
+ return TgtError{tgtOrig, err}
}
- trace(CWait, "%s", runErr.Name())
+ fdDep.Close()
+ tracef(CWait, "%s", runErr.Name())
// Prepare command line
var cmdName string
args = make([]string, 0, 3)
} else {
cmdName = "/bin/sh"
- if traced {
+ if traced || TracedAll {
args = append(args, "-ex")
} else {
args = append(args, "-e")
fdStdout, err := tempfile(cwdOrig, tgt)
if err != nil {
cleanup()
- return TgtErr{tgtOrig, err}
+ return TgtError{tgtOrig, err}
}
- tmpPath := fdStdout.Name() + ".3" // and for $3
+ stdoutPath := fdStdout.Name()
+ fdStdout.Close()
+ tmpPath := stdoutPath + ".3" // and for $3
tmpPathRel, err := filepath.Rel(cwd, tmpPath)
if err != nil {
panic(err)
cmd := exec.Command(cmdName, args...)
cmd.Dir = cwd
- cmd.Stdout = fdStdout
+ // 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))
))
fdNum := 0
- cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
- cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
+ 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 {
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,
- ))
- fdNum += 2
- }
-
// Preparing stderr
- stderr, err := cmd.StderrPipe()
- if err != nil {
- panic(err)
- }
var fdStderr *os.File
if StderrKeep {
fdStderr, err = os.OpenFile(
path.Join(redoDir, tgt+LogSuffix),
- os.O_WRONLY|os.O_CREATE,
+ os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
os.FileMode(0666),
)
if err != nil {
cleanup()
- return TgtErr{tgtOrig, err}
+ return TgtError{tgtOrig, err}
}
- fdStderr.Truncate(0)
}
- shCtx := fmt.Sprintf("sh: %s: %s %s [%s]", tgtOrig, cmdName, args, cwd)
- trace(CDebug, "%s", shCtx)
+ shCtx := fmt.Sprintf(
+ "sh: %s: %s %s cwd:%s dirprefix:%s",
+ tgtOrig, cmdName, args, cwd, dirPrefix,
+ )
+ tracef(CDebug, "%s", shCtx)
Jobs.Add(1)
go func() {
- jsAcquire(shCtx)
+ jsToken := jsAcquire(shCtx)
+ if JSR == nil {
+ // infinite jobs
+ cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
+ } else {
+ cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
+ cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
+ makeFlags := fmt.Sprintf(
+ "%s %s%d,%d", MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
+ )
+ makeFlags = strings.Trim(makeFlags, " ")
+ cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", MakeFlagsName, makeFlags))
+ fdNum += 2
+ cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
+ }
+
if FdStatus != nil {
- FdStatus.Write([]byte{StatusRun})
+ if _, err = FdStatus.Write([]byte{StatusRun}); err != nil {
+ log.Fatalln(err)
+ }
+ }
+
+ var finished time.Time
+ var exitErr *exec.ExitError
+ 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++
+ cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
+
defer func() {
- jsRelease(shCtx)
- lockRelease()
+ jsRelease(shCtx, jsToken)
fdDep.Close()
fdStdout.Close()
if fdStderr != nil {
fdStderr.Close()
+ logRecPath := path.Join(redoDir, tgt+LogRecSuffix)
+ if fdStderr, err = os.OpenFile(
+ logRecPath,
+ os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
+ os.FileMode(0666),
+ ); err == nil {
+ fields := []recfile.Field{
+ {Name: "Build", Value: BuildUUID},
+ {Name: "PPID", Value: strconv.Itoa(os.Getpid())},
+ {Name: "Cwd", Value: cwd},
+ }
+ if cmd.Process != nil {
+ fields = append(fields, recfile.Field{
+ Name: "PID", Value: strconv.Itoa(cmd.Process.Pid),
+ })
+ }
+ ts := new(tai64n.TAI64N)
+ ts.FromTime(started)
+ fields = append(fields,
+ recfile.Field{Name: "Started", Value: tai64n.Encode(ts[:])},
+ )
+ ts.FromTime(finished)
+ fields = append(fields,
+ recfile.Field{Name: "Finished", Value: tai64n.Encode(ts[:])})
+ fields = append(fields, recfile.Field{
+ Name: "Duration",
+ Value: strconv.FormatInt(finished.Sub(started).Nanoseconds(), 10),
+ })
+ fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
+ for _, arg := range args {
+ fields = append(fields, recfile.Field{Name: "Arg", Value: arg})
+ }
+ for _, env := range cmd.Env {
+ fields = append(fields, recfile.Field{Name: "Env", Value: env})
+ }
+ if exitErr != nil {
+ fields = append(fields, recfile.Field{
+ Name: "ExitCode",
+ Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
+ })
+ }
+ w := bufio.NewWriter(fdStderr)
+
+ var depInfo *DepInfo
+ fdDep, err := os.Open(fdDepPath)
+ if err != nil {
+ goto Err
+ }
+ depInfo, err = depRead(fdDep)
+ fdDep.Close()
+ if err != nil {
+ goto Err
+ }
+ for _, dep := range depInfo.ifchanges {
+ fields = append(fields, recfile.Field{
+ Name: "Ifchange",
+ Value: dep["Target"],
+ })
+ }
+ _, err = recfile.NewWriter(w).WriteFields(fields...)
+ if err != nil {
+ goto Err
+ }
+ err = w.Flush()
+ Err:
+ if err != nil {
+ log.Println(err)
+ os.Remove(logRecPath)
+ }
+ fdStderr.Close()
+ } else {
+ log.Println("can not open", logRecPath, ":", err)
+ }
}
+ lockRelease()
os.Remove(fdDep.Name())
os.Remove(fdStdout.Name())
os.Remove(tmpPath)
os.Remove(fdLock.Name())
if FdStatus != nil {
- FdStatus.Write([]byte{StatusDone})
+ if _, err = FdStatus.Write([]byte{StatusDone}); err != nil {
+ log.Fatalln(err)
+ }
}
Jobs.Done()
}()
- started := time.Now()
- runErr.Started = &started
- err := cmd.Start()
+ stderr, err := cmd.StderrPipe()
+ if err != nil {
+ runErr.Err = err
+ errs <- runErr
+ return
+ }
+ started = time.Now()
+ err = cmd.Start()
if err != nil {
runErr.Err = err
errs <- runErr
return
}
+ RunningProcsM.Lock()
+ RunningProcs[cmd.Process.Pid] = cmd.Process
+ RunningProcsM.Unlock()
pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
- trace(CDebug, "%s runs %s", tgtOrig, pid)
+ tracef(CDebug, "%s runs %s", tgtOrig, pid)
- stderrTerm := make(chan struct{}, 0)
+ stderrTerm := make(chan struct{})
go func() {
scanner := bufio.NewScanner(stderr)
var line string
continue
}
if fdStderr != nil {
- tai64n.FromTime(time.Now(), ts)
+ ts.FromTime(time.Now())
LogMutex.Lock()
- fmt.Fprintf(fdStderr, "%s %s\n", ts.Encode(), line)
+ fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
LogMutex.Unlock()
}
if StderrSilent {
continue
}
if MyPid == 0 {
- trace(CNone, "%s", line)
+ tracef(CNone, "%s", line)
} else {
- trace(CNone, "%s %s", pid, line)
+ tracef(CNone, "%s %s", pid, line)
}
}
close(stderrTerm)
// Wait for job completion
<-stderrTerm
err = cmd.Wait()
- finished := time.Now()
+ RunningProcsM.Lock()
+ delete(RunningProcs, cmd.Process.Pid)
+ RunningProcsM.Unlock()
+ finished = time.Now()
runErr.Finished = &finished
if err != nil {
+ exitErr = err.(*exec.ExitError)
runErr.Err = err
errs <- runErr
return
}
// Was $1 touched?
- if tsPrev != "" {
+ if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
+ errTouched := Err1WasTouched
+ if inodePrev == nil {
+ fd.Close()
+ runErr.Err = errTouched
+ errs <- runErr
+ return
+ }
+ inode, err := inodeFromFile(fd)
+ fd.Close()
+ if err != nil {
+ runErr.Err = err
+ errs <- runErr
+ return
+ }
+ if !inode.Equals(inodePrev) {
+ runErr.Err = errTouched
+ errs <- runErr
+ return
+ }
+ }
+
+ if inodePrev != nil {
if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
- ts, err := fileCtime(fd)
+ inode, err := inodeFromFile(fd)
fd.Close()
- if err == nil && ts != tsPrev {
- runErr.Err = errors.New("$1 was explicitly touched")
+ if err == nil && !inode.Equals(inodePrev) {
+ runErr.Err = Err1WasTouched
errs <- runErr
- fd.Close()
return
}
}
goto Finish
}
}
- err = writeDep(fdDep, cwdOrig, tgt)
+ err = depWrite(fdDep, cwdOrig, tgt)
if err != nil {
goto Finish
}
}
- // Commit .dep
+ // Commit .rec
if !NoSync {
err = fdDep.Sync()
if err != nil {
goto Finish
}
}
- err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
+ fdDepPath = path.Join(redoDir, tgt+DepSuffix)
+ err = os.Rename(fdDep.Name(), fdDepPath)
if err != nil {
goto Finish
}
if err == nil {
return true
}
- if err, ok := err.(RunErr); ok && err.Err == nil {
- trace(CRedo, "%s", err.Name())
+ var runErr RunError
+ if errors.As(err, &runErr) && runErr.Err == nil {
+ tracef(CRedo, "%s", runErr.Name())
return true
}
- trace(CErr, "%s", err)
+ tracef(CErr, "%s", err)
return false
}