c_location 0.1 → 0.2

data/README.md

@@ -0,0 +1,63 @@
+Given various assumptions about your setup, provides `Method#c_location`, which is the
+equivalent of `Method#source_location` for methods that were written in C.
+
+Requirements
+============
+
+On Mac OS X, you will need the `nm` tool that's bundled with Xcode; and the `gobjdump`
+tool that you can get with `brew install binutils`.
+
+On Linux you'll need the `objdump` tool, on Debian/Ubuntu it's obtainable with `apt-get install
+binutils`, I assume other distros are similar.
+
+On all systems you'll need your Rubies compiled with debug information (seems to be the
+default on Linux). If you're using `rvm` add `export rvm_configure_flags="CFLAGS=-g"` to
+`~/.rvmrc`.
+
+If it still doesn't work — try running the commands that are found in
+`lib/c_location/resolver.rb` manually, and see where the problem is.
+
+
+How does this even work?!
+=========================
+
+1. Find a pointer to the C function that's behind a ruby method (most of the code in
+   `ext/c_location.c` deals with doing this for various versions of Ruby — it's certainly
+   not exposed in the API!)
+
+2. Find the shared object file that contains this C function, and the offset in that file
+   that the function's compiled code resides. This is done using the non-standard (but
+   widespread) `dladdr()` function. (See man `dladdr`).
+
+3. (Mac OS X only). Use `nm` to find the original library that the shared object file was
+   built from. (This is because `.bundle` files don't contain the debugging information
+   directly).
+
+4. use `objdump` to read the DWARF data embedded in the shared object file when it was
+   compiled with the `-g` flag.
+
+5. Use some heuristics to guess the directories that might include that file based on the
+   location of the object file on disk, and look for a correctly named file there.
+
+(In short, lots and lots of string).
+
+
+TODO
+====
+
+If possible, it'd be nice to have fewer external calls. Perhaps the data we're using `nm`
+for could be done in Ruby without too much help; we could even try bundling `libdwarf` to
+avoid the dependency on `objdump`.
+
+It'd be really cool to make the Pry `edit-method` command work for C extensions. I think
+this is just a matter of writing more code: have `edit-method` work as normal, and then
+after closing the editor run `make` in the right directory; then copy the `.so` file into
+a new directory and then require it. (the Init_foo method should then just overwrite all
+the existing setup).
+
+Meta-fu
+=======
+
+Released under the MIT License. Bug reports and pull requests welcome.
+
+Do not use this in production :p.

data/example/c_extension_location.rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'c_location'
+
+puts CompiledLocation.instance_method(:compiled_location).c_location.inspect

data/example/inbuilt_location.rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'c_location'
+
+puts Math.method(:sin).c_location.inspect

data/ext/c_location.c

@@ -1,15 +1,4 @@
-/* Load dladdr() function */
-#include <dlfcn.h>
-
-#include "ruby.h"
-
-// TODO: why is it necessary to define this here? It ought to be in <dlfcn.h>
-typedef struct {
-   const char *dli_fname;  /* Pathname of shared object that contains address */
-   void       *dli_fbase;  /* Address at which shared object is loaded */
-   const char *dli_sname;  /* Name of nearest symbol with address lower than addr */
-   void       *dli_saddr;  /* Exact address of symbol named in dli_sname */
-} Dl2_info;
+#include "c_location.h"
 
 /* Given the pointer to a C function (called "name" for error handling)
  * return the filename and offset of the compiled byte code for that function.
@@ -50,78 +39,8 @@ Init_c_location()
 
 #ifdef RUBY_19
 
-typedef enum {
-    NOEX_PUBLIC    = 0x00,
-    NOEX_NOSUPER   = 0x01,
-    NOEX_PRIVATE   = 0x02,
-    NOEX_PROTECTED = 0x04,
-    NOEX_MASK      = 0x06,
-    NOEX_BASIC     = 0x08,
-    NOEX_UNDEF     = NOEX_NOSUPER,
-    NOEX_MODFUNC   = 0x12,
-    NOEX_SUPER     = 0x20,
-    NOEX_VCALL     = 0x40,
-    NOEX_RESPONDS  = 0x80
-} rb_method_flag_t;
-
-typedef enum {
-    VM_METHOD_TYPE_ISEQ,
-    VM_METHOD_TYPE_CFUNC,
-    VM_METHOD_TYPE_ATTRSET,
-    VM_METHOD_TYPE_IVAR,
-    VM_METHOD_TYPE_BMETHOD,
-    VM_METHOD_TYPE_ZSUPER,
-    VM_METHOD_TYPE_UNDEF,
-    VM_METHOD_TYPE_NOTIMPLEMENTED,
-    VM_METHOD_TYPE_OPTIMIZED, /* Kernel#send, Proc#call, etc */
-    VM_METHOD_TYPE_MISSING   /* wrapper for method_missing(id) */
-} rb_method_type_t;
-
-typedef struct rb_method_cfunc_struct {
-    VALUE (*func)(ANYARGS);
-    int argc;
-} rb_method_cfunc_t;
-
-typedef struct rb_method_attr_struct {
-    ID id;
-    VALUE location;
-} rb_method_attr_t;
-
-typedef struct rb_iseq_struct rb_iseq_t;
-typedef struct rb_method_definition_struct {
-    rb_method_type_t type; /* method type */
-    ID original_id;
-    union {
-        rb_iseq_t *iseq;            /* should be mark */
-        rb_method_cfunc_t cfunc;
-        rb_method_attr_t attr;
-        VALUE proc;                 /* should be mark */
-        enum method_optimized_type {
-            OPTIMIZED_METHOD_TYPE_SEND,
-            OPTIMIZED_METHOD_TYPE_CALL
-        } optimize_type;
-    } body;
-    int alias_count;
-} rb_method_definition_t;
-
-typedef struct rb_method_entry_struct {
-    rb_method_flag_t flag;
-    char mark;
-    rb_method_definition_t *def;
-    ID called_id;
-    VALUE klass;                    /* should be mark */
-} rb_method_entry_t;
-
 #ifdef RUBY_193
 
-struct METHOD {
-    VALUE recv;
-    VALUE rclass;
-    ID id;
-    rb_method_entry_t *me;
-    struct unlinked_method_entry_list_entry *ume;
-};
-
 static VALUE compiled_location(VALUE self)
 {
     struct METHOD *data;
@@ -142,14 +61,6 @@ static VALUE compiled_location(VALUE self)
 
 #else /* RUBY_192 */
 
-struct METHOD {
-    VALUE recv;
-    VALUE rclass;
-    ID id;
-    rb_method_entry_t me;
-    struct unlinked_method_entry_list_entry *ume;
-};
-
 static VALUE compiled_location(VALUE self)
 {
     struct METHOD *data;
@@ -170,20 +81,8 @@ static VALUE compiled_location(VALUE self)
 
 
 #endif
-
 #else /* RUBY18 */
 
-#include "node.h"
-
-/* Copy-pasted out of Ruby 1.8.7, not part of the official C API.*/
-struct METHOD {
-    VALUE klass, rklass;
-    VALUE recv;
-    ID id, oid;
-    int safe_level;
-    NODE *body;
-};
-
 static VALUE compiled_location(VALUE self)
 {
     struct METHOD *data;
@@ -197,6 +96,4 @@ static VALUE compiled_location(VALUE self)
 
     return file_and_offset(*data->body->nd_cfnc, StringValueCStr(name));
 }
-
-
 #endif

data/ext/c_location.h

@@ -0,0 +1,114 @@
+/* Load dladdr() function */
+#include <dlfcn.h>
+
+#include "ruby.h"
+
+// TODO: why is it necessary to define this here? It ought to be in <dlfcn.h>
+typedef struct {
+   const char *dli_fname;  /* Pathname of shared object that contains address */
+   void       *dli_fbase;  /* Address at which shared object is loaded */
+   const char *dli_sname;  /* Name of nearest symbol with address lower than addr */
+   void       *dli_saddr;  /* Exact address of symbol named in dli_sname */
+} Dl2_info;
+
+
+#ifdef RUBY_19
+
+typedef enum {
+    NOEX_PUBLIC    = 0x00,
+    NOEX_NOSUPER   = 0x01,
+    NOEX_PRIVATE   = 0x02,
+    NOEX_PROTECTED = 0x04,
+    NOEX_MASK      = 0x06,
+    NOEX_BASIC     = 0x08,
+    NOEX_UNDEF     = NOEX_NOSUPER,
+    NOEX_MODFUNC   = 0x12,
+    NOEX_SUPER     = 0x20,
+    NOEX_VCALL     = 0x40,
+    NOEX_RESPONDS  = 0x80
+} rb_method_flag_t;
+
+typedef enum {
+    VM_METHOD_TYPE_ISEQ,
+    VM_METHOD_TYPE_CFUNC,
+    VM_METHOD_TYPE_ATTRSET,
+    VM_METHOD_TYPE_IVAR,
+    VM_METHOD_TYPE_BMETHOD,
+    VM_METHOD_TYPE_ZSUPER,
+    VM_METHOD_TYPE_UNDEF,
+    VM_METHOD_TYPE_NOTIMPLEMENTED,
+    VM_METHOD_TYPE_OPTIMIZED, /* Kernel#send, Proc#call, etc */
+    VM_METHOD_TYPE_MISSING   /* wrapper for method_missing(id) */
+} rb_method_type_t;
+
+typedef struct rb_method_cfunc_struct {
+    VALUE (*func)(ANYARGS);
+    int argc;
+} rb_method_cfunc_t;
+
+typedef struct rb_method_attr_struct {
+    ID id;
+    VALUE location;
+} rb_method_attr_t;
+
+typedef struct rb_iseq_struct rb_iseq_t;
+typedef struct rb_method_definition_struct {
+    rb_method_type_t type; /* method type */
+    ID original_id;
+    union {
+        rb_iseq_t *iseq;            /* should be mark */
+        rb_method_cfunc_t cfunc;
+        rb_method_attr_t attr;
+        VALUE proc;                 /* should be mark */
+        enum method_optimized_type {
+            OPTIMIZED_METHOD_TYPE_SEND,
+            OPTIMIZED_METHOD_TYPE_CALL
+        } optimize_type;
+    } body;
+    int alias_count;
+} rb_method_definition_t;
+
+typedef struct rb_method_entry_struct {
+    rb_method_flag_t flag;
+    char mark;
+    rb_method_definition_t *def;
+    ID called_id;
+    VALUE klass;                    /* should be mark */
+} rb_method_entry_t;
+
+#ifdef RUBY_193
+
+struct METHOD {
+    VALUE recv;
+    VALUE rclass;
+    ID id;
+    rb_method_entry_t *me;
+    struct unlinked_method_entry_list_entry *ume;
+};
+
+#else /* RUBY_192 */
+
+struct METHOD {
+    VALUE recv;
+    VALUE rclass;
+    ID id;
+    rb_method_entry_t me;
+    struct unlinked_method_entry_list_entry *ume;
+};
+
+#endif
+
+#else /* RUBY18 */
+
+#include "node.h"
+
+/* Copy-pasted out of Ruby 1.8.7, not part of the official C API.*/
+struct METHOD {
+    VALUE klass, rklass;
+    VALUE recv;
+    ID id, oid;
+    int safe_level;
+    NODE *body;
+};
+
+#endif

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: c_location
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-08 00:00:00.000000000Z
+date: 2012-04-09 00:00:00.000000000Z
 dependencies: []
 description: Allows you to find the source location of methods written in C
 email: conrad.irwin@gmail.com
@@ -22,6 +22,9 @@ files:
 - lib/c_location/resolver.rb
 - ext/extconf.rb
 - ext/c_location.c
+- ext/c_location.h
+- example/c_extension_location.rb
+- example/inbuilt_location.rb
 - README.md
 - LICENSE.MIT
 homepage: http://github.com/ConradIrwin/c_location
@@ -50,4 +53,3 @@ signing_key:
 specification_version: 3
 summary: ! 'Adds a #c_location to Method and UnboundMethod objects.'
 test_files: []
-has_rdoc: