StdLib/Include/sys/dirent.h

   1 /** @file
   2   Declarations pertaining to directory entries under the UEFI environment.
   3
   4   The information is based upon the EFI_FILE_INFO structure
   5   in MdePkg/Include/Guid/FileInfo.h.
   6
   7   Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>
   8   This program and the accompanying materials
   9   are licensed and made available under the terms and conditions of the BSD License
  10   which accompanies this distribution.  The full text of the license may be found at
  11   http://opensource.org/licenses/bsd-license.php
  12
  13   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16   Copyright (c) 1989, 1993
  17    The Regents of the University of California.  All rights reserved.
  18
  19   Redistribution and use in source and binary forms, with or without
  20   modification, are permitted provided that the following conditions
  21   are met:
  22     1. Redistributions of source code must retain the above copyright
  23        notice, this list of conditions and the following disclaimer.
  24     2. Redistributions in binary form must reproduce the above copyright
  25        notice, this list of conditions and the following disclaimer in the
  26        documentation and/or other materials provided with the distribution.
  27     3. Neither the name of the University nor the names of its contributors
  28        may be used to endorse or promote products derived from this software
  29        without specific prior written permission.
  30
  31   THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  32   ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  33   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  34   ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  35   FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37   OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  39   LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  40   OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  41   SUCH DAMAGE.
  42
  43    @(#)dirent.h  8.3 (Berkeley) 8/10/94
  44    NetBSD: dirent.h,v 1.23 2005/12/26 18:41:36 perry Exp
  45 **/
  46 #ifndef _SYS_DIRENT_H_
  47 #define _SYS_DIRENT_H_
  48
  49 #include  <Uefi.h>
  50
  51 #include  <sys/featuretest.h>
  52 #include  <time.h>
  53 #include  <sys/time.h>
  54
  55 #define MAXNAMLEN 511
  56
  57 /*
  58  * The dirent structure defines the format of directory entries returned by
  59  * read(fd, ...) when fd refers to a directory.
  60  *
  61  * All names are wide characters and are guaranteed to be null terminated.
  62  * The maximum length of a name in a directory is MAXNAMLEN.
  63  *
  64  *  This structure is identical to the EFI_FILE_INFO structure.  A new
  65  *  structure is declared because one must be able to refer to it
  66  *  as struct dirent.
  67  */
  68 struct dirent {
  69   UINT64            Size;               // (d_reclen) Size of this dirent structure instance,
  70                                         // including the Null-terminated FileName string.
  71   UINT64            FileSize;           // The size of the file in bytes.
  72   UINT64            PhysicalSize;       // The amount of physical space the file consumes
  73                                         // on the file system volume.
  74   EFI_TIME          CreateTime;         // The time the file was created.
  75   EFI_TIME          LastAccessTime;     // The time when the file was last accessed.
  76   EFI_TIME          ModificationTime;   // The time when the file's contents were last modified.
  77   UINT64            Attribute;          // (d_type)   The attribute bits for the file. See below.
  78   CHAR16            FileName[1];        // (d_name)   The Null-terminated name of the file.
  79 };
  80
  81 /* For compatibility */
  82 #define   d_name    FileName
  83 #define   d_type    Attribute
  84 #define   d_reclen  Size
  85
  86
  87 /*
  88  * File Attributes
  89  */
  90 #define DT_UNKNOWN    0
  91 #define DT_READ_ONLY  0x0000000000000001
  92 #define DT_HIDDEN     0x0000000000000002
  93 #define DT_SYSTEM     0x0000000000000004
  94 #define DT_RESERVED   0x0000000000000008
  95 #define DT_DIRECTORY  0x0000000000000010
  96 #define DT_ARCHIVE    0x0000000000000020
  97 #define DT_CHR        0x0000000000010000  // File attaches to a character device
  98 #define DT_BLK        0x0000000000020000  // File attaches to a block device
  99 #define DT_SOCKET     0x0000000000030000  // File attaches to a socket
 100 #define DT_VALID_ATTR 0x0000000000030037  // Mask for valid attribute bits
 101
 102 /*
 103  * The _DIRENT_ALIGN macro returns the alignment of struct dirent.
 104  * struct dirent uses 8.
 105  */
 106 #define _DIRENT_ALIGN(dp) (sizeof((dp)->Size) - 1)
 107
 108 /*
 109  * The _DIRENT_NAMEOFF macro returns the offset of the d_name field in
 110  * struct dirent
 111  */
 112 #define _DIRENT_NAMEOFF(dp) \
 113     ((char *)(void *)&(dp)->FileName - (char *)(void *)dp)
 114
 115 /*
 116  * The _DIRENT_RECLEN macro gives the minimum record length which will hold
 117  * a name of size "namlen".  This requires the amount of space in struct dirent
 118  * without the d_name field, plus enough space for the name with a terminating
 119  * null byte (namlen+1), rounded up to a the appropriate byte boundary.
 120  */
 121 #define _DIRENT_RECLEN(dp, namlen) \
 122     ((_DIRENT_NAMEOFF(dp) + (namlen) + 1 + _DIRENT_ALIGN(dp)) & \
 123     ~_DIRENT_ALIGN(dp))
 124
 125 #define _DIRENT_NAMELEN(dp) \
 126           ((dp)->Size - _DIRENT_NAMEOFF(dp) - 1)
 127
 128 /*
 129  * The _DIRENT_SIZE macro returns the minimum record length required for
 130  * name name stored in the current record.
 131  */
 132 #define _DIRENT_SIZE(dp) _DIRENT_RECLEN(dp, _DIRENT_NAMELEN(dp))
 133
 134 /*
 135  * The _DIRENT_NEXT macro advances to the next dirent record.
 136  */
 137 #define _DIRENT_NEXT(dp) ((void *)((char *)(void *)(dp) + (dp)->Size))
 138
 139 /*
 140  * The _DIRENT_MINSIZE returns the size of an empty (invalid) record.
 141  */
 142 #define _DIRENT_MINSIZE(dp) _DIRENT_RECLEN(dp, 0)
 143
 144 #endif  /* !_SYS_DIRENT_H_ */