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, 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
  47 #ifndef _SYS_DIRENT_H_
  48 #define _SYS_DIRENT_H_
  49
  50 #include  <sys/featuretest.h>
  51 #include  <time.h>
  52
  53 #define MAXNAMLEN 511
  54
  55 /*
  56  * The dirent structure defines the format of directory entries returned by
  57  * read(fd, ...) when fd refers to a directory.
  58  *
  59  * All names are wide characters and are guaranteed to be null terminated.
  60  * The maximum length of a name in a directory is MAXNAMLEN.
  61  */
  62 struct dirent {
  63   UINT64    Size;               // Size of this dirent structure instance,
  64                                   // including the Null-terminated FileName string.
  65   UINT64    FileSize;           // The size of the file in bytes.
  66   UINT64    PhysicalSize;       // The amount of physical space the file consumes
  67                                   // on the file system volume.
  68   UINT64    Attribute;          // The time the file was created.
  69   timespec  CreateTime;         // The time when the file was last accessed.
  70   timespec  LastAccessTime;     // The time when the file’s contents were last modified.
  71   timespec  ModificationTime;   // The attribute bits for the file. See below.
  72   CHAR16    FileName[];         // The Null-terminated name of the file.
  73 };
  74
  75 /*
  76  * File Attributes
  77  */
  78 #define DT_UNKNOWN    0
  79 #define DT_READ_ONLY  0x0000000000000001
  80 #define DT_HIDDEN     0x0000000000000002
  81 #define DT_SYSTEM     0x0000000000000004
  82 #define DT_RESERVED   0x0000000000000008
  83 #define DT_DIRECTORY  0x0000000000000010
  84 #define DT_ARCHIVE    0x0000000000000020
  85 #define DT_CHR        0x0000000000010000  // File attaches to a character device
  86 #define DT_BLK        0x0000000000020000  // File attaches to a block device
  87 #define DT_SOCKET     0x0000000000030000  // File attaches to a socket
  88 #define DT_VALID_ATTR 0x0000000000030037  // Mask for valid attribute bits
  89
  90 #endif  /* !_SYS_DIRENT_H_ */