lib/libc/sys/lseek.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 .\"     @(#)lseek.2     8.3 (Berkeley) 4/19/94
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd July 13, 2020
  32 .Dt LSEEK 2
  33 .Os
  34 .Sh NAME
  35 .Nm lseek
  36 .Nd reposition read/write file offset
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In unistd.h
  41 .Ft off_t
  42 .Fn lseek "int fildes" "off_t offset" "int whence"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn lseek
  46 system call repositions the offset of the file descriptor
  47 .Fa fildes
  48 to the
  49 argument
  50 .Fa offset
  51 according to the directive
  52 .Fa whence .
  53 The argument
  54 .Fa fildes
  55 must be an open
  56 file descriptor.
  57 The
  58 .Fn lseek
  59 system call
  60 repositions the file position pointer associated with the file
  61 descriptor
  62 .Fa fildes
  63 as follows:
  64 .Bl -item -offset indent
  65 .It
  66 If
  67 .Fa whence
  68 is
  69 .Dv SEEK_SET ,
  70 the offset is set to
  71 .Fa offset
  72 bytes.
  73 .It
  74 If
  75 .Fa whence
  76 is
  77 .Dv SEEK_CUR ,
  78 the offset is set to its current location plus
  79 .Fa offset
  80 bytes.
  81 .It
  82 If
  83 .Fa whence
  84 is
  85 .Dv SEEK_END ,
  86 the offset is set to the size of the
  87 file plus
  88 .Fa offset
  89 bytes.
  90 .It
  91 If
  92 .Fa whence
  93 is
  94 .Dv SEEK_HOLE ,
  95 the offset is set to the start of the next hole greater than or equal
  96 to the supplied
  97 .Fa offset .
  98 The definition of a hole is provided below.
  99 .It
 100 If
 101 .Fa whence
 102 is
 103 .Dv SEEK_DATA ,
 104 the offset is set to the start of the next non-hole file region greater
 105 than or equal to the supplied
 106 .Fa offset .
 107 .El
 108 .Pp
 109 The
 110 .Fn lseek
 111 system call allows the file offset to be set beyond the end
 112 of the existing end-of-file of the file.
 113 If data is later written
 114 at this point, subsequent reads of the data in the gap return
 115 bytes of zeros (until data is actually written into the gap).
 116 However, the
 117 .Fn lseek
 118 system call does not, by itself, extend the size of a file.
 119 .Pp
 120 A
 121 .Qq hole
 122 is defined as a contiguous range of bytes in a file, all having the value of
 123 zero, but not all zeros in a file are guaranteed to be represented as holes
 124 returned with
 125 .Dv SEEK_HOLE .
 126 File systems are allowed to expose ranges of zeros with
 127 .Dv SEEK_HOLE ,
 128 but not required to.
 129 Applications can use
 130 .Dv SEEK_HOLE
 131 to optimise their behavior for ranges of zeros, but must not depend on it to
 132 find all such ranges in a file.
 133 Each file is presented as having a zero-size virtual hole at the very
 134 end of the file.
 135 The existence of a hole at the end of every data region allows for easy
 136 programming and also provides compatibility to the original implementation
 137 in Solaris.
 138 It also causes the current file size (i.e., end-of-file offset) to be returned
 139 to indicate that there are no more holes past the supplied
 140 .Fa offset .
 141 Applications should use
 142 .Fn fpathconf _PC_MIN_HOLE_SIZE
 143 or
 144 .Fn pathconf _PC_MIN_HOLE_SIZE
 145 to determine if a file system supports
 146 .Dv SEEK_HOLE .
 147 See
 148 .Xr pathconf 2 .
 149 .Pp
 150 For file systems that do not supply information about holes, the file will be
 151 represented as one entire data region.
 152 .Sh RETURN VALUES
 153 Upon successful completion,
 154 .Fn lseek
 155 returns the resulting offset location as measured in bytes from the
 156 beginning of the file.
 157 Otherwise,
 158 a value of -1 is returned and
 159 .Va errno
 160 is set to indicate
 161 the error.
 162 .Sh ERRORS
 163 The
 164 .Fn lseek
 165 system call
 166 will fail and the file position pointer will remain unchanged if:
 167 .Bl -tag -width Er
 168 .It Bq Er EBADF
 169 The
 170 .Fa fildes
 171 argument
 172 is not an open file descriptor.
 173 .It Bq Er EINVAL
 174 The
 175 .Fa whence
 176 argument
 177 is not a proper value
 178 or the resulting file offset would
 179 be negative for a non-character special file.
 180 .It Bq Er ENXIO
 181 For
 182 .Dv SEEK_DATA ,
 183 there are no more data regions past the supplied offset.
 184 Due to existence of the hole at the end of the file, for
 185 .Dv SEEK_HOLE
 186 this error is only returned when the
 187 .Fa offset
 188 already points to the end-of-file position.
 189 .It Bq Er EOVERFLOW
 190 The resulting file offset would be a value which cannot be represented
 191 correctly in an object of type
 192 .Fa off_t .
 193 .It Bq Er ESPIPE
 194 The
 195 .Fa fildes
 196 argument
 197 is associated with a pipe, socket, or FIFO.
 198 .El
 199 .Sh SEE ALSO
 200 .Xr dup 2 ,
 201 .Xr open 2 ,
 202 .Xr pathconf 2
 203 .Sh STANDARDS
 204 The
 205 .Fn lseek
 206 system call is expected to conform to
 207 .St -p1003.1-2008 .
 208 .Pp
 209 The
 210 .Dv SEEK_HOLE
 211 and
 212 .Dv SEEK_DATA
 213 directives, along with the
 214 .Er ENXIO
 215 error, are extensions to that specification.
 216 .Sh HISTORY
 217 The
 218 .Fn lseek
 219 function appeared in
 220 .At v7 .
 221 .Sh BUGS
 222 If the
 223 .Fn lseek
 224 system call is operating on a device which is incapable of seeking,
 225 it will request the seek operation and return successfully,
 226 even though no seek was performed.
 227 Because the
 228 .Ar offset
 229 argument will be stored unconditionally in the file descriptor of that device,
 230 there is no way to confirm if the seek operation succeeded or not
 231 (e.g. using the
 232 .Fn ftell
 233 function).
 234 Device types which are known to be incapable of seeking include
 235 tape drives.
 236 .Pp
 237 The
 238 .Fn lseek
 239 system call will not detect whether media are present in changeable
 240 media devices such as DVD or Blu-ray devices.
 241 A requested seek operation will therefore return sucessfully when no
 242 medium is present.
 243 .Pp
 244 This document's use of
 245 .Fa whence
 246 is incorrect English, but is maintained for historical reasons.