innodb_ruby 0.8.1 → 0.8.5

data/AUTHORS.md

@@ -0,0 +1,12 @@
+# Primary Authors #
+
+The primary authors of `innodb_ruby` have been:
+
+* Jeremy Cole \<jeremy@jcole.us\>
+* Davi Arnaut \<davi.arnaut@gmail.com\>
+
+# Contributors #
+
+Special thanks to the following contributors who have taken an interest and contributed their fixes:
+
+* Andrew Gaul \<gaul@maginatics.com\>

data/LICENSE

@@ -0,0 +1,29 @@
+This software is licensed under the Revised (3-clause) BSD license as follows:
+
+Copyright (c) 2013, Twitter, Inc.
+Copyright (c) 2013, Jeremy Cole <jeremy@jcole.us>
+Copyright (c) 2013, Davi Arnaut <davi.arnaut@gmail.com>
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the <organization> nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/bin/innodb_log

@@ -1,12 +1,62 @@
 #!/usr/bin/env ruby
 
+require "getoptlong"
+require "ostruct"
+require "set"
 require "innodb"
 
+def usage(exit_code, message = nil)
+  print "Error: #{message}\n" unless message.nil?
+
+  print <<'END_OF_USAGE'
+
+Usage: innodb_log [-d] [-s] <file> [block-number]
+
+  --help, -?
+    Print this usage text.
+
+  --dump-blocks, -d
+    Dump block header, trailer, and record.
+
+  --space-id, -s
+    Print only given space id (may provide multiple times).
+
+END_OF_USAGE
+
+  exit exit_code
+end
+
+@options = OpenStruct.new
+@options.dump = false
+@options.space_ids = Set.new
+
+getopt_options = [
+  [ "--help",                   "-?",     GetoptLong::NO_ARGUMENT ],
+  [ "--dump-blocks",            "-d",     GetoptLong::NO_ARGUMENT ],
+  [ "--space-id",               "-s",     GetoptLong::REQUIRED_ARGUMENT ],
+]
+
+getopt = GetoptLong.new(*getopt_options)
+
+getopt.each do |opt, arg|
+  case opt
+  when "--help"
+    usage 0
+  when "--dump-blocks"
+    @options.dump = true
+  when "--space-id"
+    @options.space_ids << Integer(arg)
+  end
+end
+
 filename, block_number = ARGV.shift(2)
+if filename.nil?
+  usage 1
+end
 
 log = Innodb::Log.new(filename)
 
-puts "%-10s%-20s%-10s%-10s" % [
+puts "%-10s%-30s%-10s%-10s" % [
   "block",
   "type",
   "space",
@@ -14,12 +64,17 @@ puts "%-10s%-20s%-10s%-10s" % [
 ]
 log.each_block do |block_number, block|
   if block.record
-    puts "%-10i%-20s%-10i%-10i" % [
-      block_number,
-      block.record[:type],
-      block.record[:space],
-      block.record[:page_number],
-    ]
-    #block.dump
+    space_id = block.record[:space]
+    if @options.space_ids.empty? or @options.space_ids.include?(space_id)
+      puts "%-10i%-30s%-10i%-10i" % [
+        block_number,
+        block.record[:type],
+        space_id,
+        block.record[:page_number],
+      ]
+      if @options.dump
+        block.dump
+      end
+    end
   end
-end
+end

data/bin/innodb_space

@@ -386,16 +386,16 @@ def page_directory_summary(page)
 
   page.directory.each_with_index do |offset, slot|
     record = page.record(offset)
-    key = if [:conventional, :node_pointer].include? record[:header][:type]
-      if record[:key]
-        "(%s)" % record[:key].map { |r| "%s=%s" % [r[:name], r[:value]] }.join(", ")
+    key = if [:conventional, :node_pointer].include? record.header[:type]
+      if record.key
+        "(%s)" % record.key.map { |r| "%s=%s" % [r[:name], r[:value]] }.join(", ")
       end
     end
     puts "%-8i%-8i%-14s%-8i%s" % [
       slot,
       offset,
-      record[:header][:type],
-      record[:header][:n_owned],
+      record.header[:type],
+      record.header[:n_owned],
       key,
     ]
   end
@@ -443,8 +443,8 @@ def index_recurse(index)
         page.each_record do |record|
           puts "%sRECORD: (%s) -> (%s)" % [
             "  " * (depth+1),
-            record[:key].map { |r| "%s=%s" % [r[:name], r[:value]] }.join(", "),
-            record[:row].map { |r| "%s=%s" % [r[:name], r[:value]] }.join(", "),
+            record.key.map { |r| "%s=%s" % [r[:name], r[:value]] }.join(", "),
+            record.row.map { |r| "%s=%s" % [r[:name], r[:value]] }.join(", "),
           ]
         end
       end
@@ -459,6 +459,26 @@ def index_recurse(index)
   )
 end
 
+def index_record_offsets(index)
+  puts "%-20s%-20s" % [
+    "page_offset",
+    "record_offset",
+  ]
+  index.recurse(
+    lambda do |page, depth|
+      if page.level == 0
+        page.each_record do |record|
+          puts "%-20i%-20i" % [
+            page.offset,
+            record.offset,
+          ]
+        end
+      end
+    end,
+    lambda { |*x| }
+  )
+end
+
 def index_digraph(index)
   puts "digraph btree {"
   puts "  rankdir = LR;"
@@ -513,7 +533,7 @@ def index_level_summary(index, levels)
         page.record_space,
         page.free_space,
         page.records,
-        page.first_record[:key].map { |r| r[:value] }.join("|"),
+        page.first_record.key.map { |r| r[:value] }.join("|"),
       ]
     end
   end
@@ -543,7 +563,7 @@ Usage: innodb_space -f <file> [-p <page>] [-l <level>] <mode> [<mode>, ...]
     Operate on the level <level>; may be specified more than once.
 
   --list, -L <list>
-    Operate  on the list <list>; may be specified more than once.
+    Operate on the list <list>; may be specified more than once.
 
   --require, -r <file>
     Use Ruby's "require" to load the file <file>. This is useful for loading
@@ -576,9 +596,9 @@ The following modes are supported:
     provide an overall view of the space and allocations within it. A starting
     page number can be provided with the --page/-p argument.
 
- space-page-type-summary
-   Summarize all pages by type. A starting page number can be provided with
-   the --page/-p argument.
+  space-page-type-summary
+    Summarize all pages by type. A starting page number can be provided with
+    the --page/-p argument.
 
   space-indexes
     Summarize all indexes (actually each segment of the indexes) to show
@@ -615,6 +635,10 @@ The following modes are supported:
     pages. A record describer must be provided with the --describer/-d argument
     to recurse indexes (in order to parse node pages).
 
+  index-record-offsets
+    Recurse an index as index-recurse does, but print the offsets of each
+    record within the page.
+
   index-digraph
     Recurse an index as index-recurse does, but print a dot-compatible digraph
     instead of a human-readable summary.
@@ -649,23 +673,29 @@ Signal.trap("INT")  { exit }
 Signal.trap("PIPE") { exit }
 
 @options = OpenStruct.new
-@options.file   = nil
-@options.page_size = nil
-@options.pages  = []
-@options.levels = []
-@options.lists  = []
-@options.describer = nil
+@options.system_space_file      = nil
+@options.space_file             = nil
+@options.table_name             = nil
+@options.index_name             = nil
+@options.pages                  = []
+@options.levels                 = []
+@options.lists                  = []
+@options.page_size              = nil
+@options.describer              = nil
 
 getopt_options = [
-  [ "--help",             "-?",     GetoptLong::NO_ARGUMENT ],
-  [ "--trace",            "-t",     GetoptLong::NO_ARGUMENT ],
-  [ "--file",             "-f",     GetoptLong::REQUIRED_ARGUMENT ],
-  [ "--page-size",        "-P",     GetoptLong::REQUIRED_ARGUMENT ],
-  [ "--page",             "-p",     GetoptLong::REQUIRED_ARGUMENT ],
-  [ "--level",            "-l",     GetoptLong::REQUIRED_ARGUMENT ],
-  [ "--list",             "-L",     GetoptLong::REQUIRED_ARGUMENT ],
-  [ "--require",          "-r",     GetoptLong::REQUIRED_ARGUMENT ],
-  [ "--describer",        "-d",     GetoptLong::REQUIRED_ARGUMENT ],
+  [ "--help",                   "-?",     GetoptLong::NO_ARGUMENT ],
+  [ "--trace",                  "-t",     GetoptLong::NO_ARGUMENT ],
+  [ "--system-space-file",      "-s",     GetoptLong::REQUIRED_ARGUMENT ],
+  [ "--space-file",             "-f",     GetoptLong::REQUIRED_ARGUMENT ],
+  [ "--table-name",             "-T",     GetoptLong::REQUIRED_ARGUMENT ],
+  [ "--index-name",             "-I",     GetoptLong::REQUIRED_ARGUMENT ],
+  [ "--page",                   "-p",     GetoptLong::REQUIRED_ARGUMENT ],
+  [ "--level",                  "-l",     GetoptLong::REQUIRED_ARGUMENT ],
+  [ "--list",                   "-L",     GetoptLong::REQUIRED_ARGUMENT ],
+  [ "--require",                "-r",     GetoptLong::REQUIRED_ARGUMENT ],
+  [ "--page-size",              "-P",     GetoptLong::REQUIRED_ARGUMENT ],
+  [ "--describer",              "-d",     GetoptLong::REQUIRED_ARGUMENT ],
 ]
 
 getopt = GetoptLong.new(*getopt_options)
@@ -678,13 +708,14 @@ getopt.each do |opt, arg|
     Innodb::Cursor.trace!
   when "--mode"
     @options.mode = arg
-  when "--file"
-    @options.file = arg
-  when "--page-size"
-    unless [1, 2, 4, 8, 16].include?(arg.to_i)
-      usage 1, "Page size #{arg} is not understood"
-    end
-    @options.page_size = arg.to_i * 1024
+  when "--system-space-file"
+    @options.system_space_file = arg
+  when "--space-file"
+    @options.space_file = arg
+  when "--table-name"
+    @options.table_name = arg
+  when "--index-name"
+    @options.index_name = arg
   when "--page"
     @options.pages << arg.to_i
   when "--level"
@@ -692,17 +723,27 @@ getopt.each do |opt, arg|
   when "--list"
     @options.lists << arg.to_sym
   when "--require"
-    require arg
+    require File.expand_path(arg)
+  when "--page-size"
+    unless [1, 2, 4, 8, 16].include?(arg.to_i)
+      usage 1, "Page size #{arg} is not understood"
+    end
+    @options.page_size = arg.to_i * 1024
   when "--describer"
     @options.describer = arg
   end
 end
 
-unless @options.file
-  usage 1, "File must be provided with -f argument"
+system_space = nil
+if @options.system_space_file
+  system_space = Innodb::Space.new(@options.system_space_file)
+end
+
+unless @options.space_file
+  usage 1, "Space file must be provided with -f argument"
 end
 
-space = Innodb::Space.new(@options.file, @options.page_size)
+space = Innodb::Space.new(@options.space_file, @options.page_size)
 
 if @options.describer
   describer = eval(@options.describer)
@@ -750,7 +791,7 @@ ARGV.each do |mode|
   when "space-index-pages-summary"
     space_index_pages_summary(space, @options.pages.first || 0)
   when "space-index-pages-free-plot"
-    name = File.basename(@options.file).sub(".ibd", "")
+    name = File.basename(@options.space_file).sub(".ibd", "")
     space_index_pages_free_plot(space, name, @options.pages.first || 0)
   when "space-page-type-regions"
     space_page_type_regions(space, @options.pages.first || 0)
@@ -778,7 +819,7 @@ ARGV.each do |mode|
     unless space.record_describer
       usage 1, "Record describer necessary for index recursion" 
     end
-    
+
     if @options.pages.empty?
       usage 1, "Page number of index root must be provided with --page/-p"
     end
@@ -786,11 +827,23 @@ ARGV.each do |mode|
     @options.pages.each do |page|
       index_recurse(space.index(page))
     end
+  when "index-record-offsets"
+    unless space.record_describer
+      usage 1, "Record describer necessary for index recursion" 
+    end
+
+    if @options.pages.empty?
+      usage 1, "Page number of index root must be provided with --page/-p"
+    end
+
+    @options.pages.each do |page|
+      index_record_offsets(space.index(page))
+    end
   when "index-digraph"
     unless space.record_describer
       usage 1, "Record describer necessary for index recursion" 
     end
-    
+
     if @options.pages.empty?
       usage 1, "Page number of index root must be provided with --page/-p"
     end
@@ -802,7 +855,7 @@ ARGV.each do |mode|
     unless space.record_describer
       usage 1, "Record describer necessary for index recursion" 
     end
-    
+
     if @options.pages.empty?
       usage 1, "Page number of index root must be provided with --page/-p"
     end

data/lib/innodb/checksum.rb

@@ -1,4 +1,5 @@
 # -*- encoding : utf-8 -*-
+
 class Innodb::Checksum
   MAX   = 0xFFFFFFFF.freeze
   MASK1 = 1463735687.freeze

data/lib/innodb/cursor.rb

@@ -1,4 +1,5 @@
 # -*- encoding : utf-8 -*-
+
 require "bindata"
 
 # A cursor to walk through InnoDB data structures to read fields.
@@ -270,78 +271,22 @@ class Innodb::Cursor
 
   # Read an InnoDB-compressed unsigned 32-bit integer.
   def get_ic_uint32
-    flag = peek { get_uint8 }
+    flag = peek { name("ic_uint32") { get_uint8 } }
 
     case
     when flag < 0x80
-      get_uint8
+      name("uint8") { get_uint8 }
     when flag < 0xc0
-      get_uint16 & 0x7fff
+      name("uint16") { get_uint16 } & 0x7fff
     when flag < 0xe0
-      get_uint24 & 0x3fffff
+      name("uint24") { get_uint24 } & 0x3fffff
     when flag < 0xf0
-      get_uint32 & 0x1fffffff
+      name("uint32") { get_uint32 } & 0x1fffffff
     when flag == 0xf0
       adjust(+1) # Skip the flag.
-      get_uint32
+      name("uint32+1") { get_uint32 }
     else
-      raise "Invalid flag #{flag.to_s(16)} seen"
-    end
-  end
-
-  # Read an InnoDB-munged signed 8-bit integer.
-  def get_i_sint8
-    data = read_and_advance(1)
-    BinData::Int8.read(data) ^ (-1 << 7)
-  end
-
-  # Read an InnoDB-munged signed 16-bit integer.
-  def get_i_sint16
-    data = read_and_advance(2)
-    BinData::Int16be.read(data) ^ (-1 << 15)
-  end
-
-  # Read an InnoDB-munged signed 24-bit integer.
-  def get_i_sint24
-    data = read_and_advance(3)
-    BinData::Int24be.read(data) ^ (-1 << 23)
-  end
-
-  # Read an InnoDB-munged signed 32-bit integer.
-  def get_i_sint32
-    data = read_and_advance(4)
-    BinData::Int32be.read(data) ^ (-1 << 31)
-  end
-
-  # Read an InnoDB-munged signed 48-bit integer.
-  def get_i_sint48
-    data = read_and_advance(6)
-    BinData::Int48be.read(data) ^ (-1 << 47)
-  end
-
-  # Read an InnoDB-munged signed 64-bit integer.
-  def get_i_sint64
-    data = read_and_advance(8)
-    BinData::Int64be.read(data) ^ (-1 << 63)
-  end
-
-  # Read an InnoDB-munged signed integer given its size in bytes.
-  def get_i_sint_by_size(size)
-    case size
-    when 1
-      get_i_sint8
-    when 2
-      get_i_sint16
-    when 3
-      get_i_sint24
-    when 4
-      get_i_sint32
-    when 6
-      get_i_sint48
-    when 8
-      get_i_sint64
-    else
-      raise "Not implemented"
+      raise "Invalid flag #{flag.to_s} seen"
     end
   end
 

data/lib/innodb/data_dictionary.rb

@@ -1,3 +1,5 @@
+# -*- encoding : utf-8 -*-
+
 class Innodb::DataDictionary
   # A record describer for SYS_TABLES clustered records.
   class SYS_TABLES_PRIMARY < Innodb::RecordDescriber