original/man2/sendfile.2

   1 .\" This man page is Copyright (C) 1998 Pawel Krawczyk.
   2 .\" Permission is granted to distribute possibly modified copies
   3 .\" of this page provided the header is included verbatim,
   4 .\" and in case of nontrivial modification author and date
   5 .\" of the modification is added to the header.
   6 .\" $Id: sendfile.2,v 1.5 1999/05/18 11:54:11 freitag Exp $
   7 .\" 2000-11-19 bert hubert <ahu@ds9a.nl>: in_fd cannot be socket
   8 .\"
   9 .\" 2004-12-17, mtk
  10 .\"     updated description of in_fd and out_fd for 2.6
  11 .\"     Various wording and formatting changes
  12 .\"
  13 .\" 2005-03-31 Martin Pool <mbp@sourcefrog.net> mmap() improvements
  14 .\"
  15 .TH SENDFILE 2 2010-12-03 "Linux" "Linux Programmer's Manual"
  16 .SH NAME
  17 sendfile \- transfer data between file descriptors
  18 .SH SYNOPSIS
  19 .B #include <sys/sendfile.h>
  20 .sp
  21 .BI "ssize_t sendfile(int" " out_fd" ", int" " in_fd" ", off_t *" \
  22                       offset ", size_t" " count" );
  23 .\" The below is too ugly. Comments about glibc versions belong
  24 .\" in the notes, not in the header.
  25 .\"
  26 .\" .B #include <features.h>
  27 .\" .br
  28 .\" .B #if (__GLIBC__==2 && __GLIBC_MINOR__>=1) || __GLIBC__>2
  29 .\" .br
  30 .\" .B #include <sys/sendfile.h>
  31 .\" .br
  32 .\" #else
  33 .\" .br
  34 .\" .B #include <sys/types.h>
  35 .\" .br
  36 .\" .B /* No system prototype before glibc 2.1. */
  37 .\" .br
  38 .\" .BI "ssize_t sendfile(int" " out_fd" ", int" " in_fd" ", off_t *" \
  39 .\"                       offset ", size_t" " count" )
  40 .\" .br
  41 .\" .B #endif
  42 .\"
  43 .SH DESCRIPTION
  44 .BR sendfile ()
  45 copies data between one file descriptor and another.
  46 Because this copying is done within the kernel,
  47 .BR sendfile ()
  48 is more efficient than the combination of
  49 .BR read (2)
  50 and
  51 .BR write (2),
  52 which would require transferring data to and from user space.
  53
  54 .I in_fd
  55 should be a file descriptor opened for reading and
  56 .I out_fd
  57 should be a descriptor opened for writing.
  58
  59 If
  60 .I offset
  61 is not NULL, then it points
  62 to a variable holding the file offset from which
  63 .BR sendfile ()
  64 will start reading data from
  65 .IR in_fd .
  66 When
  67 .BR sendfile ()
  68 returns, this variable
  69 will be set to the offset of the byte following the last byte that was read.
  70 If
  71 .I offset
  72 is not NULL, then
  73 .BR sendfile ()
  74 does not modify the current file offset of
  75 .IR in_fd ;
  76 otherwise the current file offset is adjusted to reflect
  77 the number of bytes read from
  78 .IR in_fd .
  79
  80 If
  81 .I offset
  82 is NULL, then data will be read from
  83 .IR in_fd
  84 starting at the current file offset,
  85 and the file offset will be updated by the call.
  86
  87 .I count
  88 is the number of bytes to copy between the file descriptors.
  89
  90 Presently (Linux 2.6.9):
  91 .IR in_fd ,
  92 must correspond to a file which supports
  93 .BR mmap (2)-like
  94 operations
  95 (i.e., it cannot be a socket);
  96 and
  97 .I out_fd
  98 must refer to a socket.
  99
 100 Applications may wish to fall back to
 101 .BR read (2)/ write (2)
 102 in the case where
 103 .BR sendfile ()
 104 fails with
 105 .B EINVAL
 106 or
 107 .BR ENOSYS .
 108 .SH "RETURN VALUE"
 109 If the transfer was successful, the number of bytes written to
 110 .I out_fd
 111 is returned.
 112 On error, \-1 is returned, and
 113 .I errno
 114 is set appropriately.
 115 .SH ERRORS
 116 .TP
 117 .B EAGAIN
 118 Nonblocking I/O has been selected using
 119 .B O_NONBLOCK
 120 and the write would block.
 121 .TP
 122 .B EBADF
 123 The input file was not opened for reading or the output file
 124 was not opened for writing.
 125 .TP
 126 .B EFAULT
 127 Bad address.
 128 .TP
 129 .B EINVAL
 130 Descriptor is not valid or locked, or an
 131 .BR mmap (2)-like
 132 operation is not available for
 133 .IR in_fd .
 134 .TP
 135 .B EIO
 136 Unspecified error while reading from
 137 .IR in_fd .
 138 .TP
 139 .B ENOMEM
 140 Insufficient memory to read from
 141 .IR in_fd .
 142 .SH VERSIONS
 143 .BR sendfile ()
 144 is a new feature in Linux 2.2.
 145 The include file
 146 .I <sys/sendfile.h>
 147 is present since glibc 2.1.
 148 .SH "CONFORMING TO"
 149 Not specified in POSIX.1-2001, or other standards.
 150
 151 Other UNIX systems implement
 152 .BR sendfile ()
 153 with different semantics and prototypes.
 154 It should not be used in portable programs.
 155 .SH NOTES
 156 If you plan to use
 157 .BR sendfile ()
 158 for sending files to a TCP socket, but need
 159 to send some header data in front of the file contents, you will find
 160 it useful to employ the
 161 .B TCP_CORK
 162 option, described in
 163 .BR tcp (7),
 164 to minimize the number of packets and to tune performance.
 165
 166 In Linux 2.4 and earlier,
 167 .I out_fd
 168 could refer to a regular file, and
 169 .BR sendfile ()
 170 changed the current offset of that file.
 171
 172 The original Linux
 173 .BR sendfile ()
 174 system call was not designed to handle large file offsets.
 175 Consequently, Linux 2.4 added
 176 .BR sendfile64 (),
 177 with a wider type for the
 178 .I offset
 179 argument.
 180 The glibc
 181 .BR sendfile ()
 182 wrapper function transparently deals with the kernel differences.
 183 .SH "SEE ALSO"
 184 .BR mmap (2),
 185 .BR open (2),
 186 .BR socket (2),
 187 .BR splice (2)
 188