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/>.
36 "github.com/google/uuid"
37 "go.cypherpunks.ru/recfile"
38 "golang.org/x/sys/unix"
42 CmdNameGoredo = "goredo"
44 CmdNameRedoAffects = "redo-affects"
45 CmdNameRedoAlways = "redo-always"
46 CmdNameRedoCleanup = "redo-cleanup"
47 CmdNameRedoDep2Rec = "redo-dep2rec"
48 CmdNameRedoDepFix = "redo-depfix"
49 CmdNameRedoDot = "redo-dot"
50 CmdNameRedoIfchange = "redo-ifchange"
51 CmdNameRedoIfcreate = "redo-ifcreate"
52 CmdNameRedoInode = "redo-inode"
53 CmdNameRedoLog = "redo-log"
54 CmdNameRedoOOD = "redo-ood"
55 CmdNameRedoSources = "redo-sources"
56 CmdNameRedoStamp = "redo-stamp"
57 CmdNameRedoTargets = "redo-targets"
58 CmdNameRedoWhichdo = "redo-whichdo"
64 IsTopRedo bool // is it the top redo instance
68 func mustSetenv(key string) {
69 if err := os.Setenv(key, "1"); err != nil {
74 func mustParseFd(v, name string) *os.File {
75 ptr, err := strconv.ParseUint(v, 10, 64)
79 fd := os.NewFile(uintptr(ptr), name)
81 panic("can not parse fd: " + name)
86 func CmdName() string {
87 return path.Base(os.Args[0])
91 version := flag.Bool("version", false, "print version")
92 warranty := flag.Bool("warranty", false, "print warranty information")
96 if cmdName == "goredo" {
97 symlinks = flag.Bool("symlinks", false, "create necessary symlinks in current directory")
100 flag.Usage = func() { usage(os.Args[0]) }
103 fmt.Println(Warranty)
107 fmt.Println("goredo", Version, "built with", runtime.Version())
110 if cmdName == CmdNameGoredo && *symlinks {
112 for _, cmdName := range []string{
130 fmt.Println(os.Args[0], "<-", cmdName)
131 if err := os.Symlink(os.Args[0], cmdName); err != nil {
138 log.SetFlags(log.Lshortfile)
140 UmaskCur = syscall.Umask(0)
141 syscall.Umask(UmaskCur)
144 Cwd, err = os.Getwd()
149 TopDir = os.Getenv(EnvTopDir)
153 TopDir = mustAbs(TopDir)
155 DirPrefix = os.Getenv(EnvDirPrefix)
156 DepCwd = os.Getenv(EnvDepCwd)
158 if flagStderrKeep != nil && *flagStderrKeep {
159 mustSetenv(EnvStderrKeep)
161 if flagStderrSilent != nil && *flagStderrSilent {
162 mustSetenv(EnvStderrSilent)
164 if flagNoProgress != nil && *flagNoProgress {
165 mustSetenv(EnvNoProgress)
167 if flagDebug != nil && *flagDebug {
170 if flagLogWait != nil && *flagLogWait {
171 mustSetenv(EnvLogWait)
173 if flagLogLock != nil && *flagLogLock {
174 mustSetenv(EnvLogLock)
176 if flagLogPid != nil && *flagLogPid {
177 mustSetenv(EnvLogPid)
179 if flagLogJS != nil && *flagLogJS {
182 StderrKeep = os.Getenv(EnvStderrKeep) == "1"
183 StderrSilent = os.Getenv(EnvStderrSilent) == "1"
184 NoProgress = os.Getenv(EnvNoProgress) == "1"
185 Debug = os.Getenv(EnvDebug) == "1"
186 LogWait = os.Getenv(EnvLogWait) == "1"
187 LogLock = os.Getenv(EnvLogLock) == "1"
188 LogJS = os.Getenv(EnvLogJS) == "1"
189 if Debug || os.Getenv(EnvLogPid) == "1" {
193 if flagTraceAll != nil && *flagTraceAll {
196 if os.Getenv(EnvTrace) == "1" {
199 } else if flagTrace != nil {
202 NoColor = os.Getenv(EnvNoColor) != ""
203 NoSync = os.Getenv(EnvNoSync) == "1"
204 StopIfMod = os.Getenv(EnvStopIfMod) == "1"
205 switch s := os.Getenv(EnvInodeTrust); s {
207 InodeTrust = InodeTrustNone
209 InodeTrust = InodeTrustCtime
211 InodeTrust = InodeTrustMtime
213 log.Fatalln("unknown", EnvInodeTrust, "value")
216 // Those are internal envs
217 FdOODTgts, err = os.CreateTemp("", "ood-tgts")
221 if err = os.Remove(FdOODTgts.Name()); err != nil {
224 FdOODTgtsLock, err = os.CreateTemp("", "ood-tgts.lock")
228 if err = os.Remove(FdOODTgtsLock.Name()); err != nil {
233 if v := os.Getenv(EnvOODTgtsFd); v != "" {
234 fd := mustParseFd(v, EnvOODTgtsFd)
235 fdLock = mustParseFd(v, EnvOODTgtsLockFd)
237 flock := unix.Flock_t{
239 Whence: io.SeekStart,
241 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_SETLKW, &flock); err != nil {
244 if _, err = fd.Seek(0, io.SeekStart); err != nil {
247 tgtsRaw, err := io.ReadAll(bufio.NewReader(fd))
251 flock.Type = unix.F_UNLCK
252 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
255 OODTgts = make(map[string]struct{})
256 for _, tgtRaw := range bytes.Split(tgtsRaw, []byte{0}) {
261 OODTgts[t] = struct{}{}
262 tracef(CDebug, "ood: known to be: %s", t)
266 StderrPrefix = os.Getenv(EnvStderrPrefix)
267 if v := os.Getenv(EnvLevel); v != "" {
268 Level, err = strconv.Atoi(v)
273 panic("negative " + EnvLevel)
278 if v := os.Getenv(EnvDepFd); v != "" {
279 fdDep = mustParseFd(v, EnvDepFd)
282 tgts := make([]*Tgt, 0, len(flag.Args()))
283 for _, arg := range flag.Args() {
284 tgts = append(tgts, NewTgt(arg))
286 tgtsWasEmpty := len(tgts) == 0
287 if BuildUUIDStr := os.Getenv(EnvBuildUUID); BuildUUIDStr == "" {
289 BuildUUID = uuid.New()
291 tgts = append(tgts, NewTgt("all"))
293 tracef(CDebug, "inode-trust: %s", InodeTrust)
295 BuildUUID, err = uuid.Parse(BuildUUIDStr)
301 if cmdName == CmdNameRedo {
305 killed := make(chan os.Signal, 1)
306 signal.Notify(killed, syscall.SIGHUP, syscall.SIGINT, syscall.SIGTERM)
309 tracef(CDebug, "[%s] killed", BuildUUID)
312 for pid, proc := range RunningProcs {
313 tracef(CDebug, "[%s] killing child %d", BuildUUID, pid)
314 _ = proc.Signal(syscall.SIGTERM)
321 tracef(CDebug, "[%s] run: %s %s cwd:%s dirprefix:%s",
322 BuildUUID, cmdName, tgts, Cwd, DirPrefix)
326 for _, tgt := range tgts {
327 ok, err = ifchange([]*Tgt{tgt}, true, traced)
328 if err != nil || !ok {
332 case CmdNameRedoIfchange:
333 ok, err = ifchange(tgts, *flagForcedIfchange, traced)
335 err = depsWrite(fdDep, tgts)
337 case CmdNameRedoIfcreate:
339 log.Fatalln("no", EnvDepFd)
341 fdDepW := bufio.NewWriter(fdDep)
342 for _, tgt := range tgts {
343 err = ifcreate(fdDepW, fdDep.Name(), tgt.RelTo(path.Join(Cwd, DirPrefix)))
349 case CmdNameRedoAlways:
351 log.Fatalln("no", EnvDepFd)
353 err = always(fdDep, fdDep.Name())
354 case CmdNameRedoCleanup:
355 for _, what := range tgts {
356 err = cleanupWalker(Cwd, path.Base(what.a))
363 case CmdNameRedoStamp:
365 log.Fatalln("no", EnvDepFd)
368 hsh, err = fileHash(os.Stdin)
372 err = stamp(fdDep, fdDep.Name(), hsh)
375 log.Fatal("single target expected")
377 err = showBuildLog(tgts[0], nil, 0)
378 case CmdNameRedoWhichdo:
380 log.Fatal("single target expected")
383 dos, err = whichdo(tgts[0])
388 for _, do := range dos {
391 case CmdNameRedoTargets:
392 raws := make([]string, 0, len(tgts))
393 for _, tgt := range tgts {
394 raws = append(raws, tgt.rel)
399 raws, err = targetsWalker(raws)
405 for _, tgt := range raws {
408 case CmdNameRedoAffects:
410 log.Fatal("no targets specified")
414 var tgtsKnown []string
415 tgtsKnown, err = targetsWalker([]string{Cwd})
420 deps := make(map[string]map[string]*Tgt)
421 for _, tgt := range tgtsKnown {
422 collectDeps(NewTgt(tgt), 0, deps, true)
424 seen := make(map[string]*Tgt)
425 for _, tgt := range tgts {
426 collectWholeDeps(deps[tgt.rel], deps, seen)
428 res = make([]string, 0, len(seen))
429 for _, dep := range seen {
430 res = append(res, dep.rel)
434 for _, dep := range res {
438 raws := make([]string, 0, len(tgts))
439 for _, tgt := range tgts {
440 raws = append(raws, tgt.rel)
443 raws, err = targetsWalker([]string{Cwd})
450 for _, tgt := range raws {
451 ood, err = isOOD(NewTgt(tgt), 0, nil)
460 case CmdNameRedoSources:
461 srcs := make(map[string]*Tgt)
463 raws := make([]string, 0, len(tgts))
464 for _, tgt := range tgts {
465 raws = append(raws, tgt.rel)
468 raws, err = targetsWalker([]string{Cwd})
476 for _, raw := range raws {
477 tgts = append(tgts, NewTgt(raw))
479 seen := make(map[string]struct{})
480 seenDeps := make(map[string]struct{})
481 err = ErrLine(sourcesWalker(tgts, seen, seenDeps, srcs))
486 res := make([]string, 0, len(srcs))
487 for _, tgt := range srcs {
488 res = append(res, tgt.rel)
492 for _, src := range res {
495 case CmdNameRedoDepFix:
497 DepFixHashCache = make(map[string]Hash)
499 case CmdNameRedoInode:
501 for _, tgt := range tgts {
502 inode, err = inodeFromFileByPath(tgt.a)
507 err = recfileWrite(os.Stdout, append(
508 []recfile.Field{{Name: "Target", Value: tgt.String()}},
509 inode.RecfileFields()...)...)
515 case CmdNameRedoDep2Rec:
517 data, err = os.ReadFile(tgts[0].a)
522 build, data, err = depHeadParse(data)
526 w := bufio.NewWriter(os.Stdout)
527 err = recfileWrite(w, []recfile.Field{
528 {Name: "Build", Value: build.String()},
536 typ, chunk, data, _ = chunkRead(data)
539 err = recfileWrite(w, []recfile.Field{
540 {Name: "Type", Value: "always"},
543 err = recfileWrite(w, []recfile.Field{
544 {Name: "Type", Value: "stamp"},
545 {Name: "Hash", Value: hex.EncodeToString(chunk)},
547 case DepTypeIfcreate:
548 err = recfileWrite(w, []recfile.Field{
549 {Name: "Type", Value: "ifcreate"},
550 {Name: "Target", Value: string(chunk)},
552 case DepTypeIfchange:
553 name := string(chunk[InodeLen+HashLen:])
554 meta := string(chunk[:InodeLen+HashLen])
555 fields := []recfile.Field{
556 {Name: "Type", Value: "ifchange"},
557 {Name: "Target", Value: name},
559 fields = append(fields, recfile.Field{
560 Name: "Hash", Value: Hash(meta[InodeLen:]).String(),
562 fields = append(fields, Inode(meta[:InodeLen]).RecfileFields()...)
563 err = recfileWrite(w, fields...)
564 case DepTypeIfchangeDummy:
565 err = recfileWrite(w, []recfile.Field{
566 {Name: "Type", Value: "ifchange"},
567 {Name: "Target", Value: string(chunk)},
576 log.Fatalln("unknown command", cmdName)
582 if !ok || err != nil {
585 tracef(CDebug, "[%s] finished: %s %s", BuildUUID, cmdName, tgts)