1 .\" Copyright (c) 1980, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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 .\" 4. 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.
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
28 .\" @(#)read.2 8.4 (Berkeley) 2/26/94
47 .Fn read "int d" "void *buf" "size_t nbytes"
49 .Fn pread "int d" "void *buf" "size_t nbytes" "off_t offset"
51 .Fn readv "int d" "const struct iovec *iov" "int iovcnt"
53 .Fn preadv "int d" "const struct iovec *iov" "int iovcnt" "off_t offset"
60 of data from the object referenced by the descriptor
62 into the buffer pointed to by
67 performs the same action, but scatters the input data
70 buffers specified by the members of the
72 array: iov[0], iov[1], ..., iov[iovcnt\|\-\|1].
78 perform the same functions, but read from the specified position in
79 the file without modifying the file pointer.
87 structure is defined as:
89 .Bd -literal -offset indent -compact
91 void *iov_base; /* Base address. */
92 size_t iov_len; /* Length. */
98 entry specifies the base address and length of an area
99 in memory where data should be placed.
103 will always fill an area completely before proceeding
106 On objects capable of seeking, the
109 given by the pointer associated with
115 the pointer is incremented by the number of bytes actually read.
117 Objects that are not capable of seeking always read from the current
119 The value of the pointer associated with such an
122 Upon successful completion,
128 return the number of bytes actually read and placed in the buffer.
129 The system guarantees to read the number of bytes requested if
130 the descriptor references a normal file that has that many bytes left
131 before the end-of-file, but in no other case.
134 number of bytes actually read is returned.
135 Upon reading end-of-file,
137 Otherwise, a -1 is returned and the global variable
139 is set to indicate the error.
154 is not a valid file or socket descriptor open for reading.
158 argument refers to a socket, and the remote socket end is
164 points outside the allocated address space.
166 An I/O error occurred while reading from the file system.
168 A read from a slow device
169 (i.e.\& one that might block for an arbitrary amount of time)
170 was interrupted by the delivery of a signal
171 before any data arrived.
173 The pointer associated with
177 The file was marked for non-blocking I/O,
178 and no data were ready to be read.
180 The file descriptor is associated with a directory residing
181 on a file system that does not allow regular read operations on
182 directories (e.g.\& NFS).
184 The file descriptor is associated with a file system and file type that
185 do not allow regular read operations on it.
187 The file descriptor is associated with a regular file,
191 is before the end-of-file, and
193 is greater than or equal to the offset maximum established
194 for this file system.
206 may return one of the following errors:
212 was less than or equal to 0, or greater than
225 array overflowed a 32-bit integer.
229 array points outside the process's allocated address space.
236 system calls may also return the following errors:
243 The file descriptor is associated with a pipe, socket, or FIFO.
248 .Xr getdirentries 2 ,
259 system call is expected to conform to
265 system calls are expected to conform to
270 system call appeared in
278 system call appeared in