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