sys/dirent.h

Go to the documentation of this file.
00001 /*-
00002  * Copyright (c) 1989, 1993
00003  *      The Regents of the University of California.  All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions
00007  * are met:
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 4. Neither the name of the University nor the names of its contributors
00014  *    may be used to endorse or promote products derived from this software
00015  *    without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
00018  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
00021  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00022  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00023  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00024  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00025  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00026  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00027  * SUCH DAMAGE.
00028  *
00029  *      @(#)dirent.h    8.3 (Berkeley) 8/10/94
00030  * $FreeBSD: src/sys/sys/dirent.h,v 1.14 2004/04/07 04:19:49 imp Exp $
00031  */
00032 
00033 #ifndef _SYS_DIRENT_H_
00034 #define _SYS_DIRENT_H_
00035 
00036 #include <sys/cdefs.h>
00037 #include <sys/_types.h>
00038 #include <stddef.h>
00039 
00040 /*
00041  * The dirent structure defines the format of directory entries returned by
00042  * the getdirentries(2) system call.
00043  *
00044  * A directory entry has a struct dirent at the front of it, containing its
00045  * inode number, the length of the entry, and the length of the name
00046  * contained in the entry.  These are followed by the name padded to a 4
00047  * byte boundary with null bytes.  All names are guaranteed null terminated.
00048  * The maximum length of a name in a directory is MAXNAMLEN.
00049  */
00050 
00051 struct dirent {
00052         __uint32_t d_fileno;            /* file number of entry */
00053         __uint16_t d_reclen;            /* length of this record */
00054         __uint8_t  d_type;              /* file type, see below */
00055         __uint8_t  d_namlen;            /* length of string in d_name */
00056 #if __BSD_VISIBLE
00057 #define MAXNAMLEN       255
00058         char    d_name[MAXNAMLEN + 1];  /* name must be no longer than this */
00059 #else
00060         char    d_name[255 + 1];        /* name must be no longer than this */
00061 #endif
00062 };
00063 
00064 #ifdef __SYMBIAN32__
00065 struct wdirent {
00066         unsigned long   d_fileno;
00067         unsigned short  d_namlen;
00068         wchar_t*                d_name;
00069 };
00070 
00071 typedef struct __EPOC32_WDIR WDIR;
00072 #endif
00073 
00074 
00075 #if __BSD_VISIBLE
00076 /*
00077  * File types
00078  */
00079 #define DT_UNKNOWN       0
00080 #define DT_FIFO          1
00081 #define DT_CHR           2
00082 #define DT_DIR           4
00083 #define DT_BLK           6
00084 #define DT_REG           8
00085 #define DT_LNK          10
00086 #define DT_SOCK         12
00087 #define DT_WHT          14
00088 
00089 /*
00090  * Convert between stat structure types and directory types.
00091  */
00092 #define IFTODT(mode)    (((mode) & 0170000) >> 12)
00093 #define DTTOIF(dirtype) ((dirtype) << 12)
00094 
00095 /*
00096  * The _GENERIC_DIRSIZ macro gives the minimum record length which will hold
00097  * the directory entry.  This requires the amount of space in struct direct
00098  * without the d_name field, plus enough space for the name with a terminating
00099  * null byte (dp->d_namlen+1), rounded up to a 4 byte boundary.
00100  *
00101  * XXX although this macro is in the implementation namespace, it requires
00102  * a manifest constant that is not.
00103  */
00104 #define _GENERIC_DIRSIZ(dp) \
00105     ((sizeof (struct dirent) - (MAXNAMLEN+1)) + (((dp)->d_namlen+1 + 3) &~ 3))
00106 #endif /* __BSD_VISIBLE */
00107 
00108 #ifdef _KERNEL
00109 #define GENERIC_DIRSIZ(dp)      _GENERIC_DIRSIZ(dp)
00110 #endif
00111 
00112 #endif /* !_SYS_DIRENT_H_ */

Copyright © Nokia Corporation 2001-2008
Back to top