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         EnvStampPrev    = "REDO_STAMP_PREV"
  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         StampPrev    string
  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, 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         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, nil
 151                 }
 152                 break
 153         }
 154         return false, 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, stampPrev string) 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, 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                 errs <- nil
 239                 return TgtErr{tgtOrig, err}
 240         }
 241
 242         // Start preparing .dep
 243         fdDep, err := tempfile(redoDir, tgt+DepSuffix)
 244         if err != nil {
 245                 lockRelease()
 246                 return TgtErr{tgtOrig, err}
 247         }
 248         cleanup := func() {
 249                 lockRelease()
 250                 fdDep.Close()
 251                 os.Remove(fdDep.Name())
 252         }
 253         if _, err = recfile.NewWriter(fdDep).WriteFields(
 254                 recfile.Field{Name: "Build", Value: BuildUUID},
 255         ); err != nil {
 256                 cleanup()
 257                 return TgtErr{tgtOrig, err}
 258         }
 259
 260         // Find .do
 261         doFile, upLevels, err := findDo(fdDep, cwd, tgt)
 262         if err != nil {
 263                 cleanup()
 264                 return TgtErr{tgtOrig, err}
 265         }
 266         if doFile == "" {
 267                 cleanup()
 268                 return TgtErr{tgtOrig, errors.New("no .do found")}
 269         }
 270         if err = writeDep(fdDep, cwd, doFile); err != nil {
 271                 cleanup()
 272                 return TgtErr{tgtOrig, err}
 273         }
 274
 275         // Determine basename and DIRPREFIX
 276         ents := strings.Split(cwd, "/")
 277         ents = ents[len(ents)-upLevels:]
 278         dirPrefix := path.Join(ents...)
 279         cwdOrig := cwd
 280         for i := 0; i < upLevels; i++ {
 281                 cwd = path.Join(cwd, "..")
 282         }
 283         cwd = path.Clean(cwd)
 284         basename := tgt
 285         runErr := RunErr{Tgt: tgtOrig}
 286         if strings.HasPrefix(doFile, "default.") {
 287                 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
 288                 runErr.DoFile = doFile
 289         }
 290         trace(CWait, "%s", runErr.Name())
 291         doFile = path.Base(doFile)
 292
 293         // Prepare command line
 294         var cmdName string
 295         var args []string
 296         if err = unix.Access(path.Join(cwd, doFile), unix.X_OK); err == nil {
 297                 // Ordinary executable file
 298                 cmdName = doFile
 299                 args = make([]string, 0, 3)
 300         } else {
 301                 fd, err := os.Open(path.Join(cwd, doFile))
 302                 if err != nil {
 303                         cleanup()
 304                         return TgtErr{tgtOrig, err}
 305                 }
 306                 buf := make([]byte, 512)
 307                 n, err := fd.Read(buf)
 308                 if err != nil {
 309                         cleanup()
 310                         return TgtErr{tgtOrig, err}
 311                 }
 312                 if n > 3 && string(buf[:3]) == "#!/" {
 313                         // Shebanged
 314                         t := string(buf[2:n])
 315                         nlIdx := strings.Index(t, "\n")
 316                         if nlIdx == -1 {
 317                                 cleanup()
 318                                 return TgtErr{tgtOrig, errors.New("not fully read shebang")}
 319                         }
 320                         args = strings.Split(t[:nlIdx], " ")
 321                         cmdName, args = args[0], args[1:]
 322                 } else {
 323                         // Shell
 324                         cmdName = "/bin/sh"
 325                         if Trace {
 326                                 args = append(args, "-ex")
 327                         } else {
 328                                 args = append(args, "-e")
 329                         }
 330                 }
 331                 args = append(args, doFile)
 332         }
 333
 334         // Temporary file for stdout
 335         fdStdout, err := tempfile(cwd, tgt)
 336         if err != nil {
 337                 cleanup()
 338                 return TgtErr{tgtOrig, err}
 339         }
 340         tmpPath := fdStdout.Name() + ".3" // and for $3
 341         args = append(args, tgt, basename, path.Base(tmpPath))
 342
 343         cmd := exec.Command(cmdName, args...)
 344         cmd.Dir = cwd
 345         cmd.Stdout = fdStdout
 346         cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
 347         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
 348         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
 349
 350         if stampPrev != "" {
 351                 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvStampPrev, stampPrev))
 352         }
 353
 354         childStderrPrefix := tempsuffix()
 355         cmd.Env = append(cmd.Env, fmt.Sprintf(
 356                 "%s=%s", EnvStderrPrefix, childStderrPrefix,
 357         ))
 358
 359         cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
 360         fdNum := 0
 361         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
 362         fdNum++
 363         if JSR == nil {
 364                 // infinite jobs
 365                 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJSFd))
 366         } else {
 367                 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
 368                 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
 369                 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d,%d", EnvJSFd, 3+fdNum+0, 3+fdNum+1))
 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                 // Does it produce both stdout and tmp?
 462                 fiStdout, err := os.Stat(fdStdout.Name())
 463                 if err != nil {
 464                         runErr.Err = err
 465                         errs <- runErr
 466                         return
 467                 }
 468                 tmpExists := false
 469                 _, err = os.Stat(tmpPath)
 470                 if err == nil {
 471                         if fiStdout.Size() > 0 {
 472                                 runErr.Err = errors.New("created both tmp and stdout")
 473                                 errs <- runErr
 474                                 return
 475                         }
 476                         tmpExists = true
 477                 } else if !os.IsNotExist(err) {
 478                         runErr.Err = err
 479                         errs <- runErr
 480                         return
 481                 }
 482
 483                 // Determine what file we must process at last
 484                 var fd *os.File
 485                 if tmpExists {
 486                         fd, err = os.Open(tmpPath)
 487                         if err != nil {
 488                                 goto Finish
 489                         }
 490                         defer fd.Close()
 491                 } else if fiStdout.Size() > 0 {
 492                         fd = fdStdout
 493                 }
 494
 495                 // Do we need to ifcreate it, of ifchange with renaming?
 496                 if fd == nil {
 497                         err = ifcreate(fdDep, tgt)
 498                         if err != nil {
 499                                 goto Finish
 500                         }
 501                 } else {
 502                         if !NoSync {
 503                                 err = fd.Sync()
 504                                 if err != nil {
 505                                         goto Finish
 506                                 }
 507                         }
 508                         err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
 509                         if err != nil {
 510                                 goto Finish
 511                         }
 512                         if !NoSync {
 513                                 err = syncDir(cwdOrig)
 514                                 if err != nil {
 515                                         goto Finish
 516                                 }
 517                         }
 518                         err = writeDep(fdDep, cwdOrig, tgt)
 519                         if err != nil {
 520                                 goto Finish
 521                         }
 522                 }
 523
 524                 // Commit .dep
 525                 if !NoSync {
 526                         err = fdDep.Sync()
 527                         if err != nil {
 528                                 goto Finish
 529                         }
 530                 }
 531                 err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
 532                 if err != nil {
 533                         goto Finish
 534                 }
 535                 if !NoSync {
 536                         err = syncDir(redoDir)
 537                         if err != nil {
 538                                 goto Finish
 539                         }
 540                 }
 541         Finish:
 542                 runErr.Err = err
 543                 errs <- runErr
 544         }()
 545         return nil
 546 }