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