io_splice 0.1.0

data/.document

@@ -0,0 +1,6 @@
+README
+LICENSE
+NEWS
+ChangeLog
+lib
+ext/io_splice/io_splice_ext.c

data/.gitignore

@@ -0,0 +1,14 @@
+*.o
+*.so
+*.log
+*.rbc
+Makefile
+/GIT-VERSION-FILE
+/local.mk
+/NEWS
+/ChangeLog
+/.manifest
+/GIT-VERSION-FILE
+/man
+/pkg
+/doc

data/COPYING

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/GIT-VERSION-GEN

@@ -0,0 +1,40 @@
+#!/bin/sh
+
+GVF=GIT-VERSION-FILE
+DEF_VER=v0.1.0.GIT
+
+LF='
+'
+
+# First see if there is a version file (included in release tarballs),
+# then try git-describe, then default.
+if test -f version
+then
+	VN=$(cat version) || VN="$DEF_VER"
+elif test -d .git -o -f .git &&
+	VN=$(git describe --abbrev=4 HEAD 2>/dev/null) &&
+	case "$VN" in
+	*$LF*) (exit 1) ;;
+	v[0-9]*)
+		git update-index -q --refresh
+		test -z "$(git diff-index --name-only HEAD --)" ||
+		VN="$VN-dirty" ;;
+	esac
+then
+	VN=$(echo "$VN" | sed -e 's/-/./g');
+else
+	VN="$DEF_VER"
+fi
+
+VN=$(expr "$VN" : v*'\(.*\)')
+
+if test -r $GVF
+then
+	VC=$(sed -e 's/^GIT_VERSION = //' <$GVF)
+else
+	VC=unset
+fi
+test "$VN" = "$VC" || {
+	echo >&2 "GIT_VERSION = $VN"
+	echo "GIT_VERSION = $VN" >$GVF
+}

data/GNUmakefile

@@ -0,0 +1,169 @@
+# use GNU Make to run tests in parallel, and without depending on RubyGems
+all::
+RUBY = ruby
+RAKE = rake
+GIT_URL = git://git.bogomips.org/ruby_io_splice.git
+
+GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
+	@./GIT-VERSION-GEN
+-include GIT-VERSION-FILE
+-include local.mk
+ifeq ($(DLEXT),) # "so" for Linux
+  DLEXT := $(shell $(RUBY) -rrbconfig -e 'puts Config::CONFIG["DLEXT"]')
+endif
+ifeq ($(RUBY_VERSION),)
+  RUBY_VERSION := $(shell $(RUBY) -e 'puts RUBY_VERSION')
+endif
+
+install: $(bins)
+	$(prep_setup_rb)
+	$(RM) -r .install-tmp
+	mkdir .install-tmp
+	cp -p bin/* .install-tmp
+	$(RUBY) setup.rb all
+	$(RM) $^
+	mv .install-tmp/* bin/
+	$(RM) -r .install-tmp
+	$(prep_setup_rb)
+
+setup_rb_files := .config InstalledFiles
+prep_setup_rb := @-$(RM) $(setup_rb_files);$(MAKE) -C $(ext) clean
+
+clean:
+	-$(MAKE) -C ext/io_splice clean
+	$(RM) $(setup_rb_files) ext/io_splice/Makefile
+
+pkg_extra := GIT-VERSION-FILE NEWS ChangeLog
+manifest: $(pkg_extra)
+	$(RM) .manifest
+	$(MAKE) .manifest
+
+.manifest:
+	(git ls-files && \
+         for i in $@ $(pkg_extra) $(man1_paths); \
+	 do echo $$i; done) | LC_ALL=C sort > $@+
+	cmp $@+ $@ || mv $@+ $@
+	$(RM) $@+
+
+NEWS: GIT-VERSION-FILE
+	$(RAKE) -s news_rdoc > $@+
+	mv $@+ $@
+
+SINCE =
+ChangeLog: LOG_VERSION = \
+  $(shell git rev-parse -q "$(GIT_VERSION)" >/dev/null 2>&1 && \
+          echo $(GIT_VERSION) || git describe)
+ifneq ($(SINCE),)
+ChangeLog: log_range = v$(SINCE)..$(LOG_VERSION)
+endif
+ChangeLog: GIT-VERSION-FILE
+	@echo "ChangeLog from $(GIT_URL) ($(log_range))" > $@+
+	@echo >> $@+
+	git log $(log_range) | sed -e 's/^/    /' >> $@+
+	mv $@+ $@
+
+news_atom := http://bogomips.org/ruby_io_splice/NEWS.atom.xml
+cgit_atom := http://git.bogomips.org/cgit/ruby_io_splice.git/atom/?h=master
+atom = <link rel="alternate" title="Atom feed" href="$(1)" \
+             type="application/atom+xml"/>
+
+# using rdoc 2.4.1+
+doc: .document NEWS ChangeLog
+	for i in $(man1_bins); do > $$i; done
+	rdoc -Na -t "$(shell sed -ne '1s/^= //p' README)"
+	install -m644 COPYING doc/COPYING
+	install -m644 $(shell grep '^[A-Z]' .document) doc/
+	cd doc && for i in $(base_bins); do \
+	  html=$$(echo $$i | sed 's/\.rb/_rb/')_1.html; \
+	  sed -e '/"documentation">/r man1/'$$i'.1.html' \
+		< $$html > tmp && mv tmp $$html; done
+	$(RUBY) -i -p -e \
+	  '$$_.gsub!("</title>",%q{\&$(call atom,$(cgit_atom))})' \
+	  doc/ChangeLog.html
+	$(RUBY) -i -p -e \
+	  '$$_.gsub!("</title>",%q{\&$(call atom,$(news_atom))})' \
+	  doc/NEWS.html doc/README.html
+	$(RAKE) -s news_atom > doc/NEWS.atom.xml
+	cd doc && ln README.html tmp && mv tmp index.html
+	$(RM) $(man1_bins)
+
+ifneq ($(VERSION),)
+rfproject := qrp
+rfpackage := io_splice
+pkggem := pkg/$(rfpackage)-$(VERSION).gem
+pkgtgz := pkg/$(rfpackage)-$(VERSION).tgz
+release_notes := release_notes-$(VERSION)
+release_changes := release_changes-$(VERSION)
+
+release-notes: $(release_notes)
+release-changes: $(release_changes)
+$(release_changes):
+	$(RAKE) -s release_changes > $@+
+	$(VISUAL) $@+ && test -s $@+ && mv $@+ $@
+$(release_notes):
+	GIT_URL=$(GIT_URL) $(RAKE) -s release_notes > $@+
+	$(VISUAL) $@+ && test -s $@+ && mv $@+ $@
+
+# ensures we're actually on the tagged $(VERSION), only used for release
+verify:
+	test x"$(shell umask)" = x0022
+	git rev-parse --verify refs/tags/v$(VERSION)^{}
+	git diff-index --quiet HEAD^0
+	test `git rev-parse --verify HEAD^0` = \
+	     `git rev-parse --verify refs/tags/v$(VERSION)^{}`
+
+fix-perms:
+	-git ls-tree -r HEAD | awk '/^100644 / {print $$NF}' | xargs chmod 644
+	-git ls-tree -r HEAD | awk '/^100755 / {print $$NF}' | xargs chmod 755
+
+gem: $(pkggem)
+
+install-gem: $(pkggem)
+	gem install $(CURDIR)/$<
+
+$(pkggem): manifest fix-perms
+	gem build $(rfpackage).gemspec
+	mkdir -p pkg
+	mv $(@F) $@
+
+$(pkgtgz): distdir = $(basename $@)
+$(pkgtgz): HEAD = v$(VERSION)
+$(pkgtgz): manifest fix-perms
+	@test -n "$(distdir)"
+	$(RM) -r $(distdir)
+	mkdir -p $(distdir)
+	tar c `cat .manifest` | (cd $(distdir) && tar x)
+	cd pkg && tar c $(basename $(@F)) | gzip -9 > $(@F)+
+	mv $@+ $@
+
+package: $(pkgtgz) $(pkggem)
+
+test-release: verify package $(release_notes) $(release_changes)
+release: verify package $(release_notes) $(release_changes)
+	# make tgz release on RubyForge
+	rubyforge add_release -f -n $(release_notes) -a $(release_changes) \
+	  $(rfproject) $(rfpackage) $(VERSION) $(pkgtgz)
+	# push gem to Gemcutter
+	gem push $(pkggem)
+	# in case of gem downloads from RubyForge releases page
+	-rubyforge add_file \
+	  $(rfproject) $(rfpackage) $(VERSION) $(pkggem)
+else
+gem install-gem: GIT-VERSION-FILE
+	$(MAKE) $@ VERSION=$(GIT_VERSION)
+endif
+
+ext := ext/io_splice/io_splice_ext.$(DLEXT)
+ext/io_splice/Makefile: ext/io_splice/extconf.rb
+	cd $(@D) && $(RUBY) extconf.rb
+$(ext): $(wildcard $(addprefix ext/io_splice/,*.c *.h)) ext/io_splice/Makefile
+	$(MAKE) -C $(@D)
+
+all:: test
+
+build: $(ext)
+test: test-unit
+test-unit: build
+	$(RUBY) -I lib:ext/io_splice test/test_io_splice.rb
+
+.PHONY: .FORCE-GIT-VERSION-FILE doc manifest man test

data/LICENSE

@@ -0,0 +1,16 @@
+io_splice is copyrighted Free Software by all contributors, see logs in
+revision control for names and email addresses of all of them.
+
+You can redistribute it and/or modify it under either the terms of the GNU
+Lesser General Public License as published by the Free Software Foundation,
+version 3.0 {LGPLv3}[http://www.gnu.org/licenses/lgpl-3.0.txt] (see
+link:COPYING).
+
+posix_mq is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
+License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with the GNU C Library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301

data/README

@@ -0,0 +1,87 @@
+= io_splice - zero-copy pipe I/O for Linux and Ruby
+
+The splice family of Linux system calls can transfer data between file
+descriptors without the need to copy data into userspace.  Instead of a
+userspace buffer, they rely on an ordinary Unix pipe as a kernel-level
+buffer.
+
+== Features
+
+* Efficient zero-copy I/O avoids data copies into userspace,
+  reducing garbage for the Ruby garbage collector as a side effect.
+
+* More flexible than sendfile, may be used to enable copies between
+  arbitrary file descriptors (assuming kernel support), not just
+  socket-to-file.
+
+* Thread-safe blocking operations under Ruby 1.9, releases GVL
+  if blocking operations are used.
+
+* Safely usable with non-blocking I/O frameworks (unlike IO.copy_stream)
+  when combined with the IO::Splice::F_NONBLOCK flag.
+
+* Fully-documented library API and
+  {examples}[http://bogomips.org/ruby_io_splice/examples/]
+
+== Install
+
+Operating system support for the splice(2), tee(2) and vmsplice(2)
+system calls is required.  Currently, only Linux 2.6.17 or later with a
+modern C library (glibc 2.5 or later) support these system calls.  Using
+the latest stable Linux kernel is *HIGHLY* recommended as there have
+been numerous bugs in the early releases of these system calls.
+
+If you're using a packaged Ruby distribution, make sure you have a C
+compiler and the matching Ruby development libraries and headers.
+
+If you use RubyGems:
+
+    gem install io_splice
+
+Otherwise grab the latest tarball from:
+
+http://bogomips.org/ruby_io_splice/files/
+
+Unpack it, and run "ruby setup.rb"
+
+== Usage
+
+Our API matches the C API closely, see the RDoc for full API
+documentation and the Linux manpages for more details.
+
+All of these system calls are fairly new have seen limited usage
+anywhere, even outside of the Ruby world.
+
+If you encounter problems (privilege escalation, memory leaks (in the
+kernel), poor performance, corrupt data, etc..), try upgrading the Linux
+kernel to the latest stable version.
+
+These system calls have a lot of potential, and will hopefully be
+standardized and available in non-Linux kernels some day.
+
+== Development
+
+You can get the latest source via git from the following locations:
+
+  git://git.bogomips.org/ruby_io_splice.git
+  git://repo.or.cz/ruby_io_splice.git (mirror)
+
+You may browse the code from the web and download the latest snapshot
+tarballs here:
+
+* http://git.bogomips.org/cgit/ruby_io_splice.git (cgit)
+* http://repo.or.cz/w/ruby_io_splice.git (gitweb)
+
+Inline patches (from "git format-patch") to the mailing list are
+preferred because they allow code review and comments in the reply to
+the patch.
+
+We will adhere to mostly the same conventions for patch submissions as
+git itself.  See the Documentation/SubmittingPatches document
+distributed with git on on patch submission guidelines to follow.  Just
+don't email the git mailing list or maintainer with io_splice patches.
+
+== Contact
+
+All feedback (bug reports, user/development discussion, patches, pull
+requests) go to the mailing list: mailto:ruby.io.splice@librelist.com