/*
-goredo -- redo implementation on pure Go
-Copyright (C) 2020-2021 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
import (
"errors"
"fmt"
+ "io"
+ "log"
"os"
"path"
"path/filepath"
"strings"
+
+ "golang.org/x/sys/unix"
)
const (
DepTypeIfchange = "ifchange"
DepTypeAlways = "always"
DepTypeStamp = "stamp"
+
+ EnvOODTgtsFd = "REDO_OOD_TGTS_FD"
+ EnvOODTgtsLockFd = "REDO_OOD_TGTS_LOCK_FD"
)
-type TgtErr struct {
+var (
+ OODTgts map[string]struct{}
+ FdOODTgts *os.File
+ FdOODTgtsLock *os.File
+
+ OODCache map[string]bool = make(map[string]bool)
+ FileExistsCache map[string]bool = 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 os.IsNotExist(err) {
+ 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 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, f+".do")); err == nil {
+ if FileExists(path.Join(d, f+".do")) {
return false
}
- if _, err := os.Stat(path.Join(d, RedoDir, f+DepSuffix)); err == nil {
+ if FileExists(path.Join(d, RedoDir, f+DepSuffix)) {
return false
}
return true
}
+func isOODByBuildUUID(cwd, tgtOrig string) bool {
+ cwd, tgt := cwdAndTgt(path.Join(cwd, tgtOrig))
+ depPath := path.Join(cwd, RedoDir, tgt+DepSuffix)
+ fdDep, err := os.Open(depPath)
+ if err != nil {
+ return true
+ }
+ depInfo, err := depRead(fdDep)
+ fdDep.Close()
+ if err != nil || depInfo.build != BuildUUID {
+ return true
+ }
+ return false
+}
+
func isOOD(cwd, tgtOrig string, level int, seen map[string]struct{}) (bool, error) {
indent := strings.Repeat(". ", level)
- trace(CDebug, "ood: %s%s checking", indent, tgtOrig)
+ 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
+ }
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
+ 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)
+ }
+ OODCache[path.Join(cwd, tgt)] = ood
+ return ood, nil
}
depInfo, err := depRead(fdDep)
fdDep.Close()
if err != nil {
- return true, TgtErr{tgtOrig, err}
+ return true, TgtError{tgtOrig, err}
}
if depInfo.build == BuildUUID {
- trace(CDebug, "ood: %s%s -> already built", indent, tgtOrig)
+ tracef(CDebug, "ood: %s%s -> already built", indent, tgtOrig)
+ OODCache[path.Join(cwd, tgt)] = false
return false, nil
}
- ood := false
+ 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 _, dep := range depInfo.ifcreates {
- if _, err := os.Stat(path.Join(cwd, dep)); err == nil {
- trace(CDebug, "ood: %s%s -> %s created", indent, tgtOrig, dep)
+ if FileExists(path.Join(cwd, dep)) {
+ tracef(CDebug, "ood: %s%s -> %s created", indent, tgtOrig, dep)
ood = true
goto Done
}
for _, m := range depInfo.ifchanges {
dep := m["Target"]
if dep == "" {
- return ood, TgtErr{tgtOrig, errors.New("invalid format of .dep: missing Target")}
+ return ood, TgtError{tgtOrig, ErrMissingTarget}
}
theirInode, err := inodeFromRec(m)
if err != nil {
- return ood, TgtErr{tgtOrig, fmt.Errorf("invalid format of .dep: %v", err)}
+ return ood, TgtError{tgtOrig, fmt.Errorf("invalid format of .rec: %w", err)}
}
theirHsh := m["Hash"]
- trace(CDebug, "ood: %s%s -> %s: checking", indent, tgtOrig, dep)
+ tracef(CDebug, "ood: %s%s -> %s: checking", indent, tgtOrig, dep)
+ ood, cached = OODCache[path.Join(cwd, dep)]
+ if cached {
+ tracef(CDebug, "ood: %s%s -> %s: cached: %v", indent, tgtOrig, dep, ood)
+ if ood {
+ goto Done
+ }
+ continue
+ }
- fd, err := os.Open(path.Join(cwd, dep))
+ inode, err := inodeFromFileByPath(path.Join(cwd, dep))
if err != nil {
if os.IsNotExist(err) {
- trace(CDebug, "ood: %s%s -> %s: not exists", indent, tgtOrig, dep)
+ tracef(CDebug, "ood: %s%s -> %s: not exists", indent, tgtOrig, dep)
ood = true
+ OODCache[path.Join(cwd, dep)] = ood
goto Done
}
- return ood, TgtErr{tgtOrig, err}
+ return ood, TgtError{tgtOrig, err}
}
- defer fd.Close()
- inode, err := inodeFromFile(fd)
- if err != nil {
- return ood, TgtErr{tgtOrig, err}
- }
if inode.Size != theirInode.Size {
- trace(CDebug, "ood: %s%s -> %s: size differs", indent, tgtOrig, dep)
+ tracef(CDebug, "ood: %s%s -> %s: size differs", indent, tgtOrig, dep)
ood = true
+ OODCache[path.Join(cwd, dep)] = ood
goto Done
}
- if inode.Equals(theirInode) {
- trace(CDebug, "ood: %s%s -> %s: same inode", indent, tgtOrig, dep)
+ if InodeTrust != InodeTrustNone && inode.Equals(theirInode) {
+ tracef(CDebug, "ood: %s%s -> %s: same inode", indent, tgtOrig, dep)
} else {
- trace(CDebug, "ood: %s%s -> %s: inode differs", indent, tgtOrig, dep)
+ tracef(CDebug, "ood: %s%s -> %s: inode differs", indent, tgtOrig, dep)
+ fd, err := os.Open(path.Join(cwd, dep))
+ if err != nil {
+ return ood, TgtError{tgtOrig, err}
+ }
hsh, err := fileHash(fd)
+ fd.Close()
if err != nil {
- return ood, TgtErr{tgtOrig, err}
+ return ood, TgtError{tgtOrig, err}
}
if theirHsh != hsh {
- trace(CDebug, "ood: %s%s -> %s: hash differs", indent, tgtOrig, dep)
+ tracef(CDebug, "ood: %s%s -> %s: hash differs", indent, tgtOrig, dep)
ood = true
+ OODCache[path.Join(cwd, dep)] = 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)
}
- fd.Close() // optimization not to hold it for long
if dep == tgt {
- trace(CDebug, "ood: %s%s -> %s: same target", indent, tgtOrig, dep)
+ tracef(CDebug, "ood: %s%s -> %s: same target", indent, tgtOrig, dep)
continue
}
if isSrc(cwd, dep) {
- trace(CDebug, "ood: %s%s -> %s: is source", indent, tgtOrig, dep)
+ tracef(CDebug, "ood: %s%s -> %s: is source", indent, tgtOrig, dep)
+ OODCache[path.Join(cwd, dep)] = false
continue
}
if _, ok := seen[cwdMustRel(cwd, dep)]; ok {
- trace(CDebug, "ood: %s%s -> %s: was always built", indent, tgtOrig, dep)
+ tracef(CDebug, "ood: %s%s -> %s: was always built", indent, tgtOrig, dep)
+ OODCache[path.Join(cwd, dep)] = false
continue
}
- depOod, err := isOOD(cwd, dep, level+1, seen)
+ depOod, err := isOODWithTrace(cwd, dep, 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)
+ tracef(CDebug, "ood: %s%s -> %s: ood", indent, tgtOrig, dep)
ood = true
goto Done
}
- trace(CDebug, "ood: %s%s -> %s: !ood", indent, tgtOrig, dep)
+ tracef(CDebug, "ood: %s%s -> %s: !ood", indent, tgtOrig, dep)
}
Done:
- trace(CDebug, "ood: %s%s: %v", indent, tgtOrig, ood)
+ 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, err := filepath.Abs(path.Join(cwd, tgtOrig))
+ if err != nil {
+ panic(err)
+ }
+ _, ood := OODTgts[p]
+ 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.Fatalln(err)
+ }
+ if _, err = FdOODTgts.Seek(0, io.SeekEnd); err != nil {
+ log.Fatalln(err)
+ }
+ if _, err := FdOODTgts.WriteString(p + "\x00"); err != nil {
+ log.Fatalln(err)
+ }
+ flock.Type = unix.F_UNLCK
+ if err = unix.FcntlFlock(FdOODTgtsLock.Fd(), unix.F_SETLK, &flock); err != nil {
+ log.Fatalln(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.Fatalln(err)
+ }
+ if err = FdOODTgts.Truncate(0); err != nil {
+ log.Fatalln(err)
+ }
+ flock.Type = unix.F_UNLCK
+ if err = unix.FcntlFlock(FdOODTgtsLock.Fd(), unix.F_SETLK, &flock); err != nil {
+ log.Fatalln(err)
+ }
+}