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         "strings"
  33         "sync"
  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         NoSync       bool = false
  60         StderrKeep   bool = false
  61         StderrSilent bool = false
  62         StderrPrefix string
  63         Jobs         sync.WaitGroup
  64
  65         flagTrace        = flag.Bool("x", false, fmt.Sprintf("trace current target (sh -x) (set %s=1 for all others)", EnvTrace))
  66         flagStderrKeep   = flag.Bool("logs", false, fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
  67         flagStderrSilent = flag.Bool("silent", false, fmt.Sprintf("do not print job's stderr (%s=1)", EnvStderrSilent))
  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 isModified(cwd, redoDir, tgt string) (bool, string, error) {
 105         fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
 106         if err != nil {
 107                 if os.IsNotExist(err) {
 108                         return false, "", nil
 109                 }
 110                 return false, "", err
 111         }
 112         defer fdDep.Close()
 113         r := recfile.NewReader(fdDep)
 114         var ourTs string
 115         for {
 116                 m, err := r.NextMap()
 117                 if err != nil {
 118                         if err == io.EOF {
 119                                 break
 120                         }
 121                         return false, "", err
 122                 }
 123                 if m["Target"] != tgt {
 124                         continue
 125                 }
 126                 fd, err := os.Open(path.Join(cwd, tgt))
 127                 if err != nil {
 128                         if os.IsNotExist(err) {
 129                                 return false, "", nil
 130                         }
 131                         return false, "", err
 132                 }
 133                 defer fd.Close()
 134                 ourTs, err = fileCtime(fd)
 135                 if err != nil {
 136                         return false, "", err
 137                 }
 138                 if ourTs != m["Ctime"] {
 139                         return true, ourTs, nil
 140                 }
 141                 break
 142         }
 143         return false, ourTs, nil
 144 }
 145
 146 func syncDir(dir string) error {
 147         fd, err := os.Open(dir)
 148         if err != nil {
 149                 return err
 150         }
 151         err = fd.Sync()
 152         fd.Close()
 153         return err
 154 }
 155
 156 func runScript(tgtOrig string, errs chan error, traced bool) error {
 157         cwd, tgt := cwdAndTgt(tgtOrig)
 158         redoDir := path.Join(cwd, RedoDir)
 159         if err := mkdirs(redoDir); err != nil {
 160                 return TgtErr{tgtOrig, err}
 161         }
 162
 163         // Acquire lock
 164         fdLock, err := os.OpenFile(
 165                 path.Join(redoDir, tgt+LockSuffix),
 166                 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
 167                 os.FileMode(0666),
 168         )
 169         if err != nil {
 170                 return TgtErr{tgtOrig, err}
 171         }
 172         lockRelease := func() {
 173                 trace(CLock, "LOCK_UN: %s", fdLock.Name())
 174                 unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
 175                 fdLock.Close()
 176         }
 177         trace(CLock, "LOCK_NB: %s", fdLock.Name())
 178
 179         // Waiting for job completion, already taken by someone else
 180         if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
 181                 if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
 182                         fdLock.Close()
 183                         return TgtErr{tgtOrig, err}
 184                 }
 185                 Jobs.Add(1)
 186                 trace(CDebug, "waiting: %s", tgtOrig)
 187                 if FdStatus != nil {
 188                         FdStatus.Write([]byte{StatusWait})
 189                 }
 190                 go func() {
 191                         defer Jobs.Done()
 192                         trace(CLock, "LOCK_EX: %s", fdLock.Name())
 193                         unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
 194                         lockRelease()
 195                         trace(CDebug, "waiting done: %s", tgtOrig)
 196                         if FdStatus != nil {
 197                                 FdStatus.Write([]byte{StatusWaited})
 198                         }
 199                         var depInfo *DepInfo
 200                         fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
 201                         if err != nil {
 202                                 if os.IsNotExist(err) {
 203                                         err = errors.New("was not built: no .dep")
 204                                 }
 205                                 goto Finish
 206                         }
 207                         defer fdDep.Close()
 208                         depInfo, err = depRead(fdDep)
 209                         if err != nil {
 210                                 goto Finish
 211                         }
 212                         if depInfo.build != BuildUUID {
 213                                 err = errors.New("was not built: build differs")
 214                         }
 215                 Finish:
 216                         if err != nil {
 217                                 err = TgtErr{tgtOrig, err}
 218                         }
 219                         errs <- err
 220                 }()
 221                 return nil
 222         }
 223
 224         // Check if target is not modified externally
 225         modified, tsPrev, err := isModified(cwd, redoDir, tgt)
 226         if err != nil {
 227                 lockRelease()
 228                 return TgtErr{tgtOrig, err}
 229         }
 230         if modified {
 231                 trace(CWarn, "%s externally modified: not redoing", tgtOrig)
 232                 lockRelease()
 233                 go func() {
 234                         errs <- nil
 235                 }()
 236                 return nil
 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
 268         // Determine basename and DIRPREFIX
 269         ents := strings.Split(cwd, "/")
 270         ents = ents[len(ents)-upLevels:]
 271         dirPrefix := path.Join(ents...)
 272         cwdOrig := cwd
 273         for i := 0; i < upLevels; i++ {
 274                 cwd = path.Join(cwd, "..")
 275         }
 276         cwd = path.Clean(cwd)
 277         doFilePath := path.Join(cwd, doFile)
 278         basename := tgt
 279         runErr := RunErr{Tgt: tgtOrig}
 280         if strings.HasPrefix(doFile, "default.") {
 281                 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
 282                 runErr.DoFile = doFile
 283         }
 284
 285         if err = writeDep(fdDep, cwd, doFile); err != nil {
 286                 cleanup()
 287                 return TgtErr{tgtOrig, err}
 288         }
 289         trace(CWait, "%s", runErr.Name())
 290
 291         // Prepare command line
 292         var cmdName string
 293         var args []string
 294         if err = unix.Access(doFilePath, unix.X_OK); err == nil {
 295                 cmdName = doFilePath
 296                 args = make([]string, 0, 3)
 297         } else {
 298                 cmdName = "/bin/sh"
 299                 if traced {
 300                         args = append(args, "-ex")
 301                 } else {
 302                         args = append(args, "-e")
 303                 }
 304                 args = append(args, doFile)
 305         }
 306
 307         // Temporary file for stdout
 308         fdStdout, err := tempfile(cwd, tgt)
 309         if err != nil {
 310                 cleanup()
 311                 return TgtErr{tgtOrig, err}
 312         }
 313         tmpPath := fdStdout.Name() + ".3" // and for $3
 314         args = append(args, tgt, basename, path.Base(tmpPath))
 315
 316         cmd := exec.Command(cmdName, args...)
 317         cmd.Dir = cwd
 318         cmd.Stdout = fdStdout
 319         cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
 320         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
 321         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
 322
 323         childStderrPrefix := tempsuffix()
 324         cmd.Env = append(cmd.Env, fmt.Sprintf(
 325                 "%s=%s", EnvStderrPrefix, childStderrPrefix,
 326         ))
 327
 328         fdNum := 0
 329         cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
 330         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
 331         fdNum++
 332
 333         if FdStatus == nil {
 334                 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
 335         } else {
 336                 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
 337                 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
 338                 fdNum++
 339         }
 340
 341         if JSR == nil {
 342                 // infinite jobs
 343                 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJSFd))
 344         } else {
 345                 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
 346                 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
 347                 cmd.Env = append(cmd.Env, fmt.Sprintf(
 348                         "%s=%d,%d", EnvJSFd, 3+fdNum+0, 3+fdNum+1,
 349                 ))
 350                 fdNum += 2
 351         }
 352
 353         // Preparing stderr
 354         stderr, err := cmd.StderrPipe()
 355         if err != nil {
 356                 panic(err)
 357         }
 358         var fdStderr *os.File
 359         if StderrKeep {
 360                 fdStderr, err = os.OpenFile(
 361                         path.Join(redoDir, tgt+LogSuffix),
 362                         os.O_WRONLY|os.O_CREATE,
 363                         os.FileMode(0666),
 364                 )
 365                 if err != nil {
 366                         cleanup()
 367                         return TgtErr{tgtOrig, err}
 368                 }
 369                 fdStderr.Truncate(0)
 370         }
 371         shCtx := fmt.Sprintf("sh: %s: %s %s [%s]", tgtOrig, cmdName, args, cwd)
 372         trace(CDebug, "%s", shCtx)
 373
 374         Jobs.Add(1)
 375         go func() {
 376                 jsAcquire(shCtx)
 377                 if FdStatus != nil {
 378                         FdStatus.Write([]byte{StatusRun})
 379                 }
 380                 defer func() {
 381                         jsRelease(shCtx)
 382                         lockRelease()
 383                         fdDep.Close()
 384                         fdStdout.Close()
 385                         if fdStderr != nil {
 386                                 fdStderr.Close()
 387                         }
 388                         os.Remove(fdDep.Name())
 389                         os.Remove(fdStdout.Name())
 390                         os.Remove(tmpPath)
 391                         os.Remove(fdLock.Name())
 392                         if FdStatus != nil {
 393                                 FdStatus.Write([]byte{StatusDone})
 394                         }
 395                         Jobs.Done()
 396                 }()
 397                 started := time.Now()
 398                 runErr.Started = &started
 399                 err := cmd.Start()
 400                 if err != nil {
 401                         runErr.Err = err
 402                         errs <- runErr
 403                         return
 404                 }
 405                 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
 406                 trace(CDebug, "%s runs %s", tgtOrig, pid)
 407
 408                 stderrTerm := make(chan struct{}, 0)
 409                 go func() {
 410                         scanner := bufio.NewScanner(stderr)
 411                         var line string
 412                         ts := new(TAI64N)
 413                         for scanner.Scan() {
 414                                 line = scanner.Text()
 415                                 if strings.HasPrefix(line, childStderrPrefix) {
 416                                         line = line[len(childStderrPrefix):]
 417                                         os.Stderr.WriteString(StderrPrefix + line + "\n")
 418                                         continue
 419                                 }
 420                                 if fdStderr != nil {
 421                                         tai64nNow(ts)
 422                                         LogMutex.Lock()
 423                                         fmt.Fprintf(fdStderr, "@%s %s\n", hex.EncodeToString(ts[:]), line)
 424                                         LogMutex.Unlock()
 425                                 }
 426                                 if StderrSilent {
 427                                         continue
 428                                 }
 429                                 if MyPid == 0 {
 430                                         trace(CNone, "%s", line)
 431                                 } else {
 432                                         trace(CNone, "%s %s", pid, line)
 433                                 }
 434                         }
 435                         close(stderrTerm)
 436                 }()
 437
 438                 // Wait for job completion
 439                 <-stderrTerm
 440                 err = cmd.Wait()
 441                 finished := time.Now()
 442                 runErr.Finished = &finished
 443                 if err != nil {
 444                         runErr.Err = err
 445                         errs <- runErr
 446                         return
 447                 }
 448
 449                 // Was $1 touched?
 450                 if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
 451                         ts, err := fileCtime(fd)
 452                         fd.Close()
 453                         if err == nil && ts != tsPrev {
 454                                 runErr.Err = errors.New("$1 was explicitly touched")
 455                                 errs <- runErr
 456                                 fd.Close()
 457                                 return
 458                         }
 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 }
 547
 548 func isOkRun(err error) bool {
 549         if err == nil {
 550                 return true
 551         }
 552         if err, ok := err.(RunErr); ok && err.Err == nil {
 553                 trace(CRedo, "%s", err.Name())
 554                 return true
 555         }
 556         trace(CErr, "%s", err)
 557         return false
 558 }