run.go

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