1 # -*- encoding: binary -*-
3 # \MogileFS administration client, this has little real-world usage
4 # and is considered a work-in-progress
5 class MogileFS::Admin < MogileFS::Client
8 # Enumerates fids using #list_fids. Returns the number of valid fids
16 fids.each { |fid| yield fid }
18 end while last = fids[-1] and low = last["fid"]
23 # Returns an Array of host status Hashes. If +hostid+ is given only that
30 # [{"status"=>"alive",
31 # "http_get_port"=>nil,
34 # "hostip"=>"192.168.1.2",
35 # "hostname"=>"rur-1",
39 def get_hosts(hostid = nil)
40 to_i = %w(hostid http_port http_get_port)
41 want = %w(status hostip hostname altip altmask).concat(to_i)
42 rv = @backend.get_hosts(hostid ? { :hostid => hostid } : {})
43 clean('hosts', 'host', rv, true, to_i, want)
47 # Returns an Array of device status Hashes. If devid is given only that
54 # [{"status"=>"alive",
61 # "reject_bad_md5"=>false,
62 # "observed_state"=>"writeable",
63 # "mb_total"=>666666}]
65 def get_devices(devid = nil)
66 to_i = %w(mb_asof mb_free mb_used mb_total devid weight hostid)
67 want = %w(status reject_bad_md5 observed_state utilization).concat(to_i)
68 rv = @backend.get_devices(devid ? { :devid => devid } : {})
69 rv = clean('devices', 'dev', rv, true, to_i, want)
72 u = row["utilization"] and row["utilization"] = u.to_f
74 case row["observed_state"]
76 row["observed_state"] = nil
79 # be sure we do not set this at all for pre-2.60 MogileFS-Server
80 case row["reject_bad_md5"]
82 row["reject_bad_md5"] = true
84 row["reject_bad_md5"] = false
86 row["reject_bad_md5"] = nil
92 # Returns an Array of fid Hashes from +from_fid+, limited to +count+
94 # admin.list_fids 0, 100
103 # "key"=>"file_key"},
109 # "key"=>"new_new_key"}]
111 def list_fids(from_fid, count = 100)
112 to_i = %w(fid devcount length)
113 want = %w(domain class key).concat(to_i)
114 rv = @backend.list_fids(:from => from_fid, :to => count)
115 # :to is now :count internally in mogilefsd
116 clean('fid_count', 'fid_', rv, true, to_i, want)
120 # Returns a statistics structure representing the state of mogilefs.
122 # *** This command no longer works with recent versions of MogileFS ***
123 # *** Use mogstats(1) from the MogileFS::Utils package on CPAN ***
124 # *** We will remove this method in 4.x ***
130 # {"fids"=>{"max"=>"99", "count"=>"2"},
132 # [{"status"=>"alive", "files"=>"2", "id"=>"1", "host"=>"rur-1"},
133 # {"status"=>"alive", "files"=>"2", "id"=>"2", "host"=>"rur-2"}],
135 # [{"files"=>"2", "class"=>"normal", "devcount"=>"2", "domain"=>"test"}],
136 # "file"=>[{"files"=>"2", "class"=>"normal", "domain"=>"test"}]}
138 def get_stats(type = 'all')
139 res = @backend.stats type => 1
142 stats['device'] = clean 'devicescount', 'devices', res, false
143 stats['file'] = clean 'filescount', 'files', res, false
144 stats['replication'] = clean 'replicationcount', 'replication', res, false
146 if res['fidmax'] or res['fidcount'] then
148 'max' => res['fidmax'].to_i,
149 'count' => res['fidcount'].to_i
153 %w(device file replication).each do |s|
154 stats.delete(s) if stats[s].empty?
161 # Returns the domains and classes, and their policies present in the mogilefs.
165 # Returns (on newer MogileFS servers):
169 # "mindevcount" => 2,
170 # "replpolicy" => "MultipleHosts()",
176 # Returns (on older MogileFS servers without replication policies):
178 # {"test"=>{"normal"=>3, "default"=>2}}
181 res = @backend.get_domains
182 have_replpolicy = false
185 to_i = %w(mindevcount)
186 want = %w(name replpolicy hashtype mindevcount)
187 (1..res['domains'].to_i).each do |i|
188 domain = clean("domain#{i}classes", "domain#{i}class", res, false, to_i,
190 tmp = domains[res["domain#{i}"]] = {}
192 tmp[d.delete("name")] = d
193 have_replpolicy ||= d.include?("replpolicy")
197 # only for MogileFS 1.x?, maybe we can drop support for this...
198 unless have_replpolicy
199 domains.each do |namespace, class_data|
200 class_data.each do |class_name, data|
201 class_data[class_name] = data["mindevcount"]
210 # Creates a new domain named +domain+. Returns nil if creation failed.
212 def create_domain(domain)
213 raise MogileFS::ReadOnlyError if readonly?
214 res = @backend.create_domain :domain => domain
215 res ? res['domain'] : nil
219 # Deletes +domain+. Returns true if successful, raises
220 # MogileFS::Backend::DomainNotFoundError if not
222 def delete_domain(domain)
223 raise MogileFS::ReadOnlyError if readonly?
224 ! @backend.delete_domain(:domain => domain).nil?
228 # Creates a new class in +domain+ named +klass+ with +policy+ for
229 # replication. Raises on failure.
231 def create_class(domain, klass, policy)
232 modify_class(domain, klass, policy, :create)
236 # Updates class +klass+ in +domain+ with +policy+ for replication.
239 def update_class(domain, klass, policy)
240 modify_class(domain, klass, policy, :update)
244 # Removes class +klass+ from +domain+. Returns true if successful.
247 def delete_class(domain, klass)
248 ! @backend.delete_class(:domain => domain, :class => klass).nil?
252 # Creates a new host named +host+. +args+ must contain :ip and :port.
253 # Returns true if successful, false if not.
255 def create_host(host, args = {})
256 raise ArgumentError, "Must specify ip and port" unless \
257 args.include? :ip and args.include? :port
259 modify_host(host, args, 'create')
263 # Updates +host+ with +args+. Returns true if successful, false if not.
265 def update_host(host, args = {})
266 modify_host(host, args, 'update')
270 # Deletes host +host+. Returns nil on failure.
272 def delete_host(host)
273 raise MogileFS::ReadOnlyError if readonly?
274 ! @backend.delete_host(:host => host).nil?
278 # Creates device with Integer +devid+ on +host+
279 # +host+ may be an integer for hostid or String for hostname
280 def create_device(host, devid, opts = {})
281 raise MogileFS::ReadOnlyError if readonly?
288 opts[:hostname] = host
290 raise ArgumentError, "host=#{host.inspect} is not a String or Integer"
294 ! @backend.create_device(opts).nil?
298 # Changes the device status of +device+ on +host+ to +state+ which can be
299 # 'alive', 'down', or 'dead'.
301 def change_device_state(host, device, state)
302 raise MogileFS::ReadOnlyError if readonly?
303 ! @backend.set_state(:host => host, :device => device, :state => state).nil?
307 # Changes the device weight of +device+ on +host+ to +weight+.
308 # +weight+ should be a non-negative Integer. Devices with higher
309 # +weight+ values are more likely to be chosen for reads and writes.
310 def change_device_weight(host, device, weight)
311 raise MogileFS::ReadOnlyError if readonly?
312 opts = { :host => host, :device => device, :weight => weight }
313 ! @backend.set_weight(opts).nil?
316 # reschedules all deferred replication, returns a hash with the number
317 # of files rescheduled:
319 # admin.replicate_now => { "count" => 5 }
321 rv = @backend.replicate_now
322 rv["count"] = rv["count"].to_i
326 # Clears the tracker caches. Not implemented in all versions of MogileFS
331 protected unless defined? $TESTING
334 # Modifies +klass+ on +domain+ to store files on +mindevcount+ devices via
335 # +action+. Returns the class name if successful, raises if not
337 def modify_class(domain, klass, policy, action)
338 raise MogileFS::ReadOnlyError if readonly?
339 args = { :domain => domain, :class => klass }
342 args[:mindevcount] = policy
344 args[:replpolicy] = policy
349 "policy=#{policy.inspect} not understood for #{action}_class"
351 @backend.__send__("#{action}_class", args)["class"]
355 # Modifies +host+ using +args+ via +action+. Returns true if successful,
358 def modify_host(host, args = {}, action = 'create')
360 ! @backend.__send__("#{action}_host", args).nil?
364 # Turns the response +res+ from the backend into an Array of Hashes from 1
365 # to res[+count+]. If +underscore+ is true then a '_' character is assumed
366 # between the prefix and the hash key value.
368 # res = {"host1_remoteroot"=>"/mnt/mogilefs/rur-1",
369 # "host1_hostname"=>"rur-1",
370 # "host1_hostid"=>"1",
371 # "host1_http_get_port"=>"",
374 # "host1_hostip"=>"",
375 # "host1_http_port"=>"",
376 # "host1_status"=>"alive",
377 # "host1_altmask"=>""}
378 # admin.clean 'hosts', 'host', res
382 # [{"status"=>"alive",
383 # "http_get_port"=>nil,
386 # "hostip"=>"192.168.1.3",
387 # "hostname"=>"rur-1",
391 def clean(count, prefix, res, underscore = true, to_i = [], want = nil)
393 underscore = underscore ? '_' : empty
395 # convert array to hash for O(1) lookups
396 to_i = to_i.inject({}) { |m,k| m[k] = m }
398 (1..res[count].to_i).map do |i|
401 v = res["#{prefix}#{i}#{underscore}#{k}"] or next
402 row[k] = to_i.include?(k) ? (empty == v ? nil : v.to_i) : v
408 (1..res[count].to_i).map do |i|
409 re = /^#{prefix}#{i}#{underscore}/
411 keys.grep(re).each do |k|
414 row[k] = to_i.include?(k) ? (empty == v ? nil : v.to_i) : v