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/>.
38 "go.cypherpunks.ru/recfile"
39 "golang.org/x/sys/unix"
43 CmdNameGoredo = "goredo"
45 CmdNameRedoAffects = "redo-affects"
46 CmdNameRedoAlways = "redo-always"
47 CmdNameRedoCleanup = "redo-cleanup"
48 CmdNameRedoDot = "redo-dot"
49 CmdNameRedoIfchange = "redo-ifchange"
50 CmdNameRedoIfcreate = "redo-ifcreate"
51 CmdNameRedoLog = "redo-log"
52 CmdNameRedoOOD = "redo-ood"
53 CmdNameRedoSources = "redo-sources"
54 CmdNameRedoStamp = "redo-stamp"
55 CmdNameRedoTargets = "redo-targets"
56 CmdNameRedoWhichdo = "redo-whichdo"
57 CmdNameRedoDepFix = "redo-depfix"
58 CmdNameRedoInode = "redo-inode"
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{
128 fmt.Println(os.Args[0], "<-", cmdName)
129 if err := os.Symlink(os.Args[0], cmdName); err != nil {
136 log.SetFlags(log.Lshortfile)
138 UmaskCur = syscall.Umask(0)
139 syscall.Umask(UmaskCur)
142 Cwd, err = os.Getwd()
147 TopDir = os.Getenv(EnvTopDir)
151 TopDir, err = filepath.Abs(TopDir)
156 DirPrefix = os.Getenv(EnvDirPrefix)
157 DepCwd = os.Getenv(EnvDepCwd)
159 if flagStderrKeep != nil && *flagStderrKeep {
160 mustSetenv(EnvStderrKeep)
162 if flagStderrSilent != nil && *flagStderrSilent {
163 mustSetenv(EnvStderrSilent)
165 if flagNoProgress != nil && *flagNoProgress {
166 mustSetenv(EnvNoProgress)
168 if flagDebug != nil && *flagDebug {
171 if flagLogWait != nil && *flagLogWait {
172 mustSetenv(EnvLogWait)
174 if flagLogLock != nil && *flagLogLock {
175 mustSetenv(EnvLogLock)
177 if flagLogPid != nil && *flagLogPid {
178 mustSetenv(EnvLogPid)
180 if flagLogJS != nil && *flagLogJS {
183 StderrKeep = os.Getenv(EnvStderrKeep) == "1"
184 StderrSilent = os.Getenv(EnvStderrSilent) == "1"
185 NoProgress = os.Getenv(EnvNoProgress) == "1"
186 Debug = os.Getenv(EnvDebug) == "1"
187 LogWait = os.Getenv(EnvLogWait) == "1"
188 LogLock = os.Getenv(EnvLogLock) == "1"
189 LogJS = os.Getenv(EnvLogJS) == "1"
190 if Debug || os.Getenv(EnvLogPid) == "1" {
194 if flagTraceAll != nil && *flagTraceAll {
197 if os.Getenv(EnvTrace) == "1" {
200 } else if flagTrace != nil {
203 NoColor = os.Getenv(EnvNoColor) != ""
204 NoSync = os.Getenv(EnvNoSync) == "1"
205 StopIfMod = os.Getenv(EnvStopIfMod) == "1"
206 switch s := os.Getenv(EnvInodeTrust); s {
208 InodeTrust = InodeTrustNone
210 InodeTrust = InodeTrustCtime
212 InodeTrust = InodeTrustMtime
214 log.Fatalln("unknown", EnvInodeTrust, "value")
216 tracef(CDebug, "inode-trust: %s", InodeTrust)
218 // Those are internal envs
219 FdOODTgts, err = os.CreateTemp("", "ood-tgts")
223 if err = os.Remove(FdOODTgts.Name()); err != nil {
226 FdOODTgtsLock, err = os.CreateTemp("", "ood-tgts.lock")
230 if err = os.Remove(FdOODTgtsLock.Name()); err != nil {
234 if v := os.Getenv(EnvOODTgtsFd); v != "" {
235 fd := mustParseFd(v, EnvOODTgtsFd)
236 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 = 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)
283 BuildUUID = os.Getenv(EnvBuildUUID)
284 tgtsWasEmpty := len(tgts) == 0
288 if _, err = io.ReadFull(rand.Reader, raw[:]); err != nil {
291 raw[6] = (raw[6] & 0x0F) | uint8(4<<4) // version 4
292 BuildUUID = fmt.Sprintf(
294 raw[0:4], raw[4:6], raw[6:8], raw[8:10], raw[10:],
297 tgts = []string{"all"}
301 if cmdName == CmdNameRedo || cmdName == CmdNameRedoIfchange {
305 for i, tgt := range tgts {
307 tgts[i] = cwdMustRel(tgt)
311 killed := make(chan os.Signal, 1)
312 signal.Notify(killed, syscall.SIGHUP, syscall.SIGINT, syscall.SIGTERM)
315 tracef(CDebug, "[%s] killed", BuildUUID)
318 for pid, proc := range RunningProcs {
319 tracef(CDebug, "[%s] killing child %d", BuildUUID, pid)
320 _ = proc.Signal(syscall.SIGTERM)
328 CDebug, "[%s] run: %s %s cwd:%s dirprefix:%s",
329 BuildUUID, cmdName, tgts, Cwd, DirPrefix,
335 for _, tgt := range tgts {
336 ok, err = ifchange([]string{tgt}, true, traced)
337 if err != nil || !ok {
341 case CmdNameRedoIfchange:
342 ok, err = ifchange(tgts, *flagForcedIfchange, traced)
344 err = depsWrite(fdDep, tgts)
346 case CmdNameRedoIfcreate:
348 log.Fatalln("no", EnvDepFd)
350 for _, tgt := range tgts {
351 tgtRel, err := filepath.Rel(
352 path.Join(Cwd, DirPrefix),
358 err = ifcreate(fdDep, tgtRel)
363 case CmdNameRedoAlways:
365 log.Fatalln("no", EnvDepFd)
368 case CmdNameRedoCleanup:
369 for _, what := range tgts {
370 err = cleanupWalker(Cwd, what)
377 case CmdNameRedoStamp:
379 log.Fatalln("no", EnvDepFd)
381 err = stamp(fdDep, os.Stdin)
384 log.Fatalln("single target expected")
386 d, t := cwdAndTgt(tgts[0])
387 err = showBuildLog(d, t, nil, 0)
388 case CmdNameRedoWhichdo:
390 log.Fatalln("single target expected")
393 fdTmp, err = os.CreateTemp("", "whichdo")
397 if err = os.Remove(fdTmp.Name()); err != nil {
400 cwd, tgt := cwdAndTgt(tgts[0])
401 doFile, upLevels, err := findDo(fdTmp, cwd, tgt)
405 _, err = fdTmp.Seek(0, io.SeekStart)
409 r := recfile.NewReader(fdTmp)
411 m, err := r.NextMap()
413 if errors.Is(err, io.EOF) {
418 fmt.Println(cwdMustRel(cwd, m["Target"]))
423 p := make([]string, 0, upLevels+2)
425 for i := 0; i < upLevels; i++ {
428 p = append(p, doFile)
429 rel, err := filepath.Rel(Cwd, path.Join(p...))
435 case CmdNameRedoTargets:
439 tgts, err = targetsWalker(tgts)
444 for _, tgt := range tgts {
447 case CmdNameRedoAffects:
449 log.Fatalln("no targets specified")
451 var tgtsKnown []string
452 tgtsKnown, err = targetsWalker([]string{Cwd})
456 deps := map[string]map[string]struct{}{}
457 for _, tgt := range tgtsKnown {
458 collectDeps(Cwd, tgt, 0, deps, true)
460 seen := map[string]struct{}{}
461 for _, tgt := range tgts {
462 collectWholeDeps(deps[tgt], deps, seen)
464 tgts := make([]string, 0, len(seen))
465 for dep := range seen {
466 tgts = append(tgts, dep)
469 for _, dep := range tgts {
474 tgts, err = targetsWalker([]string{Cwd})
481 for _, tgt := range tgts {
482 ood, err = isOOD(Cwd, tgt, 0, nil)
490 case CmdNameRedoSources:
492 tgts, err = targetsWalker([]string{Cwd})
499 srcs, err = sourcesWalker(tgts)
501 for _, src := range srcs {
504 case CmdNameRedoDepFix:
506 case CmdNameRedoInode:
508 for _, tgt := range tgts {
509 inode, err = inodeFromFileByPath(tgt)
513 err = recfileWrite(os.Stdout, append(
514 []recfile.Field{{Name: "Target", Value: tgt}},
515 inode.RecfileFields()...)...)
521 log.Fatalln("unknown command", cmdName)
527 if !ok || err != nil {
530 tracef(CDebug, "[%s] finished: %s %s", BuildUUID, cmdName, tgts)