8128: Add runtime tokens for containers, and locks for multiple dispatchers
[arvados.git] / services / crunch-dispatch-local / crunch-dispatch-local.go
index 9fb4cb9bad7e4cf9e1e6675ef65596880450ef96..848d723380da29d9a9e3337aa654e097fde782e1 100644 (file)
@@ -6,6 +6,9 @@ import (
        "log"
        "os"
        "os/exec"
+       "os/signal"
+       "sync"
+       "syscall"
        "time"
 )
 
@@ -16,7 +19,14 @@ func main() {
        }
 }
 
-var arv arvadosclient.ArvadosClient
+var (
+       arv              arvadosclient.ArvadosClient
+       runningCmds      map[string]*exec.Cmd
+       runningCmdsMutex sync.Mutex
+       waitGroup        sync.WaitGroup
+       doneProcessing   chan bool
+       sigChan          chan os.Signal
+)
 
 func doMain() error {
        flags := flag.NewFlagSet("crunch-dispatch-local", flag.ExitOnError)
@@ -45,24 +55,44 @@ func doMain() error {
                return err
        }
 
-       // channel to terminate
+       // Channel to terminate
        doneProcessing = make(chan bool)
 
-       // run all queued containers
-       runQueuedContainers(*pollInterval, *priorityPollInterval, *crunchRunCommand)
+       // Map of running crunch jobs
+       runningCmds = make(map[string]*exec.Cmd)
+
+       // Graceful shutdown
+       sigChan = make(chan os.Signal, 1)
+       signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM, syscall.SIGQUIT)
+       go func(sig <-chan os.Signal) {
+               for sig := range sig {
+                       log.Printf("Caught signal: %v", sig)
+                       doneProcessing <- true
+               }
+       }(sigChan)
+
+       // Run all queued containers
+       runQueuedContainers(time.Duration(*pollInterval)*time.Second, time.Duration(*priorityPollInterval)*time.Second, *crunchRunCommand)
+
+       // Finished dispatching; interrupt any crunch jobs that are still running
+       for _, cmd := range runningCmds {
+               cmd.Process.Signal(os.Interrupt)
+       }
+
+       // Wait for all running crunch jobs to complete / terminate
+       waitGroup.Wait()
+
        return nil
 }
 
-var doneProcessing chan bool
-
 // Poll for queued containers using pollInterval.
 // Invoke dispatchLocal for each ticker cycle, which will run all the queued containers.
 //
 // Any errors encountered are logged but the program would continue to run (not exit).
-// This is because, once one or more child processes are running,
+// This is because, once one or more crunch jobs are running,
 // we would need to wait for them complete.
-func runQueuedContainers(pollInterval, priorityPollInterval int, crunchRunCommand string) {
-       ticker := time.NewTicker(time.Duration(pollInterval) * time.Second)
+func runQueuedContainers(pollInterval, priorityPollInterval time.Duration, crunchRunCommand string) {
+       ticker := time.NewTicker(pollInterval)
 
        for {
                select {
@@ -77,19 +107,19 @@ func runQueuedContainers(pollInterval, priorityPollInterval int, crunchRunComman
 
 // Container data
 type Container struct {
-       UUID     string `json:"uuid"`
-       State    string `json:"state"`
-       Priority int    `json:"priority"`
+       UUID         string `json:"uuid"`
+       State        string `json:"state"`
+       Priority     int    `json:"priority"`
+       LockedByUUID string `json:"locked_by_uuid"`
 }
 
 // ContainerList is a list of the containers from api
 type ContainerList struct {
-       ItemsAvailable int         `json:"items_available"`
-       Items          []Container `json:"items"`
+       Items []Container `json:"items"`
 }
 
 // Get the list of queued containers from API server and invoke run for each container.
-func dispatchLocal(priorityPollInterval int, crunchRunCommand string) {
+func dispatchLocal(pollInterval time.Duration, crunchRunCommand string) {
        params := arvadosclient.Dict{
                "filters": [][]string{[]string{"state", "=", "Queued"}},
        }
@@ -101,76 +131,120 @@ func dispatchLocal(priorityPollInterval int, crunchRunCommand string) {
                return
        }
 
-       for i := 0; i < containers.ItemsAvailable; i++ {
+       for i := 0; i < len(containers.Items); i++ {
                log.Printf("About to run queued container %v", containers.Items[i].UUID)
-               go run(containers.Items[i].UUID, crunchRunCommand, priorityPollInterval)
+               // Run the container
+               go run(containers.Items[i].UUID, crunchRunCommand, pollInterval)
        }
 }
 
+func updateState(uuid, newState string) error {
+       err := arv.Update("containers", uuid,
+               arvadosclient.Dict{
+                       "container": arvadosclient.Dict{"state": newState}},
+               nil)
+       if err != nil {
+               log.Printf("Error updating container %s to '%s' state: %q", uuid, newState, err)
+       }
+       return err
+}
+
 // Run queued container:
-// Set container state to locked (TBD)
+// Set container state to Locked
 // Run container using the given crunch-run command
 // Set the container state to Running
 // If the container priority becomes zero while crunch job is still running, terminate it.
-func run(uuid string, crunchRunCommand string, priorityPollInterval int) {
-       cmd := exec.Command(crunchRunCommand, "--job", uuid)
+func run(uuid string, crunchRunCommand string, pollInterval time.Duration) {
+       if err := updateState(uuid, "Locked"); err != nil {
+               return
+       }
 
+       cmd := exec.Command(crunchRunCommand, uuid)
        cmd.Stdin = nil
        cmd.Stderr = os.Stderr
        cmd.Stdout = os.Stderr
+
+       // Add this crunch job to the list of runningCmds only if we
+       // succeed in starting crunch-run.
+       runningCmdsMutex.Lock()
        if err := cmd.Start(); err != nil {
-               log.Printf("Error running container for %v: %q", uuid, err)
+               log.Printf("Error starting crunch-run for %v: %q", uuid, err)
+               runningCmdsMutex.Unlock()
+               updateState(uuid, "Queued")
                return
        }
+       runningCmds[uuid] = cmd
+       runningCmdsMutex.Unlock()
 
-       log.Printf("Started container run for %v", uuid)
+       defer func() {
+               setFinalState(uuid)
 
-       err := arv.Update("containers", uuid,
-               arvadosclient.Dict{
-                       "container": arvadosclient.Dict{"state": "Running"}},
-               nil)
-       if err != nil {
-               log.Printf("Error updating container state to 'Running' for %v: %q", uuid, err)
-       }
+               // Remove the crunch job from runningCmds
+               runningCmdsMutex.Lock()
+               delete(runningCmds, uuid)
+               runningCmdsMutex.Unlock()
+       }()
+
+       log.Printf("Starting container %v", uuid)
+
+       // Add this crunch job to waitGroup
+       waitGroup.Add(1)
+       defer waitGroup.Done()
 
-       // Terminate the runner if container priority becomes zero
-       priorityTicker := time.NewTicker(time.Duration(priorityPollInterval) * time.Second)
+       updateState(uuid, "Running")
+
+       cmdExited := make(chan struct{})
+
+       // Kill the child process if container priority changes to zero
        go func() {
+               ticker := time.NewTicker(pollInterval)
+               defer ticker.Stop()
                for {
                        select {
-                       case <-priorityTicker.C:
-                               var container Container
-                               err := arv.Get("containers", uuid, nil, &container)
-                               if err != nil {
-                                       log.Printf("Error getting container info for %v: %q", uuid, err)
-                               } else {
-                                       if container.Priority == 0 {
-                                               priorityTicker.Stop()
-                                               cmd.Process.Kill()
-                                               return
-                                       }
-                               }
+                       case <-cmdExited:
+                               return
+                       case <-ticker.C:
+                       }
+                       var container Container
+                       err := arv.Get("containers", uuid, nil, &container)
+                       if err != nil {
+                               log.Printf("Error getting container %v: %q", uuid, err)
+                               continue
+                       }
+                       if container.Priority == 0 {
+                               log.Printf("Sending SIGINT to pid %d to cancel container %v", cmd.Process.Pid, uuid)
+                               cmd.Process.Signal(os.Interrupt)
                        }
                }
        }()
 
-       // Wait for the process to exit
+       // Wait for crunch-run to exit
        if _, err := cmd.Process.Wait(); err != nil {
-               log.Printf("Error while waiting for process to finish for %v: %q", uuid, err)
+               log.Printf("Error while waiting for crunch job to finish for %v: %q", uuid, err)
        }
+       close(cmdExited)
 
-       priorityTicker.Stop()
+       log.Printf("Finished container run for %v", uuid)
+}
 
+func setFinalState(uuid string) {
+       // The container state should now be 'Complete' if everything
+       // went well. If it started but crunch-run didn't change its
+       // final state to 'Running', fix that now. If it never even
+       // started, cancel it as unrunnable. (TODO: Requeue instead,
+       // and fix tests so they can tell something happened even if
+       // the final state is Queued.)
        var container Container
-       err = arv.Get("containers", uuid, nil, &container)
-       if container.State == "Running" {
-               log.Printf("After crunch-run process termination, the state is still 'Running' for %v. Updating it to 'Complete'", uuid)
-               err = arv.Update("containers", uuid,
-                       arvadosclient.Dict{
-                               "container": arvadosclient.Dict{"state": "Complete"}},
-                       &container)
-               if err != nil {
-                       log.Printf("Error updating container state to Complete for %v: %q", uuid, err)
-               }
+       err := arv.Get("containers", uuid, nil, &container)
+       if err != nil {
+               log.Printf("Error getting final container state: %v", err)
+       }
+       fixState := map[string]string{
+               "Running": "Complete",
+               "Locked": "Cancelled",
+       }
+       if newState, ok := fixState[container.State]; ok {
+               log.Printf("After crunch-run process termination, the state is still '%s' for %v. Updating it to '%s'", container.State, uuid, newState)
+               updateState(uuid, newState)
        }
 }