lib/libcr/sys/getdirentries.2

   1 .\" Copyright (c) 1989, 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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)getdirentries.2     8.2 (Berkeley) 5/3/95
  33 .\" $FreeBSD: src/lib/libc/sys/getdirentries.2,v 1.12.2.6 2001/12/14 18:34:00 ru Exp $
  34 .\"
  35 .Dd May 3, 1995
  36 .Dt GETDIRENTRIES 2
  37 .Os
  38 .Sh NAME
  39 .Nm getdirentries ,
  40 .Nm getdents
  41 .Nd "get directory entries in a filesystem independent format"
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In sys/types.h
  46 .In dirent.h
  47 .Ft int
  48 .Fn getdirentries "int fd" "char *buf" "int nbytes" "long *basep"
  49 .Ft int
  50 .Fn getdents "int fd" "char *buf" "int nbytes"
  51 .Sh DESCRIPTION
  52 The
  53 .Fn getdirentries
  54 and
  55 .Fn getdents
  56 functions read directory entries from the directory
  57 referenced by the file descriptor
  58 .Fa fd
  59 into the buffer pointed to by
  60 .Fa buf ,
  61 in a filesystem independent format.
  62 Up to
  63 .Fa nbytes
  64 of data will be transferred.
  65 The
  66 .Fa nbytes
  67 argument must be greater than or equal to the
  68 block size associated with the file,
  69 see
  70 .Xr stat 2 .
  71 Some filesystems may not support these functions
  72 with buffers smaller than this size.
  73 .Pp
  74 The data in the buffer is a series of
  75 .Em dirent
  76 structures each containing the following entries:
  77 .Bd -literal -offset indent
  78 u_int32_t d_fileno;
  79 u_int16_t d_reclen;
  80 u_int8_t  d_type;
  81 u_int8_t  d_namlen;
  82 char    d_name[MAXNAMELEN + 1]; /* see below */
  83 .Ed
  84 .Pp
  85 The
  86 .Fa d_fileno
  87 entry is a number which is unique for each
  88 distinct file in the filesystem.
  89 Files that are linked by hard links (see
  90 .Xr link 2 )
  91 have the same
  92 .Fa d_fileno .
  93 The
  94 .Fa d_reclen
  95 entry is the length, in bytes, of the directory record.
  96 The
  97 .Fa d_type
  98 entry is the type of the file pointed to by the directory record.
  99 The file type values are defined in
 100 .Fa <sys/dirent.h> .
 101 The
 102 .Fa d_name
 103 entry contains a null terminated file name.
 104 The
 105 .Fa d_namlen
 106 entry specifies the length of the file name excluding the null byte.
 107 Thus the actual size of
 108 .Fa d_name
 109 may vary from 1 to
 110 .Dv MAXNAMELEN
 111 \&+ 1.
 112 .Pp
 113 Entries may be separated by extra space.
 114 The
 115 .Fa d_reclen
 116 entry may be used as an offset from the start of a
 117 .Fa dirent
 118 structure to the next structure, if any.
 119 .Pp
 120 The actual number of bytes transferred is returned.
 121 The current position pointer associated with
 122 .Fa fd
 123 is set to point to the next block of entries.
 124 The pointer may not advance by the number of bytes returned by
 125 .Fn getdirentries
 126 or
 127 .Fn getdents .
 128 A value of zero is returned when
 129 the end of the directory has been reached.
 130 .Pp
 131 The
 132 .Fn getdirentries
 133 function writes the position of the block read into the location pointed to by
 134 .Fa basep .
 135 Alternatively, the current position pointer may be set and retrieved by
 136 .Xr lseek 2 .
 137 The current position pointer should only be set to a value returned by
 138 .Xr lseek 2 ,
 139 a value returned in the location pointed to by
 140 .Fa basep
 141 .Pf ( Fn getdirentries
 142 only)
 143 or zero.
 144 .Sh RETURN VALUES
 145 If successful, the number of bytes actually transferred is returned.
 146 Otherwise, -1 is returned and the global variable
 147 .Va errno
 148 is set to indicate the error.
 149 .Sh ERRORS
 150 .Fn Getdirentries
 151 will fail if:
 152 .Bl -tag -width Er
 153 .It Bq Er EBADF
 154 .Fa fd
 155 is not a valid file descriptor open for reading.
 156 .It Bq Er EFAULT
 157 Either
 158 .Fa buf
 159 or
 160 .Fa basep
 161 point outside the allocated address space.
 162 .It Bq Er EINVAL
 163 The file referenced by
 164 .Fa fd
 165 is not a directory, or
 166 .Fa nbytes
 167 is too small for returning a directory entry or block of entries,
 168 or the current position pointer is invalid.
 169 .It Bq Er EIO
 170 An
 171 .Tn I/O
 172 error occurred while reading from or writing to the file system.
 173 .El
 174 .Sh SEE ALSO
 175 .Xr lseek 2 ,
 176 .Xr open 2
 177 .Sh HISTORY
 178 The
 179 .Fn getdirentries
 180 function first appeared in
 181 .Bx 4.4 .
 182 The
 183 .Fn getdents
 184 function first appeared in
 185 .Fx 3.0 .