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(tgtOrig string, errs chan error) error {
 166         cwd, tgt := cwdAndTgt(tgtOrig)
 167         redoDir := path.Join(cwd, RedoDir)
 168         if err := mkdirs(redoDir); err != nil {
 169                 return TgtErr{tgtOrig, err}
 170         }
 171
 172         // Acquire lock
 173         fdLock, err := os.OpenFile(
 174                 path.Join(redoDir, tgt+LockSuffix),
 175                 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
 176                 os.FileMode(0666),
 177         )
 178         if err != nil {
 179                 return TgtErr{tgtOrig, err}
 180         }
 181         lockRelease := func() {
 182                 trace(CLock, "LOCK_UN: %s", fdLock.Name())
 183                 unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
 184                 fdLock.Close()
 185         }
 186         trace(CLock, "LOCK_NB: %s", fdLock.Name())
 187
 188         // Waiting for job completion, already taken by someone else
 189         if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
 190                 if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
 191                         fdLock.Close()
 192                         return TgtErr{tgtOrig, err}
 193                 }
 194                 trace(CDebug, "waiting: %s", tgtOrig)
 195                 Jobs.Add(1)
 196                 go func() {
 197                         defer Jobs.Done()
 198                         trace(CLock, "LOCK_EX: %s", fdLock.Name())
 199                         unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
 200                         lockRelease()
 201                         trace(CDebug, "waiting done: %s", tgtOrig)
 202                         var builtNow bool
 203                         fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
 204                         if err != nil {
 205                                 if os.IsNotExist(err) {
 206                                         err = errors.New("was not built")
 207                                 }
 208                                 goto Finish
 209                         }
 210                         builtNow, _, err = isBuiltNow(fdDep)
 211                         if err != nil {
 212                                 goto Finish
 213                         }
 214                         if !builtNow {
 215                                 err = errors.New("was not built")
 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, 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                 errs <- nil
 236                 return TgtErr{tgtOrig, err}
 237         }
 238
 239         // Start preparing .dep
 240         fdDep, err := tempfile(redoDir, tgt+DepSuffix)
 241         if err != nil {
 242                 lockRelease()
 243                 return TgtErr{tgtOrig, err}
 244         }
 245         cleanup := func() {
 246                 lockRelease()
 247                 fdDep.Close()
 248                 os.Remove(fdDep.Name())
 249         }
 250         if _, err = recfile.NewWriter(fdDep).WriteFields(
 251                 recfile.Field{Name: "Build", Value: BuildUUID},
 252         ); err != nil {
 253                 cleanup()
 254                 return TgtErr{tgtOrig, err}
 255         }
 256
 257         // Find .do
 258         doFile, upLevels, err := findDo(fdDep, cwd, tgt)
 259         if err != nil {
 260                 cleanup()
 261                 return TgtErr{tgtOrig, err}
 262         }
 263         if doFile == "" {
 264                 cleanup()
 265                 return TgtErr{tgtOrig, errors.New("no .do found")}
 266         }
 267         if err = writeDep(fdDep, cwd, doFile); err != nil {
 268                 cleanup()
 269                 return TgtErr{tgtOrig, err}
 270         }
 271
 272         // Determine basename and DIRPREFIX
 273         ents := strings.Split(cwd, "/")
 274         ents = ents[len(ents)-upLevels:]
 275         dirPrefix := path.Join(ents...)
 276         cwdOrig := cwd
 277         for i := 0; i < upLevels; i++ {
 278                 cwd = path.Join(cwd, "..")
 279         }
 280         cwd = path.Clean(cwd)
 281         basename := tgt
 282         runErr := RunErr{Tgt: tgtOrig}
 283         if strings.HasPrefix(doFile, "default.") {
 284                 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
 285                 runErr.DoFile = doFile
 286         }
 287         trace(CWait, "%s", runErr.Name())
 288         doFile = path.Base(doFile)
 289
 290         // Prepare command line
 291         var cmdName string
 292         var args []string
 293         if err = unix.Access(path.Join(cwd, doFile), unix.X_OK); err == nil {
 294                 // Ordinary executable file
 295                 cmdName = doFile
 296                 args = make([]string, 0, 3)
 297         } else {
 298                 fd, err := os.Open(path.Join(cwd, doFile))
 299                 if err != nil {
 300                         cleanup()
 301                         return TgtErr{tgtOrig, err}
 302                 }
 303                 buf := make([]byte, 512)
 304                 n, err := fd.Read(buf)
 305                 if err != nil {
 306                         cleanup()
 307                         return TgtErr{tgtOrig, err}
 308                 }
 309                 if n > 3 && string(buf[:3]) == "#!/" {
 310                         // Shebanged
 311                         t := string(buf[2:n])
 312                         nlIdx := strings.Index(t, "\n")
 313                         if nlIdx == -1 {
 314                                 cleanup()
 315                                 return TgtErr{tgtOrig, errors.New("not fully read shebang")}
 316                         }
 317                         args = strings.Split(t[:nlIdx], " ")
 318                         cmdName, args = args[0], args[1:]
 319                 } else {
 320                         // Shell
 321                         cmdName = "/bin/sh"
 322                         if Trace {
 323                                 args = append(args, "-ex")
 324                         } else {
 325                                 args = append(args, "-e")
 326                         }
 327                 }
 328                 args = append(args, doFile)
 329         }
 330
 331         // Temporary file for stdout
 332         fdStdout, err := tempfile(cwd, tgt)
 333         if err != nil {
 334                 cleanup()
 335                 return TgtErr{tgtOrig, err}
 336         }
 337         tmpPath := fdStdout.Name() + ".3" // and for $3
 338         args = append(args, tgt, basename, path.Base(tmpPath))
 339
 340         cmd := exec.Command(cmdName, args...)
 341         cmd.Dir = cwd
 342         cmd.Stdout = fdStdout
 343         cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
 344         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
 345         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
 346         childStderrPrefix := tempsuffix()
 347         cmd.Env = append(cmd.Env, fmt.Sprintf(
 348                 "%s=%s", EnvStderrPrefix, childStderrPrefix,
 349         ))
 350
 351         cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
 352         fdNum := 0
 353         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
 354         fdNum++
 355         if JSR == nil {
 356                 // infinite jobs
 357                 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJSFd))
 358         } else {
 359                 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
 360                 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
 361                 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d,%d", EnvJSFd, 3+fdNum+0, 3+fdNum+1))
 362                 fdNum += 2
 363         }
 364
 365         // Preparing stderr
 366         stderr, err := cmd.StderrPipe()
 367         if err != nil {
 368                 panic(err)
 369         }
 370         var fdStderr *os.File
 371         if StderrKeep {
 372                 fdStderr, err = os.OpenFile(
 373                         path.Join(redoDir, tgt+LogSuffix),
 374                         os.O_WRONLY|os.O_CREATE,
 375                         os.FileMode(0666),
 376                 )
 377                 if err != nil {
 378                         cleanup()
 379                         return TgtErr{tgtOrig, err}
 380                 }
 381                 fdStderr.Truncate(0)
 382         }
 383         shCtx := fmt.Sprintf("sh: %s: %s %s [%s]", tgtOrig, cmdName, args, cwd)
 384         trace(CDebug, "%s", shCtx)
 385
 386         Jobs.Add(1)
 387         go func() {
 388                 jsAcquire(shCtx)
 389                 defer func() {
 390                         jsRelease(shCtx)
 391                         lockRelease()
 392                         fdDep.Close()
 393                         fdStdout.Close()
 394                         if fdStderr != nil {
 395                                 fdStderr.Close()
 396                         }
 397                         os.Remove(fdDep.Name())
 398                         os.Remove(fdStdout.Name())
 399                         os.Remove(tmpPath)
 400                         os.Remove(fdLock.Name())
 401                         Jobs.Done()
 402                 }()
 403                 started := time.Now()
 404                 runErr.Started = &started
 405                 err := cmd.Start()
 406                 if err != nil {
 407                         runErr.Err = err
 408                         errs <- runErr
 409                         return
 410                 }
 411                 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
 412                 trace(CDebug, "%s runs %s", tgtOrig, pid)
 413
 414                 stderrTerm := make(chan struct{}, 0)
 415                 go func() {
 416                         scanner := bufio.NewScanner(stderr)
 417                         var line string
 418                         ts := new(TAI64N)
 419                         for scanner.Scan() {
 420                                 line = scanner.Text()
 421                                 if strings.HasPrefix(line, childStderrPrefix) {
 422                                         line = line[len(childStderrPrefix):]
 423                                         os.Stderr.WriteString(StderrPrefix + line + "\n")
 424                                         continue
 425                                 }
 426                                 if fdStderr != nil {
 427                                         tai64nNow(ts)
 428                                         fmt.Fprintf(fdStderr, "@%s %s\n", hex.EncodeToString(ts[:]), line)
 429                                 }
 430                                 if StderrSilent {
 431                                         continue
 432                                 }
 433                                 if MyPid == 0 {
 434                                         trace(CNone, "%s", line)
 435                                 } else {
 436                                         trace(CNone, "%s %s", pid, line)
 437                                 }
 438                         }
 439                         close(stderrTerm)
 440                 }()
 441
 442                 // Wait for job completion
 443                 <-stderrTerm
 444                 err = cmd.Wait()
 445                 finished := time.Now()
 446                 runErr.Finished = &finished
 447                 if err != nil {
 448                         runErr.Err = err
 449                         errs <- runErr
 450                         return
 451                 }
 452
 453                 // Does it produce both stdout and tmp?
 454                 fiStdout, err := os.Stat(fdStdout.Name())
 455                 if err != nil {
 456                         runErr.Err = err
 457                         errs <- runErr
 458                         return
 459                 }
 460                 tmpExists := false
 461                 _, err = os.Stat(tmpPath)
 462                 if err == nil {
 463                         if fiStdout.Size() > 0 {
 464                                 runErr.Err = errors.New("created both tmp and stdout")
 465                                 errs <- runErr
 466                                 return
 467                         }
 468                         tmpExists = true
 469                 } else if !os.IsNotExist(err) {
 470                         runErr.Err = err
 471                         errs <- runErr
 472                         return
 473                 }
 474
 475                 // Determine what file we must process at last
 476                 var fd *os.File
 477                 if tmpExists {
 478                         fd, err = os.Open(tmpPath)
 479                         if err != nil {
 480                                 goto Finish
 481                         }
 482                         defer fd.Close()
 483                 } else if fiStdout.Size() > 0 {
 484                         fd = fdStdout
 485                 }
 486
 487                 // Do we need to ifcreate it, of ifchange with renaming?
 488                 if fd == nil {
 489                         err = ifcreate(fdDep, tgt)
 490                         if err != nil {
 491                                 goto Finish
 492                         }
 493                 } else {
 494                         if !NoSync {
 495                                 err = fd.Sync()
 496                                 if err != nil {
 497                                         goto Finish
 498                                 }
 499                         }
 500                         err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
 501                         if err != nil {
 502                                 goto Finish
 503                         }
 504                         if !NoSync {
 505                                 err = syncDir(cwdOrig)
 506                                 if err != nil {
 507                                         goto Finish
 508                                 }
 509                         }
 510                         err = writeDep(fdDep, cwdOrig, tgt)
 511                         if err != nil {
 512                                 goto Finish
 513                         }
 514                 }
 515
 516                 // Commit .dep
 517                 if !NoSync {
 518                         err = fdDep.Sync()
 519                         if err != nil {
 520                                 goto Finish
 521                         }
 522                 }
 523                 err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
 524                 if err != nil {
 525                         goto Finish
 526                 }
 527                 if !NoSync {
 528                         err = syncDir(redoDir)
 529                         if err != nil {
 530                                 goto Finish
 531                         }
 532                 }
 533         Finish:
 534                 runErr.Err = err
 535                 errs <- runErr
 536         }()
 537         return nil
 538 }