innodb_ruby 0.6.6 → 0.7.1

data/lib/innodb/page/inode.rb

@@ -1,17 +1,30 @@
-require "innodb/free_list"
+require "innodb/list"
 
+# A specialized class for handling INODE pages, which contain index FSEG (file
+# segment) information. This allows all extents and individual pages assigned
+# to each index to be found.
 class Innodb::Page::Inode < Innodb::Page
+  # The number of "slots" (each representing one page) in the fragment array
+  # within each Inode entry.
   FRAG_ARRAY_N_SLOTS  = 32 # FSP_EXTENT_SIZE / 2
+
+  # The size (in bytes) of each slot in the fragment array.
   FRAG_SLOT_SIZE      = 4
 
+  # A magic number which helps determine if an Inode structure is in use
+  # and populated with valid data.
   MAGIC_N_VALUE	= 97937874
 
+  def pos_inode_list_entry
+    pos_fil_header + size_fil_header
+  end
+
   def pos_inode_list
-    pos_fil_header + size_fil_header + Innodb::FreeList::NODE_SIZE
+    pos_fil_header + size_fil_header + Innodb::List::NODE_SIZE
   end
 
   def size_inode
-    (16 + (3 * Innodb::FreeList::BASE_NODE_SIZE) +
+    (16 + (3 * Innodb::List::BASE_NODE_SIZE) +
       (FRAG_ARRAY_N_SLOTS * FRAG_SLOT_SIZE))
   end
 
@@ -19,22 +32,42 @@ class Innodb::Page::Inode < Innodb::Page
     (size - pos_inode_list - 10) / size_inode
   end
 
-  def uint32_array(size, cursor)
-    size.times.map { |n| cursor.get_uint32 }
+  def page_number_array(size, cursor)
+    size.times.map { |n| Innodb::Page.maybe_undefined(cursor.get_uint32) }
+  end
+
+  def list_entry
+    c = cursor(pos_inode_list_entry)
+    Innodb::List.get_node(c)
+  end
+
+  def prev_address
+    list_entry[:prev]
+  end
+
+  def next_address
+    list_entry[:next]
   end
 
   def inode(cursor)
     {
       :fseg_id            => cursor.get_uint64,
       :not_full_n_used    => cursor.get_uint32,
-      :free               => Innodb::FreeList.get_base_node(cursor),
-      :not_full           => Innodb::FreeList.get_base_node(cursor),
-      :full               => Innodb::FreeList.get_base_node(cursor),
+      :free               => Innodb::List::Xdes.new(@space,
+                              Innodb::List.get_base_node(cursor)),
+      :not_full           => Innodb::List::Xdes.new(@space,
+                              Innodb::List.get_base_node(cursor)),
+      :full               => Innodb::List::Xdes.new(@space,
+                              Innodb::List.get_base_node(cursor)),
       :magic_n            => cursor.get_uint32,
-      :frag_array         => uint32_array(FRAG_ARRAY_N_SLOTS, cursor),
+      :frag_array         => page_number_array(FRAG_ARRAY_N_SLOTS, cursor),
     }
   end
 
+  def inode_at(offset)
+    inode(cursor(offset))
+  end
+
   def each_inode
     inode_cursor = cursor(pos_inode_list)
     inodes_per_page.times do
@@ -46,6 +79,10 @@ class Innodb::Page::Inode < Innodb::Page
   def dump
     super
 
+    puts "list entry:"
+    pp list_entry
+    puts
+
     puts "inodes:"
     each_inode do |i|
       pp i

data/lib/innodb/page/trx_sys.rb

@@ -1,22 +1,41 @@
+# A specialized class for TRX_SYS pages, which contain various information
+# about the transaction system within InnoDB. Only one TRX_SYS page exists in
+# any given InnoDB installation, and it is page 5 of the system tablespace
+# (space 0), most commonly named "ibdata1".
+#
+# The basic structure of a TRX_SYS page is: FIL header, TRX_SYS header,
+# empty space, master binary log information, empty space, local binary
+# log information, empty space, doublewrite information (repeated twice),
+# empty space, and FIL trailer.
 class Innodb::Page::TrxSys < Innodb::Page
+  # The TRX_SYS header immediately follows the FIL header.
   def pos_trx_sys_header
     pos_fil_header + size_fil_header
   end
 
-  def pos_mysql_binary_log_info
-    size - 1000
-  end
-
+  # The master's binary log information is located 2000 bytes from the end of
+  # the page.
   def pos_mysql_master_log_info
     size - 2000
   end
 
+  # The local binary log information is located 1000 bytes from the end of
+  # the page.
+  def pos_mysql_binary_log_info
+    size - 1000
+  end
+
+  # The doublewrite buffer information is located 200 bytes from the end of
+  # the page.
   def pos_doublewrite_info
     size - 200
   end
 
+  # A magic number present in each MySQL binary log information structure,
+  # which helps identify whether the structure is populated or not.
   MYSQL_LOG_MAGIC_N = 873422344
 
+  # Read a MySQL binary log information structure from a given position.
   def mysql_log_info(offset)
     c = cursor(offset)
     if c.get_uint32 == MYSQL_LOG_MAGIC_N
@@ -27,8 +46,11 @@ class Innodb::Page::TrxSys < Innodb::Page
     end
   end
 
+  # A magic number present in each doublewrite buffer information structure,
+  # which helps identify whether the structure is populated or not.
   DOUBLEWRITE_MAGIC_N = 536853855
 
+  # Read a single doublewrite buffer information structure from a given cursor.
   def doublewrite_page_info(cursor)
     {
       :magic_n => cursor.get_uint32,
@@ -39,12 +61,15 @@ class Innodb::Page::TrxSys < Innodb::Page
     }
   end
 
+  # A magic number present in the overall doublewrite buffer structure,
+  # which identifies whether the space id is stored.
   DOUBLEWRITE_SPACE_ID_STORED_MAGIC_N = 1783657386
 
+  # Read the overall doublewrite buffer structures
   def doublewrite_info
     c = cursor(pos_doublewrite_info)
     {
-      :fseg => Innodb::FsegEntry.get_entry(c),
+      :fseg => Innodb::FsegEntry.get_inode(@space, c),
       :page_info => [
         doublewrite_page_info(c),
         doublewrite_page_info(c),
@@ -53,14 +78,15 @@ class Innodb::Page::TrxSys < Innodb::Page
     }
   end
 
+  # Read the TRX_SYS headers and other information.
   def trx_sys
     c = cursor(pos_trx_sys_header)
     @trx_sys ||= {
-      :trx_id            => c.get_uint64,
-      :fseg        => Innodb::FsegEntry.get_entry(c),
-      :binary_log => mysql_log_info(pos_mysql_binary_log_info),
-      :master_log => mysql_log_info(pos_mysql_master_log_info),
-      :doublewrite => doublewrite_info,
+      :trx_id       => c.get_uint64,
+      :fseg         => Innodb::FsegEntry.get_inode(@space, c),
+      :binary_log   => mysql_log_info(pos_mysql_binary_log_info),
+      :master_log   => mysql_log_info(pos_mysql_master_log_info),
+      :doublewrite  => doublewrite_info,
     }
   end
 

data/lib/innodb/space.rb

@@ -22,7 +22,7 @@ class Innodb::Space
     return nil unless (offset + PAGE_SIZE) <= @size
     @file.seek(offset)
     page_data = @file.read(PAGE_SIZE)
-    this_page = Innodb::Page.parse(page_data)
+    this_page = Innodb::Page.parse(self, page_data)
 
     if this_page.type == :INDEX
       this_page.record_describer = @record_describer
@@ -31,6 +31,11 @@ class Innodb::Space
     this_page
   end
 
+  # Get an Innodb::List object for a specific list by list name.
+  def list(name)
+    page(0).fsp_header[name]
+  end
+
   # Get an Innodb::Index object for a specific index by root page number.
   def index(root_page_number)
     Innodb::Index.new(self, root_page_number)

data/lib/innodb/version.rb

@@ -1,3 +1,3 @@
 module Innodb
-  VERSION = "0.6.6"
+  VERSION = "0.7.1"
 end

data/lib/innodb/xdes.rb

@@ -0,0 +1,39 @@
+class Innodb::Xdes
+  PAGES_PER_EXTENT = 64
+  BITS_PER_PAGE = 2
+  BITMAP_SIZE = (PAGES_PER_EXTENT * BITS_PER_PAGE) / 8
+  ENTRY_SIZE = 8 + Innodb::List::NODE_SIZE + 4 + BITMAP_SIZE
+
+  STATES = {
+    1 => :free,
+    2 => :free_frag,
+    3 => :full_frag,
+    4 => :fseg,
+  }
+
+  def initialize(page, cursor)
+    @page = page
+    extent_number = (cursor.position - page.pos_xdes_array) / ENTRY_SIZE
+    start_page = page.offset + (extent_number * PAGES_PER_EXTENT)
+    @xdes = {
+      :start_page => start_page,
+      :fseg_id    => cursor.get_uint64,
+      :this       => {:page => page.offset, :offset => cursor.position},
+      :list       => Innodb::List.get_node(cursor),
+      :state      => STATES[cursor.get_uint32],
+      :bitmap     => cursor.get_bytes(BITMAP_SIZE),
+    }
+  end
+
+  def xdes
+    @xdes
+  end
+
+  def prev_address
+    @xdes[:list][:prev]
+  end
+
+  def next_address
+    @xdes[:list][:next]
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: innodb_ruby
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 1
   prerelease: 
   segments: 
   - 0
-  - 6
-  - 6
-  version: 0.6.6
+  - 7
+  - 1
+  version: 0.7.1
 platform: ruby
 authors: 
 - Jeremy Cole
@@ -15,9 +15,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-12-07 00:00:00 Z
-dependencies: []
-
+date: 2012-12-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bindata
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 4
+        - 5
+        version: 1.4.5
+  type: :runtime
+  version_requirements: *id001
 description: Library for parsing InnoDB data files in Ruby
 email: jeremy@jcole.us
 executables: 
@@ -28,11 +43,13 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- README.md
 - lib/innodb.rb
 - lib/innodb/cursor.rb
-- lib/innodb/free_list.rb
+- lib/innodb/field.rb
 - lib/innodb/fseg_entry.rb
 - lib/innodb/index.rb
+- lib/innodb/list.rb
 - lib/innodb/log.rb
 - lib/innodb/log_block.rb
 - lib/innodb/page.rb
@@ -43,6 +60,7 @@ files:
 - lib/innodb/record_describer.rb
 - lib/innodb/space.rb
 - lib/innodb/version.rb
+- lib/innodb/xdes.rb
 - bin/innodb_log
 - bin/innodb_space
 homepage: http://jcole.us/

data/lib/innodb/free_list.rb

@@ -1,27 +0,0 @@
-class Innodb::FreeList
-  FIL_ADDR_SIZE   = 4 + 2
-  NODE_SIZE       = 2 * FIL_ADDR_SIZE
-  BASE_NODE_SIZE  = 4 + (2 * FIL_ADDR_SIZE)
-
-  def self.get_address(cursor)
-    {
-      :page     => Innodb::Page.maybe_undefined(cursor.get_uint32),
-      :offset   => cursor.get_uint16,
-    }
-  end
-
-  def self.get_node(cursor)
-    {
-      :prev => Innodb::FreeList::get_address(cursor),
-      :next => Innodb::FreeList::get_address(cursor),
-    }
-  end
-
-  def self.get_base_node(cursor)
-    {
-      :length => cursor.get_uint32,
-      :first  => Innodb::FreeList::get_address(cursor),
-      :last   => Innodb::FreeList::get_address(cursor),
-    }
-  end
-end