2 goredo -- redo implementation on pure Go
3 Copyright (C) 2020 Sergey Matveev <stargrave@stargrave.org>
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.
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.
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/>.
36 "go.cypherpunks.ru/recfile"
37 "golang.org/x/sys/unix"
48 func mkdirs(pth string) error {
49 if _, err := os.Stat(pth); err == nil {
52 return os.MkdirAll(pth, os.FileMode(0777))
55 func tempsuffix() string {
56 return strconv.FormatInt((time.Now().UnixNano()+int64(os.Getpid()))&0xFFFFFFFF, 16)
59 func tempfile(dir, prefix string) (*os.File, error) {
60 // It respects umask, unlike ioutil.TempFile
61 name := path.Join(dir, TmpPrefix+prefix+"."+tempsuffix())
62 return os.OpenFile(name, os.O_RDWR|os.O_CREATE|os.O_EXCL, os.FileMode(0666))
65 func isModified(cwd, redoDir, tgt string) (bool, error) {
66 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
68 if os.IsNotExist(err) {
74 r := recfile.NewReader(fdDep)
83 if m["Target"] != tgt {
86 fd, err := os.Open(path.Join(cwd, tgt))
88 if os.IsNotExist(err) {
94 ourTs, err := fileCtime(fd)
98 if ourTs != m["Ctime"] {
114 func (e RunErr) Unwrap() error { return e.Err }
116 func (e *RunErr) Name() string {
121 name = fmt.Sprintf("%s (%s)", e.Tgt, e.DoFile)
123 if e.Finished == nil {
126 return fmt.Sprintf("%s (%fsec)", name, e.Finished.Sub(*e.Started).Seconds())
129 func (e RunErr) Error() string {
130 return fmt.Sprintf("%s: %s", e.Name(), e.Err)
133 func syncDir(dir string) error {
134 fd, err := os.Open(dir)
143 func runScript(tgt string, errs chan error) error {
145 cwd, tgt := cwdAndTgt(tgt)
146 redoDir := path.Join(cwd, RedoDir)
147 if err := mkdirs(redoDir); err != nil {
148 return TgtErr{tgtOrig, err}
152 fdLock, err := os.OpenFile(
153 path.Join(redoDir, tgt+LockSuffix),
154 os.O_WRONLY|os.O_TRUNC|os.O_CREATE,
158 return TgtErr{tgtOrig, err}
160 lockRelease := func() {
161 trace(CLock, "LOCK_UN: %s", fdLock.Name())
162 unix.Flock(int(fdLock.Fd()), unix.LOCK_UN)
165 trace(CLock, "LOCK_NB: %s", fdLock.Name())
167 // Waiting for job completion, already taken by someone else
168 if err = unix.Flock(int(fdLock.Fd()), unix.LOCK_EX|unix.LOCK_NB); err != nil {
169 if uintptr(err.(syscall.Errno)) != uintptr(unix.EWOULDBLOCK) {
171 return TgtErr{tgtOrig, err}
173 trace(CDebug, "waiting: %s", tgtOrig)
177 trace(CLock, "LOCK_EX: %s", fdLock.Name())
178 unix.Flock(int(fdLock.Fd()), unix.LOCK_EX)
180 trace(CDebug, "waiting done: %s", tgtOrig)
182 fdDep, err := os.Open(path.Join(redoDir, tgt+DepSuffix))
184 if os.IsNotExist(err) {
185 err = errors.New("was not built")
189 builtNow, _, err = isBuiltNow(fdDep)
194 err = errors.New("was not built")
198 err = TgtErr{tgtOrig, err}
205 // Check if target is not modified externally
206 modified, err := isModified(cwd, redoDir, tgt)
209 return TgtErr{tgtOrig, err}
212 trace(CWarn, "%s externally modified: not redoing", tgtOrig)
215 return TgtErr{tgtOrig, err}
218 // Start preparing .dep
219 fdDep, err := tempfile(redoDir, tgt+DepSuffix)
222 return TgtErr{tgtOrig, err}
227 os.Remove(fdDep.Name())
229 if _, err = recfile.NewWriter(fdDep).WriteFields(
230 recfile.Field{Name: "Build", Value: BuildUUID},
233 return TgtErr{tgtOrig, err}
237 doFile, upLevels, err := findDo(fdDep, cwd, tgt)
240 return TgtErr{tgtOrig, err}
244 return TgtErr{tgtOrig, errors.New("no .do found")}
246 if err = writeDep(fdDep, cwd, doFile); err != nil {
248 return TgtErr{tgtOrig, err}
251 // Determine basename and DIRPREFIX
252 ents := strings.Split(cwd, "/")
253 ents = ents[len(ents)-upLevels:]
254 dirPrefix := path.Join(ents...)
256 for i := 0; i < upLevels; i++ {
257 cwd = path.Join(cwd, "..")
259 cwd = path.Clean(cwd)
261 runErr := RunErr{Tgt: tgtOrig}
262 if strings.HasPrefix(doFile, "default.") {
263 basename = tgt[:len(tgt)-(len(doFile)-len("default.")-len(".do"))-1]
264 runErr.DoFile = doFile
266 trace(CWait, "%s", runErr.Name())
267 doFile = path.Base(doFile)
269 // Prepare command line
272 if err = unix.Access(path.Join(cwd, doFile), unix.X_OK); err == nil {
273 // Ordinary executable file
275 args = make([]string, 0, 3)
277 fd, err := os.Open(path.Join(cwd, doFile))
280 return TgtErr{tgtOrig, err}
282 buf := make([]byte, 512)
283 n, err := fd.Read(buf)
286 return TgtErr{tgtOrig, err}
288 if n > 3 && string(buf[:3]) == "#!/" {
290 t := string(buf[2:n])
291 nlIdx := strings.Index(t, "\n")
294 return TgtErr{tgtOrig, errors.New("not fully read shebang")}
296 args = strings.Split(t[:nlIdx], " ")
297 cmdName, args = args[0], args[1:]
302 args = append(args, "-ex")
304 args = append(args, "-e")
307 args = append(args, doFile)
310 // Temporary file for stdout
311 fdStdout, err := tempfile(cwd, tgt)
314 return TgtErr{tgtOrig, err}
316 tmpPath := fdStdout.Name() + ".3" // and for $3
317 args = append(args, tgt, basename, path.Base(tmpPath))
319 cmd := exec.Command(cmdName, args...)
321 cmd.Stdout = fdStdout
322 cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%d", RedoLevelEnv, Level+1))
323 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", RedoDirPrefixEnv, dirPrefix))
324 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", RedoBuildUUIDEnv, BuildUUID))
325 childStderrPrefix := tempsuffix()
326 cmd.Env = append(cmd.Env, fmt.Sprintf(
327 "%s=%s", RedoStderrPrefixEnv, childStderrPrefix,
330 cmd.ExtraFiles = append(cmd.ExtraFiles, fdDep)
332 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", RedoDepFdEnv, 3+fdNum))
336 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", RedoJSRFdEnv))
337 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=NO", RedoJSWFdEnv))
339 cmd.ExtraFiles = append(cmd.ExtraFiles, JSR)
340 cmd.ExtraFiles = append(cmd.ExtraFiles, JSW)
341 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", RedoJSRFdEnv, 3+fdNum))
343 cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%d", RedoJSWFdEnv, 3+fdNum))
348 stderr, err := cmd.StderrPipe()
352 var fdStderr *os.File
354 fdStderr, err = os.OpenFile(
355 path.Join(redoDir, tgt+LogSuffix),
356 os.O_WRONLY|os.O_CREATE,
361 return TgtErr{tgtOrig, err}
365 shCtx := fmt.Sprintf("sh: %s: %s %s [%s]", tgtOrig, cmdName, args, cwd)
366 trace(CDebug, "%s", shCtx)
379 os.Remove(fdDep.Name())
380 os.Remove(fdStdout.Name())
382 os.Remove(fdLock.Name())
385 started := time.Now()
386 runErr.Started = &started
393 pid := fmt.Sprintf("[%d]", cmd.Process.Pid)
394 trace(CDebug, "%s runs %s", tgtOrig, pid)
396 stderrTerm := make(chan struct{}, 0)
398 scanner := bufio.NewScanner(stderr)
402 line = scanner.Text()
403 if strings.HasPrefix(line, childStderrPrefix) {
404 line = line[len(childStderrPrefix):]
405 os.Stderr.WriteString(StderrPrefix + line + "\n")
410 fmt.Fprintf(fdStderr, "@%s %s\n", hex.EncodeToString(ts[:]), line)
416 trace(CNone, "%s", line)
418 trace(CNone, "%s %s", pid, line)
424 // Wait for job completion
427 finished := time.Now()
428 runErr.Finished = &finished
435 // Does it produce both stdout and tmp?
436 fiStdout, err := os.Stat(fdStdout.Name())
443 _, err = os.Stat(tmpPath)
445 if fiStdout.Size() > 0 {
446 runErr.Err = errors.New("created both tmp and stdout")
451 } else if !os.IsNotExist(err) {
457 // Determine what file we must process at last
460 fd, err = os.Open(tmpPath)
465 } else if fiStdout.Size() > 0 {
469 // Do we need to ifcreate it, of ifchange with renaming?
471 err = ifcreate(fdDep, tgt)
482 err = os.Rename(fd.Name(), path.Join(cwdOrig, tgt))
487 err = syncDir(cwdOrig)
492 err = writeDep(fdDep, cwdOrig, tgt)
505 err = os.Rename(fdDep.Name(), path.Join(redoDir, tgt+DepSuffix))
510 err = syncDir(redoDir)