[apple/xnu.git] / bsd / man / man5 / dir.5

.\"	$NetBSD: dir.5,v 1.5 1995/03/28 17:30:20 jtc Exp $
.\"
.\" Copyright (c) 1983, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)dir.5	8.3 (Berkeley) 4/19/94
.\"
.Dd April 19, 1994
.Dt DIR 5
.Os BSD 4.2
.Sh NAME
.Nm dir ,
.Nm dirent
.Nd directory file format
.Sh SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <sys/dir.h>
.Sh DESCRIPTION
Directories provide a convenient hierarchical method of grouping
files while obscuring the underlying details of the storage medium.
A directory file is differentiated from a plain file
by a flag in its
.Xr inode 5
entry.
It consists of records (directory entries) each of which contains
information about a file and a pointer to the file itself.
Directory entries may contain other directories
as well as plain files; such nested directories are refered to as
subdirectories. 
A hierarchy of directories and files is formed in this manner
and is called a file system (or referred to as a file system tree).
.\" An entry in this tree,
.\" nested or not nested,
.\" is a pathname.
.Pp
Each directory file contains two special directory entries; one is a pointer
to the directory itself
called dot
.Ql \&.
and the other a pointer to its parent directory called dot-dot
.Ql \&.. .
Dot and dot-dot
are valid pathnames, however,
the system root directory
.Ql / ,
has no parent and dot-dot points to itself like dot.
.Pp
File system nodes are ordinary directory files on which has
been grafted a file system object, such as a physical disk or a
partitioned area of such a disk.
(See
.Xr mount 1
and
.Xr mount 8 . )
.Pp
The directory entry format is defined in the file
.Aq sys/dirent.h 
and further in the file
.Aq dirent.h :
.Bd -literal
/*** Excerpt from <sys/dirent.h> ***/
/*
 * The dirent structure defines the format of directory entries returned by 
 * the getdirentries(2) system call.
 *
 * A directory entry has a struct dirent at the front of it, containing its
 * inode number, the length of the entry, and the length of the name
 * contained in the entry.  These are followed by the name padded to a 4
 * byte boundary with null bytes.  All names are guaranteed null terminated.
 * The maximum length of a name in a directory is MAXNAMLEN.
 * The dirent structure defines the format of directory entries returned by 
 * the getdirentries(2) system call.
 */

#ifndef _SYS_DIRENT_H 
#define _SYS_DIRENT_H 

struct dirent {
        u_int32_t d_fileno;             /* file number of entry */
        u_int16_t d_reclen;             /* length of this record */
        u_int8_t  d_type;               /* file type, see below */
        u_int8_t  d_namlen;             /* length of string in d_name */
#ifdef _POSIX_SOURCE
        char    d_name[255 + 1];        /* name must be no longer than this */
#else
#define MAXNAMLEN       255
        char    d_name[MAXNAMLEN + 1];  /* name must be no longer than this */
#endif
};

/*
 * File types
 */
#define DT_UNKNOWN       0
#define DT_FIFO          1
#define DT_CHR           2
#define DT_DIR           4
#define DT_BLK           6
#define DT_REG           8
#define DT_LNK          10
#define DT_SOCK         12
#define DT_WHT          14

#endif /* !_SYS_DIRENT_H_ */

.Ed
-----------------------------------------
.Bd -literal
/*** Excerpt from <dirent.h> ***/

#ifndef _DIRENT_H 
#define _DIRENT_H 

#ifdef _POSIX_SOURCE
typedef void *  DIR;
#else

#define d_ino           d_fileno        /* backward compatibility */

/* definitions for library routines operating on directories. */
#define DIRBLKSIZ       1024

struct _telldir;                /* see telldir.h */

/* structure describing an open directory. */
typedef struct _dirdesc {
        int     dd_fd;          /* file descriptor associated with directory */
        long    dd_loc;         /* offset in current buffer */
        long    dd_size;        /* amount of data returned by getdirentries */
        char    *dd_buf;        /* data buffer */
        int     dd_len;         /* size of data buffer */
        long    dd_seek;        /* magic cookie returned by getdirentries */
        long    dd_rewind;      /* magic cookie for rewinding */
        int     dd_flags;       /* flags for readdir */
        pthread_mutex_t dd_lock; /* for thread locking */
        struct _telldir *dd_td; /* telldir position recording */
} DIR;

#define dirfd(dirp)     ((dirp)->dd_fd)

/* flags for opendir2 */
#define DTF_HIDEW       0x0001  /* hide whiteout entries */
#define DTF_NODUP       0x0002  /* don't return duplicate names */
/* structure describing an open directory. */
typedef struct _dirdesc {
        int     dd_fd;          /* file descriptor associated with directory */
        long    dd_loc;         /* offset in current buffer */
        long    dd_size;        /* amount of data returned by getdirentries */
        char    *dd_buf;        /* data buffer */
        int     dd_len;         /* size of data buffer */
        long    dd_seek;        /* magic cookie returned by getdirentries */
        long    dd_rewind;      /* magic cookie for rewinding */
        int     dd_flags;       /* flags for readdir */
        pthread_mutex_t dd_lock; /* for thread locking */
        struct _telldir *dd_td; /* telldir position recording */
} DIR;

#define dirfd(dirp)     ((dirp)->dd_fd)

/* flags for opendir2 */
#define DTF_HIDEW       0x0001  /* hide whiteout entries */
#define DTF_NODUP       0x0002  /* don't return duplicate names */
#define DTF_REWIND      0x0004  /* rewind after reading union stack */
#define __DTF_READALL   0x0008  /* everything has been read */

#ifndef NULL
#define NULL    0
#endif

#endif /* _POSIX_SOURCE */

#endif /* !_DIRENT_H_ */
.Ed
.Sh SEE ALSO
.Xr fs 5 ,
.Xr inode 5
.Sh HISTORY
A
.Nm
file format appeared in
.At v7 .
Commit	Line	Data
9bccf70c A	1	.\" $NetBSD: dir.5,v 1.5 1995/03/28 17:30:20 jtc Exp $
	2	.\"
	3	.\" Copyright (c) 1983, 1991, 1993
	4	.\" The Regents of the University of California. All rights reserved.
	5	.\"
	6	.\" Redistribution and use in source and binary forms, with or without
	7	.\" modification, are permitted provided that the following conditions
	8	.\" are met:
	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.
	21	.\"
	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
	32	.\" SUCH DAMAGE.
	33	.\"
	34	.\" @(#)dir.5 8.3 (Berkeley) 4/19/94
	35	.\"
	36	.Dd April 19, 1994
	37	.Dt DIR 5
	38	.Os BSD 4.2
	39	.Sh NAME
	40	.Nm dir ,
	41	.Nm dirent
	42	.Nd directory file format
	43	.Sh SYNOPSIS
	44	.Fd #include <sys/types.h>
	45	.Fd #include <sys/dir.h>
	46	.Sh DESCRIPTION
	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
	50	by a flag in its
	51	.Xr inode 5
	52	entry.
	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
	57	subdirectories.
	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,
	62	.\" is a pathname.
	63	.Pp
	64	Each directory file contains two special directory entries; one is a pointer
65	to the directory itself
66	called dot
67	.Ql \&.
68	and the other a pointer to its parent directory called dot-dot
69	.Ql \&.. .
70	Dot and dot-dot
71	are valid pathnames, however,
72	the system root directory
73	.Ql / ,
74	has no parent and dot-dot points to itself like dot.
75	.Pp
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.
79	(See
80	.Xr mount 1
81	and
82	.Xr mount 8 . )
83	.Pp
84	The directory entry format is defined in the file
55e303ae A	85	.Aq sys/dirent.h
55e303ae A	86	and further in the file
9bccf70c A	87	.Aq dirent.h :
9bccf70c A	88	.Bd -literal
55e303ae	89	/* Excerpt from <sys/dirent.h> */
9bccf70c	90	/*
55e303ae A	91	* The dirent structure defines the format of directory entries returned by
	92	* the getdirentries(2) system call.
	93	*
	94	* A directory entry has a struct dirent at the front of it, containing its
	95	* inode number, the length of the entry, and the length of the name
	96	* contained in the entry. These are followed by the name padded to a 4
	97	* byte boundary with null bytes. All names are guaranteed null terminated.
	98	* The maximum length of a name in a directory is MAXNAMLEN.
	99	* The dirent structure defines the format of directory entries returned by
	100	* the getdirentries(2) system call.
	101	*/
	102
	103	#ifndef _SYS_DIRENT_H
	104	#define _SYS_DIRENT_H
9bccf70c A	105
9bccf70c A	106	struct dirent {
55e303ae A	107	u_int32_t d_fileno; /* file number of entry */
	108	u_int16_t d_reclen; /* length of this record */
	109	u_int8_t d_type; /* file type, see below */
	110	u_int8_t d_namlen; /* length of string in d_name */
9bccf70c	111	#ifdef _POSIX_SOURCE
55e303ae	112	char d_name[255 + 1]; /* name must be no longer than this */
9bccf70c A	113	#else
9bccf70c A	114	#define MAXNAMLEN 255
55e303ae	115	char d_name[MAXNAMLEN + 1]; /* name must be no longer than this */
9bccf70c	116	#endif
9bccf70c A	117	};
9bccf70c A	118
55e303ae A	119	/*
	120	* File types
	121	*/
	122	#define DT_UNKNOWN 0
	123	#define DT_FIFO 1
	124	#define DT_CHR 2
	125	#define DT_DIR 4
	126	#define DT_BLK 6
	127	#define DT_REG 8
	128	#define DT_LNK 10
	129	#define DT_SOCK 12
	130	#define DT_WHT 14
	131
	132	#endif /* !_SYS_DIRENT_H_ */
	133
	134	.Ed
	135	-----------------------------------------
	136	.Bd -literal
	137	/* Excerpt from <dirent.h> */
	138
	139	#ifndef _DIRENT_H
	140	#define _DIRENT_H
	141
9bccf70c	142	#ifdef _POSIX_SOURCE
55e303ae	143	typedef void * DIR;
9bccf70c A	144	#else
9bccf70c A	145
55e303ae	146	#define d_ino d_fileno /* backward compatibility */
9bccf70c A	147
9bccf70c A	148	/* definitions for library routines operating on directories. */
55e303ae A	149	#define DIRBLKSIZ 1024
	150
	151	struct _telldir; /* see telldir.h */
9bccf70c A	152
	153	/* structure describing an open directory. */
	154	typedef struct _dirdesc {
55e303ae A	155	int dd_fd; /* file descriptor associated with directory */
	156	long dd_loc; /* offset in current buffer */
	157	long dd_size; /* amount of data returned by getdirentries */
	158	char dd_buf; / data buffer */
	159	int dd_len; /* size of data buffer */
	160	long dd_seek; /* magic cookie returned by getdirentries */
	161	long dd_rewind; /* magic cookie for rewinding */
	162	int dd_flags; /* flags for readdir */
	163	pthread_mutex_t dd_lock; /* for thread locking */
	164	struct _telldir dd_td; / telldir position recording */
9bccf70c A	165	} DIR;
9bccf70c A	166
55e303ae	167	#define dirfd(dirp) ((dirp)->dd_fd)
9bccf70c	168
55e303ae A	169	/* flags for opendir2 */
	170	#define DTF_HIDEW 0x0001 /* hide whiteout entries */
	171	#define DTF_NODUP 0x0002 /* don't return duplicate names */
	172	/* structure describing an open directory. */
	173	typedef struct _dirdesc {
	174	int dd_fd; /* file descriptor associated with directory */
	175	long dd_loc; /* offset in current buffer */
	176	long dd_size; /* amount of data returned by getdirentries */
	177	char dd_buf; / data buffer */
	178	int dd_len; /* size of data buffer */
	179	long dd_seek; /* magic cookie returned by getdirentries */
	180	long dd_rewind; /* magic cookie for rewinding */
	181	int dd_flags; /* flags for readdir */
	182	pthread_mutex_t dd_lock; /* for thread locking */
	183	struct _telldir dd_td; / telldir position recording */
	184	} DIR;
9bccf70c	185
55e303ae	186	#define dirfd(dirp) ((dirp)->dd_fd)
9bccf70c	187
55e303ae A	188	/* flags for opendir2 */
	189	#define DTF_HIDEW 0x0001 /* hide whiteout entries */
	190	#define DTF_NODUP 0x0002 /* don't return duplicate names */
	191	#define DTF_REWIND 0x0004 /* rewind after reading union stack */
	192	#define __DTF_READALL 0x0008 /* everything has been read */
9bccf70c	193
55e303ae A	194	#ifndef NULL
	195	#define NULL 0
	196	#endif
9bccf70c	197
55e303ae	198	#endif /* _POSIX_SOURCE */
9bccf70c A	199
	200	#endif /* !_DIRENT_H_ */
	201	.Ed
	202	.Sh SEE ALSO
	203	.Xr fs 5 ,
	204	.Xr inode 5
	205	.Sh HISTORY
	206	A
	207	.Nm
	208	file format appeared in
	209	.At v7 .