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