share/man/man5/dir.5

   1 .\" Copyright (c) 1983, 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 .\"     @(#)dir.5       8.3 (Berkeley) 4/19/94
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd April 19, 1994
  32 .Dt DIR 5
  33 .Os
  34 .Sh NAME
  35 .Nm dir ,
  36 .Nm dirent
  37 .Nd directory file format
  38 .Sh SYNOPSIS
  39 .In dirent.h
  40 .Sh DESCRIPTION
  41 Directories provide a convenient hierarchical method of grouping
  42 files while obscuring the underlying details of the storage medium.
  43 A directory file is differentiated from a plain file
  44 by a flag in its
  45 .Xr inode 5
  46 entry.
  47 It consists of records (directory entries) each of which contains
  48 information about a file and a pointer to the file itself.
  49 Directory entries may contain other directories
  50 as well as plain files; such nested directories are referred to as
  51 subdirectories.
  52 A hierarchy of directories and files is formed in this manner
  53 and is called a file system (or referred to as a file system tree).
  54 .\" An entry in this tree,
  55 .\" nested or not nested,
  56 .\" is a pathname.
  57 .Pp
  58 Each directory file contains two special directory entries; one is a pointer
  59 to the directory itself
  60 called dot
  61 .Ql .\&
  62 and the other a pointer to its parent directory called dot-dot
  63 .Ql \&.. .
  64 Dot and dot-dot
  65 are valid pathnames, however,
  66 the system root directory
  67 .Ql / ,
  68 has no parent and dot-dot points to itself like dot.
  69 .Pp
  70 File system nodes are ordinary directory files on which has
  71 been grafted a file system object, such as a physical disk or a
  72 partitioned area of such a disk.
  73 (See
  74 .Xr mount 2
  75 and
  76 .Xr mount 8 . )
  77 .Pp
  78 The directory entry format is defined in the file
  79 .In sys/dirent.h
  80 (which should not be included directly by applications):
  81 .Bd -literal
  82 #ifndef _SYS_DIRENT_H_
  83 #define _SYS_DIRENT_H_
  84
  85 #include <machine/ansi.h>
  86
  87 /*
  88  * The dirent structure defines the format of directory entries returned by
  89  * the getdirentries(2) system call.
  90  *
  91  * A directory entry has a struct dirent at the front of it, containing its
  92  * inode number, the length of the entry, and the length of the name
  93  * contained in the entry.  These are followed by the name padded to a 4
  94  * byte boundary with null bytes.  All names are guaranteed null terminated.
  95  * The maximum length of a name in a directory is MAXNAMLEN.
  96  */
  97
  98 struct dirent {
  99         __uint32_t d_fileno;            /* file number of entry */
 100         __uint16_t d_reclen;            /* length of this record */
 101         __uint8_t  d_type;              /* file type, see below */
 102         __uint8_t  d_namlen;            /* length of string in d_name */
 103 #ifdef _POSIX_SOURCE
 104         char    d_name[255 + 1];        /* name must be no longer than this */
 105 #else
 106 #define MAXNAMLEN       255
 107         char    d_name[MAXNAMLEN + 1];  /* name must be no longer than this */
 108 #endif
 109 };
 110
 111 /*
 112  * File types
 113  */
 114 #define DT_UNKNOWN       0
 115 #define DT_FIFO          1
 116 #define DT_CHR           2
 117 #define DT_DIR           4
 118 #define DT_BLK           6
 119 #define DT_REG           8
 120 #define DT_LNK          10
 121 #define DT_SOCK         12
 122 #define DT_WHT          14
 123
 124 /*
 125  * Convert between stat structure types and directory types.
 126  */
 127 #define IFTODT(mode)    (((mode) & 0170000) >> 12)
 128 #define DTTOIF(dirtype) ((dirtype) << 12)
 129
 130 /*
 131  * The _GENERIC_DIRSIZ macro gives the minimum record length which will hold
 132  * the directory entry.  This requires the amount of space in struct direct
 133  * without the d_name field, plus enough space for the name with a terminating
 134  * null byte (dp->d_namlen+1), rounded up to a 4 byte boundary.
 135  */
 136 #define _GENERIC_DIRSIZ(dp) \
 137     ((sizeof (struct dirent) - (MAXNAMLEN+1)) + (((dp)->d_namlen+1 + 3) &~ 3))
 138
 139 #ifdef _KERNEL
 140 #define GENERIC_DIRSIZ(dp)      _GENERIC_DIRSIZ(dp)
 141 #endif
 142
 143 #endif /* !_SYS_DIRENT_H_ */
 144 .Ed
 145 .Sh SEE ALSO
 146 .Xr fs 5 ,
 147 .Xr inode 5
 148 .Sh HISTORY
 149 A
 150 .Nm
 151 file format appeared in
 152 .At v7 .
 153 .Sh BUGS
 154 The usage of the member d_type of struct dirent is unportable as it is
 155 .Fx Ns -specific .
 156 It also may fail on certain file systems, for example the cd9660 file system.