1 .\" $NetBSD: dir.5,v 1.5 1995/03/28 17:30:20 jtc Exp $
3 .\" Copyright (c) 1983, 1991, 1993
4 .\" The Regents of the University of California. All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. All advertising materials mentioning features or use of this software
15 .\" must display the following acknowledgement:
16 .\" This product includes software developed by the University of
17 .\" California, Berkeley and its contributors.
18 .\" 4. Neither the name of the University nor the names of its contributors
19 .\" may be used to endorse or promote products derived from this software
20 .\" without specific prior written permission.
22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .\" @(#)dir.5 8.3 (Berkeley) 4/19/94
42 .Nd directory file format
44 .Fd #include <sys/types.h>
45 .Fd #include <sys/dir.h>
47 Directories provide a convenient hierarchical method of grouping
48 files while obscuring the underlying details of the storage medium.
49 A directory file is differentiated from a plain file
53 It consists of records (directory entries) each of which contains
54 information about a file and a pointer to the file itself.
55 Directory entries may contain other directories
56 as well as plain files; such nested directories are refered to as
58 A hierarchy of directories and files is formed in this manner
59 and is called a file system (or referred to as a file system tree).
60 .\" An entry in this tree,
61 .\" nested or not nested,
64 Each directory file contains two special directory entries; one is a pointer
65 to the directory itself
68 and the other a pointer to its parent directory called dot-dot
71 are valid pathnames, however,
72 the system root directory
74 has no parent and dot-dot points to itself like dot.
76 File system nodes are ordinary directory files on which has
77 been grafted a file system object, such as a physical disk or a
78 partitioned area of such a disk.
84 The directory entry format is defined in the file
86 and further in the file
89 /*** Excerpt from <sys/dirent.h> ***/
91 * The dirent structure defines the format of directory entries.
93 * A directory entry has a struct dirent at the front of it, containing its
94 * inode number, the length of the entry, and the length of the name
95 * contained in the entry. These are followed by the name padded to a 4
96 * byte boundary with null bytes. All names are guaranteed null terminated.
97 * The maximum length of a name in a directory is MAXPATHLEN.
100 #ifndef _SYS_DIRENT_H
101 #define _SYS_DIRENT_H
104 ino_t d_ino; /* file number of entry */
105 u_int64_t d_seekoff; /* length of this record */
106 u_int16_t d_reclen; /* length of this record */
107 u_int16_t d_namlen; /* length of string in d_name */
108 u_int8_t d_type; /* file type, see below */
109 char d_name[MAXPATHLEN]; /* name must be no longer than this */
125 #endif /* !_SYS_DIRENT_H_ */
128 -----------------------------------------
130 /*** Excerpt from <dirent.h> ***/
135 /* definitions for library routines operating on directories. */
136 #define DIRBLKSIZ 1024
138 struct _telldir; /* see telldir.h */
140 /* structure describing an open directory. */
142 int __dd_fd; /* file descriptor associated with directory */
143 long __dd_loc; /* offset in current buffer */
144 long __dd_size; /* amount of data returned by getdirentries */
145 char *__dd_buf; /* data buffer */
146 int __dd_len; /* size of data buffer */
147 long __dd_seek; /* magic cookie returned by getdirentries */
148 long __dd_rewind; /* magic cookie for rewinding */
149 int __dd_flags; /* flags for readdir */
150 pthread_mutex_t __dd_lock; /* for thread locking */
151 struct _telldir *__dd_td; /* telldir position recording */
154 #define dirfd(dirp) ((dirp)->__dd_fd)
156 /* flags for opendir2 */
157 #define DTF_HIDEW 0x0001 /* hide whiteout entries */
158 #define DTF_NODUP 0x0002 /* don't return duplicate names */
159 #define DTF_REWIND 0x0004 /* rewind after reading union stack */
160 #define __DTF_READALL 0x0008 /* everything has been read */
162 #endif /* !_DIRENT_H_ */
170 file format appeared in