services/crunch-run/crunchrun.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package main
   6
   7 import (
   8         "bytes"
   9         "context"
  10         "encoding/json"
  11         "errors"
  12         "flag"
  13         "fmt"
  14         "io"
  15         "io/ioutil"
  16         "log"
  17         "os"
  18         "os/exec"
  19         "os/signal"
  20         "path"
  21         "path/filepath"
  22         "regexp"
  23         "runtime"
  24         "runtime/pprof"
  25         "sort"
  26         "strings"
  27         "sync"
  28         "syscall"
  29         "time"
  30
  31         "git.curoverse.com/arvados.git/lib/crunchstat"
  32         "git.curoverse.com/arvados.git/sdk/go/arvados"
  33         "git.curoverse.com/arvados.git/sdk/go/arvadosclient"
  34         "git.curoverse.com/arvados.git/sdk/go/keepclient"
  35         "git.curoverse.com/arvados.git/sdk/go/manifest"
  36
  37         dockertypes "github.com/docker/docker/api/types"
  38         dockercontainer "github.com/docker/docker/api/types/container"
  39         dockernetwork "github.com/docker/docker/api/types/network"
  40         dockerclient "github.com/docker/docker/client"
  41 )
  42
  43 var version = "dev"
  44
  45 // IArvadosClient is the minimal Arvados API methods used by crunch-run.
  46 type IArvadosClient interface {
  47         Create(resourceType string, parameters arvadosclient.Dict, output interface{}) error
  48         Get(resourceType string, uuid string, parameters arvadosclient.Dict, output interface{}) error
  49         Update(resourceType string, uuid string, parameters arvadosclient.Dict, output interface{}) error
  50         Call(method, resourceType, uuid, action string, parameters arvadosclient.Dict, output interface{}) error
  51         CallRaw(method string, resourceType string, uuid string, action string, parameters arvadosclient.Dict) (reader io.ReadCloser, err error)
  52         Discovery(key string) (interface{}, error)
  53 }
  54
  55 // ErrCancelled is the error returned when the container is cancelled.
  56 var ErrCancelled = errors.New("Cancelled")
  57
  58 // IKeepClient is the minimal Keep API methods used by crunch-run.
  59 type IKeepClient interface {
  60         PutHB(hash string, buf []byte) (string, int, error)
  61         ManifestFileReader(m manifest.Manifest, filename string) (arvados.File, error)
  62         ClearBlockCache()
  63 }
  64
  65 // NewLogWriter is a factory function to create a new log writer.
  66 type NewLogWriter func(name string) io.WriteCloser
  67
  68 type RunArvMount func(args []string, tok string) (*exec.Cmd, error)
  69
  70 type MkTempDir func(string, string) (string, error)
  71
  72 // ThinDockerClient is the minimal Docker client interface used by crunch-run.
  73 type ThinDockerClient interface {
  74         ContainerAttach(ctx context.Context, container string, options dockertypes.ContainerAttachOptions) (dockertypes.HijackedResponse, error)
  75         ContainerCreate(ctx context.Context, config *dockercontainer.Config, hostConfig *dockercontainer.HostConfig,
  76                 networkingConfig *dockernetwork.NetworkingConfig, containerName string) (dockercontainer.ContainerCreateCreatedBody, error)
  77         ContainerStart(ctx context.Context, container string, options dockertypes.ContainerStartOptions) error
  78         ContainerStop(ctx context.Context, container string, timeout *time.Duration) error
  79         ContainerWait(ctx context.Context, container string, condition dockercontainer.WaitCondition) (<-chan dockercontainer.ContainerWaitOKBody, <-chan error)
  80         ImageInspectWithRaw(ctx context.Context, image string) (dockertypes.ImageInspect, []byte, error)
  81         ImageLoad(ctx context.Context, input io.Reader, quiet bool) (dockertypes.ImageLoadResponse, error)
  82         ImageRemove(ctx context.Context, image string, options dockertypes.ImageRemoveOptions) ([]dockertypes.ImageDeleteResponseItem, error)
  83 }
  84
  85 // ThinDockerClientProxy is a proxy implementation of ThinDockerClient
  86 // that executes the docker requests on dockerclient.Client
  87 type ThinDockerClientProxy struct {
  88         Docker *dockerclient.Client
  89 }
  90
  91 // ContainerAttach invokes dockerclient.Client.ContainerAttach
  92 func (proxy ThinDockerClientProxy) ContainerAttach(ctx context.Context, container string, options dockertypes.ContainerAttachOptions) (dockertypes.HijackedResponse, error) {
  93         return proxy.Docker.ContainerAttach(ctx, container, options)
  94 }
  95
  96 // ContainerCreate invokes dockerclient.Client.ContainerCreate
  97 func (proxy ThinDockerClientProxy) ContainerCreate(ctx context.Context, config *dockercontainer.Config, hostConfig *dockercontainer.HostConfig,
  98         networkingConfig *dockernetwork.NetworkingConfig, containerName string) (dockercontainer.ContainerCreateCreatedBody, error) {
  99         return proxy.Docker.ContainerCreate(ctx, config, hostConfig, networkingConfig, containerName)
 100 }
 101
 102 // ContainerStart invokes dockerclient.Client.ContainerStart
 103 func (proxy ThinDockerClientProxy) ContainerStart(ctx context.Context, container string, options dockertypes.ContainerStartOptions) error {
 104         return proxy.Docker.ContainerStart(ctx, container, options)
 105 }
 106
 107 // ContainerStop invokes dockerclient.Client.ContainerStop
 108 func (proxy ThinDockerClientProxy) ContainerStop(ctx context.Context, container string, timeout *time.Duration) error {
 109         return proxy.Docker.ContainerStop(ctx, container, timeout)
 110 }
 111
 112 // ContainerWait invokes dockerclient.Client.ContainerWait
 113 func (proxy ThinDockerClientProxy) ContainerWait(ctx context.Context, container string, condition dockercontainer.WaitCondition) (<-chan dockercontainer.ContainerWaitOKBody, <-chan error) {
 114         return proxy.Docker.ContainerWait(ctx, container, condition)
 115 }
 116
 117 // ImageInspectWithRaw invokes dockerclient.Client.ImageInspectWithRaw
 118 func (proxy ThinDockerClientProxy) ImageInspectWithRaw(ctx context.Context, image string) (dockertypes.ImageInspect, []byte, error) {
 119         return proxy.Docker.ImageInspectWithRaw(ctx, image)
 120 }
 121
 122 // ImageLoad invokes dockerclient.Client.ImageLoad
 123 func (proxy ThinDockerClientProxy) ImageLoad(ctx context.Context, input io.Reader, quiet bool) (dockertypes.ImageLoadResponse, error) {
 124         return proxy.Docker.ImageLoad(ctx, input, quiet)
 125 }
 126
 127 // ImageRemove invokes dockerclient.Client.ImageRemove
 128 func (proxy ThinDockerClientProxy) ImageRemove(ctx context.Context, image string, options dockertypes.ImageRemoveOptions) ([]dockertypes.ImageDeleteResponseItem, error) {
 129         return proxy.Docker.ImageRemove(ctx, image, options)
 130 }
 131
 132 // ContainerRunner is the main stateful struct used for a single execution of a
 133 // container.
 134 type ContainerRunner struct {
 135         Docker    ThinDockerClient
 136         ArvClient IArvadosClient
 137         Kc        IKeepClient
 138         arvados.Container
 139         ContainerConfig dockercontainer.Config
 140         dockercontainer.HostConfig
 141         token       string
 142         ContainerID string
 143         ExitCode    *int
 144         NewLogWriter
 145         loggingDone   chan bool
 146         CrunchLog     *ThrottledLogger
 147         Stdout        io.WriteCloser
 148         Stderr        io.WriteCloser
 149         LogCollection *CollectionWriter
 150         LogsPDH       *string
 151         RunArvMount
 152         MkTempDir
 153         ArvMount       *exec.Cmd
 154         ArvMountPoint  string
 155         HostOutputDir  string
 156         CleanupTempDir []string
 157         Binds          []string
 158         Volumes        map[string]struct{}
 159         OutputPDH      *string
 160         SigChan        chan os.Signal
 161         ArvMountExit   chan error
 162         finalState     string
 163
 164         statLogger   io.WriteCloser
 165         statReporter *crunchstat.Reporter
 166         statInterval time.Duration
 167         cgroupRoot   string
 168         // What we expect the container's cgroup parent to be.
 169         expectCgroupParent string
 170         // What we tell docker to use as the container's cgroup
 171         // parent. Note: Ideally we would use the same field for both
 172         // expectCgroupParent and setCgroupParent, and just make it
 173         // default to "docker". However, when using docker < 1.10 with
 174         // systemd, specifying a non-empty cgroup parent (even the
 175         // default value "docker") hits a docker bug
 176         // (https://github.com/docker/docker/issues/17126). Using two
 177         // separate fields makes it possible to use the "expect cgroup
 178         // parent to be X" feature even on sites where the "specify
 179         // cgroup parent" feature breaks.
 180         setCgroupParent string
 181
 182         cStateLock sync.Mutex
 183         cStarted   bool // StartContainer() succeeded
 184         cCancelled bool // StopContainer() invoked
 185
 186         enableNetwork string // one of "default" or "always"
 187         networkMode   string // passed through to HostConfig.NetworkMode
 188         arvMountLog   *ThrottledLogger
 189 }
 190
 191 // setupSignals sets up signal handling to gracefully terminate the underlying
 192 // Docker container and update state when receiving a TERM, INT or QUIT signal.
 193 func (runner *ContainerRunner) setupSignals() {
 194         runner.SigChan = make(chan os.Signal, 1)
 195         signal.Notify(runner.SigChan, syscall.SIGTERM)
 196         signal.Notify(runner.SigChan, syscall.SIGINT)
 197         signal.Notify(runner.SigChan, syscall.SIGQUIT)
 198
 199         go func(sig chan os.Signal) {
 200                 s := <-sig
 201                 if s != nil {
 202                         runner.CrunchLog.Printf("Caught signal %v", s)
 203                 }
 204                 runner.stop()
 205         }(runner.SigChan)
 206 }
 207
 208 // stop the underlying Docker container.
 209 func (runner *ContainerRunner) stop() {
 210         runner.cStateLock.Lock()
 211         defer runner.cStateLock.Unlock()
 212         if runner.cCancelled {
 213                 return
 214         }
 215         runner.cCancelled = true
 216         if runner.cStarted {
 217                 timeout := time.Duration(10)
 218                 err := runner.Docker.ContainerStop(context.TODO(), runner.ContainerID, &(timeout))
 219                 if err != nil {
 220                         runner.CrunchLog.Printf("StopContainer failed: %s", err)
 221                 }
 222                 // Suppress multiple calls to stop()
 223                 runner.cStarted = false
 224         }
 225 }
 226
 227 func (runner *ContainerRunner) stopSignals() {
 228         if runner.SigChan != nil {
 229                 signal.Stop(runner.SigChan)
 230                 close(runner.SigChan)
 231         }
 232 }
 233
 234 var errorBlacklist = []string{
 235         "(?ms).*[Cc]annot connect to the Docker daemon.*",
 236         "(?ms).*oci runtime error.*starting container process.*container init.*mounting.*to rootfs.*no such file or directory.*",
 237 }
 238 var brokenNodeHook *string = flag.String("broken-node-hook", "", "Script to run if node is detected to be broken (for example, Docker daemon is not running)")
 239
 240 func (runner *ContainerRunner) checkBrokenNode(goterr error) bool {
 241         for _, d := range errorBlacklist {
 242                 if m, e := regexp.MatchString(d, goterr.Error()); m && e == nil {
 243                         runner.CrunchLog.Printf("Error suggests node is unable to run containers: %v", goterr)
 244                         if *brokenNodeHook == "" {
 245                                 runner.CrunchLog.Printf("No broken node hook provided, cannot mark node as broken.")
 246                         } else {
 247                                 runner.CrunchLog.Printf("Running broken node hook %q", *brokenNodeHook)
 248                                 // run killme script
 249                                 c := exec.Command(*brokenNodeHook)
 250                                 c.Stdout = runner.CrunchLog
 251                                 c.Stderr = runner.CrunchLog
 252                                 err := c.Run()
 253                                 if err != nil {
 254                                         runner.CrunchLog.Printf("Error running broken node hook: %v", err)
 255                                 }
 256                         }
 257                         return true
 258                 }
 259         }
 260         return false
 261 }
 262
 263 // LoadImage determines the docker image id from the container record and
 264 // checks if it is available in the local Docker image store.  If not, it loads
 265 // the image from Keep.
 266 func (runner *ContainerRunner) LoadImage() (err error) {
 267
 268         runner.CrunchLog.Printf("Fetching Docker image from collection '%s'", runner.Container.ContainerImage)
 269
 270         var collection arvados.Collection
 271         err = runner.ArvClient.Get("collections", runner.Container.ContainerImage, nil, &collection)
 272         if err != nil {
 273                 return fmt.Errorf("While getting container image collection: %v", err)
 274         }
 275         manifest := manifest.Manifest{Text: collection.ManifestText}
 276         var img, imageID string
 277         for ms := range manifest.StreamIter() {
 278                 img = ms.FileStreamSegments[0].Name
 279                 if !strings.HasSuffix(img, ".tar") {
 280                         return fmt.Errorf("First file in the container image collection does not end in .tar")
 281                 }
 282                 imageID = img[:len(img)-4]
 283         }
 284
 285         runner.CrunchLog.Printf("Using Docker image id '%s'", imageID)
 286
 287         _, _, err = runner.Docker.ImageInspectWithRaw(context.TODO(), imageID)
 288         if err != nil {
 289                 runner.CrunchLog.Print("Loading Docker image from keep")
 290
 291                 var readCloser io.ReadCloser
 292                 readCloser, err = runner.Kc.ManifestFileReader(manifest, img)
 293                 if err != nil {
 294                         return fmt.Errorf("While creating ManifestFileReader for container image: %v", err)
 295                 }
 296
 297                 response, err := runner.Docker.ImageLoad(context.TODO(), readCloser, true)
 298                 if err != nil {
 299                         return fmt.Errorf("While loading container image into Docker: %v", err)
 300                 }
 301
 302                 defer response.Body.Close()
 303                 rbody, err := ioutil.ReadAll(response.Body)
 304                 if err != nil {
 305                         return fmt.Errorf("Reading response to image load: %v", err)
 306                 }
 307                 runner.CrunchLog.Printf("Docker response: %s", rbody)
 308         } else {
 309                 runner.CrunchLog.Print("Docker image is available")
 310         }
 311
 312         runner.ContainerConfig.Image = imageID
 313
 314         runner.Kc.ClearBlockCache()
 315
 316         return nil
 317 }
 318
 319 func (runner *ContainerRunner) ArvMountCmd(arvMountCmd []string, token string) (c *exec.Cmd, err error) {
 320         c = exec.Command("arv-mount", arvMountCmd...)
 321
 322         // Copy our environment, but override ARVADOS_API_TOKEN with
 323         // the container auth token.
 324         c.Env = nil
 325         for _, s := range os.Environ() {
 326                 if !strings.HasPrefix(s, "ARVADOS_API_TOKEN=") {
 327                         c.Env = append(c.Env, s)
 328                 }
 329         }
 330         c.Env = append(c.Env, "ARVADOS_API_TOKEN="+token)
 331
 332         runner.arvMountLog = NewThrottledLogger(runner.NewLogWriter("arv-mount"))
 333         c.Stdout = runner.arvMountLog
 334         c.Stderr = runner.arvMountLog
 335
 336         runner.CrunchLog.Printf("Running %v", c.Args)
 337
 338         err = c.Start()
 339         if err != nil {
 340                 return nil, err
 341         }
 342
 343         statReadme := make(chan bool)
 344         runner.ArvMountExit = make(chan error)
 345
 346         keepStatting := true
 347         go func() {
 348                 for keepStatting {
 349                         time.Sleep(100 * time.Millisecond)
 350                         _, err = os.Stat(fmt.Sprintf("%s/by_id/README", runner.ArvMountPoint))
 351                         if err == nil {
 352                                 keepStatting = false
 353                                 statReadme <- true
 354                         }
 355                 }
 356                 close(statReadme)
 357         }()
 358
 359         go func() {
 360                 mnterr := c.Wait()
 361                 if mnterr != nil {
 362                         runner.CrunchLog.Printf("Arv-mount exit error: %v", mnterr)
 363                 }
 364                 runner.ArvMountExit <- mnterr
 365                 close(runner.ArvMountExit)
 366         }()
 367
 368         select {
 369         case <-statReadme:
 370                 break
 371         case err := <-runner.ArvMountExit:
 372                 runner.ArvMount = nil
 373                 keepStatting = false
 374                 return nil, err
 375         }
 376
 377         return c, nil
 378 }
 379
 380 func (runner *ContainerRunner) SetupArvMountPoint(prefix string) (err error) {
 381         if runner.ArvMountPoint == "" {
 382                 runner.ArvMountPoint, err = runner.MkTempDir("", prefix)
 383         }
 384         return
 385 }
 386
 387 func (runner *ContainerRunner) SetupMounts() (err error) {
 388         err = runner.SetupArvMountPoint("keep")
 389         if err != nil {
 390                 return fmt.Errorf("While creating keep mount temp dir: %v", err)
 391         }
 392
 393         token, err := runner.ContainerToken()
 394         if err != nil {
 395                 return fmt.Errorf("could not get container token: %s", err)
 396         }
 397
 398         pdhOnly := true
 399         tmpcount := 0
 400         arvMountCmd := []string{
 401                 "--foreground",
 402                 "--allow-other",
 403                 "--read-write",
 404                 fmt.Sprintf("--crunchstat-interval=%v", runner.statInterval.Seconds())}
 405
 406         if runner.Container.RuntimeConstraints.KeepCacheRAM > 0 {
 407                 arvMountCmd = append(arvMountCmd, "--file-cache", fmt.Sprintf("%d", runner.Container.RuntimeConstraints.KeepCacheRAM))
 408         }
 409
 410         collectionPaths := []string{}
 411         runner.Binds = nil
 412         runner.Volumes = make(map[string]struct{})
 413         needCertMount := true
 414
 415         var binds []string
 416         for bind := range runner.Container.Mounts {
 417                 binds = append(binds, bind)
 418         }
 419         sort.Strings(binds)
 420
 421         for _, bind := range binds {
 422                 mnt := runner.Container.Mounts[bind]
 423                 if bind == "stdout" || bind == "stderr" {
 424                         // Is it a "file" mount kind?
 425                         if mnt.Kind != "file" {
 426                                 return fmt.Errorf("Unsupported mount kind '%s' for %s. Only 'file' is supported.", mnt.Kind, bind)
 427                         }
 428
 429                         // Does path start with OutputPath?
 430                         prefix := runner.Container.OutputPath
 431                         if !strings.HasSuffix(prefix, "/") {
 432                                 prefix += "/"
 433                         }
 434                         if !strings.HasPrefix(mnt.Path, prefix) {
 435                                 return fmt.Errorf("%s path does not start with OutputPath: %s, %s", strings.Title(bind), mnt.Path, prefix)
 436                         }
 437                 }
 438
 439                 if bind == "stdin" {
 440                         // Is it a "collection" mount kind?
 441                         if mnt.Kind != "collection" && mnt.Kind != "json" {
 442                                 return fmt.Errorf("Unsupported mount kind '%s' for stdin. Only 'collection' or 'json' are supported.", mnt.Kind)
 443                         }
 444                 }
 445
 446                 if bind == "/etc/arvados/ca-certificates.crt" {
 447                         needCertMount = false
 448                 }
 449
 450                 if strings.HasPrefix(bind, runner.Container.OutputPath+"/") && bind != runner.Container.OutputPath+"/" {
 451                         if mnt.Kind != "collection" {
 452                                 return fmt.Errorf("Only mount points of kind 'collection' are supported underneath the output_path: %v", bind)
 453                         }
 454                 }
 455
 456                 switch {
 457                 case mnt.Kind == "collection" && bind != "stdin":
 458                         var src string
 459                         if mnt.UUID != "" && mnt.PortableDataHash != "" {
 460                                 return fmt.Errorf("Cannot specify both 'uuid' and 'portable_data_hash' for a collection mount")
 461                         }
 462                         if mnt.UUID != "" {
 463                                 if mnt.Writable {
 464                                         return fmt.Errorf("Writing to existing collections currently not permitted.")
 465                                 }
 466                                 pdhOnly = false
 467                                 src = fmt.Sprintf("%s/by_id/%s", runner.ArvMountPoint, mnt.UUID)
 468                         } else if mnt.PortableDataHash != "" {
 469                                 if mnt.Writable {
 470                                         return fmt.Errorf("Can never write to a collection specified by portable data hash")
 471                                 }
 472                                 idx := strings.Index(mnt.PortableDataHash, "/")
 473                                 if idx > 0 {
 474                                         mnt.Path = path.Clean(mnt.PortableDataHash[idx:])
 475                                         mnt.PortableDataHash = mnt.PortableDataHash[0:idx]
 476                                         runner.Container.Mounts[bind] = mnt
 477                                 }
 478                                 src = fmt.Sprintf("%s/by_id/%s", runner.ArvMountPoint, mnt.PortableDataHash)
 479                                 if mnt.Path != "" && mnt.Path != "." {
 480                                         if strings.HasPrefix(mnt.Path, "./") {
 481                                                 mnt.Path = mnt.Path[2:]
 482                                         } else if strings.HasPrefix(mnt.Path, "/") {
 483                                                 mnt.Path = mnt.Path[1:]
 484                                         }
 485                                         src += "/" + mnt.Path
 486                                 }
 487                         } else {
 488                                 src = fmt.Sprintf("%s/tmp%d", runner.ArvMountPoint, tmpcount)
 489                                 arvMountCmd = append(arvMountCmd, "--mount-tmp")
 490                                 arvMountCmd = append(arvMountCmd, fmt.Sprintf("tmp%d", tmpcount))
 491                                 tmpcount += 1
 492                         }
 493                         if mnt.Writable {
 494                                 if bind == runner.Container.OutputPath {
 495                                         runner.HostOutputDir = src
 496                                 } else if strings.HasPrefix(bind, runner.Container.OutputPath+"/") {
 497                                         return fmt.Errorf("Writable mount points are not permitted underneath the output_path: %v", bind)
 498                                 }
 499                                 runner.Binds = append(runner.Binds, fmt.Sprintf("%s:%s", src, bind))
 500                         } else {
 501                                 runner.Binds = append(runner.Binds, fmt.Sprintf("%s:%s:ro", src, bind))
 502                         }
 503                         collectionPaths = append(collectionPaths, src)
 504
 505                 case mnt.Kind == "tmp":
 506                         var tmpdir string
 507                         tmpdir, err = runner.MkTempDir("", "")
 508                         if err != nil {
 509                                 return fmt.Errorf("While creating mount temp dir: %v", err)
 510                         }
 511                         st, staterr := os.Stat(tmpdir)
 512                         if staterr != nil {
 513                                 return fmt.Errorf("While Stat on temp dir: %v", staterr)
 514                         }
 515                         err = os.Chmod(tmpdir, st.Mode()|os.ModeSetgid|0777)
 516                         if staterr != nil {
 517                                 return fmt.Errorf("While Chmod temp dir: %v", err)
 518                         }
 519                         runner.CleanupTempDir = append(runner.CleanupTempDir, tmpdir)
 520                         runner.Binds = append(runner.Binds, fmt.Sprintf("%s:%s", tmpdir, bind))
 521                         if bind == runner.Container.OutputPath {
 522                                 runner.HostOutputDir = tmpdir
 523                         }
 524
 525                 case mnt.Kind == "json":
 526                         jsondata, err := json.Marshal(mnt.Content)
 527                         if err != nil {
 528                                 return fmt.Errorf("encoding json data: %v", err)
 529                         }
 530                         // Create a tempdir with a single file
 531                         // (instead of just a tempfile): this way we
 532                         // can ensure the file is world-readable
 533                         // inside the container, without having to
 534                         // make it world-readable on the docker host.
 535                         tmpdir, err := runner.MkTempDir("", "")
 536                         if err != nil {
 537                                 return fmt.Errorf("creating temp dir: %v", err)
 538                         }
 539                         runner.CleanupTempDir = append(runner.CleanupTempDir, tmpdir)
 540                         tmpfn := filepath.Join(tmpdir, "mountdata.json")
 541                         err = ioutil.WriteFile(tmpfn, jsondata, 0644)
 542                         if err != nil {
 543                                 return fmt.Errorf("writing temp file: %v", err)
 544                         }
 545                         runner.Binds = append(runner.Binds, fmt.Sprintf("%s:%s:ro", tmpfn, bind))
 546
 547                 case mnt.Kind == "git_tree":
 548                         tmpdir, err := runner.MkTempDir("", "")
 549                         if err != nil {
 550                                 return fmt.Errorf("creating temp dir: %v", err)
 551                         }
 552                         runner.CleanupTempDir = append(runner.CleanupTempDir, tmpdir)
 553                         err = gitMount(mnt).extractTree(runner.ArvClient, tmpdir, token)
 554                         if err != nil {
 555                                 return err
 556                         }
 557                         runner.Binds = append(runner.Binds, tmpdir+":"+bind+":ro")
 558                 }
 559         }
 560
 561         if runner.HostOutputDir == "" {
 562                 return fmt.Errorf("Output path does not correspond to a writable mount point")
 563         }
 564
 565         if wantAPI := runner.Container.RuntimeConstraints.API; needCertMount && wantAPI != nil && *wantAPI {
 566                 for _, certfile := range arvadosclient.CertFiles {
 567                         _, err := os.Stat(certfile)
 568                         if err == nil {
 569                                 runner.Binds = append(runner.Binds, fmt.Sprintf("%s:/etc/arvados/ca-certificates.crt:ro", certfile))
 570                                 break
 571                         }
 572                 }
 573         }
 574
 575         if pdhOnly {
 576                 arvMountCmd = append(arvMountCmd, "--mount-by-pdh", "by_id")
 577         } else {
 578                 arvMountCmd = append(arvMountCmd, "--mount-by-id", "by_id")
 579         }
 580         arvMountCmd = append(arvMountCmd, runner.ArvMountPoint)
 581
 582         runner.ArvMount, err = runner.RunArvMount(arvMountCmd, token)
 583         if err != nil {
 584                 return fmt.Errorf("While trying to start arv-mount: %v", err)
 585         }
 586
 587         for _, p := range collectionPaths {
 588                 _, err = os.Stat(p)
 589                 if err != nil {
 590                         return fmt.Errorf("While checking that input files exist: %v", err)
 591                 }
 592         }
 593
 594         return nil
 595 }
 596
 597 func (runner *ContainerRunner) ProcessDockerAttach(containerReader io.Reader) {
 598         // Handle docker log protocol
 599         // https://docs.docker.com/engine/reference/api/docker_remote_api_v1.15/#attach-to-a-container
 600
 601         header := make([]byte, 8)
 602         for {
 603                 _, readerr := io.ReadAtLeast(containerReader, header, 8)
 604
 605                 if readerr == nil {
 606                         readsize := int64(header[7]) | (int64(header[6]) << 8) | (int64(header[5]) << 16) | (int64(header[4]) << 24)
 607                         if header[0] == 1 {
 608                                 // stdout
 609                                 _, readerr = io.CopyN(runner.Stdout, containerReader, readsize)
 610                         } else {
 611                                 // stderr
 612                                 _, readerr = io.CopyN(runner.Stderr, containerReader, readsize)
 613                         }
 614                 }
 615
 616                 if readerr != nil {
 617                         if readerr != io.EOF {
 618                                 runner.CrunchLog.Printf("While reading docker logs: %v", readerr)
 619                         }
 620
 621                         closeerr := runner.Stdout.Close()
 622                         if closeerr != nil {
 623                                 runner.CrunchLog.Printf("While closing stdout logs: %v", closeerr)
 624                         }
 625
 626                         closeerr = runner.Stderr.Close()
 627                         if closeerr != nil {
 628                                 runner.CrunchLog.Printf("While closing stderr logs: %v", closeerr)
 629                         }
 630
 631                         if runner.statReporter != nil {
 632                                 runner.statReporter.Stop()
 633                                 closeerr = runner.statLogger.Close()
 634                                 if closeerr != nil {
 635                                         runner.CrunchLog.Printf("While closing crunchstat logs: %v", closeerr)
 636                                 }
 637                         }
 638
 639                         runner.loggingDone <- true
 640                         close(runner.loggingDone)
 641                         return
 642                 }
 643         }
 644 }
 645
 646 func (runner *ContainerRunner) StartCrunchstat() {
 647         runner.statLogger = NewThrottledLogger(runner.NewLogWriter("crunchstat"))
 648         runner.statReporter = &crunchstat.Reporter{
 649                 CID:          runner.ContainerID,
 650                 Logger:       log.New(runner.statLogger, "", 0),
 651                 CgroupParent: runner.expectCgroupParent,
 652                 CgroupRoot:   runner.cgroupRoot,
 653                 PollPeriod:   runner.statInterval,
 654         }
 655         runner.statReporter.Start()
 656 }
 657
 658 type infoCommand struct {
 659         label string
 660         cmd   []string
 661 }
 662
 663 // LogNodeInfo gathers node information and store it on the log for debugging
 664 // purposes.
 665 func (runner *ContainerRunner) LogNodeInfo() (err error) {
 666         w := runner.NewLogWriter("node-info")
 667
 668         commands := []infoCommand{
 669                 {
 670                         label: "Host Information",
 671                         cmd:   []string{"uname", "-a"},
 672                 },
 673                 {
 674                         label: "CPU Information",
 675                         cmd:   []string{"cat", "/proc/cpuinfo"},
 676                 },
 677                 {
 678                         label: "Memory Information",
 679                         cmd:   []string{"cat", "/proc/meminfo"},
 680                 },
 681                 {
 682                         label: "Disk Space",
 683                         cmd:   []string{"df", "-m", "/", os.TempDir()},
 684                 },
 685                 {
 686                         label: "Disk INodes",
 687                         cmd:   []string{"df", "-i", "/", os.TempDir()},
 688                 },
 689         }
 690
 691         // Run commands with informational output to be logged.
 692         for _, command := range commands {
 693                 fmt.Fprintln(w, command.label)
 694                 cmd := exec.Command(command.cmd[0], command.cmd[1:]...)
 695                 cmd.Stdout = w
 696                 cmd.Stderr = w
 697                 if err := cmd.Run(); err != nil {
 698                         err = fmt.Errorf("While running command %q: %v", command.cmd, err)
 699                         fmt.Fprintln(w, err)
 700                         return err
 701                 }
 702                 fmt.Fprintln(w, "")
 703         }
 704
 705         err = w.Close()
 706         if err != nil {
 707                 return fmt.Errorf("While closing node-info logs: %v", err)
 708         }
 709         return nil
 710 }
 711
 712 // LogContainerRecord gets and saves the raw JSON container record from the API server
 713 func (runner *ContainerRunner) LogContainerRecord() (err error) {
 714         w := &ArvLogWriter{
 715                 ArvClient:     runner.ArvClient,
 716                 UUID:          runner.Container.UUID,
 717                 loggingStream: "container",
 718                 writeCloser:   runner.LogCollection.Open("container.json"),
 719         }
 720
 721         // Get Container record JSON from the API Server
 722         reader, err := runner.ArvClient.CallRaw("GET", "containers", runner.Container.UUID, "", nil)
 723         if err != nil {
 724                 return fmt.Errorf("While retrieving container record from the API server: %v", err)
 725         }
 726         defer reader.Close()
 727
 728         dec := json.NewDecoder(reader)
 729         dec.UseNumber()
 730         var cr map[string]interface{}
 731         if err = dec.Decode(&cr); err != nil {
 732                 return fmt.Errorf("While decoding the container record JSON response: %v", err)
 733         }
 734         // Re-encode it using indentation to improve readability
 735         enc := json.NewEncoder(w)
 736         enc.SetIndent("", "    ")
 737         if err = enc.Encode(cr); err != nil {
 738                 return fmt.Errorf("While logging the JSON container record: %v", err)
 739         }
 740         err = w.Close()
 741         if err != nil {
 742                 return fmt.Errorf("While closing container.json log: %v", err)
 743         }
 744         return nil
 745 }
 746
 747 // AttachStreams connects the docker container stdin, stdout and stderr logs
 748 // to the Arvados logger which logs to Keep and the API server logs table.
 749 func (runner *ContainerRunner) AttachStreams() (err error) {
 750
 751         runner.CrunchLog.Print("Attaching container streams")
 752
 753         // If stdin mount is provided, attach it to the docker container
 754         var stdinRdr arvados.File
 755         var stdinJson []byte
 756         if stdinMnt, ok := runner.Container.Mounts["stdin"]; ok {
 757                 if stdinMnt.Kind == "collection" {
 758                         var stdinColl arvados.Collection
 759                         collId := stdinMnt.UUID
 760                         if collId == "" {
 761                                 collId = stdinMnt.PortableDataHash
 762                         }
 763                         err = runner.ArvClient.Get("collections", collId, nil, &stdinColl)
 764                         if err != nil {
 765                                 return fmt.Errorf("While getting stding collection: %v", err)
 766                         }
 767
 768                         stdinRdr, err = runner.Kc.ManifestFileReader(manifest.Manifest{Text: stdinColl.ManifestText}, stdinMnt.Path)
 769                         if os.IsNotExist(err) {
 770                                 return fmt.Errorf("stdin collection path not found: %v", stdinMnt.Path)
 771                         } else if err != nil {
 772                                 return fmt.Errorf("While getting stdin collection path %v: %v", stdinMnt.Path, err)
 773                         }
 774                 } else if stdinMnt.Kind == "json" {
 775                         stdinJson, err = json.Marshal(stdinMnt.Content)
 776                         if err != nil {
 777                                 return fmt.Errorf("While encoding stdin json data: %v", err)
 778                         }
 779                 }
 780         }
 781
 782         stdinUsed := stdinRdr != nil || len(stdinJson) != 0
 783         response, err := runner.Docker.ContainerAttach(context.TODO(), runner.ContainerID,
 784                 dockertypes.ContainerAttachOptions{Stream: true, Stdin: stdinUsed, Stdout: true, Stderr: true})
 785         if err != nil {
 786                 return fmt.Errorf("While attaching container stdout/stderr streams: %v", err)
 787         }
 788
 789         runner.loggingDone = make(chan bool)
 790
 791         if stdoutMnt, ok := runner.Container.Mounts["stdout"]; ok {
 792                 stdoutFile, err := runner.getStdoutFile(stdoutMnt.Path)
 793                 if err != nil {
 794                         return err
 795                 }
 796                 runner.Stdout = stdoutFile
 797         } else {
 798                 runner.Stdout = NewThrottledLogger(runner.NewLogWriter("stdout"))
 799         }
 800
 801         if stderrMnt, ok := runner.Container.Mounts["stderr"]; ok {
 802                 stderrFile, err := runner.getStdoutFile(stderrMnt.Path)
 803                 if err != nil {
 804                         return err
 805                 }
 806                 runner.Stderr = stderrFile
 807         } else {
 808                 runner.Stderr = NewThrottledLogger(runner.NewLogWriter("stderr"))
 809         }
 810
 811         if stdinRdr != nil {
 812                 go func() {
 813                         _, err := io.Copy(response.Conn, stdinRdr)
 814                         if err != nil {
 815                                 runner.CrunchLog.Print("While writing stdin collection to docker container %q", err)
 816                                 runner.stop()
 817                         }
 818                         stdinRdr.Close()
 819                         response.CloseWrite()
 820                 }()
 821         } else if len(stdinJson) != 0 {
 822                 go func() {
 823                         _, err := io.Copy(response.Conn, bytes.NewReader(stdinJson))
 824                         if err != nil {
 825                                 runner.CrunchLog.Print("While writing stdin json to docker container %q", err)
 826                                 runner.stop()
 827                         }
 828                         response.CloseWrite()
 829                 }()
 830         }
 831
 832         go runner.ProcessDockerAttach(response.Reader)
 833
 834         return nil
 835 }
 836
 837 func (runner *ContainerRunner) getStdoutFile(mntPath string) (*os.File, error) {
 838         stdoutPath := mntPath[len(runner.Container.OutputPath):]
 839         index := strings.LastIndex(stdoutPath, "/")
 840         if index > 0 {
 841                 subdirs := stdoutPath[:index]
 842                 if subdirs != "" {
 843                         st, err := os.Stat(runner.HostOutputDir)
 844                         if err != nil {
 845                                 return nil, fmt.Errorf("While Stat on temp dir: %v", err)
 846                         }
 847                         stdoutPath := filepath.Join(runner.HostOutputDir, subdirs)
 848                         err = os.MkdirAll(stdoutPath, st.Mode()|os.ModeSetgid|0777)
 849                         if err != nil {
 850                                 return nil, fmt.Errorf("While MkdirAll %q: %v", stdoutPath, err)
 851                         }
 852                 }
 853         }
 854         stdoutFile, err := os.Create(filepath.Join(runner.HostOutputDir, stdoutPath))
 855         if err != nil {
 856                 return nil, fmt.Errorf("While creating file %q: %v", stdoutPath, err)
 857         }
 858
 859         return stdoutFile, nil
 860 }
 861
 862 // CreateContainer creates the docker container.
 863 func (runner *ContainerRunner) CreateContainer() error {
 864         runner.CrunchLog.Print("Creating Docker container")
 865
 866         runner.ContainerConfig.Cmd = runner.Container.Command
 867         if runner.Container.Cwd != "." {
 868                 runner.ContainerConfig.WorkingDir = runner.Container.Cwd
 869         }
 870
 871         for k, v := range runner.Container.Environment {
 872                 runner.ContainerConfig.Env = append(runner.ContainerConfig.Env, k+"="+v)
 873         }
 874
 875         runner.ContainerConfig.Volumes = runner.Volumes
 876
 877         runner.HostConfig = dockercontainer.HostConfig{
 878                 Binds: runner.Binds,
 879                 LogConfig: dockercontainer.LogConfig{
 880                         Type: "none",
 881                 },
 882                 Resources: dockercontainer.Resources{
 883                         CgroupParent: runner.setCgroupParent,
 884                 },
 885         }
 886
 887         if wantAPI := runner.Container.RuntimeConstraints.API; wantAPI != nil && *wantAPI {
 888                 tok, err := runner.ContainerToken()
 889                 if err != nil {
 890                         return err
 891                 }
 892                 runner.ContainerConfig.Env = append(runner.ContainerConfig.Env,
 893                         "ARVADOS_API_TOKEN="+tok,
 894                         "ARVADOS_API_HOST="+os.Getenv("ARVADOS_API_HOST"),
 895                         "ARVADOS_API_HOST_INSECURE="+os.Getenv("ARVADOS_API_HOST_INSECURE"),
 896                 )
 897                 runner.HostConfig.NetworkMode = dockercontainer.NetworkMode(runner.networkMode)
 898         } else {
 899                 if runner.enableNetwork == "always" {
 900                         runner.HostConfig.NetworkMode = dockercontainer.NetworkMode(runner.networkMode)
 901                 } else {
 902                         runner.HostConfig.NetworkMode = dockercontainer.NetworkMode("none")
 903                 }
 904         }
 905
 906         _, stdinUsed := runner.Container.Mounts["stdin"]
 907         runner.ContainerConfig.OpenStdin = stdinUsed
 908         runner.ContainerConfig.StdinOnce = stdinUsed
 909         runner.ContainerConfig.AttachStdin = stdinUsed
 910         runner.ContainerConfig.AttachStdout = true
 911         runner.ContainerConfig.AttachStderr = true
 912
 913         createdBody, err := runner.Docker.ContainerCreate(context.TODO(), &runner.ContainerConfig, &runner.HostConfig, nil, runner.Container.UUID)
 914         if err != nil {
 915                 return fmt.Errorf("While creating container: %v", err)
 916         }
 917
 918         runner.ContainerID = createdBody.ID
 919
 920         return runner.AttachStreams()
 921 }
 922
 923 // StartContainer starts the docker container created by CreateContainer.
 924 func (runner *ContainerRunner) StartContainer() error {
 925         runner.CrunchLog.Printf("Starting Docker container id '%s'", runner.ContainerID)
 926         runner.cStateLock.Lock()
 927         defer runner.cStateLock.Unlock()
 928         if runner.cCancelled {
 929                 return ErrCancelled
 930         }
 931         err := runner.Docker.ContainerStart(context.TODO(), runner.ContainerID,
 932                 dockertypes.ContainerStartOptions{})
 933         if err != nil {
 934                 var advice string
 935                 if m, e := regexp.MatchString("(?ms).*(exec|System error).*(no such file or directory|file not found).*", err.Error()); m && e == nil {
 936                         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])
 937                 }
 938                 return fmt.Errorf("could not start container: %v%s", err, advice)
 939         }
 940         runner.cStarted = true
 941         return nil
 942 }
 943
 944 // WaitFinish waits for the container to terminate, capture the exit code, and
 945 // close the stdout/stderr logging.
 946 func (runner *ContainerRunner) WaitFinish() (err error) {
 947         runner.CrunchLog.Print("Waiting for container to finish")
 948
 949         waitOk, waitErr := runner.Docker.ContainerWait(context.TODO(), runner.ContainerID, "not-running")
 950
 951         go func() {
 952                 <-runner.ArvMountExit
 953                 if runner.cStarted {
 954                         runner.CrunchLog.Printf("arv-mount exited while container is still running.  Stopping container.")
 955                         runner.stop()
 956                 }
 957         }()
 958
 959         var waitBody dockercontainer.ContainerWaitOKBody
 960         select {
 961         case waitBody = <-waitOk:
 962         case err = <-waitErr:
 963         }
 964
 965         // Container isn't running any more
 966         runner.cStarted = false
 967
 968         if err != nil {
 969                 return fmt.Errorf("container wait: %v", err)
 970         }
 971
 972         runner.CrunchLog.Printf("Container exited with code: %v", waitBody.StatusCode)
 973         code := int(waitBody.StatusCode)
 974         runner.ExitCode = &code
 975
 976         // wait for stdout/stderr to complete
 977         <-runner.loggingDone
 978
 979         return nil
 980 }
 981
 982 var ErrNotInOutputDir = fmt.Errorf("Must point to path within the output directory")
 983
 984 func (runner *ContainerRunner) derefOutputSymlink(path string, startinfo os.FileInfo) (tgt string, readlinktgt string, info os.FileInfo, err error) {
 985         // Follow symlinks if necessary
 986         info = startinfo
 987         tgt = path
 988         readlinktgt = ""
 989         nextlink := path
 990         for followed := 0; info.Mode()&os.ModeSymlink != 0; followed++ {
 991                 if followed >= limitFollowSymlinks {
 992                         // Got stuck in a loop or just a pathological number of links, give up.
 993                         err = fmt.Errorf("Followed more than %v symlinks from path %q", limitFollowSymlinks, path)
 994                         return
 995                 }
 996
 997                 readlinktgt, err = os.Readlink(nextlink)
 998                 if err != nil {
 999                         return
1000                 }
1001
1002                 tgt = readlinktgt
1003                 if !strings.HasPrefix(tgt, "/") {
1004                         // Relative symlink, resolve it to host path
1005                         tgt = filepath.Join(filepath.Dir(path), tgt)
1006                 }
1007                 if strings.HasPrefix(tgt, runner.Container.OutputPath+"/") && !strings.HasPrefix(tgt, runner.HostOutputDir+"/") {
1008                         // Absolute symlink to container output path, adjust it to host output path.
1009                         tgt = filepath.Join(runner.HostOutputDir, tgt[len(runner.Container.OutputPath):])
1010                 }
1011                 if !strings.HasPrefix(tgt, runner.HostOutputDir+"/") {
1012                         // After dereferencing, symlink target must either be
1013                         // within output directory, or must point to a
1014                         // collection mount.
1015                         err = ErrNotInOutputDir
1016                         return
1017                 }
1018
1019                 info, err = os.Lstat(tgt)
1020                 if err != nil {
1021                         // tgt
1022                         err = fmt.Errorf("Symlink in output %q points to invalid location %q: %v",
1023                                 path[len(runner.HostOutputDir):], readlinktgt, err)
1024                         return
1025                 }
1026
1027                 nextlink = tgt
1028         }
1029
1030         return
1031 }
1032
1033 var limitFollowSymlinks = 10
1034
1035 // UploadFile uploads files within the output directory, with special handling
1036 // for symlinks. If the symlink leads to a keep mount, copy the manifest text
1037 // from the keep mount into the output manifestText.  Ensure that whether
1038 // symlinks are relative or absolute, every symlink target (even targets that
1039 // are symlinks themselves) must point to a path in either the output directory
1040 // or a collection mount.
1041 //
1042 // Assumes initial value of "path" is absolute, and located within runner.HostOutputDir.
1043 func (runner *ContainerRunner) UploadOutputFile(
1044         path string,
1045         info os.FileInfo,
1046         infoerr error,
1047         binds []string,
1048         walkUpload *WalkUpload,
1049         relocateFrom string,
1050         relocateTo string,
1051         followed int) (manifestText string, err error) {
1052
1053         if infoerr != nil {
1054                 return "", infoerr
1055         }
1056
1057         if info.Mode().IsDir() {
1058                 // if empty, need to create a .keep file
1059                 dir, direrr := os.Open(path)
1060                 if (direrr != nil) {
1061                         return "", direrr
1062                 }
1063                 defer dir.Close()
1064                 names, eof := dir.Readdirnames(1)
1065                 if len(names) == 0 && eof == io.EOF && path != runner.HostOutputDir {
1066                         containerPath := runner.OutputPath + path[len(runner.HostOutputDir):]
1067                         for _, bind := range binds {
1068                                 mnt := runner.Container.Mounts[bind]
1069                                 // Check if there is a bind for this
1070                                 // directory, in which case assume we don't need .keep
1071                                 if (containerPath == bind || strings.HasPrefix(containerPath, bind+"/")) && mnt.PortableDataHash != "d41d8cd98f00b204e9800998ecf8427e+0" {
1072                                         return
1073                                 }
1074                         }
1075                         outputSuffix := path[len(runner.HostOutputDir)+1:]
1076                         return fmt.Sprintf("./%v d41d8cd98f00b204e9800998ecf8427e+0 0:0:.keep\n", outputSuffix), nil
1077                 }
1078                 return
1079         }
1080
1081         if followed >= limitFollowSymlinks {
1082                 // Got stuck in a loop or just a pathological number of
1083                 // directory links, give up.
1084                 err = fmt.Errorf("Followed more than %v symlinks from path %q", limitFollowSymlinks, path)
1085                 return
1086         }
1087
1088         // "path" is the actual path we are visiting
1089         // "tgt" is the target of "path" (a non-symlink) after following symlinks
1090         // "relocated" is the path in the output manifest where the file should be placed,
1091         // but has HostOutputDir as a prefix.
1092
1093         // The destination path in the output manifest may need to be
1094         // logically relocated to some other path in order to appear
1095         // in the correct location as a result of following a symlink.
1096         // Remove the relocateFrom prefix and replace it with
1097         // relocateTo.
1098         relocated := relocateTo + path[len(relocateFrom):]
1099
1100         tgt, readlinktgt, info, derefErr := runner.derefOutputSymlink(path, info)
1101         if derefErr != nil && derefErr != ErrNotInOutputDir {
1102                 return "", derefErr
1103         }
1104
1105         // go through mounts and try reverse map to collection reference
1106         for _, bind := range binds {
1107                 mnt := runner.Container.Mounts[bind]
1108                 if tgt == bind || strings.HasPrefix(tgt, bind+"/") {
1109                         // get path relative to bind
1110                         targetSuffix := tgt[len(bind):]
1111
1112                         // Copy mount and adjust the path to add path relative to the bind
1113                         adjustedMount := mnt
1114                         adjustedMount.Path = filepath.Join(adjustedMount.Path, targetSuffix)
1115
1116                         // Terminates in this keep mount, so add the
1117                         // manifest text at appropriate location.
1118                         outputSuffix := relocated[len(runner.HostOutputDir):]
1119                         manifestText, err = runner.getCollectionManifestForPath(adjustedMount, outputSuffix)
1120                         return
1121                 }
1122         }
1123
1124         // If target is not a collection mount, it must be located within the
1125         // output directory, otherwise it is an error.
1126         if derefErr == ErrNotInOutputDir {
1127                 err = fmt.Errorf("Symlink in output %q points to invalid location %q, must point to path within the output directory.",
1128                         path[len(runner.HostOutputDir):], readlinktgt)
1129                 return
1130         }
1131
1132         if info.Mode().IsRegular() {
1133                 return "", walkUpload.UploadFile(relocated, tgt)
1134         }
1135
1136         if info.Mode().IsDir() {
1137                 // Symlink leads to directory.  Walk() doesn't follow
1138                 // directory symlinks, so we walk the target directory
1139                 // instead.  Within the walk, file paths are relocated
1140                 // so they appear under the original symlink path.
1141                 err = filepath.Walk(tgt, func(walkpath string, walkinfo os.FileInfo, walkerr error) error {
1142                         var m string
1143                         m, walkerr = runner.UploadOutputFile(walkpath, walkinfo, walkerr,
1144                                 binds, walkUpload, tgt, relocated, followed+1)
1145                         if walkerr == nil {
1146                                 manifestText = manifestText + m
1147                         }
1148                         return walkerr
1149                 })
1150                 return
1151         }
1152
1153         return
1154 }
1155
1156 // HandleOutput sets the output, unmounts the FUSE mount, and deletes temporary directories
1157 func (runner *ContainerRunner) CaptureOutput() error {
1158         if runner.finalState != "Complete" {
1159                 return nil
1160         }
1161
1162         if wantAPI := runner.Container.RuntimeConstraints.API; wantAPI != nil && *wantAPI {
1163                 // Output may have been set directly by the container, so
1164                 // refresh the container record to check.
1165                 err := runner.ArvClient.Get("containers", runner.Container.UUID,
1166                         nil, &runner.Container)
1167                 if err != nil {
1168                         return err
1169                 }
1170                 if runner.Container.Output != "" {
1171                         // Container output is already set.
1172                         runner.OutputPDH = &runner.Container.Output
1173                         return nil
1174                 }
1175         }
1176
1177         if runner.HostOutputDir == "" {
1178                 return nil
1179         }
1180
1181         _, err := os.Stat(runner.HostOutputDir)
1182         if err != nil {
1183                 return fmt.Errorf("While checking host output path: %v", err)
1184         }
1185
1186         // Pre-populate output from the configured mount points
1187         var binds []string
1188         for bind, mnt := range runner.Container.Mounts {
1189                 if mnt.Kind == "collection" {
1190                         binds = append(binds, bind)
1191                 }
1192         }
1193         sort.Strings(binds)
1194
1195         var manifestText string
1196
1197         collectionMetafile := fmt.Sprintf("%s/.arvados#collection", runner.HostOutputDir)
1198         _, err = os.Stat(collectionMetafile)
1199         if err != nil {
1200                 // Regular directory
1201
1202                 cw := CollectionWriter{0, runner.Kc, nil, nil, sync.Mutex{}}
1203                 walkUpload := cw.BeginUpload(runner.HostOutputDir, runner.CrunchLog.Logger)
1204
1205                 var m string
1206                 err = filepath.Walk(runner.HostOutputDir, func(path string, info os.FileInfo, err error) error {
1207                         m, err = runner.UploadOutputFile(path, info, err, binds, walkUpload, "", "", 0)
1208                         if err == nil {
1209                                 manifestText = manifestText + m
1210                         }
1211                         return err
1212                 })
1213
1214                 cw.EndUpload(walkUpload)
1215
1216                 if err != nil {
1217                         return fmt.Errorf("While uploading output files: %v", err)
1218                 }
1219
1220                 m, err = cw.ManifestText()
1221                 manifestText = manifestText + m
1222                 if err != nil {
1223                         return fmt.Errorf("While uploading output files: %v", err)
1224                 }
1225         } else {
1226                 // FUSE mount directory
1227                 file, openerr := os.Open(collectionMetafile)
1228                 if openerr != nil {
1229                         return fmt.Errorf("While opening FUSE metafile: %v", err)
1230                 }
1231                 defer file.Close()
1232
1233                 var rec arvados.Collection
1234                 err = json.NewDecoder(file).Decode(&rec)
1235                 if err != nil {
1236                         return fmt.Errorf("While reading FUSE metafile: %v", err)
1237                 }
1238                 manifestText = rec.ManifestText
1239         }
1240
1241         for _, bind := range binds {
1242                 mnt := runner.Container.Mounts[bind]
1243
1244                 bindSuffix := strings.TrimPrefix(bind, runner.Container.OutputPath)
1245
1246                 if bindSuffix == bind || len(bindSuffix) <= 0 {
1247                         // either does not start with OutputPath or is OutputPath itself
1248                         continue
1249                 }
1250
1251                 if mnt.ExcludeFromOutput == true {
1252                         continue
1253                 }
1254
1255                 // append to manifest_text
1256                 m, err := runner.getCollectionManifestForPath(mnt, bindSuffix)
1257                 if err != nil {
1258                         return err
1259                 }
1260
1261                 manifestText = manifestText + m
1262         }
1263
1264         // Save output
1265         var response arvados.Collection
1266         manifest := manifest.Manifest{Text: manifestText}
1267         manifestText = manifest.Extract(".", ".").Text
1268         err = runner.ArvClient.Create("collections",
1269                 arvadosclient.Dict{
1270                         "ensure_unique_name": true,
1271                         "collection": arvadosclient.Dict{
1272                                 "is_trashed":    true,
1273                                 "name":          "output for " + runner.Container.UUID,
1274                                 "manifest_text": manifestText}},
1275                 &response)
1276         if err != nil {
1277                 return fmt.Errorf("While creating output collection: %v", err)
1278         }
1279         runner.OutputPDH = &response.PortableDataHash
1280         return nil
1281 }
1282
1283 var outputCollections = make(map[string]arvados.Collection)
1284
1285 // Fetch the collection for the mnt.PortableDataHash
1286 // Return the manifest_text fragment corresponding to the specified mnt.Path
1287 //  after making any required updates.
1288 //  Ex:
1289 //    If mnt.Path is not specified,
1290 //      return the entire manifest_text after replacing any "." with bindSuffix
1291 //    If mnt.Path corresponds to one stream,
1292 //      return the manifest_text for that stream after replacing that stream name with bindSuffix
1293 //    Otherwise, check if a filename in any one stream is being sought. Return the manifest_text
1294 //      for that stream after replacing stream name with bindSuffix minus the last word
1295 //      and the file name with last word of the bindSuffix
1296 //  Allowed path examples:
1297 //    "path":"/"
1298 //    "path":"/subdir1"
1299 //    "path":"/subdir1/subdir2"
1300 //    "path":"/subdir/filename" etc
1301 func (runner *ContainerRunner) getCollectionManifestForPath(mnt arvados.Mount, bindSuffix string) (string, error) {
1302         collection := outputCollections[mnt.PortableDataHash]
1303         if collection.PortableDataHash == "" {
1304                 err := runner.ArvClient.Get("collections", mnt.PortableDataHash, nil, &collection)
1305                 if err != nil {
1306                         return "", fmt.Errorf("While getting collection for %v: %v", mnt.PortableDataHash, err)
1307                 }
1308                 outputCollections[mnt.PortableDataHash] = collection
1309         }
1310
1311         if collection.ManifestText == "" {
1312                 runner.CrunchLog.Printf("No manifest text for collection %v", collection.PortableDataHash)
1313                 return "", nil
1314         }
1315
1316         mft := manifest.Manifest{Text: collection.ManifestText}
1317         extracted := mft.Extract(mnt.Path, bindSuffix)
1318         if extracted.Err != nil {
1319                 return "", fmt.Errorf("Error parsing manifest for %v: %v", mnt.PortableDataHash, extracted.Err.Error())
1320         }
1321         return extracted.Text, nil
1322 }
1323
1324 func (runner *ContainerRunner) CleanupDirs() {
1325         if runner.ArvMount != nil {
1326                 var delay int64 = 8
1327                 umount := exec.Command("arv-mount", fmt.Sprintf("--unmount-timeout=%d", delay), "--unmount", runner.ArvMountPoint)
1328                 umount.Stdout = runner.CrunchLog
1329                 umount.Stderr = runner.CrunchLog
1330                 runner.CrunchLog.Printf("Running %v", umount.Args)
1331                 umnterr := umount.Start()
1332
1333                 if umnterr != nil {
1334                         runner.CrunchLog.Printf("Error unmounting: %v", umnterr)
1335                 } else {
1336                         // If arv-mount --unmount gets stuck for any reason, we
1337                         // don't want to wait for it forever.  Do Wait() in a goroutine
1338                         // so it doesn't block crunch-run.
1339                         umountExit := make(chan error)
1340                         go func() {
1341                                 mnterr := umount.Wait()
1342                                 if mnterr != nil {
1343                                         runner.CrunchLog.Printf("Error unmounting: %v", mnterr)
1344                                 }
1345                                 umountExit <- mnterr
1346                         }()
1347
1348                         for again := true; again; {
1349                                 again = false
1350                                 select {
1351                                 case <-umountExit:
1352                                         umount = nil
1353                                         again = true
1354                                 case <-runner.ArvMountExit:
1355                                         break
1356                                 case <-time.After(time.Duration((delay + 1) * int64(time.Second))):
1357                                         runner.CrunchLog.Printf("Timed out waiting for unmount")
1358                                         if umount != nil {
1359                                                 umount.Process.Kill()
1360                                         }
1361                                         runner.ArvMount.Process.Kill()
1362                                 }
1363                         }
1364                 }
1365         }
1366
1367         if runner.ArvMountPoint != "" {
1368                 if rmerr := os.Remove(runner.ArvMountPoint); rmerr != nil {
1369                         runner.CrunchLog.Printf("While cleaning up arv-mount directory %s: %v", runner.ArvMountPoint, rmerr)
1370                 }
1371         }
1372
1373         for _, tmpdir := range runner.CleanupTempDir {
1374                 if rmerr := os.RemoveAll(tmpdir); rmerr != nil {
1375                         runner.CrunchLog.Printf("While cleaning up temporary directory %s: %v", tmpdir, rmerr)
1376                 }
1377         }
1378 }
1379
1380 // CommitLogs posts the collection containing the final container logs.
1381 func (runner *ContainerRunner) CommitLogs() error {
1382         runner.CrunchLog.Print(runner.finalState)
1383
1384         if runner.arvMountLog != nil {
1385                 runner.arvMountLog.Close()
1386         }
1387         runner.CrunchLog.Close()
1388
1389         // Closing CrunchLog above allows them to be committed to Keep at this
1390         // point, but re-open crunch log with ArvClient in case there are any
1391         // other further errors (such as failing to write the log to Keep!)
1392         // while shutting down
1393         runner.CrunchLog = NewThrottledLogger(&ArvLogWriter{ArvClient: runner.ArvClient,
1394                 UUID: runner.Container.UUID, loggingStream: "crunch-run", writeCloser: nil})
1395         runner.CrunchLog.Immediate = log.New(os.Stderr, runner.Container.UUID+" ", 0)
1396
1397         if runner.LogsPDH != nil {
1398                 // If we have already assigned something to LogsPDH,
1399                 // we must be closing the re-opened log, which won't
1400                 // end up getting attached to the container record and
1401                 // therefore doesn't need to be saved as a collection
1402                 // -- it exists only to send logs to other channels.
1403                 return nil
1404         }
1405
1406         mt, err := runner.LogCollection.ManifestText()
1407         if err != nil {
1408                 return fmt.Errorf("While creating log manifest: %v", err)
1409         }
1410
1411         var response arvados.Collection
1412         err = runner.ArvClient.Create("collections",
1413                 arvadosclient.Dict{
1414                         "ensure_unique_name": true,
1415                         "collection": arvadosclient.Dict{
1416                                 "is_trashed":    true,
1417                                 "name":          "logs for " + runner.Container.UUID,
1418                                 "manifest_text": mt}},
1419                 &response)
1420         if err != nil {
1421                 return fmt.Errorf("While creating log collection: %v", err)
1422         }
1423         runner.LogsPDH = &response.PortableDataHash
1424         return nil
1425 }
1426
1427 // UpdateContainerRunning updates the container state to "Running"
1428 func (runner *ContainerRunner) UpdateContainerRunning() error {
1429         runner.cStateLock.Lock()
1430         defer runner.cStateLock.Unlock()
1431         if runner.cCancelled {
1432                 return ErrCancelled
1433         }
1434         return runner.ArvClient.Update("containers", runner.Container.UUID,
1435                 arvadosclient.Dict{"container": arvadosclient.Dict{"state": "Running"}}, nil)
1436 }
1437
1438 // ContainerToken returns the api_token the container (and any
1439 // arv-mount processes) are allowed to use.
1440 func (runner *ContainerRunner) ContainerToken() (string, error) {
1441         if runner.token != "" {
1442                 return runner.token, nil
1443         }
1444
1445         var auth arvados.APIClientAuthorization
1446         err := runner.ArvClient.Call("GET", "containers", runner.Container.UUID, "auth", nil, &auth)
1447         if err != nil {
1448                 return "", err
1449         }
1450         runner.token = auth.APIToken
1451         return runner.token, nil
1452 }
1453
1454 // UpdateContainerComplete updates the container record state on API
1455 // server to "Complete" or "Cancelled"
1456 func (runner *ContainerRunner) UpdateContainerFinal() error {
1457         update := arvadosclient.Dict{}
1458         update["state"] = runner.finalState
1459         if runner.LogsPDH != nil {
1460                 update["log"] = *runner.LogsPDH
1461         }
1462         if runner.finalState == "Complete" {
1463                 if runner.ExitCode != nil {
1464                         update["exit_code"] = *runner.ExitCode
1465                 }
1466                 if runner.OutputPDH != nil {
1467                         update["output"] = *runner.OutputPDH
1468                 }
1469         }
1470         return runner.ArvClient.Update("containers", runner.Container.UUID, arvadosclient.Dict{"container": update}, nil)
1471 }
1472
1473 // IsCancelled returns the value of Cancelled, with goroutine safety.
1474 func (runner *ContainerRunner) IsCancelled() bool {
1475         runner.cStateLock.Lock()
1476         defer runner.cStateLock.Unlock()
1477         return runner.cCancelled
1478 }
1479
1480 // NewArvLogWriter creates an ArvLogWriter
1481 func (runner *ContainerRunner) NewArvLogWriter(name string) io.WriteCloser {
1482         return &ArvLogWriter{
1483                 ArvClient:     runner.ArvClient,
1484                 UUID:          runner.Container.UUID,
1485                 loggingStream: name,
1486                 writeCloser:   runner.LogCollection.Open(name + ".txt")}
1487 }
1488
1489 // Run the full container lifecycle.
1490 func (runner *ContainerRunner) Run() (err error) {
1491         runner.CrunchLog.Printf("crunch-run %s started", version)
1492         runner.CrunchLog.Printf("Executing container '%s'", runner.Container.UUID)
1493
1494         hostname, hosterr := os.Hostname()
1495         if hosterr != nil {
1496                 runner.CrunchLog.Printf("Error getting hostname '%v'", hosterr)
1497         } else {
1498                 runner.CrunchLog.Printf("Executing on host '%s'", hostname)
1499         }
1500
1501         runner.finalState = "Queued"
1502
1503         defer func() {
1504                 runner.stopSignals()
1505                 runner.CleanupDirs()
1506
1507                 runner.CrunchLog.Printf("crunch-run finished")
1508                 runner.CrunchLog.Close()
1509         }()
1510
1511         defer func() {
1512                 // checkErr prints e (unless it's nil) and sets err to
1513                 // e (unless err is already non-nil). Thus, if err
1514                 // hasn't already been assigned when Run() returns,
1515                 // this cleanup func will cause Run() to return the
1516                 // first non-nil error that is passed to checkErr().
1517                 checkErr := func(e error) {
1518                         if e == nil {
1519                                 return
1520                         }
1521                         runner.CrunchLog.Print(e)
1522                         if err == nil {
1523                                 err = e
1524                         }
1525                         if runner.finalState == "Complete" {
1526                                 // There was an error in the finalization.
1527                                 runner.finalState = "Cancelled"
1528                         }
1529                 }
1530
1531                 // Log the error encountered in Run(), if any
1532                 checkErr(err)
1533
1534                 if runner.finalState == "Queued" {
1535                         runner.UpdateContainerFinal()
1536                         return
1537                 }
1538
1539                 if runner.IsCancelled() {
1540                         runner.finalState = "Cancelled"
1541                         // but don't return yet -- we still want to
1542                         // capture partial output and write logs
1543                 }
1544
1545                 checkErr(runner.CaptureOutput())
1546                 checkErr(runner.CommitLogs())
1547                 checkErr(runner.UpdateContainerFinal())
1548         }()
1549
1550         err = runner.fetchContainerRecord()
1551         if err != nil {
1552                 return
1553         }
1554
1555         // setup signal handling
1556         runner.setupSignals()
1557
1558         // check for and/or load image
1559         err = runner.LoadImage()
1560         if err != nil {
1561                 if !runner.checkBrokenNode(err) {
1562                         // Failed to load image but not due to a "broken node"
1563                         // condition, probably user error.
1564                         runner.finalState = "Cancelled"
1565                 }
1566                 err = fmt.Errorf("While loading container image: %v", err)
1567                 return
1568         }
1569
1570         // set up FUSE mount and binds
1571         err = runner.SetupMounts()
1572         if err != nil {
1573                 runner.finalState = "Cancelled"
1574                 err = fmt.Errorf("While setting up mounts: %v", err)
1575                 return
1576         }
1577
1578         err = runner.CreateContainer()
1579         if err != nil {
1580                 return
1581         }
1582
1583         // Gather and record node information
1584         err = runner.LogNodeInfo()
1585         if err != nil {
1586                 return
1587         }
1588         // Save container.json record on log collection
1589         err = runner.LogContainerRecord()
1590         if err != nil {
1591                 return
1592         }
1593
1594         if runner.IsCancelled() {
1595                 return
1596         }
1597
1598         err = runner.UpdateContainerRunning()
1599         if err != nil {
1600                 return
1601         }
1602         runner.finalState = "Cancelled"
1603
1604         runner.StartCrunchstat()
1605
1606         err = runner.StartContainer()
1607         if err != nil {
1608                 runner.checkBrokenNode(err)
1609                 return
1610         }
1611
1612         err = runner.WaitFinish()
1613         if err == nil {
1614                 runner.finalState = "Complete"
1615         }
1616         return
1617 }
1618
1619 // Fetch the current container record (uuid = runner.Container.UUID)
1620 // into runner.Container.
1621 func (runner *ContainerRunner) fetchContainerRecord() error {
1622         reader, err := runner.ArvClient.CallRaw("GET", "containers", runner.Container.UUID, "", nil)
1623         if err != nil {
1624                 return fmt.Errorf("error fetching container record: %v", err)
1625         }
1626         defer reader.Close()
1627
1628         dec := json.NewDecoder(reader)
1629         dec.UseNumber()
1630         err = dec.Decode(&runner.Container)
1631         if err != nil {
1632                 return fmt.Errorf("error decoding container record: %v", err)
1633         }
1634         return nil
1635 }
1636
1637 // NewContainerRunner creates a new container runner.
1638 func NewContainerRunner(api IArvadosClient,
1639         kc IKeepClient,
1640         docker ThinDockerClient,
1641         containerUUID string) *ContainerRunner {
1642
1643         cr := &ContainerRunner{ArvClient: api, Kc: kc, Docker: docker}
1644         cr.NewLogWriter = cr.NewArvLogWriter
1645         cr.RunArvMount = cr.ArvMountCmd
1646         cr.MkTempDir = ioutil.TempDir
1647         cr.LogCollection = &CollectionWriter{0, kc, nil, nil, sync.Mutex{}}
1648         cr.Container.UUID = containerUUID
1649         cr.CrunchLog = NewThrottledLogger(cr.NewLogWriter("crunch-run"))
1650         cr.CrunchLog.Immediate = log.New(os.Stderr, containerUUID+" ", 0)
1651
1652         loadLogThrottleParams(api)
1653
1654         return cr
1655 }
1656
1657 func main() {
1658         statInterval := flag.Duration("crunchstat-interval", 10*time.Second, "sampling period for periodic resource usage reporting")
1659         cgroupRoot := flag.String("cgroup-root", "/sys/fs/cgroup", "path to sysfs cgroup tree")
1660         cgroupParent := flag.String("cgroup-parent", "docker", "name of container's parent cgroup (ignored if -cgroup-parent-subsystem is used)")
1661         cgroupParentSubsystem := flag.String("cgroup-parent-subsystem", "", "use current cgroup for given subsystem as parent cgroup for container")
1662         caCertsPath := flag.String("ca-certs", "", "Path to TLS root certificates")
1663         enableNetwork := flag.String("container-enable-networking", "default",
1664                 `Specify if networking should be enabled for container.  One of 'default', 'always':
1665         default: only enable networking if container requests it.
1666         always:  containers always have networking enabled
1667         `)
1668         networkMode := flag.String("container-network-mode", "default",
1669                 `Set networking mode for container.  Corresponds to Docker network mode (--net).
1670         `)
1671         memprofile := flag.String("memprofile", "", "write memory profile to `file` after running container")
1672         getVersion := flag.Bool("version", false, "Print version information and exit.")
1673         flag.Parse()
1674
1675         // Print version information if requested
1676         if *getVersion {
1677                 fmt.Printf("crunch-run %s\n", version)
1678                 return
1679         }
1680
1681         log.Printf("crunch-run %s started", version)
1682
1683         containerId := flag.Arg(0)
1684
1685         if *caCertsPath != "" {
1686                 arvadosclient.CertFiles = []string{*caCertsPath}
1687         }
1688
1689         api, err := arvadosclient.MakeArvadosClient()
1690         if err != nil {
1691                 log.Fatalf("%s: %v", containerId, err)
1692         }
1693         api.Retries = 8
1694
1695         kc, kcerr := keepclient.MakeKeepClient(api)
1696         if kcerr != nil {
1697                 log.Fatalf("%s: %v", containerId, kcerr)
1698         }
1699         kc.BlockCache = &keepclient.BlockCache{MaxBlocks: 2}
1700         kc.Retries = 4
1701
1702         // API version 1.21 corresponds to Docker 1.9, which is currently the
1703         // minimum version we want to support.
1704         docker, dockererr := dockerclient.NewClient(dockerclient.DefaultDockerHost, "1.21", nil, nil)
1705         dockerClientProxy := ThinDockerClientProxy{Docker: docker}
1706
1707         cr := NewContainerRunner(api, kc, dockerClientProxy, containerId)
1708
1709         if dockererr != nil {
1710                 cr.CrunchLog.Printf("%s: %v", containerId, dockererr)
1711                 cr.checkBrokenNode(dockererr)
1712                 cr.CrunchLog.Close()
1713                 os.Exit(1)
1714         }
1715
1716         cr.statInterval = *statInterval
1717         cr.cgroupRoot = *cgroupRoot
1718         cr.expectCgroupParent = *cgroupParent
1719         cr.enableNetwork = *enableNetwork
1720         cr.networkMode = *networkMode
1721         if *cgroupParentSubsystem != "" {
1722                 p := findCgroup(*cgroupParentSubsystem)
1723                 cr.setCgroupParent = p
1724                 cr.expectCgroupParent = p
1725         }
1726
1727         runerr := cr.Run()
1728
1729         if *memprofile != "" {
1730                 f, err := os.Create(*memprofile)
1731                 if err != nil {
1732                         log.Printf("could not create memory profile: ", err)
1733                 }
1734                 runtime.GC() // get up-to-date statistics
1735                 if err := pprof.WriteHeapProfile(f); err != nil {
1736                         log.Printf("could not write memory profile: ", err)
1737                 }
1738                 closeerr := f.Close()
1739                 if closeerr != nil {
1740                         log.Printf("closing memprofile file: ", err)
1741                 }
1742         }
1743
1744         if runerr != nil {
1745                 log.Fatalf("%s: %v", containerId, runerr)
1746         }
1747 }