odinflex 1.0.0

data/odinflex.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name        = "odinflex"
+  s.version     = "1.0.0"
+  s.summary     = "Parse AR or Mach-O files"
+  s.description = "Do you need to parse an AR file or a Mach-O file? If so, then this is the library for you!"
+  s.authors     = ["Aaron Patterson"]
+  s.email       = "tenderlove@ruby-lang.org"
+  s.files       = `git ls-files -z`.split("\x0")
+  s.test_files  = s.files.grep(%r{^test/})
+  s.homepage    = "https://github.com/tenderlove/odinflex"
+  s.license     = "Apache-2.0"
+end

data/test/fixtures/a.out.dSYM/Contents/Info.plist

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+	<dict>
+		<key>CFBundleDevelopmentRegion</key>
+		<string>English</string>
+		<key>CFBundleIdentifier</key>
+		<string>com.apple.xcode.dsym.a.out</string>
+		<key>CFBundleInfoDictionaryVersion</key>
+		<string>6.0</string>
+		<key>CFBundlePackageType</key>
+		<string>dSYM</string>
+		<key>CFBundleSignature</key>
+		<string>????</string>
+		<key>CFBundleShortVersionString</key>
+		<string>1.0</string>
+		<key>CFBundleVersion</key>
+		<string>1</string>
+	</dict>
+</plist>

data/test/fixtures/out.dSYM/Contents/Info.plist

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+	<dict>
+		<key>CFBundleDevelopmentRegion</key>
+		<string>English</string>
+		<key>CFBundleIdentifier</key>
+		<string>com.apple.xcode.dsym.out</string>
+		<key>CFBundleInfoDictionaryVersion</key>
+		<string>6.0</string>
+		<key>CFBundlePackageType</key>
+		<string>dSYM</string>
+		<key>CFBundleSignature</key>
+		<string>????</string>
+		<key>CFBundleShortVersionString</key>
+		<string>1.0</string>
+		<key>CFBundleVersion</key>
+		<string>1</string>
+	</dict>
+</plist>

data/test/fixtures/slop.c

@@ -0,0 +1,17 @@
+#include <stdio.h>
+#include <stdlib.h>
+
+struct hello {
+    char *p;
+    char c;
+    long x;
+};
+
+int main(int argc, char **argv) {
+  struct hello * m;
+  m = malloc(sizeof(struct hello));
+  m->c = 123;
+  m->x = 123;
+  printf("Hello World %lu\n", m->x);
+  return 0;
+}

data/test/fixtures/thing.c

@@ -0,0 +1,6 @@
+#include <stdio.h>
+
+int main(int argc, char **argv) {
+  printf("Hello World\n");
+  return 0;
+}

data/test/helper.rb

@@ -0,0 +1,58 @@
+ENV["MT_NO_PLUGINS"] = "1"
+
+require "minitest/autorun"
+require "odinflex/mach-o"
+require "odinflex/ar"
+require "rbconfig"
+require "fiddle"
+
+module OdinFlex
+  class Test < Minitest::Test
+    include Fiddle
+
+    module Hacks
+      include Fiddle
+
+      class Fiddle::Function
+        def to_proc
+          this = self
+          lambda { |*args| this.call(*args) }
+        end
+      end unless Function.method_defined?(:to_proc)
+
+      def self.make_function name, args, ret
+        ptr = Handle::DEFAULT[name]
+        func = Function.new ptr, args, ret, name: name
+        define_singleton_method name, &func.to_proc
+      end
+
+      make_function "strerror", [TYPE_INT], TYPE_CONST_STRING
+      #make_function "mprotect", [TYPE_VOIDP, TYPE_SIZE_T, TYPE_INT], TYPE_INT
+      make_function "_dyld_image_count", [], TYPE_INT32_T
+      make_function "_dyld_get_image_name", [TYPE_INT32_T], TYPE_CONST_STRING
+      make_function "_dyld_get_image_vmaddr_slide", [TYPE_INT32_T], TYPE_INTPTR_T
+      make_function "mach_task_self", [], TYPE_VOIDP
+      make_function "vm_protect", [TYPE_VOIDP, -TYPE_INT64_T, TYPE_SIZE_T, TYPE_CHAR, TYPE_INT], TYPE_INT
+      make_function "rb_intern", [TYPE_CONST_STRING], TYPE_INT
+
+      def self.mprotect addr, len, prot
+        vm_protect mach_task_self, addr, len, 0, prot | PROT_COPY
+      end
+
+      PROT_READ   = 0x01
+      PROT_WRITE  = 0x02
+      PROT_EXEC   = 0x04
+      PROT_COPY   = 0x10
+
+      def self.slide
+        executable = RbConfig.ruby
+        Hacks._dyld_image_count.times do |i|
+          name = Hacks._dyld_get_image_name(i)
+          if executable == name
+            return Hacks._dyld_get_image_vmaddr_slide(i)
+          end
+        end
+      end
+    end
+  end
+end

data/test/mach_o_dwarf_integration_test.rb

@@ -0,0 +1,47 @@
+require "helper"
+require "worf"
+
+module OdinFlex
+  class MachODWARFIntegrationTest < Test
+    def test_find_symbol_and_make_struct
+      archive = nil
+
+      File.open(RbConfig.ruby) do |f|
+        my_macho = MachO.new f
+        my_macho.each do |section|
+          if section.symtab?
+            archive = section.nlist.find_all(&:archive?).map(&:archive).uniq.first
+          end
+        end
+      end
+
+      assert archive
+
+      found_object = nil
+
+      File.open(archive) do |f|
+        ar = AR.new f
+        ar.each do |object_file|
+          next unless object_file.identifier.end_with?(".o")
+          next unless object_file.identifier == "version.o"
+
+          f.seek object_file.pos, IO::SEEK_SET
+          macho = MachO.new f
+          debug_info = macho.find_section("__debug_info")&.as_dwarf || next
+          debug_strs = macho.find_section("__debug_str").as_dwarf
+          debug_abbrev = macho.find_section("__debug_abbrev").as_dwarf
+
+          debug_info.compile_units(debug_abbrev.tags).each do |unit|
+            unit.die.children.each do |die|
+              if die.name(debug_strs) == "ruby_api_version"
+                found_object = object_file
+              end
+            end
+          end
+        end
+      end
+
+      assert found_object
+    end
+  end
+end

data/test/ruby_test.rb

@@ -0,0 +1,238 @@
+require "helper"
+
+module OdinFlex
+  class RubyTest < OdinFlex::Test
+    def ruby_archive
+      File.join RbConfig::CONFIG["prefix"], "lib", RbConfig::CONFIG["LIBRUBY"]
+    end
+
+    def test_ruby_archive
+      assert File.file?(ruby_archive)
+    end
+
+    def test_read_archive
+      files = []
+      File.open(ruby_archive) do |f|
+        AR.new(f).each { |file| files << file.identifier }
+      end
+      assert_includes files, "gc.o"
+    end
+
+    def test_read_archive_twice
+      files = []
+      File.open(ruby_archive) do |f|
+        ar = AR.new(f)
+        ar.each { |file| files << file.identifier }
+        assert_includes files, "gc.o"
+        files.clear
+        ar.each { |file| files << file.identifier }
+        assert_includes files, "gc.o"
+      end
+    end
+
+    def test_macho_in_archive
+      File.open(ruby_archive) do |f|
+        ar = AR.new f
+        gc = ar.find { |file| file.identifier == "gc.o" }
+
+        f.seek gc.pos, IO::SEEK_SET
+        macho = MachO.new f
+        section = macho.find_section("__debug_str")
+        assert_equal "__debug_str", section.sectname
+      end
+    end
+
+    def test_macho_to_dwarf
+      File.open(ruby_archive) do |f|
+        ar = AR.new f
+        gc = ar.find { |file| file.identifier == "gc.o" }
+
+        f.seek gc.pos, IO::SEEK_SET
+        macho = MachO.new f
+        debug_strs = macho.find_section("__debug_str").as_dwarf
+        debug_abbrev = macho.find_section("__debug_abbrev").as_dwarf
+        debug_info = macho.find_section("__debug_info").as_dwarf
+
+        names = []
+
+        debug_info.compile_units(debug_abbrev.tags).each do |unit|
+          unit.die.children.each do |die|
+            names << die.name(debug_strs)
+          end
+        end
+
+        assert_includes names, "RBasic"
+      end
+    end
+
+    def test_rbasic_layout
+      File.open(ruby_archive) do |f|
+        ar = AR.new f
+        gc = ar.find { |file| file.identifier == "gc.o" }
+
+        f.seek gc.pos, IO::SEEK_SET
+        macho = MachO.new f
+        debug_strs = macho.find_section("__debug_str").as_dwarf
+        debug_abbrev = macho.find_section("__debug_abbrev").as_dwarf
+        debug_info = macho.find_section("__debug_info").as_dwarf
+
+        rbasic_layout = []
+
+        debug_info.compile_units(debug_abbrev.tags).each do |unit|
+          unit.die.children.each do |die|
+            if die.name(debug_strs) == "RBasic"
+              assert_predicate die.tag, :structure_type?
+
+              die.children.each do |child|
+                field_name = child.name(debug_strs)
+                field_type = nil
+                while child
+                  field_type = child.name(debug_strs)
+                  break unless child.type
+                  child = unit.die.find_type(child)
+                end
+                rbasic_layout << [field_name, field_type]
+              end
+            end
+          end
+        end
+
+        assert_equal([["flags", "long unsigned int"], ["klass", "long unsigned int"]],
+                     rbasic_layout)
+      end
+    end
+
+    def test_rclass_layout
+      File.open(ruby_archive) do |f|
+        ar = AR.new f
+        gc = ar.find { |file| file.identifier == "gc.o" }
+
+        f.seek gc.pos, IO::SEEK_SET
+        macho = MachO.new f
+        debug_strs = macho.find_section("__debug_str").as_dwarf
+        debug_abbrev = macho.find_section("__debug_abbrev").as_dwarf
+        debug_info = macho.find_section("__debug_info").as_dwarf
+
+        layout = []
+
+        debug_info.compile_units(debug_abbrev.tags).each do |unit|
+          unit.die.children.each do |die|
+            if die.name(debug_strs) == "RClass"
+              assert_predicate die.tag, :structure_type?
+
+              die.children.each do |child|
+                field_name = child.name(debug_strs)
+                type = unit.die.find_type(child)
+
+                if type.tag.typedef?
+                  type = unit.die.find_type(type)
+                end
+
+                type_name = if type.tag.pointer_type?
+                  c = unit.die.find_type(type)
+                  "#{c.name(debug_strs)} *"
+                else
+                  type.name(debug_strs)
+                end
+
+                type_size = if type.tag.pointer_type?
+                              unit.address_size
+                            else
+                              type.byte_size
+                            end
+
+                layout << [field_name, type_name, type_size]
+              end
+            end
+          end
+        end
+
+        assert_equal([["basic", "RBasic", 16],
+                      ["super", "long unsigned int", 8],
+                      ["ptr", "rb_classext_struct *", 8],
+                      ["class_serial", "long long unsigned int", 8]],
+                     layout)
+      end
+    end
+
+    [
+      [:section?, MachO::Section],
+      [:symtab?, MachO::LC_SYMTAB],
+      [:segment?, MachO::LC_SEGMENT_64],
+      [:dysymtab?, MachO::LC_DYSYMTAB],
+      [:command?, MachO::Command],
+    ].each do |predicate, klass|
+      define_method :"test_find_#{predicate}" do
+        File.open(RbConfig.ruby) do |f|
+          my_macho = MachO.new f
+          list = my_macho.find_all(&predicate)
+          refute_predicate list, :empty?
+          assert list.all? { |x| x.is_a?(klass) }
+        end
+      end
+    end
+
+    def test_rb_vm_get_insns_address_table
+      sym = nil
+
+      File.open(RbConfig.ruby) do |f|
+        my_macho = MachO.new f
+
+        my_macho.each do |section|
+          if section.symtab?
+            sym = section.nlist.find do |symbol|
+              symbol.name == "_rb_vm_get_insns_address_table" && symbol.value
+            end
+            break if sym
+          end
+        end
+      end
+
+      addr = sym.value + Hacks.slide
+      ptr = Fiddle::Function.new(addr, [], TYPE_VOIDP).call
+      len = RubyVM::INSTRUCTION_NAMES.length
+      assert ptr[0, len * Fiddle::SIZEOF_VOIDP].unpack("Q#{len}")
+    end
+
+    def test_guess_slide
+      File.open(RbConfig.ruby) do |f|
+        my_macho = MachO.new f
+
+        my_macho.each do |section|
+          if section.symtab?
+            section.nlist.each do |symbol|
+              if symbol.name == "_rb_st_insert"
+                guess_slide = Fiddle::Handle::DEFAULT["rb_st_insert"] - symbol.value
+                assert_equal Hacks.slide, guess_slide
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def test_find_global
+      File.open(RbConfig.ruby) do |f|
+        my_macho = MachO.new f
+
+        my_macho.each do |section|
+          if section.symtab?
+            section.nlist.each do |symbol|
+              if symbol.name == "_ruby_api_version"
+                if symbol.value > 0
+                  addr = symbol.value + Hacks.slide
+                  pointer = Fiddle::Pointer.new(addr, Fiddle::SIZEOF_INT * 3)
+                  assert_equal RbConfig::CONFIG["ruby_version"].split(".").map(&:to_i),
+                    pointer[0, Fiddle::SIZEOF_INT * 3].unpack("LLL")
+                else
+                  assert_predicate symbol, :stab?
+                  assert_predicate symbol, :gsym?
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: odinflex
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aaron Patterson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-07-07 00:00:00.000000000 Z
+dependencies: []
+description: Do you need to parse an AR file or a Mach-O file? If so, then this is
+  the library for you!
+email: tenderlove@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/odinflex/ar.rb
+- lib/odinflex/mach-o.rb
+- odinflex.gemspec
+- test/fixtures/a.out
+- test/fixtures/a.out.dSYM/Contents/Info.plist
+- test/fixtures/a.out.dSYM/Contents/Resources/DWARF/a.out
+- test/fixtures/out.dSYM/Contents/Info.plist
+- test/fixtures/out.dSYM/Contents/Resources/DWARF/out
+- test/fixtures/slop.c
+- test/fixtures/thing.c
+- test/helper.rb
+- test/mach_o_dwarf_integration_test.rb
+- test/ruby_test.rb
+homepage: https://github.com/tenderlove/odinflex
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Parse AR or Mach-O files
+test_files:
+- test/fixtures/a.out
+- test/fixtures/a.out.dSYM/Contents/Info.plist
+- test/fixtures/a.out.dSYM/Contents/Resources/DWARF/a.out
+- test/fixtures/out.dSYM/Contents/Info.plist
+- test/fixtures/out.dSYM/Contents/Resources/DWARF/out
+- test/fixtures/slop.c
+- test/fixtures/thing.c
+- test/helper.rb
+- test/mach_o_dwarf_integration_test.rb
+- test/ruby_test.rb