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