innodb_ruby 0.7.11 → 0.7.12

data/lib/innodb/record_describer.rb

@@ -1,2 +1,3 @@
+# -*- encoding : utf-8 -*-
 # An empty class in order to establish the Innodb::RecordDescriber namespace.
-class Innodb::RecordDescriber; end
+class Innodb::RecordDescriber; end

data/lib/innodb/space.rb

@@ -1,10 +1,25 @@
-# An InnoDB tablespace file, which can be either a multi-table ibdataN file
+# -*- encoding : utf-8 -*-
+# An InnoDB space file, which can be either a multi-table ibdataN file
 # or a single-table "innodb_file_per_table" .ibd file.
 class Innodb::Space
   # InnoDB's default page size is 16KiB.
   DEFAULT_PAGE_SIZE = 16384
 
-  # Open a tablespace file, optionally providing the page size to use. Pages
+  # A map of InnoDB system space fixed-allocation pages. This can be used to
+  # check whether a space is a system space or not, as non-system spaces will
+  # not match this pattern.
+  SYSTEM_SPACE_PAGE_MAP = {
+    0 => :FSP_HDR,
+    1 => :IBUF_BITMAP,
+    2 => :INODE,
+    3 => :SYS,
+    4 => :INDEX,
+    5 => :TRX_SYS,
+    6 => :SYS,
+    7 => :SYS,
+  }
+
+  # Open a space file, optionally providing the page size to use. Pages
   # that aren't 16 KiB may not be supported well.
   def initialize(file, page_size=nil)
     @file = File.open(file)
@@ -91,6 +106,24 @@ class Innodb::Space
     (0..(@pages / pages_per_xdes_page)).map { |n| n * pages_per_xdes_page }
   end
 
+  # The FSP_HDR/XDES page which will contain the XDES entry for a given page.
+  def xdes_page_for_page(page_number)
+    page_number - (page_number % pages_per_xdes_page)
+  end
+
+  # The XDES entry offset for a given page within its FSP_HDR/XDES page's
+  # XDES array.
+  def xdes_entry_for_page(page_number)
+    relative_page_number = page_number - xdes_page_for_page(page_number)
+    relative_page_number / pages_per_extent
+  end
+
+  # Return the Innodb::Xdes entry which represents a given page.
+  def xdes_for_page(page_number)
+    xdes_array = page(xdes_page_for_page(page_number)).each_xdes.to_a
+    xdes_array[xdes_entry_for_page(page_number)]
+  end
+
   # Get the raw byte buffer of size bytes at offset in the file.
   def read_at_offset(offset, size)
     @file.seek(offset)
@@ -116,19 +149,56 @@ class Innodb::Space
     this_page
   end
 
+  # Determine whether this space looks like a system space. If the initial
+  # pages in the space match the SYSTEM_SPACE_PAGE_MAP, it is likely to be
+  # a system space.
+  def system_space?
+    SYSTEM_SPACE_PAGE_MAP.each do |page_number, type|
+      # We can't use page() here, because system_space? need to be used
+      # in the Innodb::Page::Sys.parse to determine what type of page
+      # is being looked at. Using page() would cause us to keep recurse
+      # infinitely. Use Innodb::Page.new instead to load the page as
+      # simply as possible.
+      test_page = Innodb::Page.new(self, page_data(page_number))
+      return false unless test_page.type == type
+    end
+    true
+  end
+
   # Get (and cache) the FSP header from the FSP_HDR page.
   def fsp
     @fsp ||= page(0).fsp_header
   end
 
+  # Get the Innodb::Page::TrxSys page for a system space.
+  def trx_sys
+    page(5) if system_space?
+  end
+
+  def rseg_page?(page_number)
+    if trx_sys
+      trx_sys.rsegs.include?({
+        :space_id => 0,
+        :page_number => page_number,
+      })
+    end
+  end
+
+  # Get the Innodb::Page::SysDataDictionaryHeader page for a system space.
+  def data_dictionary
+    page(7) if system_space?
+  end
+
   # Get an Innodb::List object for a specific list by list name.
   def list(name)
-    fsp[name]
+    if xdes_lists.include?(name) || inode_lists.include?(name)
+      fsp[name]
+    end
   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)
+  def index(root_page_number, record_describer=nil)
+    Innodb::Index.new(self, root_page_number, record_describer || @record_describer)
   end
 
   # Iterate through each index by guessing that the root pages will be
@@ -140,18 +210,55 @@ class Innodb::Space
       return enum_for(:each_index)
     end
 
-    (3...@pages).each do |page_number|
-      page = page(page_number)
-      if page.type == :INDEX && page.root?
-        yield index(page_number)
-      else
-        break
+    if system_space?
+      data_dictionary.each_index do |table_name, index_name, index|
+        yield index
+      end
+    else
+      (3...@pages).each do |page_number|
+        page = page(page_number)
+        if page.type == :INDEX && page.root?
+          yield index(page_number)
+        else
+          break
+        end
       end
     end
   end
 
-  # Iterate through all pages in a tablespace, returning the page number
-  # and an Innodb::Page object for each one.
+  # An array of Innodb::Inode list names.
+  def inode_lists
+    [:full_inodes, :free_inodes]
+  end
+
+  # Iterate through Innodb::Inode lists in the space.
+  def each_inode_list
+    unless block_given?
+      return enum_for(:each_inode_list)
+    end
+
+    inode_lists.each do |name|
+      yield name, list(name)
+    end
+  end
+
+  # Iterate through Innodb::Inode objects in the space.
+  def each_inode
+    unless block_given?
+      return enum_for(:each_inode)
+    end
+
+    each_inode_list.each do |name, list|
+      list.each do |page|
+        page.each_inode do |inode|
+          yield inode
+        end
+      end
+    end
+  end
+
+  # Iterate through all pages in a space, returning the page number and an
+  # Innodb::Page object for each one.
   def each_page(start_page=0)
     unless block_given?
       return enum_for(:each_page, start_page)
@@ -163,6 +270,22 @@ class Innodb::Space
     end
   end
 
+  # An array of Innodb::Xdes list names. 
+  def xdes_lists
+    [:free, :free_frag, :full_frag]
+  end
+
+  # Iterate through Innodb::Xdes lists in the space.
+  def each_xdes_list
+    unless block_given?
+      return enum_for(:each_xdes_list)
+    end
+
+    xdes_lists.each do |name|
+      yield name, list(name)
+    end
+  end
+
   # Iterate through all FSP_HDR/XDES pages, returning an Innodb::Page object
   # for each one.
   def each_xdes_page
@@ -192,16 +315,38 @@ class Innodb::Space
     end
   end
 
+  def each_page_status(start_page=0)
+    unless block_given?
+      return enum_for(:each_page_with_status, start_page)
+    end
+
+    each_xdes do |xdes|
+      xdes.each_page_status do |page_number, page_status|
+        next if page_number < start_page
+        next if page_number >= @pages
+
+        if this_page = page(page_number)
+          yield page_number, this_page, page_status
+        end
+      end
+    end
+  end
+
+  def type_for_page(page, page_status)
+    page_status[:free] ? "FREE (#{page.type})" : page.type
+  end
+
   # Iterate through unique regions in the space by page type. This is useful
   # to achieve an overall view of the space.
   def each_page_type_region(start_page=0)
     unless block_given?
-      return enum_for(:each_page_type_region)
+      return enum_for(:each_page_type_region, start_page)
     end
 
     region = nil
-    each_page(start_page) do |page_number, page|
-      if region && region[:type] == page.type
+    each_page_status(start_page) do |page_number, page, page_status|
+      page_type = type_for_page(page, page_status)
+      if region && region[:type] == page_type
         region[:end] = page_number
         region[:count] += 1
       else
@@ -209,7 +354,7 @@ class Innodb::Space
         region = {
           :start => page_number,
           :end   => page_number,
-          :type  => page.type,
+          :type  => page_type,
           :count => 1,
         }
       end

data/lib/innodb/undo_log.rb

@@ -0,0 +1,73 @@
+
+class Innodb::UndoLog
+  attr_reader :page
+  attr_reader :position
+  def initialize(page, position)
+    @page = page
+    @position = position
+  end
+
+  def size_xa_header
+    4 + 4 + 4 + 128
+  end
+
+  def size_header
+    8 + 8 + 2 + 2 + 1 + 1 + 8 + 2 + 2 + Innodb::List::NODE_SIZE + size_xa_header
+  end
+
+  def read_header(cursor)
+    cursor.name("header") do |c|
+      xid_exists = nil
+      {
+        :trx_id => c.name("trx_id") { c.get_hex(8) },
+        :trx_no => c.name("trx_no") { c.get_uint64 },
+        :delete_marks => c.name("delete_marks") { (c.get_uint16 != 0) },
+        :log_start => c.name("log_start") { c.get_uint16 },
+        :xid_exists => c.name("xid_exists") { xid_exists = (c.get_uint8 != 0) },
+        :dict_trans => c.name("dict_trans") { (c.get_uint8 != 0) },
+        :table_id => c.name("table_id") { c.get_uint64 },
+        :next_log => c.name("next_log") { c.get_uint16 },
+        :prev_log => c.name("prev_log") { c.get_uint16 },
+        :history_list_node => c.name("history_list_node") {
+          Innodb::List.get_node(c)
+        },
+        :xid => c.name("xid") {
+          if xid_exists
+            {
+              :format => c.name("format") { c.get_uint32 },
+              :trid_len => c.name("trid_len") { c.get_uint32 },
+              :bqual_len => c.name("bqual_len") { c.get_uint32 },
+              :data => c.name("data") { c.get_bytes(128) },
+            }
+          end
+        },
+      }
+    end
+  end
+
+  def undo_log
+    @undo_log ||= page.cursor(position).name("undo_log") do |c|
+      {
+        :header => read_header(c),
+      }
+    end
+  end
+
+  def header
+    undo_log[:header]
+  end
+
+  def prev_address
+    header[:history_list_node][:prev]
+  end
+
+  def next_address
+    header[:history_list_node][:next]
+  end
+
+  def dump
+    puts "header:"
+    pp header
+    puts
+  end
+end

data/lib/innodb/version.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Innodb
-  VERSION = "0.7.11"
+  VERSION = "0.7.12"
 end

data/lib/innodb/xdes.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # An InnoDB "extent descriptor entry" or "+XDES+". These structures are used
 # in the +XDES+ entry array contained in +FSP_HDR+ and +XDES+ pages.
 #
@@ -58,14 +59,17 @@ class Innodb::Xdes
   def read_xdes_entry(page, cursor)
     extent_number = (cursor.position - page.pos_xdes_array) / size_entry
     start_page = page.offset + (extent_number * page.space.pages_per_extent)
-    {
-      :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(size_bitmap),
-    }
+    cursor.name("xdes[#{extent_number}]") do |c|
+      {
+        :start_page => start_page,
+        :end_page   => start_page + page.space.pages_per_extent - 1,
+        :fseg_id    => c.name("fseg_id") { c.get_uint64 },
+        :this       => {:page => page.offset, :offset => c.position},
+        :list       => c.name("list") { Innodb::List.get_node(c) },
+        :state      => c.name("state") { STATES[c.get_uint32] },
+        :bitmap     => c.name("bitmap") { c.get_bytes(size_bitmap) },
+      }
+    end
   end
 
   # Return the stored extent descriptor entry.
@@ -73,6 +77,27 @@ class Innodb::Xdes
     @xdes
   end
 
+  def start_page; @xdes[:start_page]; end
+  def end_page;   @xdes[:end_page];   end
+  def fseg_id;    @xdes[:fseg_id];    end
+  def this;       @xdes[:this];       end
+  def list;       @xdes[:list];       end
+  def state;      @xdes[:state];      end
+  def bitmap;     @xdes[:bitmap];     end
+
+  # Return whether this XDES entry is allocated to an fseg (the whole extent
+  # then belongs to the fseg).
+  def allocated_to_fseg?
+    fseg_id != 0
+  end
+
+  # Return the status for a given page. This is relatively inefficient as
+  # implemented and could be done better.
+  def page_status(page_number)
+    page_status_array = each_page_status.to_a
+    page_status_array[page_number - xdes[:start_page]][1]
+  end
+
   # Iterate through all pages represented by this extent descriptor,
   # yielding a page status hash for each page, containing the following
   # fields:
@@ -93,11 +118,10 @@ class Innodb::Xdes
         page_number = xdes[:start_page] + (byte_index * 4) + page_index
         page_bits = ((byte >> (page * BITS_PER_PAGE)) & BITMAP_BV_ALL)
         page_status = {
-          :page   => page_number,
           :free   => (page_bits & BITMAP_BV_FREE  != 0),
           :clean  => (page_bits & BITMAP_BV_CLEAN != 0),
         }
-        yield page_status
+        yield page_number, page_status
       end
     end
 
@@ -106,7 +130,10 @@ class Innodb::Xdes
 
   # Return the count of free pages (free bit is true) on this extent.
   def free_pages
-    each_page_status.inject(0) { |sum, p| sum += 1 if p[:free]; sum }
+    each_page_status.inject(0) do |sum, (page_number, page_status)|
+      sum += 1 if page_status[:free]
+      sum
+    end
   end
 
   # Return the count of used pages (free bit is false) on this extent.
@@ -127,4 +154,10 @@ class Innodb::Xdes
   def next_address
     xdes[:list][:next]
   end
+
+  # Compare one Innodb::Xdes to another.
+  def ==(other)
+    xdes[:this][:page] == other.xdes[:this][:page] &&
+      xdes[:this][:offset] == other.xdes[:this][:offset]
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: innodb_ruby
 version: !ruby/object:Gem::Version
-  version: 0.7.11
+  version: 0.7.12
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-15 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
-  requirement: &70308829886920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,12 @@ dependencies:
         version: 1.4.5
   type: :runtime
   prerelease: false
-  version_requirements: *70308829886920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.5
 description: Library for parsing InnoDB data files in Ruby
 email: jeremy@jcole.us
 executables:
@@ -32,20 +37,29 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/innodb.rb
+- lib/innodb/checksum.rb
 - lib/innodb/cursor.rb
 - lib/innodb/field.rb
+- lib/innodb/field_type.rb
 - lib/innodb/fseg_entry.rb
 - lib/innodb/index.rb
+- lib/innodb/inode.rb
 - lib/innodb/list.rb
 - lib/innodb/log.rb
 - lib/innodb/log_block.rb
 - lib/innodb/page.rb
+- lib/innodb/page/blob.rb
 - lib/innodb/page/fsp_hdr_xdes.rb
 - lib/innodb/page/index.rb
 - lib/innodb/page/inode.rb
+- lib/innodb/page/sys.rb
+- lib/innodb/page/sys_data_dictionary_header.rb
+- lib/innodb/page/sys_rseg_header.rb
 - lib/innodb/page/trx_sys.rb
+- lib/innodb/page/undo_log.rb
 - lib/innodb/record_describer.rb
 - lib/innodb/space.rb
+- lib/innodb/undo_log.rb
 - lib/innodb/version.rb
 - lib/innodb/xdes.rb
 - bin/innodb_log
@@ -70,9 +84,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: InnoDB data file parser
 test_files: []
-has_rdoc: