innodb_ruby 0.9.16 → 0.11.0

data/lib/innodb/page/sys_ibuf_header.rb

@@ -1,45 +1,48 @@
-# -*- encoding : utf-8 -*-
-
-class Innodb::Page::SysIbufHeader < Innodb::Page
-  def pos_ibuf_header
-    pos_page_body
-  end
-
-  def size_ibuf_header
-    Innodb::FsegEntry::SIZE
-  end
-
-  def ibuf_header
-    cursor(pos_ibuf_header).name("ibuf_header") do |c|
-      {
-        :fseg => c.name("fseg") {
-          Innodb::FsegEntry.get_inode(space, c)
-        }
-      }
-    end
-  end
-
-  def each_region
-    unless block_given?
-      return enum_for(:each_region)
-    end
-
-    super do |region|
-      yield region
+# frozen_string_literal: true
+
+module Innodb
+  class Page
+    class SysIbufHeader < Page
+      Header = Struct.new(
+        :fseg,
+        keyword_init: true
+      )
+
+      def pos_ibuf_header
+        pos_page_body
+      end
+
+      def size_ibuf_header
+        Innodb::FsegEntry::SIZE
+      end
+
+      def ibuf_header
+        cursor(pos_ibuf_header).name("ibuf_header") do |c|
+          Header.new(
+            fseg: c.name("fseg") { Innodb::FsegEntry.get_inode(space, c) }
+          )
+        end
+      end
+
+      def each_region(&block)
+        return enum_for(:each_region) unless block_given?
+
+        super(&block)
+
+        yield Region.new(
+          offset: pos_ibuf_header,
+          length: size_ibuf_header,
+          name: :ibuf_header,
+          info: "Insert Buffer Header"
+        )
+      end
+
+      def dump
+        super
+
+        puts "ibuf header:"
+        pp ibuf_header
+      end
     end
-
-    yield({
-      :offset => pos_ibuf_header,
-      :length => size_ibuf_header,
-      :name => :ibuf_header,
-      :info => "Insert Buffer Header",
-    })
-  end
-
-  def dump
-    super
-
-    puts "ibuf header:"
-    pp ibuf_header
   end
 end

data/lib/innodb/page/sys_rseg_header.rb

@@ -1,99 +1,105 @@
-# -*- encoding : utf-8 -*-
-
-class Innodb::Page::SysRsegHeader < Innodb::Page
-  # The number of undo log slots in the page.
-  UNDO_SEGMENT_SLOTS = 1024
-
-  # The position of the rollback segment header within the page.
-  def pos_rseg_header
-    pos_page_body
-  end
-
-  # The size of the rollback segment header.
-  def size_rseg_header
-    4 + 4 + Innodb::List::BASE_NODE_SIZE + Innodb::FsegEntry::SIZE
-  end
+# frozen_string_literal: true
+
+module Innodb
+  class Page
+    class SysRsegHeader < Page
+      Header = Struct.new(
+        :max_size,
+        :history_size,
+        :history_list,
+        :fseg,
+        keyword_init: true
+      )
+
+      # The number of undo log slots in the page.
+      UNDO_SEGMENT_SLOTS = 1024
+
+      # The position of the rollback segment header within the page.
+      def pos_rseg_header
+        pos_page_body
+      end
 
-  def pos_undo_segment_array
-    pos_rseg_header + size_rseg_header
-  end
+      # The size of the rollback segment header.
+      def size_rseg_header
+        4 + 4 + Innodb::List::BASE_NODE_SIZE + Innodb::FsegEntry::SIZE
+      end
 
-  def size_undo_segment_slot
-    4
-  end
+      def pos_undo_segment_array
+        pos_rseg_header + size_rseg_header
+      end
 
-  # Parse the rollback segment header from the page.
-  def rseg_header
-    cursor(pos_rseg_header).name("rseg_header") do |c|
-      {
-        :max_size => c.name("max_size") { c.get_uint32 },
-        :history_size => c.name("history_size") { c.get_uint32 },
-        :history_list => c.name("history_list") {
-          Innodb::List::History.new(@space, Innodb::List.get_base_node(c))
-        },
-        :fseg => c.name("fseg") { Innodb::FsegEntry.get_inode(@space, c) },
-      }
-    end
-  end
+      def size_undo_segment_slot
+        4
+      end
 
-  def history_list
-    Innodb::HistoryList.new(rseg_header[:history_list])
-  end
+      # Parse the rollback segment header from the page.
+      def rseg_header
+        cursor(pos_rseg_header).name("rseg_header") do |c|
+          Header.new(
+            max_size: c.name("max_size") { c.read_uint32 },
+            history_size: c.name("history_size") { c.read_uint32 },
+            history_list: c.name("history_list") do
+              Innodb::List::History.new(@space, Innodb::List.get_base_node(c))
+            end,
+            fseg: c.name("fseg") { Innodb::FsegEntry.get_inode(@space, c) }
+          )
+        end
+      end
 
-  def each_undo_segment
-    unless block_given?
-      return enum_for(:each_undo_segment)
-    end
+      def history_list
+        Innodb::HistoryList.new(rseg_header.history_list)
+      end
 
-    cursor(pos_undo_segment_array).name("undo_segment_array") do |c|
-      (0...UNDO_SEGMENT_SLOTS).each do |slot|
-        page_number = c.name("slot[#{slot}]") {
-          Innodb::Page.maybe_undefined(c.get_uint32)
-        }
-        yield slot, page_number
+      def each_undo_segment
+        return enum_for(:each_undo_segment) unless block_given?
+
+        cursor(pos_undo_segment_array).name("undo_segment_array") do |c|
+          (0...UNDO_SEGMENT_SLOTS).each do |slot|
+            page_number = c.name("slot[#{slot}]") do
+              Innodb::Page.maybe_undefined(c.read_uint32)
+            end
+            yield slot, page_number
+          end
+        end
       end
-    end
-  end
 
-  def each_region
-    unless block_given?
-      return enum_for(:each_region)
-    end
+      def each_region(&block)
+        return enum_for(:each_region) unless block_given?
 
-    super do |region|
-      yield region
-    end
+        super(&block)
 
-    yield({
-      :offset => pos_rseg_header,
-      :length => size_rseg_header,
-      :name => :rseg_header,
-      :info => "Rollback Segment Header",
-    })
-
-    (0...UNDO_SEGMENT_SLOTS).each do |slot|
-      yield({
-        :offset => pos_undo_segment_array + (slot * size_undo_segment_slot),
-        :length => size_undo_segment_slot,
-        :name => :undo_segment_slot,
-        :info => "Undo Segment Slot",
-      })
-    end
+        yield Region.new(
+          offset: pos_rseg_header,
+          length: size_rseg_header,
+          name: :rseg_header,
+          info: "Rollback Segment Header"
+        )
 
-    nil
-  end
+        (0...UNDO_SEGMENT_SLOTS).each do |slot|
+          yield Region.new(
+            offset: pos_undo_segment_array + (slot * size_undo_segment_slot),
+            length: size_undo_segment_slot,
+            name: :undo_segment_slot,
+            info: "Undo Segment Slot"
+          )
+        end
 
-  def dump
-    super
+        nil
+      end
+
+      def dump
+        super
 
-    puts
-    puts "rollback segment header:"
-    pp rseg_header
+        puts
+        puts "rollback segment header:"
+        pp rseg_header
 
-    puts
-    puts "undo segment array:"
-    each_undo_segment do |slot, page_number|
-      puts "  #{slot}: #{page_number}"
+        puts
+        puts "undo segment array:"
+        each_undo_segment do |slot, page_number|
+          puts "  #{slot}: #{page_number}"
+        end
+      end
     end
   end
 end

data/lib/innodb/page/trx_sys.rb

@@ -1,4 +1,6 @@
-# -*- encoding : utf-8 -*-
+# frozen_string_literal: true
+
+require "forwardable"
 
 # A specialized class for TRX_SYS pages, which contain various information
 # about the transaction system within InnoDB. Only one TRX_SYS page exists in
@@ -9,207 +11,227 @@
 # 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_page_body
-  end
+module Innodb
+  class Page
+    class TrxSys < Page
+      extend Forwardable
+
+      specialization_for :TRX_SYS
+
+      RsegSlot = Struct.new(
+        :offset,
+        :space_id,
+        :page_number,
+        keyword_init: true
+      )
+
+      MysqlLogInfo = Struct.new(
+        :magic_n,
+        :offset,
+        :name,
+        keyword_init: true
+      )
+
+      DoublewritePageInfo = Struct.new(
+        :magic_n,
+        :page_number,
+        keyword_init: true
+      )
+
+      DoublewriteInfo = Struct.new(
+        :fseg,
+        :page_info,
+        :space_id_stored,
+        keyword_init: true
+      )
+
+      Header = Struct.new(
+        :trx_id,
+        :fseg,
+        :rsegs,
+        :binary_log,
+        :master_log,
+        :doublewrite,
+        keyword_init: true
+      )
+
+      # The TRX_SYS header immediately follows the FIL header.
+      def pos_trx_sys_header
+        pos_page_body
+      end
 
-  def size_trx_sys_header
-    8 + Innodb::FsegEntry::SIZE
-  end
+      def size_trx_sys_header
+        8 + Innodb::FsegEntry::SIZE
+      end
 
-  def pos_rsegs_array
-    pos_trx_sys_header + size_trx_sys_header
-  end
+      def pos_rsegs_array
+        pos_trx_sys_header + size_trx_sys_header
+      end
 
-  def size_mysql_log_info
-    4 + 8 + 100
-  end
+      def size_mysql_log_info
+        4 + 8 + 100
+      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 master's binary log information is located 2000 bytes from the end of
+      # the page.
+      def pos_mysql_master_log_info
+        size - 2_000
+      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 local binary log information is located 1000 bytes from the end of
+      # the page.
+      def pos_mysql_binary_log_info
+        size - 1_000
+      end
 
-  # The doublewrite buffer information is located 200 bytes from the end of
-  # the page.
-  def pos_doublewrite_info
-    size - 200
-  end
+      # The doublewrite buffer information is located 200 bytes from the end of
+      # the page.
+      def pos_doublewrite_info
+        size - 200
+      end
 
-  def size_doublewrite_info
-    Innodb::FsegEntry::SIZE + (2 * (4 + 4 + 4)) + 4
-  end
+      def size_doublewrite_info
+        Innodb::FsegEntry::SIZE + (2 * (4 + 4 + 4)) + 4
+      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
-
-  N_RSEGS = 128
-
-  def rsegs_array(cursor)
-    @rsegs_array ||= (0...N_RSEGS).to_a.inject([]) do |a, n|
-      cursor.name("slot[#{n}]") do |c|
-        slot = {
-          :offset => c.position,
-          :space_id => c.name("space_id") {
-            Innodb::Page.maybe_undefined(c.get_uint32)
-          },
-          :page_number => c.name("page_number") {
-            Innodb::Page.maybe_undefined(c.get_uint32)
-          },
-        }
-        if slot[:space_id] && slot[:page_number]
-          a << slot
+      # 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 = 873_422_344
+
+      # A magic number present in each doublewrite buffer information structure,
+      # which helps identify whether the structure is populated or not.
+      DOUBLEWRITE_MAGIC_N = 536_853_855
+
+      # A magic number present in the overall doublewrite buffer structure,
+      # which identifies whether the space id is stored.
+      DOUBLEWRITE_SPACE_ID_STORED_MAGIC_N = 1_783_657_386
+
+      N_RSEGS = 128
+
+      def rsegs_array(cursor)
+        @rsegs_array ||= N_RSEGS.times.each_with_object([]) do |n, a|
+          cursor.name("slot[#{n}]") do |c|
+            slot = RsegSlot.new(
+              offset: c.position,
+              space_id: c.name("space_id") { Innodb::Page.maybe_undefined(c.read_uint32) },
+              page_number: c.name("page_number") { Innodb::Page.maybe_undefined(c.read_uint32) }
+            )
+            a << slot if slot.space_id && slot.page_number
+          end
         end
       end
-      a
-    end
-  end
 
-  # Read a MySQL binary log information structure from a given position.
-  def mysql_log_info(cursor, offset)
-    cursor.peek(offset) do |c|
-      if c.name("magic_n") { c.get_uint32 } == MYSQL_LOG_MAGIC_N
-        {
-          :offset => c.name("offset") { c.get_uint64 },
-          :name   => c.name("name")   { c.get_bytes(100) },
-        }
+      # Read a MySQL binary log information structure from a given position.
+      def mysql_log_info(cursor, offset)
+        cursor.peek(offset) do |c|
+          magic_n = c.name("magic_n") { c.read_uint32 } == MYSQL_LOG_MAGIC_N
+          break unless magic_n
+
+          MysqlLogInfo.new(
+            magic_n: magic_n,
+            offset: c.name("offset") { c.read_uint64 },
+            name: c.name("name") { c.read_bytes(100) }
+          )
+        end
       end
-    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.name("magic_n") { cursor.get_uint32 },
-      :page_number => [
-        cursor.name("page[0]") { cursor.get_uint32 },
-        cursor.name("page[1]") { cursor.get_uint32 },
-      ],
-    }
-  end
+      # Read a single doublewrite buffer information structure from a given cursor.
+      def doublewrite_page_info(cursor)
+        magic_n = cursor.name("magic_n") { cursor.read_uint32 }
 
-  # 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(cursor)
-    cursor.peek(pos_doublewrite_info) do |c_doublewrite|
-      c_doublewrite.name("doublewrite") do |c|
-        {
-          :fseg => c.name("fseg") { Innodb::FsegEntry.get_inode(@space, c) },
-          :page_info => [
-            c.name("group[0]") { doublewrite_page_info(c) },
-            c.name("group[1]") { doublewrite_page_info(c) },
-          ],
-          :space_id_stored =>
-            (c.name("space_id_stored") { c.get_uint32 } ==
-               DOUBLEWRITE_SPACE_ID_STORED_MAGIC_N),
-        }
+        DoublewritePageInfo.new(
+          magic_n: magic_n,
+          page_number: [0, 1].map { |n| cursor.name("page[#{n}]") { cursor.read_uint32 } }
+        )
       end
-    end
-  end
 
-  # Read the TRX_SYS headers and other information.
-  def trx_sys
-    @trx_sys ||= cursor(pos_trx_sys_header).name("trx_sys") do |c|
-      {
-        :trx_id       => c.name("trx_id") { c.get_uint64 },
-        :fseg         => c.name("fseg") {
-          Innodb::FsegEntry.get_inode(@space, c)
-        },
-        :rsegs        => c.name("rsegs") {
-          rsegs_array(c)
-        },
-        :binary_log   => c.name("binary_log") {
-          mysql_log_info(c, pos_mysql_binary_log_info)
-        },
-        :master_log   => c.name("master_log") {
-          mysql_log_info(c, pos_mysql_master_log_info)
-        },
-        :doublewrite  => doublewrite_info(c),
-      }
-    end
-  end
-
-  def trx_id;       trx_sys[:trx_id];       end
-  def fseg;         trx_sys[:fseg];         end
-  def rsegs;        trx_sys[:rsegs];        end
-  def binary_log;   trx_sys[:binary_log];   end
-  def master_log;   trx_sys[:master_log];   end
-  def doublewrite;  trx_sys[:doublewrite];  end
-
-  def each_region
-    unless block_given?
-      return enum_for(:each_region)
-    end
+      # Read the overall doublewrite buffer structures
+      def doublewrite_info(cursor)
+        cursor.peek(pos_doublewrite_info) do |c_doublewrite|
+          c_doublewrite.name("doublewrite") do |c|
+            DoublewriteInfo.new(
+              fseg: c.name("fseg") { Innodb::FsegEntry.get_inode(@space, c) },
+              page_info: [0, 1].map { |n| c.name("group[#{n}]") { doublewrite_page_info(c) } },
+              space_id_stored: (c.name("space_id_stored") { c.read_uint32 } == DOUBLEWRITE_SPACE_ID_STORED_MAGIC_N)
+            )
+          end
+        end
+      end
 
-    super do |region|
-      yield region
-    end
+      # Read the TRX_SYS headers and other information.
+      def trx_sys
+        @trx_sys ||= cursor(pos_trx_sys_header).name("trx_sys") do |c|
+          Header.new(
+            trx_id: c.name("trx_id") { c.read_uint64 },
+            fseg: c.name("fseg") { Innodb::FsegEntry.get_inode(@space, c) },
+            rsegs: c.name("rsegs") { rsegs_array(c) },
+            binary_log: c.name("binary_log") { mysql_log_info(c, pos_mysql_binary_log_info) },
+            master_log: c.name("master_log") { mysql_log_info(c, pos_mysql_master_log_info) },
+            doublewrite: doublewrite_info(c)
+          )
+        end
+      end
 
-    yield({
-      :offset => pos_trx_sys_header,
-      :length => size_trx_sys_header,
-      :name => :trx_sys_header,
-      :info => "Transaction System Header",
-    })
-
-    rsegs.each do |rseg|
-      yield({
-        :offset => rseg[:offset],
-        :length => 4 + 4,
-        :name => :rseg,
-        :info => "Rollback Segment",
-      })
-    end
+      def_delegator :trx_sys, :trx_id
+      def_delegator :trx_sys, :fseg
+      def_delegator :trx_sys, :rsegs
+      def_delegator :trx_sys, :binary_log
+      def_delegator :trx_sys, :master_log
+      def_delegator :trx_sys, :doublewrite
+
+      def each_region(&block)
+        return enum_for(:each_region) unless block_given?
+
+        super(&block)
+
+        yield Region.new(
+          offset: pos_trx_sys_header,
+          length: size_trx_sys_header,
+          name: :trx_sys_header,
+          info: "Transaction System Header"
+        )
+
+        rsegs.each do |rseg|
+          yield Region.new(
+            offset: rseg[:offset],
+            length: 4 + 4,
+            name: :rseg,
+            info: "Rollback Segment"
+          )
+        end
 
-    yield({
-      :offset => pos_mysql_binary_log_info,
-      :length => size_mysql_log_info,
-      :name => :mysql_binary_log_info,
-      :info => "Binary Log Info",
-    })
-
-    yield({
-      :offset => pos_mysql_master_log_info,
-      :length => size_mysql_log_info,
-      :name => :mysql_master_log_info,
-      :info => "Master Log Info",
-    })
-
-    yield({
-      :offset => pos_doublewrite_info,
-      :length => size_doublewrite_info,
-      :name => :doublewrite_info,
-      :info => "Double Write Buffer Info",
-    })
-
-    nil
-  end
+        yield Region.new(
+          offset: pos_mysql_binary_log_info,
+          length: size_mysql_log_info,
+          name: :mysql_binary_log_info,
+          info: "Binary Log Info"
+        )
+
+        yield Region.new(
+          offset: pos_mysql_master_log_info,
+          length: size_mysql_log_info,
+          name: :mysql_master_log_info,
+          info: "Master Log Info"
+        )
+
+        yield Region.new(
+          offset: pos_doublewrite_info,
+          length: size_doublewrite_info,
+          name: :doublewrite_info,
+          info: "Double Write Buffer Info"
+        )
+
+        nil
+      end
 
-  # Dump the contents of a page for debugging purposes.
-  def dump
-    super
+      # Dump the contents of a page for debugging purposes.
+      def dump
+        super
 
-    puts "trx_sys:"
-    pp trx_sys
-    puts
+        puts "trx_sys:"
+        pp trx_sys
+        puts
+      end
+    end
   end
 end
-
-Innodb::Page::SPECIALIZED_CLASSES[:TRX_SYS] = Innodb::Page::TrxSys