main.go

   1 /*
   2 goredo -- djb's redo implementation on pure Go
   3 Copyright (C) 2020-2022 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 )
  59
  60 var (
  61         Cwd       string
  62         BuildUUID string
  63         IsTopRedo bool // is it the top redo instance
  64         UmaskCur  int
  65 )
  66
  67 func mustSetenv(key string) {
  68         if err := os.Setenv(key, "1"); err != nil {
  69                 panic(err)
  70         }
  71 }
  72
  73 func mustParseFd(v, name string) *os.File {
  74         ptr, err := strconv.ParseUint(v, 10, 64)
  75         if err != nil {
  76                 panic(err)
  77         }
  78         fd := os.NewFile(uintptr(ptr), name)
  79         if fd == nil {
  80                 panic("can not parse fd: " + name)
  81         }
  82         return fd
  83 }
  84
  85 func CmdName() string {
  86         return path.Base(os.Args[0])
  87 }
  88
  89 func main() {
  90         version := flag.Bool("version", false, "print version")
  91         warranty := flag.Bool("warranty", false, "print warranty information")
  92
  93         var symlinks *bool
  94         cmdName := CmdName()
  95         if cmdName == "goredo" {
  96                 symlinks = flag.Bool("symlinks", false, "create necessary symlinks in current directory")
  97         }
  98
  99         flag.Usage = func() { usage(os.Args[0]) }
 100         flag.Parse()
 101         if *warranty {
 102                 fmt.Println(Warranty)
 103                 return
 104         }
 105         if *version {
 106                 fmt.Println("goredo", Version, "built with", runtime.Version())
 107                 return
 108         }
 109         if cmdName == CmdNameGoredo && *symlinks {
 110                 rc := 0
 111                 for _, cmdName := range []string{
 112                         CmdNameRedo,
 113                         CmdNameRedoAffects,
 114                         CmdNameRedoAlways,
 115                         CmdNameRedoCleanup,
 116                         CmdNameRedoDepFix,
 117                         CmdNameRedoDot,
 118                         CmdNameRedoIfchange,
 119                         CmdNameRedoIfcreate,
 120                         CmdNameRedoLog,
 121                         CmdNameRedoOOD,
 122                         CmdNameRedoSources,
 123                         CmdNameRedoStamp,
 124                         CmdNameRedoTargets,
 125                         CmdNameRedoWhichdo,
 126                 } {
 127                         fmt.Println(os.Args[0], "<-", cmdName)
 128                         if err := os.Symlink(os.Args[0], cmdName); err != nil {
 129                                 rc = 1
 130                                 log.Println(err)
 131                         }
 132                 }
 133                 os.Exit(rc)
 134         }
 135         log.SetFlags(log.Lshortfile)
 136
 137         UmaskCur = syscall.Umask(0)
 138         syscall.Umask(UmaskCur)
 139
 140         var err error
 141         Cwd, err = os.Getwd()
 142         if err != nil {
 143                 log.Fatalln(err)
 144         }
 145
 146         TopDir = os.Getenv(EnvTopDir)
 147         if TopDir == "" {
 148                 TopDir = "/"
 149         } else {
 150                 TopDir, err = filepath.Abs(TopDir)
 151                 if err != nil {
 152                         panic(err)
 153                 }
 154         }
 155         DirPrefix = os.Getenv(EnvDirPrefix)
 156         DepCwd = os.Getenv(EnvDepCwd)
 157
 158         if flagStderrKeep != nil && *flagStderrKeep {
 159                 mustSetenv(EnvStderrKeep)
 160         }
 161         if flagStderrSilent != nil && *flagStderrSilent {
 162                 mustSetenv(EnvStderrSilent)
 163         }
 164         if flagNoProgress != nil && *flagNoProgress {
 165                 mustSetenv(EnvNoProgress)
 166         }
 167         if flagDebug != nil && *flagDebug {
 168                 mustSetenv(EnvDebug)
 169         }
 170         if flagLogWait != nil && *flagLogWait {
 171                 mustSetenv(EnvLogWait)
 172         }
 173         if flagLogLock != nil && *flagLogLock {
 174                 mustSetenv(EnvLogLock)
 175         }
 176         if flagLogPid != nil && *flagLogPid {
 177                 mustSetenv(EnvLogPid)
 178         }
 179         if flagLogJS != nil && *flagLogJS {
 180                 mustSetenv(EnvLogJS)
 181         }
 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" {
 190                 MyPid = os.Getpid()
 191         }
 192         var traced bool
 193         if flagTraceAll != nil && *flagTraceAll {
 194                 mustSetenv(EnvTrace)
 195         }
 196         if os.Getenv(EnvTrace) == "1" {
 197                 TracedAll = true
 198                 traced = true
 199         } else if flagTrace != nil {
 200                 traced = *flagTrace
 201         }
 202         NoColor = os.Getenv(EnvNoColor) != ""
 203         NoSync = os.Getenv(EnvNoSync) == "1"
 204         StopIfMod = os.Getenv(EnvStopIfMod) == "1"
 205         switch s := os.Getenv(EnvInodeTrust); s {
 206         case "none":
 207                 InodeTrust = InodeTrustNone
 208         case "", "ctime":
 209                 InodeTrust = InodeTrustCtime
 210         case "mtime":
 211                 InodeTrust = InodeTrustMtime
 212         default:
 213                 log.Fatalln("unknown", EnvInodeTrust, "value")
 214         }
 215         tracef(CDebug, "inode-trust: %s", InodeTrust)
 216
 217         // Those are internal envs
 218         FdOODTgts, err = os.CreateTemp("", "ood-tgts")
 219         if err != nil {
 220                 log.Fatalln(err)
 221         }
 222         if err = os.Remove(FdOODTgts.Name()); err != nil {
 223                 log.Fatalln(err)
 224         }
 225         FdOODTgtsLock, err = os.CreateTemp("", "ood-tgts.lock")
 226         if err != nil {
 227                 log.Fatalln(err)
 228         }
 229         if err = os.Remove(FdOODTgtsLock.Name()); err != nil {
 230                 log.Fatalln(err)
 231         }
 232
 233         if v := os.Getenv(EnvOODTgtsFd); v != "" {
 234                 fd := mustParseFd(v, EnvOODTgtsFd)
 235                 fdLock := mustParseFd(v, EnvOODTgtsLockFd)
 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.Fatalln(err)
 242                 }
 243                 if _, err = fd.Seek(0, io.SeekStart); err != nil {
 244                         log.Fatalln(err)
 245                 }
 246                 tgtsRaw, err := io.ReadAll(bufio.NewReader(fd))
 247                 if err != nil {
 248                         log.Fatalln(err)
 249                 }
 250                 flock.Type = unix.F_UNLCK
 251                 if err = unix.FcntlFlock(fdLock.Fd(), unix.F_SETLK, &flock); err != nil {
 252                         log.Fatalln(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.Fatalln(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 || cmdName == CmdNameRedoIfchange {
 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                                 break
 356                         }
 357                         err = ifcreate(fdDep, tgtRel)
 358                         if err != nil {
 359                                 break
 360                         }
 361                 }
 362         case CmdNameRedoAlways:
 363                 if fdDep == nil {
 364                         log.Fatalln("no", EnvDepFd)
 365                 }
 366                 err = always(fdDep)
 367         case CmdNameRedoCleanup:
 368                 for _, what := range tgts {
 369                         err = cleanupWalker(Cwd, what)
 370                         if err != nil {
 371                                 break
 372                         }
 373                 }
 374         case CmdNameRedoDot:
 375                 err = dotPrint(tgts)
 376         case CmdNameRedoStamp:
 377                 if fdDep == nil {
 378                         log.Fatalln("no", EnvDepFd)
 379                 }
 380                 err = stamp(fdDep, os.Stdin)
 381         case CmdNameRedoLog:
 382                 if len(tgts) != 1 {
 383                         log.Fatalln("single target expected")
 384                 }
 385                 d, t := cwdAndTgt(tgts[0])
 386                 err = showBuildLog(d, t, nil, 0)
 387         case CmdNameRedoWhichdo:
 388                 if len(tgts) != 1 {
 389                         log.Fatalln("single target expected")
 390                 }
 391                 var fdTmp *os.File
 392                 fdTmp, err = os.CreateTemp("", "whichdo")
 393                 if err != nil {
 394                         break
 395                 }
 396                 if err = os.Remove(fdTmp.Name()); err != nil {
 397                         break
 398                 }
 399                 cwd, tgt := cwdAndTgt(tgts[0])
 400                 doFile, upLevels, err := findDo(fdTmp, cwd, tgt)
 401                 if err != nil {
 402                         break
 403                 }
 404                 _, err = fdTmp.Seek(0, io.SeekStart)
 405                 if err != nil {
 406                         break
 407                 }
 408                 r := recfile.NewReader(fdTmp)
 409                 for {
 410                         m, err := r.NextMap()
 411                         if err != nil {
 412                                 if errors.Is(err, io.EOF) {
 413                                         break
 414                                 }
 415                                 break CmdSwitch
 416                         }
 417                         fmt.Println(cwdMustRel(cwd, m["Target"]))
 418                 }
 419                 if doFile == "" {
 420                         ok = false
 421                 } else {
 422                         p := make([]string, 0, upLevels+2)
 423                         p = append(p, cwd)
 424                         for i := 0; i < upLevels; i++ {
 425                                 p = append(p, "..")
 426                         }
 427                         p = append(p, doFile)
 428                         rel, err := filepath.Rel(Cwd, path.Join(p...))
 429                         if err != nil {
 430                                 panic(err)
 431                         }
 432                         fmt.Println(rel)
 433                 }
 434         case CmdNameRedoTargets:
 435                 if tgtsWasEmpty {
 436                         tgts = []string{Cwd}
 437                 }
 438                 tgts, err = targetsWalker(tgts)
 439                 if err != nil {
 440                         break
 441                 }
 442                 sort.Strings(tgts)
 443                 for _, tgt := range tgts {
 444                         fmt.Println(tgt)
 445                 }
 446         case CmdNameRedoAffects:
 447                 if tgtsWasEmpty {
 448                         log.Fatalln("no targets specified")
 449                 }
 450                 var tgtsKnown []string
 451                 tgtsKnown, err = targetsWalker([]string{Cwd})
 452                 if err != nil {
 453                         break
 454                 }
 455                 deps := map[string]map[string]struct{}{}
 456                 for _, tgt := range tgtsKnown {
 457                         collectDeps(Cwd, tgt, 0, deps, true)
 458                 }
 459                 seen := map[string]struct{}{}
 460                 for _, tgt := range tgts {
 461                         collectWholeDeps(deps[tgt], deps, seen)
 462                 }
 463                 tgts := make([]string, 0, len(seen))
 464                 for dep := range seen {
 465                         tgts = append(tgts, dep)
 466                 }
 467                 sort.Strings(tgts)
 468                 for _, dep := range tgts {
 469                         fmt.Println(dep)
 470                 }
 471         case CmdNameRedoOOD:
 472                 if tgtsWasEmpty {
 473                         tgts, err = targetsWalker([]string{Cwd})
 474                         if err != nil {
 475                                 break
 476                         }
 477                 }
 478                 sort.Strings(tgts)
 479                 var ood bool
 480                 for _, tgt := range tgts {
 481                         ood, err = isOOD(Cwd, tgt, 0, nil)
 482                         if err != nil {
 483                                 break
 484                         }
 485                         if ood {
 486                                 fmt.Println(tgt)
 487                         }
 488                 }
 489         case CmdNameRedoSources:
 490                 if tgtsWasEmpty {
 491                         tgts, err = targetsWalker([]string{Cwd})
 492                         if err != nil {
 493                                 break
 494                         }
 495                 }
 496                 sort.Strings(tgts)
 497                 var srcs []string
 498                 srcs, err = sourcesWalker(tgts)
 499                 sort.Strings(srcs)
 500                 for _, src := range srcs {
 501                         fmt.Println(src)
 502                 }
 503         case CmdNameRedoDepFix:
 504                 err = depFix(Cwd)
 505         default:
 506                 log.Fatalln("unknown command", cmdName)
 507         }
 508         if err != nil {
 509                 log.Println(err)
 510         }
 511         rc := 0
 512         if !ok || err != nil {
 513                 rc = 1
 514         }
 515         tracef(CDebug, "[%s] finished: %s %s", BuildUUID, cmdName, tgts)
 516         os.Exit(rc)
 517 }