services/api/script/crunch-dispatch.rb

   1 #!/usr/bin/env ruby
   2
   3 include Process
   4
   5 $warned = {}
   6 $signal = {}
   7 %w{TERM INT}.each do |sig|
   8   signame = sig
   9   Signal.trap(sig) do
  10     $stderr.puts "Received #{signame} signal"
  11     $signal[:term] = true
  12   end
  13 end
  14
  15 if ENV["CRUNCH_DISPATCH_LOCKFILE"]
  16   lockfilename = ENV.delete "CRUNCH_DISPATCH_LOCKFILE"
  17   lockfile = File.open(lockfilename, File::RDWR|File::CREAT, 0644)
  18   unless lockfile.flock File::LOCK_EX|File::LOCK_NB
  19     abort "Lock unavailable on #{lockfilename} - exit"
  20   end
  21 end
  22
  23 ENV["RAILS_ENV"] = ARGV[0] || ENV["RAILS_ENV"] || "development"
  24
  25 require File.dirname(__FILE__) + '/../config/boot'
  26 require File.dirname(__FILE__) + '/../config/environment'
  27 require 'open3'
  28
  29 $redis ||= Redis.new
  30 LOG_BUFFER_SIZE = 2**20
  31
  32 class Dispatcher
  33   include ApplicationHelper
  34
  35   def sysuser
  36     return act_as_system_user
  37   end
  38
  39   def refresh_todo
  40     @todo = Job.queue
  41   end
  42
  43   def sinfo
  44     @@slurm_version ||= Gem::Version.new(`sinfo --version`.match(/\b[\d\.]+\b/)[0])
  45     if Gem::Version.new('2.3') <= @@slurm_version
  46       `sinfo --noheader -o '%n:%t'`.strip
  47     else
  48       # Expand rows with hostname ranges (like "foo[1-3,5,9-12]:idle")
  49       # into multiple rows with one hostname each.
  50       `sinfo --noheader -o '%N:%t'`.split("\n").collect do |line|
  51         tokens = line.split ":"
  52         if (re = tokens[0].match /^(.*?)\[([-,\d]+)\]$/)
  53           re[2].split(",").collect do |range|
  54             range = range.split("-").collect(&:to_i)
  55             (range[0]..range[-1]).collect do |n|
  56               [re[1] + n.to_s, tokens[1..-1]].join ":"
  57             end
  58           end
  59         else
  60           tokens.join ":"
  61         end
  62       end.flatten.join "\n"
  63     end
  64   end
  65
  66   def update_node_status
  67     if Server::Application.config.crunch_job_wrapper.to_s.match /^slurm/
  68       @nodes_in_state = {idle: 0, alloc: 0, down: 0}
  69       @node_state ||= {}
  70       node_seen = {}
  71       begin
  72         sinfo.split("\n").
  73           each do |line|
  74           re = line.match /(\S+?):+(idle|alloc|down)/
  75           next if !re
  76
  77           # sinfo tells us about a node N times if it is shared by N partitions
  78           next if node_seen[re[1]]
  79           node_seen[re[1]] = true
  80
  81           # count nodes in each state
  82           @nodes_in_state[re[2].to_sym] += 1
  83
  84           # update our database (and cache) when a node's state changes
  85           if @node_state[re[1]] != re[2]
  86             @node_state[re[1]] = re[2]
  87             node = Node.where('hostname=?', re[1]).first
  88             if node
  89               $stderr.puts "dispatch: update #{re[1]} state to #{re[2]}"
  90               node.info[:slurm_state] = re[2]
  91               node.save
  92             elsif re[2] != 'down'
  93               $stderr.puts "dispatch: sinfo reports '#{re[1]}' is not down, but no node has that name"
  94             end
  95           end
  96         end
  97       rescue
  98       end
  99     end
 100   end
 101
 102   def start_jobs
 103     @todo.each do |job|
 104
 105       min_nodes = 1
 106       begin
 107         if job.runtime_constraints['min_nodes']
 108           min_nodes = begin job.runtime_constraints['min_nodes'].to_i rescue 1 end
 109         end
 110       end
 111
 112       begin
 113         next if @nodes_in_state[:idle] < min_nodes
 114       rescue
 115       end
 116
 117       next if @running[job.uuid]
 118       next if !take(job)
 119
 120       cmd_args = nil
 121       case Server::Application.config.crunch_job_wrapper
 122       when :none
 123         cmd_args = []
 124       when :slurm_immediate
 125         cmd_args = ["salloc",
 126                     "--chdir=/",
 127                     "--immediate",
 128                     "--exclusive",
 129                     "--no-kill",
 130                     "--job-name=#{job.uuid}",
 131                     "--nodes=#{min_nodes}"]
 132       else
 133         raise "Unknown crunch_job_wrapper: #{Server::Application.config.crunch_job_wrapper}"
 134       end
 135
 136       if Server::Application.config.crunch_job_user
 137         cmd_args.unshift("sudo", "-E", "-u",
 138                          Server::Application.config.crunch_job_user,
 139                          "PERLLIB=#{ENV['PERLLIB']}")
 140       end
 141
 142       job_auth = ApiClientAuthorization.
 143         new(user: User.where('uuid=?', job.modified_by_user_uuid).first,
 144             api_client_id: 0)
 145       job_auth.save
 146
 147       crunch_job_bin = (ENV['CRUNCH_JOB_BIN'] || `which arv-crunch-job`.strip)
 148       if crunch_job_bin == ''
 149         raise "No CRUNCH_JOB_BIN env var, and crunch-job not in path."
 150       end
 151
 152       cmd_args << crunch_job_bin
 153       cmd_args << '--job-api-token'
 154       cmd_args << job_auth.api_token
 155       cmd_args << '--job'
 156       cmd_args << job.uuid
 157
 158       commit = Commit.where(sha1: job.script_version).first
 159       if commit
 160         cmd_args << '--git-dir'
 161         if File.exists?(File.
 162                         join(Rails.configuration.git_repositories_dir,
 163                              commit.repository_name + '.git'))
 164           cmd_args << File.
 165             join(Rails.configuration.git_repositories_dir,
 166                  commit.repository_name + '.git')
 167         else
 168           cmd_args << File.
 169             join(Rails.configuration.git_repositories_dir,
 170                  commit.repository_name, '.git')
 171         end
 172       end
 173
 174       $stderr.puts "dispatch: #{cmd_args.join ' '}"
 175
 176       begin
 177         i, o, e, t = Open3.popen3(*cmd_args)
 178       rescue
 179         $stderr.puts "dispatch: popen3: #{$!}"
 180         sleep 1
 181         untake(job)
 182         next
 183       end
 184
 185       $stderr.puts "dispatch: job #{job.uuid}"
 186       start_banner = "dispatch: child #{t.pid} start #{Time.now.ctime.to_s}"
 187       $stderr.puts start_banner
 188       $redis.set job.uuid, start_banner + "\n"
 189       $redis.publish job.uuid, start_banner
 190       $redis.publish job.owner_uuid, start_banner
 191
 192       @running[job.uuid] = {
 193         stdin: i,
 194         stdout: o,
 195         stderr: e,
 196         wait_thr: t,
 197         job: job,
 198         stderr_buf: '',
 199         started: false,
 200         sent_int: 0,
 201         job_auth: job_auth
 202       }
 203       i.close
 204     end
 205   end
 206
 207   def take(job)
 208     # no-op -- let crunch-job take care of locking.
 209     true
 210   end
 211
 212   def untake(job)
 213     # no-op -- let crunch-job take care of locking.
 214     true
 215   end
 216
 217   def read_pipes
 218     @running.each do |job_uuid, j|
 219       job = j[:job]
 220
 221       # Throw away child stdout
 222       begin
 223         j[:stdout].read_nonblock(2**20)
 224       rescue Errno::EAGAIN, EOFError
 225       end
 226
 227       # Read whatever is available from child stderr
 228       stderr_buf = false
 229       begin
 230         stderr_buf = j[:stderr].read_nonblock(2**20)
 231       rescue Errno::EAGAIN, EOFError
 232       end
 233
 234       if stderr_buf
 235         j[:stderr_buf] << stderr_buf
 236         if j[:stderr_buf].index "\n"
 237           lines = j[:stderr_buf].lines("\n").to_a
 238           if j[:stderr_buf][-1] == "\n"
 239             j[:stderr_buf] = ''
 240           else
 241             j[:stderr_buf] = lines.pop
 242           end
 243           lines.each do |line|
 244             $stderr.print "#{job_uuid} ! " unless line.index(job_uuid)
 245             $stderr.puts line
 246             pub_msg = "#{Time.now.ctime.to_s} #{line.strip}"
 247             $redis.publish job.owner_uuid, pub_msg
 248             $redis.publish job_uuid, pub_msg
 249             $redis.append job_uuid, pub_msg + "\n"
 250             if LOG_BUFFER_SIZE < $redis.strlen(job_uuid)
 251               $redis.set(job_uuid,
 252                          $redis
 253                            .getrange(job_uuid, (LOG_BUFFER_SIZE >> 1), -1)
 254                            .sub(/^.*?\n/, ''))
 255             end
 256           end
 257         end
 258       end
 259     end
 260   end
 261
 262   def reap_children
 263     return if 0 == @running.size
 264     pid_done = nil
 265     j_done = nil
 266
 267     if false
 268       begin
 269         pid_done = waitpid(-1, Process::WNOHANG | Process::WUNTRACED)
 270         if pid_done
 271           j_done = @running.values.
 272             select { |j| j[:wait_thr].pid == pid_done }.
 273             first
 274         end
 275       rescue SystemCallError
 276         # I have @running processes but system reports I have no
 277         # children. This is likely to happen repeatedly if it happens at
 278         # all; I will log this no more than once per child process I
 279         # start.
 280         if 0 < @running.select { |uuid,j| j[:warned_waitpid_error].nil? }.size
 281           children = @running.values.collect { |j| j[:wait_thr].pid }.join ' '
 282           $stderr.puts "dispatch: IPC bug: waitpid() error (#{$!}), but I have children #{children}"
 283         end
 284         @running.each do |uuid,j| j[:warned_waitpid_error] = true end
 285       end
 286     else
 287       @running.each do |uuid, j|
 288         if j[:wait_thr].status == false
 289           pid_done = j[:wait_thr].pid
 290           j_done = j
 291         end
 292       end
 293     end
 294
 295     return if !pid_done
 296
 297     job_done = j_done[:job]
 298     $stderr.puts "dispatch: child #{pid_done} exit"
 299     $stderr.puts "dispatch: job #{job_done.uuid} end"
 300     $redis.publish job_done.uuid, "end"
 301
 302     # Ensure every last drop of stdout and stderr is consumed
 303     read_pipes
 304     if j_done[:stderr_buf] and j_done[:stderr_buf] != ''
 305       $stderr.puts j_done[:stderr_buf] + "\n"
 306     end
 307
 308     # Wait the thread
 309     j_done[:wait_thr].value
 310
 311     # Invalidate the per-job auth token
 312     j_done[:job_auth].update_attributes expires_at: Time.now
 313
 314     @running.delete job_done.uuid
 315   end
 316
 317   def run
 318     act_as_system_user
 319     @running ||= {}
 320     $stderr.puts "dispatch: ready"
 321     while !$signal[:term] or @running.size > 0
 322       read_pipes
 323       if $signal[:term]
 324         @running.each do |uuid, j|
 325           if !j[:started] and j[:sent_int] < 2
 326             begin
 327               Process.kill 'INT', j[:wait_thr].pid
 328             rescue Errno::ESRCH
 329               # No such pid = race condition + desired result is
 330               # already achieved
 331             end
 332             j[:sent_int] += 1
 333           end
 334         end
 335       else
 336         refresh_todo unless did_recently(:refresh_todo, 1.0)
 337         update_node_status
 338         unless @todo.empty? or did_recently(:start_jobs, 1.0) or $signal[:term]
 339           start_jobs
 340         end
 341       end
 342       reap_children
 343       select(@running.values.collect { |j| [j[:stdout], j[:stderr]] }.flatten,
 344              [], [], 1)
 345     end
 346   end
 347
 348   protected
 349
 350   def did_recently(thing, min_interval)
 351     @did_recently ||= {}
 352     if !@did_recently[thing] or @did_recently[thing] < Time.now - min_interval
 353       @did_recently[thing] = Time.now
 354       false
 355     else
 356       true
 357     end
 358   end
 359 end
 360
 361 # This is how crunch-job child procs know where the "refresh" trigger file is
 362 ENV["CRUNCH_REFRESH_TRIGGER"] = Rails.configuration.crunch_refresh_trigger
 363
 364 Dispatcher.new.run