Splice (system call)


splice is a Linux-specific system call that moves data between a file descriptor and a pipe without a round trip to user space. The related system call vmsplice moves or copies data between a pipe and user space. Ideally, splice and vmsplice work by remapping pages and do not actually copy any data, which may improve I/O performance. As linear addresses do not necessarily correspond to contiguous physical addresses, this may not be possible in all cases and on all hardware combinations.

Workings

With splice, one can move data from one file descriptor to another without incurring any copies from user space into kernel space, which is usually required to enforce system security and also to keep a simple interface for processes to read and write to files. splice works by using the pipe buffer. A pipe buffer is an in-kernel memory buffer that is opaque to the user space process. A user process can splice the contents of a source file into this pipe buffer, then splice the pipe buffer into the destination file, all without moving any data through userspace.
Linus Torvalds described splice in a 2006 email, which was included in a KernelTrap article.

Origins

The Linux splice implementation borrows some ideas from an original proposal by Larry McVoy in 1998. The splice system calls first appeared in Linux kernel version 2.6.17 and were written by Jens Axboe.

Prototype


ssize_t splice;

Some constants that are of interest are:

/* Splice flags. */
  1. ifndef SPLICE_F_MOVE
  2. define SPLICE_F_MOVE 0x01
  3. endif
  4. ifndef SPLICE_F_NONBLOCK
  5. define SPLICE_F_NONBLOCK 0x02
  6. endif
  7. ifndef SPLICE_F_MORE
  8. define SPLICE_F_MORE 0x04
  9. endif
  10. ifndef SPLICE_F_GIFT
  11. define SPLICE_F_GIFT 0x08
  12. endif

Example

This is an example of splice in action:

/* Transfer from disk to a log. */
int log_blocks

Complementary system calls

splice is one of three system calls that complete the splice architecture. vmsplice can map an application data area into a pipe, thus allowing transfers between pipes and user memory where sys_splice transfers between a file descriptor and a pipe. tee is the last part of the trilogy. It duplicates one pipe to another, enabling forks in the way applications are connected with pipes.

Requirements

When using splice with sockets, the network controller must support DMA.
When the NIC does not support DMA then splice will not deliver a large performance improvement. The reason for this is that each page of the pipe will just fill up to frame size.
Not all filesystem types support splice. Also, AF_UNIX sockets do not support splice.