methodmissing-vio 0.1.0

data/README

@@ -0,0 +1,37 @@
+Vectored I/O for Ruby MRI
+  (c) 2009 Lourens Naudé (methodmissing) 
+ 
+  http://github.com/methodmissing/vio
+
+Vectored I/O ?
+
+  POSIX 1003.1-2001 introduces reading or writing data into multiple buffers with a single procedure call.See http://en.wikipedia.org/wiki/Vectored_I/O for an overview.
+
+Use cases :
+
+  * Write non-sequentially placed data in memory to disk with a single write operation.This fits very well with custom database/record formats for writing out indexes and data at once.
+  * Reducing syscall overheads
+  * Reading structured data (protocol dumps,db records) into distinct buffers
+
+Examples :
+
+  8=FIX.4.4
9=45
35=0
49=TW
56=ISLD
34=3
52=20000426-12:05:06
10=220

+
+  >>io = File.open('/path/to/fix.txt')) 
+  => #<File://path/to/fix.txt>
+  >>io.read([9, 5, 5, 6, 8, 26, 8]) 
+  => ["8=FIX.4.4","\x019=45", "\x0135=0", "\x0149=TW", "\x0156=ISLD",
+"\x0134=3\x0152=20000426-12:05:06", "\x0110=220\x01"]    
+
+Todo :
+
+  * Error handling for rewind
+  * An API that doesn't impose array arguments
+
+To run the test suite:
+
+  rake
+
+To run the benchmarks:
+
+  rake bench

data/Rakefile

@@ -0,0 +1,68 @@
+#!/usr/bin/env rake
+require 'rake/testtask'
+require 'rake/clean'
+$:.unshift(File.expand_path('lib'))
+VIO_ROOT = 'ext/vio'
+
+desc 'Default: test'
+task :default => :test
+
+desc 'Run VIO tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs = [VIO_ROOT]
+  t.pattern = 'test/test_*.rb'
+  t.verbose = true
+end
+task :test => :build
+
+namespace :build do
+  file "#{VIO_ROOT}/vio.c"
+  file "#{VIO_ROOT}/extconf.rb"
+  file "#{VIO_ROOT}/Makefile" => %W(#{VIO_ROOT}/vio.c #{VIO_ROOT}/extconf.rb) do
+    Dir.chdir(VIO_ROOT) do
+      ruby 'extconf.rb'
+    end
+  end
+
+  desc "generate makefile"
+  task :makefile => %W(#{VIO_ROOT}/Makefile #{VIO_ROOT}/vio.c)
+
+  dlext = Config::CONFIG['DLEXT']
+  file "#{VIO_ROOT}/vio.#{dlext}" => %W(#{VIO_ROOT}/Makefile #{VIO_ROOT}/vio.c) do
+    Dir.chdir(VIO_ROOT) do
+      sh 'make' # TODO - is there a config for which make somewhere?
+    end
+  end
+
+  desc "compile vio extension"
+  task :compile => "#{VIO_ROOT}/vio.#{dlext}"
+
+  task :clean do
+    Dir.chdir(VIO_ROOT) do
+      sh 'make clean'
+    end if File.exists?("#{VIO_ROOT}/Makefile")
+  end
+
+  CLEAN.include("#{VIO_ROOT}/Makefile")
+  CLEAN.include("#{VIO_ROOT}/vio.#{dlext}")
+end
+
+task :clean => %w(build:clean)
+
+desc "compile"
+task :build => %w(build:compile)
+
+task :install do |t|
+  Dir.chdir(VIO_ROOT) do
+    sh 'sudo make install'
+  end
+end
+
+desc "clean build install"
+task :setup => %w(clean build install)
+
+desc "run benchmarks"
+task :bench do |t|
+  ruby "bench/read.rb"
+end  
+task :bench => :build

data/ext/vio/extconf.rb

@@ -0,0 +1,13 @@
+require 'mkmf'
+
+def add_define(name)
+  $defs.push("-D#{name}")
+end
+
+dir_config('vio')
+add_define 'RUBY19' if have_func('rb_thread_blocking_region') and have_macro('RUBY_UBF_IO', 'ruby.h')
+add_define 'RUBY18' if have_var('rb_trap_immediate', ['ruby.h', 'rubysig.h'])
+
+$defs.push("-pedantic")
+
+create_makefile('vio')

data/ext/vio/vio.c

@@ -0,0 +1,116 @@
+#include "ruby.h"
+#include <sys/types.h>
+#include <sys/uio.h>
+#include <unistd.h>
+
+#ifndef RSTRING_PTR
+#define RSTRING_PTR(obj) RSTRING(obj)->ptr
+#endif
+ 
+#ifndef RSTRING_LEN
+#define RSTRING_LEN(obj) RSTRING(obj)->len
+#endif
+
+#ifndef RARRAY_PTR
+#define RARRAY_PTR(obj) RARRAY(obj)->ptr
+#endif
+ 
+#ifndef RARRAY_LEN
+#define RARRAY_LEN(obj) RARRAY(obj)->len
+#endif
+
+#ifdef RUBY19
+  #include "ruby/io.h" 
+  #define TRAP_BEG
+  #define TRAP_END
+#else
+  #include "rubysig.h"
+  #include "rubyio.h"
+#endif
+
+static VALUE 
+vio_read(VALUE io, VALUE iov)
+{
+    Check_Type(iov, T_ARRAY);
+    int fd;
+#ifdef RUBY19
+    rb_io_t *fptr;
+#else
+    OpenFile *fptr;
+#endif
+    if (RARRAY_LEN(iov) == 0) rb_raise(rb_eIOError, "No buffer offsets given");  
+    GetOpenFile(io, fptr);
+    rb_io_check_readable(fptr);
+#ifdef RUBY19
+    fd = fptr->fd;
+#else
+    fd = fileno(fptr->f);
+#endif
+    /* XXX Todo: Error handling */
+    lseek(fd, 0L, SEEK_SET);
+    fptr->lineno = 0;
+    struct iovec iovs[IOV_MAX];
+    int i, size, bytes_read;
+    int expected = 0;
+    int cnt = RARRAY_LEN(iov);
+    VALUE results = rb_ary_new2(cnt);
+    for (i=0; i < cnt; i++) {
+      size = FIX2INT(RARRAY_PTR(iov)[i]);
+      expected = expected + size;
+      iovs[i].iov_len = size;
+      iovs[i].iov_base = malloc(size);
+    }    
+    bytes_read = readv(fd,iovs,cnt);
+    if (bytes_read < expected) rb_raise(rb_eIOError, "Vectored I/O read failure!");
+    for (i=0; i < cnt; i++) {
+      rb_ary_push(results, rb_tainted_str_new((char *)iovs[i].iov_base, iovs[i].iov_len));
+    }
+    return results;
+}
+
+static VALUE 
+vio_write(VALUE io, VALUE iov)
+{
+   Check_Type(iov, T_ARRAY);
+   int fd;
+#ifdef RUBY19
+    rb_io_t *fptr;
+#else
+    OpenFile *fptr;
+#endif
+    if (RARRAY_LEN(iov) == 0) rb_raise(rb_eIOError, "No buffers to write given");  
+    GetOpenFile(io, fptr);
+    rb_io_check_writable(fptr);
+#ifdef RUBY19
+    fd = fptr->fd;
+#else
+    fd = fileno(fptr->f);
+#endif
+    /* XXX Todo: Error handling */
+    lseek(fd, 0L, SEEK_SET);
+    fptr->lineno = 0;
+    struct iovec iovs[IOV_MAX];
+    int i, size, bytes_written;
+    int expected = 0;
+    int cnt = RARRAY_LEN(iov);
+    VALUE results = rb_ary_new2(cnt);
+    for (i=0; i < cnt; i++) {
+      VALUE str = RARRAY_PTR(iov)[i];
+      size = RSTRING_LEN(str);
+      expected = expected + size;
+      iovs[i].iov_len = size;
+      iovs[i].iov_base = RSTRING_PTR(str);
+    }    
+    bytes_written = writev(fd,iovs,cnt);
+    if (bytes_written < expected) rb_raise(rb_eIOError, "Vectored I/O write failure!");
+    for (i=0; i < cnt; i++) {
+      rb_ary_push(results, INT2FIX(iovs[i].iov_len));
+    }
+    return results;
+}
+
+void Init_vio()
+{
+    rb_define_method(rb_cIO, "readv", vio_read, 1);
+    rb_define_method(rb_cIO, "writev", vio_write, 1);
+}

data/vio.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name     = "vio"
+  s.version  = "0.1.0"
+  s.date     = "2009-09-19"
+  s.summary  = "Vectored I/O extension for Ruby"
+  s.email    = "lourens@methodmissing.com"
+  s.homepage = "http://github.com/methodmissing/vio"
+  s.description = "Vectored I/O extension for Ruby MRI (1.8.{6,7} and 1.9.2)"
+  s.has_rdoc = true
+  s.authors  = ["Lourens Naudé (methodmissing)"]
+  s.platform = Gem::Platform::RUBY
+  s.files    = %w[
+    README
+    Rakefile
+    ext/vio/extconf.rb
+    ext/vio/vio.c
+    vio.gemspec
+  ] + Dir.glob('test/*')
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README"]
+  s.extensions << "ext/vio/extconf.rb"
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: methodmissing-vio
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Lourens Naud\xC3\xA9 (methodmissing)"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-19 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Vectored I/O extension for Ruby MRI (1.8.{6,7} and 1.9.2)
+email: lourens@methodmissing.com
+executables: []
+
+extensions: 
+- ext/vio/extconf.rb
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- ext/vio/extconf.rb
+- ext/vio/vio.c
+- vio.gemspec
+has_rdoc: true
+homepage: http://github.com/methodmissing/vio
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Vectored I/O extension for Ruby
+test_files: []
+