lib/crunchrun/background.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package crunchrun
   6
   7 import (
   8         "encoding/json"
   9         "fmt"
  10         "io"
  11         "os"
  12         "os/exec"
  13         "path/filepath"
  14         "strings"
  15         "syscall"
  16         "time"
  17 )
  18
  19 var (
  20         lockdir    = "/var/lock"
  21         lockprefix = "crunch-run-"
  22         locksuffix = ".lock"
  23         brokenfile = "crunch-run-broken"
  24 )
  25
  26 // procinfo is saved in each process's lockfile.
  27 type procinfo struct {
  28         UUID string
  29         PID  int
  30 }
  31
  32 // Detach acquires a lock for the given uuid, and starts the current
  33 // program as a child process (with -no-detach prepended to the given
  34 // arguments so the child knows not to detach again). The lock is
  35 // passed along to the child process.
  36 //
  37 // Stdout and stderr in the child process are sent to the systemd
  38 // journal using the systemd-cat program.
  39 func Detach(uuid string, prog string, args []string, stdout, stderr io.Writer) int {
  40         return exitcode(stderr, detach(uuid, prog, args, stdout, stderr))
  41 }
  42 func detach(uuid string, prog string, args []string, stdout, stderr io.Writer) error {
  43         lockfile, err := func() (*os.File, error) {
  44                 // We must hold the dir-level lock between
  45                 // opening/creating the lockfile and acquiring LOCK_EX
  46                 // on it, to avoid racing with the ListProcess's
  47                 // alive-checking and garbage collection.
  48                 dirlock, err := lockall()
  49                 if err != nil {
  50                         return nil, err
  51                 }
  52                 defer dirlock.Close()
  53                 lockfilename := filepath.Join(lockdir, lockprefix+uuid+locksuffix)
  54                 lockfile, err := os.OpenFile(lockfilename, os.O_CREATE|os.O_RDWR, 0700)
  55                 if err != nil {
  56                         return nil, fmt.Errorf("open %s: %s", lockfilename, err)
  57                 }
  58                 err = syscall.Flock(int(lockfile.Fd()), syscall.LOCK_EX|syscall.LOCK_NB)
  59                 if err != nil {
  60                         lockfile.Close()
  61                         return nil, fmt.Errorf("lock %s: %s", lockfilename, err)
  62                 }
  63                 return lockfile, nil
  64         }()
  65         if err != nil {
  66                 return err
  67         }
  68         defer lockfile.Close()
  69         lockfile.Truncate(0)
  70
  71         execargs := append([]string{"-no-detach"}, args...)
  72         if strings.HasSuffix(prog, " crunch-run") {
  73                 // invoked as "/path/to/arvados-server crunch-run"
  74                 // (see arvados/lib/cmd.Multi)
  75                 execargs = append([]string{strings.TrimSuffix(prog, " crunch-run"), "crunch-run"}, execargs...)
  76         } else {
  77                 // invoked as "/path/to/crunch-run"
  78                 execargs = append([]string{prog}, execargs...)
  79         }
  80         execargs = append([]string{
  81                 // Here, if the inner systemd-cat can't exec
  82                 // crunch-run, it writes an error message to stderr,
  83                 // and the outer systemd-cat writes it to the journal
  84                 // where the operator has a chance to discover it. (If
  85                 // we only used one systemd-cat command, it would be
  86                 // up to us to report the error -- but we are going to
  87                 // detach and exit, not wait for something to appear
  88                 // on stderr.)  Note these systemd-cat calls don't
  89                 // result in additional processes -- they just connect
  90                 // stderr/stdout to sockets and call exec().
  91                 "systemd-cat", "--identifier=crunch-run",
  92                 "systemd-cat", "--identifier=crunch-run",
  93         }, execargs...)
  94
  95         cmd := exec.Command(execargs[0], execargs[1:]...)
  96         // Child inherits lockfile.
  97         cmd.ExtraFiles = []*os.File{lockfile}
  98         // Ensure child isn't interrupted even if we receive signals
  99         // from parent (sshd) while sending lockfile content to
 100         // caller.
 101         cmd.SysProcAttr = &syscall.SysProcAttr{Setpgid: true}
 102         err = cmd.Start()
 103         if err != nil {
 104                 return fmt.Errorf("exec %s: %s", cmd.Path, err)
 105         }
 106
 107         w := io.MultiWriter(stdout, lockfile)
 108         return json.NewEncoder(w).Encode(procinfo{
 109                 UUID: uuid,
 110                 PID:  cmd.Process.Pid,
 111         })
 112 }
 113
 114 // KillProcess finds the crunch-run process corresponding to the given
 115 // uuid, and sends the given signal to it. It then waits up to 1
 116 // second for the process to die. It returns 0 if the process is
 117 // successfully killed or didn't exist in the first place.
 118 func KillProcess(uuid string, signal syscall.Signal, stdout, stderr io.Writer) int {
 119         return exitcode(stderr, kill(uuid, signal, stdout, stderr))
 120 }
 121
 122 func kill(uuid string, signal syscall.Signal, stdout, stderr io.Writer) error {
 123         path := filepath.Join(lockdir, lockprefix+uuid+locksuffix)
 124         f, err := os.Open(path)
 125         if os.IsNotExist(err) {
 126                 return nil
 127         } else if err != nil {
 128                 return fmt.Errorf("open %s: %s", path, err)
 129         }
 130         defer f.Close()
 131
 132         var pi procinfo
 133         err = json.NewDecoder(f).Decode(&pi)
 134         if err != nil {
 135                 return fmt.Errorf("decode %s: %s", path, err)
 136         }
 137
 138         if pi.UUID != uuid || pi.PID == 0 {
 139                 return fmt.Errorf("%s: bogus procinfo: %+v", path, pi)
 140         }
 141
 142         proc, err := os.FindProcess(pi.PID)
 143         if err != nil {
 144                 // FindProcess should have succeeded, even if the
 145                 // process does not exist.
 146                 return fmt.Errorf("%s: find process %d: %s", uuid, pi.PID, err)
 147         }
 148
 149         // Send the requested signal once, then send signal 0 a few
 150         // times.  When proc.Signal() returns an error (process no
 151         // longer exists), return success.  If that doesn't happen
 152         // within 1 second, return an error.
 153         err = proc.Signal(signal)
 154         for deadline := time.Now().Add(time.Second); err == nil && time.Now().Before(deadline); time.Sleep(time.Second / 100) {
 155                 err = proc.Signal(syscall.Signal(0))
 156         }
 157         if err == nil {
 158                 // Reached deadline without a proc.Signal() error.
 159                 return fmt.Errorf("%s: pid %d: sent signal %d (%s) but process is still alive", uuid, pi.PID, signal, signal)
 160         }
 161         fmt.Fprintf(stderr, "%s: pid %d: %s\n", uuid, pi.PID, err)
 162         return nil
 163 }
 164
 165 // ListProcesses lists UUIDs of active crunch-run processes.
 166 func ListProcesses(stdout, stderr io.Writer) int {
 167         // filepath.Walk does not follow symlinks, so we must walk
 168         // lockdir+"/." in case lockdir itself is a symlink.
 169         walkdir := lockdir + "/."
 170         return exitcode(stderr, filepath.Walk(walkdir, func(path string, info os.FileInfo, err error) error {
 171                 if info.IsDir() && path != walkdir {
 172                         return filepath.SkipDir
 173                 }
 174                 if name := info.Name(); name == brokenfile {
 175                         fmt.Fprintln(stdout, "broken")
 176                         return nil
 177                 } else if !strings.HasPrefix(name, lockprefix) || !strings.HasSuffix(name, locksuffix) {
 178                         return nil
 179                 }
 180                 if info.Size() == 0 {
 181                         // race: process has opened/locked but hasn't yet written pid/uuid
 182                         return nil
 183                 }
 184
 185                 f, err := os.Open(path)
 186                 if err != nil {
 187                         return nil
 188                 }
 189                 defer f.Close()
 190
 191                 // Ensure other processes don't acquire this lockfile
 192                 // after we have decided it is abandoned but before we
 193                 // have deleted it.
 194                 dirlock, err := lockall()
 195                 if err != nil {
 196                         return err
 197                 }
 198                 err = syscall.Flock(int(f.Fd()), syscall.LOCK_SH|syscall.LOCK_NB)
 199                 if err == nil {
 200                         // lockfile is stale
 201                         err := os.Remove(path)
 202                         dirlock.Close()
 203                         if err != nil {
 204                                 fmt.Fprintf(stderr, "unlink %s: %s\n", f.Name(), err)
 205                         }
 206                         return nil
 207                 }
 208                 dirlock.Close()
 209
 210                 var pi procinfo
 211                 err = json.NewDecoder(f).Decode(&pi)
 212                 if err != nil {
 213                         fmt.Fprintf(stderr, "%s: %s\n", path, err)
 214                         return nil
 215                 }
 216                 if pi.UUID == "" || pi.PID == 0 {
 217                         fmt.Fprintf(stderr, "%s: bogus procinfo: %+v", path, pi)
 218                         return nil
 219                 }
 220
 221                 proc, err := os.FindProcess(pi.PID)
 222                 if err != nil {
 223                         // FindProcess should have succeeded, even if the
 224                         // process does not exist.
 225                         fmt.Fprintf(stderr, "%s: find process %d: %s", path, pi.PID, err)
 226                         return nil
 227                 }
 228                 err = proc.Signal(syscall.Signal(0))
 229                 if err != nil {
 230                         // Process is dead, even though lockfile was
 231                         // still locked. Most likely a stuck arv-mount
 232                         // process that inherited the lock from
 233                         // crunch-run. Report container UUID as
 234                         // "stale".
 235                         fmt.Fprintln(stdout, pi.UUID, "stale")
 236                         return nil
 237                 }
 238
 239                 fmt.Fprintln(stdout, pi.UUID)
 240                 return nil
 241         }))
 242 }
 243
 244 // If err is nil, return 0 ("success"); otherwise, print err to stderr
 245 // and return 1.
 246 func exitcode(stderr io.Writer, err error) int {
 247         if err != nil {
 248                 fmt.Fprintln(stderr, err)
 249                 return 1
 250         }
 251         return 0
 252 }
 253
 254 // Acquire a dir-level lock. Must be held while creating or deleting
 255 // container-specific lockfiles, to avoid races during the intervals
 256 // when those container-specific lockfiles are open but not locked.
 257 //
 258 // Caller releases the lock by closing the returned file.
 259 func lockall() (*os.File, error) {
 260         lockfile := filepath.Join(lockdir, lockprefix+"all"+locksuffix)
 261         f, err := os.OpenFile(lockfile, os.O_CREATE|os.O_RDWR, 0700)
 262         if err != nil {
 263                 return nil, fmt.Errorf("open %s: %s", lockfile, err)
 264         }
 265         err = syscall.Flock(int(f.Fd()), syscall.LOCK_EX)
 266         if err != nil {
 267                 f.Close()
 268                 return nil, fmt.Errorf("lock %s: %s", lockfile, err)
 269         }
 270         return f, nil
 271 }