sendfile 0.9.1

data/ChangeLog

@@ -0,0 +1,11 @@
+* sendfile 0.9.1 - 2006.03.24 <toby@cbcg.net>
+
+  - Improved interface with non-blocking sockets
+  - Added unit tests for blocking sends
+  - Added unit tests for nonblocking sends
+  - Added README
+  - Packaged in a RubyGem
+
+* sendfile 0.0.1 - 2005.11.16 <toby@cbcg.net>
+
+  - Initial release

data/FILES

@@ -0,0 +1,10 @@
+FILES
+README
+LICENSE
+ChangeLog
+ext/extconf.rb
+ext/sendfile.c
+test/test_sendfile.rb
+test/large.gz
+test/small
+sendfile.gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+
+Copyright (c) 2005 Tobias DiPasquale
+
+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/README

@@ -0,0 +1,57 @@
+= Ruby sendfile(2) Interface
+
+This module allows Ruby programs to access their OS's native
+sendfile(2) system call from any IO object. Your kernel must
+export a recognized signature for the sendfile(2) system call
+to use this module. Currently, that includes Linux, Solaris
+and FreeBSD.
+
+== Installation
+
+Download and install the latest package from the rubyforge.org
+RubyGems repository.
+
+  gem install sendfile --remote
+  gem check sendfile --test
+
+If the tests all pass, you're ready to start using sendfile.
+
+Or, if you don't have rubygems installed, you can install by
+hand by downloading the tarball:
+
+  tar xzvf ruby-sendfile-<latest>.tar.gz
+  cd ruby-sendfile-<latest>/ext
+  ruby extconf.rb
+  make
+  sudo make install
+
+You can then run the tests with:
+
+  ruby test/test_*.rb
+
+== Usage
+
+Here's a small example of a use of IO#sendfile.
+
+  require 'socket'
+  require 'rubygems'
+  require 'sendfile'
+
+  s = TCPSocket.new 'yourdomain.com', 5000
+  File.open 'somefile.txt' { |f| s.sendfile f }
+  s.close
+
+See the test scripts for more examples on how to use this 
+module.
+
+== Contact Information
+
+This project's homepage is:
+
+  http://rubyforge.org/projects/ruby-sendfile
+
+Thereupon are additional resources, such as news and forums
+can be found for working out any issues you may have with this
+module. In the last case, you can email questions or patches
+to toby@cbcg.net.
+

data/ext/extconf.rb

@@ -0,0 +1,53 @@
+# 
+# Copyright (c) 2005 Tobias DiPasquale
+#
+# 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.
+#
+
+#
+# $Id: extconf.rb,v 1.1 2006/03/25 01:42:02 codeslinger Exp $
+#
+require 'mkmf'
+
+$config_h = ""
+case RUBY_PLATFORM
+when /solaris/
+	have_header( "sys/sendfile.h")
+	have_library( "sendfile", "sendfile")
+	$config_h << "#define RUBY_PLATFORM_SOLARIS"
+when /linux/
+	have_header( "sys/sendfile.h")
+	have_library( "c", "sendfile")
+	$config_h << "#define RUBY_PLATFORM_LINUX"
+when /freebsd/
+	have_library( "c", "sendfile")
+	$config_h << "#define RUBY_PLATFORM_FREEBSD"
+end
+
+File.open( "config.h", "w") do |f|
+f.print <<EOF
+#ifndef CONFIG_H
+#define CONFIG_H
+#{$config_h}
+#endif /* CONFIG_H */
+EOF
+end
+
+create_makefile( "sendfile")
+

data/ext/sendfile.c

@@ -0,0 +1,161 @@
+/*
+ * ------------------------------------------------------------------------
+ *
+ * Copyright (c) 2005 Tobias DiPasquale
+ *
+ * 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.
+ *
+ * ------------------------------------------------------------------------
+ *
+ * Ruby binding for the UNIX sendfile(2) facility. Should work on FreeBSD,
+ * Linux and Solaris systems that support sendfile(2).
+ *
+ * Original Author: Toby DiPasquale <toby@cbcg.net>
+ * Current Maintainer: Toby DiPasquale <toby@cbcg.net>
+ *
+ * $Id: sendfile.c,v 1.3 2006/03/26 16:03:59 codeslinger Exp $
+ */
+#include "ruby.h"
+#include "rubyio.h"
+#include "rubysig.h"
+#include "config.h"
+
+#if defined(RUBY_PLATFORM_FREEBSD)
+# include <sys/socket.h>
+# include <sys/stat.h>
+# include <sys/types.h>
+# include <sys/uio.h>
+#elif defined(RUBY_PLATFORM_LINUX)
+# include <sys/sendfile.h>
+# include <sys/stat.h>
+# include <sys/types.h>
+# include <unistd.h>
+#elif defined(RUBY_PLATFORM_SOLARIS)
+# include <sys/sendfile.h>
+# include <sys/stat.h>
+# include <sys/types.h>
+#endif
+
+#define SENDFILE_PAUSE_SEC 	0
+#define SENDFILE_PAUSE_USEC	500
+
+#if defined(RUBY_PLATFORM_FREEBSD)
+static off_t __sendfile( int out, int in, off_t off, size_t count, struct timeval *tv)
+{
+	int rv;
+	off_t written, initial = off;
+
+	while (1) {
+		TRAP_BEG;
+		rv = sendfile( in, out, off, count, NULL, &written, 0);
+		TRAP_END;
+		off += written;
+		count -= written;
+		if (rv < 0 && errno != EAGAIN)
+			rv_sys_fail( "sendfile");
+		if (!rv)
+			break;
+		rb_thread_select( 0, NULL, NULL, NULL, tv);
+	}
+	return off - initial;
+}
+#else
+static size_t __sendfile( int out, int in, off_t off, size_t count, struct timeval *tv)
+{
+	ssize_t rv, remaining = count;
+	
+	while (1) {
+		TRAP_BEG;
+		rv = sendfile( out, in, &off, remaining);
+		TRAP_END;
+		if (rv < 0 && errno != EAGAIN)
+			rb_sys_fail( "sendfile");
+		if (rv > 0)
+			remaining -= rv;
+		if (!remaining)
+			break;
+		rb_thread_select( 0, NULL, NULL, NULL, tv);
+	}
+	return count;
+}
+#endif
+
+/* call-seq:
+ * 	writeIO.sendfile( readIO, offset=0, count=nil) => integer
+ * 
+ * Transfers count bytes starting at offset from readIO directly to writeIO
+ * without copying (i.e. invoking the kernel to do it for you).
+ * 
+ * If offset is omitted, transfer starts at the beginning of the file. 
+ *
+ * If count is omitted, the full length of the file will be sent. 
+ *
+ * Returns the number of bytes sent on success. Will throw system error
+ * exception on error. (check man sendfile(2) on your platform for 
+ * information on what errors could result and how to handle them)
+ */
+static VALUE rb_io_sendfile( int argc, VALUE *argv, VALUE self)
+{
+	int i, o;
+	size_t c;
+	off_t off;
+	OpenFile *iptr, *optr;
+	VALUE in, offset, count;
+	struct timeval _sendfile_sleep;
+
+	/* get fds for files involved to pass to sendfile(2) */
+	rb_scan_args( argc, argv, "12", &in, &offset, &count);
+	if (TYPE( in) != T_FILE)
+		rb_raise( rb_eArgError, "invalid first argument\n");
+	GetOpenFile( self, optr);
+	GetOpenFile( in, iptr);
+	o = fileno( optr->f);
+	i = fileno( iptr->f);
+
+	_sendfile_sleep.tv_sec = SENDFILE_PAUSE_SEC;
+	_sendfile_sleep.tv_usec = SENDFILE_PAUSE_USEC;
+	
+	/* determine offset and count parameters */
+	off = (NIL_P( offset)) ? 0 : NUM2ULONG( offset);
+	if (NIL_P( count)) {
+		/* FreeBSD's sendfile() can take 0 as an indication to send
+		 * until end of file, but Linux and Solaris can't, and anyway 
+		 * we need the file size to ensure we send it all in the case
+		 * of a non-blocking fd */
+		struct stat s;
+		if (fstat( i, &s) == -1)
+			rb_sys_fail( "sendfile");
+		c = s.st_size;
+		c -= off;
+	} else {
+		c = NUM2ULONG( count);
+	}
+
+	/* now send the file */
+	return INT2FIX( __sendfile( o, i, off, c, &_sendfile_sleep));
+}
+
+/* Interface to the UNIX sendfile(2) system call. Should work on FreeBSD,
+ * Linux and Solaris systems that support the sendfile(2) system call.
+ */
+void Init_sendfile( void)
+{
+	rb_define_method( rb_cIO, "sendfile", rb_io_sendfile, -1);
+}
+

data/sendfile.gemspec

@@ -0,0 +1,25 @@
+# vim:set ts=4 sw=4 ai syntax=ruby:
+
+spec = Gem::Specification.new do |gs|
+	gs.name = 'sendfile'
+	gs.version = '0.9.1'
+	gs.summary = 'Ruby interface to sendfile(2) system call'
+	gs.description = <<-EOF
+Allows Ruby programs to access sendfile(2) functionality on 
+any IO object. Works on Linux, Solaris and FreeBSD with 
+blocking and non-blocking sockets.
+EOF
+	gs.author = 'Toby DiPasquale'
+	gs.email = 'toby@cbcg.net'
+	gs.rubyforge_project = 'ruby-sendfile'
+
+	gs.autorequire = 'sendfile'
+	gs.files = File.read( 'FILES').split( $/)
+	gs.test_files = Dir.glob 'test/test_*.rb'
+	gs.extensions << 'ext/extconf.rb'
+
+	gs.has_rdoc = true
+	gs.extra_rdoc_files = %w( README )
+	gs.required_ruby_version = '>= 1.8.0'
+end
+

data/test/small

@@ -0,0 +1 @@
+I love Pocky!

data/test/test_sendfile.rb

@@ -0,0 +1,174 @@
+#!/usr/bin/env ruby
+# vim:set ts=4 sw=4 ai:
+require 'io/nonblock'
+begin
+	require 'rubygems'
+rescue
+	nil
+end
+require 'sendfile'
+require 'socket'
+require 'tempfile'
+require 'test/unit'
+require 'zlib'
+
+class TestSendfile < Test::Unit::TestCase
+	def __fork_server
+		# open pipe for backchannel
+		@rd, @wr = IO.pipe
+		# fork server child
+		@pid = fork do
+			# close read end in child
+			@rd.close
+
+			# start listening and send port back to parent
+			ss = TCPServer.new @host, 0
+			@wr.write( [ ss.addr[1] ].pack( "S"))
+			@wr.flush
+
+			# read what they send and push it back up the pipe
+			while s = ss.accept
+				data = s.read
+				s.close
+				@wr.write( [data.length].pack( "N"))
+				@wr.write data
+				@wr.flush
+			end
+		end
+		
+		# close write end in parent and get server port
+		@wr.close
+		@port = @rd.read( 2).unpack( "S")[0]
+	end
+
+	def setup
+		@dir = File.dirname __FILE__
+		@host = '127.0.0.1'
+		__fork_server
+		
+		@smallfile = "#{@dir}/small"
+		@small = File.open @smallfile
+		@small_data = File.read @smallfile
+		
+		File.open( "#{@dir}/large.gz") do |f|
+			gzipped = Zlib::GzipReader.new f
+			@large_data = gzipped.read
+		end
+		@largefile = "/tmp/sendfiletest"
+		@large = File.open @largefile, 'w+'
+		@large.write @large_data
+		@large.flush
+	end
+
+	def teardown
+		@small.close
+		@large.close
+		File.unlink @largefile
+
+		Process.kill 'KILL', @pid
+		Process.wait
+	end
+
+	def __do_sendfile file, off=nil, count=nil
+		s = TCPSocket.new @host, @port
+		yield s if block_given?
+		sent = s.sendfile file, off, count
+		s.close
+		len = @rd.read( 4).unpack( "N")[0]
+		read = @rd.read len
+		[ sent, read ]
+	end
+		
+	def test_blocking_full_small
+		sent, read = __do_sendfile( @small)
+		assert_equal @small_data.size, sent
+		assert_equal @small_data.size, read.size
+		assert_equal @small_data, read
+	end
+
+	def test_nonblocking_full_small
+		sent, read = __do_sendfile( @small) { |s| s.nonblock = true }
+		assert_equal @small_data.size, sent
+		assert_equal @small_data.size, read.size
+		assert_equal @small_data, read
+	end
+
+	def test_blocking_full_large
+		sent, read = __do_sendfile( @large)
+		assert_equal @large_data.size, sent
+		assert_equal @large_data.size, read.size
+		assert_equal @large_data, read
+	end
+
+	def test_nonblocking_full_large
+		sent, read = __do_sendfile( @large) { |s| s.nonblock = true }
+		assert_equal @large_data.size, sent
+		assert_equal @large_data.size, read.size
+		assert_equal @large_data, read
+	end
+	
+	def test_blocking_from_offset
+		data = @large_data[4096..-1]
+		sent, read = __do_sendfile( @large, 4096)
+		assert_equal data.size, sent
+		assert_equal data.size, read.size
+		assert_equal data, read
+	end
+	
+	def test_blocking_partial_from_beginning
+		data = @large_data[0, 1048576]
+		sent, read = __do_sendfile( @large, 0, 1048576)
+		assert_equal data.size, sent
+		assert_equal data.size, read.size
+		assert_equal data, read
+	end
+
+	def test_blocking_partial_from_middle
+		data = @large_data[2048, 1048576]
+		sent, read = __do_sendfile( @large, 2048, 1048576)
+		assert_equal data.size, sent
+		assert_equal data.size, read.size
+		assert_equal data, read
+	end
+
+	def test_blocking_partial_to_end
+		data = @large_data[-1048576, 1048576]
+		sent, read = __do_sendfile( @large, @large_data.size - 1048576, 1048576)
+		assert_equal data.size, sent
+		assert_equal data.size, read.size
+		assert_equal data, read
+	end
+
+	def test_nonblocking_from_offset
+		data = @large_data[4096..-1]
+		sent, read = __do_sendfile( @large, 4096) { |s| s.nonblock = true }
+		assert_equal data.size, sent
+		assert_equal data.size, read.size
+		assert_equal data, read
+	end
+	
+	def test_nonblocking_partial_from_beginning
+		data = @large_data[0, 1048576]
+		sent, read = __do_sendfile( @large, 0, 1048576) { |s| s.nonblock = true }
+		assert_equal data.size, sent
+		assert_equal data.size, read.size
+		assert_equal data, read
+	end
+
+	def test_nonblocking_partial_from_middle
+		data = @large_data[2048, 1048576]
+		sent, read = __do_sendfile( @large, 2048, 1048576) { |s| s.nonblock = true }
+		assert_equal data.size, sent
+		assert_equal data.size, read.size
+		assert_equal data, read
+	end
+
+	def test_nonblocking_partial_to_end
+		data = @large_data[-1048576, 1048576]
+		sent, read = __do_sendfile( @large, @large_data.size - 1048576, 1048576) { |s| s.nonblock = true }
+		assert_equal data.size, sent
+		assert_equal data.size, read.size
+		assert_equal data, read
+	end
+end		# class TestSendfile
+

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: sendfile
+version: !ruby/object:Gem::Version 
+  version: 0.9.1
+date: 2006-03-26 00:00:00 -05:00
+summary: Ruby interface to sendfile(2) system call
+require_paths: 
+- lib
+email: toby@cbcg.net
+homepage: 
+rubyforge_project: ruby-sendfile
+description: Allows Ruby programs to access sendfile(2) functionality on  any IO object. Works on Linux, Solaris and FreeBSD with  blocking and non-blocking sockets.
+autorequire: sendfile
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Toby DiPasquale
+files: 
+- FILES
+- README
+- LICENSE
+- ChangeLog
+- ext/extconf.rb
+- ext/sendfile.c
+- test/test_sendfile.rb
+- test/large.gz
+- test/small
+- sendfile.gemspec
+test_files: 
+- test/test_sendfile.rb
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: 
+- ext/extconf.rb
+requirements: []
+
+dependencies: []
+