]> Cypherpunks.ru repositories - goredo.git/blob - run.go
Collision resistant .log-rec extension
[goredo.git] / run.go
1 /*
2 goredo -- djb's redo implementation on pure Go
3 Copyright (C) 2020-2021 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         "errors"
25         "flag"
26         "fmt"
27         "io"
28         "log"
29         "os"
30         "os/exec"
31         "path"
32         "path/filepath"
33         "strconv"
34         "strings"
35         "sync"
36         "syscall"
37         "time"
38
39         "go.cypherpunks.ru/recfile"
40         "go.cypherpunks.ru/tai64n/v2"
41         "golang.org/x/sys/unix"
42 )
43
44 const (
45         EnvDepFd        = "REDO_DEP_FD"
46         EnvDirPrefix    = "REDO_DIRPREFIX"
47         EnvDepCwd       = "REDO_DEP_CWD"
48         EnvBuildUUID    = "REDO_BUILD_UUID"
49         EnvStderrPrefix = "REDO_STDERR_PREFIX"
50         EnvTrace        = "REDO_TRACE"
51         EnvStderrKeep   = "REDO_LOGS"
52         EnvStderrSilent = "REDO_SILENT"
53         EnvNoSync       = "REDO_NO_SYNC"
54
55         RedoDir      = ".redo"
56         LockSuffix   = ".lock"
57         DepSuffix    = ".rec"
58         TmpPrefix    = ".redo."
59         LogSuffix    = ".log"
60         LogRecSuffix = ".log-rec"
61 )
62
63 var (
64         NoSync       bool = false
65         StderrKeep   bool = false
66         StderrSilent bool = false
67         StderrPrefix string
68         Jobs         sync.WaitGroup
69
70         flagTrace        *bool
71         flagTraceAll     *bool
72         flagStderrKeep   *bool
73         flagStderrSilent *bool
74
75         TracedAll bool
76 )
77
78 func init() {
79         cmdName := CmdName()
80         if !(cmdName == CmdNameRedo || cmdName == CmdNameRedoIfchange) {
81                 return
82         }
83         flagTrace = flag.Bool("x", false, "trace (sh -x) current targets")
84         flagTraceAll = flag.Bool("xx", false,
85                 fmt.Sprintf("trace (sh -x) all targets (%s=1)", EnvTrace))
86         flagStderrKeep = flag.Bool("k", false,
87                 fmt.Sprintf("keep job's stderr (%s=1)", EnvStderrKeep))
88         flagStderrSilent = flag.Bool("s", false,
89                 fmt.Sprintf("silent, do not print job's stderr (%s=1)", EnvStderrSilent))
90 }
91
92 type RunErr struct {
93         Tgt      string
94         DoFile   string
95         Started  *time.Time
96         Finished *time.Time
97         Err      error
98 }
99
100 func (e *RunErr) Name() string {
101         var name string
102         if e.DoFile == "" {
103                 name = e.Tgt
104         } else {
105                 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
106         }
107         if e.Finished == nil {
108                 return name
109         }
110         return fmt.Sprintf("%s (%.3fs)", name, e.Finished.Sub(*e.Started).Seconds())
111 }
112
113 func (e RunErr) Error() string {
114         return fmt.Sprintf("%s: %s", e.Name(), e.Err)
115 }
116
117 func mkdirs(pth string) error {
118         if _, err := os.Stat(pth); err == nil {
119                 return nil
120         }
121         return os.MkdirAll(pth, os.FileMode(0777))
122 }
123
124 func isModified(cwd, redoDir, tgt string) (bool, *Inode, error) {
125         fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
126         if err != nil {
127                 if os.IsNotExist(err) {
128                         return false, nil, nil
129                 }
130                 return false, nil, err
131         }
132         defer fdDep.Close()
133         r := recfile.NewReader(fdDep)
134         var ourInode *Inode
135         for {
136                 m, err := r.NextMap()
137                 if err != nil {
138                         if err == io.EOF {
139                                 break
140                         }
141                         return false, nil, err
142                 }
143                 if m["Target"] != tgt {
144                         continue
145                 }
146                 fd, err := os.Open(path.Join(cwd, tgt))
147                 if err != nil {
148                         if os.IsNotExist(err) {
149                                 return false, nil, nil
150                         }
151                         return false, nil, err
152                 }
153                 ourInode, err = inodeFromFile(fd)
154                 fd.Close()
155                 if err != nil {
156                         return false, nil, err
157                 }
158                 theirInode, err := inodeFromRec(m)
159                 if err != nil {
160                         return false, nil, err
161                 }
162                 if !ourInode.Equals(theirInode) {
163                         return true, ourInode, nil
164                 }
165                 break
166         }
167         return false, ourInode, nil
168 }
169
170 func syncDir(dir string) error {
171         fd, err := os.Open(dir)
172         if err != nil {
173                 return err
174         }
175         err = fd.Sync()
176         fd.Close()
177         return err
178 }
179
180 func runScript(tgtOrig string, errs chan error, traced bool) error {
181         cwd, tgt := cwdAndTgt(tgtOrig)
182         redoDir := path.Join(cwd, RedoDir)
183         if err := mkdirs(redoDir); err != nil {
184                 return TgtErr{tgtOrig, err}
185         }
186
187         // Acquire lock
188         fdLock, err := os.OpenFile(
189                 path.Join(redoDir, tgt+LockSuffix),
190                 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
191                 os.FileMode(0666),
192         )
193         if err != nil {
194                 return TgtErr{tgtOrig, err}
195         }
196         lockRelease := func() {
197                 trace(CLock, "LOCK_UN: %s", fdLock.Name())
198                 unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
199                 fdLock.Close()
200         }
201         trace(CLock, "LOCK_NB: %s", fdLock.Name())
202
203         // Waiting for job completion, already taken by someone else
204         if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
205                 if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
206                         fdLock.Close()
207                         return TgtErr{tgtOrig, err}
208                 }
209                 Jobs.Add(1)
210                 trace(CDebug, "waiting: %s", tgtOrig)
211                 if FdStatus != nil {
212                         FdStatus.Write([]byte{StatusWait})
213                 }
214                 go func() {
215                         defer Jobs.Done()
216                         trace(CLock, "LOCK_EX: %s", fdLock.Name())
217                         unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
218                         lockRelease()
219                         trace(CDebug, "waiting done: %s", tgtOrig)
220                         if FdStatus != nil {
221                                 FdStatus.Write([]byte{StatusWaited})
222                         }
223                         var depInfo *DepInfo
224                         fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
225                         if err != nil {
226                                 if os.IsNotExist(err) {
227                                         err = errors.New("was not built: no .rec")
228                                 }
229                                 goto Finish
230                         }
231                         defer fdDep.Close()
232                         depInfo, err = depRead(fdDep)
233                         if err != nil {
234                                 goto Finish
235                         }
236                         if depInfo.build != BuildUUID {
237                                 err = errors.New("was not built: build differs")
238                         }
239                 Finish:
240                         if err != nil {
241                                 err = TgtErr{tgtOrig, err}
242                         }
243                         errs <- err
244                 }()
245                 return nil
246         }
247
248         // Check if target is not modified externally
249         modified, inodePrev, err := isModified(cwd, redoDir, tgt)
250         if err != nil {
251                 lockRelease()
252                 return TgtErr{tgtOrig, err}
253         }
254         if modified {
255                 trace(CWarn, "%s externally modified: not redoing", tgtOrig)
256                 lockRelease()
257                 go func() {
258                         errs <- nil
259                 }()
260                 return nil
261         }
262
263         // Start preparing .rec
264         fdDep, err := tempfile(redoDir, tgt+DepSuffix)
265         if err != nil {
266                 lockRelease()
267                 return TgtErr{tgtOrig, err}
268         }
269         fdDepPath := fdDep.Name()
270         cleanup := func() {
271                 lockRelease()
272                 fdDep.Close()
273                 os.Remove(fdDep.Name())
274         }
275         if _, err = recfile.NewWriter(fdDep).WriteFields(
276                 recfile.Field{Name: "Build", Value: BuildUUID},
277         ); err != nil {
278                 cleanup()
279                 return TgtErr{tgtOrig, err}
280         }
281
282         // Find .do
283         doFile, upLevels, err := findDo(fdDep, cwd, tgt)
284         if err != nil {
285                 cleanup()
286                 return TgtErr{tgtOrig, err}
287         }
288         if doFile == "" {
289                 cleanup()
290                 return TgtErr{tgtOrig, errors.New("no .do found")}
291         }
292
293         // Determine basename and DIRPREFIX
294         doFileRelPath := doFile
295         ents := strings.Split(cwd, "/")
296         ents = ents[len(ents)-upLevels:]
297         dirPrefix := path.Join(ents...)
298         cwdOrig := cwd
299         for i := 0; i < upLevels; i++ {
300                 cwd = path.Join(cwd, "..")
301                 doFileRelPath = path.Join("..", doFileRelPath)
302         }
303         cwd = path.Clean(cwd)
304         doFilePath := path.Join(cwd, doFile)
305         basename := tgt
306         runErr := RunErr{Tgt: tgtOrig}
307         if strings.HasPrefix(doFile, "default.") {
308                 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
309                 runErr.DoFile = doFileRelPath
310         }
311
312         if err = writeDep(fdDep, cwdOrig, doFileRelPath); err != nil {
313                 cleanup()
314                 return TgtErr{tgtOrig, err}
315         }
316         fdDep.Close()
317         trace(CWait, "%s", runErr.Name())
318
319         // Prepare command line
320         var cmdName string
321         var args []string
322         if err = unix.Access(doFilePath, unix.X_OK); err == nil {
323                 cmdName = doFilePath
324                 args = make([]string, 0, 3)
325         } else {
326                 cmdName = "/bin/sh"
327                 if traced || TracedAll {
328                         args = append(args, "-ex")
329                 } else {
330                         args = append(args, "-e")
331                 }
332                 args = append(args, doFile)
333         }
334
335         // Temporary file for stdout
336         fdStdout, err := tempfile(cwdOrig, tgt)
337         if err != nil {
338                 cleanup()
339                 return TgtErr{tgtOrig, err}
340         }
341         stdoutPath := fdStdout.Name()
342         fdStdout.Close()
343         tmpPath := stdoutPath + ".3" // and for $3
344         tmpPathRel, err := filepath.Rel(cwd, tmpPath)
345         if err != nil {
346                 panic(err)
347         }
348         args = append(
349                 args,
350                 path.Join(dirPrefix, tgt),
351                 path.Join(dirPrefix, basename),
352                 tmpPathRel,
353         )
354
355         cmd := exec.Command(cmdName, args...)
356         cmd.Dir = cwd
357         // cmd.Stdin reads from /dev/null by default
358         cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", EnvLevel, Level+1))
359         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDirPrefix, dirPrefix))
360         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvBuildUUID, BuildUUID))
361
362         childStderrPrefix := tempsuffix()
363         cmd.Env = append(cmd.Env, fmt.Sprintf(
364                 "%s=%s", EnvStderrPrefix, childStderrPrefix,
365         ))
366
367         fdNum := 0
368         cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgts)
369         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsFd, 3+fdNum))
370         fdNum++
371         cmd.ExtraFiles = append(cmd.ExtraFiles, FdOODTgtsLock)
372         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvOODTgtsLockFd, 3+fdNum))
373         fdNum++
374
375         if FdStatus == nil {
376                 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvStatusFd))
377         } else {
378                 cmd.ExtraFiles = append(cmd.ExtraFiles, FdStatus)
379                 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvStatusFd, 3+fdNum))
380                 fdNum++
381         }
382
383         // Preparing stderr
384         var fdStderr *os.File
385         if StderrKeep {
386                 fdStderr, err = os.OpenFile(
387                         path.Join(redoDir, tgt+LogSuffix),
388                         os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
389                         os.FileMode(0666),
390                 )
391                 if err != nil {
392                         cleanup()
393                         return TgtErr{tgtOrig, err}
394                 }
395         }
396         shCtx := fmt.Sprintf(
397                 "sh: %s: %s %s cwd:%s dirprefix:%s",
398                 tgtOrig, cmdName, args, cwd, dirPrefix,
399         )
400         trace(CDebug, "%s", shCtx)
401
402         Jobs.Add(1)
403         go func() {
404                 jsToken := jsAcquire(shCtx)
405                 if JSR == nil {
406                         // infinite jobs
407                         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", EnvJobs))
408                 } else {
409                         cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
410                         cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
411                         cmd.Env = append(cmd.Env, fmt.Sprintf(
412                                 "%s=%s %s%d,%d",
413                                 MakeFlagsName, MakeFlags, MakeJSArg, 3+fdNum+0, 3+fdNum+1,
414                         ))
415                         fdNum += 2
416                         cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvJSToken, jsToken))
417                 }
418
419                 if FdStatus != nil {
420                         FdStatus.Write([]byte{StatusRun})
421                 }
422
423                 var finished time.Time
424                 var exitErr *exec.ExitError
425                 started := time.Now()
426                 runErr.Started = &started
427                 fdStdout, err = os.OpenFile(stdoutPath, os.O_RDWR, os.FileMode(0666))
428                 if err != nil {
429                         runErr.Err = err
430                         errs <- runErr
431                         return
432                 }
433                 cmd.Stdout = fdStdout
434                 fdDep, err = os.OpenFile(fdDepPath, os.O_WRONLY|os.O_APPEND, os.FileMode(0666))
435                 if err != nil {
436                         runErr.Err = err
437                         errs <- runErr
438                         return
439                 }
440                 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
441                 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", EnvDepFd, 3+fdNum))
442                 fdNum++
443                 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", EnvDepCwd, cwd))
444
445                 defer func() {
446                         jsRelease(shCtx, jsToken)
447                         fdDep.Close()
448                         fdStdout.Close()
449                         if fdStderr != nil {
450                                 fdStderr.Close()
451                                 logRecPath := path.Join(redoDir, tgt+LogRecSuffix)
452                                 if fdStderr, err = os.OpenFile(
453                                         logRecPath,
454                                         os.O_WRONLY|os.O_CREATE|os.O_TRUNC,
455                                         os.FileMode(0666),
456                                 ); err == nil {
457                                         fields := []recfile.Field{
458                                                 {Name: "Build", Value: BuildUUID},
459                                                 {Name: "PID", Value: strconv.Itoa(cmd.Process.Pid)},
460                                                 {Name: "PPID", Value: strconv.Itoa(os.Getpid())},
461                                                 {Name: "Cwd", Value: cwd},
462                                         }
463                                         ts := new(tai64n.TAI64N)
464                                         ts.FromTime(started)
465                                         fields = append(fields,
466                                                 recfile.Field{Name: "Started", Value: tai64n.Encode(ts[:])},
467                                         )
468                                         ts.FromTime(finished)
469                                         fields = append(fields,
470                                                 recfile.Field{Name: "Finished", Value: tai64n.Encode(ts[:])})
471                                         fields = append(fields, recfile.Field{
472                                                 Name:  "Duration",
473                                                 Value: strconv.FormatInt(finished.Sub(started).Nanoseconds(), 10),
474                                         })
475                                         fields = append(fields, recfile.Field{Name: "Cmd", Value: cmdName})
476                                         for _, arg := range args {
477                                                 fields = append(fields, recfile.Field{Name: "Cmd", Value: arg})
478                                         }
479                                         for _, env := range cmd.Env {
480                                                 fields = append(fields, recfile.Field{Name: "Env", Value: env})
481                                         }
482                                         if exitErr != nil {
483                                                 fields = append(fields, recfile.Field{
484                                                         Name:  "ExitCode",
485                                                         Value: strconv.Itoa(exitErr.ProcessState.ExitCode()),
486                                                 })
487                                         }
488                                         w := bufio.NewWriter(fdStderr)
489
490                                         var depInfo *DepInfo
491                                         fdDep, err := os.Open(fdDepPath)
492                                         if err != nil {
493                                                 goto Err
494                                         }
495                                         depInfo, err = depRead(fdDep)
496                                         fdDep.Close()
497                                         if err != nil {
498                                                 goto Err
499                                         }
500                                         for _, dep := range depInfo.ifchanges {
501                                                 fields = append(fields, recfile.Field{
502                                                         Name:  "Ifchange",
503                                                         Value: dep["Target"],
504                                                 })
505                                         }
506                                         _, err = recfile.NewWriter(w).WriteFields(fields...)
507                                         if err != nil {
508                                                 goto Err
509                                         }
510                                         err = w.Flush()
511                                 Err:
512                                         if err != nil {
513                                                 log.Println(err)
514                                                 os.Remove(logRecPath)
515                                         }
516                                         fdStderr.Close()
517                                 } else {
518                                         log.Println("can not open", logRecPath, ":", err)
519                                 }
520                         }
521                         lockRelease()
522                         os.Remove(fdDep.Name())
523                         os.Remove(fdStdout.Name())
524                         os.Remove(tmpPath)
525                         os.Remove(fdLock.Name())
526                         if FdStatus != nil {
527                                 FdStatus.Write([]byte{StatusDone})
528                         }
529                         Jobs.Done()
530                 }()
531                 stderr, err := cmd.StderrPipe()
532                 if err != nil {
533                         runErr.Err = err
534                         errs <- runErr
535                         return
536                 }
537                 started = time.Now()
538                 err = cmd.Start()
539                 if err != nil {
540                         runErr.Err = err
541                         errs <- runErr
542                         return
543                 }
544                 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
545                 trace(CDebug, "%s runs %s", tgtOrig, pid)
546
547                 stderrTerm := make(chan struct{}, 0)
548                 go func() {
549                         scanner := bufio.NewScanner(stderr)
550                         var line string
551                         ts := new(tai64n.TAI64N)
552                         for scanner.Scan() {
553                                 line = scanner.Text()
554                                 if strings.HasPrefix(line, childStderrPrefix) {
555                                         line = line[len(childStderrPrefix):]
556                                         os.Stderr.WriteString(StderrPrefix + line + "\n")
557                                         continue
558                                 }
559                                 if fdStderr != nil {
560                                         ts.FromTime(time.Now())
561                                         LogMutex.Lock()
562                                         fmt.Fprintln(fdStderr, tai64n.Encode(ts[:]), line)
563                                         LogMutex.Unlock()
564                                 }
565                                 if StderrSilent {
566                                         continue
567                                 }
568                                 if MyPid == 0 {
569                                         trace(CNone, "%s", line)
570                                 } else {
571                                         trace(CNone, "%s %s", pid, line)
572                                 }
573                         }
574                         close(stderrTerm)
575                 }()
576
577                 // Wait for job completion
578                 <-stderrTerm
579                 err = cmd.Wait()
580                 finished = time.Now()
581                 runErr.Finished = &finished
582                 if err != nil {
583                         exitErr = err.(*exec.ExitError)
584                         runErr.Err = err
585                         errs <- runErr
586                         return
587                 }
588
589                 // Was $1 touched?
590                 if inodePrev != nil {
591                         if fd, err := os.Open(path.Join(cwdOrig, tgt)); err == nil {
592                                 inode, err := inodeFromFile(fd)
593                                 fd.Close()
594                                 if err == nil && !inode.Equals(inodePrev) {
595                                         runErr.Err = errors.New("$1 was explicitly touched")
596                                         errs <- runErr
597                                         return
598                                 }
599                         }
600                 }
601
602                 // Does it produce both stdout and tmp?
603                 fiStdout, err := os.Stat(fdStdout.Name())
604                 if err != nil {
605                         runErr.Err = err
606                         errs <- runErr
607                         return
608                 }
609                 tmpExists := false
610                 _, err = os.Stat(tmpPath)
611                 if err == nil {
612                         if fiStdout.Size() > 0 {
613                                 runErr.Err = errors.New("created both tmp and stdout")
614                                 errs <- runErr
615                                 return
616                         }
617                         tmpExists = true
618                 } else if !os.IsNotExist(err) {
619                         runErr.Err = err
620                         errs <- runErr
621                         return
622                 }
623
624                 // Determine what file we must process at last
625                 var fd *os.File
626                 if tmpExists {
627                         fd, err = os.Open(tmpPath)
628                         if err != nil {
629                                 goto Finish
630                         }
631                         defer fd.Close()
632                 } else if fiStdout.Size() > 0 {
633                         fd = fdStdout
634                 }
635
636                 // Do we need to ifcreate it, of ifchange with renaming?
637                 if fd == nil {
638                         os.Remove(path.Join(cwdOrig, tgt))
639                         err = ifcreate(fdDep, tgt)
640                         if err != nil {
641                                 goto Finish
642                         }
643                 } else {
644                         if !NoSync {
645                                 err = fd.Sync()
646                                 if err != nil {
647                                         goto Finish
648                                 }
649                         }
650                         err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
651                         if err != nil {
652                                 goto Finish
653                         }
654                         if !NoSync {
655                                 err = syncDir(cwdOrig)
656                                 if err != nil {
657                                         goto Finish
658                                 }
659                         }
660                         err = writeDep(fdDep, cwdOrig, tgt)
661                         if err != nil {
662                                 goto Finish
663                         }
664                 }
665
666                 // Commit .rec
667                 if !NoSync {
668                         err = fdDep.Sync()
669                         if err != nil {
670                                 goto Finish
671                         }
672                 }
673                 fdDepPath = path.Join(redoDir, tgt+DepSuffix)
674                 err = os.Rename(fdDep.Name(), fdDepPath)
675                 if err != nil {
676                         goto Finish
677                 }
678                 if !NoSync {
679                         err = syncDir(redoDir)
680                         if err != nil {
681                                 goto Finish
682                         }
683                 }
684         Finish:
685                 runErr.Err = err
686                 errs <- runErr
687         }()
688         return nil
689 }
690
691 func isOkRun(err error) bool {
692         if err == nil {
693                 return true
694         }
695         if err, ok := err.(RunErr); ok && err.Err == nil {
696                 trace(CRedo, "%s", err.Name())
697                 return true
698         }
699         trace(CErr, "%s", err)
700         return false
701 }