fadvise 1.0

data/ext/extconf.rb

@@ -0,0 +1,4 @@
+require 'mkmf'
+
+have_func("posix_fadvise")
+create_makefile("fadvise")

data/ext/fadvise.c

@@ -0,0 +1,77 @@
+#include "ruby.h"
+#include <errno.h>
+
+static int symbols[6];
+static VALUE rb_Errno_EINVAL;
+
+#ifdef HAVE_POSIX_FADVISE
+
+#define _XOPEN_SOURCE 600
+#include <fcntl.h>
+/*
+ * call-seq:
+ *   file.fadvise(offset,len,advice) -> file
+ * 
+ * Advise the operating system how you intend to use the data in this file,
+ * starting from byte +offset+ and counting +len+ bytes, so that the kernel can
+ * schedule it to be fetched in the background while you do more processing. This
+ * call is intended to avoid blocking later when you actually read the data,
+ * but whether this actually happens is up to the the kernel's IO scheduler.
+ * Valid values for advice are:
+ * * <tt>:normal</tt>
+ * * <tt>:sequential</tt>
+ * * <tt>:random</tt>
+ * * <tt>:no_reuse</tt>
+ * * <tt>:will_need</tt>
+ * * <tt>:dont_need</tt>
+ *
+ * This call does not block.
+ *
+ * See the posix_fadvise(2) manpage for more information about these types of advice.
+ */
+static VALUE File_fadvise(VALUE self, VALUE offset, VALUE len, VALUE advice){
+   int fd;
+   int madvice;
+   fd=NUM2INT(rb_funcall(self,rb_intern("fileno"),0));
+   madvice=SYM2ID(advice);
+   if(madvice == symbols[0])      madvice=POSIX_FADV_NORMAL;
+   else if(madvice == symbols[1]) madvice=POSIX_FADV_SEQUENTIAL;
+   else if(madvice == symbols[2]) madvice=POSIX_FADV_RANDOM;
+   else if(madvice == symbols[3]) madvice=POSIX_FADV_NOREUSE;
+   else if(madvice == symbols[4]) madvice=POSIX_FADV_WILLNEED;
+   else if(madvice == symbols[5]) madvice=POSIX_FADV_DONTNEED;
+   else rb_raise(rb_Errno_EINVAL,":%s is not valid advice",rb_id2name(SYM2ID(advice)));
+
+   if (!posix_fadvise(self,NUM2OFFT(offset),NUM2OFFT(len),madvice)){
+      rb_sys_fail(0);
+   }
+
+   return self;
+}
+#else
+//dummy implementation for systems that don't have fadvise
+//do all the same error checking
+static VALUE File_fadvise(VALUE self, VALUE offset, VALUE len, VALUE advice){
+   int fd;
+   int madvice;
+   int i;
+   fd=NUM2INT(rb_funcall(self,rb_intern("fileno"),0));
+   madvice=SYM2ID(advice);
+   for (i=0; i<6; ++i){
+      if(madvice == symbols[i]) return self;
+   }
+   rb_raise(rb_Errno_EINVAL,":%s is not valid advice",rb_id2name(SYM2ID(advice)));
+   return self;
+}
+#endif
+
+void Init_fadvise(){
+   rb_Errno_EINVAL = rb_eval_string("Errno::EINVAL");
+   symbols[0]=rb_intern("normal");
+   symbols[1]=rb_intern("sequential");
+   symbols[2]=rb_intern("random");
+   symbols[3]=rb_intern("no_reuse");
+   symbols[4]=rb_intern("will_need");
+   symbols[5]=rb_intern("dont_need");
+   rb_define_method(rb_cFile,"fadvise",File_fadvise,3);
+}

data/test/test.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require 'test/unit'
+
+$: << File.expand_path(File.dirname(__FILE__)) + '/../ext'
+require 'fadvise'
+
+class TestFadvise < Test::Unit::TestCase
+  def test_symbols
+    f=open("/dev/zero")
+    assert_nothing_thrown{ f.fadvise 0,0,:normal }
+    assert_nothing_thrown{ f.fadvise 0,0,:sequential }
+    assert_nothing_thrown{ f.fadvise 0,0,:random }
+    assert_nothing_thrown{ f.fadvise 0,0,:no_reuse }
+    assert_nothing_thrown{ f.fadvise 0,0,:will_need }
+    assert_nothing_thrown{ f.fadvise 0,0,:dont_need }
+    assert_raise(Errno::EINVAL){ f.fadvise 0,0,:foobar }
+    f.close
+  end
+
+  def test_closed
+    f=open("/dev/zero")
+    assert_nothing_thrown{ f.fadvise 0,0,:normal }
+    f.close
+    assert_raise(IOError){ f.fadvise 0,0,:normal }
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification 
+name: fadvise
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Ken Bloom
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-27 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: kbloom@gmail.com
+executables: []
+
+extensions: 
+- ext/extconf.rb
+extra_rdoc_files: []
+
+files: 
+- ext/fadvise.c
+- ext/extconf.rb
+- test/test.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- ext
+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.2.0
+signing_key: 
+specification_version: 2
+summary: A binding to the posix_fadvise system call
+test_files: []
+