]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/sys/dirent.h
xnu-6153.61.1.tar.gz
[apple/xnu.git] / bsd / sys / dirent.h
index d862d534764d6f9940d4a884ddca6dfbe35db568..4970773018aa911cde4ffb80700f14791c7b6480 100644 (file)
@@ -1,15 +1,20 @@
 /*
- * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2008 Apple Inc. All rights reserved.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  *
- * @APPLE_LICENSE_HEADER_START@
- * 
  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in
- * compliance with the License. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
- * 
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ *
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
@@ -17,8 +22,8 @@
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.
- * 
- * @APPLE_LICENSE_HEADER_END@
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
 /*-
  */
 
 /*
- * The dirent structure defines the format of directory entries returned by 
- * the getdirentries(2) system call.
+ * The dirent structure defines the format of directory entries.
  *
  * 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 maximum length of a name in a directory is MAXNAMLEN when 32-bit
+ * ino_t is in effect; (MAXPATHLEN - 1) when 64-bit ino_t is in effect.
  */
 
-#ifndef _SYS_DIRENT_H 
-#define _SYS_DIRENT_H 
+#ifndef _SYS_DIRENT_H
+#define _SYS_DIRENT_H
 
 #include <sys/_types.h>
 #include <sys/cdefs.h>
 
-#ifndef        _INO_T
-typedef        __darwin_ino_t  ino_t;          /* inode number */
-#define _INO_T
-#endif
+#include <sys/_types/_ino_t.h>
 
-#define __DARWIN_MAXNAMLEN     255
 
-#if __DARWIN_ALIGN_POWER
-#pragma options align=power
-#endif
+#define __DARWIN_MAXNAMLEN      255
+
+#pragma pack(4)
 
+#if !__DARWIN_64_BIT_INO_T
 struct dirent {
-       ino_t d_ino;                    /* file number of entry */
-       __uint16_t d_reclen;            /* length of this record */
-       __uint8_t  d_type;              /* file type, see below */
-       __uint8_t  d_namlen;            /* length of string in d_name */
-       char d_name[__DARWIN_MAXNAMLEN + 1];    /* name must be no longer than this */
+       ino_t d_ino;                    /* file number of entry */
+       __uint16_t d_reclen;            /* length of this record */
+       __uint8_t  d_type;              /* file type, see below */
+       __uint8_t  d_namlen;            /* length of string in d_name */
+       char d_name[__DARWIN_MAXNAMLEN + 1];    /* name must be no longer than this */
 };
+#endif /* !__DARWIN_64_BIT_INO_T */
 
-#if __DARWIN_ALIGN_POWER
-#pragma options align=reset
-#endif
+#pragma pack()
 
-#ifdef KERNEL
-#include <sys/kernel_types.h>
+#define __DARWIN_MAXPATHLEN     1024
 
+#define __DARWIN_STRUCT_DIRENTRY { \
+       __uint64_t  d_ino;      /* file number of entry */ \
+       __uint64_t  d_seekoff;  /* seek offset (optional, used by servers) */ \
+       __uint16_t  d_reclen;   /* length of this record */ \
+       __uint16_t  d_namlen;   /* length of string in d_name */ \
+       __uint8_t   d_type;     /* file type, see below */ \
+       char      d_name[__DARWIN_MAXPATHLEN]; /* entry name (up to MAXPATHLEN bytes) */ \
+}
+
+#if __DARWIN_64_BIT_INO_T
+struct dirent __DARWIN_STRUCT_DIRENTRY;
+#endif /* __DARWIN_64_BIT_INO_T */
+
+#ifdef KERNEL
 /* Extended directory entry */
-struct direntry{
-       ino64_t     d_ino;      /* file number of entry */
-       __uint64_t  d_seekoff;   /* seek offset (optional, used by servers) */
-       __uint16_t  d_reclen;   /* length of this record */
-       __uint16_t  d_namlen;   /* length of string in d_name */
-       __uint8_t   d_type;     /* file type, see below */
-       u_char      d_name[MAXPATHLEN - 1]; /* entry name (up to MAXPATHLEN - 1 bytes) */
-};
+struct direntry __DARWIN_STRUCT_DIRENTRY;
 #endif
 
 
-#ifndef _POSIX_C_SOURCE
-#define        d_fileno        d_ino           /* backward compatibility */
-#define        MAXNAMLEN       __DARWIN_MAXNAMLEN
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
+#define d_fileno        d_ino           /* backward compatibility */
+#define MAXNAMLEN       __DARWIN_MAXNAMLEN
 /*
  * 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
+#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
 
 /*
  * Convert between stat structure types and directory types.
  */
-#define        IFTODT(mode)    (((mode) & 0170000) >> 12)
-#define        DTTOIF(dirtype) ((dirtype) << 12)
+#define IFTODT(mode)    (((mode) & 0170000) >> 12)
+#define DTTOIF(dirtype) ((dirtype) << 12)
+#endif
+
+#if PRIVATE
+/*
+ * If a buffer at least this size is passed to __getdirentries64,
+ * the the last 4 bytes will be the flags below.
+ */
+#define GETDIRENTRIES64_EXTENDED_BUFSIZE  1024
+
+__options_decl(getdirentries64_flags_t, unsigned, {
+       /* the __getdirentries64 returned all entries */
+       GETDIRENTRIES64_EOF = 1U << 0,
+});
 #endif
 
 #endif /* _SYS_DIRENT_H  */