ruby-lvm-attrib 0.0.1

data/History.txt

@@ -0,0 +1,5 @@
+=== 0.0.1 / 2008-07-21
+
+* 1 major enhancement
+  * Birthday!
+  * Test release.

data/Manifest.txt

@@ -0,0 +1,28 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+Todo.txt
+bin/generate_field_data
+lib/lvm/attributes.rb
+lib/lvm/attributes/2.02.26/lvs.yaml
+lib/lvm/attributes/2.02.26/lvsseg.yaml
+lib/lvm/attributes/2.02.26/pvs.yaml
+lib/lvm/attributes/2.02.26/pvsseg.yaml
+lib/lvm/attributes/2.02.26/vgs.yaml
+lib/lvm/attributes/2.02.27/lvs.yaml
+lib/lvm/attributes/2.02.27/lvsseg.yaml
+lib/lvm/attributes/2.02.27/pvs.yaml
+lib/lvm/attributes/2.02.27/pvsseg.yaml
+lib/lvm/attributes/2.02.27/vgs.yaml
+lib/lvm/attributes/2.02.29/lvs.yaml
+lib/lvm/attributes/2.02.29/lvsseg.yaml
+lib/lvm/attributes/2.02.29/pvs.yaml
+lib/lvm/attributes/2.02.29/pvsseg.yaml
+lib/lvm/attributes/2.02.29/vgs.yaml
+lib/lvm/attributes/2.02.30/lvs.yaml
+lib/lvm/attributes/2.02.30/lvsseg.yaml
+lib/lvm/attributes/2.02.30/pvs.yaml
+lib/lvm/attributes/2.02.30/pvsseg.yaml
+lib/lvm/attributes/2.02.30/vgs.yaml
+test/test_ruby-lvm-attributes.rb

data/README.txt

@@ -0,0 +1,63 @@
+= ruby-lvm-attrib
+
+* http://ruby-lvm-attrib.rubyforge.org
+* mailto:mkent@magoazul.com
+
+== DESCRIPTION:
+
+This is a list of attributes for lvm objects. They are generated from the 
+source code and broken down by version.
+
+At their core these files exist to determine which arguments to pass
+lvs/vgs/pvs and the subsequent type conversions.
+
+Currently this is split from the main ruby-lvm gem since these files require
+updating to follow LVM2 releases.
+
+== FEATURES/PROBLEMS:
+
+* This library may go away depending on future progress of ruby-lvm.
+
+== SYNOPSIS:
+
+  require 'lvm/attributes'
+
+  attributes = Attributes.load("2.0.36", "vgs.yaml")
+
+== REQUIREMENTS:
+
+* None
+
+== INSTALL:
+
+* sudo gem install ruby-lvm-attrib
+
+== FEEDBACK:
+
+Please feel free to submit patches or constructive criticism, I'm still pretty
+new to ruby and object oriented programming in general.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Matthew Kent, Bravenet Web Services Inc. 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,13 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'lvm/attributes'
+
+Hoe.new('ruby-lvm-attrib', LVM::Attributes::VERSION) do |p|
+  p.developer('Matthew Kent', 'mkent@magoazul.com')
+  p.remote_rdoc_dir = ''
+end
+
+# vim: syntax=Ruby

data/Todo.txt

@@ -0,0 +1,4 @@
+= to do
+
+== 0.1.1
+* attribute generation should be a proper class with a binary invoking it 

data/bin/generate_field_data

@@ -0,0 +1,169 @@
+#!/usr/bin/env ruby
+
+# Build yaml files which provide arguments passed to {lv,pv,vg}s and subsequent
+# type conversions.
+#
+# ./generate_field_data ~/LVM2.2.02.38
+
+require 'fileutils'
+require 'yaml'
+
+VERSION_FILE = "/VERSION"
+COLUMNS_FILE = "/lib/report/columns.h"
+
+debug = false 
+
+TYPE_CONVERSION_MAP = {
+ # Only types we can really trust
+ "uint32" => "Integer",
+ "int32" => "Integer",
+ # These were determined by reading the code, they invoke _(u)int32_disp right away
+ "pvmdas" => "Integer",
+ "vgmdas" => "Integer",
+ "lvcount" => "Integer",
+ "lvsegcount" => "Integer",
+ "segstartpe" => "Integer",
+ # listed to return STR?
+ "lvkmaj" => "Integer",
+ "lvkmin" => "Integer",
+ "snpercent" => "Float",
+ "copypercent" => "Float",
+ # size32/64, these do unit formatting unless overridden on command line. We
+ # typically want them in bytes so we can convert them to Integers safely
+ "size32" => "Integer",
+ "size64" => "Integer",
+ # These types return size32/size64 as well
+ "lvkreadahead" => "Integer",
+ "pvsize" => "Integer",
+ "devsize" => "Integer",
+ "pvfree" => "Integer",
+ "pvused" => "Integer",
+ "pvmdafree" => "Integer",
+ "vgsize" => "Integer",
+ "vgfree" => "Integer",
+ "vgmda_free" => "Integer",
+ "chunksize" => "Integer",
+ "segstart" => "Integer",
+ "segsize" => "Integer",
+ "vgmdafree" => "Integer",
+ # Weird one, can be "auto" or size32
+ "lvreadahead" => "String"
+}
+
+lvm_source = ARGV[0]
+
+version = File.readlines(lvm_source + VERSION_FILE)[0].split(' ')[0]
+
+lvs     = []
+lvssegs = []
+pvs     = []
+pvssegs = [] 
+vgs     = []
+File.readlines(lvm_source + COLUMNS_FILE).each do |line|
+  # eg: FIELD(LVS, lv, STR, "LV UUID", lvid.id[1], 38, uuid, "lv_uuid", "Unique identifier")
+  if line =~ %r{^FIELD\((.*)\)$}
+    fields = $1.split(', ')
+    fields.each { |f| f.gsub!(%r{^"}, ''); f.gsub!(%r{"$}, '') }
+    p fields if debug
+    app           = fields[0]
+    general_type  = fields[2]
+    specific_type = fields[6]
+    column        = fields[7]
+    method        = fields[7].dup
+    description   = fields[8]
+    p app, general_type, specific_type, column, method, description if debug
+
+    if general_type == "NUM"
+      attribute_type = TYPE_CONVERSION_MAP[specific_type]
+      if attribute_type.nil?
+        puts "Oops, missing type conversion data of column '#{attribute}' use by '#{app}' which says its going to return a '#{specific_type}'"
+        puts "Figure out the missing type and rerun."
+        exit 1
+      end
+    else
+      attribute_type = "String"
+    end
+
+    # our shorter nicer method names, according to the man page these can be
+    # dropped when passing column names as arguments as well, but i found a few
+    # with issues (seg_start).
+    case app
+    when "LVS"
+      method.sub!(%r{^lv_}, '') 
+    when "SEGS"
+      method.sub!(%r{^seg_}, '') 
+    when "PVS"
+      method.sub!(%r{^pv_}, '') 
+    when "PVSEGS"
+      method.sub!(%r{^pvseg_}, '') 
+    when "VGS"
+      method.sub!(%r{^vg_}, '') 
+    end
+
+    attribute = { 
+      :method => method, 
+      :column => column, 
+      :type_hint => attribute_type, 
+      :description => description 
+    }
+
+    case app
+    when "LVS"
+      lvs << attribute
+    when "SEGS"
+      lvssegs << attribute
+    when "PVS"
+      pvs << attribute
+    when "PVSEGS"
+      pvssegs << attribute
+    when "VGS"
+      vgs << attribute
+    end
+  end
+end
+
+# we use vg_uuid as our crossover attribute that links vg->lv and vg->pv
+attribute = { :method => "vg_uuid", 
+              :column => "vg_uuid", 
+              :type_hint => "String", 
+              :description => "For VolumeGroup to LogicalVolume relationship." }
+lvs << attribute
+attribute = { :method => "vg_uuid", 
+              :column => "vg_uuid", 
+              :type_hint => "String", 
+              :description => "For VolumeGroup to PhysicalVolume relationship." }
+pvs << attribute
+
+# and we link lv->lvsegment, pv->pvsegment
+attribute = { :method => "lv_uuid", 
+              :column => "lv_uuid", 
+              :type_hint => "String", 
+              :description => "For LogicalVolume to LogicalVolumeSegment relationship." }
+lvssegs << attribute
+attribute = { :method => "pv_uuid", 
+              :column => "pv_uuid", 
+              :type_hint => "String", 
+              :description => "For PhysicalVolume to PhysicalVolumeSegment relationship." }
+pvssegs << attribute
+
+lvs.sort!     {|x,y| x[:column] <=> y[:column]}
+lvssegs.sort! {|x,y| x[:column] <=> y[:column]}
+pvs.sort!     {|x,y| x[:column] <=> y[:column]} 
+pvssegs.sort! {|x,y| x[:column] <=> y[:column]} 
+vgs.sort!     {|x,y| x[:column] <=> y[:column]}
+
+FileUtils.mkdir(version)
+
+disclaimer=<<go
+# These are column to object attribute mappings
+# generated by #{$0} based on
+# #{lvm_source}/lib/report/columns.h
+go
+
+File.open("#{version}/lvs.yaml", "w")    { |f| f.write(disclaimer); f.write(lvs.to_yaml)    }
+File.open("#{version}/lvsseg.yaml", "w") { |f| f.write(disclaimer); f.write(lvssegs.to_yaml)}
+File.open("#{version}/pvs.yaml", "w")    { |f| f.write(disclaimer); f.write(pvs.to_yaml)    }
+File.open("#{version}/pvsseg.yaml", "w") { |f| f.write(disclaimer); f.write(pvssegs.to_yaml)}
+File.open("#{version}/vgs.yaml", "w")    { |f| f.write(disclaimer); f.write(vgs.to_yaml)    }
+
+puts "Done."

data/lib/lvm/attributes.rb

@@ -0,0 +1,24 @@
+require 'yaml'
+
+module LVM
+  module Attributes
+    VERSION = '0.0.1'
+
+    def load(version, name)
+      cwd = File.dirname(__FILE__)
+
+      # was going to be symlinks, but rubygems didn't seem to want to package
+      # them
+      if version == "2.02.28"
+        version = "2.02.27"
+      elsif ((31..39).map { |x| "2.02.#{x}" }).include?(version)
+        version = "2.02.30"
+      end
+
+      file = File.join(cwd, "attributes", version, name)
+
+      return YAML.load_file(file)
+    end
+    module_function :load
+  end # module Attributes 
+end # module LVM

data/lib/lvm/attributes/2.02.26/lvs.yaml

@@ -0,0 +1,72 @@
+# These are column to object attribute mappings
+# generated by ./generate_field_data based on
+# /home/iscsidev/LVM2.2.02.26/lib/report/columns.h
+--- 
+- :method: copy_percent
+  :type_hint: Float
+  :column: copy_percent
+  :description: For mirrors and pvmove
+- :method: attr
+  :type_hint: String
+  :column: lv_attr
+  :description: Various attributes - see man page.
+- :method: kernel_major
+  :type_hint: String
+  :column: lv_kernel_major
+  :description: Currently assigned major number or -1 if LV is not active.
+- :method: kernel_minor
+  :type_hint: String
+  :column: lv_kernel_minor
+  :description: Currently assigned minor number or -1 if LV is not active.
+- :method: major
+  :type_hint: Integer
+  :column: lv_major
+  :description: Persistent major number or -1 if not persistent.
+- :method: minor
+  :type_hint: Integer
+  :column: lv_minor
+  :description: Persistent minor number or -1 if not persistent.
+- :method: name
+  :type_hint: String
+  :column: lv_name
+  :description: Name.  LVs created for internal use are enclosed in brackets.
+- :method: size
+  :type_hint: Integer
+  :column: lv_size
+  :description: Size of LV in current units.
+- :method: tags
+  :type_hint: String
+  :column: lv_tags
+  :description: Tags
+- :method: uuid
+  :type_hint: String
+  :column: lv_uuid
+  :description: Unique identifier
+- :method: mirror_log
+  :type_hint: String
+  :column: mirror_log
+  :description: For mirrors
+- :method: modules
+  :type_hint: String
+  :column: modules
+  :description: Kernel device-mapper modules required for this LV.
+- :method: move_pv
+  :type_hint: String
+  :column: move_pv
+  :description: For pvmove
+- :method: origin
+  :type_hint: String
+  :column: origin
+  :description: For snapshots
+- :method: seg_count
+  :type_hint: Integer
+  :column: seg_count
+  :description: Number of segments in LV.
+- :method: snap_percent
+  :type_hint: Float
+  :column: snap_percent
+  :description: For snapshots
+- :method: vg_uuid
+  :type_hint: String
+  :column: vg_uuid
+  :description: For VolumeGroup to LogicalVolume relationship.

data/lib/lvm/attributes/2.02.26/lvsseg.yaml

@@ -0,0 +1,56 @@
+# These are column to object attribute mappings
+# generated by ./generate_field_data based on
+# /home/iscsidev/LVM2.2.02.26/lib/report/columns.h
+--- 
+- :method: chunk_size
+  :type_hint: Integer
+  :column: chunk_size
+  :description: For snapshots
+- :method: chunksize
+  :type_hint: Integer
+  :column: chunksize
+  :description: For snapshots
+- :method: devices
+  :type_hint: String
+  :column: devices
+  :description: Underlying devices used with starting extent numbers.
+- :method: lv_uuid
+  :type_hint: String
+  :column: lv_uuid
+  :description: For LogicalVolume to LogicalVolumeSegment relationship.
+- :method: region_size
+  :type_hint: Integer
+  :column: region_size
+  :description: For mirrors
+- :method: regionsize
+  :type_hint: Integer
+  :column: regionsize
+  :description: For mirrors
+- :method: size
+  :type_hint: Integer
+  :column: seg_size
+  :description: Size of segment in current units.
+- :method: start
+  :type_hint: Integer
+  :column: seg_start
+  :description: Offset within the LV to the start of the segment in current units.
+- :method: tags
+  :type_hint: String
+  :column: seg_tags
+  :description: Tags
+- :method: segtype
+  :type_hint: String
+  :column: segtype
+  :description: Type of LV segment
+- :method: stripe_size
+  :type_hint: Integer
+  :column: stripe_size
+  :description: For stripes
+- :method: stripes
+  :type_hint: Integer
+  :column: stripes
+  :description: Number of stripes or mirror legs.
+- :method: stripesize
+  :type_hint: Integer
+  :column: stripesize
+  :description: For stripes