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