run.go

   1 /*
   2 goredo -- djb's redo implementation on pure Go
   3 Copyright (C) 2020-2021 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 // Targets runner
  19
  20 package main
  21
  22 import (
  23         "bufio"
  24         "errors"
  25         "flag"
  26         "fmt"
  27         "io"
  28         "os"
  29         "os/exec"
  30         "path"
  31         "path/filepath"
  32         "strings"
  33         "sync"
  34         "syscall"
  35         "time"
  36
  37         "go.cypherpunks.ru/recfile"
  38         "go.cypherpunks.ru/tai64n"
  39         "golang.org/x/sys/unix"
  40 )
  41
  42 const (
  43         EnvDepFd        = "REDO_DEP_FD"
  44         EnvDirPrefix    = "REDO_DIRPREFIX"
  45         EnvBuildUUID    = "REDO_BUILD_UUID"
  46         EnvStderrPrefix = "REDO_STDERR_PREFIX"
  47         EnvTrace        = "REDO_TRACE"
  48         EnvStderrKeep   = "REDO_LOGS"
  49         EnvStderrSilent = "REDO_SILENT"
  50         EnvNoSync       = "REDO_NO_SYNC"
  51
  52         RedoDir    = ".redo"
  53         LockSuffix = ".lock"
  54         DepSuffix  = ".dep"
  55         TmpPrefix  = ".redo."
  56         LogSuffix  = ".log"
  57 )
  58
  59 var (
  60         NoSync       bool = false
  61         StderrKeep   bool = false
  62         StderrSilent bool = false
  63         StderrPrefix string
  64         Jobs         sync.WaitGroup
  65
  66         flagTrace        = flag.Bool("x", false, "trace (sh -x) current targets")
  67         flagTraceAll     = flag.Bool("xx", false, fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
  68         flagStderrKeep   = flag.Bool("logs", false, fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
  69         flagStderrSilent = flag.Bool("silent", false, fmt.Sprintf("do not print job's stderr (%s=1)", EnvStderrSilent))
  70 )
  71
  72 type RunErr struct {
  73         Tgt      string
  74         DoFile   string
  75         Started  *time.Time
  76         Finished *time.Time
  77         Err      error
  78 }
  79
  80 func (e *RunErr) Name() string {
  81         var name string
  82         if e.DoFile == "" {
  83                 name = e.Tgt
  84         } else {
  85                 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
  86         }
  87         if e.Finished == nil {
  88                 return name
  89         }
  90         return fmt.Sprintf("%s (%fsec)", name, e.Finished.Sub(*e.Started).Seconds())
  91 }
  92
  93 func (e RunErr) Error() string {
  94         return fmt.Sprintf("%s: %s", e.Name(), e.Err)
  95 }
  96
  97 func mkdirs(pth string) error {
  98         if _, err := os.Stat(pth); err == nil {
  99                 return nil
 100         }
 101         return os.MkdirAll(pth, os.FileMode(0777))
 102 }
 103
 104 func isModified(cwd, redoDir, tgt string) (bool, *Inode, error) {
 105         fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
 106         if err != nil {
 107                 if os.IsNotExist(err) {
 108                         return false, nil, nil
 109                 }
 110                 return false, nil, err
 111         }
 112         defer fdDep.Close()
 113         r := recfile.NewReader(fdDep)
 114         var ourInode *Inode
 115         for {
 116                 m, err := r.NextMap()
 117                 if err != nil {
 118                         if err == io.EOF {
 119                                 break
 120                         }
 121                         return false, nil, err
 122                 }
 123                 if m["Target"] != tgt {
 124                         continue
 125                 }
 126                 fd, err := os.Open(path.Join(cwd, tgt))
 127                 if err != nil {
 128                         if os.IsNotExist(err) {
 129                                 return false, nil, nil
 130                         }
 131                         return false, nil, err
 132                 }
 133                 ourInode, err = inodeFromFile(fd)
 134                 fd.Close()
 135                 if err != nil {
 136                         return false, nil, err
 137                 }
 138                 theirInode, err := inodeFromRec(m)
 139                 if err != nil {
 140                         return false, nil, err
 141                 }
 142                 if !ourInode.Equals(theirInode) {
 143                         return true, ourInode, nil
 144                 }
 145                 break
 146         }
 147         return false, ourInode, nil
 148 }
 149
 150 func syncDir(dir string) error {
 151         fd, err := os.Open(dir)
 152         if err != nil {
 153                 return err
 154         }
 155         err = fd.Sync()
 156         fd.Close()
 157         return err
 158 }
 159
 160 func runScript(tgtOrig string, errs chan error, traced bool) error {
 161         cwd, tgt := cwdAndTgt(tgtOrig)
 162         redoDir := path.Join(cwd, RedoDir)
 163         if err := mkdirs(redoDir); err != nil {
 164                 return TgtErr{tgtOrig, err}
 165         }
 166
 167         // Acquire lock
 168         fdLock, err := os.OpenFile(
 169                 path.Join(redoDir, tgt+LockSuffix),
 170                 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
 171                 os.FileMode(0666),
 172         )
 173         if err != nil {
 174                 return TgtErr{tgtOrig, err}
 175         }
 176         lockRelease := func() {
 177                 trace(CLock, "LOCK_UN: %s", fdLock.Name())
 178                 unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
 179                 fdLock.Close()
 180         }
 181         trace(CLock, "LOCK_NB: %s", fdLock.Name())
 182
 183         // Waiting for job completion, already taken by someone else
 184         if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
 185                 if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
 186                         fdLock.Close()
 187                         return TgtErr{tgtOrig, err}
 188                 }
 189                 Jobs.Add(1)
 190                 trace(CDebug, "waiting: %s", tgtOrig)
 191                 if FdStatus != nil {
 192                         FdStatus.Write([]byte{StatusWait})
 193                 }
 194                 go func() {
 195                         defer Jobs.Done()
 196                         trace(CLock, "LOCK_EX: %s", fdLock.Name())
 197                         unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
 198                         lockRelease()
 199                         trace(CDebug, "waiting done: %s", tgtOrig)
 200                         if FdStatus != nil {
 201                                 FdStatus.Write([]byte{StatusWaited})
 202                         }
 203                         var depInfo *DepInfo
 204                         fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
 205                         if err != nil {
 206                                 if os.IsNotExist(err) {
 207                                         err = errors.New("was not built: no .dep")
 208                                 }
 209                                 goto Finish
 210                         }
 211                         defer fdDep.Close()
 212                         depInfo, err = depRead(fdDep)
 213                         if err != nil {
 214                                 goto Finish
 215                         }
 216                         if depInfo.build != BuildUUID {
 217                                 err = errors.New("was not built: build differs")
 218                         }
 219                 Finish:
 220                         if err != nil {
 221                                 err = TgtErr{tgtOrig, err}
 222                         }
 223                         errs <- err
 224                 }()
 225                 return nil
 226         }
 227
 228         // Check if target is not modified externally
 229         modified, inodePrev, err := isModified(cwd, redoDir, tgt)
 230         if err != nil {
 231                 lockRelease()
 232                 return TgtErr{tgtOrig, err}
 233         }
 234         if modified {
 235                 trace(CWarn, "%s externally modified: not redoing", tgtOrig)
 236                 lockRelease()
 237                 go func() {
 238                         errs <- nil
 239                 }()
 240                 return nil
 241         }
 242
 243         // Start preparing .dep
 244         fdDep, err := tempfile(redoDir, tgt+DepSuffix)
 245         if err != nil {
 246                 lockRelease()
 247                 return TgtErr{tgtOrig, err}
 248         }
 249         cleanup := func() {
 250                 lockRelease()
 251                 fdDep.Close()
 252                 os.Remove(fdDep.Name())
 253         }
 254         if _, err = recfile.NewWriter(fdDep).WriteFields(
 255                 recfile.Field{Name: "Build", Value: BuildUUID},
 256         ); err != nil {
 257                 cleanup()
 258                 return TgtErr{tgtOrig, err}
 259         }
 260
 261         // Find .do
 262         doFile, upLevels, err := findDo(fdDep, cwd, tgt)
 263         if err != nil {
 264                 cleanup()
 265                 return TgtErr{tgtOrig, err}
 266         }
 267         if doFile == "" {
 268                 cleanup()
 269                 return TgtErr{tgtOrig, errors.New("no .do found")}
 270         }
 271
 272         // Determine basename and DIRPREFIX
 273         doFileRelPath := doFile
 274         ents := strings.Split(cwd, "/")
 275         ents = ents[len(ents)-upLevels:]
 276         dirPrefix := path.Join(ents...)
 277         cwdOrig := cwd
 278         for i := 0; i < upLevels; i++ {
 279                 cwd = path.Join(cwd, "..")
 280                 doFileRelPath = path.Join("..", doFileRelPath)
 281         }
 282         cwd = path.Clean(cwd)
 283         doFilePath := path.Join(cwd, doFile)
 284         basename := tgt
 285         runErr := RunErr{Tgt: tgtOrig}
 286         if strings.HasPrefix(doFile, "default.") {
 287                 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
 288                 runErr.DoFile = doFileRelPath
 289         }
 290
 291         if err = writeDep(fdDep, cwdOrig, doFileRelPath); err != nil {
 292                 cleanup()
 293                 return TgtErr{tgtOrig, err}
 294         }
 295         trace(CWait, "%s", runErr.Name())
 296
 297         // Prepare command line
 298         var cmdName string
 299         var args []string
 300         if err = unix.Access(doFilePath, unix.X_OK); err == nil {
 301                 cmdName = doFilePath
 302                 args = make([]string, 0, 3)
 303         } else {
 304                 cmdName = "/bin/sh"
 305                 if traced {
 306                         args = append(args, "-ex")
 307                 } else {
 308                         args = append(args, "-e")
 309                 }
 310                 args = append(args, doFile)
 311         }
 312
 313         // Temporary file for stdout
 314         fdStdout, err := tempfile(cwdOrig, tgt)
 315         if err != nil {
 316                 cleanup()
 317                 return TgtErr{tgtOrig, err}
 318         }
 319         tmpPath := fdStdout.Name() + ".3" // and for $3
 320         tmpPathRel, err := filepath.Rel(cwd, tmpPath)
 321         if err != nil {
 322                 panic(err)
 323         }
 324         args = append(
 325                 args,
 326                 path.Join(dirPrefix, tgt),
 327                 path.Join(dirPrefix, basename),
 328                 tmpPathRel,
 329         )
 330
 331         cmd := exec.Command(cmdName, args...)
 332         cmd.Dir = cwd
 333         cmd.Stdout = fdStdout
 334         // cmd.Stdin reads from /dev/null by default
 335         cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
 336         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
 337         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
 338
 339         childStderrPrefix := tempsuffix()
 340         cmd.Env = append(cmd.Env, fmt.Sprintf(
 341                 "%s=%s", EnvStderrPrefix, childStderrPrefix,
 342         ))
 343
 344         fdNum := 0
 345         cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
 346         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
 347         fdNum++
 348
 349         if FdStatus == nil {
 350                 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
 351         } else {
 352                 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
 353                 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
 354                 fdNum++
 355         }
 356
 357         if JSR == nil {
 358                 // infinite jobs
 359                 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJSFd))
 360         } else {
 361                 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
 362                 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
 363                 cmd.Env = append(cmd.Env, fmt.Sprintf(
 364                         "%s=%d,%d", EnvJSFd, 3+fdNum+0, 3+fdNum+1,
 365                 ))
 366                 fdNum += 2
 367         }
 368
 369         // Preparing stderr
 370         stderr, err := cmd.StderrPipe()
 371         if err != nil {
 372                 panic(err)
 373         }
 374         var fdStderr *os.File
 375         if StderrKeep {
 376                 fdStderr, err = os.OpenFile(
 377                         path.Join(redoDir, tgt+LogSuffix),
 378                         os.O_WRONLY|os.O_CREATE,
 379                         os.FileMode(0666),
 380                 )
 381                 if err != nil {
 382                         cleanup()
 383                         return TgtErr{tgtOrig, err}
 384                 }
 385                 fdStderr.Truncate(0)
 386         }
 387         shCtx := fmt.Sprintf(
 388                 "sh: %s: %s %s cwd:%s dirprefix:%s",
 389                 tgtOrig, cmdName, args, cwd, dirPrefix,
 390         )
 391         trace(CDebug, "%s", shCtx)
 392
 393         Jobs.Add(1)
 394         go func() {
 395                 jsAcquire(shCtx)
 396                 if FdStatus != nil {
 397                         FdStatus.Write([]byte{StatusRun})
 398                 }
 399                 defer func() {
 400                         jsRelease(shCtx)
 401                         lockRelease()
 402                         fdDep.Close()
 403                         fdStdout.Close()
 404                         if fdStderr != nil {
 405                                 fdStderr.Close()
 406                         }
 407                         os.Remove(fdDep.Name())
 408                         os.Remove(fdStdout.Name())
 409                         os.Remove(tmpPath)
 410                         os.Remove(fdLock.Name())
 411                         if FdStatus != nil {
 412                                 FdStatus.Write([]byte{StatusDone})
 413                         }
 414                         Jobs.Done()
 415                 }()
 416                 started := time.Now()
 417                 runErr.Started = &started
 418                 err := cmd.Start()
 419                 if err != nil {
 420                         runErr.Err = err
 421                         errs <- runErr
 422                         return
 423                 }
 424                 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
 425                 trace(CDebug, "%s runs %s", tgtOrig, pid)
 426
 427                 stderrTerm := make(chan struct{}, 0)
 428                 go func() {
 429                         scanner := bufio.NewScanner(stderr)
 430                         var line string
 431                         ts := new(tai64n.TAI64N)
 432                         for scanner.Scan() {
 433                                 line = scanner.Text()
 434                                 if strings.HasPrefix(line, childStderrPrefix) {
 435                                         line = line[len(childStderrPrefix):]
 436                                         os.Stderr.WriteString(StderrPrefix + line + "\n")
 437                                         continue
 438                                 }
 439                                 if fdStderr != nil {
 440                                         tai64n.FromTime(time.Now(), ts)
 441                                         LogMutex.Lock()
 442                                         fmt.Fprintf(fdStderr, "%s %s\n", ts.Encode(), line)
 443                                         LogMutex.Unlock()
 444                                 }
 445                                 if StderrSilent {
 446                                         continue
 447                                 }
 448                                 if MyPid == 0 {
 449                                         trace(CNone, "%s", line)
 450                                 } else {
 451                                         trace(CNone, "%s %s", pid, line)
 452                                 }
 453                         }
 454                         close(stderrTerm)
 455                 }()
 456
 457                 // Wait for job completion
 458                 <-stderrTerm
 459                 err = cmd.Wait()
 460                 finished := time.Now()
 461                 runErr.Finished = &finished
 462                 if err != nil {
 463                         runErr.Err = err
 464                         errs <- runErr
 465                         return
 466                 }
 467
 468                 // Was $1 touched?
 469                 if inodePrev != nil {
 470                         if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
 471                                 inode, err := inodeFromFile(fd)
 472                                 fd.Close()
 473                                 if err == nil && !inode.Equals(inodePrev) {
 474                                         runErr.Err = errors.New("$1 was explicitly touched")
 475                                         errs <- runErr
 476                                         fd.Close()
 477                                         return
 478                                 }
 479                         }
 480                 }
 481
 482                 // Does it produce both stdout and tmp?
 483                 fiStdout, err := os.Stat(fdStdout.Name())
 484                 if err != nil {
 485                         runErr.Err = err
 486                         errs <- runErr
 487                         return
 488                 }
 489                 tmpExists := false
 490                 _, err = os.Stat(tmpPath)
 491                 if err == nil {
 492                         if fiStdout.Size() > 0 {
 493                                 runErr.Err = errors.New("created both tmp and stdout")
 494                                 errs <- runErr
 495                                 return
 496                         }
 497                         tmpExists = true
 498                 } else if !os.IsNotExist(err) {
 499                         runErr.Err = err
 500                         errs <- runErr
 501                         return
 502                 }
 503
 504                 // Determine what file we must process at last
 505                 var fd *os.File
 506                 if tmpExists {
 507                         fd, err = os.Open(tmpPath)
 508                         if err != nil {
 509                                 goto Finish
 510                         }
 511                         defer fd.Close()
 512                 } else if fiStdout.Size() > 0 {
 513                         fd = fdStdout
 514                 }
 515
 516                 // Do we need to ifcreate it, of ifchange with renaming?
 517                 if fd == nil {
 518                         os.Remove(path.Join(cwdOrig, tgt))
 519                         err = ifcreate(fdDep, tgt)
 520                         if err != nil {
 521                                 goto Finish
 522                         }
 523                 } else {
 524                         if !NoSync {
 525                                 err = fd.Sync()
 526                                 if err != nil {
 527                                         goto Finish
 528                                 }
 529                         }
 530                         err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
 531                         if err != nil {
 532                                 goto Finish
 533                         }
 534                         if !NoSync {
 535                                 err = syncDir(cwdOrig)
 536                                 if err != nil {
 537                                         goto Finish
 538                                 }
 539                         }
 540                         err = writeDep(fdDep, cwdOrig, tgt)
 541                         if err != nil {
 542                                 goto Finish
 543                         }
 544                 }
 545
 546                 // Commit .dep
 547                 if !NoSync {
 548                         err = fdDep.Sync()
 549                         if err != nil {
 550                                 goto Finish
 551                         }
 552                 }
 553                 err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
 554                 if err != nil {
 555                         goto Finish
 556                 }
 557                 if !NoSync {
 558                         err = syncDir(redoDir)
 559                         if err != nil {
 560                                 goto Finish
 561                         }
 562                 }
 563         Finish:
 564                 runErr.Err = err
 565                 errs <- runErr
 566         }()
 567         return nil
 568 }
 569
 570 func isOkRun(err error) bool {
 571         if err == nil {
 572                 return true
 573         }
 574         if err, ok := err.(RunErr); ok && err.Err == nil {
 575                 trace(CRedo, "%s", err.Name())
 576                 return true
 577         }
 578         trace(CErr, "%s", err)
 579         return false
 580 }