services/api/app/models/container.rb

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: AGPL-3.0
   4
   5 require 'log_reuse_info'
   6 require 'whitelist_update'
   7 require 'safe_json'
   8
   9 class Container < ArvadosModel
  10   include HasUuid
  11   include KindAndEtag
  12   include CommonApiTemplate
  13   include WhitelistUpdate
  14   extend CurrentApiClient
  15   extend DbCurrentTime
  16   extend LogReuseInfo
  17
  18   serialize :environment, Hash
  19   serialize :mounts, Hash
  20   serialize :runtime_constraints, Hash
  21   serialize :command, Array
  22   serialize :scheduling_parameters, Hash
  23   serialize :secret_mounts, Hash
  24
  25   before_validation :fill_field_defaults, :if => :new_record?
  26   before_validation :set_timestamps
  27   validates :command, :container_image, :output_path, :cwd, :priority, { presence: true }
  28   validates :priority, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
  29   validate :validate_state_change
  30   validate :validate_change
  31   validate :validate_lock
  32   validate :validate_output
  33   after_validation :assign_auth
  34   before_save :sort_serialized_attrs
  35   before_save :update_secret_mounts_md5
  36   before_save :scrub_secret_mounts
  37   after_save :handle_completed
  38   after_save :propagate_priority
  39
  40   has_many :container_requests, :foreign_key => :container_uuid, :class_name => 'ContainerRequest', :primary_key => :uuid
  41   belongs_to :auth, :class_name => 'ApiClientAuthorization', :foreign_key => :auth_uuid, :primary_key => :uuid
  42
  43   api_accessible :user, extend: :common do |t|
  44     t.add :command
  45     t.add :container_image
  46     t.add :cwd
  47     t.add :environment
  48     t.add :exit_code
  49     t.add :finished_at
  50     t.add :locked_by_uuid
  51     t.add :log
  52     t.add :mounts
  53     t.add :output
  54     t.add :output_path
  55     t.add :priority
  56     t.add :progress
  57     t.add :runtime_constraints
  58     t.add :started_at
  59     t.add :state
  60     t.add :auth_uuid
  61     t.add :scheduling_parameters
  62   end
  63
  64   # Supported states for a container
  65   States =
  66     [
  67      (Queued = 'Queued'),
  68      (Locked = 'Locked'),
  69      (Running = 'Running'),
  70      (Complete = 'Complete'),
  71      (Cancelled = 'Cancelled')
  72     ]
  73
  74   State_transitions = {
  75     nil => [Queued],
  76     Queued => [Locked, Cancelled],
  77     Locked => [Queued, Running, Cancelled],
  78     Running => [Complete, Cancelled]
  79   }
  80
  81   def self.limit_index_columns_read
  82     ["mounts"]
  83   end
  84
  85   def self.full_text_searchable_columns
  86     super - ["secret_mounts", "secret_mounts_md5"]
  87   end
  88
  89   def self.searchable_columns *args
  90     super - ["secret_mounts_md5"]
  91   end
  92
  93   def logged_attributes
  94     super.except('secret_mounts')
  95   end
  96
  97   def state_transitions
  98     State_transitions
  99   end
 100
 101   # Container priority is the highest "computed priority" of any
 102   # matching request. The computed priority of a container-submitted
 103   # request is the priority of the submitting container. The computed
 104   # priority of a user-submitted request is a function of
 105   # user-assigned priority and request creation time.
 106   def update_priority!
 107     return if ![Queued, Locked, Running].include?(state)
 108     p = ContainerRequest.
 109         where('container_uuid=? and priority>0', uuid).
 110         includes(:requesting_container).
 111         lock(true).
 112         map do |cr|
 113       if cr.requesting_container
 114         cr.requesting_container.priority
 115       else
 116         (cr.priority << 50) - (cr.created_at.to_time.to_f * 1000).to_i
 117       end
 118     end.max || 0
 119     update_attributes!(priority: p)
 120   end
 121
 122   def propagate_priority
 123     return true unless priority_changed?
 124     act_as_system_user do
 125       # Update the priority of child container requests to match new
 126       # priority of the parent container (ignoring requests with no
 127       # container assigned, because their priority doesn't matter).
 128       ContainerRequest.
 129         where(requesting_container_uuid: self.uuid,
 130               state: ContainerRequest::Committed).
 131         where('container_uuid is not null').
 132         includes(:container).
 133         map(&:container).
 134         map(&:update_priority!)
 135     end
 136   end
 137
 138   # Create a new container (or find an existing one) to satisfy the
 139   # given container request.
 140   def self.resolve(req)
 141     c_attrs = {
 142       command: req.command,
 143       cwd: req.cwd,
 144       environment: req.environment,
 145       output_path: req.output_path,
 146       container_image: resolve_container_image(req.container_image),
 147       mounts: resolve_mounts(req.mounts),
 148       runtime_constraints: resolve_runtime_constraints(req.runtime_constraints),
 149       scheduling_parameters: req.scheduling_parameters,
 150       secret_mounts: req.secret_mounts,
 151     }
 152     act_as_system_user do
 153       if req.use_existing && (reusable = find_reusable(c_attrs))
 154         reusable
 155       else
 156         Container.create!(c_attrs)
 157       end
 158     end
 159   end
 160
 161   # Return a runtime_constraints hash that complies with requested but
 162   # is suitable for saving in a container record, i.e., has specific
 163   # values instead of ranges.
 164   #
 165   # Doing this as a step separate from other resolutions, like "git
 166   # revision range to commit hash", makes sense only when there is no
 167   # opportunity to reuse an existing container (e.g., container reuse
 168   # is not implemented yet, or we have already found that no existing
 169   # containers are suitable).
 170   def self.resolve_runtime_constraints(runtime_constraints)
 171     rc = {}
 172     defaults = {
 173       'keep_cache_ram' =>
 174       Rails.configuration.container_default_keep_cache_ram,
 175     }
 176     defaults.merge(runtime_constraints).each do |k, v|
 177       if v.is_a? Array
 178         rc[k] = v[0]
 179       else
 180         rc[k] = v
 181       end
 182     end
 183     rc
 184   end
 185
 186   # Return a mounts hash suitable for a Container, i.e., with every
 187   # readonly collection UUID resolved to a PDH.
 188   def self.resolve_mounts(mounts)
 189     c_mounts = {}
 190     mounts.each do |k, mount|
 191       mount = mount.dup
 192       c_mounts[k] = mount
 193       if mount['kind'] != 'collection'
 194         next
 195       end
 196       if (uuid = mount.delete 'uuid')
 197         c = Collection.
 198           readable_by(current_user).
 199           where(uuid: uuid).
 200           select(:portable_data_hash).
 201           first
 202         if !c
 203           raise ArvadosModel::UnresolvableContainerError.new "cannot mount collection #{uuid.inspect}: not found"
 204         end
 205         if mount['portable_data_hash'].nil?
 206           # PDH not supplied by client
 207           mount['portable_data_hash'] = c.portable_data_hash
 208         elsif mount['portable_data_hash'] != c.portable_data_hash
 209           # UUID and PDH supplied by client, but they don't agree
 210           raise ArgumentError.new "cannot mount collection #{uuid.inspect}: current portable_data_hash #{c.portable_data_hash.inspect} does not match #{c['portable_data_hash'].inspect} in request"
 211         end
 212       end
 213     end
 214     return c_mounts
 215   end
 216
 217   # Return a container_image PDH suitable for a Container.
 218   def self.resolve_container_image(container_image)
 219     coll = Collection.for_latest_docker_image(container_image)
 220     if !coll
 221       raise ArvadosModel::UnresolvableContainerError.new "docker image #{container_image.inspect} not found"
 222     end
 223     coll.portable_data_hash
 224   end
 225
 226   def self.find_reusable(attrs)
 227     log_reuse_info { "starting with #{Container.all.count} container records in database" }
 228     candidates = Container.where_serialized(:command, attrs[:command])
 229     log_reuse_info(candidates) { "after filtering on command #{attrs[:command].inspect}" }
 230
 231     candidates = candidates.where('cwd = ?', attrs[:cwd])
 232     log_reuse_info(candidates) { "after filtering on cwd #{attrs[:cwd].inspect}" }
 233
 234     candidates = candidates.where_serialized(:environment, attrs[:environment])
 235     log_reuse_info(candidates) { "after filtering on environment #{attrs[:environment].inspect}" }
 236
 237     candidates = candidates.where('output_path = ?', attrs[:output_path])
 238     log_reuse_info(candidates) { "after filtering on output_path #{attrs[:output_path].inspect}" }
 239
 240     image = resolve_container_image(attrs[:container_image])
 241     candidates = candidates.where('container_image = ?', image)
 242     log_reuse_info(candidates) { "after filtering on container_image #{image.inspect} (resolved from #{attrs[:container_image].inspect})" }
 243
 244     candidates = candidates.where_serialized(:mounts, resolve_mounts(attrs[:mounts]))
 245     log_reuse_info(candidates) { "after filtering on mounts #{attrs[:mounts].inspect}" }
 246
 247     candidates = candidates.where('secret_mounts_md5 = ?', Digest::MD5.hexdigest(SafeJSON.dump(self.deep_sort_hash(attrs[:secret_mounts]))))
 248     log_reuse_info(candidates) { "after filtering on mounts #{attrs[:mounts].inspect}" }
 249
 250     candidates = candidates.where_serialized(:runtime_constraints, resolve_runtime_constraints(attrs[:runtime_constraints]))
 251     log_reuse_info(candidates) { "after filtering on runtime_constraints #{attrs[:runtime_constraints].inspect}" }
 252
 253     log_reuse_info { "checking for state=Complete with readable output and log..." }
 254
 255     select_readable_pdh = Collection.
 256       readable_by(current_user).
 257       select(:portable_data_hash).
 258       to_sql
 259
 260     usable = candidates.where(state: Complete, exit_code: 0)
 261     log_reuse_info(usable) { "with state=Complete, exit_code=0" }
 262
 263     usable = usable.where("log IN (#{select_readable_pdh})")
 264     log_reuse_info(usable) { "with readable log" }
 265
 266     usable = usable.where("output IN (#{select_readable_pdh})")
 267     log_reuse_info(usable) { "with readable output" }
 268
 269     usable = usable.order('finished_at ASC').limit(1).first
 270     if usable
 271       log_reuse_info { "done, reusing container #{usable.uuid} with state=Complete" }
 272       return usable
 273     end
 274
 275     # Check for Running candidates and return the most likely to finish sooner.
 276     log_reuse_info { "checking for state=Running..." }
 277     running = candidates.where(state: Running).
 278               order('progress desc, started_at asc').
 279               limit(1).first
 280     if running
 281       log_reuse_info { "done, reusing container #{running.uuid} with state=Running" }
 282       return running
 283     else
 284       log_reuse_info { "have no containers in Running state" }
 285     end
 286
 287     # Check for Locked or Queued ones and return the most likely to start first.
 288     locked_or_queued = candidates.
 289                        where("state IN (?)", [Locked, Queued]).
 290                        order('state asc, priority desc, created_at asc').
 291                        limit(1).first
 292     if locked_or_queued
 293       log_reuse_info { "done, reusing container #{locked_or_queued.uuid} with state=#{locked_or_queued.state}" }
 294       return locked_or_queued
 295     else
 296       log_reuse_info { "have no containers in Locked or Queued state" }
 297     end
 298
 299     log_reuse_info { "done, no reusable container found" }
 300     nil
 301   end
 302
 303   def check_lock_fail
 304     if self.state != Queued
 305       raise LockFailedError.new("cannot lock when #{self.state}")
 306     elsif self.priority <= 0
 307       raise LockFailedError.new("cannot lock when priority<=0")
 308     end
 309   end
 310
 311   def lock
 312     # Check invalid state transitions once before getting the lock
 313     # (because it's cheaper that way) and once after getting the lock
 314     # (because state might have changed while acquiring the lock).
 315     check_lock_fail
 316     transaction do
 317       begin
 318         reload(lock: 'FOR UPDATE NOWAIT')
 319       rescue
 320         raise LockFailedError.new("cannot lock: other transaction in progress")
 321       end
 322       check_lock_fail
 323       update_attributes!(state: Locked)
 324     end
 325   end
 326
 327   def check_unlock_fail
 328     if self.state != Locked
 329       raise InvalidStateTransitionError.new("cannot unlock when #{self.state}")
 330     elsif self.locked_by_uuid != current_api_client_authorization.uuid
 331       raise InvalidStateTransitionError.new("locked by a different token")
 332     end
 333   end
 334
 335   def unlock
 336     # Check invalid state transitions twice (see lock)
 337     check_unlock_fail
 338     transaction do
 339       reload(lock: 'FOR UPDATE')
 340       check_unlock_fail
 341       update_attributes!(state: Queued)
 342     end
 343   end
 344
 345   def self.readable_by(*users_list)
 346     # Load optional keyword arguments, if they exist.
 347     if users_list.last.is_a? Hash
 348       kwargs = users_list.pop
 349     else
 350       kwargs = {}
 351     end
 352     Container.where(ContainerRequest.readable_by(*users_list).where("containers.uuid = container_requests.container_uuid").exists)
 353   end
 354
 355   def final?
 356     [Complete, Cancelled].include?(self.state)
 357   end
 358
 359   protected
 360
 361   def fill_field_defaults
 362     self.state ||= Queued
 363     self.environment ||= {}
 364     self.runtime_constraints ||= {}
 365     self.mounts ||= {}
 366     self.cwd ||= "."
 367     self.priority ||= 0
 368     self.scheduling_parameters ||= {}
 369   end
 370
 371   def permission_to_create
 372     current_user.andand.is_admin
 373   end
 374
 375   def permission_to_update
 376     # Override base permission check to allow auth_uuid to set progress and
 377     # output (only).  Whether it is legal to set progress and output in the current
 378     # state has already been checked in validate_change.
 379     current_user.andand.is_admin ||
 380       (!current_api_client_authorization.nil? and
 381        [self.auth_uuid, self.locked_by_uuid].include? current_api_client_authorization.uuid)
 382   end
 383
 384   def ensure_owner_uuid_is_permitted
 385     # Override base permission check to allow auth_uuid to set progress and
 386     # output (only).  Whether it is legal to set progress and output in the current
 387     # state has already been checked in validate_change.
 388     if !current_api_client_authorization.nil? and self.auth_uuid == current_api_client_authorization.uuid
 389       check_update_whitelist [:progress, :output]
 390     else
 391       super
 392     end
 393   end
 394
 395   def set_timestamps
 396     if self.state_changed? and self.state == Running
 397       self.started_at ||= db_current_time
 398     end
 399
 400     if self.state_changed? and [Complete, Cancelled].include? self.state
 401       self.finished_at ||= db_current_time
 402     end
 403   end
 404
 405   def validate_change
 406     permitted = [:state]
 407
 408     if self.new_record?
 409       permitted.push(:owner_uuid, :command, :container_image, :cwd,
 410                      :environment, :mounts, :output_path, :priority,
 411                      :runtime_constraints, :scheduling_parameters,
 412                      :secret_mounts)
 413     end
 414
 415     case self.state
 416     when Queued, Locked
 417       permitted.push :priority
 418
 419     when Running
 420       permitted.push :priority, :progress, :output
 421       if self.state_changed?
 422         permitted.push :started_at
 423       end
 424
 425     when Complete
 426       if self.state_was == Running
 427         permitted.push :finished_at, :output, :log, :exit_code
 428       end
 429
 430     when Cancelled
 431       case self.state_was
 432       when Running
 433         permitted.push :finished_at, :output, :log
 434       when Queued, Locked
 435         permitted.push :finished_at, :log
 436       end
 437
 438     else
 439       # The state_transitions check will add an error message for this
 440       return false
 441     end
 442
 443     check_update_whitelist permitted
 444   end
 445
 446   def validate_lock
 447     if [Locked, Running].include? self.state
 448       # If the Container was already locked, locked_by_uuid must not
 449       # changes. Otherwise, the current auth gets the lock.
 450       need_lock = locked_by_uuid_was || current_api_client_authorization.andand.uuid
 451     else
 452       need_lock = nil
 453     end
 454
 455     # The caller can provide a new value for locked_by_uuid, but only
 456     # if it's exactly what we expect. This allows a caller to perform
 457     # an update like {"state":"Unlocked","locked_by_uuid":null}.
 458     if self.locked_by_uuid_changed?
 459       if self.locked_by_uuid != need_lock
 460         return errors.add :locked_by_uuid, "can only change to #{need_lock}"
 461       end
 462     end
 463     self.locked_by_uuid = need_lock
 464   end
 465
 466   def validate_output
 467     # Output must exist and be readable by the current user.  This is so
 468     # that a container cannot "claim" a collection that it doesn't otherwise
 469     # have access to just by setting the output field to the collection PDH.
 470     if output_changed?
 471       c = Collection.
 472             readable_by(current_user, {include_trash: true}).
 473             where(portable_data_hash: self.output).
 474             first
 475       if !c
 476         errors.add :output, "collection must exist and be readable by current user."
 477       end
 478     end
 479   end
 480
 481   def assign_auth
 482     if self.auth_uuid_changed?
 483       return errors.add :auth_uuid, 'is readonly'
 484     end
 485     if not [Locked, Running].include? self.state
 486       # don't need one
 487       self.auth.andand.update_attributes(expires_at: db_current_time)
 488       self.auth = nil
 489       return
 490     elsif self.auth
 491       # already have one
 492       return
 493     end
 494     cr = ContainerRequest.
 495       where('container_uuid=? and priority>0', self.uuid).
 496       order('priority desc').
 497       first
 498     if !cr
 499       return errors.add :auth_uuid, "cannot be assigned because priority <= 0"
 500     end
 501     self.auth = ApiClientAuthorization.
 502       create!(user_id: User.find_by_uuid(cr.modified_by_user_uuid).id,
 503               api_client_id: 0)
 504   end
 505
 506   def sort_serialized_attrs
 507     if self.environment_changed?
 508       self.environment = self.class.deep_sort_hash(self.environment)
 509     end
 510     if self.mounts_changed?
 511       self.mounts = self.class.deep_sort_hash(self.mounts)
 512     end
 513     if self.runtime_constraints_changed?
 514       self.runtime_constraints = self.class.deep_sort_hash(self.runtime_constraints)
 515     end
 516     if self.scheduling_parameters_changed?
 517       self.scheduling_parameters = self.class.deep_sort_hash(self.scheduling_parameters)
 518     end
 519   end
 520
 521   def update_secret_mounts_md5
 522     if self.secret_mounts_changed?
 523       self.secret_mounts_md5 = Digest::MD5.hexdigest(
 524         SafeJSON.dump(self.class.deep_sort_hash(self.secret_mounts)))
 525     end
 526   end
 527
 528   def scrub_secret_mounts
 529     # this runs after update_secret_mounts_md5, so the
 530     # secret_mounts_md5 will still reflect the secrets that are being
 531     # scrubbed here.
 532     if self.state_changed? && self.final?
 533       self.secret_mounts = {}
 534     end
 535   end
 536
 537   def handle_completed
 538     # This container is finished so finalize any associated container requests
 539     # that are associated with this container.
 540     if self.state_changed? and self.final?
 541       act_as_system_user do
 542
 543         if self.state == Cancelled
 544           retryable_requests = ContainerRequest.where("container_uuid = ? and priority > 0 and state = 'Committed' and container_count < container_count_max", uuid)
 545         else
 546           retryable_requests = []
 547         end
 548
 549         if retryable_requests.any?
 550           c_attrs = {
 551             command: self.command,
 552             cwd: self.cwd,
 553             environment: self.environment,
 554             output_path: self.output_path,
 555             container_image: self.container_image,
 556             mounts: self.mounts,
 557             runtime_constraints: self.runtime_constraints,
 558             scheduling_parameters: self.scheduling_parameters
 559           }
 560           c = Container.create! c_attrs
 561           retryable_requests.each do |cr|
 562             cr.with_lock do
 563               # Use row locking because this increments container_count
 564               cr.container_uuid = c.uuid
 565               cr.save!
 566             end
 567           end
 568         end
 569
 570         # Notify container requests associated with this container
 571         ContainerRequest.where(container_uuid: uuid,
 572                                state: ContainerRequest::Committed).each do |cr|
 573           cr.finalize!
 574         end
 575
 576         # Cancel outstanding container requests made by this container.
 577         ContainerRequest.
 578           includes(:container).
 579           where(requesting_container_uuid: uuid,
 580                 state: ContainerRequest::Committed).each do |cr|
 581           cr.update_attributes!(priority: 0)
 582           cr.container.reload
 583           if cr.container.state == Container::Queued || cr.container.state == Container::Locked
 584             # If the child container hasn't started yet, finalize the
 585             # child CR now instead of leaving it "on hold", i.e.,
 586             # Queued with priority 0.  (OTOH, if the child is already
 587             # running, leave it alone so it can get cancelled the
 588             # usual way, get a copy of the log collection, etc.)
 589             cr.update_attributes!(state: ContainerRequest::Final)
 590           end
 591         end
 592       end
 593     end
 594   end
 595
 596 end