include/sys/dirent.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*      Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */
  22 /*        All Rights Reserved   */
  23
  24
  25 /*
  26  * Copyright 2014 Garrett D'Amore <garrett@damore.org>
  27  *
  28  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
  29  * Use is subject to license terms.
  30  */
  31
  32 #ifndef _SYS_DIRENT_H
  33 #define _SYS_DIRENT_H
  34
  35 #include <sys/feature_tests.h>
  36
  37 #ifdef  __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /*
  42  * File-system independent directory entry.
  43  */
  44 typedef struct dirent {
  45         ino_t           d_ino;          /* "inode number" of entry */
  46         off_t           d_off;          /* offset of disk directory entry */
  47         unsigned short  d_reclen;       /* length of this record */
  48         char            d_name[1];      /* name of file */
  49 } dirent_t;
  50
  51 #if defined(_SYSCALL32)
  52
  53 /* kernel's view of user ILP32 dirent */
  54
  55 typedef struct dirent32 {
  56         ino32_t         d_ino;          /* "inode number" of entry */
  57         off32_t         d_off;          /* offset of disk directory entry */
  58         uint16_t        d_reclen;       /* length of this record */
  59         char            d_name[1];      /* name of file */
  60 } dirent32_t;
  61
  62 #endif  /* _SYSCALL32 */
  63
  64 #ifdef  _LARGEFILE64_SOURCE
  65
  66 /*
  67  * transitional large file interface version AND kernel internal version
  68  */
  69 typedef struct dirent64 {
  70         ino64_t         d_ino;          /* "inode number" of entry */
  71         off64_t         d_off;          /* offset of disk directory entry */
  72         unsigned short  d_reclen;       /* length of this record */
  73         char            d_name[1];      /* name of file */
  74 } dirent64_t;
  75
  76 #endif  /* _LARGEFILE64_SOURCE */
  77
  78 #if !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__)
  79 #if defined(_KERNEL)
  80 #define DIRENT64_RECLEN(namelen)        \
  81         ((offsetof(dirent64_t, d_name[0]) + 1 + (namelen) + 7) & ~ 7)
  82 #define DIRENT64_NAMELEN(reclen)        \
  83         ((reclen) - (offsetof(dirent64_t, d_name[0])))
  84 #define DIRENT32_RECLEN(namelen)        \
  85         ((offsetof(dirent32_t, d_name[0]) + 1 + (namelen) + 3) & ~ 3)
  86 #define DIRENT32_NAMELEN(reclen)        \
  87         ((reclen) - (offsetof(dirent32_t, d_name[0])))
  88 #endif
  89
  90 /*
  91  * This is the maximum number of bytes that getdents(2) will store in
  92  * user-supplied dirent buffers.
  93  */
  94 #define MAXGETDENTS_SIZE        (64 * 1024)
  95
  96 #if !defined(_KERNEL)
  97
  98 /*
  99  * large file compilation environment setup
 100  *
 101  * In the LP64 compilation environment, map large file interfaces
 102  * back to native versions where possible. (This only works because
 103  * a 'struct dirent' == 'struct dirent64').
 104  */
 105
 106 #if !defined(_LP64) && _FILE_OFFSET_BITS == 64
 107 #ifdef  __PRAGMA_REDEFINE_EXTNAME
 108 #pragma redefine_extname        getdents        getdents64
 109 #else
 110 #define getdents                getdents64
 111 #endif
 112 #endif  /* !_LP64 && _FILE_OFFSET_BITS == 64 */
 113
 114 #if defined(_LP64) && defined(_LARGEFILE64_SOURCE)
 115 #ifdef  __PRAGMA_REDEFINE_EXTNAME
 116 #pragma redefine_extname        getdents64      getdents
 117 #else
 118 #define getdents64              getdents
 119 #define dirent64                dirent
 120 #define dirent64_t              dirent_t
 121 #endif
 122 #endif  /* _LP64 && _LARGEFILE64_SOURCE */
 123
 124 extern int getdents(int, struct dirent *, size_t);
 125
 126 /* N.B.: transitional large file interface version deliberately not provided */
 127
 128 #endif /* !defined(_KERNEL) */
 129 #endif /* !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__) */
 130
 131 #ifdef  __cplusplus
 132 }
 133 #endif
 134
 135 #endif  /* _SYS_DIRENT_H */