The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/dirent.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*      $NetBSD: dirent.h,v 1.23 2005/12/26 18:41:36 perry Exp $        */
    2 
    3 /*-
    4  * Copyright (c) 1989, 1993
    5  *      The Regents of the University of California.  All rights reserved.
    6  *
    7  * Redistribution and use in source and binary forms, with or without
    8  * modification, are permitted provided that the following conditions
    9  * are met:
   10  * 1. Redistributions of source code must retain the above copyright
   11  *    notice, this list of conditions and the following disclaimer.
   12  * 2. Redistributions in binary form must reproduce the above copyright
   13  *    notice, this list of conditions and the following disclaimer in the
   14  *    documentation and/or other materials provided with the distribution.
   15  * 3. Neither the name of the University nor the names of its contributors
   16  *    may be used to endorse or promote products derived from this software
   17  *    without specific prior written permission.
   18  *
   19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   29  * SUCH DAMAGE.
   30  *
   31  *      @(#)dirent.h    8.3 (Berkeley) 8/10/94
   32  */
   33 
   34 #ifndef _SYS_DIRENT_H_
   35 #define _SYS_DIRENT_H_
   36 
   37 #include <sys/featuretest.h>
   38 
   39 /*
   40  * The dirent structure defines the format of directory entries returned by
   41  * the getdents(2) system call.
   42  *
   43  * A directory entry has a struct dirent at the front of it, containing its
   44  * inode number, the length of the entry, and the length of the name
   45  * contained in the entry.  These are followed by the name padded to a 4
   46  * byte boundary with null bytes.  All names are guaranteed null terminated.
   47  * The maximum length of a name in a directory is MAXNAMLEN.
   48  */
   49 struct dirent {
   50         ino_t d_fileno;                 /* file number of entry */
   51         uint16_t d_reclen;              /* length of this record */
   52         uint16_t d_namlen;              /* length of string in d_name */
   53         uint8_t  d_type;                /* file type, see below */
   54 #if defined(_NETBSD_SOURCE)
   55 #define MAXNAMLEN       511
   56         char    d_name[MAXNAMLEN + 1];  /* name must be no longer than this */
   57 #else
   58         char    d_name[511 + 1];        /* name must be no longer than this */
   59 #endif
   60 };
   61 
   62 #if defined(_NETBSD_SOURCE)
   63 /*
   64  * File types
   65  */
   66 #define DT_UNKNOWN       0
   67 #define DT_FIFO          1
   68 #define DT_CHR           2
   69 #define DT_DIR           4
   70 #define DT_BLK           6
   71 #define DT_REG           8
   72 #define DT_LNK          10
   73 #define DT_SOCK         12
   74 #define DT_WHT          14
   75 
   76 /*
   77  * The _DIRENT_ALIGN macro returns the alignment of struct dirent.
   78  * struct direct and struct dirent12 used 4 byte alignment but
   79  * struct dirent uses 8.
   80  */
   81 #define _DIRENT_ALIGN(dp) (sizeof((dp)->d_fileno) - 1)
   82 /*
   83  * The _DIRENT_NAMEOFF macro returns the offset of the d_name field in 
   84  * struct dirent
   85  */
   86 #define _DIRENT_NAMEOFF(dp) \
   87     ((char *)(void *)&(dp)->d_name - (char *)(void *)dp)
   88 /*
   89  * The _DIRENT_RECLEN macro gives the minimum record length which will hold
   90  * a name of size "namlen".  This requires the amount of space in struct dirent
   91  * without the d_name field, plus enough space for the name with a terminating
   92  * null byte (namlen+1), rounded up to a the appropriate byte boundary.
   93  */
   94 #define _DIRENT_RECLEN(dp, namlen) \
   95     ((_DIRENT_NAMEOFF(dp) + (namlen) + 1 + _DIRENT_ALIGN(dp)) & \
   96     ~_DIRENT_ALIGN(dp))
   97 /*
   98  * The _DIRENT_SIZE macro returns the minimum record length required for
   99  * name name stored in the current record.
  100  */
  101 #define _DIRENT_SIZE(dp) _DIRENT_RECLEN(dp, (dp)->d_namlen)
  102 /*
  103  * The _DIRENT_NEXT macro advances to the next dirent record.
  104  */
  105 #define _DIRENT_NEXT(dp) ((void *)((char *)(void *)(dp) + (dp)->d_reclen))
  106 /*
  107  * The _DIRENT_MINSIZE returns the size of an empty (invalid) record.
  108  */
  109 #define _DIRENT_MINSIZE(dp) _DIRENT_RECLEN(dp, 0)
  110 
  111 /*
  112  * Convert between stat structure types and directory types.
  113  */
  114 #define IFTODT(mode)    (((mode) & 0170000) >> 12)
  115 #define DTTOIF(dirtype) ((dirtype) << 12)
  116 #endif
  117 
  118 #endif  /* !_SYS_DIRENT_H_ */

Cache object: 5f0a9be94ff0588733cfdf01534328a1


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.