run.go

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