syscalls 0.0.1

data/README.rdoc

@@ -0,0 +1,58 @@
+= syscalls
+
+* http://github.com/jdleesmiller/syscalls_ruby
+
+== SYNOPSIS
+
+An extension that lists the system's supported syscalls (e.g. SYS_open,
+SYS_write, etc.)}. These are read from <tt>sys/syscall.h</tt> when the gem is
+built.
+
+So far this has been tested on a couple of Linux machines; it should in
+principle work on other *nixes, but I haven't tested it.
+
+=== Usage
+
+  require 'rubygems'
+  require 'syscalls'
+
+  include Syscalls
+  puts Process.pid         #=> (your process's pid)
+  puts syscall(SYS_getpid) #=> (your process's pid)
+
+== REQUIREMENTS
+
+Tested on:
+* ruby 1.9.2p290 (2011-07-09 revision 32553) [i686-linux] (Debian squeeze)
+* ruby 1.9.2p180 (2011-02-18 revision 30909) [x86_64-linux] (CentOS 5.5)
+* ruby 1.8.7 (2011-02-18 patchlevel 334) [x86_64-linux] (CentOS 5.5)
+
+== INSTALLATION
+
+  sudo gem install syscalls
+
+== LICENSE
+
+(The MIT License)
+
+Copyright (c) 2011 John Lees-Miller
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/ext/extconf.rb

@@ -0,0 +1,58 @@
+require 'mkmf'
+require 'erb'
+
+#
+# sys/syscall.h comes from glibc; it lists the SYS_ constants; see
+# http://www.delorie.com/gnu/docs/glibc/libc_556.html
+#
+raise "cannot find sys/syscall.h" unless have_header('sys/syscall.h')
+
+#
+# use "gcc -E -dD" on a file that includes sys/syscall.h to get the preprocessor
+# output (including defines, due to -dD); this gives us a list of SYS_call
+# constants
+#
+# the reasons for not just reading in syscall.h directly are that (1) we don't
+# always know where it is, and (2) some of the constants are conditioned out at
+# compile time (e.g. 32-bit vs. 64-bit); running it through the gcc preprocessor
+# solves these problems
+#
+# the call to RbConfig::expand is based on cc_command in mkmf.rb from 1.9.2p290;
+# we do this to ensure that we use the right gcc flags
+#
+conf = RbConfig::CONFIG.merge('hdrdir' => $hdrdir.quote,
+                              'srcdir' => $srcdir.quote,
+                              'arch_hdrdir' => "#$arch_hdrdir",
+                              'top_srcdir' => ($top_srcdir || '').quote)
+cmd = RbConfig::expand(
+  "$(CC) #$INCFLAGS #$CPPFLAGS #$CFLAGS #$ARCH_FLAG -E -dD -", conf)
+lines = IO.popen(cmd, 'r+') {|io|
+  io.puts "#include <sys/syscall.h>"
+  io.close_write
+  io.readlines
+}
+
+syscall_names = lines.map {|l| $1 if l =~ /#define\s+(SYS_\S+)\s+/}.compact
+
+#
+# generate the extension 
+#
+File.open('syscalls.c', 'w') do |f|
+  template = ERB.new(<<EOF)
+/* THIS FILE IS GENERATED BY extconf.rb */
+#include <ruby.h>
+#include <sys/syscall.h>
+
+void
+Init_syscalls(void)
+{
+    VALUE mod = rb_define_module("Syscalls");
+<% syscall_names.each do |name| %>
+    rb_define_const(mod, "<%= name %>", INT2FIX(<%= name %>));
+<% end %>
+}
+EOF
+  f.puts template.result(binding)
+end
+
+create_makefile('syscalls')

data/lib/syscalls.rb

@@ -0,0 +1,24 @@
+require 'syscalls.so'
+require 'syscalls/version'
+
+#
+# System call constants (e.g. SYS_open). 
+#
+# The constant names and values in this module are system-dependent. They are
+# read in from <tt>sys/syscall.h</tt> when this gem is built.
+#
+# The {SYS_NUMBER} and {SYS_NAME} hashes provide an easy way of converting from
+# names to numbers.
+#
+module Syscalls
+  #
+  # Hash from system call names (as symbols) to system call numbers.
+  #
+  SYS_NUMBER = Hash[self.constants.grep(/SYS_/).map{|c|
+    [c.to_sym, self.const_get(c)]}]
+
+  #
+  # Hash from system call numbers to system call names (as symbols).
+  #
+  SYS_NAME = SYS_NUMBER.invert
+end

data/lib/syscalls/version.rb

@@ -0,0 +1,6 @@
+module Syscalls
+  VERSION_MAJOR = 0
+  VERSION_MINOR = 0
+  VERSION_PATCH = 1
+  VERSION = [VERSION_MAJOR,VERSION_MINOR,VERSION_PATCH].join('.')
+end

data/test/syscalls_test.rb

@@ -0,0 +1,16 @@
+require 'syscalls'
+require 'test/unit'
+
+class TestSyscalls < Test::Unit::TestCase
+  include Syscalls
+
+  def test_syscalls
+    assert_equal SYS_open, SYS_NUMBER[:SYS_open]
+    assert_equal :SYS_open, SYS_NAME[SYS_open]
+  end
+
+  def test_getpid
+    assert_equal Process.pid, syscall(SYS_getpid)
+  end
+end
+

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: syscalls
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- John Lees-Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-23 00:00:00.000000000 +01:00
+default_executable: 
+dependencies: []
+description: An extension that lists the system's supported syscalls (e.g. SYS_open,
+  SYS_write, etc.)
+email:
+- jdleesmiller@gmail.com
+executables: []
+extensions:
+- ext/extconf.rb
+extra_rdoc_files:
+- README.rdoc
+files:
+- lib/syscalls.rb
+- lib/syscalls/version.rb
+- README.rdoc
+- test/syscalls_test.rb
+- ext/extconf.rb
+has_rdoc: true
+homepage: https://github.com/jdleesmiller/syscalls_ruby
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+- --title
+- syscalls-0.0.1 Documentation
+require_paths:
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ''
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Constants for syscall numbers
+test_files:
+- test/syscalls_test.rb