bsd/sys/dirent.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  26 /*-
  27  * Copyright (c) 1989, 1993
  28  *      The Regents of the University of California.  All rights reserved.
  29  *
  30  * Redistribution and use in source and binary forms, with or without
  31  * modification, are permitted provided that the following conditions
  32  * are met:
  33  * 1. Redistributions of source code must retain the above copyright
  34  *    notice, this list of conditions and the following disclaimer.
  35  * 2. Redistributions in binary form must reproduce the above copyright
  36  *    notice, this list of conditions and the following disclaimer in the
  37  *    documentation and/or other materials provided with the distribution.
  38  * 3. All advertising materials mentioning features or use of this software
  39  *    must display the following acknowledgement:
  40  *      This product includes software developed by the University of
  41  *      California, Berkeley and its contributors.
  42  * 4. Neither the name of the University nor the names of its contributors
  43  *    may be used to endorse or promote products derived from this software
  44  *    without specific prior written permission.
  45  *
  46  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  47  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  48  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  49  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  50  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  51  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  52  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  53  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  54  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  55  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  56  * SUCH DAMAGE.
  57  *
  58  *      @(#)dirent.h    8.3 (Berkeley) 8/10/94
  59  */
  60
  61 /*
  62  * The dirent structure defines the format of directory entries returned by
  63  * the getdirentries(2) system call.
  64  *
  65  * A directory entry has a struct dirent at the front of it, containing its
  66  * inode number, the length of the entry, and the length of the name
  67  * contained in the entry.  These are followed by the name padded to a 4
  68  * byte boundary with null bytes.  All names are guaranteed null terminated.
  69  * The maximum length of a name in a directory is MAXNAMLEN.
  70  */
  71
  72 #ifndef _SYS_DIRENT_H
  73 #define _SYS_DIRENT_H
  74
  75 struct dirent {
  76         u_int32_t d_fileno;             /* file number of entry */
  77         u_int16_t d_reclen;             /* length of this record */
  78         u_int8_t  d_type;               /* file type, see below */
  79         u_int8_t  d_namlen;             /* length of string in d_name */
  80 #ifdef _POSIX_SOURCE
  81         char    d_name[255 + 1];        /* name must be no longer than this */
  82 #else
  83 #define MAXNAMLEN       255
  84         char    d_name[MAXNAMLEN + 1];  /* name must be no longer than this */
  85 #endif
  86 };
  87
  88 /*
  89  * File types
  90  */
  91 #define DT_UNKNOWN       0
  92 #define DT_FIFO          1
  93 #define DT_CHR           2
  94 #define DT_DIR           4
  95 #define DT_BLK           6
  96 #define DT_REG           8
  97 #define DT_LNK          10
  98 #define DT_SOCK         12
  99 #define DT_WHT          14
 100
 101 /*
 102  * Convert between stat structure types and directory types.
 103  */
 104 #define IFTODT(mode)    (((mode) & 0170000) >> 12)
 105 #define DTTOIF(dirtype) ((dirtype) << 12)
 106
 107 #endif /* _SYS_DIRENT_H  */