main.go

   1 /*
   2 goredo -- djb's redo implementation on pure Go
   3 Copyright (C) 2020-2023 Sergey Matveev <stargrave@stargrave.org>
   4
   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.
   8
   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.
  13
  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/>.
  16 */
  17
  18 package main
  19
  20 import (
  21         "bufio"
  22         "bytes"
  23         "crypto/rand"
  24         "errors"
  25         "flag"
  26         "fmt"
  27         "io"
  28         "log"
  29         "os"
  30         "os/signal"
  31         "path"
  32         "path/filepath"
  33         "runtime"
  34         "sort"
  35         "strconv"
  36         "syscall"
  37
  38         "go.cypherpunks.ru/recfile"
  39         "golang.org/x/sys/unix"
  40 )
  41
  42 const (
  43         CmdNameGoredo       = "goredo"
  44         CmdNameRedo         = "redo"
  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"
  59 )
  60
  61 var (
  62         Cwd       string
  63         BuildUUID string
  64         IsTopRedo bool // is it the top redo instance
  65         UmaskCur  int
  66 )
  67
  68 func mustSetenv(key string) {
  69         if err := os.Setenv(key, "1"); err != nil {
  70                 panic(err)
  71         }
  72 }
  73
  74 func mustParseFd(v, name string) *os.File {
  75         ptr, err := strconv.ParseUint(v, 10, 64)
  76         if err != nil {
  77                 panic(err)
  78         }
  79         fd := os.NewFile(uintptr(ptr), name)
  80         if fd == nil {
  81                 panic("can not parse fd: " + name)
  82         }
  83         return fd
  84 }
  85
  86 func CmdName() string {
  87         return path.Base(os.Args[0])
  88 }
  89
  90 func main() {
  91         version := flag.Bool("version", false, "print version")
  92         warranty := flag.Bool("warranty", false, "print warranty information")
  93
  94         var symlinks *bool
  95         cmdName := CmdName()
  96         if cmdName == "goredo" {
  97                 symlinks = flag.Bool("symlinks", false, "create necessary symlinks in current directory")
  98         }
  99
 100         flag.Usage = func() { usage(os.Args[0]) }
 101         flag.Parse()
 102         if *warranty {
 103                 fmt.Println(Warranty)
 104                 return
 105         }
 106         if *version {
 107                 fmt.Println("goredo", Version, "built with", runtime.Version())
 108                 return
 109         }
 110         if cmdName == CmdNameGoredo && *symlinks {
 111                 rc := 0
 112                 for _, cmdName := range []string{
 113                         CmdNameRedo,
 114                         CmdNameRedoAffects,
 115                         CmdNameRedoAlways,
 116                         CmdNameRedoCleanup,
 117                         CmdNameRedoDepFix,
 118                         CmdNameRedoDot,
 119                         CmdNameRedoIfchange,
 120                         CmdNameRedoIfcreate,
 121                         CmdNameRedoLog,
 122                         CmdNameRedoOOD,
 123                         CmdNameRedoSources,
 124                         CmdNameRedoStamp,
 125                         CmdNameRedoTargets,
 126                         CmdNameRedoWhichdo,
 127                 } {
 128                         fmt.Println(os.Args[0], "<-", cmdName)
 129                         if err := os.Symlink(os.Args[0], cmdName); err != nil {
 130                                 rc = 1
 131                                 log.Print(err)
 132                         }
 133                 }
 134                 os.Exit(rc)
 135         }
 136         log.SetFlags(log.Lshortfile)
 137
 138         UmaskCur = syscall.Umask(0)
 139         syscall.Umask(UmaskCur)
 140
 141         var err error
 142         Cwd, err = os.Getwd()
 143         if err != nil {
 144                 log.Fatal(err)
 145         }
 146
 147         TopDir = os.Getenv(EnvTopDir)
 148         if TopDir == "" {
 149                 TopDir = "/"
 150         } else {
 151                 TopDir = mustAbs(TopDir)
 152         }
 153         DirPrefix = os.Getenv(EnvDirPrefix)
 154         DepCwd = os.Getenv(EnvDepCwd)
 155
 156         if flagStderrKeep != nil && *flagStderrKeep {
 157                 mustSetenv(EnvStderrKeep)
 158         }
 159         if flagStderrSilent != nil && *flagStderrSilent {
 160                 mustSetenv(EnvStderrSilent)
 161         }
 162         if flagNoProgress != nil && *flagNoProgress {
 163                 mustSetenv(EnvNoProgress)
 164         }
 165         if flagDebug != nil && *flagDebug {
 166                 mustSetenv(EnvDebug)
 167         }
 168         if flagLogWait != nil && *flagLogWait {
 169                 mustSetenv(EnvLogWait)
 170         }
 171         if flagLogLock != nil && *flagLogLock {
 172                 mustSetenv(EnvLogLock)
 173         }
 174         if flagLogPid != nil && *flagLogPid {
 175                 mustSetenv(EnvLogPid)
 176         }
 177         if flagLogJS != nil && *flagLogJS {
 178                 mustSetenv(EnvLogJS)
 179         }
 180         StderrKeep = os.Getenv(EnvStderrKeep) == "1"
 181         StderrSilent = os.Getenv(EnvStderrSilent) == "1"
 182         NoProgress = os.Getenv(EnvNoProgress) == "1"
 183         Debug = os.Getenv(EnvDebug) == "1"
 184         LogWait = os.Getenv(EnvLogWait) == "1"
 185         LogLock = os.Getenv(EnvLogLock) == "1"
 186         LogJS = os.Getenv(EnvLogJS) == "1"
 187         if Debug || os.Getenv(EnvLogPid) == "1" {
 188                 MyPid = os.Getpid()
 189         }
 190         var traced bool
 191         if flagTraceAll != nil && *flagTraceAll {
 192                 mustSetenv(EnvTrace)
 193         }
 194         if os.Getenv(EnvTrace) == "1" {
 195                 TracedAll = true
 196                 traced = true
 197         } else if flagTrace != nil {
 198                 traced = *flagTrace
 199         }
 200         NoColor = os.Getenv(EnvNoColor) != ""
 201         NoSync = os.Getenv(EnvNoSync) == "1"
 202         StopIfMod = os.Getenv(EnvStopIfMod) == "1"
 203         switch s := os.Getenv(EnvInodeTrust); s {
 204         case "none":
 205                 InodeTrust = InodeTrustNone
 206         case "", "ctime":
 207                 InodeTrust = InodeTrustCtime
 208         case "mtime":
 209                 InodeTrust = InodeTrustMtime
 210         default:
 211                 log.Fatalln("unknown", EnvInodeTrust, "value")
 212         }
 213         tracef(CDebug, "inode-trust: %s", InodeTrust)
 214
 215         // Those are internal envs
 216         FdOODTgts, err = os.CreateTemp("", "ood-tgts")
 217         if err != nil {
 218                 log.Fatal(err)
 219         }
 220         if err = os.Remove(FdOODTgts.Name()); err != nil {
 221                 log.Fatal(err)
 222         }
 223         FdOODTgtsLock, err = os.CreateTemp("", "ood-tgts.lock")
 224         if err != nil {
 225                 log.Fatal(err)
 226         }
 227         if err = os.Remove(FdOODTgtsLock.Name()); err != nil {
 228                 log.Fatal(err)
 229         }
 230
 231         var fdLock *os.File
 232         if v := os.Getenv(EnvOODTgtsFd); v != "" {
 233                 fd := mustParseFd(v, EnvOODTgtsFd)
 234                 fdLock = mustParseFd(v, EnvOODTgtsLockFd)
 235                 defer fdLock.Close()
 236                 flock := unix.Flock_t{
 237                         Type:   unix.F_WRLCK,
 238                         Whence: io.SeekStart,
 239                 }
 240                 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_SETLKW, &flock); err != nil {
 241                         log.Fatal(err)
 242                 }
 243                 if _, err = fd.Seek(0, io.SeekStart); err != nil {
 244                         log.Fatal(err)
 245                 }
 246                 tgtsRaw, err := io.ReadAll(bufio.NewReader(fd))
 247                 if err != nil {
 248                         log.Fatal(err)
 249                 }
 250                 flock.Type = unix.F_UNLCK
 251                 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
 252                         log.Fatal(err)
 253                 }
 254                 OODTgts = map[string]struct{}{}
 255                 for _, tgtRaw := range bytes.Split(tgtsRaw, []byte{0}) {
 256                         t := string(tgtRaw)
 257                         if t == "" {
 258                                 continue
 259                         }
 260                         OODTgts[t] = struct{}{}
 261                         tracef(CDebug, "ood: known to be: %s", t)
 262                 }
 263         }
 264
 265         StderrPrefix = os.Getenv(EnvStderrPrefix)
 266         if v := os.Getenv(EnvLevel); v != "" {
 267                 Level, err = strconv.Atoi(v)
 268                 if err != nil {
 269                         panic(err)
 270                 }
 271                 if Level < 0 {
 272                         panic("negative " + EnvLevel)
 273                 }
 274         }
 275
 276         var fdDep *os.File
 277         if v := os.Getenv(EnvDepFd); v != "" {
 278                 fdDep = mustParseFd(v, EnvDepFd)
 279         }
 280
 281         tgts := flag.Args()
 282         BuildUUID = os.Getenv(EnvBuildUUID)
 283         tgtsWasEmpty := len(tgts) == 0
 284         if BuildUUID == "" {
 285                 IsTopRedo = true
 286                 raw := new([16]byte)
 287                 if _, err = io.ReadFull(rand.Reader, raw[:]); err != nil {
 288                         log.Fatal(err)
 289                 }
 290                 raw[6] = (raw[6] & 0x0F) | uint8(4<<4) // version 4
 291                 BuildUUID = fmt.Sprintf(
 292                         "%x-%x-%x-%x-%x",
 293                         raw[0:4], raw[4:6], raw[6:8], raw[8:10], raw[10:],
 294                 )
 295                 if tgtsWasEmpty {
 296                         tgts = []string{"all"}
 297                 }
 298         }
 299
 300         if cmdName == CmdNameRedo {
 301                 statusInit()
 302         }
 303
 304         for i, tgt := range tgts {
 305                 if path.IsAbs(tgt) {
 306                         tgts[i] = cwdMustRel(tgt)
 307                 }
 308         }
 309
 310         killed := make(chan os.Signal, 1)
 311         signal.Notify(killed, syscall.SIGHUP, syscall.SIGINT, syscall.SIGTERM)
 312         go func() {
 313                 <-killed
 314                 tracef(CDebug, "[%s] killed", BuildUUID)
 315                 jsReleaseAll()
 316                 RunningProcsM.Lock()
 317                 for pid, proc := range RunningProcs {
 318                         tracef(CDebug, "[%s] killing child %d", BuildUUID, pid)
 319                         _ = proc.Signal(syscall.SIGTERM)
 320                 }
 321                 os.Exit(1)
 322         }()
 323
 324         ok := true
 325         err = nil
 326         tracef(
 327                 CDebug, "[%s] run: %s %s cwd:%s dirprefix:%s",
 328                 BuildUUID, cmdName, tgts, Cwd, DirPrefix,
 329         )
 330
 331 CmdSwitch:
 332         switch cmdName {
 333         case CmdNameRedo:
 334                 for _, tgt := range tgts {
 335                         ok, err = ifchange([]string{tgt}, true, traced)
 336                         if err != nil || !ok {
 337                                 break
 338                         }
 339                 }
 340         case CmdNameRedoIfchange:
 341                 ok, err = ifchange(tgts, *flagForcedIfchange, traced)
 342                 if err == nil {
 343                         err = depsWrite(fdDep, tgts)
 344                 }
 345         case CmdNameRedoIfcreate:
 346                 if fdDep == nil {
 347                         log.Fatalln("no", EnvDepFd)
 348                 }
 349                 for _, tgt := range tgts {
 350                         tgtRel, err := filepath.Rel(
 351                                 path.Join(Cwd, DirPrefix),
 352                                 path.Join(Cwd, tgt),
 353                         )
 354                         if err != nil {
 355                                 err = ErrLine(err)
 356                                 break
 357                         }
 358                         err = ifcreate(fdDep, tgtRel)
 359                         if err != nil {
 360                                 break
 361                         }
 362                 }
 363         case CmdNameRedoAlways:
 364                 if fdDep == nil {
 365                         log.Fatalln("no", EnvDepFd)
 366                 }
 367                 err = always(fdDep)
 368         case CmdNameRedoCleanup:
 369                 for _, what := range tgts {
 370                         err = cleanupWalker(Cwd, what)
 371                         if err != nil {
 372                                 break
 373                         }
 374                 }
 375         case CmdNameRedoDot:
 376                 err = dotPrint(tgts)
 377         case CmdNameRedoStamp:
 378                 if fdDep == nil {
 379                         log.Fatalln("no", EnvDepFd)
 380                 }
 381                 err = stamp(fdDep, os.Stdin)
 382         case CmdNameRedoLog:
 383                 if len(tgts) != 1 {
 384                         log.Fatal("single target expected")
 385                 }
 386                 d, t := cwdAndTgt(tgts[0])
 387                 err = showBuildLog(d, t, nil, 0)
 388         case CmdNameRedoWhichdo:
 389                 if len(tgts) != 1 {
 390                         log.Fatal("single target expected")
 391                 }
 392                 var fdTmp *os.File
 393                 fdTmp, err = os.CreateTemp("", "whichdo")
 394                 if err != nil {
 395                         err = ErrLine(err)
 396                         break
 397                 }
 398                 if err = os.Remove(fdTmp.Name()); err != nil {
 399                         err = ErrLine(err)
 400                         break
 401                 }
 402                 cwd, tgt := cwdAndTgt(tgts[0])
 403                 doFile, upLevels, err := findDo(fdTmp, cwd, tgt)
 404                 if err != nil {
 405                         err = ErrLine(err)
 406                         break
 407                 }
 408                 _, err = fdTmp.Seek(0, io.SeekStart)
 409                 if err != nil {
 410                         err = ErrLine(err)
 411                         break
 412                 }
 413                 r := recfile.NewReader(fdTmp)
 414                 for {
 415                         m, err := r.NextMap()
 416                         if err != nil {
 417                                 if errors.Is(err, io.EOF) {
 418                                         break
 419                                 }
 420                                 err = ErrLine(err)
 421                                 break CmdSwitch
 422                         }
 423                         fmt.Println(cwdMustRel(cwd, m["Target"]))
 424                 }
 425                 if doFile == "" {
 426                         ok = false
 427                 } else {
 428                         p := make([]string, 0, upLevels+2)
 429                         p = append(p, cwd)
 430                         for i := 0; i < upLevels; i++ {
 431                                 p = append(p, "..")
 432                         }
 433                         p = append(p, doFile)
 434                         rel := mustRel(Cwd, path.Join(p...))
 435                         fmt.Println(rel)
 436                 }
 437         case CmdNameRedoTargets:
 438                 if tgtsWasEmpty {
 439                         tgts = []string{Cwd}
 440                 }
 441                 tgts, err = targetsWalker(tgts)
 442                 if err != nil {
 443                         err = ErrLine(err)
 444                         break
 445                 }
 446                 sort.Strings(tgts)
 447                 for _, tgt := range tgts {
 448                         fmt.Println(tgt)
 449                 }
 450         case CmdNameRedoAffects:
 451                 if tgtsWasEmpty {
 452                         log.Fatal("no targets specified")
 453                 }
 454                 var tgtsKnown []string
 455                 tgtsKnown, err = targetsWalker([]string{Cwd})
 456                 if err != nil {
 457                         err = ErrLine(err)
 458                         break
 459                 }
 460                 deps := map[string]map[string]struct{}{}
 461                 for _, tgt := range tgtsKnown {
 462                         collectDeps(Cwd, tgt, 0, deps, true, map[string]struct{}{})
 463                 }
 464                 seen := map[string]struct{}{}
 465                 for _, tgt := range tgts {
 466                         collectWholeDeps(deps[tgt], deps, seen)
 467                 }
 468                 tgts := make([]string, 0, len(seen))
 469                 for dep := range seen {
 470                         tgts = append(tgts, dep)
 471                 }
 472                 sort.Strings(tgts)
 473                 for _, dep := range tgts {
 474                         fmt.Println(dep)
 475                 }
 476         case CmdNameRedoOOD:
 477                 if tgtsWasEmpty {
 478                         tgts, err = targetsWalker([]string{Cwd})
 479                         if err != nil {
 480                                 break
 481                         }
 482                 }
 483                 sort.Strings(tgts)
 484                 var ood bool
 485                 for _, tgt := range tgts {
 486                         ood, err = isOOD(Cwd, tgt, 0, nil)
 487                         if err != nil {
 488                                 err = ErrLine(err)
 489                                 break
 490                         }
 491                         if ood {
 492                                 fmt.Println(tgt)
 493                         }
 494                 }
 495         case CmdNameRedoSources:
 496                 if tgtsWasEmpty {
 497                         tgts, err = targetsWalker([]string{Cwd})
 498                         if err != nil {
 499                                 err = ErrLine(err)
 500                                 break
 501                         }
 502                 }
 503                 sort.Strings(tgts)
 504                 seen := make(map[string]struct{})
 505                 seenDeps := make(map[string]struct{})
 506                 srcs := make(map[string]struct{})
 507                 err = ErrLine(sourcesWalker(tgts, seen, seenDeps, srcs))
 508                 seen = nil
 509                 seenDeps = nil
 510                 if err != nil {
 511                         break
 512                 }
 513                 seenDeps = nil
 514                 res := make([]string, 0, len(srcs))
 515                 for p := range srcs {
 516                         res = append(res, p)
 517                 }
 518                 srcs = nil
 519                 sort.Strings(res)
 520                 for _, src := range res {
 521                         fmt.Println(src)
 522                 }
 523         case CmdNameRedoDepFix:
 524                 err = depFix(Cwd)
 525         case CmdNameRedoInode:
 526                 var inode *Inode
 527                 for _, tgt := range tgts {
 528                         inode, err = inodeFromFileByPath(tgt)
 529                         if err != nil {
 530                                 err = ErrLine(err)
 531                                 break
 532                         }
 533                         err = recfileWrite(os.Stdout, append(
 534                                 []recfile.Field{{Name: "Target", Value: tgt}},
 535                                 inode.RecfileFields()...)...)
 536                         if err != nil {
 537                                 err = ErrLine(err)
 538                                 break
 539                         }
 540                 }
 541         default:
 542                 log.Fatalln("unknown command", cmdName)
 543         }
 544         if err != nil {
 545                 log.Print(err)
 546         }
 547         rc := 0
 548         if !ok || err != nil {
 549                 rc = 1
 550         }
 551         tracef(CDebug, "[%s] finished: %s %s", BuildUUID, cmdName, tgts)
 552         os.Exit(rc)
 553 }