services/crunch-dispatch-local/crunch-dispatch-local.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package main
   6
   7 // Dispatcher service for Crunch that runs containers locally.
   8
   9 import (
  10         "context"
  11         "flag"
  12         "fmt"
  13         "os"
  14         "os/exec"
  15         "os/signal"
  16         "sync"
  17         "syscall"
  18         "time"
  19
  20         "git.arvados.org/arvados.git/lib/config"
  21         "git.arvados.org/arvados.git/sdk/go/arvados"
  22         "git.arvados.org/arvados.git/sdk/go/arvadosclient"
  23         "git.arvados.org/arvados.git/sdk/go/dispatch"
  24         "github.com/sirupsen/logrus"
  25 )
  26
  27 var version = "dev"
  28
  29 func main() {
  30         err := doMain()
  31         if err != nil {
  32                 logrus.Fatalf("%q", err)
  33         }
  34 }
  35
  36 var (
  37         runningCmds      map[string]*exec.Cmd
  38         runningCmdsMutex sync.Mutex
  39         waitGroup        sync.WaitGroup
  40         crunchRunCommand *string
  41 )
  42
  43 func doMain() error {
  44         logger := logrus.StandardLogger()
  45         if os.Getenv("DEBUG") != "" {
  46                 logger.SetLevel(logrus.DebugLevel)
  47         }
  48         logger.Formatter = &logrus.JSONFormatter{
  49                 TimestampFormat: "2006-01-02T15:04:05.000000000Z07:00",
  50         }
  51
  52         flags := flag.NewFlagSet("crunch-dispatch-local", flag.ExitOnError)
  53
  54         pollInterval := flags.Int(
  55                 "poll-interval",
  56                 10,
  57                 "Interval in seconds to poll for queued containers")
  58
  59         crunchRunCommand = flags.String(
  60                 "crunch-run-command",
  61                 "/usr/bin/crunch-run",
  62                 "Crunch command to run container")
  63
  64         getVersion := flags.Bool(
  65                 "version",
  66                 false,
  67                 "Print version information and exit.")
  68
  69         // Parse args; omit the first arg which is the command name
  70         flags.Parse(os.Args[1:])
  71
  72         // Print version information if requested
  73         if *getVersion {
  74                 fmt.Printf("crunch-dispatch-local %s\n", version)
  75                 return nil
  76         }
  77
  78         loader := config.NewLoader(nil, logger)
  79         cfg, err := loader.Load()
  80         cluster, err := cfg.GetCluster("")
  81         if err != nil {
  82                 return fmt.Errorf("config error: %s", err)
  83         }
  84
  85         logger.Printf("crunch-dispatch-local %s started", version)
  86
  87         runningCmds = make(map[string]*exec.Cmd)
  88
  89         var client arvados.Client
  90         client.APIHost = cluster.Services.Controller.ExternalURL.Host
  91         client.AuthToken = cluster.SystemRootToken
  92         client.Insecure = cluster.TLS.Insecure
  93
  94         if client.APIHost != "" || client.AuthToken != "" {
  95                 // Copy real configs into env vars so [a]
  96                 // MakeArvadosClient() uses them, and [b] they get
  97                 // propagated to crunch-run via SLURM.
  98                 os.Setenv("ARVADOS_API_HOST", client.APIHost)
  99                 os.Setenv("ARVADOS_API_TOKEN", client.AuthToken)
 100                 os.Setenv("ARVADOS_API_HOST_INSECURE", "")
 101                 if client.Insecure {
 102                         os.Setenv("ARVADOS_API_HOST_INSECURE", "1")
 103                 }
 104                 os.Setenv("ARVADOS_EXTERNAL_CLIENT", "")
 105         } else {
 106                 logger.Warnf("Client credentials missing from config, so falling back on environment variables (deprecated).")
 107         }
 108
 109         arv, err := arvadosclient.MakeArvadosClient()
 110         if err != nil {
 111                 logger.Errorf("error making Arvados client: %v", err)
 112                 return err
 113         }
 114         arv.Retries = 25
 115
 116         ctx, cancel := context.WithCancel(context.Background())
 117
 118         dispatcher := dispatch.Dispatcher{
 119                 Logger:       logger,
 120                 Arv:          arv,
 121                 RunContainer: (&LocalRun{startFunc, make(chan bool, 8), ctx, cluster}).run,
 122                 PollPeriod:   time.Duration(*pollInterval) * time.Second,
 123         }
 124
 125         err = dispatcher.Run(ctx)
 126         if err != nil {
 127                 return err
 128         }
 129
 130         c := make(chan os.Signal, 1)
 131         signal.Notify(c, os.Interrupt, syscall.SIGTERM, syscall.SIGQUIT)
 132         sig := <-c
 133         logger.Printf("Received %s, shutting down", sig)
 134         signal.Stop(c)
 135
 136         cancel()
 137
 138         runningCmdsMutex.Lock()
 139         // Finished dispatching; interrupt any crunch jobs that are still running
 140         for _, cmd := range runningCmds {
 141                 cmd.Process.Signal(os.Interrupt)
 142         }
 143         runningCmdsMutex.Unlock()
 144
 145         // Wait for all running crunch jobs to complete / terminate
 146         waitGroup.Wait()
 147
 148         return nil
 149 }
 150
 151 func startFunc(container arvados.Container, cmd *exec.Cmd) error {
 152         return cmd.Start()
 153 }
 154
 155 type LocalRun struct {
 156         startCmd         func(container arvados.Container, cmd *exec.Cmd) error
 157         concurrencyLimit chan bool
 158         ctx              context.Context
 159         cluster          *arvados.Cluster
 160 }
 161
 162 // Run a container.
 163 //
 164 // If the container is Locked, start a new crunch-run process and wait until
 165 // crunch-run completes.  If the priority is set to zero, set an interrupt
 166 // signal to the crunch-run process.
 167 //
 168 // If the container is in any other state, or is not Complete/Cancelled after
 169 // crunch-run terminates, mark the container as Cancelled.
 170 func (lr *LocalRun) run(dispatcher *dispatch.Dispatcher,
 171         container arvados.Container,
 172         status <-chan arvados.Container) error {
 173
 174         uuid := container.UUID
 175
 176         if container.State == dispatch.Locked {
 177
 178                 select {
 179                 case lr.concurrencyLimit <- true:
 180                         break
 181                 case <-lr.ctx.Done():
 182                         return lr.ctx.Err()
 183                 }
 184
 185                 defer func() { <-lr.concurrencyLimit }()
 186
 187                 select {
 188                 case c := <-status:
 189                         // Check for state updates after possibly
 190                         // waiting to be ready-to-run
 191                         if c.Priority == 0 {
 192                                 goto Finish
 193                         }
 194                 default:
 195                         break
 196                 }
 197
 198                 waitGroup.Add(1)
 199                 defer waitGroup.Done()
 200
 201                 cmd := exec.Command(*crunchRunCommand, "--runtime-engine="+lr.cluster.Containers.RuntimeEngine, uuid)
 202                 cmd.Stdin = nil
 203                 cmd.Stderr = os.Stderr
 204                 cmd.Stdout = os.Stderr
 205
 206                 dispatcher.Logger.Printf("starting container %v", uuid)
 207
 208                 // Add this crunch job to the list of runningCmds only if we
 209                 // succeed in starting crunch-run.
 210
 211                 runningCmdsMutex.Lock()
 212                 if err := lr.startCmd(container, cmd); err != nil {
 213                         runningCmdsMutex.Unlock()
 214                         dispatcher.Logger.Warnf("error starting %q for %s: %s", *crunchRunCommand, uuid, err)
 215                         dispatcher.UpdateState(uuid, dispatch.Cancelled)
 216                 } else {
 217                         runningCmds[uuid] = cmd
 218                         runningCmdsMutex.Unlock()
 219
 220                         // Need to wait for crunch-run to exit
 221                         done := make(chan struct{})
 222
 223                         go func() {
 224                                 if _, err := cmd.Process.Wait(); err != nil {
 225                                         dispatcher.Logger.Warnf("error while waiting for crunch job to finish for %v: %q", uuid, err)
 226                                 }
 227                                 dispatcher.Logger.Debugf("sending done")
 228                                 done <- struct{}{}
 229                         }()
 230
 231                 Loop:
 232                         for {
 233                                 select {
 234                                 case <-done:
 235                                         break Loop
 236                                 case c := <-status:
 237                                         // Interrupt the child process if priority changes to 0
 238                                         if (c.State == dispatch.Locked || c.State == dispatch.Running) && c.Priority == 0 {
 239                                                 dispatcher.Logger.Printf("sending SIGINT to pid %d to cancel container %v", cmd.Process.Pid, uuid)
 240                                                 cmd.Process.Signal(os.Interrupt)
 241                                         }
 242                                 }
 243                         }
 244                         close(done)
 245
 246                         dispatcher.Logger.Printf("finished container run for %v", uuid)
 247
 248                         // Remove the crunch job from runningCmds
 249                         runningCmdsMutex.Lock()
 250                         delete(runningCmds, uuid)
 251                         runningCmdsMutex.Unlock()
 252                 }
 253         }
 254
 255 Finish:
 256
 257         // If the container is not finalized, then change it to "Cancelled".
 258         err := dispatcher.Arv.Get("containers", uuid, nil, &container)
 259         if err != nil {
 260                 dispatcher.Logger.Warnf("error getting final container state: %v", err)
 261         }
 262         if container.State == dispatch.Locked || container.State == dispatch.Running {
 263                 dispatcher.Logger.Warnf("after %q process termination, container state for %v is %q; updating it to %q",
 264                         *crunchRunCommand, uuid, container.State, dispatch.Cancelled)
 265                 dispatcher.UpdateState(uuid, dispatch.Cancelled)
 266         }
 267
 268         // drain any subsequent status changes
 269         for range status {
 270         }
 271
 272         dispatcher.Logger.Printf("finalized container %v", uuid)
 273         return nil
 274 }