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