lib/mogilefs/backend.rb

   1 # -*- encoding: binary -*-
   2 require 'thread'
   3
   4 # This class communicates with the MogileFS trackers.
   5 # You should not have to use this directly unless you are developing
   6 # support for new commands or plugins for MogileFS
   7 class MogileFS::Backend
   8
   9   # Adds MogileFS commands +names+.
  10   def self.add_command(*names)
  11     names.each do |name|
  12       define_method name do |*args|
  13         do_request(name, args[0] || {}, false)
  14       end
  15     end
  16   end
  17
  18   # adds idempotent MogileFS commands +names+, these commands may be retried
  19   # transparently on a different tracker if there is a network/server error.
  20   def self.add_idempotent_command(*names)
  21     names.each do |name|
  22       define_method name do |*args|
  23         do_request(name, args[0] || {}, true)
  24       end
  25     end
  26   end
  27
  28   BACKEND_ERRORS = {} # :nodoc:
  29
  30   # this converts an error code from a mogilefsd tracker to an exception:
  31   #
  32   # Examples of some exceptions that get created:
  33   #   class AfterMismatchError < MogileFS::Error; end
  34   #   class DomainNotFoundError < MogileFS::Error; end
  35   #   class InvalidCharsError < MogileFS::Error; end
  36   def self.add_error(err_snake)
  37     err_camel = err_snake.gsub(/(?:^|_)([a-z])/) { $1.upcase }
  38     err_camel << 'Error' unless /Error\z/ =~ err_camel
  39     unless const_defined?(err_camel)
  40       const_set(err_camel, Class.new(MogileFS::Error))
  41     end
  42     BACKEND_ERRORS[err_snake] = const_get(err_camel)
  43   end
  44
  45   ##
  46   # The last error
  47
  48   attr_reader :lasterr
  49
  50   ##
  51   # The string attached to the last error
  52
  53   attr_reader :lasterrstr
  54
  55   ##
  56   # Creates a new MogileFS::Backend.
  57   #
  58   # :hosts is a required argument and must be an Array containing one or more
  59   # 'hostname:port' pairs as Strings.
  60   #
  61   # :timeout adjusts the request timeout before an error is returned.
  62
  63   def initialize(args)
  64     @hosts = args[:hosts]
  65     raise ArgumentError, "must specify at least one host" unless @hosts
  66     raise ArgumentError, "must specify at least one host" if @hosts.empty?
  67     unless @hosts == @hosts.select { |h| h =~ /:\d+$/ } then
  68       raise ArgumentError, ":hosts must be in 'host:port' form"
  69     end
  70
  71     @mutex = Mutex.new
  72     @timeout = args[:timeout] || 3
  73     @socket = nil
  74     @lasterr = nil
  75     @lasterrstr = nil
  76     @pending = []
  77
  78     @dead = {}
  79   end
  80
  81   ##
  82   # Closes this backend's socket.
  83
  84   def shutdown
  85     @mutex.synchronize { shutdown_unlocked }
  86   end
  87
  88   # MogileFS::MogileFS commands
  89
  90   add_command :create_open
  91   add_command :create_close
  92   add_idempotent_command :get_paths
  93   add_command :delete
  94   add_idempotent_command :sleep
  95   add_command :rename
  96   add_idempotent_command :list_keys
  97   add_idempotent_command :file_info
  98   add_idempotent_command :file_debug
  99
 100   # MogileFS::Backend commands
 101
 102   add_idempotent_command :get_hosts
 103   add_idempotent_command :get_devices
 104   add_idempotent_command :list_fids
 105   add_idempotent_command :stats
 106   add_idempotent_command :get_domains
 107   add_command :create_domain
 108   add_command :delete_domain
 109   add_command :create_class
 110   add_command :update_class
 111   add_command :delete_class
 112   add_command :create_host
 113   add_command :update_host
 114   add_command :delete_host
 115   add_command :set_state
 116
 117   # Errors copied from MogileFS/Worker/Query.pm
 118   add_error 'dup'
 119   add_error 'after_mismatch'
 120   add_error 'bad_params'
 121   add_error 'class_exists'
 122   add_error 'class_has_files'
 123   add_error 'class_not_found'
 124   add_error 'db'
 125   add_error 'domain_has_files'
 126   add_error 'domain_exists'
 127   add_error 'domain_not_empty'
 128   add_error 'domain_not_found'
 129   add_error 'failure'
 130   add_error 'host_exists'
 131   add_error 'host_mismatch'
 132   add_error 'host_not_empty'
 133   add_error 'host_not_found'
 134   add_error 'invalid_chars'
 135   add_error 'invalid_checker_level'
 136   add_error 'invalid_mindevcount'
 137   add_error 'key_exists'
 138   add_error 'no_class'
 139   add_error 'no_devices'
 140   add_error 'no_domain'
 141   add_error 'no_host'
 142   add_error 'no_ip'
 143   add_error 'no_key'
 144   add_error 'no_port'
 145   add_error 'none_match'
 146   add_error 'plugin_aborted'
 147   add_error 'state_too_high'
 148   add_error 'size_verify_error'
 149   add_error 'unknown_command'
 150   add_error 'unknown_host'
 151   add_error 'unknown_key'
 152   add_error 'unknown_state'
 153   add_error 'unreg_domain'
 154
 155   def shutdown_unlocked(do_raise = false) # :nodoc:
 156     @pending = []
 157     if @socket
 158       @socket.close rescue nil # ignore errors
 159       @socket = nil
 160     end
 161     raise if do_raise
 162   end
 163
 164   def dispatch_unlocked(request, timeout = @timeout) # :nodoc:
 165     begin
 166       io = socket
 167       io.timed_write(request, timeout)
 168       io
 169     rescue SystemCallError, MogileFS::RequestTruncatedError  => err
 170       @dead[@active_host] = [ Time.now, err ]
 171       shutdown_unlocked
 172       retry
 173     end
 174   end
 175
 176   def pipeline_gets_unlocked(io, timeout) # :nodoc:
 177     line = io.timed_gets(timeout) or
 178       raise MogileFS::PipelineError,
 179             "EOF with #{@pending.size} requests in-flight"
 180     ready = @pending.shift
 181     ready[1].call(parse_response(line, ready[0]))
 182   end
 183
 184   def timeout_update(timeout, t0) # :nodoc:
 185     timeout -= (Time.now - t0)
 186     timeout < 0 ? 0 : timeout
 187   end
 188
 189   # try to read any responses we have pending already before filling
 190   # the pipeline more requests.  This usually takes very little time,
 191   # but trackers may return huge responses and we could be on a slow
 192   # network.
 193   def pipeline_drain_unlocked(io, timeout) # :nodoc:
 194     set = [ io ]
 195     while @pending.size > 0
 196       t0 = Time.now
 197       r = IO.select(set, set, nil, timeout)
 198       timeout = timeout_update(timeout, t0)
 199
 200       if r && r[0][0]
 201         t0 = Time.now
 202         pipeline_gets_unlocked(io, timeout)
 203         timeout = timeout_update(timeout, t0)
 204       else
 205         return timeout
 206       end
 207     end
 208     timeout
 209   end
 210
 211   # dispatch a request like do_request, but queue +block+ for execution
 212   # upon receiving a response.  It is the users' responsibility to ensure
 213   # &block is executed in the correct order.  Trackers with multiple
 214   # queryworkers are not guaranteed to return responses in the same
 215   # order they were requested.
 216   def pipeline_dispatch(cmd, args, &block) # :nodoc:
 217     request = make_request(cmd, args)
 218     timeout = @timeout
 219
 220     @mutex.synchronize do
 221       io = socket
 222       timeout = pipeline_drain_unlocked(io, timeout)
 223
 224       # send the request out...
 225       begin
 226         io.timed_write(request, timeout)
 227         @pending << [ request, block ]
 228       rescue SystemCallError, MogileFS::RequestTruncatedError => err
 229         @dead[@active_host] = [ Time.now, err ]
 230         shutdown_unlocked(@pending[0])
 231         io = socket
 232         retry
 233       end
 234
 235       @pending.size
 236     end
 237   end
 238
 239   def pipeline_wait(count = nil) # :nodoc:
 240     @mutex.synchronize do
 241       io = socket
 242       count ||= @pending.size
 243       @pending.size < count and
 244         raise MogileFS::Error,
 245               "pending=#{@pending.size} < expected=#{count} failed"
 246       begin
 247         count.times { pipeline_gets_unlocked(io, @timeout) }
 248       rescue
 249         shutdown_unlocked(true)
 250       end
 251     end
 252   end
 253
 254   # Performs the +cmd+ request with +args+.
 255   def do_request(cmd, args, idempotent = false)
 256     request = make_request cmd, args
 257     @mutex.synchronize do
 258       begin
 259         io = dispatch_unlocked(request)
 260         line = io.timed_gets(@timeout) and return parse_response(line)
 261
 262         idempotent or
 263           raise EOFError, "end of file reached after: #{request.inspect}"
 264         # fall through to retry in loop
 265       rescue SystemCallError,
 266              MogileFS::UnreadableSocketError,
 267              MogileFS::InvalidResponseError, # truncated response
 268              MogileFS::Timeout
 269         # we got a successful timed_write, but not a timed_gets
 270         retry if idempotent
 271         shutdown_unlocked(true)
 272       rescue
 273         # we DO NOT want the response we timed out waiting for, to crop up later
 274         # on, on the same socket, intersperesed with a subsequent request!  we
 275         # close the socket if there's any error.
 276         shutdown_unlocked(true)
 277       end while idempotent
 278     end # @mutex.synchronize
 279   end
 280
 281   # Makes a new request string for +cmd+ and +args+.
 282   def make_request(cmd, args)
 283     "#{cmd} #{url_encode args}\r\n"
 284   end
 285
 286   # this converts an error code from a mogilefsd tracker to an exception
 287   # Most of these exceptions should already be defined, but since the
 288   # MogileFS server code is liable to change and we may not always be
 289   # able to keep up with the changes
 290   def error(err_snake)
 291     BACKEND_ERRORS[err_snake] || self.class.add_error(err_snake)
 292   end
 293
 294   # Turns the +line+ response from the server into a Hash of options, an
 295   # error, or raises, as appropriate.
 296   def parse_response(line, request = nil)
 297     if line =~ /^ERR\s+(\w+)\s*([^\r\n]*)/
 298       @lasterr = $1
 299       @lasterrstr = $2 ? url_unescape($2) : nil
 300       if request
 301         request = " request=#{request.strip}"
 302         @lasterrstr = @lasterrstr ? (@lasterrstr << request) : request
 303         return error(@lasterr).new(@lasterrstr)
 304       end
 305       raise error(@lasterr).new(@lasterrstr)
 306     end
 307
 308     return url_decode($1) if line =~ /^OK\s+\d*\s*(\S*)\r\n\z/
 309
 310     raise MogileFS::InvalidResponseError,
 311           "Invalid response from server: #{line.inspect}"
 312   end
 313
 314   # Returns a socket connected to a MogileFS tracker.
 315   def socket
 316     return @socket if @socket and not @socket.closed?
 317
 318     now = Time.now
 319
 320     @hosts.shuffle.each do |host|
 321       next if @dead.include?(host) and @dead[host][0] > now - 5
 322
 323       begin
 324         addr, port = host.split(/:/)
 325         @socket = MogileFS::Socket.tcp(addr, port, @timeout)
 326         @active_host = host
 327       rescue SystemCallError, MogileFS::Timeout => err
 328         @dead[host] = [ now, err ]
 329         next
 330       end
 331
 332       return @socket
 333     end
 334
 335     errors = @dead.map { |host,(_,e)| "#{host} - #{e.message} (#{e.class})" }
 336     raise MogileFS::UnreachableBackendError,
 337           "couldn't connect to any tracker: #{errors.join(', ')}"
 338   end
 339
 340   # Turns a url params string into a Hash.
 341   def url_decode(str) # :nodoc:
 342     Hash[*(str.split(/&/).map! { |pair|
 343       pair.split(/=/, 2).map! { |x| url_unescape(x) }
 344     } ).flatten]
 345   end
 346
 347   # :stopdoc:
 348   # TODO: see if we can use existing URL-escape/unescaping routines
 349   # in the Ruby standard library, Perl MogileFS seems to NIH these
 350   #  routines, too
 351   # :startdoc:
 352
 353   # Turns a Hash (or Array of pairs) into a url params string.
 354   def url_encode(params) # :nodoc:
 355     params.map do |k,v|
 356       "#{url_escape k.to_s}=#{url_escape v.to_s}"
 357     end.join("&")
 358   end
 359
 360   # Escapes naughty URL characters.
 361   if ''.respond_to?(:ord) # Ruby 1.9
 362     def url_escape(str) # :nodoc:
 363       str.gsub(/([^\w\,\-.\/\\\: ])/) { "%%%02x" % $1.ord }.tr(' ', '+')
 364     end
 365   else # Ruby 1.8
 366     def url_escape(str) # :nodoc:
 367       str.gsub(/([^\w\,\-.\/\\\: ])/) { "%%%02x" % $1[0] }.tr(' ', '+')
 368     end
 369   end
 370
 371   # Unescapes naughty URL characters.
 372   def url_unescape(str) # :nodoc:
 373     str.tr('+', ' ').gsub(/%([a-f0-9][a-f0-9])/i) { [$1.to_i(16)].pack 'C' }
 374   end
 375 end