lib/crunchrun/docker.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4 package crunchrun
   5
   6 import (
   7         "fmt"
   8         "io"
   9         "io/ioutil"
  10         "os"
  11         "strings"
  12         "time"
  13
  14         "git.arvados.org/arvados.git/sdk/go/arvados"
  15         dockertypes "github.com/docker/docker/api/types"
  16         dockercontainer "github.com/docker/docker/api/types/container"
  17         dockerclient "github.com/docker/docker/client"
  18         "golang.org/x/net/context"
  19 )
  20
  21 // Docker daemon won't let you set a limit less than ~10 MiB
  22 const minDockerRAM = int64(16 * 1024 * 1024)
  23
  24 type dockerExecutor struct {
  25         containerUUID    string
  26         logf             func(string, ...interface{})
  27         watchdogInterval time.Duration
  28         dockerclient     *dockerclient.Client
  29         containerID      string
  30         doneIO           chan struct{}
  31         errIO            error
  32 }
  33
  34 func newDockerExecutor(containerUUID string, logf func(string, ...interface{}), watchdogInterval time.Duration) (*dockerExecutor, error) {
  35         // API version 1.21 corresponds to Docker 1.9, which is
  36         // currently the minimum version we want to support.
  37         client, err := dockerclient.NewClient(dockerclient.DefaultDockerHost, "1.21", nil, nil)
  38         if watchdogInterval < 1 {
  39                 watchdogInterval = time.Minute
  40         }
  41         return &dockerExecutor{
  42                 containerUUID:    containerUUID,
  43                 logf:             logf,
  44                 watchdogInterval: watchdogInterval,
  45                 dockerclient:     client,
  46         }, err
  47 }
  48
  49 func (e *dockerExecutor) Runtime() string { return "docker" }
  50
  51 func (e *dockerExecutor) LoadImage(imageID string, imageTarballPath string, container arvados.Container, arvMountPoint string,
  52         containerClient *arvados.Client) error {
  53         _, _, err := e.dockerclient.ImageInspectWithRaw(context.TODO(), imageID)
  54         if err == nil {
  55                 // already loaded
  56                 return nil
  57         }
  58
  59         f, err := os.Open(imageTarballPath)
  60         if err != nil {
  61                 return err
  62         }
  63         defer f.Close()
  64         resp, err := e.dockerclient.ImageLoad(context.TODO(), f, true)
  65         if err != nil {
  66                 return fmt.Errorf("While loading container image into Docker: %v", err)
  67         }
  68         defer resp.Body.Close()
  69         buf, _ := ioutil.ReadAll(resp.Body)
  70         e.logf("loaded image: response %s", buf)
  71         return nil
  72 }
  73
  74 func (e *dockerExecutor) config(spec containerSpec) (dockercontainer.Config, dockercontainer.HostConfig) {
  75         e.logf("Creating Docker container")
  76         cfg := dockercontainer.Config{
  77                 Image:        spec.Image,
  78                 Cmd:          spec.Command,
  79                 WorkingDir:   spec.WorkingDir,
  80                 Volumes:      map[string]struct{}{},
  81                 OpenStdin:    spec.Stdin != nil,
  82                 StdinOnce:    spec.Stdin != nil,
  83                 AttachStdin:  spec.Stdin != nil,
  84                 AttachStdout: true,
  85                 AttachStderr: true,
  86         }
  87         if cfg.WorkingDir == "." {
  88                 cfg.WorkingDir = ""
  89         }
  90         for k, v := range spec.Env {
  91                 cfg.Env = append(cfg.Env, k+"="+v)
  92         }
  93         if spec.RAM > 0 && spec.RAM < minDockerRAM {
  94                 spec.RAM = minDockerRAM
  95         }
  96         hostCfg := dockercontainer.HostConfig{
  97                 LogConfig: dockercontainer.LogConfig{
  98                         Type: "none",
  99                 },
 100                 NetworkMode: dockercontainer.NetworkMode("none"),
 101                 Resources: dockercontainer.Resources{
 102                         CgroupParent: spec.CgroupParent,
 103                         NanoCPUs:     int64(spec.VCPUs) * 1000000000,
 104                         Memory:       spec.RAM, // RAM
 105                         MemorySwap:   spec.RAM, // RAM+swap
 106                         KernelMemory: spec.RAM, // kernel portion
 107                 },
 108         }
 109         if spec.CUDADeviceCount != 0 {
 110                 var deviceIds []string
 111                 if cudaVisibleDevices := os.Getenv("CUDA_VISIBLE_DEVICES"); cudaVisibleDevices != "" {
 112                         // If a resource manager such as slurm or LSF told
 113                         // us to select specific devices we need to propagate that.
 114                         deviceIds = strings.Split(cudaVisibleDevices, ",")
 115                 }
 116
 117                 deviceCount := spec.CUDADeviceCount
 118                 if len(deviceIds) > 0 {
 119                         // Docker won't accept both non-empty
 120                         // DeviceIDs and a non-zero Count
 121                         //
 122                         // (it turns out "Count" is a dumb fallback
 123                         // that just allocates device 0, 1, 2, ...,
 124                         // Count-1)
 125                         deviceCount = 0
 126                 }
 127
 128                 // Capabilities are confusing.  The driver has generic
 129                 // capabilities "gpu" and "nvidia" but then there's
 130                 // additional capabilities "compute" and "utility"
 131                 // that are passed to nvidia-container-cli.
 132                 //
 133                 // "compute" means include the CUDA libraries and
 134                 // "utility" means include the CUDA utility programs
 135                 // (like nvidia-smi).
 136                 //
 137                 // https://github.com/moby/moby/blob/7b9275c0da707b030e62c96b679a976f31f929d3/daemon/nvidia_linux.go#L37
 138                 // https://github.com/containerd/containerd/blob/main/contrib/nvidia/nvidia.go
 139                 hostCfg.Resources.DeviceRequests = append(hostCfg.Resources.DeviceRequests, dockercontainer.DeviceRequest{
 140                         Driver:       "nvidia",
 141                         Count:        deviceCount,
 142                         DeviceIDs:    deviceIds,
 143                         Capabilities: [][]string{[]string{"gpu", "nvidia", "compute", "utility"}},
 144                 })
 145         }
 146         for path, mount := range spec.BindMounts {
 147                 bind := mount.HostPath + ":" + path
 148                 if mount.ReadOnly {
 149                         bind += ":ro"
 150                 }
 151                 hostCfg.Binds = append(hostCfg.Binds, bind)
 152         }
 153         if spec.EnableNetwork {
 154                 hostCfg.NetworkMode = dockercontainer.NetworkMode(spec.NetworkMode)
 155         }
 156         return cfg, hostCfg
 157 }
 158
 159 func (e *dockerExecutor) Create(spec containerSpec) error {
 160         cfg, hostCfg := e.config(spec)
 161         created, err := e.dockerclient.ContainerCreate(context.TODO(), &cfg, &hostCfg, nil, e.containerUUID)
 162         if err != nil {
 163                 return fmt.Errorf("While creating container: %v", err)
 164         }
 165         e.containerID = created.ID
 166         return e.startIO(spec.Stdin, spec.Stdout, spec.Stderr)
 167 }
 168
 169 func (e *dockerExecutor) CgroupID() string {
 170         return e.containerID
 171 }
 172
 173 func (e *dockerExecutor) Start() error {
 174         return e.dockerclient.ContainerStart(context.TODO(), e.containerID, dockertypes.ContainerStartOptions{})
 175 }
 176
 177 func (e *dockerExecutor) Stop() error {
 178         err := e.dockerclient.ContainerRemove(context.TODO(), e.containerID, dockertypes.ContainerRemoveOptions{Force: true})
 179         if err != nil && strings.Contains(err.Error(), "No such container: "+e.containerID) {
 180                 err = nil
 181         }
 182         return err
 183 }
 184
 185 // Wait for the container to terminate, capture the exit code, and
 186 // wait for stdout/stderr logging to finish.
 187 func (e *dockerExecutor) Wait(ctx context.Context) (int, error) {
 188         ctx, cancel := context.WithCancel(ctx)
 189         defer cancel()
 190         watchdogErr := make(chan error, 1)
 191         go func() {
 192                 ticker := time.NewTicker(e.watchdogInterval)
 193                 defer ticker.Stop()
 194                 for range ticker.C {
 195                         dctx, dcancel := context.WithDeadline(ctx, time.Now().Add(e.watchdogInterval))
 196                         ctr, err := e.dockerclient.ContainerInspect(dctx, e.containerID)
 197                         dcancel()
 198                         if ctx.Err() != nil {
 199                                 // Either the container already
 200                                 // exited, or our caller is trying to
 201                                 // kill it.
 202                                 return
 203                         } else if err != nil {
 204                                 e.logf("Error inspecting container: %s", err)
 205                                 watchdogErr <- err
 206                                 return
 207                         } else if ctr.State == nil || !(ctr.State.Running || ctr.State.Status == "created") {
 208                                 watchdogErr <- fmt.Errorf("Container is not running: State=%v", ctr.State)
 209                                 return
 210                         }
 211                 }
 212         }()
 213
 214         waitOk, waitErr := e.dockerclient.ContainerWait(ctx, e.containerID, dockercontainer.WaitConditionNotRunning)
 215         for {
 216                 select {
 217                 case waitBody := <-waitOk:
 218                         e.logf("Container exited with code: %v", waitBody.StatusCode)
 219                         // wait for stdout/stderr to complete
 220                         <-e.doneIO
 221                         return int(waitBody.StatusCode), nil
 222
 223                 case err := <-waitErr:
 224                         return -1, fmt.Errorf("container wait: %v", err)
 225
 226                 case <-ctx.Done():
 227                         return -1, ctx.Err()
 228
 229                 case err := <-watchdogErr:
 230                         return -1, err
 231                 }
 232         }
 233 }
 234
 235 func (e *dockerExecutor) startIO(stdin io.Reader, stdout, stderr io.Writer) error {
 236         resp, err := e.dockerclient.ContainerAttach(context.TODO(), e.containerID, dockertypes.ContainerAttachOptions{
 237                 Stream: true,
 238                 Stdin:  stdin != nil,
 239                 Stdout: true,
 240                 Stderr: true,
 241         })
 242         if err != nil {
 243                 return fmt.Errorf("error attaching container stdin/stdout/stderr streams: %v", err)
 244         }
 245         var errStdin error
 246         if stdin != nil {
 247                 go func() {
 248                         errStdin = e.handleStdin(stdin, resp.Conn, resp.CloseWrite)
 249                 }()
 250         }
 251         e.doneIO = make(chan struct{})
 252         go func() {
 253                 e.errIO = e.handleStdoutStderr(stdout, stderr, resp.Reader)
 254                 if e.errIO == nil && errStdin != nil {
 255                         e.errIO = errStdin
 256                 }
 257                 close(e.doneIO)
 258         }()
 259         return nil
 260 }
 261
 262 func (e *dockerExecutor) handleStdin(stdin io.Reader, conn io.Writer, closeConn func() error) error {
 263         defer closeConn()
 264         _, err := io.Copy(conn, stdin)
 265         if err != nil {
 266                 return fmt.Errorf("While writing to docker container on stdin: %v", err)
 267         }
 268         return nil
 269 }
 270
 271 // Handle docker log protocol; see
 272 // https://docs.docker.com/engine/reference/api/docker_remote_api_v1.15/#attach-to-a-container
 273 func (e *dockerExecutor) handleStdoutStderr(stdout, stderr io.Writer, reader io.Reader) error {
 274         header := make([]byte, 8)
 275         var err error
 276         for err == nil {
 277                 _, err = io.ReadAtLeast(reader, header, 8)
 278                 if err != nil {
 279                         if err == io.EOF {
 280                                 err = nil
 281                         }
 282                         break
 283                 }
 284                 readsize := int64(header[7]) | (int64(header[6]) << 8) | (int64(header[5]) << 16) | (int64(header[4]) << 24)
 285                 if header[0] == 1 {
 286                         _, err = io.CopyN(stdout, reader, readsize)
 287                 } else {
 288                         // stderr
 289                         _, err = io.CopyN(stderr, reader, readsize)
 290                 }
 291         }
 292         if err != nil {
 293                 return fmt.Errorf("error copying stdout/stderr from docker: %v", err)
 294         }
 295         return nil
 296 }
 297
 298 func (e *dockerExecutor) Close() {
 299         e.dockerclient.ContainerRemove(context.TODO(), e.containerID, dockertypes.ContainerRemoveOptions{Force: true})
 300 }