lib/libc/sys/read.2

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)read.2      8.4 (Berkeley) 2/26/94
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd June 4, 2020
  32 .Dt READ 2
  33 .Os
  34 .Sh NAME
  35 .Nm read ,
  36 .Nm readv ,
  37 .Nm pread ,
  38 .Nm preadv
  39 .Nd read input
  40 .Sh LIBRARY
  41 .Lb libc
  42 .Sh SYNOPSIS
  43 .In unistd.h
  44 .Ft ssize_t
  45 .Fn read "int fd" "void *buf" "size_t nbytes"
  46 .Ft ssize_t
  47 .Fn pread "int fd" "void *buf" "size_t nbytes" "off_t offset"
  48 .In sys/uio.h
  49 .Ft ssize_t
  50 .Fn readv "int fd" "const struct iovec *iov" "int iovcnt"
  51 .Ft ssize_t
  52 .Fn preadv "int fd" "const struct iovec *iov" "int iovcnt" "off_t offset"
  53 .Sh DESCRIPTION
  54 The
  55 .Fn read
  56 system call
  57 attempts to read
  58 .Fa nbytes
  59 of data from the object referenced by the descriptor
  60 .Fa fd
  61 into the buffer pointed to by
  62 .Fa buf .
  63 The
  64 .Fn readv
  65 system call
  66 performs the same action, but scatters the input data
  67 into the
  68 .Fa iovcnt
  69 buffers specified by the members of the
  70 .Fa iov
  71 array: iov[0], iov[1], ..., iov[iovcnt\|\-\|1].
  72 The
  73 .Fn pread
  74 and
  75 .Fn preadv
  76 system calls
  77 perform the same functions, but read from the specified position in
  78 the file without modifying the file pointer.
  79 .Pp
  80 For
  81 .Fn readv
  82 and
  83 .Fn preadv ,
  84 the
  85 .Fa iovec
  86 structure is defined as:
  87 .Pp
  88 .Bd -literal -offset indent -compact
  89 struct iovec {
  90         void   *iov_base;  /* Base address. */
  91         size_t iov_len;    /* Length. */
  92 };
  93 .Ed
  94 .Pp
  95 Each
  96 .Fa iovec
  97 entry specifies the base address and length of an area
  98 in memory where data should be placed.
  99 The
 100 .Fn readv
 101 system call
 102 will always fill an area completely before proceeding
 103 to the next.
 104 .Pp
 105 On objects capable of seeking, the
 106 .Fn read
 107 starts at a position
 108 given by the pointer associated with
 109 .Fa fd
 110 (see
 111 .Xr lseek 2 ) .
 112 Upon return from
 113 .Fn read ,
 114 the pointer is incremented by the number of bytes actually read.
 115 .Pp
 116 Objects that are not capable of seeking always read from the current
 117 position.
 118 The value of the pointer associated with such an
 119 object is undefined.
 120 .Pp
 121 Upon successful completion,
 122 .Fn read ,
 123 .Fn readv ,
 124 .Fn pread
 125 and
 126 .Fn preadv
 127 return the number of bytes actually read and placed in the buffer.
 128 The system guarantees to read the number of bytes requested if
 129 the descriptor references a normal file that has that many bytes left
 130 before the end-of-file, but in no other case.
 131 .Pp
 132 In accordance with
 133 .St -p1003.1-2004 ,
 134 both
 135 .Xr read 2
 136 and
 137 .Xr write 2
 138 syscalls are atomic with respect to each other in the effects on file
 139 content, when they operate on regular files.
 140 If two threads each call one of the
 141 .Xr read 2
 142 or
 143 .Xr write 2 ,
 144 syscalls, each call will see either all of the changes of the other call,
 145 or none of them.
 146 The
 147 .Fx
 148 kernel implements this guarantee by locking the file ranges affected by
 149 the calls.
 150 .Sh RETURN VALUES
 151 If successful, the
 152 number of bytes actually read is returned.
 153 Upon reading end-of-file,
 154 zero is returned.
 155 Otherwise, a -1 is returned and the global variable
 156 .Va errno
 157 is set to indicate the error.
 158 .Sh ERRORS
 159 The
 160 .Fn read ,
 161 .Fn readv ,
 162 .Fn pread
 163 and
 164 .Fn preadv
 165 system calls
 166 will succeed unless:
 167 .Bl -tag -width Er
 168 .It Bq Er EBADF
 169 The
 170 .Fa fd
 171 argument
 172 is not a valid file or socket descriptor open for reading.
 173 .It Bq Er ECONNRESET
 174 The
 175 .Fa fd
 176 argument refers to a socket, and the remote socket end is
 177 forcibly closed.
 178 .It Bq Er EFAULT
 179 The
 180 .Fa buf
 181 argument
 182 points outside the allocated address space.
 183 .It Bq Er EIO
 184 An I/O error occurred while reading from the file system.
 185 .It Bq Er EINTEGRITY
 186 Corrupted data was detected while reading from the file system.
 187 .It Bq Er EBUSY
 188 Failed to read from a file, e.g. /proc/<pid>/regs while <pid> is not stopped
 189 .It Bq Er EINTR
 190 A read from a slow device
 191 (i.e.\& one that might block for an arbitrary amount of time)
 192 was interrupted by the delivery of a signal
 193 before any data arrived.
 194 .It Bq Er EINVAL
 195 The pointer associated with
 196 .Fa fd
 197 was negative.
 198 .It Bq Er EAGAIN
 199 The file was marked for non-blocking I/O,
 200 and no data were ready to be read.
 201 .It Bq Er EISDIR
 202 The file descriptor is associated with a directory.
 203 Directories may only be read directly by root if the filesystem supports it and
 204 the
 205 .Dv security.bsd.allow_read_dir
 206 sysctl MIB is set to a non-zero value.
 207 For most scenarios, the
 208 .Xr readdir 3
 209 function should be used instead.
 210 .It Bq Er EOPNOTSUPP
 211 The file descriptor is associated with a file system and file type that
 212 do not allow regular read operations on it.
 213 .It Bq Er EOVERFLOW
 214 The file descriptor is associated with a regular file,
 215 .Fa nbytes
 216 is greater than 0,
 217 .Fa offset
 218 is before the end-of-file, and
 219 .Fa offset
 220 is greater than or equal to the offset maximum established
 221 for this file system.
 222 .It Bq Er EINVAL
 223 The value
 224 .Fa nbytes
 225 is greater than
 226 .Dv INT_MAX .
 227 .El
 228 .Pp
 229 In addition,
 230 .Fn readv
 231 and
 232 .Fn preadv
 233 may return one of the following errors:
 234 .Bl -tag -width Er
 235 .It Bq Er EINVAL
 236 The
 237 .Fa iovcnt
 238 argument
 239 was less than or equal to 0, or greater than
 240 .Dv IOV_MAX .
 241 .It Bq Er EINVAL
 242 One of the
 243 .Fa iov_len
 244 values in the
 245 .Fa iov
 246 array was negative.
 247 .It Bq Er EINVAL
 248 The sum of the
 249 .Fa iov_len
 250 values in the
 251 .Fa iov
 252 array overflowed a 32-bit integer.
 253 .It Bq Er EFAULT
 254 Part of the
 255 .Fa iov
 256 array points outside the process's allocated address space.
 257 .El
 258 .Pp
 259 The
 260 .Fn pread
 261 and
 262 .Fn preadv
 263 system calls may also return the following errors:
 264 .Bl -tag -width Er
 265 .It Bq Er EINVAL
 266 The
 267 .Fa offset
 268 value was negative.
 269 .It Bq Er ESPIPE
 270 The file descriptor is associated with a pipe, socket, or FIFO.
 271 .El
 272 .Sh SEE ALSO
 273 .Xr dup 2 ,
 274 .Xr fcntl 2 ,
 275 .Xr getdirentries 2 ,
 276 .Xr open 2 ,
 277 .Xr pipe 2 ,
 278 .Xr select 2 ,
 279 .Xr socket 2 ,
 280 .Xr socketpair 2 ,
 281 .Xr fread 3 ,
 282 .Xr readdir 3
 283 .Sh STANDARDS
 284 The
 285 .Fn read
 286 system call is expected to conform to
 287 .St -p1003.1-90 .
 288 The
 289 .Fn readv
 290 and
 291 .Fn pread
 292 system calls are expected to conform to
 293 .St -xpg4.2 .
 294 .Sh HISTORY
 295 The
 296 .Fn preadv
 297 system call appeared in
 298 .Fx 6.0 .
 299 The
 300 .Fn pread
 301 function appeared in
 302 .At V.4 .
 303 The
 304 .Fn readv
 305 system call appeared in
 306 .Bx 4.2 .
 307 The
 308 .Fn read
 309 function appeared in
 310 .At v1 .