bsd/sys/dirent.h

   1 /*
   2  * Copyright (c) 2000-2008 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  29 /*-
  30  * Copyright (c) 1989, 1993
  31  *      The Regents of the University of California.  All rights reserved.
  32  *
  33  * Redistribution and use in source and binary forms, with or without
  34  * modification, are permitted provided that the following conditions
  35  * are met:
  36  * 1. Redistributions of source code must retain the above copyright
  37  *    notice, this list of conditions and the following disclaimer.
  38  * 2. Redistributions in binary form must reproduce the above copyright
  39  *    notice, this list of conditions and the following disclaimer in the
  40  *    documentation and/or other materials provided with the distribution.
  41  * 3. All advertising materials mentioning features or use of this software
  42  *    must display the following acknowledgement:
  43  *      This product includes software developed by the University of
  44  *      California, Berkeley and its contributors.
  45  * 4. Neither the name of the University nor the names of its contributors
  46  *    may be used to endorse or promote products derived from this software
  47  *    without specific prior written permission.
  48  *
  49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  59  * SUCH DAMAGE.
  60  *
  61  *      @(#)dirent.h    8.3 (Berkeley) 8/10/94
  62  */
  63
  64 /*
  65  * The dirent structure defines the format of directory entries.
  66  *
  67  * A directory entry has a struct dirent at the front of it, containing its
  68  * inode number, the length of the entry, and the length of the name
  69  * contained in the entry.  These are followed by the name padded to a 4
  70  * byte boundary with null bytes.  All names are guaranteed null terminated.
  71  * The maximum length of a name in a directory is MAXNAMLEN when 32-bit
  72  * ino_t is in effect; (MAXPATHLEN - 1) when 64-bit ino_t is in effect.
  73  */
  74
  75 #ifndef _SYS_DIRENT_H
  76 #define _SYS_DIRENT_H
  77
  78 #include <sys/_types.h>
  79 #include <sys/cdefs.h>
  80
  81 #ifndef _INO_T
  82 typedef __darwin_ino_t  ino_t;          /* inode number */
  83 #define _INO_T
  84 #endif
  85
  86
  87 #define __DARWIN_MAXNAMLEN      255
  88
  89 #pragma pack(4)
  90
  91 #if !__DARWIN_64_BIT_INO_T
  92 struct dirent {
  93         ino_t d_ino;                    /* file number of entry */
  94         __uint16_t d_reclen;            /* length of this record */
  95         __uint8_t  d_type;              /* file type, see below */
  96         __uint8_t  d_namlen;            /* length of string in d_name */
  97         char d_name[__DARWIN_MAXNAMLEN + 1];    /* name must be no longer than this */
  98 };
  99 #endif /* !__DARWIN_64_BIT_INO_T */
 100
 101 #pragma pack()
 102
 103 #define __DARWIN_MAXPATHLEN     1024
 104
 105 #define __DARWIN_STRUCT_DIRENTRY { \
 106         __uint64_t  d_ino;      /* file number of entry */ \
 107         __uint64_t  d_seekoff;  /* seek offset (optional, used by servers) */ \
 108         __uint16_t  d_reclen;   /* length of this record */ \
 109         __uint16_t  d_namlen;   /* length of string in d_name */ \
 110         __uint8_t   d_type;     /* file type, see below */ \
 111         char      d_name[__DARWIN_MAXPATHLEN]; /* entry name (up to MAXPATHLEN bytes) */ \
 112 }
 113
 114 #if __DARWIN_64_BIT_INO_T
 115 struct dirent __DARWIN_STRUCT_DIRENTRY;
 116 #endif /* __DARWIN_64_BIT_INO_T */
 117
 118 #ifdef KERNEL
 119 /* Extended directory entry */
 120 struct direntry __DARWIN_STRUCT_DIRENTRY;
 121 #endif
 122
 123
 124 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 125 #define d_fileno        d_ino           /* backward compatibility */
 126 #define MAXNAMLEN       __DARWIN_MAXNAMLEN
 127 /*
 128  * File types
 129  */
 130 #define DT_UNKNOWN       0
 131 #define DT_FIFO          1
 132 #define DT_CHR           2
 133 #define DT_DIR           4
 134 #define DT_BLK           6
 135 #define DT_REG           8
 136 #define DT_LNK          10
 137 #define DT_SOCK         12
 138 #define DT_WHT          14
 139
 140 /*
 141  * Convert between stat structure types and directory types.
 142  */
 143 #define IFTODT(mode)    (((mode) & 0170000) >> 12)
 144 #define DTTOIF(dirtype) ((dirtype) << 12)
 145 #endif
 146
 147 #endif /* _SYS_DIRENT_H  */