lib/dispatchcloud/container/queue.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package container
   6
   7 import (
   8         "io"
   9         "sync"
  10         "time"
  11
  12         "git.curoverse.com/arvados.git/sdk/go/arvados"
  13         "github.com/prometheus/client_golang/prometheus"
  14         "github.com/sirupsen/logrus"
  15 )
  16
  17 type typeChooser func(*arvados.Container) (arvados.InstanceType, error)
  18
  19 // An APIClient performs Arvados API requests. It is typically an
  20 // *arvados.Client.
  21 type APIClient interface {
  22         RequestAndDecode(dst interface{}, method, path string, body io.Reader, params interface{}) error
  23 }
  24
  25 // A QueueEnt is an entry in the queue, consisting of a container
  26 // record and the instance type that should be used to run it.
  27 type QueueEnt struct {
  28         // The container to run. Only the UUID, State, Priority, and
  29         // RuntimeConstraints fields are populated.
  30         Container    arvados.Container    `json:"container"`
  31         InstanceType arvados.InstanceType `json:"instance_type"`
  32 }
  33
  34 // String implements fmt.Stringer by returning the queued container's
  35 // UUID.
  36 func (c *QueueEnt) String() string {
  37         return c.Container.UUID
  38 }
  39
  40 // A Queue is an interface to an Arvados cluster's container
  41 // database. It presents only the containers that are eligible to be
  42 // run by, are already being run by, or have recently been run by the
  43 // present dispatcher.
  44 //
  45 // The Entries, Get, and Forget methods do not block: they return
  46 // immediately, using cached data.
  47 //
  48 // The updating methods (Cancel, Lock, Unlock, Update) do block: they
  49 // return only after the operation has completed.
  50 //
  51 // A Queue's Update method should be called periodically to keep the
  52 // cache up to date.
  53 type Queue struct {
  54         logger     logrus.FieldLogger
  55         reg        *prometheus.Registry
  56         chooseType typeChooser
  57         client     APIClient
  58
  59         auth    *arvados.APIClientAuthorization
  60         current map[string]QueueEnt
  61         updated time.Time
  62         mtx     sync.Mutex
  63
  64         // Methods that modify the Queue (like Lock) add the affected
  65         // container UUIDs to dontupdate. When applying a batch of
  66         // updates received from the network, anything appearing in
  67         // dontupdate is skipped, in case the received update has
  68         // already been superseded by the locally initiated change.
  69         // When no network update is in progress, this protection is
  70         // not needed, and dontupdate is nil.
  71         dontupdate map[string]struct{}
  72
  73         // active notification subscribers (see Subscribe)
  74         subscribers map[<-chan struct{}]chan struct{}
  75 }
  76
  77 // NewQueue returns a new Queue. When a new container appears in the
  78 // Arvados cluster's queue during Update, chooseType will be called to
  79 // assign an appropriate arvados.InstanceType for the queue entry.
  80 func NewQueue(logger logrus.FieldLogger, reg *prometheus.Registry, chooseType typeChooser, client APIClient) *Queue {
  81         return &Queue{
  82                 logger:      logger,
  83                 reg:         reg,
  84                 chooseType:  chooseType,
  85                 client:      client,
  86                 current:     map[string]QueueEnt{},
  87                 subscribers: map[<-chan struct{}]chan struct{}{},
  88         }
  89 }
  90
  91 // Subscribe returns a channel that becomes ready to receive when an
  92 // entry in the Queue is updated.
  93 //
  94 //      ch := q.Subscribe()
  95 //      defer q.Unsubscribe(ch)
  96 //      for range ch {
  97 //              // ...
  98 //      }
  99 func (cq *Queue) Subscribe() <-chan struct{} {
 100         cq.mtx.Lock()
 101         defer cq.mtx.Unlock()
 102         ch := make(chan struct{}, 1)
 103         cq.subscribers[ch] = ch
 104         return ch
 105 }
 106
 107 // Unsubscribe stops sending updates to the given channel. See
 108 // Subscribe.
 109 func (cq *Queue) Unsubscribe(ch <-chan struct{}) {
 110         cq.mtx.Lock()
 111         defer cq.mtx.Unlock()
 112         delete(cq.subscribers, ch)
 113 }
 114
 115 // Caller must have lock.
 116 func (cq *Queue) notify() {
 117         for _, ch := range cq.subscribers {
 118                 select {
 119                 case ch <- struct{}{}:
 120                 default:
 121                 }
 122         }
 123 }
 124
 125 // Forget drops the specified container from the cache. It should be
 126 // called on finalized containers to avoid leaking memory over
 127 // time. It is a no-op if the indicated container is not in a
 128 // finalized state.
 129 func (cq *Queue) Forget(uuid string) {
 130         cq.mtx.Lock()
 131         defer cq.mtx.Unlock()
 132         ctr := cq.current[uuid].Container
 133         if ctr.State == arvados.ContainerStateComplete || ctr.State == arvados.ContainerStateCancelled {
 134                 delete(cq.current, uuid)
 135         }
 136 }
 137
 138 // Get returns the (partial) Container record for the specified
 139 // container. Like a map lookup, its second return value is false if
 140 // the specified container is not in the Queue.
 141 func (cq *Queue) Get(uuid string) (arvados.Container, bool) {
 142         cq.mtx.Lock()
 143         defer cq.mtx.Unlock()
 144         if ctr, ok := cq.current[uuid]; !ok {
 145                 return arvados.Container{}, false
 146         } else {
 147                 return ctr.Container, true
 148         }
 149 }
 150
 151 // Entries returns all cache entries, keyed by container UUID.
 152 //
 153 // The returned threshold indicates the maximum age of any cached data
 154 // returned in the map. This makes it possible for a scheduler to
 155 // determine correctly the outcome of a remote process that updates
 156 // container state. It must first wait for the remote process to exit,
 157 // then wait for the Queue to start and finish its next Update --
 158 // i.e., it must wait until threshold > timeProcessExited.
 159 func (cq *Queue) Entries() (entries map[string]QueueEnt, threshold time.Time) {
 160         cq.mtx.Lock()
 161         defer cq.mtx.Unlock()
 162         entries = make(map[string]QueueEnt, len(cq.current))
 163         for uuid, ctr := range cq.current {
 164                 entries[uuid] = ctr
 165         }
 166         threshold = cq.updated
 167         return
 168 }
 169
 170 // Update refreshes the cache from the Arvados API. It adds newly
 171 // queued containers, and updates the state of previously queued
 172 // containers.
 173 func (cq *Queue) Update() error {
 174         cq.mtx.Lock()
 175         cq.dontupdate = map[string]struct{}{}
 176         updateStarted := time.Now()
 177         cq.mtx.Unlock()
 178
 179         next, err := cq.poll()
 180         if err != nil {
 181                 return err
 182         }
 183
 184         cq.mtx.Lock()
 185         defer cq.mtx.Unlock()
 186         for uuid, ctr := range next {
 187                 if _, keep := cq.dontupdate[uuid]; keep {
 188                         continue
 189                 }
 190                 if cur, ok := cq.current[uuid]; !ok {
 191                         cq.addEnt(uuid, *ctr)
 192                 } else {
 193                         cur.Container = *ctr
 194                         cq.current[uuid] = cur
 195                 }
 196         }
 197         for uuid := range cq.current {
 198                 if _, keep := cq.dontupdate[uuid]; keep {
 199                         continue
 200                 } else if _, keep = next[uuid]; keep {
 201                         continue
 202                 } else {
 203                         delete(cq.current, uuid)
 204                 }
 205         }
 206         cq.dontupdate = nil
 207         cq.updated = updateStarted
 208         cq.notify()
 209         return nil
 210 }
 211
 212 func (cq *Queue) addEnt(uuid string, ctr arvados.Container) {
 213         it, err := cq.chooseType(&ctr)
 214         if err != nil && (ctr.State == arvados.ContainerStateQueued || ctr.State == arvados.ContainerStateLocked) {
 215                 errorString := err.Error()
 216                 cq.logger.WithField("ContainerUUID", ctr.UUID).Warn("cancel container with no suitable instance type")
 217                 go func() {
 218                         var err error
 219                         defer func() {
 220                                 if err == nil {
 221                                         return
 222                                 }
 223                                 // On failure, check current container
 224                                 // state, and don't log the error if
 225                                 // the failure came from losing a
 226                                 // race.
 227                                 var latest arvados.Container
 228                                 cq.client.RequestAndDecode(&latest, "GET", "arvados/v1/containers/"+ctr.UUID, nil, map[string][]string{"select": {"state"}})
 229                                 if latest.State == arvados.ContainerStateCancelled {
 230                                         return
 231                                 }
 232                                 cq.logger.WithField("ContainerUUID", ctr.UUID).WithError(err).Warn("error while trying to cancel unsatisfiable container")
 233                         }()
 234                         if ctr.State == arvados.ContainerStateQueued {
 235                                 err = cq.Lock(ctr.UUID)
 236                                 if err != nil {
 237                                         return
 238                                 }
 239                         }
 240                         err = cq.setRuntimeError(ctr.UUID, errorString)
 241                         if err != nil {
 242                                 return
 243                         }
 244                         err = cq.Cancel(ctr.UUID)
 245                         if err != nil {
 246                                 return
 247                         }
 248                 }()
 249                 return
 250         }
 251         cq.current[uuid] = QueueEnt{Container: ctr, InstanceType: it}
 252 }
 253
 254 // Lock acquires the dispatch lock for the given container.
 255 func (cq *Queue) Lock(uuid string) error {
 256         return cq.apiUpdate(uuid, "lock")
 257 }
 258
 259 // Unlock releases the dispatch lock for the given container.
 260 func (cq *Queue) Unlock(uuid string) error {
 261         return cq.apiUpdate(uuid, "unlock")
 262 }
 263
 264 // setRuntimeError sets runtime_status["error"] to the given value.
 265 // Container should already have state==Locked or Running.
 266 func (cq *Queue) setRuntimeError(uuid, errorString string) error {
 267         return cq.client.RequestAndDecode(nil, "PUT", "arvados/v1/containers/"+uuid, nil, map[string]map[string]map[string]interface{}{
 268                 "container": {
 269                         "runtime_status": {
 270                                 "error": errorString,
 271                         },
 272                 },
 273         })
 274 }
 275
 276 // Cancel cancels the given container.
 277 func (cq *Queue) Cancel(uuid string) error {
 278         err := cq.client.RequestAndDecode(nil, "PUT", "arvados/v1/containers/"+uuid, nil, map[string]map[string]interface{}{
 279                 "container": {"state": arvados.ContainerStateCancelled},
 280         })
 281         if err != nil {
 282                 return err
 283         }
 284         cq.mtx.Lock()
 285         defer cq.mtx.Unlock()
 286         cq.notify()
 287         return nil
 288 }
 289
 290 func (cq *Queue) apiUpdate(uuid, action string) error {
 291         var resp arvados.Container
 292         err := cq.client.RequestAndDecode(&resp, "POST", "arvados/v1/containers/"+uuid+"/"+action, nil, nil)
 293         if err != nil {
 294                 return err
 295         }
 296
 297         cq.mtx.Lock()
 298         defer cq.mtx.Unlock()
 299         if cq.dontupdate != nil {
 300                 cq.dontupdate[uuid] = struct{}{}
 301         }
 302         if ent, ok := cq.current[uuid]; !ok {
 303                 cq.addEnt(uuid, resp)
 304         } else {
 305                 ent.Container.State, ent.Container.Priority, ent.Container.LockedByUUID = resp.State, resp.Priority, resp.LockedByUUID
 306                 cq.current[uuid] = ent
 307         }
 308         cq.notify()
 309         return nil
 310 }
 311
 312 func (cq *Queue) poll() (map[string]*arvados.Container, error) {
 313         cq.mtx.Lock()
 314         size := len(cq.current)
 315         auth := cq.auth
 316         cq.mtx.Unlock()
 317
 318         if auth == nil {
 319                 auth = &arvados.APIClientAuthorization{}
 320                 err := cq.client.RequestAndDecode(auth, "GET", "arvados/v1/api_client_authorizations/current", nil, nil)
 321                 if err != nil {
 322                         return nil, err
 323                 }
 324                 cq.mtx.Lock()
 325                 cq.auth = auth
 326                 cq.mtx.Unlock()
 327         }
 328
 329         next := make(map[string]*arvados.Container, size)
 330         apply := func(updates []arvados.Container) {
 331                 for _, upd := range updates {
 332                         if next[upd.UUID] == nil {
 333                                 next[upd.UUID] = &arvados.Container{}
 334                         }
 335                         *next[upd.UUID] = upd
 336                 }
 337         }
 338         selectParam := []string{"uuid", "state", "priority", "runtime_constraints"}
 339         limitParam := 1000
 340
 341         mine, err := cq.fetchAll(arvados.ResourceListParams{
 342                 Select:  selectParam,
 343                 Order:   "uuid",
 344                 Limit:   &limitParam,
 345                 Count:   "none",
 346                 Filters: []arvados.Filter{{"locked_by_uuid", "=", auth.UUID}},
 347         })
 348         if err != nil {
 349                 return nil, err
 350         }
 351         apply(mine)
 352
 353         avail, err := cq.fetchAll(arvados.ResourceListParams{
 354                 Select:  selectParam,
 355                 Order:   "uuid",
 356                 Limit:   &limitParam,
 357                 Count:   "none",
 358                 Filters: []arvados.Filter{{"state", "=", arvados.ContainerStateQueued}, {"priority", ">", "0"}},
 359         })
 360         if err != nil {
 361                 return nil, err
 362         }
 363         apply(avail)
 364
 365         var missing []string
 366         cq.mtx.Lock()
 367         for uuid, ent := range cq.current {
 368                 if next[uuid] == nil &&
 369                         ent.Container.State != arvados.ContainerStateCancelled &&
 370                         ent.Container.State != arvados.ContainerStateComplete {
 371                         missing = append(missing, uuid)
 372                 }
 373         }
 374         cq.mtx.Unlock()
 375
 376         for i, page := 0, 20; i < len(missing); i += page {
 377                 batch := missing[i:]
 378                 if len(batch) > page {
 379                         batch = batch[:page]
 380                 }
 381                 ended, err := cq.fetchAll(arvados.ResourceListParams{
 382                         Select:  selectParam,
 383                         Order:   "uuid",
 384                         Count:   "none",
 385                         Filters: []arvados.Filter{{"uuid", "in", batch}},
 386                 })
 387                 if err != nil {
 388                         return nil, err
 389                 }
 390                 apply(ended)
 391         }
 392         return next, nil
 393 }
 394
 395 func (cq *Queue) fetchAll(initialParams arvados.ResourceListParams) ([]arvados.Container, error) {
 396         var results []arvados.Container
 397         params := initialParams
 398         params.Offset = 0
 399         for {
 400                 // This list variable must be a new one declared
 401                 // inside the loop: otherwise, items in the API
 402                 // response would get deep-merged into the items
 403                 // loaded in previous iterations.
 404                 var list arvados.ContainerList
 405
 406                 err := cq.client.RequestAndDecode(&list, "GET", "arvados/v1/containers", nil, params)
 407                 if err != nil {
 408                         return nil, err
 409                 }
 410                 if len(list.Items) == 0 {
 411                         break
 412                 }
 413
 414                 results = append(results, list.Items...)
 415                 if len(params.Order) == 1 && params.Order == "uuid" {
 416                         params.Filters = append(initialParams.Filters, arvados.Filter{"uuid", ">", list.Items[len(list.Items)-1].UUID})
 417                 } else {
 418                         params.Offset += len(list.Items)
 419                 }
 420         }
 421         return results, nil
 422 }