lib/io/splice.rb

   1 # -*- encoding: binary -*-
   2 require 'io_splice_ext'
   3 require 'io/wait'
   4
   5 module IO::Splice
   6
   7   # The maximum default capacity of the pipe in bytes.
   8   # Under stock Linux, this is 65536 bytes as of 2.6.11, and 4096 before
   9   # We detect this at runtime as it is easy to recompile the kernel
  10   # and set a new value.
  11   # Starting with Linux 2.6.35, pipe capacity will be tunable
  12   # and this will only represent the default capacity of a
  13   # newly-created pipe.
  14   PIPE_CAPA = begin
  15     rd, wr = IO.pipe
  16     buf = ' ' * PIPE_BUF
  17     n = 0
  18     begin
  19       n += wr.write_nonblock(buf)
  20     rescue Errno::EAGAIN
  21       break
  22     end while true
  23     wr.close
  24     rd.close
  25     n
  26   end
  27
  28   # copies the contents of the IO object given by +src+ to +dst+
  29   # If +len+ is specified, then only +len+ bytes are copied and
  30   # +EOFError+ is raised if fewer than +len+ bytes could be copied.
  31   # Otherwise the copy will be until EOF is reached on the +src+.
  32   # +src+ and +dst+ must be IO objects or respond to +to_io+
  33   #
  34   # This is nearly a drop-in replacement for IO.copy_stream (in Ruby 1.9)
  35   # but does not take into account userspace I/O buffers nor IO-like
  36   # objects with no underlying file descriptor (e.g. StringIO).
  37   def self.copy_stream(src, dst, len = nil, src_offset = nil)
  38     close = []
  39     src.kind_of?(String) and close << (src = File.open(src))
  40     dst.kind_of?(String) and close << (dst = File.open(dst, "w"))
  41     src, dst = src.to_io, dst.to_io
  42     rv = len
  43
  44     if src.stat.pipe? || dst.stat.pipe?
  45       if len
  46         len -= full(src, dst, len, src_offset) until len == 0
  47       else
  48         rv = 0
  49         while n = partial(src, dst, PIPE_CAPA, src_offset)
  50           rv += n
  51         end
  52       end
  53     else
  54       r, w = tmp = IO.pipe
  55       close.concat(tmp)
  56       if len
  57         while len != 0 && n = partial(src, w, len, src_offset)
  58           len -= full(r, dst, n, nil)
  59         end
  60       else
  61         rv = 0
  62         while n = partial(src, w, PIPE_CAPA, src_offset)
  63           rv += full(r, dst, n, nil)
  64         end
  65       end
  66     end
  67
  68     rv
  69     ensure
  70       close.each { |io| io.close }
  71   end
  72
  73   # splice the full amount specified from +src+ to +dst+
  74   # Either +dst+ or +src+ must be a pipe.  +dst+ and +src+
  75   # may BOTH be pipes in Linux 2.6.31 or later.
  76   # This will block and wait for IO completion of +len+
  77   # Raises +EOFError+ if end of file is reached.
  78   # bytes.  Returns the number of bytes actually spliced (always +len+)
  79   def self.full(src, dst, len, src_offset)
  80     IO.splice(src, src_offset, dst, nil, len, F_MOVE | WAITALL)
  81   end
  82
  83   # splice up to +len+ bytes from +src+ to +dst+.
  84   # Either +dst+ or +src+ must be a pipe.  +dst+ and +src+
  85   # may BOTH be pipes in Linux 2.6.31 or later.
  86   # Returns the number of bytes actually spliced.
  87   # Like IO#readpartial, this never returns Errno::EAGAIN
  88   def self.partial(src, dst, len, src_offset)
  89     IO.splice(src, src_offset, dst, nil, len, F_MOVE)
  90     rescue EOFError
  91       nil
  92     rescue Errno::EAGAIN
  93       begin
  94         src.to_io.wait
  95         IO.select(nil, [dst])
  96         rv = IO.trysplice(src, src_offset, dst, nil, len, F_MOVE)
  97       end while rv == :EAGAIN
  98       rv
  99   end
 100 end