xref: /onnv-gate/usr/src/lib/libbc/inc/include/sys/dir.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
23*0Sstevel@tonic-gate 
24*0Sstevel@tonic-gate /*
25*0Sstevel@tonic-gate  * Filesystem-independent directory information.
26*0Sstevel@tonic-gate  * Directory entry structures are of variable length.
27*0Sstevel@tonic-gate  * Each directory entry is a struct direct containing its file number, the
28*0Sstevel@tonic-gate  * offset of the next entry (a cookie interpretable only the filesystem
29*0Sstevel@tonic-gate  * type that generated it), the length of the entry, and the length of the
30*0Sstevel@tonic-gate  * name contained in the entry.  These are followed by the name. The
31*0Sstevel@tonic-gate  * entire entry is padded with null bytes to a 4 byte boundary. All names
32*0Sstevel@tonic-gate  * are guaranteed null terminated. The maximum length of a name in a
33*0Sstevel@tonic-gate  * directory is MAXNAMLEN, plus a null byte.
34*0Sstevel@tonic-gate  * Note: this file is present only for backwards compatibility. It is superseded
35*0Sstevel@tonic-gate  * by the files /usr/include/dirent.h and /usr/include/sys/dirent.h. It will
36*0Sstevel@tonic-gate  * disappear in a future major release.
37*0Sstevel@tonic-gate  */
38*0Sstevel@tonic-gate 
39*0Sstevel@tonic-gate #ifndef _sys_dir_h
40*0Sstevel@tonic-gate #define _sys_dir_h
41*0Sstevel@tonic-gate 
42*0Sstevel@tonic-gate #define	MAXNAMLEN	255
43*0Sstevel@tonic-gate 
44*0Sstevel@tonic-gate struct	direct {
45*0Sstevel@tonic-gate 	off_t   d_off;			/* offset of next disk directory entry */
46*0Sstevel@tonic-gate 	u_long	d_fileno;		/* file number of entry */
47*0Sstevel@tonic-gate 	u_short	d_reclen;		/* length of this record */
48*0Sstevel@tonic-gate 	u_short	d_namlen;		/* length of string in d_name */
49*0Sstevel@tonic-gate 	char	d_name[MAXNAMLEN + 1];	/* name (up to MAXNAMLEN + 1) */
50*0Sstevel@tonic-gate };
51*0Sstevel@tonic-gate 
52*0Sstevel@tonic-gate /*
53*0Sstevel@tonic-gate  * The macro DIRSIZ(dp) gives the minimum amount of space required to represent
54*0Sstevel@tonic-gate  * a directory entry.  For any directory entry dp->d_reclen >= DIRSIZ(dp).
55*0Sstevel@tonic-gate  * Specific filesystem typesm may use this macro to construct the value
56*0Sstevel@tonic-gate  * for d_reclen.
57*0Sstevel@tonic-gate  */
58*0Sstevel@tonic-gate #undef DIRSIZ
59*0Sstevel@tonic-gate #define DIRSIZ(dp)  \
60*0Sstevel@tonic-gate 	(((sizeof (struct direct) - (MAXNAMLEN+1) + ((dp)->d_namlen+1)) + 3) & ~3)
61*0Sstevel@tonic-gate 
62*0Sstevel@tonic-gate #ifndef KERNEL
63*0Sstevel@tonic-gate #define d_ino	d_fileno		/* compatability */
64*0Sstevel@tonic-gate 
65*0Sstevel@tonic-gate 
66*0Sstevel@tonic-gate /*
67*0Sstevel@tonic-gate  * Definitions for library routines operating on directories.
68*0Sstevel@tonic-gate  */
69*0Sstevel@tonic-gate 
70*0Sstevel@tonic-gate typedef struct _dirdesc {
71*0Sstevel@tonic-gate 	int	dd_fd;			/* file descriptor */
72*0Sstevel@tonic-gate 	long	dd_loc;             /* buf offset of entry from last readddir() */
73*0Sstevel@tonic-gate 	long	dd_size;		/* amount of valid data in buffer */
74*0Sstevel@tonic-gate 	long	dd_bsize;		/* amount of entries read at a time */
75*0Sstevel@tonic-gate 	long	dd_off;             	/* Current offset in dir (for telldir) */
76*0Sstevel@tonic-gate 	char	*dd_buf;		/* directory data buffer */
77*0Sstevel@tonic-gate } DIR;
78*0Sstevel@tonic-gate 
79*0Sstevel@tonic-gate #ifndef NULL
80*0Sstevel@tonic-gate #define NULL 0
81*0Sstevel@tonic-gate #endif
82*0Sstevel@tonic-gate extern	DIR *opendir();
83*0Sstevel@tonic-gate extern	struct direct *readdir();
84*0Sstevel@tonic-gate extern	long telldir();
85*0Sstevel@tonic-gate extern	void seekdir();
86*0Sstevel@tonic-gate #define rewinddir(dirp)	seekdir((dirp), (long)0)
87*0Sstevel@tonic-gate extern	int closedir();
88*0Sstevel@tonic-gate #endif
89*0Sstevel@tonic-gate 
90*0Sstevel@tonic-gate #endif /*!_sys_dir_h*/
91