$ git log --pretty=format:'%h %s (%cs)%d' v2.1.0 --
52ec5be Ruby io_splice 2.1.0 - IO::Splice.copy_stream fixes (2010-06-06)
(tag: v2.1.0)
1db6afb doc: help RDoc read IO::Splice singleton methods (2010-06-06)
a2026ea document +src+ and +dst+ for IO::Splice.{full,partial} (2010-06-06)
be048fd GNUmakefile: add rcov target (2010-06-06)
8733229 copy_stream: handle and block on EAGAIN from the non-pipe IO (2010-06-06)
e86706a GNUmakefile: allow passing options to test/unit (2010-06-06)
a301f99 copy_stream: cleanup after ourselves (2010-06-06)
8aab8c9 COPYING: bundle the LGPLv2.1 instead of LGPLv3 (2010-06-06)
2b95ba4 Ruby io_splice 2.0.0 (2010-06-05)
(tag: v2.0.0)
901e606 update PIPE_CAPA documentation for Linux 2.6.35 (2010-06-05)
...
$ git cat-file blob v2.1.0:README
= 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
== Mailing List Archives
In addition to the rsync-able archives provided by http://librelist.com/, we
are also mirrored to
{Gmane}[http://gmane.org/info.php?group=gmane.comp.lang.ruby.io-splice.general]
and maintain our own mbox mirrors downloadable via HTTP.
* nntp://news.gmane.org/gmane.comp.lang.ruby.io-splice.general
* http://bogomips.org/ruby_io_splice/archives/
# heads (aka `branches'):
$ git for-each-ref --sort=-creatordate refs/heads \
--format='%(HEAD) %(refname:short) %(subject) (%(creatordate:short))'
* master Ruby io_splice 4.4.2 - URL + doc updates (2020-02-22)
# tags:
$ git for-each-ref --sort=-creatordate refs/tags \
--format='%(refname:short) %(subject) (%(creatordate:short))'
v4.4.2 Ruby io_splice 4.4.2 - URL + doc updates (2020-02-22) tar.gz
v4.4.1 Ruby io_splice 4.4.1 - minor updates (2019-01-02) tar.gz
v4.4.0 Ruby io_splice 4.4.0 - minor updates (2015-01-11) tar.gz
v4.3.0 io_splice 4.3.0 - cleanups and compatibility fixes (2014-02-15) tar.gz
v4.2.0 io_splice 4.2.0 - several bugfixes and workarounds (2013-01-19) tar.gz
v4.1.1 io_splice 4.1.1 - workaround socket -> pipe issues (2011-05-17) tar.gz
v4.1.0 io_splice 4.1.0 - copy_stream enhancement for 1.9 (2011-05-16) tar.gz
v4.0.0 io_splice 4.0.0 - easier to use! (2011-05-12) tar.gz
v3.1.0 io_splice 3.1.0 - IO::Splice.copy_stream improvement (2011-05-01) tar.gz
v3.0.0 io_splice 3.0.0 - kinder, gentler Linux zero-copy (2011-03-01) tar.gz
...
# associated public inboxes:
# (number on the left is used for dev purposes)
https://yhbt.net/ruby-io-splice
git clone https://yhbt.net/ruby_io_splice.git