Merge branch '21666-provision-test-improvement'
[arvados.git] / lib / crunchrun / crunchrun.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         "bytes"
9         "context"
10         "encoding/json"
11         "errors"
12         "flag"
13         "fmt"
14         "io"
15         "io/fs"
16         "io/ioutil"
17         "log"
18         "net"
19         "net/http"
20         "os"
21         "os/exec"
22         "os/signal"
23         "os/user"
24         "path"
25         "path/filepath"
26         "regexp"
27         "runtime"
28         "runtime/pprof"
29         "sort"
30         "strings"
31         "sync"
32         "syscall"
33         "time"
34
35         "git.arvados.org/arvados.git/lib/cloud"
36         "git.arvados.org/arvados.git/lib/cmd"
37         "git.arvados.org/arvados.git/lib/config"
38         "git.arvados.org/arvados.git/lib/crunchstat"
39         "git.arvados.org/arvados.git/sdk/go/arvados"
40         "git.arvados.org/arvados.git/sdk/go/arvadosclient"
41         "git.arvados.org/arvados.git/sdk/go/ctxlog"
42         "git.arvados.org/arvados.git/sdk/go/keepclient"
43         "git.arvados.org/arvados.git/sdk/go/manifest"
44         "golang.org/x/sys/unix"
45 )
46
47 type command struct{}
48
49 var arvadosCertPath = "/etc/arvados/ca-certificates.crt"
50
51 var Command = command{}
52
53 // ConfigData contains environment variables and (when needed) cluster
54 // configuration, passed from dispatchcloud to crunch-run on stdin.
55 type ConfigData struct {
56         Env          map[string]string
57         KeepBuffers  int
58         EC2SpotCheck bool
59         Cluster      *arvados.Cluster
60 }
61
62 // IArvadosClient is the minimal Arvados API methods used by crunch-run.
63 type IArvadosClient interface {
64         Create(resourceType string, parameters arvadosclient.Dict, output interface{}) error
65         Get(resourceType string, uuid string, parameters arvadosclient.Dict, output interface{}) error
66         Update(resourceType string, uuid string, parameters arvadosclient.Dict, output interface{}) error
67         Call(method, resourceType, uuid, action string, parameters arvadosclient.Dict, output interface{}) error
68         CallRaw(method string, resourceType string, uuid string, action string, parameters arvadosclient.Dict) (reader io.ReadCloser, err error)
69         Discovery(key string) (interface{}, error)
70 }
71
72 // ErrCancelled is the error returned when the container is cancelled.
73 var ErrCancelled = errors.New("Cancelled")
74
75 // IKeepClient is the minimal Keep API methods used by crunch-run.
76 type IKeepClient interface {
77         BlockWrite(context.Context, arvados.BlockWriteOptions) (arvados.BlockWriteResponse, error)
78         ReadAt(locator string, p []byte, off int) (int, error)
79         ManifestFileReader(m manifest.Manifest, filename string) (arvados.File, error)
80         LocalLocator(locator string) (string, error)
81         SetStorageClasses(sc []string)
82 }
83
84 type RunArvMount func(cmdline []string, tok string) (*exec.Cmd, error)
85
86 type MkTempDir func(string, string) (string, error)
87
88 type PsProcess interface {
89         CmdlineSlice() ([]string, error)
90 }
91
92 // ContainerRunner is the main stateful struct used for a single execution of a
93 // container.
94 type ContainerRunner struct {
95         executor       containerExecutor
96         executorStdin  io.Closer
97         executorStdout io.Closer
98         executorStderr io.Closer
99
100         // Dispatcher client is initialized with the Dispatcher token.
101         // This is a privileged token used to manage container status
102         // and logs.
103         //
104         // We have both dispatcherClient and DispatcherArvClient
105         // because there are two different incompatible Arvados Go
106         // SDKs and we have to use both (hopefully this gets fixed in
107         // #14467)
108         dispatcherClient     *arvados.Client
109         DispatcherArvClient  IArvadosClient
110         DispatcherKeepClient IKeepClient
111
112         // Container client is initialized with the Container token
113         // This token controls the permissions of the container, and
114         // must be used for operations such as reading collections.
115         //
116         // Same comment as above applies to
117         // containerClient/ContainerArvClient.
118         containerClient     *arvados.Client
119         ContainerArvClient  IArvadosClient
120         ContainerKeepClient IKeepClient
121
122         Container     arvados.Container
123         token         string
124         ExitCode      *int
125         CrunchLog     *logWriter
126         logUUID       string
127         logMtx        sync.Mutex
128         LogCollection arvados.CollectionFileSystem
129         LogsPDH       *string
130         RunArvMount   RunArvMount
131         MkTempDir     MkTempDir
132         ArvMount      *exec.Cmd
133         ArvMountPoint string
134         HostOutputDir string
135         Volumes       map[string]struct{}
136         OutputPDH     *string
137         SigChan       chan os.Signal
138         ArvMountExit  chan error
139         SecretMounts  map[string]arvados.Mount
140         MkArvClient   func(token string) (IArvadosClient, IKeepClient, *arvados.Client, error)
141         finalState    string
142         parentTemp    string
143         costStartTime time.Time
144
145         keepstore        *exec.Cmd
146         keepstoreLogger  io.WriteCloser
147         keepstoreLogbuf  *bufThenWrite
148         statLogger       io.WriteCloser
149         statReporter     *crunchstat.Reporter
150         hoststatLogger   io.WriteCloser
151         hoststatReporter *crunchstat.Reporter
152         statInterval     time.Duration
153         // What we tell docker to use as the container's cgroup
154         // parent.
155         setCgroupParent string
156         // Fake root dir where crunchstat.Reporter should read OS
157         // files, for testing.
158         crunchstatFakeFS fs.FS
159
160         cStateLock sync.Mutex
161         cCancelled bool // StopContainer() invoked
162
163         enableMemoryLimit bool
164         enableNetwork     string // one of "default" or "always"
165         networkMode       string // "none", "host", or "" -- passed through to executor
166         brokenNodeHook    string // script to run if node appears to be broken
167         arvMountLog       io.WriteCloser
168
169         containerWatchdogInterval time.Duration
170
171         gateway Gateway
172
173         prices     []cloud.InstancePrice
174         pricesLock sync.Mutex
175 }
176
177 // setupSignals sets up signal handling to gracefully terminate the
178 // underlying container and update state when receiving a TERM, INT or
179 // QUIT signal.
180 func (runner *ContainerRunner) setupSignals() {
181         runner.SigChan = make(chan os.Signal, 1)
182         signal.Notify(runner.SigChan, syscall.SIGTERM)
183         signal.Notify(runner.SigChan, syscall.SIGINT)
184         signal.Notify(runner.SigChan, syscall.SIGQUIT)
185
186         go func(sig chan os.Signal) {
187                 for s := range sig {
188                         runner.stop(s)
189                 }
190         }(runner.SigChan)
191 }
192
193 // stop the underlying container.
194 func (runner *ContainerRunner) stop(sig os.Signal) {
195         runner.cStateLock.Lock()
196         defer runner.cStateLock.Unlock()
197         if sig != nil {
198                 runner.CrunchLog.Printf("caught signal: %v", sig)
199         }
200         runner.cCancelled = true
201         runner.CrunchLog.Printf("stopping container")
202         err := runner.executor.Stop()
203         if err != nil {
204                 runner.CrunchLog.Printf("error stopping container: %s", err)
205         }
206 }
207
208 var errorBlacklist = []string{
209         "(?ms).*[Cc]annot connect to the Docker daemon.*",
210         "(?ms).*oci runtime error.*starting container process.*container init.*mounting.*to rootfs.*no such file or directory.*",
211         "(?ms).*grpc: the connection is unavailable.*",
212 }
213
214 func (runner *ContainerRunner) runBrokenNodeHook() {
215         if runner.brokenNodeHook == "" {
216                 path := filepath.Join(lockdir, brokenfile)
217                 runner.CrunchLog.Printf("Writing %s to mark node as broken", path)
218                 f, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0700)
219                 if err != nil {
220                         runner.CrunchLog.Printf("Error writing %s: %s", path, err)
221                         return
222                 }
223                 f.Close()
224         } else {
225                 runner.CrunchLog.Printf("Running broken node hook %q", runner.brokenNodeHook)
226                 // run killme script
227                 c := exec.Command(runner.brokenNodeHook)
228                 c.Stdout = runner.CrunchLog
229                 c.Stderr = runner.CrunchLog
230                 err := c.Run()
231                 if err != nil {
232                         runner.CrunchLog.Printf("Error running broken node hook: %v", err)
233                 }
234         }
235 }
236
237 func (runner *ContainerRunner) checkBrokenNode(goterr error) bool {
238         for _, d := range errorBlacklist {
239                 if m, e := regexp.MatchString(d, goterr.Error()); m && e == nil {
240                         runner.CrunchLog.Printf("Error suggests node is unable to run containers: %v", goterr)
241                         runner.runBrokenNodeHook()
242                         return true
243                 }
244         }
245         return false
246 }
247
248 // LoadImage determines the docker image id from the container record and
249 // checks if it is available in the local Docker image store.  If not, it loads
250 // the image from Keep.
251 func (runner *ContainerRunner) LoadImage() (string, error) {
252         runner.CrunchLog.Printf("Fetching Docker image from collection '%s'", runner.Container.ContainerImage)
253
254         d, err := os.Open(runner.ArvMountPoint + "/by_id/" + runner.Container.ContainerImage)
255         if err != nil {
256                 return "", err
257         }
258         defer d.Close()
259         allfiles, err := d.Readdirnames(-1)
260         if err != nil {
261                 return "", err
262         }
263         var tarfiles []string
264         for _, fnm := range allfiles {
265                 if strings.HasSuffix(fnm, ".tar") {
266                         tarfiles = append(tarfiles, fnm)
267                 }
268         }
269         if len(tarfiles) == 0 {
270                 return "", fmt.Errorf("image collection does not include a .tar image file")
271         }
272         if len(tarfiles) > 1 {
273                 return "", fmt.Errorf("cannot choose from multiple tar files in image collection: %v", tarfiles)
274         }
275         imageID := tarfiles[0][:len(tarfiles[0])-4]
276         imageTarballPath := runner.ArvMountPoint + "/by_id/" + runner.Container.ContainerImage + "/" + imageID + ".tar"
277         runner.CrunchLog.Printf("Using Docker image id %q", imageID)
278
279         runner.CrunchLog.Print("Loading Docker image from keep")
280         err = runner.executor.LoadImage(imageID, imageTarballPath, runner.Container, runner.ArvMountPoint,
281                 runner.containerClient)
282         if err != nil {
283                 return "", err
284         }
285
286         return imageID, nil
287 }
288
289 func (runner *ContainerRunner) ArvMountCmd(cmdline []string, token string) (c *exec.Cmd, err error) {
290         c = exec.Command(cmdline[0], cmdline[1:]...)
291
292         // Copy our environment, but override ARVADOS_API_TOKEN with
293         // the container auth token.
294         c.Env = nil
295         for _, s := range os.Environ() {
296                 if !strings.HasPrefix(s, "ARVADOS_API_TOKEN=") {
297                         c.Env = append(c.Env, s)
298                 }
299         }
300         c.Env = append(c.Env, "ARVADOS_API_TOKEN="+token)
301
302         runner.arvMountLog, err = runner.openLogFile("arv-mount")
303         if err != nil {
304                 return nil, err
305         }
306         scanner := logScanner{
307                 Patterns: []string{
308                         "Keep write error",
309                         "Block not found error",
310                         "Unhandled exception during FUSE operation",
311                 },
312                 ReportFunc: func(pattern, text string) {
313                         runner.updateRuntimeStatus(arvadosclient.Dict{
314                                 "warning":       "arv-mount: " + pattern,
315                                 "warningDetail": text,
316                         })
317                 },
318         }
319         c.Stdout = runner.arvMountLog
320         c.Stderr = io.MultiWriter(runner.arvMountLog, os.Stderr, &scanner)
321
322         runner.CrunchLog.Printf("Running %v", c.Args)
323
324         err = c.Start()
325         if err != nil {
326                 return nil, err
327         }
328
329         statReadme := make(chan bool)
330         runner.ArvMountExit = make(chan error)
331
332         keepStatting := true
333         go func() {
334                 for keepStatting {
335                         time.Sleep(100 * time.Millisecond)
336                         _, err = os.Stat(fmt.Sprintf("%s/by_id/README", runner.ArvMountPoint))
337                         if err == nil {
338                                 keepStatting = false
339                                 statReadme <- true
340                         }
341                 }
342                 close(statReadme)
343         }()
344
345         go func() {
346                 mnterr := c.Wait()
347                 if mnterr != nil {
348                         runner.CrunchLog.Printf("Arv-mount exit error: %v", mnterr)
349                 }
350                 runner.ArvMountExit <- mnterr
351                 close(runner.ArvMountExit)
352         }()
353
354         select {
355         case <-statReadme:
356                 break
357         case err := <-runner.ArvMountExit:
358                 runner.ArvMount = nil
359                 keepStatting = false
360                 return nil, err
361         }
362
363         return c, nil
364 }
365
366 func (runner *ContainerRunner) SetupArvMountPoint(prefix string) (err error) {
367         if runner.ArvMountPoint == "" {
368                 runner.ArvMountPoint, err = runner.MkTempDir(runner.parentTemp, prefix)
369         }
370         return
371 }
372
373 func copyfile(src string, dst string) (err error) {
374         srcfile, err := os.Open(src)
375         if err != nil {
376                 return
377         }
378
379         os.MkdirAll(path.Dir(dst), 0777)
380
381         dstfile, err := os.Create(dst)
382         if err != nil {
383                 return
384         }
385         _, err = io.Copy(dstfile, srcfile)
386         if err != nil {
387                 return
388         }
389
390         err = srcfile.Close()
391         err2 := dstfile.Close()
392
393         if err != nil {
394                 return
395         }
396
397         if err2 != nil {
398                 return err2
399         }
400
401         return nil
402 }
403
404 func (runner *ContainerRunner) SetupMounts() (map[string]bindmount, error) {
405         bindmounts := map[string]bindmount{}
406         err := runner.SetupArvMountPoint("keep")
407         if err != nil {
408                 return nil, fmt.Errorf("While creating keep mount temp dir: %v", err)
409         }
410
411         token, err := runner.ContainerToken()
412         if err != nil {
413                 return nil, fmt.Errorf("could not get container token: %s", err)
414         }
415         runner.CrunchLog.Printf("container token %q", token)
416
417         pdhOnly := true
418         tmpcount := 0
419         arvMountCmd := []string{
420                 "arv-mount",
421                 "--foreground",
422                 "--read-write",
423                 "--storage-classes", strings.Join(runner.Container.OutputStorageClasses, ","),
424                 fmt.Sprintf("--crunchstat-interval=%v", runner.statInterval.Seconds())}
425
426         if _, isdocker := runner.executor.(*dockerExecutor); isdocker {
427                 arvMountCmd = append(arvMountCmd, "--allow-other")
428         }
429
430         if runner.Container.RuntimeConstraints.KeepCacheDisk > 0 {
431                 keepcachedir, err := runner.MkTempDir(runner.parentTemp, "keepcache")
432                 if err != nil {
433                         return nil, fmt.Errorf("while creating keep cache temp dir: %v", err)
434                 }
435                 arvMountCmd = append(arvMountCmd, "--disk-cache", "--disk-cache-dir", keepcachedir, "--file-cache", fmt.Sprintf("%d", runner.Container.RuntimeConstraints.KeepCacheDisk))
436         } else if runner.Container.RuntimeConstraints.KeepCacheRAM > 0 {
437                 arvMountCmd = append(arvMountCmd, "--ram-cache", "--file-cache", fmt.Sprintf("%d", runner.Container.RuntimeConstraints.KeepCacheRAM))
438         }
439
440         collectionPaths := []string{}
441         needCertMount := true
442         type copyFile struct {
443                 src  string
444                 bind string
445         }
446         var copyFiles []copyFile
447
448         var binds []string
449         for bind := range runner.Container.Mounts {
450                 binds = append(binds, bind)
451         }
452         for bind := range runner.SecretMounts {
453                 if _, ok := runner.Container.Mounts[bind]; ok {
454                         return nil, fmt.Errorf("secret mount %q conflicts with regular mount", bind)
455                 }
456                 if runner.SecretMounts[bind].Kind != "json" &&
457                         runner.SecretMounts[bind].Kind != "text" {
458                         return nil, fmt.Errorf("secret mount %q type is %q but only 'json' and 'text' are permitted",
459                                 bind, runner.SecretMounts[bind].Kind)
460                 }
461                 binds = append(binds, bind)
462         }
463         sort.Strings(binds)
464
465         for _, bind := range binds {
466                 mnt, notSecret := runner.Container.Mounts[bind]
467                 if !notSecret {
468                         mnt = runner.SecretMounts[bind]
469                 }
470                 if bind == "stdout" || bind == "stderr" {
471                         // Is it a "file" mount kind?
472                         if mnt.Kind != "file" {
473                                 return nil, fmt.Errorf("unsupported mount kind '%s' for %s: only 'file' is supported", mnt.Kind, bind)
474                         }
475
476                         // Does path start with OutputPath?
477                         prefix := runner.Container.OutputPath
478                         if !strings.HasSuffix(prefix, "/") {
479                                 prefix += "/"
480                         }
481                         if !strings.HasPrefix(mnt.Path, prefix) {
482                                 return nil, fmt.Errorf("%s path does not start with OutputPath: %s, %s", strings.Title(bind), mnt.Path, prefix)
483                         }
484                 }
485
486                 if bind == "stdin" {
487                         // Is it a "collection" mount kind?
488                         if mnt.Kind != "collection" && mnt.Kind != "json" {
489                                 return nil, fmt.Errorf("unsupported mount kind '%s' for stdin: only 'collection' and 'json' are supported", mnt.Kind)
490                         }
491                 }
492
493                 if bind == arvadosCertPath {
494                         needCertMount = false
495                 }
496
497                 if strings.HasPrefix(bind, runner.Container.OutputPath+"/") && bind != runner.Container.OutputPath+"/" {
498                         if mnt.Kind != "collection" && mnt.Kind != "text" && mnt.Kind != "json" {
499                                 return nil, fmt.Errorf("only mount points of kind 'collection', 'text' or 'json' are supported underneath the output_path for %q, was %q", bind, mnt.Kind)
500                         }
501                 }
502
503                 switch {
504                 case mnt.Kind == "collection" && bind != "stdin":
505                         var src string
506                         if mnt.UUID != "" && mnt.PortableDataHash != "" {
507                                 return nil, fmt.Errorf("cannot specify both 'uuid' and 'portable_data_hash' for a collection mount")
508                         }
509                         if mnt.UUID != "" {
510                                 if mnt.Writable {
511                                         return nil, fmt.Errorf("writing to existing collections currently not permitted")
512                                 }
513                                 pdhOnly = false
514                                 src = fmt.Sprintf("%s/by_id/%s", runner.ArvMountPoint, mnt.UUID)
515                         } else if mnt.PortableDataHash != "" {
516                                 if mnt.Writable && !strings.HasPrefix(bind, runner.Container.OutputPath+"/") {
517                                         return nil, fmt.Errorf("can never write to a collection specified by portable data hash")
518                                 }
519                                 idx := strings.Index(mnt.PortableDataHash, "/")
520                                 if idx > 0 {
521                                         mnt.Path = path.Clean(mnt.PortableDataHash[idx:])
522                                         mnt.PortableDataHash = mnt.PortableDataHash[0:idx]
523                                         runner.Container.Mounts[bind] = mnt
524                                 }
525                                 src = fmt.Sprintf("%s/by_id/%s", runner.ArvMountPoint, mnt.PortableDataHash)
526                                 if mnt.Path != "" && mnt.Path != "." {
527                                         if strings.HasPrefix(mnt.Path, "./") {
528                                                 mnt.Path = mnt.Path[2:]
529                                         } else if strings.HasPrefix(mnt.Path, "/") {
530                                                 mnt.Path = mnt.Path[1:]
531                                         }
532                                         src += "/" + mnt.Path
533                                 }
534                         } else {
535                                 src = fmt.Sprintf("%s/tmp%d", runner.ArvMountPoint, tmpcount)
536                                 arvMountCmd = append(arvMountCmd, "--mount-tmp", fmt.Sprintf("tmp%d", tmpcount))
537                                 tmpcount++
538                         }
539                         if mnt.Writable {
540                                 if bind == runner.Container.OutputPath {
541                                         runner.HostOutputDir = src
542                                         bindmounts[bind] = bindmount{HostPath: src}
543                                 } else if strings.HasPrefix(bind, runner.Container.OutputPath+"/") {
544                                         copyFiles = append(copyFiles, copyFile{src, runner.HostOutputDir + bind[len(runner.Container.OutputPath):]})
545                                 } else {
546                                         bindmounts[bind] = bindmount{HostPath: src}
547                                 }
548                         } else {
549                                 bindmounts[bind] = bindmount{HostPath: src, ReadOnly: true}
550                         }
551                         collectionPaths = append(collectionPaths, src)
552
553                 case mnt.Kind == "tmp":
554                         var tmpdir string
555                         tmpdir, err = runner.MkTempDir(runner.parentTemp, "tmp")
556                         if err != nil {
557                                 return nil, fmt.Errorf("while creating mount temp dir: %v", err)
558                         }
559                         st, staterr := os.Stat(tmpdir)
560                         if staterr != nil {
561                                 return nil, fmt.Errorf("while Stat on temp dir: %v", staterr)
562                         }
563                         err = os.Chmod(tmpdir, st.Mode()|os.ModeSetgid|0777)
564                         if staterr != nil {
565                                 return nil, fmt.Errorf("while Chmod temp dir: %v", err)
566                         }
567                         bindmounts[bind] = bindmount{HostPath: tmpdir}
568                         if bind == runner.Container.OutputPath {
569                                 runner.HostOutputDir = tmpdir
570                         }
571
572                 case mnt.Kind == "json" || mnt.Kind == "text":
573                         var filedata []byte
574                         if mnt.Kind == "json" {
575                                 filedata, err = json.Marshal(mnt.Content)
576                                 if err != nil {
577                                         return nil, fmt.Errorf("encoding json data: %v", err)
578                                 }
579                         } else {
580                                 text, ok := mnt.Content.(string)
581                                 if !ok {
582                                         return nil, fmt.Errorf("content for mount %q must be a string", bind)
583                                 }
584                                 filedata = []byte(text)
585                         }
586
587                         tmpdir, err := runner.MkTempDir(runner.parentTemp, mnt.Kind)
588                         if err != nil {
589                                 return nil, fmt.Errorf("creating temp dir: %v", err)
590                         }
591                         tmpfn := filepath.Join(tmpdir, "mountdata."+mnt.Kind)
592                         err = ioutil.WriteFile(tmpfn, filedata, 0444)
593                         if err != nil {
594                                 return nil, fmt.Errorf("writing temp file: %v", err)
595                         }
596                         if strings.HasPrefix(bind, runner.Container.OutputPath+"/") && (notSecret || runner.Container.Mounts[runner.Container.OutputPath].Kind != "collection") {
597                                 // In most cases, if the container
598                                 // specifies a literal file inside the
599                                 // output path, we copy it into the
600                                 // output directory (either a mounted
601                                 // collection or a staging area on the
602                                 // host fs). If it's a secret, it will
603                                 // be skipped when copying output from
604                                 // staging to Keep later.
605                                 copyFiles = append(copyFiles, copyFile{tmpfn, runner.HostOutputDir + bind[len(runner.Container.OutputPath):]})
606                         } else {
607                                 // If a secret is outside OutputPath,
608                                 // we bind mount the secret file
609                                 // directly just like other mounts. We
610                                 // also use this strategy when a
611                                 // secret is inside OutputPath but
612                                 // OutputPath is a live collection, to
613                                 // avoid writing the secret to
614                                 // Keep. Attempting to remove a
615                                 // bind-mounted secret file from
616                                 // inside the container will return a
617                                 // "Device or resource busy" error
618                                 // that might not be handled well by
619                                 // the container, which is why we
620                                 // don't use this strategy when
621                                 // OutputPath is a staging directory.
622                                 bindmounts[bind] = bindmount{HostPath: tmpfn, ReadOnly: true}
623                         }
624                 }
625         }
626
627         if runner.HostOutputDir == "" {
628                 return nil, fmt.Errorf("output path does not correspond to a writable mount point")
629         }
630
631         if needCertMount && runner.Container.RuntimeConstraints.API {
632                 for _, certfile := range []string{
633                         // Populated by caller, or sdk/go/arvados init(), or test suite:
634                         os.Getenv("SSL_CERT_FILE"),
635                         // Copied from Go 1.21 stdlib (src/crypto/x509/root_linux.go):
636                         "/etc/ssl/certs/ca-certificates.crt",                // Debian/Ubuntu/Gentoo etc.
637                         "/etc/pki/tls/certs/ca-bundle.crt",                  // Fedora/RHEL 6
638                         "/etc/ssl/ca-bundle.pem",                            // OpenSUSE
639                         "/etc/pki/tls/cacert.pem",                           // OpenELEC
640                         "/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem", // CentOS/RHEL 7
641                         "/etc/ssl/cert.pem",                                 // Alpine Linux
642                 } {
643                         if _, err := os.Stat(certfile); err == nil {
644                                 bindmounts[arvadosCertPath] = bindmount{HostPath: certfile, ReadOnly: true}
645                                 break
646                         }
647                 }
648         }
649
650         if pdhOnly {
651                 // If we are only mounting collections by pdh, make
652                 // sure we don't subscribe to websocket events to
653                 // avoid putting undesired load on the API server
654                 arvMountCmd = append(arvMountCmd, "--mount-by-pdh", "by_id", "--disable-event-listening")
655         } else {
656                 arvMountCmd = append(arvMountCmd, "--mount-by-id", "by_id")
657         }
658         // the by_uuid mount point is used by singularity when writing
659         // out docker images converted to SIF
660         arvMountCmd = append(arvMountCmd, "--mount-by-id", "by_uuid")
661         arvMountCmd = append(arvMountCmd, runner.ArvMountPoint)
662
663         runner.ArvMount, err = runner.RunArvMount(arvMountCmd, token)
664         if err != nil {
665                 return nil, fmt.Errorf("while trying to start arv-mount: %v", err)
666         }
667         if runner.hoststatReporter != nil && runner.ArvMount != nil {
668                 runner.hoststatReporter.ReportPID("arv-mount", runner.ArvMount.Process.Pid)
669         }
670
671         for _, p := range collectionPaths {
672                 _, err = os.Stat(p)
673                 if err != nil {
674                         return nil, fmt.Errorf("while checking that input files exist: %v", err)
675                 }
676         }
677
678         for _, cp := range copyFiles {
679                 st, err := os.Stat(cp.src)
680                 if err != nil {
681                         return nil, fmt.Errorf("while staging writable file from %q to %q: %v", cp.src, cp.bind, err)
682                 }
683                 if st.IsDir() {
684                         err = filepath.Walk(cp.src, func(walkpath string, walkinfo os.FileInfo, walkerr error) error {
685                                 if walkerr != nil {
686                                         return walkerr
687                                 }
688                                 target := path.Join(cp.bind, walkpath[len(cp.src):])
689                                 if walkinfo.Mode().IsRegular() {
690                                         copyerr := copyfile(walkpath, target)
691                                         if copyerr != nil {
692                                                 return copyerr
693                                         }
694                                         return os.Chmod(target, walkinfo.Mode()|0777)
695                                 } else if walkinfo.Mode().IsDir() {
696                                         mkerr := os.MkdirAll(target, 0777)
697                                         if mkerr != nil {
698                                                 return mkerr
699                                         }
700                                         return os.Chmod(target, walkinfo.Mode()|os.ModeSetgid|0777)
701                                 } else {
702                                         return fmt.Errorf("source %q is not a regular file or directory", cp.src)
703                                 }
704                         })
705                 } else if st.Mode().IsRegular() {
706                         err = copyfile(cp.src, cp.bind)
707                         if err == nil {
708                                 err = os.Chmod(cp.bind, st.Mode()|0777)
709                         }
710                 }
711                 if err != nil {
712                         return nil, fmt.Errorf("while staging writable file from %q to %q: %v", cp.src, cp.bind, err)
713                 }
714         }
715
716         return bindmounts, nil
717 }
718
719 func (runner *ContainerRunner) stopHoststat() error {
720         if runner.hoststatReporter == nil {
721                 return nil
722         }
723         runner.hoststatReporter.Stop()
724         runner.hoststatReporter.LogProcessMemMax(runner.CrunchLog)
725         err := runner.hoststatLogger.Close()
726         if err != nil {
727                 return fmt.Errorf("error closing hoststat logs: %v", err)
728         }
729         return nil
730 }
731
732 func (runner *ContainerRunner) startHoststat() error {
733         var err error
734         runner.hoststatLogger, err = runner.openLogFile("hoststat")
735         if err != nil {
736                 return err
737         }
738         runner.hoststatReporter = &crunchstat.Reporter{
739                 Logger: newLogWriter(runner.hoststatLogger),
740                 // Our own cgroup is the "host" cgroup, in the sense
741                 // that it accounts for resource usage outside the
742                 // container. It doesn't count _all_ resource usage on
743                 // the system.
744                 //
745                 // TODO?: Use the furthest ancestor of our own cgroup
746                 // that has stats available. (Currently crunchstat
747                 // does not have that capability.)
748                 Pid:        os.Getpid,
749                 PollPeriod: runner.statInterval,
750         }
751         runner.hoststatReporter.Start()
752         runner.hoststatReporter.ReportPID("crunch-run", os.Getpid())
753         return nil
754 }
755
756 func (runner *ContainerRunner) startCrunchstat() error {
757         var err error
758         runner.statLogger, err = runner.openLogFile("crunchstat")
759         if err != nil {
760                 return err
761         }
762         runner.statReporter = &crunchstat.Reporter{
763                 Pid:    runner.executor.Pid,
764                 FS:     runner.crunchstatFakeFS,
765                 Logger: newLogWriter(runner.statLogger),
766                 MemThresholds: map[string][]crunchstat.Threshold{
767                         "rss": crunchstat.NewThresholdsFromPercentages(runner.Container.RuntimeConstraints.RAM, []int64{90, 95, 99}),
768                 },
769                 PollPeriod:      runner.statInterval,
770                 TempDir:         runner.parentTemp,
771                 ThresholdLogger: runner.CrunchLog,
772         }
773         runner.statReporter.Start()
774         return nil
775 }
776
777 type infoCommand struct {
778         label string
779         cmd   []string
780 }
781
782 // LogHostInfo logs info about the current host, for debugging and
783 // accounting purposes. Although it's logged as "node-info", this is
784 // about the environment where crunch-run is actually running, which
785 // might differ from what's described in the node record (see
786 // LogNodeRecord).
787 func (runner *ContainerRunner) LogHostInfo() (err error) {
788         w, err := runner.openLogFile("node-info")
789         if err != nil {
790                 return
791         }
792
793         commands := []infoCommand{
794                 {
795                         label: "Host Information",
796                         cmd:   []string{"uname", "-a"},
797                 },
798                 {
799                         label: "CPU Information",
800                         cmd:   []string{"cat", "/proc/cpuinfo"},
801                 },
802                 {
803                         label: "Memory Information",
804                         cmd:   []string{"cat", "/proc/meminfo"},
805                 },
806                 {
807                         label: "Disk Space",
808                         cmd:   []string{"df", "-m", "/", os.TempDir()},
809                 },
810                 {
811                         label: "Disk INodes",
812                         cmd:   []string{"df", "-i", "/", os.TempDir()},
813                 },
814         }
815
816         // Run commands with informational output to be logged.
817         for _, command := range commands {
818                 fmt.Fprintln(w, command.label)
819                 cmd := exec.Command(command.cmd[0], command.cmd[1:]...)
820                 cmd.Stdout = w
821                 cmd.Stderr = w
822                 if err := cmd.Run(); err != nil {
823                         err = fmt.Errorf("While running command %q: %v", command.cmd, err)
824                         fmt.Fprintln(w, err)
825                         return err
826                 }
827                 fmt.Fprintln(w, "")
828         }
829
830         err = w.Close()
831         if err != nil {
832                 return fmt.Errorf("While closing node-info logs: %v", err)
833         }
834         return nil
835 }
836
837 // LogContainerRecord gets and saves the raw JSON container record from the API server
838 func (runner *ContainerRunner) LogContainerRecord() error {
839         logged, err := runner.logAPIResponse("container", "containers", map[string]interface{}{"filters": [][]string{{"uuid", "=", runner.Container.UUID}}})
840         if !logged && err == nil {
841                 err = fmt.Errorf("error: no container record found for %s", runner.Container.UUID)
842         }
843         return err
844 }
845
846 // LogNodeRecord logs the current host's InstanceType config entry, if
847 // running via arvados-dispatch-cloud.
848 func (runner *ContainerRunner) LogNodeRecord() error {
849         it := os.Getenv("InstanceType")
850         if it == "" {
851                 // Not dispatched by arvados-dispatch-cloud.
852                 return nil
853         }
854         // Save InstanceType config fragment received from dispatcher
855         // on stdin.
856         w, err := runner.LogCollection.OpenFile("node.json", os.O_CREATE|os.O_WRONLY, 0666)
857         if err != nil {
858                 return err
859         }
860         defer w.Close()
861         _, err = io.WriteString(w, it)
862         if err != nil {
863                 return err
864         }
865         return w.Close()
866 }
867
868 func (runner *ContainerRunner) logAPIResponse(label, path string, params map[string]interface{}) (logged bool, err error) {
869         writer, err := runner.LogCollection.OpenFile(label+".json", os.O_CREATE|os.O_WRONLY, 0666)
870         if err != nil {
871                 return false, err
872         }
873         reader, err := runner.DispatcherArvClient.CallRaw("GET", path, "", "", arvadosclient.Dict(params))
874         if err != nil {
875                 return false, fmt.Errorf("error getting %s record: %v", label, err)
876         }
877         defer reader.Close()
878
879         dec := json.NewDecoder(reader)
880         dec.UseNumber()
881         var resp map[string]interface{}
882         if err = dec.Decode(&resp); err != nil {
883                 return false, fmt.Errorf("error decoding %s list response: %v", label, err)
884         }
885         items, ok := resp["items"].([]interface{})
886         if !ok {
887                 return false, fmt.Errorf("error decoding %s list response: no \"items\" key in API list response", label)
888         } else if len(items) < 1 {
889                 return false, nil
890         }
891         // Re-encode it using indentation to improve readability
892         enc := json.NewEncoder(writer)
893         enc.SetIndent("", "    ")
894         if err = enc.Encode(items[0]); err != nil {
895                 return false, fmt.Errorf("error logging %s record: %v", label, err)
896         }
897         err = writer.Close()
898         if err != nil {
899                 return false, fmt.Errorf("error closing %s.json in log collection: %v", label, err)
900         }
901         return true, nil
902 }
903
904 func (runner *ContainerRunner) getStdoutFile(mntPath string) (*os.File, error) {
905         stdoutPath := mntPath[len(runner.Container.OutputPath):]
906         index := strings.LastIndex(stdoutPath, "/")
907         if index > 0 {
908                 subdirs := stdoutPath[:index]
909                 if subdirs != "" {
910                         st, err := os.Stat(runner.HostOutputDir)
911                         if err != nil {
912                                 return nil, fmt.Errorf("While Stat on temp dir: %v", err)
913                         }
914                         stdoutPath := filepath.Join(runner.HostOutputDir, subdirs)
915                         err = os.MkdirAll(stdoutPath, st.Mode()|os.ModeSetgid|0777)
916                         if err != nil {
917                                 return nil, fmt.Errorf("While MkdirAll %q: %v", stdoutPath, err)
918                         }
919                 }
920         }
921         stdoutFile, err := os.Create(filepath.Join(runner.HostOutputDir, stdoutPath))
922         if err != nil {
923                 return nil, fmt.Errorf("While creating file %q: %v", stdoutPath, err)
924         }
925
926         return stdoutFile, nil
927 }
928
929 // CreateContainer creates the docker container.
930 func (runner *ContainerRunner) CreateContainer(imageID string, bindmounts map[string]bindmount) error {
931         var stdin io.ReadCloser = ioutil.NopCloser(bytes.NewReader(nil))
932         if mnt, ok := runner.Container.Mounts["stdin"]; ok {
933                 switch mnt.Kind {
934                 case "collection":
935                         var collID string
936                         if mnt.UUID != "" {
937                                 collID = mnt.UUID
938                         } else {
939                                 collID = mnt.PortableDataHash
940                         }
941                         path := runner.ArvMountPoint + "/by_id/" + collID + "/" + mnt.Path
942                         f, err := os.Open(path)
943                         if err != nil {
944                                 return err
945                         }
946                         stdin = f
947                 case "json":
948                         j, err := json.Marshal(mnt.Content)
949                         if err != nil {
950                                 return fmt.Errorf("error encoding stdin json data: %v", err)
951                         }
952                         stdin = ioutil.NopCloser(bytes.NewReader(j))
953                 default:
954                         return fmt.Errorf("stdin mount has unsupported kind %q", mnt.Kind)
955                 }
956         }
957
958         var stdout, stderr io.WriteCloser
959         if mnt, ok := runner.Container.Mounts["stdout"]; ok {
960                 f, err := runner.getStdoutFile(mnt.Path)
961                 if err != nil {
962                         return err
963                 }
964                 stdout = f
965         } else if w, err := runner.openLogFile("stdout"); err != nil {
966                 return err
967         } else {
968                 stdout = w
969         }
970
971         if mnt, ok := runner.Container.Mounts["stderr"]; ok {
972                 f, err := runner.getStdoutFile(mnt.Path)
973                 if err != nil {
974                         return err
975                 }
976                 stderr = f
977         } else if w, err := runner.openLogFile("stderr"); err != nil {
978                 return err
979         } else {
980                 stderr = w
981         }
982
983         env := runner.Container.Environment
984         enableNetwork := runner.enableNetwork == "always"
985         if runner.Container.RuntimeConstraints.API {
986                 enableNetwork = true
987                 tok, err := runner.ContainerToken()
988                 if err != nil {
989                         return err
990                 }
991                 env = map[string]string{}
992                 for k, v := range runner.Container.Environment {
993                         env[k] = v
994                 }
995                 env["ARVADOS_API_TOKEN"] = tok
996                 env["ARVADOS_API_HOST"] = os.Getenv("ARVADOS_API_HOST")
997                 env["ARVADOS_API_HOST_INSECURE"] = os.Getenv("ARVADOS_API_HOST_INSECURE")
998                 env["ARVADOS_KEEP_SERVICES"] = os.Getenv("ARVADOS_KEEP_SERVICES")
999         }
1000         workdir := runner.Container.Cwd
1001         if workdir == "." {
1002                 // both "" and "." mean default
1003                 workdir = ""
1004         }
1005         ram := runner.Container.RuntimeConstraints.RAM
1006         if !runner.enableMemoryLimit {
1007                 ram = 0
1008         }
1009         runner.executorStdin = stdin
1010         runner.executorStdout = stdout
1011         runner.executorStderr = stderr
1012
1013         if runner.Container.RuntimeConstraints.CUDA.DeviceCount > 0 {
1014                 nvidiaModprobe(runner.CrunchLog)
1015         }
1016
1017         return runner.executor.Create(containerSpec{
1018                 Image:           imageID,
1019                 VCPUs:           runner.Container.RuntimeConstraints.VCPUs,
1020                 RAM:             ram,
1021                 WorkingDir:      workdir,
1022                 Env:             env,
1023                 BindMounts:      bindmounts,
1024                 Command:         runner.Container.Command,
1025                 EnableNetwork:   enableNetwork,
1026                 CUDADeviceCount: runner.Container.RuntimeConstraints.CUDA.DeviceCount,
1027                 NetworkMode:     runner.networkMode,
1028                 CgroupParent:    runner.setCgroupParent,
1029                 Stdin:           stdin,
1030                 Stdout:          stdout,
1031                 Stderr:          stderr,
1032         })
1033 }
1034
1035 // StartContainer starts the docker container created by CreateContainer.
1036 func (runner *ContainerRunner) StartContainer() error {
1037         runner.CrunchLog.Printf("Starting container")
1038         runner.cStateLock.Lock()
1039         defer runner.cStateLock.Unlock()
1040         if runner.cCancelled {
1041                 return ErrCancelled
1042         }
1043         err := runner.executor.Start()
1044         if err != nil {
1045                 var advice string
1046                 if m, e := regexp.MatchString("(?ms).*(exec|System error).*(no such file or directory|file not found).*", err.Error()); m && e == nil {
1047                         advice = fmt.Sprintf("\nPossible causes: command %q is missing, the interpreter given in #! is missing, or script has Windows line endings.", runner.Container.Command[0])
1048                 }
1049                 return fmt.Errorf("could not start container: %v%s", err, advice)
1050         }
1051         return nil
1052 }
1053
1054 // WaitFinish waits for the container to terminate, capture the exit code, and
1055 // close the stdout/stderr logging.
1056 func (runner *ContainerRunner) WaitFinish() error {
1057         runner.CrunchLog.Print("Waiting for container to finish")
1058         var timeout <-chan time.Time
1059         if s := runner.Container.SchedulingParameters.MaxRunTime; s > 0 {
1060                 timeout = time.After(time.Duration(s) * time.Second)
1061         }
1062         ctx, cancel := context.WithCancel(context.Background())
1063         defer cancel()
1064         go func() {
1065                 select {
1066                 case <-timeout:
1067                         runner.CrunchLog.Printf("maximum run time exceeded. Stopping container.")
1068                         runner.stop(nil)
1069                 case <-runner.ArvMountExit:
1070                         runner.CrunchLog.Printf("arv-mount exited while container is still running. Stopping container.")
1071                         runner.stop(nil)
1072                 case <-ctx.Done():
1073                 }
1074         }()
1075         exitcode, err := runner.executor.Wait(ctx)
1076         if err != nil {
1077                 runner.checkBrokenNode(err)
1078                 return err
1079         }
1080         runner.ExitCode = &exitcode
1081
1082         extra := ""
1083         if exitcode&0x80 != 0 {
1084                 // Convert raw exit status (0x80 + signal number) to a
1085                 // string to log after the code, like " (signal 101)"
1086                 // or " (signal 9, killed)"
1087                 sig := syscall.WaitStatus(exitcode).Signal()
1088                 if name := unix.SignalName(sig); name != "" {
1089                         extra = fmt.Sprintf(" (signal %d, %s)", sig, name)
1090                 } else {
1091                         extra = fmt.Sprintf(" (signal %d)", sig)
1092                 }
1093         }
1094         runner.CrunchLog.Printf("Container exited with status code %d%s", exitcode, extra)
1095         err = runner.DispatcherArvClient.Update("containers", runner.Container.UUID, arvadosclient.Dict{
1096                 "select":    []string{"uuid"},
1097                 "container": arvadosclient.Dict{"exit_code": exitcode},
1098         }, nil)
1099         if err != nil {
1100                 runner.CrunchLog.Printf("ignoring error updating exit_code: %s", err)
1101         }
1102
1103         var returnErr error
1104         if err = runner.executorStdin.Close(); err != nil {
1105                 err = fmt.Errorf("error closing container stdin: %s", err)
1106                 runner.CrunchLog.Printf("%s", err)
1107                 returnErr = err
1108         }
1109         if err = runner.executorStdout.Close(); err != nil {
1110                 err = fmt.Errorf("error closing container stdout: %s", err)
1111                 runner.CrunchLog.Printf("%s", err)
1112                 if returnErr == nil {
1113                         returnErr = err
1114                 }
1115         }
1116         if err = runner.executorStderr.Close(); err != nil {
1117                 err = fmt.Errorf("error closing container stderr: %s", err)
1118                 runner.CrunchLog.Printf("%s", err)
1119                 if returnErr == nil {
1120                         returnErr = err
1121                 }
1122         }
1123
1124         if runner.statReporter != nil {
1125                 runner.statReporter.Stop()
1126                 runner.statReporter.LogMaxima(runner.CrunchLog, map[string]int64{
1127                         "rss": runner.Container.RuntimeConstraints.RAM,
1128                 })
1129                 err = runner.statLogger.Close()
1130                 if err != nil {
1131                         runner.CrunchLog.Printf("error closing crunchstat logs: %v", err)
1132                 }
1133         }
1134         return returnErr
1135 }
1136
1137 func (runner *ContainerRunner) updateLogs() {
1138         ticker := time.NewTicker(crunchLogUpdatePeriod / 360)
1139         defer ticker.Stop()
1140
1141         sigusr1 := make(chan os.Signal, 1)
1142         signal.Notify(sigusr1, syscall.SIGUSR1)
1143         defer signal.Stop(sigusr1)
1144
1145         saveAtTime := time.Now().Add(crunchLogUpdatePeriod)
1146         saveAtSize := crunchLogUpdateSize
1147         var savedSize int64
1148         for {
1149                 select {
1150                 case <-ticker.C:
1151                 case <-sigusr1:
1152                         saveAtTime = time.Now()
1153                 }
1154                 runner.logMtx.Lock()
1155                 done := runner.LogsPDH != nil
1156                 runner.logMtx.Unlock()
1157                 if done {
1158                         return
1159                 }
1160                 size := runner.LogCollection.Size()
1161                 if size == savedSize || (time.Now().Before(saveAtTime) && size < saveAtSize) {
1162                         continue
1163                 }
1164                 saveAtTime = time.Now().Add(crunchLogUpdatePeriod)
1165                 saveAtSize = runner.LogCollection.Size() + crunchLogUpdateSize
1166                 saved, err := runner.saveLogCollection(false)
1167                 if err != nil {
1168                         runner.CrunchLog.Printf("error updating log collection: %s", err)
1169                         continue
1170                 }
1171
1172                 err = runner.DispatcherArvClient.Update("containers", runner.Container.UUID, arvadosclient.Dict{
1173                         "select": []string{"uuid"},
1174                         "container": arvadosclient.Dict{
1175                                 "log": saved.PortableDataHash,
1176                         },
1177                 }, nil)
1178                 if err != nil {
1179                         runner.CrunchLog.Printf("error updating container log to %s: %s", saved.PortableDataHash, err)
1180                         continue
1181                 }
1182
1183                 savedSize = size
1184         }
1185 }
1186
1187 var spotInterruptionCheckInterval = 5 * time.Second
1188 var ec2MetadataBaseURL = "http://169.254.169.254"
1189
1190 const ec2TokenTTL = time.Second * 21600
1191
1192 func (runner *ContainerRunner) checkSpotInterruptionNotices() {
1193         type ec2metadata struct {
1194                 Action string    `json:"action"`
1195                 Time   time.Time `json:"time"`
1196         }
1197         runner.CrunchLog.Printf("Checking for spot interruptions every %v using instance metadata at %s", spotInterruptionCheckInterval, ec2MetadataBaseURL)
1198         var metadata ec2metadata
1199         var token string
1200         var tokenExp time.Time
1201         check := func() error {
1202                 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(time.Minute))
1203                 defer cancel()
1204                 if token == "" || tokenExp.Sub(time.Now()) < time.Minute {
1205                         req, err := http.NewRequestWithContext(ctx, http.MethodPut, ec2MetadataBaseURL+"/latest/api/token", nil)
1206                         if err != nil {
1207                                 return err
1208                         }
1209                         req.Header.Set("X-aws-ec2-metadata-token-ttl-seconds", fmt.Sprintf("%d", int(ec2TokenTTL/time.Second)))
1210                         resp, err := http.DefaultClient.Do(req)
1211                         if err != nil {
1212                                 return err
1213                         }
1214                         defer resp.Body.Close()
1215                         if resp.StatusCode != http.StatusOK {
1216                                 return fmt.Errorf("%s", resp.Status)
1217                         }
1218                         newtoken, err := ioutil.ReadAll(resp.Body)
1219                         if err != nil {
1220                                 return err
1221                         }
1222                         token = strings.TrimSpace(string(newtoken))
1223                         tokenExp = time.Now().Add(ec2TokenTTL)
1224                 }
1225                 req, err := http.NewRequestWithContext(ctx, http.MethodGet, ec2MetadataBaseURL+"/latest/meta-data/spot/instance-action", nil)
1226                 if err != nil {
1227                         return err
1228                 }
1229                 req.Header.Set("X-aws-ec2-metadata-token", token)
1230                 resp, err := http.DefaultClient.Do(req)
1231                 if err != nil {
1232                         return err
1233                 }
1234                 defer resp.Body.Close()
1235                 metadata = ec2metadata{}
1236                 switch resp.StatusCode {
1237                 case http.StatusOK:
1238                         break
1239                 case http.StatusNotFound:
1240                         // "If Amazon EC2 is not preparing to stop or
1241                         // terminate the instance, or if you
1242                         // terminated the instance yourself,
1243                         // instance-action is not present in the
1244                         // instance metadata and you receive an HTTP
1245                         // 404 error when you try to retrieve it."
1246                         return nil
1247                 case http.StatusUnauthorized:
1248                         token = ""
1249                         return fmt.Errorf("%s", resp.Status)
1250                 default:
1251                         return fmt.Errorf("%s", resp.Status)
1252                 }
1253                 err = json.NewDecoder(resp.Body).Decode(&metadata)
1254                 if err != nil {
1255                         return err
1256                 }
1257                 return nil
1258         }
1259         failures := 0
1260         var lastmetadata ec2metadata
1261         for range time.NewTicker(spotInterruptionCheckInterval).C {
1262                 err := check()
1263                 if err != nil {
1264                         runner.CrunchLog.Printf("Error checking spot interruptions: %s", err)
1265                         failures++
1266                         if failures > 5 {
1267                                 runner.CrunchLog.Printf("Giving up on checking spot interruptions after too many consecutive failures")
1268                                 return
1269                         }
1270                         continue
1271                 }
1272                 failures = 0
1273                 if metadata != lastmetadata {
1274                         lastmetadata = metadata
1275                         text := fmt.Sprintf("Cloud provider scheduled instance %s at %s", metadata.Action, metadata.Time.UTC().Format(time.RFC3339))
1276                         runner.CrunchLog.Printf("%s", text)
1277                         runner.updateRuntimeStatus(arvadosclient.Dict{
1278                                 "warning":          "preemption notice",
1279                                 "warningDetail":    text,
1280                                 "preemptionNotice": text,
1281                         })
1282                         if proc, err := os.FindProcess(os.Getpid()); err == nil {
1283                                 // trigger updateLogs
1284                                 proc.Signal(syscall.SIGUSR1)
1285                         }
1286                 }
1287         }
1288 }
1289
1290 func (runner *ContainerRunner) updateRuntimeStatus(status arvadosclient.Dict) {
1291         err := runner.DispatcherArvClient.Update("containers", runner.Container.UUID, arvadosclient.Dict{
1292                 "select": []string{"uuid"},
1293                 "container": arvadosclient.Dict{
1294                         "runtime_status": status,
1295                 },
1296         }, nil)
1297         if err != nil {
1298                 runner.CrunchLog.Printf("error updating container runtime_status: %s", err)
1299         }
1300 }
1301
1302 // CaptureOutput saves data from the container's output directory if
1303 // needed, and updates the container output accordingly.
1304 func (runner *ContainerRunner) CaptureOutput(bindmounts map[string]bindmount) error {
1305         if runner.Container.RuntimeConstraints.API {
1306                 // Output may have been set directly by the container, so
1307                 // refresh the container record to check.
1308                 err := runner.DispatcherArvClient.Get("containers", runner.Container.UUID,
1309                         arvadosclient.Dict{
1310                                 "select": []string{"output"},
1311                         }, &runner.Container)
1312                 if err != nil {
1313                         return err
1314                 }
1315                 if runner.Container.Output != "" {
1316                         // Container output is already set.
1317                         runner.OutputPDH = &runner.Container.Output
1318                         return nil
1319                 }
1320         }
1321
1322         txt, err := (&copier{
1323                 client:        runner.containerClient,
1324                 keepClient:    runner.ContainerKeepClient,
1325                 hostOutputDir: runner.HostOutputDir,
1326                 ctrOutputDir:  runner.Container.OutputPath,
1327                 globs:         runner.Container.OutputGlob,
1328                 bindmounts:    bindmounts,
1329                 mounts:        runner.Container.Mounts,
1330                 secretMounts:  runner.SecretMounts,
1331                 logger:        runner.CrunchLog,
1332         }).Copy()
1333         if err != nil {
1334                 return err
1335         }
1336         if n := len(regexp.MustCompile(` [0-9a-f]+\+\S*\+R`).FindAllStringIndex(txt, -1)); n > 0 {
1337                 runner.CrunchLog.Printf("Copying %d data blocks from remote input collections...", n)
1338                 fs, err := (&arvados.Collection{ManifestText: txt}).FileSystem(runner.containerClient, runner.ContainerKeepClient)
1339                 if err != nil {
1340                         return err
1341                 }
1342                 txt, err = fs.MarshalManifest(".")
1343                 if err != nil {
1344                         return err
1345                 }
1346         }
1347         var resp arvados.Collection
1348         err = runner.ContainerArvClient.Create("collections", arvadosclient.Dict{
1349                 "ensure_unique_name": true,
1350                 "select":             []string{"portable_data_hash"},
1351                 "collection": arvadosclient.Dict{
1352                         "is_trashed":    true,
1353                         "name":          "output for " + runner.Container.UUID,
1354                         "manifest_text": txt,
1355                 },
1356         }, &resp)
1357         if err != nil {
1358                 return fmt.Errorf("error creating output collection: %v", err)
1359         }
1360         runner.OutputPDH = &resp.PortableDataHash
1361         return nil
1362 }
1363
1364 func (runner *ContainerRunner) CleanupDirs() {
1365         if runner.ArvMount != nil {
1366                 var delay int64 = 8
1367                 umount := exec.Command("arv-mount", fmt.Sprintf("--unmount-timeout=%d", delay), "--unmount", runner.ArvMountPoint)
1368                 umount.Stdout = runner.CrunchLog
1369                 umount.Stderr = runner.CrunchLog
1370                 runner.CrunchLog.Printf("Running %v", umount.Args)
1371                 umnterr := umount.Start()
1372
1373                 if umnterr != nil {
1374                         runner.CrunchLog.Printf("Error unmounting: %v", umnterr)
1375                         runner.ArvMount.Process.Kill()
1376                 } else {
1377                         // If arv-mount --unmount gets stuck for any reason, we
1378                         // don't want to wait for it forever.  Do Wait() in a goroutine
1379                         // so it doesn't block crunch-run.
1380                         umountExit := make(chan error)
1381                         go func() {
1382                                 mnterr := umount.Wait()
1383                                 if mnterr != nil {
1384                                         runner.CrunchLog.Printf("Error unmounting: %v", mnterr)
1385                                 }
1386                                 umountExit <- mnterr
1387                         }()
1388
1389                         for again := true; again; {
1390                                 again = false
1391                                 select {
1392                                 case <-umountExit:
1393                                         umount = nil
1394                                         again = true
1395                                 case <-runner.ArvMountExit:
1396                                         break
1397                                 case <-time.After(time.Duration((delay + 1) * int64(time.Second))):
1398                                         runner.CrunchLog.Printf("Timed out waiting for unmount")
1399                                         if umount != nil {
1400                                                 umount.Process.Kill()
1401                                         }
1402                                         runner.ArvMount.Process.Kill()
1403                                 }
1404                         }
1405                 }
1406                 runner.ArvMount = nil
1407         }
1408
1409         if runner.ArvMountPoint != "" {
1410                 if rmerr := os.Remove(runner.ArvMountPoint); rmerr != nil {
1411                         runner.CrunchLog.Printf("While cleaning up arv-mount directory %s: %v", runner.ArvMountPoint, rmerr)
1412                 }
1413                 runner.ArvMountPoint = ""
1414         }
1415
1416         if rmerr := os.RemoveAll(runner.parentTemp); rmerr != nil {
1417                 runner.CrunchLog.Printf("While cleaning up temporary directory %s: %v", runner.parentTemp, rmerr)
1418         }
1419 }
1420
1421 // CommitLogs posts the collection containing the final container logs.
1422 func (runner *ContainerRunner) CommitLogs() error {
1423         func() {
1424                 // Hold cStateLock to prevent races on CrunchLog (e.g., stop()).
1425                 runner.cStateLock.Lock()
1426                 defer runner.cStateLock.Unlock()
1427
1428                 runner.CrunchLog.Print(runner.finalState)
1429
1430                 if runner.arvMountLog != nil {
1431                         runner.arvMountLog.Close()
1432                 }
1433
1434                 // From now on just log to stderr, in case there are
1435                 // any other further errors (such as failing to write
1436                 // the log to Keep!)  while shutting down
1437                 runner.CrunchLog = newLogWriter(newTimestamper(newStringPrefixer(os.Stderr, runner.Container.UUID+" ")))
1438         }()
1439
1440         if runner.keepstoreLogger != nil {
1441                 // Flush any buffered logs from our local keepstore
1442                 // process.  Discard anything logged after this point
1443                 // -- it won't end up in the log collection, so
1444                 // there's no point writing it to the collectionfs.
1445                 runner.keepstoreLogbuf.SetWriter(io.Discard)
1446                 runner.keepstoreLogger.Close()
1447                 runner.keepstoreLogger = nil
1448         }
1449
1450         if runner.LogsPDH != nil {
1451                 // If we have already assigned something to LogsPDH,
1452                 // we must be closing the re-opened log, which won't
1453                 // end up getting attached to the container record and
1454                 // therefore doesn't need to be saved as a collection
1455                 // -- it exists only to send logs to other channels.
1456                 return nil
1457         }
1458
1459         saved, err := runner.saveLogCollection(true)
1460         if err != nil {
1461                 return fmt.Errorf("error saving log collection: %s", err)
1462         }
1463         runner.logMtx.Lock()
1464         defer runner.logMtx.Unlock()
1465         runner.LogsPDH = &saved.PortableDataHash
1466         return nil
1467 }
1468
1469 // Create/update the log collection. Return value has UUID and
1470 // PortableDataHash fields populated, but others may be blank.
1471 func (runner *ContainerRunner) saveLogCollection(final bool) (response arvados.Collection, err error) {
1472         runner.logMtx.Lock()
1473         defer runner.logMtx.Unlock()
1474         if runner.LogsPDH != nil {
1475                 // Already finalized.
1476                 return
1477         }
1478         updates := arvadosclient.Dict{
1479                 "name": "logs for " + runner.Container.UUID,
1480         }
1481         mt, err1 := runner.LogCollection.MarshalManifest(".")
1482         if err1 == nil {
1483                 // Only send updated manifest text if there was no
1484                 // error.
1485                 updates["manifest_text"] = mt
1486         }
1487
1488         // Even if flushing the manifest had an error, we still want
1489         // to update the log record, if possible, to push the trash_at
1490         // and delete_at times into the future.  Details on bug
1491         // #17293.
1492         if final {
1493                 updates["is_trashed"] = true
1494         } else {
1495                 // We set trash_at so this collection gets
1496                 // automatically cleaned up eventually.  It used to be
1497                 // 12 hours but we had a situation where the API
1498                 // server was down over a weekend but the containers
1499                 // kept running such that the log collection got
1500                 // trashed, so now we make it 2 weeks.  refs #20378
1501                 exp := time.Now().Add(time.Duration(24*14) * time.Hour)
1502                 updates["trash_at"] = exp
1503                 updates["delete_at"] = exp
1504         }
1505         reqBody := arvadosclient.Dict{
1506                 "select":     []string{"uuid", "portable_data_hash"},
1507                 "collection": updates,
1508         }
1509         var err2 error
1510         if runner.logUUID == "" {
1511                 reqBody["ensure_unique_name"] = true
1512                 err2 = runner.DispatcherArvClient.Create("collections", reqBody, &response)
1513         } else {
1514                 err2 = runner.DispatcherArvClient.Update("collections", runner.logUUID, reqBody, &response)
1515         }
1516         if err2 == nil {
1517                 runner.logUUID = response.UUID
1518         }
1519
1520         if err1 != nil || err2 != nil {
1521                 err = fmt.Errorf("error recording logs: %q, %q", err1, err2)
1522         }
1523         return
1524 }
1525
1526 // UpdateContainerRunning updates the container state to "Running"
1527 func (runner *ContainerRunner) UpdateContainerRunning(logId string) error {
1528         runner.cStateLock.Lock()
1529         defer runner.cStateLock.Unlock()
1530         if runner.cCancelled {
1531                 return ErrCancelled
1532         }
1533         updates := arvadosclient.Dict{
1534                 "gateway_address": runner.gateway.Address,
1535                 "state":           "Running",
1536         }
1537         if logId != "" {
1538                 updates["log"] = logId
1539         }
1540         return runner.DispatcherArvClient.Update(
1541                 "containers",
1542                 runner.Container.UUID,
1543                 arvadosclient.Dict{
1544                         "select":    []string{"uuid"},
1545                         "container": updates,
1546                 },
1547                 nil,
1548         )
1549 }
1550
1551 // ContainerToken returns the api_token the container (and any
1552 // arv-mount processes) are allowed to use.
1553 func (runner *ContainerRunner) ContainerToken() (string, error) {
1554         if runner.token != "" {
1555                 return runner.token, nil
1556         }
1557
1558         var auth arvados.APIClientAuthorization
1559         err := runner.DispatcherArvClient.Call("GET", "containers", runner.Container.UUID, "auth", nil, &auth)
1560         if err != nil {
1561                 return "", err
1562         }
1563         runner.token = fmt.Sprintf("v2/%s/%s/%s", auth.UUID, auth.APIToken, runner.Container.UUID)
1564         return runner.token, nil
1565 }
1566
1567 // UpdateContainerFinal updates the container record state on API
1568 // server to "Complete" or "Cancelled"
1569 func (runner *ContainerRunner) UpdateContainerFinal() error {
1570         update := arvadosclient.Dict{}
1571         update["state"] = runner.finalState
1572         if runner.LogsPDH != nil {
1573                 update["log"] = *runner.LogsPDH
1574         }
1575         if runner.ExitCode != nil {
1576                 update["exit_code"] = *runner.ExitCode
1577         } else {
1578                 update["exit_code"] = nil
1579         }
1580         if runner.finalState == "Complete" && runner.OutputPDH != nil {
1581                 update["output"] = *runner.OutputPDH
1582         }
1583         update["cost"] = runner.calculateCost(time.Now())
1584         return runner.DispatcherArvClient.Update("containers", runner.Container.UUID, arvadosclient.Dict{
1585                 "select":    []string{"uuid"},
1586                 "container": update,
1587         }, nil)
1588 }
1589
1590 // IsCancelled returns the value of Cancelled, with goroutine safety.
1591 func (runner *ContainerRunner) IsCancelled() bool {
1592         runner.cStateLock.Lock()
1593         defer runner.cStateLock.Unlock()
1594         return runner.cCancelled
1595 }
1596
1597 func (runner *ContainerRunner) openLogFile(name string) (io.WriteCloser, error) {
1598         return runner.LogCollection.OpenFile(name+".txt", os.O_CREATE|os.O_WRONLY, 0666)
1599 }
1600
1601 // Run the full container lifecycle.
1602 func (runner *ContainerRunner) Run() (err error) {
1603         runner.CrunchLog.Printf("crunch-run %s started", cmd.Version.String())
1604         runner.CrunchLog.Printf("%s", currentUserAndGroups())
1605         v, _ := exec.Command("arv-mount", "--version").CombinedOutput()
1606         runner.CrunchLog.Printf("Using FUSE mount: %s", v)
1607         runner.CrunchLog.Printf("Using container runtime: %s", runner.executor.Runtime())
1608         runner.CrunchLog.Printf("Executing container: %s", runner.Container.UUID)
1609         runner.costStartTime = time.Now()
1610
1611         hostname, hosterr := os.Hostname()
1612         if hosterr != nil {
1613                 runner.CrunchLog.Printf("Error getting hostname '%v'", hosterr)
1614         } else {
1615                 runner.CrunchLog.Printf("Executing on host '%s'", hostname)
1616         }
1617
1618         sigusr2 := make(chan os.Signal, 1)
1619         signal.Notify(sigusr2, syscall.SIGUSR2)
1620         defer signal.Stop(sigusr2)
1621         runner.loadPrices()
1622         go runner.handleSIGUSR2(sigusr2)
1623
1624         runner.finalState = "Queued"
1625
1626         defer func() {
1627                 runner.CleanupDirs()
1628                 runner.CrunchLog.Printf("crunch-run finished")
1629         }()
1630
1631         err = runner.fetchContainerRecord()
1632         if err != nil {
1633                 return
1634         }
1635         if runner.Container.State != "Locked" {
1636                 return fmt.Errorf("dispatch error detected: container %q has state %q", runner.Container.UUID, runner.Container.State)
1637         }
1638
1639         var bindmounts map[string]bindmount
1640         defer func() {
1641                 // checkErr prints e (unless it's nil) and sets err to
1642                 // e (unless err is already non-nil). Thus, if err
1643                 // hasn't already been assigned when Run() returns,
1644                 // this cleanup func will cause Run() to return the
1645                 // first non-nil error that is passed to checkErr().
1646                 checkErr := func(errorIn string, e error) {
1647                         if e == nil {
1648                                 return
1649                         }
1650                         runner.CrunchLog.Printf("error in %s: %v", errorIn, e)
1651                         if err == nil {
1652                                 err = e
1653                         }
1654                         if runner.finalState == "Complete" {
1655                                 // There was an error in the finalization.
1656                                 runner.finalState = "Cancelled"
1657                         }
1658                 }
1659
1660                 // Log the error encountered in Run(), if any
1661                 checkErr("Run", err)
1662
1663                 if runner.finalState == "Queued" {
1664                         runner.UpdateContainerFinal()
1665                         return
1666                 }
1667
1668                 if runner.IsCancelled() {
1669                         runner.finalState = "Cancelled"
1670                         // but don't return yet -- we still want to
1671                         // capture partial output and write logs
1672                 }
1673
1674                 if bindmounts != nil {
1675                         checkErr("CaptureOutput", runner.CaptureOutput(bindmounts))
1676                 }
1677                 checkErr("stopHoststat", runner.stopHoststat())
1678                 checkErr("CommitLogs", runner.CommitLogs())
1679                 runner.CleanupDirs()
1680                 checkErr("UpdateContainerFinal", runner.UpdateContainerFinal())
1681         }()
1682
1683         runner.setupSignals()
1684         err = runner.startHoststat()
1685         if err != nil {
1686                 return
1687         }
1688         if runner.keepstore != nil {
1689                 runner.hoststatReporter.ReportPID("keepstore", runner.keepstore.Process.Pid)
1690         }
1691
1692         // set up FUSE mount and binds
1693         bindmounts, err = runner.SetupMounts()
1694         if err != nil {
1695                 runner.finalState = "Cancelled"
1696                 err = fmt.Errorf("While setting up mounts: %v", err)
1697                 return
1698         }
1699
1700         // check for and/or load image
1701         imageID, err := runner.LoadImage()
1702         if err != nil {
1703                 if !runner.checkBrokenNode(err) {
1704                         // Failed to load image but not due to a "broken node"
1705                         // condition, probably user error.
1706                         runner.finalState = "Cancelled"
1707                 }
1708                 err = fmt.Errorf("While loading container image: %v", err)
1709                 return
1710         }
1711
1712         err = runner.CreateContainer(imageID, bindmounts)
1713         if err != nil {
1714                 return
1715         }
1716         err = runner.LogHostInfo()
1717         if err != nil {
1718                 return
1719         }
1720         err = runner.LogNodeRecord()
1721         if err != nil {
1722                 return
1723         }
1724         err = runner.LogContainerRecord()
1725         if err != nil {
1726                 return
1727         }
1728
1729         if runner.IsCancelled() {
1730                 return
1731         }
1732
1733         logCollection, err := runner.saveLogCollection(false)
1734         var logId string
1735         if err == nil {
1736                 logId = logCollection.PortableDataHash
1737         } else {
1738                 runner.CrunchLog.Printf("Error committing initial log collection: %v", err)
1739         }
1740         err = runner.UpdateContainerRunning(logId)
1741         if err != nil {
1742                 return
1743         }
1744         runner.finalState = "Cancelled"
1745
1746         err = runner.startCrunchstat()
1747         if err != nil {
1748                 return
1749         }
1750
1751         err = runner.StartContainer()
1752         if err != nil {
1753                 runner.checkBrokenNode(err)
1754                 return
1755         }
1756
1757         err = runner.WaitFinish()
1758         if err == nil && !runner.IsCancelled() {
1759                 runner.finalState = "Complete"
1760         }
1761         return
1762 }
1763
1764 // Fetch the current container record (uuid = runner.Container.UUID)
1765 // into runner.Container.
1766 func (runner *ContainerRunner) fetchContainerRecord() error {
1767         reader, err := runner.DispatcherArvClient.CallRaw("GET", "containers", runner.Container.UUID, "", nil)
1768         if err != nil {
1769                 return fmt.Errorf("error fetching container record: %v", err)
1770         }
1771         defer reader.Close()
1772
1773         dec := json.NewDecoder(reader)
1774         dec.UseNumber()
1775         err = dec.Decode(&runner.Container)
1776         if err != nil {
1777                 return fmt.Errorf("error decoding container record: %v", err)
1778         }
1779
1780         var sm struct {
1781                 SecretMounts map[string]arvados.Mount `json:"secret_mounts"`
1782         }
1783
1784         containerToken, err := runner.ContainerToken()
1785         if err != nil {
1786                 return fmt.Errorf("error getting container token: %v", err)
1787         }
1788
1789         runner.ContainerArvClient, runner.ContainerKeepClient,
1790                 runner.containerClient, err = runner.MkArvClient(containerToken)
1791         if err != nil {
1792                 return fmt.Errorf("error creating container API client: %v", err)
1793         }
1794
1795         runner.ContainerKeepClient.SetStorageClasses(runner.Container.OutputStorageClasses)
1796         runner.DispatcherKeepClient.SetStorageClasses(runner.Container.OutputStorageClasses)
1797
1798         err = runner.ContainerArvClient.Call("GET", "containers", runner.Container.UUID, "secret_mounts", nil, &sm)
1799         if err != nil {
1800                 if apierr, ok := err.(arvadosclient.APIServerError); !ok || apierr.HttpStatusCode != 404 {
1801                         return fmt.Errorf("error fetching secret_mounts: %v", err)
1802                 }
1803                 // ok && apierr.HttpStatusCode == 404, which means
1804                 // secret_mounts isn't supported by this API server.
1805         }
1806         runner.SecretMounts = sm.SecretMounts
1807
1808         return nil
1809 }
1810
1811 // NewContainerRunner creates a new container runner.
1812 func NewContainerRunner(dispatcherClient *arvados.Client,
1813         dispatcherArvClient IArvadosClient,
1814         dispatcherKeepClient IKeepClient,
1815         containerUUID string) (*ContainerRunner, error) {
1816
1817         cr := &ContainerRunner{
1818                 dispatcherClient:     dispatcherClient,
1819                 DispatcherArvClient:  dispatcherArvClient,
1820                 DispatcherKeepClient: dispatcherKeepClient,
1821         }
1822         cr.RunArvMount = cr.ArvMountCmd
1823         cr.MkTempDir = ioutil.TempDir
1824         cr.MkArvClient = func(token string) (IArvadosClient, IKeepClient, *arvados.Client, error) {
1825                 cl, err := arvadosclient.MakeArvadosClient()
1826                 if err != nil {
1827                         return nil, nil, nil, err
1828                 }
1829                 cl.ApiToken = token
1830                 kc, err := keepclient.MakeKeepClient(cl)
1831                 if err != nil {
1832                         return nil, nil, nil, err
1833                 }
1834                 c2 := arvados.NewClientFromEnv()
1835                 c2.AuthToken = token
1836                 return cl, kc, c2, nil
1837         }
1838         var err error
1839         cr.LogCollection, err = (&arvados.Collection{}).FileSystem(cr.dispatcherClient, cr.DispatcherKeepClient)
1840         if err != nil {
1841                 return nil, err
1842         }
1843         cr.Container.UUID = containerUUID
1844         f, err := cr.openLogFile("crunch-run")
1845         if err != nil {
1846                 return nil, err
1847         }
1848         cr.CrunchLog = newLogWriter(newTimestamper(io.MultiWriter(f, newStringPrefixer(os.Stderr, cr.Container.UUID+" "))))
1849
1850         go cr.updateLogs()
1851
1852         return cr, nil
1853 }
1854
1855 func (command) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
1856         log := log.New(stderr, "", 0)
1857         flags := flag.NewFlagSet(prog, flag.ContinueOnError)
1858         statInterval := flags.Duration("crunchstat-interval", 10*time.Second, "sampling period for periodic resource usage reporting")
1859         flags.String("cgroup-root", "/sys/fs/cgroup", "path to sysfs cgroup tree (obsolete, ignored)")
1860         flags.String("cgroup-parent", "docker", "name of container's parent cgroup (obsolete, ignored)")
1861         cgroupParentSubsystem := flags.String("cgroup-parent-subsystem", "", "use current cgroup for given `subsystem` as parent cgroup for container (subsystem argument is only relevant for cgroups v1; in cgroups v2 / unified mode, any non-empty value means use current cgroup); if empty, use the docker daemon's default cgroup parent. See https://doc.arvados.org/install/crunch2-slurm/install-dispatch.html#CrunchRunCommand-cgroups")
1862         caCertsPath := flags.String("ca-certs", "", "Path to TLS root certificates")
1863         detach := flags.Bool("detach", false, "Detach from parent process and run in the background")
1864         stdinConfig := flags.Bool("stdin-config", false, "Load config and environment variables from JSON message on stdin")
1865         configFile := flags.String("config", arvados.DefaultConfigFile, "filename of cluster config file to try loading if -stdin-config=false (default is $ARVADOS_CONFIG)")
1866         sleep := flags.Duration("sleep", 0, "Delay before starting (testing use only)")
1867         kill := flags.Int("kill", -1, "Send signal to an existing crunch-run process for given UUID")
1868         list := flags.Bool("list", false, "List UUIDs of existing crunch-run processes (and notify them to use price data passed on stdin)")
1869         enableMemoryLimit := flags.Bool("enable-memory-limit", true, "tell container runtime to limit container's memory usage")
1870         enableNetwork := flags.String("container-enable-networking", "default", "enable networking \"always\" (for all containers) or \"default\" (for containers that request it)")
1871         networkMode := flags.String("container-network-mode", "default", `Docker network mode for container (use any argument valid for docker --net)`)
1872         memprofile := flags.String("memprofile", "", "write memory profile to `file` after running container")
1873         runtimeEngine := flags.String("runtime-engine", "docker", "container runtime: docker or singularity")
1874         brokenNodeHook := flags.String("broken-node-hook", "", "script to run if node is detected to be broken (for example, Docker daemon is not running)")
1875         flags.Duration("check-containerd", 0, "Ignored. Exists for compatibility with older versions.")
1876         version := flags.Bool("version", false, "Write version information to stdout and exit 0.")
1877
1878         ignoreDetachFlag := false
1879         if len(args) > 0 && args[0] == "-no-detach" {
1880                 // This process was invoked by a parent process, which
1881                 // has passed along its own arguments, including
1882                 // -detach, after the leading -no-detach flag.  Strip
1883                 // the leading -no-detach flag (it's not recognized by
1884                 // flags.Parse()) and ignore the -detach flag that
1885                 // comes later.
1886                 args = args[1:]
1887                 ignoreDetachFlag = true
1888         }
1889
1890         if ok, code := cmd.ParseFlags(flags, prog, args, "container-uuid", stderr); !ok {
1891                 return code
1892         } else if *version {
1893                 fmt.Fprintln(stdout, prog, cmd.Version.String())
1894                 return 0
1895         } else if !*list && flags.NArg() != 1 {
1896                 fmt.Fprintf(stderr, "missing required argument: container-uuid (try -help)\n")
1897                 return 2
1898         }
1899
1900         containerUUID := flags.Arg(0)
1901
1902         switch {
1903         case *detach && !ignoreDetachFlag:
1904                 return Detach(containerUUID, prog, args, stdin, stdout, stderr)
1905         case *kill >= 0:
1906                 return KillProcess(containerUUID, syscall.Signal(*kill), stdout, stderr)
1907         case *list:
1908                 return ListProcesses(stdin, stdout, stderr)
1909         }
1910
1911         if len(containerUUID) != 27 {
1912                 log.Printf("usage: %s [options] UUID", prog)
1913                 return 1
1914         }
1915
1916         var keepstoreLogbuf bufThenWrite
1917         var conf ConfigData
1918         if *stdinConfig {
1919                 err := json.NewDecoder(stdin).Decode(&conf)
1920                 if err != nil {
1921                         log.Printf("decode stdin: %s", err)
1922                         return 1
1923                 }
1924                 for k, v := range conf.Env {
1925                         err = os.Setenv(k, v)
1926                         if err != nil {
1927                                 log.Printf("setenv(%q): %s", k, err)
1928                                 return 1
1929                         }
1930                 }
1931                 if conf.Cluster != nil {
1932                         // ClusterID is missing from the JSON
1933                         // representation, but we need it to generate
1934                         // a valid config file for keepstore, so we
1935                         // fill it using the container UUID prefix.
1936                         conf.Cluster.ClusterID = containerUUID[:5]
1937                 }
1938         } else {
1939                 conf = hpcConfData(containerUUID, *configFile, io.MultiWriter(&keepstoreLogbuf, stderr))
1940         }
1941
1942         log.Printf("crunch-run %s started", cmd.Version.String())
1943         time.Sleep(*sleep)
1944
1945         if *caCertsPath != "" {
1946                 os.Setenv("SSL_CERT_FILE", *caCertsPath)
1947         }
1948
1949         keepstore, err := startLocalKeepstore(conf, io.MultiWriter(&keepstoreLogbuf, stderr))
1950         if err != nil {
1951                 log.Print(err)
1952                 return 1
1953         }
1954         if keepstore != nil {
1955                 defer keepstore.Process.Kill()
1956         }
1957
1958         api, err := arvadosclient.MakeArvadosClient()
1959         if err != nil {
1960                 log.Printf("%s: %v", containerUUID, err)
1961                 return 1
1962         }
1963         // arvadosclient now interprets Retries=10 to mean
1964         // Timeout=10m, retrying with exponential backoff + jitter.
1965         api.Retries = 10
1966
1967         kc, err := keepclient.MakeKeepClient(api)
1968         if err != nil {
1969                 log.Printf("%s: %v", containerUUID, err)
1970                 return 1
1971         }
1972         kc.Retries = 4
1973
1974         cr, err := NewContainerRunner(arvados.NewClientFromEnv(), api, kc, containerUUID)
1975         if err != nil {
1976                 log.Print(err)
1977                 return 1
1978         }
1979
1980         cr.keepstore = keepstore
1981         if keepstore == nil {
1982                 // Log explanation (if any) for why we're not running
1983                 // a local keepstore.
1984                 var buf bytes.Buffer
1985                 keepstoreLogbuf.SetWriter(&buf)
1986                 if buf.Len() > 0 {
1987                         cr.CrunchLog.Printf("%s", strings.TrimSpace(buf.String()))
1988                 }
1989         } else if logWhat := conf.Cluster.Containers.LocalKeepLogsToContainerLog; logWhat == "none" {
1990                 cr.CrunchLog.Printf("using local keepstore process (pid %d) at %s", keepstore.Process.Pid, os.Getenv("ARVADOS_KEEP_SERVICES"))
1991                 keepstoreLogbuf.SetWriter(io.Discard)
1992         } else {
1993                 cr.CrunchLog.Printf("using local keepstore process (pid %d) at %s, writing logs to keepstore.txt in log collection", keepstore.Process.Pid, os.Getenv("ARVADOS_KEEP_SERVICES"))
1994                 cr.keepstoreLogger, err = cr.openLogFile("keepstore")
1995                 if err != nil {
1996                         log.Print(err)
1997                         return 1
1998                 }
1999
2000                 var writer io.WriteCloser = cr.keepstoreLogger
2001                 if logWhat == "errors" {
2002                         writer = &filterKeepstoreErrorsOnly{WriteCloser: writer}
2003                 } else if logWhat != "all" {
2004                         // should have been caught earlier by
2005                         // dispatcher's config loader
2006                         log.Printf("invalid value for Containers.LocalKeepLogsToContainerLog: %q", logWhat)
2007                         return 1
2008                 }
2009                 err = keepstoreLogbuf.SetWriter(writer)
2010                 if err != nil {
2011                         log.Print(err)
2012                         return 1
2013                 }
2014                 cr.keepstoreLogbuf = &keepstoreLogbuf
2015         }
2016
2017         switch *runtimeEngine {
2018         case "docker":
2019                 cr.executor, err = newDockerExecutor(containerUUID, cr.CrunchLog.Printf, cr.containerWatchdogInterval)
2020         case "singularity":
2021                 cr.executor, err = newSingularityExecutor(cr.CrunchLog.Printf)
2022         default:
2023                 cr.CrunchLog.Printf("%s: unsupported RuntimeEngine %q", containerUUID, *runtimeEngine)
2024                 return 1
2025         }
2026         if err != nil {
2027                 cr.CrunchLog.Printf("%s: %v", containerUUID, err)
2028                 cr.checkBrokenNode(err)
2029                 return 1
2030         }
2031         defer cr.executor.Close()
2032
2033         cr.brokenNodeHook = *brokenNodeHook
2034
2035         gwAuthSecret := os.Getenv("GatewayAuthSecret")
2036         os.Unsetenv("GatewayAuthSecret")
2037         if gwAuthSecret == "" {
2038                 // not safe to run a gateway service without an auth
2039                 // secret
2040                 cr.CrunchLog.Printf("Not starting a gateway server (GatewayAuthSecret was not provided by dispatcher)")
2041         } else {
2042                 gwListen := os.Getenv("GatewayAddress")
2043                 cr.gateway = Gateway{
2044                         Address:       gwListen,
2045                         AuthSecret:    gwAuthSecret,
2046                         ContainerUUID: containerUUID,
2047                         Target:        cr.executor,
2048                         Log:           cr.CrunchLog,
2049                         LogCollection: cr.LogCollection,
2050                 }
2051                 if gwListen == "" {
2052                         // Direct connection won't work, so we use the
2053                         // gateway_address field to indicate the
2054                         // internalURL of the controller process that
2055                         // has the current tunnel connection.
2056                         cr.gateway.ArvadosClient = cr.dispatcherClient
2057                         cr.gateway.UpdateTunnelURL = func(url string) {
2058                                 cr.gateway.Address = "tunnel " + url
2059                                 cr.DispatcherArvClient.Update("containers", containerUUID,
2060                                         arvadosclient.Dict{
2061                                                 "select":    []string{"uuid"},
2062                                                 "container": arvadosclient.Dict{"gateway_address": cr.gateway.Address},
2063                                         }, nil)
2064                         }
2065                 }
2066                 err = cr.gateway.Start()
2067                 if err != nil {
2068                         log.Printf("error starting gateway server: %s", err)
2069                         return 1
2070                 }
2071         }
2072
2073         parentTemp, tmperr := cr.MkTempDir("", "crunch-run."+containerUUID+".")
2074         if tmperr != nil {
2075                 log.Printf("%s: %v", containerUUID, tmperr)
2076                 return 1
2077         }
2078
2079         cr.parentTemp = parentTemp
2080         cr.statInterval = *statInterval
2081         cr.enableMemoryLimit = *enableMemoryLimit
2082         cr.enableNetwork = *enableNetwork
2083         cr.networkMode = *networkMode
2084         if *cgroupParentSubsystem != "" {
2085                 p, err := findCgroup(os.DirFS("/"), *cgroupParentSubsystem)
2086                 if err != nil {
2087                         log.Printf("fatal: cgroup parent subsystem: %s", err)
2088                         return 1
2089                 }
2090                 cr.setCgroupParent = p
2091         }
2092
2093         if conf.EC2SpotCheck {
2094                 go cr.checkSpotInterruptionNotices()
2095         }
2096
2097         runerr := cr.Run()
2098
2099         if *memprofile != "" {
2100                 f, err := os.Create(*memprofile)
2101                 if err != nil {
2102                         log.Printf("could not create memory profile: %s", err)
2103                 }
2104                 runtime.GC() // get up-to-date statistics
2105                 if err := pprof.WriteHeapProfile(f); err != nil {
2106                         log.Printf("could not write memory profile: %s", err)
2107                 }
2108                 closeerr := f.Close()
2109                 if closeerr != nil {
2110                         log.Printf("closing memprofile file: %s", err)
2111                 }
2112         }
2113
2114         if runerr != nil {
2115                 log.Printf("%s: %v", containerUUID, runerr)
2116                 return 1
2117         }
2118         return 0
2119 }
2120
2121 // Try to load ConfigData in hpc (slurm/lsf) environment. This means
2122 // loading the cluster config from the specified file and (if that
2123 // works) getting the runtime_constraints container field from
2124 // controller to determine # VCPUs so we can calculate KeepBuffers.
2125 func hpcConfData(uuid string, configFile string, stderr io.Writer) ConfigData {
2126         var conf ConfigData
2127         conf.Cluster = loadClusterConfigFile(configFile, stderr)
2128         if conf.Cluster == nil {
2129                 // skip loading the container record -- we won't be
2130                 // able to start local keepstore anyway.
2131                 return conf
2132         }
2133         arv, err := arvadosclient.MakeArvadosClient()
2134         if err != nil {
2135                 fmt.Fprintf(stderr, "error setting up arvadosclient: %s\n", err)
2136                 return conf
2137         }
2138         // arvadosclient now interprets Retries=10 to mean
2139         // Timeout=10m, retrying with exponential backoff + jitter.
2140         arv.Retries = 10
2141         var ctr arvados.Container
2142         err = arv.Call("GET", "containers", uuid, "", arvadosclient.Dict{"select": []string{"runtime_constraints"}}, &ctr)
2143         if err != nil {
2144                 fmt.Fprintf(stderr, "error getting container record: %s\n", err)
2145                 return conf
2146         }
2147         if ctr.RuntimeConstraints.VCPUs > 0 {
2148                 conf.KeepBuffers = ctr.RuntimeConstraints.VCPUs * conf.Cluster.Containers.LocalKeepBlobBuffersPerVCPU
2149         }
2150         return conf
2151 }
2152
2153 // Load cluster config file from given path. If an error occurs, log
2154 // the error to stderr and return nil.
2155 func loadClusterConfigFile(path string, stderr io.Writer) *arvados.Cluster {
2156         ldr := config.NewLoader(&bytes.Buffer{}, ctxlog.New(stderr, "plain", "info"))
2157         ldr.Path = path
2158         cfg, err := ldr.Load()
2159         if err != nil {
2160                 fmt.Fprintf(stderr, "could not load config file %s: %s\n", path, err)
2161                 return nil
2162         }
2163         cluster, err := cfg.GetCluster("")
2164         if err != nil {
2165                 fmt.Fprintf(stderr, "could not use config file %s: %s\n", path, err)
2166                 return nil
2167         }
2168         fmt.Fprintf(stderr, "loaded config file %s\n", path)
2169         return cluster
2170 }
2171
2172 func startLocalKeepstore(configData ConfigData, logbuf io.Writer) (*exec.Cmd, error) {
2173         if configData.KeepBuffers < 1 {
2174                 fmt.Fprintf(logbuf, "not starting a local keepstore process because KeepBuffers=%v in config\n", configData.KeepBuffers)
2175                 return nil, nil
2176         }
2177         if configData.Cluster == nil {
2178                 fmt.Fprint(logbuf, "not starting a local keepstore process because cluster config file was not loaded\n")
2179                 return nil, nil
2180         }
2181         for uuid, vol := range configData.Cluster.Volumes {
2182                 if len(vol.AccessViaHosts) > 0 {
2183                         fmt.Fprintf(logbuf, "not starting a local keepstore process because a volume (%s) uses AccessViaHosts\n", uuid)
2184                         return nil, nil
2185                 }
2186                 if !vol.ReadOnly && vol.Replication < configData.Cluster.Collections.DefaultReplication {
2187                         fmt.Fprintf(logbuf, "not starting a local keepstore process because a writable volume (%s) has replication less than Collections.DefaultReplication (%d < %d)\n", uuid, vol.Replication, configData.Cluster.Collections.DefaultReplication)
2188                         return nil, nil
2189                 }
2190         }
2191
2192         // Rather than have an alternate way to tell keepstore how
2193         // many buffers to use, etc., when starting it this way, we
2194         // just modify the cluster configuration that we feed it on
2195         // stdin.
2196         ccfg := *configData.Cluster
2197         ccfg.API.MaxKeepBlobBuffers = configData.KeepBuffers
2198         ccfg.Collections.BlobTrash = false
2199         ccfg.Collections.BlobTrashConcurrency = 0
2200         ccfg.Collections.BlobDeleteConcurrency = 0
2201
2202         localaddr := localKeepstoreAddr()
2203         ln, err := net.Listen("tcp", net.JoinHostPort(localaddr, "0"))
2204         if err != nil {
2205                 return nil, err
2206         }
2207         _, port, err := net.SplitHostPort(ln.Addr().String())
2208         if err != nil {
2209                 ln.Close()
2210                 return nil, err
2211         }
2212         ln.Close()
2213         url := "http://" + net.JoinHostPort(localaddr, port)
2214
2215         fmt.Fprintf(logbuf, "starting keepstore on %s\n", url)
2216
2217         var confJSON bytes.Buffer
2218         err = json.NewEncoder(&confJSON).Encode(arvados.Config{
2219                 Clusters: map[string]arvados.Cluster{
2220                         ccfg.ClusterID: ccfg,
2221                 },
2222         })
2223         if err != nil {
2224                 return nil, err
2225         }
2226         cmd := exec.Command("/proc/self/exe", "keepstore", "-config=-")
2227         if target, err := os.Readlink(cmd.Path); err == nil && strings.HasSuffix(target, ".test") {
2228                 // If we're a 'go test' process, running
2229                 // /proc/self/exe would start the test suite in a
2230                 // child process, which is not what we want.
2231                 cmd.Path, _ = exec.LookPath("go")
2232                 cmd.Args = append([]string{"go", "run", "../../cmd/arvados-server"}, cmd.Args[1:]...)
2233                 cmd.Env = os.Environ()
2234         }
2235         cmd.Stdin = &confJSON
2236         cmd.Stdout = logbuf
2237         cmd.Stderr = logbuf
2238         cmd.Env = append(cmd.Env,
2239                 "GOGC=10",
2240                 "ARVADOS_SERVICE_INTERNAL_URL="+url)
2241         err = cmd.Start()
2242         if err != nil {
2243                 return nil, fmt.Errorf("error starting keepstore process: %w", err)
2244         }
2245         cmdExited := false
2246         go func() {
2247                 cmd.Wait()
2248                 cmdExited = true
2249         }()
2250         ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(time.Second*10))
2251         defer cancel()
2252         poll := time.NewTicker(time.Second / 10)
2253         defer poll.Stop()
2254         client := http.Client{}
2255         for range poll.C {
2256                 testReq, err := http.NewRequestWithContext(ctx, "GET", url+"/_health/ping", nil)
2257                 testReq.Header.Set("Authorization", "Bearer "+configData.Cluster.ManagementToken)
2258                 if err != nil {
2259                         return nil, err
2260                 }
2261                 resp, err := client.Do(testReq)
2262                 if err == nil {
2263                         resp.Body.Close()
2264                         if resp.StatusCode == http.StatusOK {
2265                                 break
2266                         }
2267                 }
2268                 if cmdExited {
2269                         return nil, fmt.Errorf("keepstore child process exited")
2270                 }
2271                 if ctx.Err() != nil {
2272                         return nil, fmt.Errorf("timed out waiting for new keepstore process to report healthy")
2273                 }
2274         }
2275         os.Setenv("ARVADOS_KEEP_SERVICES", url)
2276         return cmd, nil
2277 }
2278
2279 // return current uid, gid, groups in a format suitable for logging:
2280 // "crunch-run process has uid=1234(arvados) gid=1234(arvados)
2281 // groups=1234(arvados),114(fuse)"
2282 func currentUserAndGroups() string {
2283         u, err := user.Current()
2284         if err != nil {
2285                 return fmt.Sprintf("error getting current user ID: %s", err)
2286         }
2287         s := fmt.Sprintf("crunch-run process has uid=%s(%s) gid=%s", u.Uid, u.Username, u.Gid)
2288         if g, err := user.LookupGroupId(u.Gid); err == nil {
2289                 s += fmt.Sprintf("(%s)", g.Name)
2290         }
2291         s += " groups="
2292         if gids, err := u.GroupIds(); err == nil {
2293                 for i, gid := range gids {
2294                         if i > 0 {
2295                                 s += ","
2296                         }
2297                         s += gid
2298                         if g, err := user.LookupGroupId(gid); err == nil {
2299                                 s += fmt.Sprintf("(%s)", g.Name)
2300                         }
2301                 }
2302         }
2303         return s
2304 }
2305
2306 // Return a suitable local interface address for a local keepstore
2307 // service. Currently this is the numerically lowest non-loopback ipv4
2308 // address assigned to a local interface that is not in any of the
2309 // link-local/vpn/loopback ranges 169.254/16, 100.64/10, or 127/8.
2310 func localKeepstoreAddr() string {
2311         var ips []net.IP
2312         // Ignore error (proceed with zero IPs)
2313         addrs, _ := processIPs(os.Getpid())
2314         for addr := range addrs {
2315                 ip := net.ParseIP(addr)
2316                 if ip == nil {
2317                         // invalid
2318                         continue
2319                 }
2320                 if ip.Mask(net.CIDRMask(8, 32)).Equal(net.IPv4(127, 0, 0, 0)) ||
2321                         ip.Mask(net.CIDRMask(10, 32)).Equal(net.IPv4(100, 64, 0, 0)) ||
2322                         ip.Mask(net.CIDRMask(16, 32)).Equal(net.IPv4(169, 254, 0, 0)) {
2323                         // unsuitable
2324                         continue
2325                 }
2326                 ips = append(ips, ip)
2327         }
2328         if len(ips) == 0 {
2329                 return "0.0.0.0"
2330         }
2331         sort.Slice(ips, func(ii, jj int) bool {
2332                 i, j := ips[ii], ips[jj]
2333                 if len(i) != len(j) {
2334                         return len(i) < len(j)
2335                 }
2336                 for x := range i {
2337                         if i[x] != j[x] {
2338                                 return i[x] < j[x]
2339                         }
2340                 }
2341                 return false
2342         })
2343         return ips[0].String()
2344 }
2345
2346 func (cr *ContainerRunner) loadPrices() {
2347         buf, err := os.ReadFile(filepath.Join(lockdir, pricesfile))
2348         if err != nil {
2349                 if !os.IsNotExist(err) {
2350                         cr.CrunchLog.Printf("loadPrices: read: %s", err)
2351                 }
2352                 return
2353         }
2354         var prices []cloud.InstancePrice
2355         err = json.Unmarshal(buf, &prices)
2356         if err != nil {
2357                 cr.CrunchLog.Printf("loadPrices: decode: %s", err)
2358                 return
2359         }
2360         cr.pricesLock.Lock()
2361         defer cr.pricesLock.Unlock()
2362         var lastKnown time.Time
2363         if len(cr.prices) > 0 {
2364                 lastKnown = cr.prices[0].StartTime
2365         }
2366         cr.prices = cloud.NormalizePriceHistory(append(prices, cr.prices...))
2367         for i := len(cr.prices) - 1; i >= 0; i-- {
2368                 price := cr.prices[i]
2369                 if price.StartTime.After(lastKnown) {
2370                         cr.CrunchLog.Printf("Instance price changed to %#.3g at %s", price.Price, price.StartTime.UTC())
2371                 }
2372         }
2373 }
2374
2375 func (cr *ContainerRunner) calculateCost(now time.Time) float64 {
2376         cr.pricesLock.Lock()
2377         defer cr.pricesLock.Unlock()
2378
2379         // First, make a "prices" slice with the real data as far back
2380         // as it goes, and (if needed) a "since the beginning of time"
2381         // placeholder containing a reasonable guess about what the
2382         // price was between cr.costStartTime and the earliest real
2383         // data point.
2384         prices := cr.prices
2385         if len(prices) == 0 {
2386                 // use price info in InstanceType record initially
2387                 // provided by cloud dispatcher
2388                 var p float64
2389                 var it arvados.InstanceType
2390                 if j := os.Getenv("InstanceType"); j != "" && json.Unmarshal([]byte(j), &it) == nil && it.Price > 0 {
2391                         p = it.Price
2392                 }
2393                 prices = []cloud.InstancePrice{{Price: p}}
2394         } else if prices[len(prices)-1].StartTime.After(cr.costStartTime) {
2395                 // guess earlier pricing was the same as the earliest
2396                 // price we know about
2397                 filler := prices[len(prices)-1]
2398                 filler.StartTime = time.Time{}
2399                 prices = append(prices, filler)
2400         }
2401
2402         // Now that our history of price changes goes back at least as
2403         // far as cr.costStartTime, add up the costs for each
2404         // interval.
2405         cost := 0.0
2406         spanEnd := now
2407         for _, ip := range prices {
2408                 spanStart := ip.StartTime
2409                 if spanStart.After(now) {
2410                         // pricing information from the future -- not
2411                         // expected from AWS, but possible in
2412                         // principle, and exercised by tests.
2413                         continue
2414                 }
2415                 last := false
2416                 if spanStart.Before(cr.costStartTime) {
2417                         spanStart = cr.costStartTime
2418                         last = true
2419                 }
2420                 cost += ip.Price * spanEnd.Sub(spanStart).Seconds() / 3600
2421                 if last {
2422                         break
2423                 }
2424                 spanEnd = spanStart
2425         }
2426
2427         return cost
2428 }
2429
2430 func (runner *ContainerRunner) handleSIGUSR2(sigchan chan os.Signal) {
2431         for range sigchan {
2432                 runner.loadPrices()
2433                 update := arvadosclient.Dict{
2434                         "select": []string{"uuid"},
2435                         "container": arvadosclient.Dict{
2436                                 "cost": runner.calculateCost(time.Now()),
2437                         },
2438                 }
2439                 runner.DispatcherArvClient.Update("containers", runner.Container.UUID, update, nil)
2440         }
2441 }