/*
goredo -- djb's redo implementation on pure Go
-Copyright (C) 2020-2021 Sergey Matveev <stargrave@stargrave.org>
+Copyright (C) 2020-2023 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"
+ "crypto/rand"
+ "encoding/hex"
"errors"
"flag"
"fmt"
EnvStderrKeep = "REDO_LOGS"
EnvStderrSilent = "REDO_SILENT"
EnvNoSync = "REDO_NO_SYNC"
+ EnvStopIfMod = "REDO_STOP_IF_MODIFIED"
RedoDir = ".redo"
LockSuffix = ".lock"
)
var (
- NoSync bool = false
- StderrKeep bool = false
- StderrSilent bool = false
+ NoSync = false
+ StderrKeep = false
+ StderrSilent = false
StderrPrefix string
+ StopIfMod = false
Jobs sync.WaitGroup
- flagTrace *bool
- flagTraceAll *bool
- flagStderrKeep *bool
- flagStderrSilent *bool
+ flagTrace *bool
+ flagTraceAll *bool
+ flagStderrKeep *bool
+ flagStderrSilent *bool
+ flagForcedIfchange *bool
TracedAll bool
+
+ RunningProcs = map[int]*os.Process{}
+ RunningProcsM sync.Mutex
+
+ Err1WasTouched = errors.New("$1 was explicitly touched")
)
func init() {
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))
+ flagForcedIfchange = flag.Bool("f", false, "forced redo-ifchange")
}
-type RunErr struct {
+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
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)
}
func mkdirs(pth string) error {
- if _, err := os.Stat(pth); err == nil {
+ if FileExists(pth) {
return nil
}
return os.MkdirAll(pth, os.FileMode(0777))
}
-func isModified(cwd, redoDir, tgt string) (bool, *Inode, error) {
+func isModified(cwd, redoDir, tgt string) (bool, *Inode, string, error) {
fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
if err != nil {
if os.IsNotExist(err) {
- return false, nil, nil
+ return false, nil, "", nil
}
- return false, nil, err
+ return false, nil, "", err
}
defer fdDep.Close()
r := recfile.NewReader(fdDep)
+ var modified bool
var ourInode *Inode
+ var hshPrev string
for {
m, err := r.NextMap()
if err != nil {
- if err == io.EOF {
+ if errors.Is(err, io.EOF) {
break
}
- return false, nil, 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))
+ ourInode, err = inodeFromFileByPath(path.Join(cwd, tgt))
if err != nil {
if os.IsNotExist(err) {
- return false, nil, nil
+ return false, nil, "", nil
}
- return false, nil, err
- }
- ourInode, err = inodeFromFile(fd)
- fd.Close()
- if err != nil {
- return false, nil, err
+ return false, nil, "", err
}
theirInode, err := inodeFromRec(m)
if err != nil {
- return false, nil, err
- }
- if !ourInode.Equals(theirInode) {
- return true, ourInode, nil
+ return false, nil, "", err
}
+ hshPrev = m["Hash"]
+ modified = !ourInode.Equals(theirInode)
break
}
- return false, ourInode, nil
+ return modified, ourInode, hshPrev, 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}
}
+ shCtx := fmt.Sprintf("sh: %s: cwd:%s", tgtOrig, cwd)
+ jsToken := jsAcquire(shCtx)
+ jsNeedsRelease := true
+ defer func() {
+ if jsNeedsRelease {
+ jsRelease(shCtx, jsToken)
+ }
+ }()
+
// Acquire lock
fdLock, err := os.OpenFile(
path.Join(redoDir, tgt+LockSuffix),
os.FileMode(0666),
)
if err != nil {
- return TgtErr{tgtOrig, err}
+ return TgtError{tgtOrig, err}
+ }
+ flock := unix.Flock_t{
+ Type: unix.F_WRLCK,
+ Whence: io.SeekStart,
}
lockRelease := func() {
- trace(CLock, "LOCK_UN: %s", fdLock.Name())
- unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
+ tracef(CLock, "LOCK_UN: %s", fdLock.Name())
+ flock.Type = unix.F_UNLCK
+ if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
+ log.Fatalln(err, fdLock.Name())
+ }
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) {
+ if err = unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
+ if uintptr(err.(syscall.Errno)) != uintptr(unix.EAGAIN) {
fdLock.Close()
- return TgtErr{tgtOrig, err}
+ return TgtError{tgtOrig, err}
}
Jobs.Add(1)
- trace(CDebug, "waiting: %s", tgtOrig)
+ if err = unix.FcntlFlock(fdLock.Fd(), unix.F_GETLK, &flock); err != nil {
+ log.Fatalln(err, fdLock.Name())
+ }
+ tracef(CDebug, "waiting: %s (pid=%d)", tgtOrig, flock.Pid)
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())
+ LockAgain:
+ if err := unix.FcntlFlock(fdLock.Fd(), unix.F_SETLKW, &flock); err != nil {
+ log.Println(err, fdLock.Name())
+ time.Sleep(10 * time.Millisecond)
+ goto LockAgain
+ }
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))
}
Finish:
if err != nil {
- err = TgtErr{tgtOrig, err}
+ err = TgtError{tgtOrig, err}
+ fdLock.Close()
}
errs <- err
}()
}
// Check if target is not modified externally
- modified, inodePrev, err := isModified(cwd, redoDir, tgt)
+ modified, inodePrev, hshPrev, 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)
lockRelease()
+ if StopIfMod {
+ return fmt.Errorf("%s externally modified", tgtOrig)
+ }
+ tracef(CWarn, "%s externally modified: not redoing", tgtOrig)
go func() {
errs <- nil
}()
fdDep, err := tempfile(redoDir, tgt+DepSuffix)
if err != nil {
lockRelease()
- return TgtErr{tgtOrig, err}
+ return TgtError{tgtOrig, err}
}
fdDepPath := fdDep.Name()
cleanup := func() {
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
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 = doFileRelPath
}
- if err = writeDep(fdDep, cwdOrig, doFileRelPath); err != nil {
+ if err = depWrite(fdDep, cwdOrig, doFileRelPath, ""); err != nil {
cleanup()
- return TgtErr{tgtOrig, err}
+ return TgtError{tgtOrig, err}
}
fdDep.Close()
- trace(CWait, "%s", runErr.Name())
+ tracef(CWait, "%s", runErr.Name())
// Prepare command line
var cmdName string
fdStdout, err := tempfile(cwdOrig, tgt)
if err != nil {
cleanup()
- return TgtErr{tgtOrig, err}
+ return TgtError{tgtOrig, err}
}
stdoutPath := fdStdout.Name()
fdStdout.Close()
path.Join(dirPrefix, basename),
tmpPathRel,
)
+ shCtx = fmt.Sprintf(
+ "sh: %s: %s %s cwd:%s dirprefix:%s",
+ tgtOrig, cmdName, args, cwd, dirPrefix,
+ )
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))
- childStderrPrefix := tempsuffix()
+ childStderrPrefixRaw := make([]byte, 8)
+ if _, err = io.ReadFull(rand.Reader, childStderrPrefixRaw); err != nil {
+ panic(err)
+ }
+ childStderrPrefix := hex.EncodeToString(childStderrPrefixRaw)
cmd.Env = append(cmd.Env, fmt.Sprintf(
"%s=%s", EnvStderrPrefix, childStderrPrefix,
))
)
if err != nil {
cleanup()
- return TgtErr{tgtOrig, err}
+ return TgtError{tgtOrig, err}
}
}
- shCtx := fmt.Sprintf(
- "sh: %s: %s %s cwd:%s dirprefix:%s",
- tgtOrig, cmdName, args, cwd, dirPrefix,
- )
- trace(CDebug, "%s", shCtx)
+ tracef(CDebug, "%s", shCtx)
+ jsNeedsRelease = false
Jobs.Add(1)
go func() {
- 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)
- cmd.Env = append(cmd.Env, fmt.Sprintf(
- "%s=%s %s%d,%d",
- MakeFlagsName, MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
- ))
+ 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)
+ }
}
+ defer jsRelease(shCtx, jsToken)
+
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 {
+ if fdStderr != nil {
+ fdStderr.Close()
+ }
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 {
+ if fdStderr != nil {
+ fdStderr.Close()
+ }
+ fdStdout.Close()
runErr.Err = err
errs <- runErr
return
cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
defer func() {
- jsRelease(shCtx, jsToken)
fdDep.Close()
fdStdout.Close()
if fdStderr != nil {
); err == nil {
fields := []recfile.Field{
{Name: "Build", Value: BuildUUID},
- {Name: "PID", Value: strconv.Itoa(cmd.Process.Pid)},
{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,
})
fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
for _, arg := range args {
- fields = append(fields, recfile.Field{Name: "Cmd", Value: arg})
+ fields = append(fields, recfile.Field{Name: "Arg", Value: arg})
}
for _, env := range cmd.Env {
fields = append(fields, recfile.Field{Name: "Env", Value: env})
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()
}()
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 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()
+ RunningProcsM.Lock()
+ delete(RunningProcs, cmd.Process.Pid)
+ RunningProcsM.Unlock()
finished = time.Now()
runErr.Finished = &finished
if err != nil {
}
// Was $1 touched?
- if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
- errTouched := errors.New("$1 was explicitly touched")
+ if inode, err := inodeFromFileByPath(path.Join(cwdOrig, tgt)); err == nil {
if inodePrev == nil {
- fd.Close()
- runErr.Err = errTouched
+ runErr.Err = Err1WasTouched
+ errs <- runErr
+ return
+ }
+ if err != nil {
+ runErr.Err = err
+ errs <- runErr
+ return
+ }
+ if !inode.Equals(inodePrev) {
+ runErr.Err = Err1WasTouched
errs <- runErr
return
- } else {
- 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 {
- inode, err := inodeFromFile(fd)
- fd.Close()
- if err == nil && !inode.Equals(inodePrev) {
- runErr.Err = errors.New("$1 was explicitly touched")
+ if inode, err := inodeFromFileByPath(path.Join(cwdOrig, tgt)); err == nil {
+ if !inode.Equals(inodePrev) {
+ runErr.Err = Err1WasTouched
errs <- runErr
return
}
fd = fdStdout
}
- // Do we need to ifcreate it, of ifchange with renaming?
+ // Do we need to ifcreate it, or ifchange with renaming?
if fd == nil {
os.Remove(path.Join(cwdOrig, tgt))
err = ifcreate(fdDep, tgt)
goto Finish
}
} else {
+ var hsh string
+ if hshPrev != "" {
+ _, err = fd.Seek(0, io.SeekStart)
+ if err != nil {
+ goto Finish
+ }
+ hsh, err = fileHash(fd)
+ if err != nil {
+ goto Finish
+ }
+ if hsh == hshPrev {
+ tracef(CDebug, "%s has same hash, not renaming", tgtOrig)
+ err = os.Remove(fd.Name())
+ if err != nil {
+ goto Finish
+ }
+ err = os.Chtimes(path.Join(cwdOrig, tgt), finished, finished)
+ if err != nil {
+ goto Finish
+ }
+ if !NoSync {
+ err = syncDir(cwdOrig)
+ if err != nil {
+ goto Finish
+ }
+ }
+ err = depWrite(fdDep, cwdOrig, tgt, hshPrev)
+ if err != nil {
+ goto Finish
+ }
+ goto RecCommit
+ }
+ }
if !NoSync {
err = fd.Sync()
if err != nil {
goto Finish
}
}
- err = writeDep(fdDep, cwdOrig, tgt)
+ err = depWrite(fdDep, cwdOrig, tgt, hsh)
if err != nil {
goto Finish
}
}
+ RecCommit:
// Commit .rec
if !NoSync {
err = fdDep.Sync()
goto Finish
}
}
+
+ // Post-commit .rec sanitizing
+ fdDep.Close()
+ if fdDepR, err := os.Open(fdDepPath); err == nil {
+ depInfo, err := depRead(fdDepR)
+ fdDepR.Close()
+ if err != nil {
+ goto Finish
+ }
+ ifchangeSeen := make(map[string]struct{}, len(depInfo.ifchanges))
+ for _, dep := range depInfo.ifchanges {
+ ifchangeSeen[dep["Target"]] = struct{}{}
+ }
+ for _, dep := range depInfo.ifcreates {
+ if _, exists := ifchangeSeen[dep]; exists {
+ tracef(CWarn, "simultaneous ifcreate and ifchange records: %s", tgt)
+ }
+ }
+ }
+
Finish:
runErr.Err = err
errs <- runErr
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
}