/*
-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-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
package main
import (
+ "bytes"
"errors"
"fmt"
"io"
+ "io/fs"
+ "log"
"os"
"path"
- "path/filepath"
"strings"
- "go.cypherpunks.ru/recfile"
+ "golang.org/x/sys/unix"
)
-type TgtErr struct {
+const (
+ DepTypeIfcreate = "ifcreate"
+ DepTypeIfchange = "ifchange"
+ DepTypeAlways = "always"
+ DepTypeStamp = "stamp"
+
+ EnvOODTgtsFd = "REDO_OOD_TGTS_FD"
+ EnvOODTgtsLockFd = "REDO_OOD_TGTS_LOCK_FD"
+)
+
+var (
+ OODTgts map[string]struct{}
+ FdOODTgts *os.File
+ FdOODTgtsLock *os.File
+
+ OODCache = make(map[string]bool)
+ FileExistsCache = make(map[string]bool)
+
+ ErrMissingTarget = errors.New("invalid format of .rec: missing Target")
+)
+
+func FileExists(p string) bool {
+ if exists, known := FileExistsCache[p]; known {
+ return exists
+ }
+ _, err := os.Stat(p)
+ if err == nil {
+ FileExistsCache[p] = true
+ return true
+ }
+ if errors.Is(err, fs.ErrNotExist) {
+ FileExistsCache[p] = false
+ }
+ return false
+}
+
+type TgtError struct {
Tgt string
Err error
}
-func (e TgtErr) Unwrap() error { return e.Err }
+func (e TgtError) Unwrap() error { return e.Err }
-func (e TgtErr) Error() string {
+func (e TgtError) Error() string {
return fmt.Sprintf("%s: %s", e.Tgt, e.Err)
}
-func cwdAndTgt(tgt string) (string, string) {
- cwd, tgt := path.Split(tgt)
- cwd, err := filepath.Abs(cwd)
- if err != nil {
- panic(err)
- }
- return cwd, tgt
-}
-
func isSrc(cwd, tgt string) bool {
d, f := path.Split(path.Join(cwd, tgt))
- if _, err := os.Stat(path.Join(d, f)); err != nil {
+ if !FileExists(path.Join(d, f)) {
return false
}
- if _, err := os.Stat(path.Join(d, RedoDir, f+DepSuffix)); err == nil {
+ if FileExists(path.Join(d, f+".do")) {
+ return false
+ }
+ if FileExists(path.Join(d, RedoDir, f+DepSuffix)) {
return false
}
return true
}
-func isBuiltNow(fdDep *os.File) (bool, *recfile.Reader, error) {
- r := recfile.NewReader(fdDep)
- m, err := r.NextMap()
- if err != nil {
- return false, nil, err
- }
- if m["Build"] == "" {
- return false, r, errors.New(".dep missing Build:")
- }
- return m["Build"] == BuildUUID, r, nil
+func isOODByBuildUUID(cwd, tgtOrig string) bool {
+ cwd, tgt := cwdAndTgt(path.Join(cwd, tgtOrig))
+ depPath := path.Join(cwd, RedoDir, tgt+DepSuffix)
+ build, err := depReadBuild(depPath)
+ return err != nil || build != BuildUUID
}
-func rebuildStamped(cwd, tgt, depPath string) (string, error) {
- relTgt, err := filepath.Rel(Cwd, path.Join(cwd, tgt))
- if err != nil {
- panic(err)
- }
- errs := make(chan error, 1)
- if err = runScript(relTgt, errs); err != nil {
- return "", err
- }
- if err = <-errs; !isOkRun(err) {
- return "", errors.New("build failed")
- }
- fdDep, err := os.Open(depPath)
- if err != nil {
- return "", err
+func isOOD(cwd, tgtOrig string, level int, seen map[string]struct{}) (bool, error) {
+ indent := strings.Repeat(". ", level)
+ tracef(CDebug, "ood: %s%s checking", indent, tgtOrig)
+ cwd, tgt := cwdAndTgt(path.Join(cwd, tgtOrig))
+ ood, cached := OODCache[path.Join(cwd, tgt)]
+ if cached {
+ tracef(CDebug, "ood: %s%s -> cached: %v", indent, tgtOrig, ood)
+ return ood, nil
}
- defer fdDep.Close()
- builtNow, r, err := isBuiltNow(fdDep)
+ depPath := path.Join(cwd, RedoDir, tgt+DepSuffix)
+ depInfo, err := depRead(depPath)
if err != nil {
- return "", err
- }
- if !builtNow {
- return "", errors.New("is not built")
- }
- var stampTheir string
- for {
- m, err := r.NextMap()
- if err != nil {
- if err == io.EOF {
- break
+ if errors.Is(err, fs.ErrNotExist) {
+ if isSrc(cwd, tgt) {
+ ood = false
+ tracef(CDebug, "ood: %s%s -> is source", indent, tgtOrig)
+ } else {
+ ood = true
+ tracef(CDebug, "ood: %s%s -> no dep: %s", indent, tgtOrig, depPath)
}
- return "", err
+ OODCache[path.Join(cwd, tgt)] = ood
+ return ood, nil
}
- if m["Type"] == "stamp" {
- stampTheir = m["Hash"]
- break
+ if err != nil {
+ return true, TgtError{tgtOrig, ErrLine(err)}
}
}
- return stampTheir, nil
-}
-
-func isOOD(cwd, tgt string, level int) (bool, error) {
- tgtOrig := tgt
- indent := strings.Repeat(". ", level)
- trace(CDebug, "ood: %s%s checking", indent, tgtOrig)
- cwd, tgt = cwdAndTgt(path.Join(cwd, tgt))
- depPath := path.Join(cwd, RedoDir, tgt+DepSuffix)
- fdDep, err := os.Open(depPath)
- if err != nil {
- trace(CDebug, "ood: %s%s -> no dep: %s", indent, tgtOrig, depPath)
- return true, nil
- }
- defer fdDep.Close()
- ood := false
- builtNow, r, err := isBuiltNow(fdDep)
- if err != nil {
- return true, TgtErr{tgtOrig, err}
- }
- if builtNow {
- trace(CDebug, "ood: %s%s -> already built", indent, tgtOrig)
+ if depInfo.build == BuildUUID {
+ tracef(CDebug, "ood: %s%s -> already built", indent, tgtOrig)
+ OODCache[path.Join(cwd, tgt)] = false
return false, nil
}
-
- var stampOur string
- ifcreates := []map[string]string{}
- ifchanges := []map[string]string{}
- for {
- m, err := r.NextMap()
- if err != nil {
- if err == io.EOF {
- break
- }
- return true, TgtErr{tgtOrig, err}
- }
- switch m["Type"] {
- case "always":
- trace(CDebug, "ood: %s%s -> always", indent, tgtOrig)
- ood = true
- case "ifcreate":
- ifcreates = append(ifcreates, m)
- case "ifchange":
- ifchanges = append(ifchanges, m)
- case "stamp":
- stampOur = m["Hash"]
- trace(CDebug, "ood: %s%s -> stamped: %s", indent, tgtOrig, stampOur)
- default:
- return ood, TgtErr{tgtOrig, errors.New("invalid format of .dep")}
- }
- }
- if ood {
- goto StampCheck
+ if !FileExists(path.Join(cwd, tgt)) {
+ tracef(CDebug, "ood: %s%s -> non-existent", indent, tgtOrig)
+ OODCache[path.Join(cwd, tgt)] = true
+ return true, nil
}
- for _, m := range ifcreates {
- theirTgt := m["Target"]
- if theirTgt == "" {
- return ood, TgtErr{tgtOrig, errors.New("invalid format of .dep")}
- }
- if _, err = os.Stat(path.Join(cwd, theirTgt)); err == nil {
- trace(CDebug, "ood: %s%s -> created", indent, tgtOrig)
+ for _, dep := range depInfo.ifcreates {
+ if FileExists(path.Join(cwd, dep)) {
+ tracef(CDebug, "ood: %s%s -> %s created", indent, tgtOrig, dep)
ood = true
- goto StampCheck
+ goto Done
}
}
- for _, m := range ifchanges {
- dep := m["Target"]
- theirTs := m["Ctime"]
- theirHsh := m["Hash"]
- if dep == "" || theirTs == "" {
- return ood, TgtErr{tgtOrig, errors.New("invalid format of .dep")}
+ for _, dep := range depInfo.ifchanges {
+ tracef(CDebug, "ood: %s%s -> %s: checking", indent, tgtOrig, dep.tgt)
+ ood, cached = OODCache[path.Join(cwd, dep.tgt)]
+ if cached {
+ tracef(CDebug, "ood: %s%s -> %s: cached: %v", indent, tgtOrig, dep.tgt, ood)
+ if ood {
+ goto Done
+ }
+ continue
}
- trace(CDebug, "ood: %s%s -> %s: checking", indent, tgtOrig, dep)
- fd, err := os.Open(path.Join(cwd, dep))
+
+ inode, err := inodeFromFileByPath(path.Join(cwd, dep.tgt))
if err != nil {
- if os.IsNotExist(err) {
- trace(CDebug, "ood: %s%s -> %s: not exists", indent, tgtOrig, dep)
+ if errors.Is(err, fs.ErrNotExist) {
+ tracef(CDebug, "ood: %s%s -> %s: not exists", indent, tgtOrig, dep.tgt)
ood = true
- goto StampCheck
+ OODCache[path.Join(cwd, dep.tgt)] = ood
+ goto Done
}
- return ood, TgtErr{tgtOrig, err}
- }
- defer fd.Close()
- ts, err := fileCtime(fd)
- if err != nil {
- return ood, TgtErr{tgtOrig, err}
+ return ood, TgtError{tgtOrig, ErrLine(err)}
}
- if theirTs == ts {
- trace(CDebug, "ood: %s%s -> %s: same ctime", indent, tgtOrig, dep)
- } else if NoHash || theirHsh == "" {
- trace(CDebug, "ood: %s%s -> %s: ctime differs", indent, tgtOrig, dep)
+
+ if inode.Size != dep.inode.Size {
+ tracef(CDebug, "ood: %s%s -> %s: size differs", indent, tgtOrig, dep.tgt)
ood = true
- goto StampCheck
+ OODCache[path.Join(cwd, dep.tgt)] = ood
+ goto Done
+ }
+ if InodeTrust != InodeTrustNone && inode.Equals(dep.inode) {
+ tracef(CDebug, "ood: %s%s -> %s: same inode", indent, tgtOrig, dep.tgt)
} else {
+ tracef(CDebug, "ood: %s%s -> %s: inode differs", indent, tgtOrig, dep.tgt)
+ fd, err := os.Open(path.Join(cwd, dep.tgt))
+ if err != nil {
+ return ood, TgtError{tgtOrig, ErrLine(err)}
+ }
hsh, err := fileHash(fd)
+ fd.Close()
if err != nil {
- return ood, TgtErr{tgtOrig, err}
+ return ood, TgtError{tgtOrig, ErrLine(err)}
}
- if theirHsh != hsh {
- trace(CDebug, "ood: %s%s -> %s: hash differs", indent, tgtOrig, dep)
+ if !bytes.Equal(dep.hash, hsh) {
+ tracef(CDebug, "ood: %s%s -> %s: hash differs", indent, tgtOrig, dep.tgt)
ood = true
- goto StampCheck
+ OODCache[path.Join(cwd, dep.tgt)] = ood
+ goto Done
}
- trace(CDebug, "ood: %s%s -> %s: same hash", indent, tgtOrig, dep)
+ tracef(CDebug, "ood: %s%s -> %s: same hash", indent, tgtOrig, dep.tgt)
}
- fd.Close()
- if dep == tgt {
- trace(CDebug, "ood: %s%s -> %s: same target", indent, tgtOrig, dep)
+
+ if dep.tgt == tgt {
+ tracef(CDebug, "ood: %s%s -> %s: same target", indent, tgtOrig, dep.tgt)
continue
}
- if isSrc(cwd, dep) {
- trace(CDebug, "ood: %s%s -> %s: is source", indent, tgtOrig, dep)
+ if isSrc(cwd, dep.tgt) {
+ tracef(CDebug, "ood: %s%s -> %s: is source", indent, tgtOrig, dep.tgt)
+ OODCache[path.Join(cwd, dep.tgt)] = false
continue
}
- depOod, err := isOOD(cwd, dep, level+1)
+
+ if _, ok := seen[cwdMustRel(cwd, dep.tgt)]; ok {
+ tracef(CDebug, "ood: %s%s -> %s: was always built", indent, tgtOrig, dep.tgt)
+ OODCache[path.Join(cwd, dep.tgt)] = false
+ continue
+ }
+
+ depOOD, err := isOODWithTrace(cwd, dep.tgt, level+1, seen)
if err != nil {
- return ood, TgtErr{tgtOrig, err}
+ return ood, TgtError{tgtOrig, err}
}
- if depOod {
- trace(CDebug, "ood: %s%s -> %s: ood", indent, tgtOrig, dep)
+ if depOOD {
+ tracef(CDebug, "ood: %s%s -> %s: ood", indent, tgtOrig, dep.tgt)
ood = true
- goto StampCheck
+ goto Done
}
- trace(CDebug, "ood: %s%s -> %s: !ood", indent, tgtOrig, dep)
+ tracef(CDebug, "ood: %s%s -> %s: !ood", indent, tgtOrig, dep.tgt)
}
-StampCheck:
- if ood && stampOur != "" {
- trace(CDebug, "ood: %s%s run, because stamped", indent, tgtOrig)
- stampTheir, err := rebuildStamped(cwd, tgt, depPath)
- if err != nil {
- return true, TgtErr{tgtOrig, err}
- }
- trace(CDebug, "ood: %s%s -> stamp: %s %s", indent, tgtOrig, stampOur, stampTheir)
- if stampOur == stampTheir {
- ood = false
+Done:
+ tracef(CDebug, "ood: %s%s: %v", indent, tgtOrig, ood)
+ OODCache[path.Join(cwd, tgt)] = ood
+ return ood, nil
+}
+
+func isOODWithTrace(
+ cwd, tgtOrig string,
+ level int,
+ seen map[string]struct{},
+) (bool, error) {
+ p := mustAbs(path.Join(cwd, tgtOrig))
+ _, ood := OODTgts[p]
+ var err error
+ if ood {
+ if !isOODByBuildUUID(cwd, tgtOrig) {
+ tracef(
+ CDebug,
+ "ood: %s%s -> already built",
+ strings.Repeat(". ", level), tgtOrig,
+ )
+ return false, nil
}
+ tracef(
+ CDebug,
+ "ood: %s%s true, external decision",
+ strings.Repeat(". ", level), tgtOrig,
+ )
+ goto RecordOODTgt
+ }
+ ood, err = isOOD(cwd, tgtOrig, level, seen)
+ if !ood {
+ return ood, err
+ }
+RecordOODTgt:
+ flock := unix.Flock_t{
+ Type: unix.F_WRLCK,
+ Whence: io.SeekStart,
+ }
+ if err = unix.FcntlFlock(FdOODTgtsLock.Fd(), unix.F_SETLKW, &flock); err != nil {
+ log.Fatal(err)
+ }
+ if _, err = FdOODTgts.Seek(0, io.SeekEnd); err != nil {
+ log.Fatal(err)
+ }
+ if _, err := FdOODTgts.WriteString(p + "\x00"); err != nil {
+ log.Fatal(err)
+ }
+ flock.Type = unix.F_UNLCK
+ if err = unix.FcntlFlock(FdOODTgtsLock.Fd(), unix.F_SETLK, &flock); err != nil {
+ log.Fatal(err)
+ }
+ return true, nil
+}
+
+func oodTgtsClear() {
+ var err error
+ flock := unix.Flock_t{
+ Type: unix.F_WRLCK,
+ Whence: io.SeekStart,
+ }
+ if err = unix.FcntlFlock(FdOODTgtsLock.Fd(), unix.F_SETLKW, &flock); err != nil {
+ log.Fatal(err)
+ }
+ if err = FdOODTgts.Truncate(0); err != nil {
+ log.Fatal(err)
+ }
+ flock.Type = unix.F_UNLCK
+ if err = unix.FcntlFlock(FdOODTgtsLock.Fd(), unix.F_SETLK, &flock); err != nil {
+ log.Fatal(err)
}
- trace(CDebug, "ood: %s%s: %v", indent, tgtOrig, ood)
- return ood, nil
}