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