2 goredo -- djb's redo implementation on pure Go
3 Copyright (C) 2020-2023 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/>.
32 "go.cypherpunks.ru/recfile"
33 "lukechampine.com/blake3"
42 ErrBadRecFormat = errors.New("invalid format of .rec")
43 InodeCache = make(map[string][]*Inode)
44 HashCache = make(map[string][]Hash)
49 func (h Hash) String() string {
50 return hex.EncodeToString([]byte(h))
53 func recfileWrite(fdDep io.StringWriter, fields ...recfile.Field) error {
54 w := recfile.NewWriter(fdDep)
55 if _, err := w.RecordStart(); err != nil {
58 if _, err := w.WriteFields(fields...); err != nil {
64 func ifcreate(fdDep *os.File, tgt string) error {
65 tracef(CDebug, "ifcreate: %s <- %s", fdDep.Name(), tgt)
68 recfile.Field{Name: "Type", Value: DepTypeIfcreate},
69 recfile.Field{Name: "Target", Value: tgt},
73 func always(fdDep *os.File) error {
74 tracef(CDebug, "always: %s", fdDep.Name())
75 return recfileWrite(fdDep, recfile.Field{Name: "Type", Value: DepTypeAlways})
78 func stamp(fdDep, src *os.File) error {
79 hsh, err := fileHash(src)
83 tracef(CDebug, "stamp: %s <- %s", fdDep.Name(), hsh)
86 recfile.Field{Name: "Type", Value: DepTypeStamp},
87 recfile.Field{Name: "Hash", Value: hsh.String()},
91 func fileHash(fd *os.File) (Hash, error) {
92 h := blake3.New(HashLen, nil)
93 if _, err := io.Copy(h, bufio.NewReader(fd)); err != nil {
96 return Hash(h.Sum(nil)), nil
99 func depWrite(fdDep *os.File, cwd string, tgt *Tgt, hsh Hash) error {
100 tracef(CDebug, "ifchange: %s <- %s", fdDep.Name(), tgt)
101 fd, err := os.Open(tgt.a)
106 inode, isDir, err := inodeFromFileByFd(fd)
114 hsh, err = fileHash(fd)
119 fields := []recfile.Field{
120 {Name: "Type", Value: DepTypeIfchange},
121 {Name: "Target", Value: tgt.RelTo(cwd)},
122 {Name: "Hash", Value: hsh.String()},
124 fields = append(fields, inode.RecfileFields()...)
125 return recfileWrite(fdDep, fields...)
128 func depsWrite(fdDep *os.File, tgts []*Tgt) error {
130 tracef(CDebug, "no opened fdDep: %s", tgts)
135 for _, tgt := range tgts {
137 if DepCwd != "" && Cwd != DepCwd {
140 tgtDir := path.Join(cwd, DirPrefix)
141 if _, errStat := os.Stat(tgt.a); errStat == nil {
142 err = ErrLine(depWrite(fdDep, tgtDir, tgt, ""))
144 tgtRel := tgt.RelTo(tgtDir)
145 tracef(CDebug, "ifchange: %s <- %s (non-existing)", fdDep.Name(), tgtRel)
146 fields := []recfile.Field{
147 {Name: "Type", Value: DepTypeIfchange},
148 {Name: "Target", Value: tgtRel},
150 inodeDummy := Inode{}
151 fields = append(fields, inodeDummy.RecfileFields()...)
152 err = ErrLine(recfileWrite(fdDep, fields...))
161 type DepInfoIfchange struct {
167 type DepInfo struct {
172 ifchanges []DepInfoIfchange
175 func mustHashDecode(s string) Hash {
176 b, err := hex.DecodeString(s)
183 var missingBuild = errors.New(".rec missing Build:")
185 func depRead(tgt *Tgt) (*DepInfo, error) {
186 data, err := os.ReadFile(tgt.Dep())
190 r := recfile.NewReader(bytes.NewReader(data))
191 m, err := r.NextMap()
198 return nil, missingBuild
202 m, err := r.NextMap()
204 if errors.Is(err, io.EOF) {
211 depInfo.always = true
212 case DepTypeIfcreate:
215 return nil, ErrBadRecFormat
217 depInfo.ifcreates = append(depInfo.ifcreates,
218 NewTgt(path.Join(tgt.h, dep)))
219 case DepTypeIfchange:
220 depRaw := m["Target"]
222 return nil, ErrBadRecFormat
224 inode, err := inodeFromRec(m)
227 return nil, ErrBadRecFormat
229 dep := NewTgt(path.Join(tgt.h, depRaw))
232 for _, cachedInode := range InodeCache[dep.a] {
233 if inode.Equals(cachedInode) {
239 if InodeCache != nil && !cachedFound {
240 InodeCache[dep.a] = append(InodeCache[dep.a], inode)
243 hsh := mustHashDecode(m["Hash"])
245 for _, cachedHash := range HashCache[dep.a] {
246 if hsh == cachedHash {
252 if HashCache != nil && !cachedFound {
253 HashCache[dep.a] = append(HashCache[dep.a], hsh)
256 depInfo.ifchanges = append(depInfo.ifchanges, DepInfoIfchange{
257 tgt: dep, inode: inode, hash: hsh,
262 return nil, ErrBadRecFormat
264 depInfo.stamp = mustHashDecode(hsh)
266 return nil, ErrBadRecFormat
272 func depReadOnlyIfchanges(pth string) (ifchanges []string, err error) {
273 data, err := os.ReadFile(pth)
277 r := recfile.NewReader(bytes.NewReader(data))
278 var m map[string]string
282 if errors.Is(err, io.EOF) {
288 if m["Type"] == DepTypeIfchange {
289 ifchanges = append(ifchanges, m["Target"])
295 func depReadBuild(pth string) (string, error) {
296 fd, err := os.Open(pth)
300 r := recfile.NewReader(fd)
301 m, err := r.NextMap()