2 goredo -- djb's redo implementation on pure Go
3 Copyright (C) 2020-2021 Sergey Matveev <stargrave@stargrave.org>
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, version 3 of the License.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 // Out-of-date determination
32 "golang.org/x/sys/unix"
36 DepTypeIfcreate = "ifcreate"
37 DepTypeIfchange = "ifchange"
38 DepTypeAlways = "always"
39 DepTypeStamp = "stamp"
41 EnvOODTgtsFd = "REDO_OOD_TGTS_FD"
42 EnvOODTgtsLockFd = "REDO_OOD_TGTS_LOCK_FD"
46 OODTgts map[string]struct{}
48 FdOODTgtsLock *os.File
56 func (e TgtErr) Unwrap() error { return e.Err }
58 func (e TgtErr) Error() string {
59 return fmt.Sprintf("%s: %s", e.Tgt, e.Err)
62 func cwdMustRel(paths ...string) string {
63 rel, err := filepath.Rel(Cwd, path.Join(paths...))
70 func cwdAndTgt(tgt string) (string, string) {
71 cwd, tgt := path.Split(tgt)
72 cwd, err := filepath.Abs(cwd)
79 func isSrc(cwd, tgt string) bool {
80 d, f := path.Split(path.Join(cwd, tgt))
81 if _, err := os.Stat(path.Join(d, f)); err != nil {
84 if _, err := os.Stat(path.Join(d, f+".do")); err == nil {
87 if _, err := os.Stat(path.Join(d, RedoDir, f+DepSuffix)); err == nil {
93 func isOODByBuildUUID(cwd, tgtOrig string) bool {
94 cwd, tgt := cwdAndTgt(path.Join(cwd, tgtOrig))
95 depPath := path.Join(cwd, RedoDir, tgt+DepSuffix)
96 fdDep, err := os.Open(depPath)
100 depInfo, err := depRead(fdDep)
102 if err != nil || depInfo.build != BuildUUID {
108 func isOOD(cwd, tgtOrig string, level int, seen map[string]struct{}) (bool, error) {
109 indent := strings.Repeat(". ", level)
110 trace(CDebug, "ood: %s%s checking", indent, tgtOrig)
111 cwd, tgt := cwdAndTgt(path.Join(cwd, tgtOrig))
112 depPath := path.Join(cwd, RedoDir, tgt+DepSuffix)
113 fdDep, err := os.Open(depPath)
115 trace(CDebug, "ood: %s%s -> no dep: %s", indent, tgtOrig, depPath)
118 depInfo, err := depRead(fdDep)
121 return true, TgtErr{tgtOrig, err}
124 if depInfo.build == BuildUUID {
125 trace(CDebug, "ood: %s%s -> already built", indent, tgtOrig)
128 if _, err := os.Stat(path.Join(cwd, tgt)); err != nil && os.IsNotExist(err) {
129 trace(CDebug, "ood: %s%s -> non-existent", indent, tgtOrig)
134 for _, dep := range depInfo.ifcreates {
135 if _, err := os.Stat(path.Join(cwd, dep)); err == nil {
136 trace(CDebug, "ood: %s%s -> %s created", indent, tgtOrig, dep)
142 for _, m := range depInfo.ifchanges {
145 return ood, TgtErr{tgtOrig, errors.New("invalid format of .rec: missing Target")}
147 theirInode, err := inodeFromRec(m)
149 return ood, TgtErr{tgtOrig, fmt.Errorf("invalid format of .rec: %w", err)}
151 theirHsh := m["Hash"]
152 trace(CDebug, "ood: %s%s -> %s: checking", indent, tgtOrig, dep)
154 fd, err := os.Open(path.Join(cwd, dep))
156 if os.IsNotExist(err) {
157 trace(CDebug, "ood: %s%s -> %s: not exists", indent, tgtOrig, dep)
161 return ood, TgtErr{tgtOrig, err}
165 inode, err := inodeFromFile(fd)
167 return ood, TgtErr{tgtOrig, err}
169 if inode.Size != theirInode.Size {
170 trace(CDebug, "ood: %s%s -> %s: size differs", indent, tgtOrig, dep)
174 if InodeTrust && inode.Equals(theirInode) {
175 trace(CDebug, "ood: %s%s -> %s: same inode", indent, tgtOrig, dep)
177 trace(CDebug, "ood: %s%s -> %s: inode differs", indent, tgtOrig, dep)
178 hsh, err := fileHash(fd)
180 return ood, TgtErr{tgtOrig, err}
183 trace(CDebug, "ood: %s%s -> %s: hash differs", indent, tgtOrig, dep)
187 trace(CDebug, "ood: %s%s -> %s: same hash", indent, tgtOrig, dep)
189 fd.Close() // optimization not to hold it for long
192 trace(CDebug, "ood: %s%s -> %s: same target", indent, tgtOrig, dep)
196 trace(CDebug, "ood: %s%s -> %s: is source", indent, tgtOrig, dep)
200 if _, ok := seen[cwdMustRel(cwd, dep)]; ok {
201 trace(CDebug, "ood: %s%s -> %s: was always built", indent, tgtOrig, dep)
205 depOod, err := isOODWithTrace(cwd, dep, level+1, seen)
207 return ood, TgtErr{tgtOrig, err}
210 trace(CDebug, "ood: %s%s -> %s: ood", indent, tgtOrig, dep)
214 trace(CDebug, "ood: %s%s -> %s: !ood", indent, tgtOrig, dep)
218 trace(CDebug, "ood: %s%s: %v", indent, tgtOrig, ood)
225 seen map[string]struct{},
227 p, err := filepath.Abs(path.Join(cwd, tgtOrig))
233 if !isOODByBuildUUID(cwd, tgtOrig) {
236 "ood: %s%s -> already built",
237 strings.Repeat(". ", level), tgtOrig,
243 "ood: %s%s true, external decision",
244 strings.Repeat(". ", level), tgtOrig,
248 ood, err = isOOD(cwd, tgtOrig, level, seen)
253 if err = unix.Flock(int(FdOODTgtsLock.Fd()), unix.LOCK_EX); err != nil {
256 if _, err = FdOODTgts.Seek(0, io.SeekEnd); err != nil {
259 if _, err := FdOODTgts.WriteString(p + "\x00"); err != nil {
262 unix.Flock(int(FdOODTgtsLock.Fd()), unix.LOCK_UN)
266 func oodTgtsClear() {
267 if err := unix.Flock(int(FdOODTgtsLock.Fd()), unix.LOCK_EX); err != nil {
270 if err := FdOODTgts.Truncate(0); err != nil {
273 unix.Flock(int(FdOODTgtsLock.Fd()), unix.LOCK_UN)