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.\" $DragonFly: src/lib/libc/sys/getdirentries.2,v 1.8 2007/12/23 15:31:28 swildner Exp $ 35.\" 36.Dd July 31, 2006 37.Dt GETDIRENTRIES 2 38.Os 39.Sh NAME 40.Nm getdirentries , 41.Nm getdents 42.Nd "get directory entries in a filesystem independent format" 43.Sh LIBRARY 44.Lb libc 45.Sh SYNOPSIS 46.In sys/types.h 47.In dirent.h 48.Ft int 49.Fn getdirentries "int fd" "char *buf" "int nbytes" "long *basep" 50.Ft int 51.Fn getdents "int fd" "char *buf" "int nbytes" 52.Ft size_t 53.Fn _DIRENT_DIRSIZ "struct dirent *dp" 54.Ft struct dirent * 55.Fn _DIRENT_NEXT "struct dirent *dp" 56.Sh DESCRIPTION 57The 58.Fn getdirentries 59and 60.Fn getdents 61functions read directory entries from the directory 62referenced by the file descriptor 63.Fa fd 64into the buffer pointed to by 65.Fa buf , 66in a filesystem independent format. 67Up to 68.Fa nbytes 69of data will be transferred. 70The 71.Fa nbytes 72argument must be greater than or equal to the 73block size associated with the file, 74see 75.Xr stat 2 . 76Some filesystems may not support these functions 77with buffers smaller than this size. 78.Pp 79The data in the buffer is a series of 80.Em dirent 81structures each containing the following entries: 82.Bd -literal -offset indent 83ino_t d_fileno; 84u_int8_t d_type; 85u_int8_t d_namlen; 86char d_name[...]; /* see below */ 87.Ed 88.Pp 89The 90.Fa d_fileno 91entry is a number which is unique for each 92distinct file in the filesystem. 93Files that are linked by hard links (see 94.Xr link 2 ) 95have the same 96.Fa d_fileno . 97The 98.Fa d_type 99entry is the type of the file pointed to by the directory record. 100The file type values are defined in 101.In sys/dirent.h . 102The 103.Fa d_name 104entry contains a null terminated file name. 105The 106.Fa d_namlen 107entry specifies the length of the file name excluding the null byte. 108Thus the actual size of 109.Fa d_name 110may vary from 1 to 111.Dv MAXNAMELEN 112\&+ 1. 113.Pp 114Entries may be separated by extra space. 115To get the total size of a 116.Fa dirent 117structure, use the 118.Nm _DIRENT_DIRSIZ 119macro, or use 120.Nm _DIRENT_NEXT 121to get a pointer to the following 122.Fa dirent 123structure. 124.Pp 125The actual number of bytes transferred is returned. 126The current position pointer associated with 127.Fa fd 128is set to point to the next block of entries. 129The pointer may not advance by the number of bytes returned by 130.Fn getdirentries 131or 132.Fn getdents . 133A value of zero is returned when 134the end of the directory has been reached. 135.Pp 136The 137.Fn getdirentries 138function writes the position of the block read into the location pointed to by 139.Fa basep . 140Alternatively, the current position pointer may be set and retrieved by 141.Xr lseek 2 . 142The current position pointer should only be set to a value returned by 143.Xr lseek 2 , 144a value returned in the location pointed to by 145.Fa basep 146.Pf ( Fn getdirentries 147only) 148or zero. 149.Sh RETURN VALUES 150If successful, the number of bytes actually transferred is returned. 151Otherwise, -1 is returned and the global variable 152.Va errno 153is set to indicate the error. 154.Sh ERRORS 155.Fn Getdirentries 156will fail if: 157.Bl -tag -width Er 158.It Bq Er EBADF 159.Fa fd 160is not a valid file descriptor open for reading. 161.It Bq Er EFAULT 162Either 163.Fa buf 164or 165.Fa basep 166point outside the allocated address space. 167.It Bq Er EINVAL 168The file referenced by 169.Fa fd 170is not a directory, or 171.Fa nbytes 172is too small for returning a directory entry or block of entries, 173or the current position pointer is invalid. 174.It Bq Er EIO 175An 176.Tn I/O 177error occurred while reading from or writing to the file system. 178.El 179.Sh SEE ALSO 180.Xr lseek 2 , 181.Xr open 2 182.Sh HISTORY 183The 184.Fn getdirentries 185function first appeared in 186.Bx 4.4 . 187The 188.Fn getdents 189function first appeared in 190.Fx 3.0 . 191.Sh BUGS 192Unfortunately, 193.Fa *basep 194is only 32 bits wide on 32 bit platforms and 195may not be wide enough to accommodate the directory position cookie. 196Modern users should use 197.Xr lseek 2 . 198to retrieve and set the seek position within the directory. 199The seek offset is 64 bits wide on all platforms. 200