bsd/sys/dirent.h

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