lib/crunchrun/singularity.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package crunchrun
   6
   7 import (
   8         "bytes"
   9         "context"
  10         "errors"
  11         "fmt"
  12         "io/ioutil"
  13         "net"
  14         "os"
  15         "os/exec"
  16         "os/user"
  17         "regexp"
  18         "sort"
  19         "strconv"
  20         "strings"
  21         "syscall"
  22         "time"
  23
  24         "git.arvados.org/arvados.git/sdk/go/arvados"
  25 )
  26
  27 type singularityExecutor struct {
  28         logf          func(string, ...interface{})
  29         sudo          bool // use sudo to run singularity (only used by tests)
  30         spec          containerSpec
  31         tmpdir        string
  32         child         *exec.Cmd
  33         imageFilename string // "sif" image
  34 }
  35
  36 func newSingularityExecutor(logf func(string, ...interface{})) (*singularityExecutor, error) {
  37         tmpdir, err := ioutil.TempDir("", "crunch-run-singularity-")
  38         if err != nil {
  39                 return nil, err
  40         }
  41         return &singularityExecutor{
  42                 logf:   logf,
  43                 tmpdir: tmpdir,
  44         }, nil
  45 }
  46
  47 func (e *singularityExecutor) Runtime() string {
  48         buf, err := exec.Command("singularity", "--version").CombinedOutput()
  49         if err != nil {
  50                 return "singularity (unknown version)"
  51         }
  52         return strings.TrimSuffix(string(buf), "\n")
  53 }
  54
  55 func (e *singularityExecutor) getOrCreateProject(ownerUuid string, name string, containerClient *arvados.Client) (*arvados.Group, error) {
  56         var gp arvados.GroupList
  57         err := containerClient.RequestAndDecode(&gp,
  58                 arvados.EndpointGroupList.Method,
  59                 arvados.EndpointGroupList.Path,
  60                 nil, arvados.ListOptions{Filters: []arvados.Filter{
  61                         arvados.Filter{"owner_uuid", "=", ownerUuid},
  62                         arvados.Filter{"name", "=", name},
  63                         arvados.Filter{"group_class", "=", "project"},
  64                 },
  65                         Limit: 1})
  66         if err != nil {
  67                 return nil, err
  68         }
  69         if len(gp.Items) == 1 {
  70                 return &gp.Items[0], nil
  71         }
  72
  73         var rgroup arvados.Group
  74         err = containerClient.RequestAndDecode(&rgroup,
  75                 arvados.EndpointGroupCreate.Method,
  76                 arvados.EndpointGroupCreate.Path,
  77                 nil, map[string]interface{}{
  78                         "group": map[string]string{
  79                                 "owner_uuid":  ownerUuid,
  80                                 "name":        name,
  81                                 "group_class": "project",
  82                         },
  83                 })
  84         if err != nil {
  85                 return nil, err
  86         }
  87         return &rgroup, nil
  88 }
  89
  90 func (e *singularityExecutor) checkImageCache(dockerImageID string, container arvados.Container, arvMountPoint string,
  91         containerClient *arvados.Client) (collection *arvados.Collection, err error) {
  92
  93         // Cache the image to keep
  94         cacheGroup, err := e.getOrCreateProject(container.RuntimeUserUUID, ".cache", containerClient)
  95         if err != nil {
  96                 return nil, fmt.Errorf("error getting '.cache' project: %v", err)
  97         }
  98         imageGroup, err := e.getOrCreateProject(cacheGroup.UUID, "auto-generated singularity images", containerClient)
  99         if err != nil {
 100                 return nil, fmt.Errorf("error getting 'auto-generated singularity images' project: %s", err)
 101         }
 102
 103         collectionName := fmt.Sprintf("singularity image for %v", dockerImageID)
 104         var cl arvados.CollectionList
 105         err = containerClient.RequestAndDecode(&cl,
 106                 arvados.EndpointCollectionList.Method,
 107                 arvados.EndpointCollectionList.Path,
 108                 nil, arvados.ListOptions{Filters: []arvados.Filter{
 109                         arvados.Filter{"owner_uuid", "=", imageGroup.UUID},
 110                         arvados.Filter{"name", "=", collectionName},
 111                 },
 112                         Limit: 1})
 113         if err != nil {
 114                 return nil, fmt.Errorf("error querying for collection '%v': %v", collectionName, err)
 115         }
 116         var imageCollection arvados.Collection
 117         if len(cl.Items) == 1 {
 118                 imageCollection = cl.Items[0]
 119         } else {
 120                 collectionName := "converting " + collectionName
 121                 exp := time.Now().Add(24 * 7 * 2 * time.Hour)
 122                 err = containerClient.RequestAndDecode(&imageCollection,
 123                         arvados.EndpointCollectionCreate.Method,
 124                         arvados.EndpointCollectionCreate.Path,
 125                         nil, map[string]interface{}{
 126                                 "collection": map[string]string{
 127                                         "owner_uuid": imageGroup.UUID,
 128                                         "name":       collectionName,
 129                                         "trash_at":   exp.UTC().Format(time.RFC3339),
 130                                 },
 131                                 "ensure_unique_name": true,
 132                         })
 133                 if err != nil {
 134                         return nil, fmt.Errorf("error creating '%v' collection: %s", collectionName, err)
 135                 }
 136         }
 137
 138         return &imageCollection, nil
 139 }
 140
 141 // LoadImage will satisfy ContainerExecuter interface transforming
 142 // containerImage into a sif file for later use.
 143 func (e *singularityExecutor) LoadImage(dockerImageID string, imageTarballPath string, container arvados.Container, arvMountPoint string,
 144         containerClient *arvados.Client) error {
 145
 146         var imageFilename string
 147         var sifCollection *arvados.Collection
 148         var err error
 149         if containerClient != nil {
 150                 sifCollection, err = e.checkImageCache(dockerImageID, container, arvMountPoint, containerClient)
 151                 if err != nil {
 152                         return err
 153                 }
 154                 imageFilename = fmt.Sprintf("%s/by_uuid/%s/image.sif", arvMountPoint, sifCollection.UUID)
 155         } else {
 156                 imageFilename = e.tmpdir + "/image.sif"
 157         }
 158
 159         if _, err := os.Stat(imageFilename); os.IsNotExist(err) {
 160                 // Make sure the docker image is readable, and error
 161                 // out if not.
 162                 if _, err := os.Stat(imageTarballPath); err != nil {
 163                         return err
 164                 }
 165
 166                 e.logf("building singularity image")
 167                 // "singularity build" does not accept a
 168                 // docker-archive://... filename containing a ":" character,
 169                 // as in "/path/to/sha256:abcd...1234.tar". Workaround: make a
 170                 // symlink that doesn't have ":" chars.
 171                 err := os.Symlink(imageTarballPath, e.tmpdir+"/image.tar")
 172                 if err != nil {
 173                         return err
 174                 }
 175
 176                 // Set up a cache and tmp dir for singularity build
 177                 err = os.Mkdir(e.tmpdir+"/cache", 0700)
 178                 if err != nil {
 179                         return err
 180                 }
 181                 defer os.RemoveAll(e.tmpdir + "/cache")
 182                 err = os.Mkdir(e.tmpdir+"/tmp", 0700)
 183                 if err != nil {
 184                         return err
 185                 }
 186                 defer os.RemoveAll(e.tmpdir + "/tmp")
 187
 188                 build := exec.Command("singularity", "build", imageFilename, "docker-archive://"+e.tmpdir+"/image.tar")
 189                 build.Env = os.Environ()
 190                 build.Env = append(build.Env, "SINGULARITY_CACHEDIR="+e.tmpdir+"/cache")
 191                 build.Env = append(build.Env, "SINGULARITY_TMPDIR="+e.tmpdir+"/tmp")
 192                 e.logf("%v", build.Args)
 193                 out, err := build.CombinedOutput()
 194                 // INFO:    Starting build...
 195                 // Getting image source signatures
 196                 // Copying blob ab15617702de done
 197                 // Copying config 651e02b8a2 done
 198                 // Writing manifest to image destination
 199                 // Storing signatures
 200                 // 2021/04/22 14:42:14  info unpack layer: sha256:21cbfd3a344c52b197b9fa36091e66d9cbe52232703ff78d44734f85abb7ccd3
 201                 // INFO:    Creating SIF file...
 202                 // INFO:    Build complete: arvados-jobs.latest.sif
 203                 e.logf("%s", out)
 204                 if err != nil {
 205                         return err
 206                 }
 207         }
 208
 209         if containerClient == nil {
 210                 e.imageFilename = imageFilename
 211                 return nil
 212         }
 213
 214         // update TTL to now + two weeks
 215         exp := time.Now().Add(24 * 7 * 2 * time.Hour)
 216
 217         uuidPath, err := containerClient.PathForUUID("update", sifCollection.UUID)
 218         if err != nil {
 219                 e.logf("error PathForUUID: %v", err)
 220                 return nil
 221         }
 222         var imageCollection arvados.Collection
 223         err = containerClient.RequestAndDecode(&imageCollection,
 224                 arvados.EndpointCollectionUpdate.Method,
 225                 uuidPath,
 226                 nil, map[string]interface{}{
 227                         "collection": map[string]string{
 228                                 "name":     fmt.Sprintf("singularity image for %v", dockerImageID),
 229                                 "trash_at": exp.UTC().Format(time.RFC3339),
 230                         },
 231                 })
 232         if err == nil {
 233                 // If we just wrote the image to the cache, the
 234                 // response also returns the updated PDH
 235                 e.imageFilename = fmt.Sprintf("%s/by_id/%s/image.sif", arvMountPoint, imageCollection.PortableDataHash)
 236                 return nil
 237         }
 238
 239         e.logf("error updating/renaming collection for cached sif image: %v", err)
 240         // Failed to update but maybe it lost a race and there is
 241         // another cached collection in the same place, so check the cache
 242         // again
 243         sifCollection, err = e.checkImageCache(dockerImageID, container, arvMountPoint, containerClient)
 244         if err != nil {
 245                 return err
 246         }
 247         e.imageFilename = fmt.Sprintf("%s/by_id/%s/image.sif", arvMountPoint, sifCollection.PortableDataHash)
 248
 249         return nil
 250 }
 251
 252 func (e *singularityExecutor) Create(spec containerSpec) error {
 253         e.spec = spec
 254         return nil
 255 }
 256
 257 func (e *singularityExecutor) execCmd(path string) *exec.Cmd {
 258         args := []string{path, "exec", "--containall", "--cleanenv", "--pwd=" + e.spec.WorkingDir}
 259         if !e.spec.EnableNetwork {
 260                 args = append(args, "--net", "--network=none")
 261         } else if u, err := user.Current(); err == nil && u.Uid == "0" || e.sudo {
 262                 // Specifying --network=bridge fails unless
 263                 // singularity is running as root.
 264                 //
 265                 // Note this used to be possible with --fakeroot, or
 266                 // configuring singularity like so:
 267                 //
 268                 // singularity config global --set 'allow net networks' bridge
 269                 // singularity config global --set 'allow net groups' mygroup
 270                 //
 271                 // However, these options no longer work (as of debian
 272                 // bookworm) because iptables now refuses to run in a
 273                 // setuid environment.
 274                 args = append(args, "--net", "--network=bridge")
 275         } else {
 276                 // If we don't pass a --net argument at all, the
 277                 // container will be in the same network namespace as
 278                 // the host.
 279                 //
 280                 // Note this allows the container to listen on the
 281                 // host's external ports.
 282         }
 283         if e.spec.CUDADeviceCount != 0 {
 284                 args = append(args, "--nv")
 285         }
 286
 287         // If we ask for resource limits that aren't supported,
 288         // singularity will not run the container at all. So we probe
 289         // for support first, and only apply the limits that appear to
 290         // be supported.
 291         //
 292         // Default debian configuration lets non-root users set memory
 293         // limits but not CPU limits, so we enable/disable those
 294         // limits independently.
 295         //
 296         // https://rootlesscontaine.rs/getting-started/common/cgroup2/
 297         checkCgroupSupport(e.logf)
 298         if e.spec.VCPUs > 0 {
 299                 if cgroupSupport["cpu"] {
 300                         args = append(args, "--cpus", fmt.Sprintf("%d", e.spec.VCPUs))
 301                 } else {
 302                         e.logf("cpu limits are not supported by current systemd/cgroup configuration, not setting --cpu %d", e.spec.VCPUs)
 303                 }
 304         }
 305         if e.spec.RAM > 0 {
 306                 if cgroupSupport["memory"] {
 307                         args = append(args, "--memory", fmt.Sprintf("%d", e.spec.RAM))
 308                 } else {
 309                         e.logf("memory limits are not supported by current systemd/cgroup configuration, not setting --memory %d", e.spec.RAM)
 310                 }
 311         }
 312
 313         readonlyflag := map[bool]string{
 314                 false: "rw",
 315                 true:  "ro",
 316         }
 317         var binds []string
 318         for path, _ := range e.spec.BindMounts {
 319                 binds = append(binds, path)
 320         }
 321         sort.Strings(binds)
 322         for _, path := range binds {
 323                 mount := e.spec.BindMounts[path]
 324                 if path == e.spec.Env["HOME"] {
 325                         // Singularity treats $HOME as special case
 326                         args = append(args, "--home", mount.HostPath+":"+path)
 327                 } else {
 328                         args = append(args, "--bind", mount.HostPath+":"+path+":"+readonlyflag[mount.ReadOnly])
 329                 }
 330         }
 331
 332         // This is for singularity 3.5.2. There are some behaviors
 333         // that will change in singularity 3.6, please see:
 334         // https://sylabs.io/guides/3.7/user-guide/environment_and_metadata.html
 335         // https://sylabs.io/guides/3.5/user-guide/environment_and_metadata.html
 336         env := make([]string, 0, len(e.spec.Env))
 337         for k, v := range e.spec.Env {
 338                 if k == "HOME" {
 339                         // Singularity treats $HOME as special case,
 340                         // this is handled with --home above
 341                         continue
 342                 }
 343                 env = append(env, "SINGULARITYENV_"+k+"="+v)
 344         }
 345
 346         // Singularity always makes all nvidia devices visible to the
 347         // container.  If a resource manager such as slurm or LSF told
 348         // us to select specific devices we need to propagate that.
 349         if cudaVisibleDevices := os.Getenv("CUDA_VISIBLE_DEVICES"); cudaVisibleDevices != "" {
 350                 // If a resource manager such as slurm or LSF told
 351                 // us to select specific devices we need to propagate that.
 352                 env = append(env, "SINGULARITYENV_CUDA_VISIBLE_DEVICES="+cudaVisibleDevices)
 353         }
 354         // Singularity's default behavior is to evaluate each
 355         // SINGULARITYENV_* env var with a shell as a double-quoted
 356         // string and pass the result to the contained
 357         // process. Singularity 3.10+ has an option to pass env vars
 358         // through literally without evaluating, which is what we
 359         // want. See https://github.com/sylabs/singularity/pull/704
 360         // and https://dev.arvados.org/issues/19081
 361         env = append(env, "SINGULARITY_NO_EVAL=1")
 362
 363         // If we don't propagate XDG_RUNTIME_DIR and
 364         // DBUS_SESSION_BUS_ADDRESS, singularity resource limits fail
 365         // with "FATAL: container creation failed: while applying
 366         // cgroups config: system configuration does not support
 367         // cgroup management" or "FATAL: container creation failed:
 368         // while applying cgroups config: rootless cgroups require a
 369         // D-Bus session - check that XDG_RUNTIME_DIR and
 370         // DBUS_SESSION_BUS_ADDRESS are set".
 371         env = append(env, "XDG_RUNTIME_DIR="+os.Getenv("XDG_RUNTIME_DIR"))
 372         env = append(env, "DBUS_SESSION_BUS_ADDRESS="+os.Getenv("DBUS_SESSION_BUS_ADDRESS"))
 373
 374         args = append(args, e.imageFilename)
 375         args = append(args, e.spec.Command...)
 376
 377         return &exec.Cmd{
 378                 Path:   path,
 379                 Args:   args,
 380                 Env:    env,
 381                 Stdin:  e.spec.Stdin,
 382                 Stdout: e.spec.Stdout,
 383                 Stderr: e.spec.Stderr,
 384         }
 385 }
 386
 387 func (e *singularityExecutor) Start() error {
 388         path, err := exec.LookPath("singularity")
 389         if err != nil {
 390                 return err
 391         }
 392         child := e.execCmd(path)
 393         if e.sudo {
 394                 child.Args = append([]string{child.Path}, child.Args...)
 395                 child.Path, err = exec.LookPath("sudo")
 396                 if err != nil {
 397                         return err
 398                 }
 399         }
 400         err = child.Start()
 401         if err != nil {
 402                 return err
 403         }
 404         e.child = child
 405         return nil
 406 }
 407
 408 func (e *singularityExecutor) Pid() int {
 409         childproc, err := e.containedProcess()
 410         if err != nil {
 411                 return 0
 412         }
 413         return childproc
 414 }
 415
 416 func (e *singularityExecutor) Stop() error {
 417         if e.child == nil || e.child.Process == nil {
 418                 // no process started, or Wait already called
 419                 return nil
 420         }
 421         if err := e.child.Process.Signal(syscall.Signal(0)); err != nil {
 422                 // process already exited
 423                 return nil
 424         }
 425         return e.child.Process.Signal(syscall.SIGKILL)
 426 }
 427
 428 func (e *singularityExecutor) Wait(context.Context) (int, error) {
 429         err := e.child.Wait()
 430         if err, ok := err.(*exec.ExitError); ok {
 431                 return err.ProcessState.ExitCode(), nil
 432         }
 433         if err != nil {
 434                 return 0, err
 435         }
 436         return e.child.ProcessState.ExitCode(), nil
 437 }
 438
 439 func (e *singularityExecutor) Close() {
 440         err := os.RemoveAll(e.tmpdir)
 441         if err != nil {
 442                 e.logf("error removing temp dir: %s", err)
 443         }
 444 }
 445
 446 func (e *singularityExecutor) InjectCommand(ctx context.Context, detachKeys, username string, usingTTY bool, injectcmd []string) (*exec.Cmd, error) {
 447         target, err := e.containedProcess()
 448         if err != nil {
 449                 return nil, err
 450         }
 451         return exec.CommandContext(ctx, "nsenter", append([]string{fmt.Sprintf("--target=%d", target), "--all"}, injectcmd...)...), nil
 452 }
 453
 454 var (
 455         errContainerHasNoIPAddress = errors.New("container has no IP address distinct from host")
 456 )
 457
 458 func (e *singularityExecutor) IPAddress() (string, error) {
 459         target, err := e.containedProcess()
 460         if err != nil {
 461                 return "", err
 462         }
 463         targetIPs, err := processIPs(target)
 464         if err != nil {
 465                 return "", err
 466         }
 467         selfIPs, err := processIPs(os.Getpid())
 468         if err != nil {
 469                 return "", err
 470         }
 471         for ip := range targetIPs {
 472                 if !selfIPs[ip] {
 473                         return ip, nil
 474                 }
 475         }
 476         return "", errContainerHasNoIPAddress
 477 }
 478
 479 func processIPs(pid int) (map[string]bool, error) {
 480         fibtrie, err := os.ReadFile(fmt.Sprintf("/proc/%d/net/fib_trie", pid))
 481         if err != nil {
 482                 return nil, err
 483         }
 484
 485         addrs := map[string]bool{}
 486         // When we see a pair of lines like this:
 487         //
 488         //              |-- 10.1.2.3
 489         //                 /32 host LOCAL
 490         //
 491         // ...we set addrs["10.1.2.3"] = true
 492         lines := bytes.Split(fibtrie, []byte{'\n'})
 493         for linenumber, line := range lines {
 494                 if !bytes.HasSuffix(line, []byte("/32 host LOCAL")) {
 495                         continue
 496                 }
 497                 if linenumber < 1 {
 498                         continue
 499                 }
 500                 i := bytes.LastIndexByte(lines[linenumber-1], ' ')
 501                 if i < 0 || i >= len(line)-7 {
 502                         continue
 503                 }
 504                 addr := string(lines[linenumber-1][i+1:])
 505                 if net.ParseIP(addr).To4() != nil {
 506                         addrs[addr] = true
 507                 }
 508         }
 509         return addrs, nil
 510 }
 511
 512 var (
 513         errContainerNotStarted = errors.New("container has not started yet")
 514         errCannotFindChild     = errors.New("failed to find any process inside the container")
 515         reProcStatusPPid       = regexp.MustCompile(`\nPPid:\t(\d+)\n`)
 516 )
 517
 518 // Return the PID of a process that is inside the container (not
 519 // necessarily the topmost/pid=1 process in the container).
 520 func (e *singularityExecutor) containedProcess() (int, error) {
 521         if e.child == nil || e.child.Process == nil {
 522                 return 0, errContainerNotStarted
 523         }
 524         cmd := exec.Command("lsns")
 525         if e.sudo {
 526                 cmd = exec.Command("sudo", "lsns")
 527         }
 528         lsns, err := cmd.CombinedOutput()
 529         if err != nil {
 530                 return 0, fmt.Errorf("lsns: %w", err)
 531         }
 532         for _, line := range bytes.Split(lsns, []byte{'\n'}) {
 533                 fields := bytes.Fields(line)
 534                 if len(fields) < 4 {
 535                         continue
 536                 }
 537                 if !bytes.Equal(fields[1], []byte("pid")) {
 538                         continue
 539                 }
 540                 pid, err := strconv.ParseInt(string(fields[3]), 10, 64)
 541                 if err != nil {
 542                         return 0, fmt.Errorf("error parsing PID field in lsns output: %q", fields[3])
 543                 }
 544                 for parent := pid; ; {
 545                         procstatus, err := os.ReadFile(fmt.Sprintf("/proc/%d/status", parent))
 546                         if err != nil {
 547                                 break
 548                         }
 549                         m := reProcStatusPPid.FindSubmatch(procstatus)
 550                         if m == nil {
 551                                 break
 552                         }
 553                         parent, err = strconv.ParseInt(string(m[1]), 10, 64)
 554                         if err != nil {
 555                                 break
 556                         }
 557                         if int(parent) == e.child.Process.Pid {
 558                                 return int(pid), nil
 559                         }
 560                 }
 561         }
 562         return 0, errCannotFindChild
 563 }