hacks 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc7490b844554dbfab5a6bbb8b7ccffc78707533c1da479c37d9d95d05e4edea
-  data.tar.gz: b9be1db5fa2b2bcf8489fe7dc3dc2e777db4f272d0d1cc57dc58f00af3a0921d
+  metadata.gz: 9d864adfb10ffe7141efe44a825a6691a50564bb5762a81d0ab970afe264eb34
+  data.tar.gz: a653799f9f87b99e9d83c893aa793da7f8152dbddabc9be987be45faac2cb527
 SHA512:
-  metadata.gz: cb87833249d0fae12c00e87c9d9b2321b7c3ec9404960176d1b7fc2f2fb2f33ed6259c0a11bca8fc26a218f6a8112e8d7a0aee809908526598b09dcaa84a4374
-  data.tar.gz: 410ab0b742089dedbc90c7cd9f3e359debb9e3f150502eed99905f90d94b04ec8429b1b075c46e7a93da42b07ac1e9a288fac672b0dd01ef664bdb447caa0173
+  metadata.gz: 94a16bcccc2be2fe57c52f55e4b8370d1a4a056c42fd8ceeefc7e9d8a8992d0a5ae8021abd0d7a78278c094b56485b61817ba9ae46f3e98a7a6a23b187ce27d8
+  data.tar.gz: 537c8567c67ccc38f9df2f0e4eacaa5ea1ed7a5ddf3c95990ed9bb619e5db0657905f72cfccf9dd275ec1aaa7105e7edf03f068326c865147706340a6082ebc3

data/Rakefile

@@ -1,4 +1,60 @@
-
+require "rake/clean"
 require 'rake/extensiontask'
+
+task :compile => "ext/hacks/structs.rb"
 Rake::ExtensionTask.new("hacks")
 
+CLOBBER.include "ext/hacks/structs.rb"
+
+def walk doc, &blk
+  yield doc
+  (doc["inner"] || []).each { |child| walk(child, &blk) }
+end
+
+def struct doc, name
+  walk doc do |node|
+    if node["kind"] == "RecordDecl" && node["name"] == name && node["inner"]
+      return [name, node["inner"].find_all { |x| x["kind"] == "FieldDecl" }.map { |x|
+        x["name"]
+      }]
+    end
+  end
+  nil
+end
+
+STRUCTS = %w{
+  RTypedData
+  RBasic
+  RObject
+  RArray
+  RData
+}
+
+file "ext/hacks/structs.rb" do
+  require "tempfile"
+  require "rbconfig"
+  require "open3"
+  require "json"
+
+  h_dir = RbConfig::CONFIG["rubyhdrdir"]
+  arch_dir = RbConfig::CONFIG["rubyarchhdrdir"]
+  file = Tempfile.new('c_file')
+
+  begin
+    file.write "#include <ruby.h>"
+    file.close
+
+    cmd = "clang -I#{h_dir} -I#{arch_dir} -xc -Xclang -ast-dump=json -fsyntax-only #{file.path}"
+    stdout_and_stderr, status = Open3.capture2e(cmd)
+    doc = JSON.load stdout_and_stderr
+
+    require "pp"
+    structs = STRUCTS.map { |name| struct doc, name }.pretty_inspect
+
+    File.open("ext/hacks/structs.rb", "w") do |f|
+      f.write "module Hacks\n  STRUCTS = #{structs}\nend"
+    end
+  ensure
+    #file.unlink   # deletes the temp file
+  end
+end

data/ext/hacks/constants.rb

@@ -0,0 +1,46 @@
+# Only used at gem installation time
+module Hacks
+  CONSTANTS = %w{
+    RUBY_T_NONE
+
+    RUBY_T_OBJECT
+    RUBY_T_CLASS
+    RUBY_T_MODULE
+    RUBY_T_FLOAT
+    RUBY_T_STRING
+    RUBY_T_REGEXP
+    RUBY_T_ARRAY
+    RUBY_T_HASH
+    RUBY_T_STRUCT
+    RUBY_T_BIGNUM
+    RUBY_T_FILE
+    RUBY_T_DATA
+    RUBY_T_MATCH
+    RUBY_T_COMPLEX
+    RUBY_T_RATIONAL
+
+    RUBY_T_NIL
+    RUBY_T_TRUE
+    RUBY_T_FALSE
+    RUBY_T_SYMBOL
+    RUBY_T_FIXNUM
+    RUBY_T_UNDEF
+
+    RUBY_T_IMEMO
+    RUBY_T_NODE
+    RUBY_T_ICLASS
+    RUBY_T_ZOMBIE
+    RUBY_T_MOVED
+
+    RUBY_T_MASK
+    RUBY_Qfalse
+    RUBY_Qnil
+    RUBY_Qtrue
+    RUBY_Qundef
+    RUBY_IMMEDIATE_MASK
+    RUBY_FIXNUM_FLAG
+    RUBY_FLONUM_MASK
+    RUBY_FLONUM_FLAG
+    RUBY_SYMBOL_FLAG
+  }
+end

data/ext/hacks/extconf.rb

@@ -1,51 +1,10 @@
 require "mkmf"
 require "erb"
 
-constants = %w{
-    RUBY_T_NONE
+require File.join File.dirname(__FILE__), "constants.rb"
+require File.join File.dirname(__FILE__), "structs.rb"
 
-    RUBY_T_OBJECT
-    RUBY_T_CLASS
-    RUBY_T_MODULE
-    RUBY_T_FLOAT
-    RUBY_T_STRING
-    RUBY_T_REGEXP
-    RUBY_T_ARRAY
-    RUBY_T_HASH
-    RUBY_T_STRUCT
-    RUBY_T_BIGNUM
-    RUBY_T_FILE
-    RUBY_T_DATA
-    RUBY_T_MATCH
-    RUBY_T_COMPLEX
-    RUBY_T_RATIONAL
-
-    RUBY_T_NIL
-    RUBY_T_TRUE
-    RUBY_T_FALSE
-    RUBY_T_SYMBOL
-    RUBY_T_FIXNUM
-    RUBY_T_UNDEF
-
-    RUBY_T_IMEMO
-    RUBY_T_NODE
-    RUBY_T_ICLASS
-    RUBY_T_ZOMBIE
-    RUBY_T_MOVED
-
-    RUBY_T_MASK
-    RUBY_Qfalse
-    RUBY_Qnil
-    RUBY_Qtrue
-    RUBY_Qundef
-    RUBY_IMMEDIATE_MASK
-    RUBY_FIXNUM_FLAG
-    RUBY_FLONUM_MASK
-    RUBY_FLONUM_FLAG
-    RUBY_SYMBOL_FLAG
-}
-
-def make_c constants
+def make_c constants, structs
   erb_file = File.join File.dirname(__FILE__), "hacks.c.erb"
   erb = ERB.new(File.binread(erb_file), trim_mode: "-")
   c = erb.result(binding)
@@ -53,6 +12,6 @@ def make_c constants
   File.binwrite c_file, c
 end
 
-make_c constants.find_all { have_const(_1) }.map { [_1.sub(/^RUBY_/, ''), _1] }
+make_c Hacks::CONSTANTS.find_all { have_const(_1) }.map { [_1.sub(/^RUBY_/, ''), _1] }, Hacks::STRUCTS
 
 create_makefile "hacks"

data/ext/hacks/hacks.c.erb

@@ -1,11 +1,36 @@
 #include <ruby.h>
 
+static VALUE
+hacks_rb_intern_str(VALUE mod, VALUE x)
+{
+    return rb_intern_str(x);
+}
+
+static VALUE
+hacks_rb_gc_writebarrier(VALUE mod, VALUE x, VALUE y)
+{
+    rb_gc_writebarrier(x, y);
+    return Qtrue;
+}
+
+static VALUE
+hacks_rb_obj_class(VALUE mod, VALUE x)
+{
+    return rb_obj_class(x);
+}
+
 static VALUE
 hacks_rb_type(VALUE mod, VALUE x)
 {
     return INT2NUM(rb_type(x));
 }
 
+static VALUE
+hacks_rb_id2sym(VALUE mod, VALUE x)
+{
+    return rb_id2sym((ID)NUM2INT(x));
+}
+
 void Init_hacks(void)
 {
     VALUE rb_mHacks = rb_define_module("Hacks");
@@ -13,5 +38,26 @@ void Init_hacks(void)
     rb_define_const(rb_mHacks, "<%= ruby_name %>", INT2NUM(<%= c_name %>));
 <%- end -%>
 
+    VALUE offsets = rb_hash_new();
+    VALUE tmp;
+    VALUE tmp2;
+<%- structs.each do |struct_name, members| -%>
+    tmp = rb_hash_new();
+  <%- members.each do |member_name| -%>
+    tmp2 = rb_ary_new();
+    // Offset
+    rb_ary_store(tmp2, 0, INT2NUM(offsetof(struct <%= struct_name %>, <%= member_name %>)));
+    // Size
+    rb_ary_store(tmp2, 1, INT2NUM(sizeof(((struct <%= struct_name %> *)0)-><%= member_name %>)));
+    rb_hash_aset(tmp, rb_str_new2("<%= member_name %>"), tmp2);
+  <%- end -%>
+    rb_hash_aset(offsets, rb_str_new2("<%= struct_name %>"), tmp);
+<%- end -%>
+    rb_define_const(rb_mHacks, "STRUCTS", offsets);
+
     rb_define_singleton_method(rb_mHacks, "rb_type", hacks_rb_type, 1);
+    rb_define_singleton_method(rb_mHacks, "rb_id2sym", hacks_rb_id2sym, 1);
+    rb_define_singleton_method(rb_mHacks, "rb_obj_class", hacks_rb_obj_class, 1);
+    rb_define_singleton_method(rb_mHacks, "rb_gc_writebarrier", hacks_rb_gc_writebarrier, 2);
+    rb_define_singleton_method(rb_mHacks, "rb_intern_str", hacks_rb_intern_str, 1);
 }

data/ext/hacks/structs.rb

@@ -0,0 +1,8 @@
+module Hacks
+  STRUCTS = [["RTypedData", ["basic", "type", "typed_flag", "data"]],
+ ["RBasic", ["flags", "klass"]],
+ ["RObject", ["basic", "as"]],
+ ["RArray", ["basic", "as"]],
+ ["RData", ["basic", "dmark", "dfree", "data"]]]
+
+end

data/hacks.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = "hacks"
-  s.version     = "0.0.1"
+  s.version     = "0.0.3"
   s.summary     = "Ruby C internals exposed as Ruby"
   s.description = "These are some hacks I use. This gem exposes some Ruby C internals as Ruby functions and constants"
   s.authors     = ["Aaron Patterson"]

data/lib/hacks.rb

@@ -0,0 +1,9 @@
+require "hacks.so"
+
+module Hacks
+  BASIC_TYPE_LUT = Hash[constants.grep(/^T_/).map { [const_get(_1), _1] }]
+
+  def self.basic_type obj
+    BASIC_TYPE_LUT[rb_type(obj)]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hacks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Aaron Patterson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-27 00:00:00.000000000 Z
+date: 2023-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -50,9 +50,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- ext/hacks/constants.rb
 - ext/hacks/extconf.rb
 - ext/hacks/hacks.c.erb
+- ext/hacks/structs.rb
 - hacks.gemspec
+- lib/hacks.rb
 homepage: https://github.com/tenderlove/hacks
 licenses:
 - Apache-2.0
@@ -72,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.0.dev
 signing_key:
 specification_version: 4
 summary: Ruby C internals exposed as Ruby