mogilefs-client.git  about / heads / tags
MogileFS client library for Ruby
blob d330439814f3d85bef4bad5198c36ba136b8b318 11472 bytes (raw)
$ git show HEAD:lib/mogilefs/admin.rb	# shows this blob on the CLI

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# -*- encoding: binary -*-
# frozen_string_literal: true

# \MogileFS administration client, this has little real-world usage
# and is considered a work-in-progress
class MogileFS::Admin < MogileFS::Client

  ##
  # Enumerates fids using #list_fids.  Returns the number of valid fids
  # processed

  def each_fid
    low = -1
    rv = 0
    begin
      fids = list_fids(low)
      fids.each { |fid| yield fid }
      rv += fids.size
    end while last = fids[-1] and low = last["fid"]
    rv
  end

  ##
  # Returns an Array of host status Hashes.  If +hostid+ is given only that
  # host is returned.
  #
  #   admin.get_hosts 1
  #
  # Returns:
  #
  #   [{"status"=>"alive",
  #     "http_get_port"=>nil,
  #     "http_port"=>7500,
  #     "hostid"=>1,
  #     "hostip"=>"192.168.1.2",
  #     "hostname"=>"rur-1",
  #     "altip"=>"",
  #     "altmask"=>""}]

  def get_hosts(hostid = nil)
    to_i = %w(hostid http_port http_get_port)
    want = %w(status hostip hostname altip altmask).concat(to_i)
    rv = @backend.get_hosts(hostid ? { :hostid => hostid } : {})
    clean('hosts', 'host', rv, true, to_i, want)
  end

  ##
  # Returns an Array of device status Hashes.  If devid is given only that
  # device is returned.
  #
  #   admin.get_devices 1
  #
  # Returns:
  #
  #   [{"status"=>"alive",
  #     "mb_asof"=>nil,
  #     "mb_free"=>666000,
  #     "devid"=>1,
  #     "hostid"=>1,
  #     "mb_used"=>666,
  #     "utilization"=>0.0,
  #     "reject_bad_md5"=>false,
  #     "observed_state"=>"writeable",
  #     "mb_total"=>666666}]

  def get_devices(devid = nil)
    to_i = %w(mb_asof mb_free mb_used mb_total devid weight hostid)
    want = %w(status reject_bad_md5 observed_state utilization).concat(to_i)
    rv = @backend.get_devices(devid ? { :devid => devid } : {})
    rv = clean('devices', 'dev', rv, true, to_i, want)

    rv.each do |row|
      u = row["utilization"] and row["utilization"] = u.to_f

      case row["observed_state"]
      when ""
        row["observed_state"] = nil
      end

      # be sure we do not set this at all for pre-2.60 MogileFS-Server
      case row["reject_bad_md5"]
      when "1"
        row["reject_bad_md5"] = true
      when "0"
        row["reject_bad_md5"] = false
      when ""
        row["reject_bad_md5"] = nil
      end
    end
  end

  ##
  # Returns an Array of fid Hashes from +from_fid+, limited to +count+
  #
  #   admin.list_fids 0, 100
  #
  # Returns:
  #
  #   [{"fid"=>99,
  #     "class"=>"normal",
  #     "domain"=>"test",
  #     "devcount"=>2,
  #     "length"=>4,
  #     "key"=>"file_key"},
  #    {"fid"=>82,
  #     "class"=>"normal",
  #     "devcount"=>2,
  #     "domain"=>"test",
  #     "length"=>9,
  #     "key"=>"new_new_key"}]

  def list_fids(from_fid, count = 100)
    to_i = %w(fid devcount length)
    want = %w(domain class key).concat(to_i)
    rv = @backend.list_fids(:from => from_fid, :to => count)
    # :to is now :count internally in mogilefsd
    clean('fid_count', 'fid_', rv, true, to_i, want)
  end

  ##
  # Returns a statistics structure representing the state of mogilefs.
  #
  # *** This command no longer works with recent versions of MogileFS ***
  # *** Use mogstats(1) from the MogileFS::Utils package on CPAN ***
  # *** We will remove this method in 4.x ***
  #
  #   admin.get_stats
  #
  # Returns:
  #
  #   {"fids"=>{"max"=>"99", "count"=>"2"},
  #    "device"=>
  #     [{"status"=>"alive", "files"=>"2", "id"=>"1", "host"=>"rur-1"},
  #      {"status"=>"alive", "files"=>"2", "id"=>"2", "host"=>"rur-2"}],
  #    "replication"=>
  #     [{"files"=>"2", "class"=>"normal", "devcount"=>"2", "domain"=>"test"}],
  #    "file"=>[{"files"=>"2", "class"=>"normal", "domain"=>"test"}]}

  def get_stats(type = 'all')
    res = @backend.stats type => 1
    stats = {}

    stats['device'] = clean 'devicescount', 'devices', res, false
    stats['file'] = clean 'filescount', 'files', res, false
    stats['replication'] = clean 'replicationcount', 'replication', res, false

    if res['fidmax'] or res['fidcount'] then
      stats['fids'] = {
        'max' => res['fidmax'].to_i,
        'count' => res['fidcount'].to_i
      }
    end

    %w(device file replication).each do |s|
      stats.delete(s) if stats[s].empty?
    end

    stats
  end

  ##
  # Returns the domains and classes, and their policies present in the mogilefs.
  #
  #   admin.get_domains
  #
  # Returns (on newer MogileFS servers):
  #   {
  #     "test" => {
  #       "default" => {
  #         "mindevcount" => 2,
  #         "replpolicy" => "MultipleHosts()",
  #         "hashtype => nil,
  #       }
  #     }
  #   }
  #
  # Returns (on older MogileFS servers without replication policies):
  #
  #   {"test"=>{"normal"=>3, "default"=>2}}

  def get_domains
    res = @backend.get_domains
    have_replpolicy = false

    domains = {}
    to_i = %w(mindevcount)
    want = %w(name replpolicy hashtype mindevcount)
    (1..res['domains'].to_i).each do |i|
      domain = clean("domain#{i}classes", "domain#{i}class", res, false, to_i,
                     want)
      tmp = domains[res["domain#{i}"]] = {}
      domain.each do |d|
        tmp[d.delete("name")] = d
        have_replpolicy ||= d.include?("replpolicy")
      end
    end

    # only for MogileFS 1.x?, maybe we can drop support for this...
    unless have_replpolicy
      domains.each do |namespace, class_data|
        class_data.each do |class_name, data|
          class_data[class_name] = data["mindevcount"]
        end
      end
    end

    domains
  end

  ##
  # Creates a new domain named +domain+.  Returns nil if creation failed.

  def create_domain(domain)
    raise MogileFS::ReadOnlyError if readonly?
    res = @backend.create_domain :domain => domain
    res ? res['domain'] : nil
  end

  ##
  # Deletes +domain+.  Returns true if successful, raises
  # MogileFS::Backend::DomainNotFoundError if not

  def delete_domain(domain)
    raise MogileFS::ReadOnlyError if readonly?
    ! @backend.delete_domain(:domain => domain).nil?
  end

  ##
  # Creates a new class in +domain+ named +klass+ with +policy+ for
  # replication.  Raises on failure.

  def create_class(domain, klass, policy)
    modify_class(domain, klass, policy, :create)
  end

  ##
  # Updates class +klass+ in +domain+ with +policy+ for replication.
  # Raises on failure.

  def update_class(domain, klass, policy)
    modify_class(domain, klass, policy, :update)
  end

  ##
  # Removes class +klass+ from +domain+.  Returns true if successful.
  # Raises on failure

  def delete_class(domain, klass)
    ! @backend.delete_class(:domain => domain, :class => klass).nil?
  end

  ##
  # Creates a new host named +host+.  +args+ must contain :ip and :port.
  # Returns true if successful, false if not.

  def create_host(host, args = {})
    raise ArgumentError, "Must specify ip and port" unless \
      args.include? :ip and args.include? :port

    modify_host(host, args, 'create')
  end

  ##
  # Updates +host+ with +args+.  Returns true if successful, false if not.

  def update_host(host, args = {})
    modify_host(host, args, 'update')
  end

  ##
  # Deletes host +host+.  Returns nil on failure.

  def delete_host(host)
    raise MogileFS::ReadOnlyError if readonly?
    ! @backend.delete_host(:host => host).nil?
  end

  ##
  # Creates device with Integer +devid+ on +host+
  # +host+ may be an integer for hostid or String for hostname
  def create_device(host, devid, opts = {})
    raise MogileFS::ReadOnlyError if readonly?
    opts = opts.dup

    case host
    when Integer
      opts[:hostid] = host
    when String
      opts[:hostname] = host
    else
      raise ArgumentError, "host=#{host.inspect} is not a String or Integer"
    end

    opts[:devid] = devid
    ! @backend.create_device(opts).nil?
  end

  ##
  # Changes the device status of +device+ on +host+ to +state+ which can be
  # 'alive', 'down', or 'dead'.

  def change_device_state(host, device, state)
    raise MogileFS::ReadOnlyError if readonly?
    ! @backend.set_state(:host => host, :device => device, :state => state).nil?
  end

  ##
  # Changes the device weight of +device+ on +host+ to +weight+.
  # +weight+ should be a non-negative Integer.  Devices with higher
  # +weight+ values are more likely to be chosen for reads and writes.
  def change_device_weight(host, device, weight)
    raise MogileFS::ReadOnlyError if readonly?
    opts = { :host => host, :device => device, :weight => weight }
    ! @backend.set_weight(opts).nil?
  end

  # reschedules all deferred replication, returns a hash with the number
  # of files rescheduled:
  #
  #   admin.replicate_now => { "count" => 5 }
  def replicate_now
    rv = @backend.replicate_now
    rv["count"] = rv["count"].to_i
    rv
  end

  # Clears the tracker caches.  Not implemented in all versions of MogileFS
  def clear_cache
    @backend.clear_cache
  end

  protected unless defined? $TESTING

  ##
  # Modifies +klass+ on +domain+ to store files on +mindevcount+ devices via
  # +action+.  Returns the class name if successful, raises if not

  def modify_class(domain, klass, policy, action)
    raise MogileFS::ReadOnlyError if readonly?
    args = { :domain => domain, :class => klass }
    case policy
    when Integer
      args[:mindevcount] = policy
    when String
      args[:replpolicy] = policy
    when Hash
      args.merge!(policy)
    else
      raise ArgumentError,
           "policy=#{policy.inspect} not understood for #{action}_class"
    end
    @backend.__send__("#{action}_class", args)["class"]
  end

  ##
  # Modifies +host+ using +args+ via +action+.  Returns true if successful,
  # false if not.

  def modify_host(host, args = {}, action = 'create')
    args[:host] = host
    ! @backend.__send__("#{action}_host", args).nil?
  end

  ##
  # Turns the response +res+ from the backend into an Array of Hashes from 1
  # to res[+count+].  If +underscore+ is true then a '_' character is assumed
  # between the prefix and the hash key value.
  #
  #   res = {"host1_remoteroot"=>"/mnt/mogilefs/rur-1",
  #          "host1_hostname"=>"rur-1",
  #          "host1_hostid"=>"1",
  #          "host1_http_get_port"=>"",
  #          "host1_altip"=>"",
  #          "hosts"=>"1",
  #          "host1_hostip"=>"",
  #          "host1_http_port"=>"",
  #          "host1_status"=>"alive",
  #          "host1_altmask"=>""}
  #   admin.clean 'hosts', 'host', res
  #
  # Returns:
  #
  #   [{"status"=>"alive",
  #     "http_get_port"=>nil,
  #     "http_port"=>7600,
  #     "hostid"=>1,
  #     "hostip"=>"192.168.1.3",
  #     "hostname"=>"rur-1",
  #     "altip"=>"",
  #     "altmask"=>""}]

  def clean(count, prefix, res, underscore = true, to_i = [], want = nil)
    empty = ""
    underscore = underscore ? '_' : empty

    # convert array to hash for O(1) lookups
    to_i = to_i.inject({}) { |m,k| m[k] = m }
    if want
      (1..res[count].to_i).map do |i|
        row = {}
        want.each do |k|
          v = res["#{prefix}#{i}#{underscore}#{k}"] or next
          row[k] = to_i.include?(k) ? (empty == v ? nil : v.to_i) : v
        end
        row
      end
    else
      keys = res.keys
      (1..res[count].to_i).map do |i|
        re = /^#{prefix}#{i}#{underscore}/
        row = {}
        keys.grep(re).each do |k|
          v = res[k]
          k = k.sub(re, empty)
          row[k] = to_i.include?(k) ? (empty == v ? nil : v.to_i) : v
        end
        row
      end
    end
  end

end


git clone https://yhbt.net/mogilefs-client.git