splice(2)
๐ splice(2) โ the System Calls Manual glow-up ๐
okay bestie, welcome to splice(2) from the System Calls Manual โจ this one is a real one and she does NOT get the attention she deserves, so buckle up ๐
โจ NAME โจ
splice โ splice data to/from a pipe ๐ซถ
๐ LIBRARY ๐
Standard C library (libc, -lc) ๐
๐ฉท SYNOPSIS ๐ฉท
#define _GNU_SOURCE /* See feature_test_macros(7) */
#define _FILE_OFFSET_BITS 64
#include <fcntl.h>
ssize_t splice(int fd_in, off_t *_Nullable off_in,
int fd_out, off_t *_Nullable off_out,
size_t size, unsigned int flags);
๐ธ DESCRIPTION ๐ธ
so here's the tea, bestie: splice() moves data between two file descriptors without copying between kernel address space and user address space. No round-tripping through userspace, no extra copies, it's giving efficiency ๐
It transfers up to size bytes of data from the file descriptor fd_in to the file descriptor fd_out, and one of those file descriptors must refer to a pipe. That's the rule, no cap ๐
Here's how it goes for fd_in and off_in:
- If
fd_inrefers to a pipe, thenoff_inmust beNULL. - If
fd_indoes NOT refer to a pipe andoff_inisNULL, then bytes are read fromfd_instarting from the file offset, and the file offset gets adjusted appropriately โจ - If
fd_indoes NOT refer to a pipe andoff_inis NOTNULL, thenoff_inmust point to a buffer which specifies the starting offset from which bytes will be read fromfd_in. In this case the file offset offd_inis not changed, and instead the offset pointed to byoff_inis adjusted appropriately. Iconic behavior honestly ๐
Analogous statements apply for fd_out and off_out โ same energy, other end of the pipe ๐ฆ
The flags argument is a bit mask that you compose by ORing together zero or more of the following values:
SPLICE_F_MOVEโ Attempt to move pages instead of copying. This is only a hint to the kernel, so don't get too attached: pages may still be copied if the kernel cannot move the pages from the pipe, or if the pipe buffers don't refer to full pages. The initial implementation of this flag was buggy, so starting in Linux 2.6.21 it's a no-op (but it's still permitted in asplice()call). In the future, a correct implementation may be restored ๐SPLICE_F_NONBLOCKโ Do not block on I/O. This makes the splice pipe operations nonblocking, but heads up:splice()may nevertheless block, because the file descriptors that are spliced to/from may block (unless they have theO_NONBLOCKflag set) ๐SPLICE_F_MOREโ More data will be coming in a subsequent splice. This is a helpful hint when thefd_outrefers to a socket (see also the description ofMSG_MOREinsend(2), and the description ofTCP_CORKintcp(7)) ๐SPLICE_F_GIFTโ Unused forsplice(); seevmsplice(2)๐
๐ซถ RETURN VALUE ๐ซถ
Upon successful completion, splice() returns the number of bytes spliced to or from the pipe. Slay.
A return value of 0 means end of input. If fd_in refers to a pipe, then this means there was no data to transfer, and it would not make sense to block, because there are no writers connected to the write end of the pipe ๐ญ
On error, splice() returns -1 and errno is set to indicate the error. Rude, but okay.
๐ ERRORS ๐
EAGAINโSPLICE_F_NONBLOCKwas specified inflags, or one of the file descriptors had been marked as nonblocking (O_NONBLOCK), and the operation would block.EBADFโ One or both file descriptors are not valid, or do not have proper read-write mode.EINVALโ The target filesystem doesn't support splicing.EINVALโ The target file is opened in append mode.EINVALโ Neither of the file descriptors refers to a pipe.EINVALโ An offset was given for nonseekable device (e.g., a pipe).EINVALโfd_inandfd_outrefer to the same pipe.ENOMEMโ Out of memory.ESPIPEโ Eitheroff_inoroff_outwas notNULL, but the corresponding file descriptor refers to a pipe.
bestie not theEINVALstack ๐ that's FIVE wholeEINVALcases, she's an overachiever fr fr
๐ STANDARDS ๐
Linux. That's it. That's the standard. ๐
๐ฆ HISTORY ๐ฆ
Linux 2.6.17, glibc 2.5 ๐
In Linux 2.6.30 and earlier, exactly one of fd_in and fd_out was required to be a pipe. Since Linux 2.6.31, both arguments may refer to pipes. Glow-up era โจ
๐ NOTES ๐
Okay this part is the lore, and I need you to be seated for it ๐ซ
The three system calls splice(), vmsplice(2), and tee(2) provide user-space programs with full control over an arbitrary kernel buffer, implemented within the kernel using the same type of buffer that is used for a pipe. In overview, these system calls perform the following tasks:
splice()โ moves data from the buffer to an arbitrary file descriptor, or vice versa, or from one buffer to another.tee(2)โ "copies" the data from one buffer to another.vmsplice(2)โ "copies" data from user space into the buffer.
Though we talk of copying, actual copies are generally avoided. The kernel does this by implementing a pipe buffer as a set of reference-counted pointers to pages of kernel memory. The kernel creates "copies" of pages in a buffer by creating new pointers (for the output buffer) referring to the pages, and increasing the reference counts for the pages: only pointers are copied, not the pages of the buffer. Literally the main character energy of memory management ๐ง
_FILE_OFFSET_BITS should be defined to be 64 in code that uses non-null off_in or off_out, or that takes the address of splice, if the code is intended to be portable to traditional 32-bit x86 and ARM platforms where off_t's width defaults to 32 bits. Don't skip this, bestie, your 32-bit friends will suffer ๐ค
โญ EXAMPLES โญ
See tee(2) for another example ๐
#define _GNU_SOURCE
#define _FILE_OFFSET_BITS 64
#include <err.h>
#include <fcntl.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>
#include <unistd.h>
int
main(void)
{
int fd;
int pfd[2];
off_t off;
[[gnu::nonstring]]
const char s[12] = "Hello, world";
fd = open("out", O_WRONLY | O_CREAT | O_EXCL, 0666);
if (fd == -1)
err(EXIT_FAILURE, "open");
if (pipe(pfd) == -1)
err(EXIT_FAILURE, "pipe");
if (write(pfd[1], s, sizeof(s)) != sizeof(s))
err(EXIT_FAILURE, "write");
if (close(pfd[1]) == -1)
err(EXIT_FAILURE, "close");
off = 10;
if (splice(pfd[0], NULL, fd, &off, sizeof(s), 0) != sizeof(s))
err(EXIT_FAILURE, "splice");
if (close(pfd[0]) == -1)
err(EXIT_FAILURE, "close");
printf("New offset is %jd\n", (intmax_t) off);
if (close(fd) == -1)
err(EXIT_FAILURE, "close");
exit(EXIT_SUCCESS);
}
this one is actually so clean โ write into a pipe, drop the read end,spliceit straight into a file with an explicitoff, and print the new offset. Obsessed ๐
๐ SEE ALSO ๐
copy_file_range(2), sendfile(2), tee(2), vmsplice(2), pipe(7)
and that's the page, babe ๐ this one is from Linux man-pages 6.20, dated 2026-02-08 โ drink some water, go splice something without copying it, and I'll see you in the next man page ๐๐ซถโจ
๐ฆ where this page comes from
- arch rolling: man-pages 6.20-1 ยท BSD-2-Clause AND BSD-3-Clause AND BSD-4.3TAHOE AND BSD-4-Clause-UC AND GPL-1.0-or-later AND GPL-2.0-only AND GPL-2.0-or-later AND GPL-3.0-or-later AND LGPL-3.0-linking-exception AND LGPL-3.0-or-later AND LicenseRef-Public-Domain AND LicenseRef-UltraPermissive AND Linux-man-pages-1-para AND Linux-man-pages-copyleft AND Linux-man-pages-copyleft-2-para AND Linux-man-pages-copyleft-var AND MIT AND Spencer-94
- nixpkgs unstable: man-pages 6.20
- ๐ the page's license: Linux-man-pages-copyleft
- Copyright 2006, Jens Axboe <axboe@kernel.dk>
- Copyright 2006, Michael Kerrisk <mtk.manpages@gmail.com>
- ๐ girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms