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, "trace current target (sh -x) (set REDO_TRACE=1 for others too)")
  67         flagStderrKeep   = flag.Bool("logs", false, "keep job's stderr (REDO_LOGS=1)")
  68         flagStderrSilent = flag.Bool("silent", false, "do not print job's stderr (REDO_SILENT=1)")
  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                 trace(CDebug, "waiting: %s", tgtOrig)
 197                 Jobs.Add(1)
 198                 go func() {
 199                         defer Jobs.Done()
 200                         trace(CLock, "LOCK_EX: %s", fdLock.Name())
 201                         unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
 202                         lockRelease()
 203                         trace(CDebug, "waiting done: %s", tgtOrig)
 204                         var depInfo *DepInfo
 205                         fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
 206                         if err != nil {
 207                                 if os.IsNotExist(err) {
 208                                         err = errors.New("was not built: no .dep")
 209                                 }
 210                                 goto Finish
 211                         }
 212                         defer fdDep.Close()
 213                         depInfo, err = depRead(fdDep)
 214                         if err != nil {
 215                                 goto Finish
 216                         }
 217                         if depInfo.build != BuildUUID {
 218                                 err = errors.New("was not built: build differs")
 219                         }
 220                 Finish:
 221                         if err != nil {
 222                                 err = TgtErr{tgtOrig, err}
 223                         }
 224                         errs <- err
 225                 }()
 226                 return nil
 227         }
 228
 229         // Check if target is not modified externally
 230         modified, tsPrev, err := isModified(cwd, redoDir, tgt)
 231         if err != nil {
 232                 lockRelease()
 233                 return TgtErr{tgtOrig, err}
 234         }
 235         if modified {
 236                 trace(CWarn, "%s externally modified: not redoing", tgtOrig)
 237                 lockRelease()
 238                 go func() {
 239                         errs <- nil
 240                 }()
 241                 return nil
 242         }
 243
 244         // Start preparing .dep
 245         fdDep, err := tempfile(redoDir, tgt+DepSuffix)
 246         if err != nil {
 247                 lockRelease()
 248                 return TgtErr{tgtOrig, err}
 249         }
 250         cleanup := func() {
 251                 lockRelease()
 252                 fdDep.Close()
 253                 os.Remove(fdDep.Name())
 254         }
 255         if _, err = recfile.NewWriter(fdDep).WriteFields(
 256                 recfile.Field{Name: "Build", Value: BuildUUID},
 257         ); err != nil {
 258                 cleanup()
 259                 return TgtErr{tgtOrig, err}
 260         }
 261
 262         // Find .do
 263         doFile, upLevels, err := findDo(fdDep, cwd, tgt)
 264         if err != nil {
 265                 cleanup()
 266                 return TgtErr{tgtOrig, err}
 267         }
 268         if doFile == "" {
 269                 cleanup()
 270                 return TgtErr{tgtOrig, errors.New("no .do found")}
 271         }
 272         if err = writeDep(fdDep, cwd, doFile); err != nil {
 273                 cleanup()
 274                 return TgtErr{tgtOrig, err}
 275         }
 276
 277         // Determine basename and DIRPREFIX
 278         ents := strings.Split(cwd, "/")
 279         ents = ents[len(ents)-upLevels:]
 280         dirPrefix := path.Join(ents...)
 281         cwdOrig := cwd
 282         for i := 0; i < upLevels; i++ {
 283                 cwd = path.Join(cwd, "..")
 284         }
 285         cwd = path.Clean(cwd)
 286         basename := tgt
 287         runErr := RunErr{Tgt: tgtOrig}
 288         if strings.HasPrefix(doFile, "default.") {
 289                 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
 290                 runErr.DoFile = doFile
 291         }
 292         trace(CWait, "%s", runErr.Name())
 293         doFile = path.Base(doFile)
 294
 295         // Prepare command line
 296         var cmdName string
 297         var args []string
 298         if err = unix.Access(path.Join(cwd, doFile), unix.X_OK); err == nil {
 299                 // Ordinary executable file
 300                 cmdName = doFile
 301                 args = make([]string, 0, 3)
 302         } else {
 303                 fd, err := os.Open(path.Join(cwd, doFile))
 304                 if err != nil {
 305                         cleanup()
 306                         return TgtErr{tgtOrig, err}
 307                 }
 308                 buf := make([]byte, 512)
 309                 n, err := fd.Read(buf)
 310                 if err != nil {
 311                         cleanup()
 312                         return TgtErr{tgtOrig, err}
 313                 }
 314                 if n > 3 && string(buf[:3]) == "#!/" {
 315                         // Shebanged
 316                         t := string(buf[2:n])
 317                         nlIdx := strings.Index(t, "\n")
 318                         if nlIdx == -1 {
 319                                 cleanup()
 320                                 return TgtErr{tgtOrig, errors.New("not fully read shebang")}
 321                         }
 322                         args = strings.Split(t[:nlIdx], " ")
 323                         cmdName, args = args[0], args[1:]
 324                 } else {
 325                         // Shell
 326                         cmdName = "/bin/sh"
 327                         if traced {
 328                                 args = append(args, "-ex")
 329                         } else {
 330                                 args = append(args, "-e")
 331                         }
 332                 }
 333                 args = append(args, doFile)
 334         }
 335
 336         // Temporary file for stdout
 337         fdStdout, err := tempfile(cwd, tgt)
 338         if err != nil {
 339                 cleanup()
 340                 return TgtErr{tgtOrig, err}
 341         }
 342         tmpPath := fdStdout.Name() + ".3" // and for $3
 343         args = append(args, tgt, basename, path.Base(tmpPath))
 344
 345         cmd := exec.Command(cmdName, args...)
 346         cmd.Dir = cwd
 347         cmd.Stdout = fdStdout
 348         cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
 349         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
 350         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
 351
 352         childStderrPrefix := tempsuffix()
 353         cmd.Env = append(cmd.Env, fmt.Sprintf(
 354                 "%s=%s", EnvStderrPrefix, childStderrPrefix,
 355         ))
 356
 357         cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
 358         fdNum := 0
 359         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
 360         fdNum++
 361         if JSR == nil {
 362                 // infinite jobs
 363                 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJSFd))
 364         } else {
 365                 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
 366                 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
 367                 cmd.Env = append(cmd.Env, fmt.Sprintf(
 368                         "%s=%d,%d", EnvJSFd, 3+fdNum+0, 3+fdNum+1,
 369                 ))
 370                 fdNum += 2
 371         }
 372
 373         // Preparing stderr
 374         stderr, err := cmd.StderrPipe()
 375         if err != nil {
 376                 panic(err)
 377         }
 378         var fdStderr *os.File
 379         if StderrKeep {
 380                 fdStderr, err = os.OpenFile(
 381                         path.Join(redoDir, tgt+LogSuffix),
 382                         os.O_WRONLY|os.O_CREATE,
 383                         os.FileMode(0666),
 384                 )
 385                 if err != nil {
 386                         cleanup()
 387                         return TgtErr{tgtOrig, err}
 388                 }
 389                 fdStderr.Truncate(0)
 390         }
 391         shCtx := fmt.Sprintf("sh: %s: %s %s [%s]", tgtOrig, cmdName, args, cwd)
 392         trace(CDebug, "%s", shCtx)
 393
 394         Jobs.Add(1)
 395         go func() {
 396                 jsAcquire(shCtx)
 397                 defer func() {
 398                         jsRelease(shCtx)
 399                         lockRelease()
 400                         fdDep.Close()
 401                         fdStdout.Close()
 402                         if fdStderr != nil {
 403                                 fdStderr.Close()
 404                         }
 405                         os.Remove(fdDep.Name())
 406                         os.Remove(fdStdout.Name())
 407                         os.Remove(tmpPath)
 408                         os.Remove(fdLock.Name())
 409                         Jobs.Done()
 410                 }()
 411                 started := time.Now()
 412                 runErr.Started = &started
 413                 err := cmd.Start()
 414                 if err != nil {
 415                         runErr.Err = err
 416                         errs <- runErr
 417                         return
 418                 }
 419                 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
 420                 trace(CDebug, "%s runs %s", tgtOrig, pid)
 421
 422                 stderrTerm := make(chan struct{}, 0)
 423                 go func() {
 424                         scanner := bufio.NewScanner(stderr)
 425                         var line string
 426                         ts := new(TAI64N)
 427                         for scanner.Scan() {
 428                                 line = scanner.Text()
 429                                 if strings.HasPrefix(line, childStderrPrefix) {
 430                                         line = line[len(childStderrPrefix):]
 431                                         os.Stderr.WriteString(StderrPrefix + line + "\n")
 432                                         continue
 433                                 }
 434                                 if fdStderr != nil {
 435                                         tai64nNow(ts)
 436                                         fmt.Fprintf(fdStderr, "@%s %s\n", hex.EncodeToString(ts[:]), line)
 437                                 }
 438                                 if StderrSilent {
 439                                         continue
 440                                 }
 441                                 if MyPid == 0 {
 442                                         trace(CNone, "%s", line)
 443                                 } else {
 444                                         trace(CNone, "%s %s", pid, line)
 445                                 }
 446                         }
 447                         close(stderrTerm)
 448                 }()
 449
 450                 // Wait for job completion
 451                 <-stderrTerm
 452                 err = cmd.Wait()
 453                 finished := time.Now()
 454                 runErr.Finished = &finished
 455                 if err != nil {
 456                         runErr.Err = err
 457                         errs <- runErr
 458                         return
 459                 }
 460
 461                 // Was $1 touched?
 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                 // Does it produce both stdout and tmp?
 474                 fiStdout, err := os.Stat(fdStdout.Name())
 475                 if err != nil {
 476                         runErr.Err = err
 477                         errs <- runErr
 478                         return
 479                 }
 480                 tmpExists := false
 481                 _, err = os.Stat(tmpPath)
 482                 if err == nil {
 483                         if fiStdout.Size() > 0 {
 484                                 runErr.Err = errors.New("created both tmp and stdout")
 485                                 errs <- runErr
 486                                 return
 487                         }
 488                         tmpExists = true
 489                 } else if !os.IsNotExist(err) {
 490                         runErr.Err = err
 491                         errs <- runErr
 492                         return
 493                 }
 494
 495                 // Determine what file we must process at last
 496                 var fd *os.File
 497                 if tmpExists {
 498                         fd, err = os.Open(tmpPath)
 499                         if err != nil {
 500                                 goto Finish
 501                         }
 502                         defer fd.Close()
 503                 } else if fiStdout.Size() > 0 {
 504                         fd = fdStdout
 505                 }
 506
 507                 // Do we need to ifcreate it, of ifchange with renaming?
 508                 if fd == nil {
 509                         err = ifcreate(fdDep, tgt)
 510                         if err != nil {
 511                                 goto Finish
 512                         }
 513                 } else {
 514                         if !NoSync {
 515                                 err = fd.Sync()
 516                                 if err != nil {
 517                                         goto Finish
 518                                 }
 519                         }
 520                         err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
 521                         if err != nil {
 522                                 goto Finish
 523                         }
 524                         if !NoSync {
 525                                 err = syncDir(cwdOrig)
 526                                 if err != nil {
 527                                         goto Finish
 528                                 }
 529                         }
 530                         err = writeDep(fdDep, cwdOrig, tgt)
 531                         if err != nil {
 532                                 goto Finish
 533                         }
 534                 }
 535
 536                 // Commit .dep
 537                 if !NoSync {
 538                         err = fdDep.Sync()
 539                         if err != nil {
 540                                 goto Finish
 541                         }
 542                 }
 543                 err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
 544                 if err != nil {
 545                         goto Finish
 546                 }
 547                 if !NoSync {
 548                         err = syncDir(redoDir)
 549                         if err != nil {
 550                                 goto Finish
 551                         }
 552                 }
 553         Finish:
 554                 runErr.Err = err
 555                 errs <- runErr
 556         }()
 557         return nil
 558 }
 559
 560 func isOkRun(err error) bool {
 561         if err == nil {
 562                 return true
 563         }
 564         if err, ok := err.(RunErr); ok && err.Err == nil {
 565                 trace(CRedo, "%s", err.Name())
 566                 return true
 567         }
 568         trace(CErr, "%s", err)
 569         return false
 570 }