]>
Commit | Line | Data |
---|---|---|
1 | /*++\r | |
2 | \r | |
3 | Copyright (c) 2004, Intel Corporation. All rights reserved.<BR>\r | |
4 | This program and the accompanying materials \r | |
5 | are licensed and made available under the terms and conditions of the BSD License \r | |
6 | which accompanies this distribution. The full text of the license may be found at \r | |
7 | http://opensource.org/licenses/bsd-license.php \r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
11 | \r | |
12 | Module Name:\r | |
13 | \r | |
14 | EfiStdArg.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | Support for variable length argument lists using the ANSI standard.\r | |
19 | \r | |
20 | Since we are using the ANSI standard we used the standard nameing and\r | |
21 | did not folow the coding convention\r | |
22 | \r | |
23 | VA_LIST - typedef for argument list.\r | |
24 | VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.\r | |
25 | VA_END (VA_LIST Marker) - Clear Marker\r | |
26 | VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argumnet from\r | |
27 | the ... list. You must know the size and pass it in this macro.\r | |
28 | \r | |
29 | example:\r | |
30 | \r | |
31 | UINTN\r | |
32 | ExampleVarArg (\r | |
33 | IN UINTN NumberOfArgs,\r | |
34 | ...\r | |
35 | )\r | |
36 | {\r | |
37 | VA_LIST Marker;\r | |
38 | UINTN Index;\r | |
39 | UINTN Result;\r | |
40 | \r | |
41 | //\r | |
42 | // Initialize the Marker\r | |
43 | //\r | |
44 | VA_START (Marker, NumberOfArgs);\r | |
45 | for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {\r | |
46 | //\r | |
47 | // The ... list is a series of UINTN values, so average them up.\r | |
48 | //\r | |
49 | Result += VA_ARG (Marker, UINTN);\r | |
50 | }\r | |
51 | \r | |
52 | VA_END (Marker);\r | |
53 | return Result\r | |
54 | }\r | |
55 | \r | |
56 | --*/\r | |
57 | \r | |
58 | #ifndef _EFISTDARG_H_\r | |
59 | #define _EFISTDARG_H_\r | |
60 | \r | |
61 | /**\r | |
62 | Return the size of argument that has been aligned to sizeof (UINTN).\r | |
63 | \r | |
64 | @param n The parameter size to be aligned.\r | |
65 | \r | |
66 | @return The aligned size.\r | |
67 | **/\r | |
68 | #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r | |
69 | \r | |
70 | #if defined(__CC_ARM)\r | |
71 | //\r | |
72 | // RVCT ARM variable argument list support.\r | |
73 | //\r | |
74 | \r | |
75 | ///\r | |
76 | /// Variable used to traverse the list of arguments. This type can vary by \r | |
77 | /// implementation and could be an array or structure. \r | |
78 | ///\r | |
79 | #ifdef __APCS_ADSABI\r | |
80 | typedef int *va_list[1];\r | |
81 | #define VA_LIST va_list\r | |
82 | #else\r | |
83 | typedef struct __va_list { void *__ap; } va_list;\r | |
84 | #define VA_LIST va_list\r | |
85 | #endif\r | |
86 | \r | |
87 | #define VA_START(Marker, Parameter) __va_start(Marker, Parameter)\r | |
88 | \r | |
89 | #define VA_ARG(Marker, TYPE) __va_arg(Marker, TYPE)\r | |
90 | \r | |
91 | #define VA_END(Marker) ((void)0)\r | |
92 | \r | |
93 | #define VA_COPY(Dest, Start) __va_copy (Dest, Start)\r | |
94 | \r | |
95 | #elif defined(__GNUC__) && !defined(NO_BUILTIN_VA_FUNCS)\r | |
96 | //\r | |
97 | // Use GCC built-in macros for variable argument lists.\r | |
98 | //\r | |
99 | \r | |
100 | ///\r | |
101 | /// Variable used to traverse the list of arguments. This type can vary by \r | |
102 | /// implementation and could be an array or structure. \r | |
103 | ///\r | |
104 | typedef __builtin_va_list VA_LIST;\r | |
105 | \r | |
106 | #define VA_START(Marker, Parameter) __builtin_va_start (Marker, Parameter)\r | |
107 | \r | |
108 | #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))\r | |
109 | \r | |
110 | #define VA_END(Marker) __builtin_va_end (Marker)\r | |
111 | \r | |
112 | #define VA_COPY(Dest, Start) __builtin_va_copy (Dest, Start)\r | |
113 | \r | |
114 | #else\r | |
115 | \r | |
116 | #ifndef VA_START\r | |
117 | \r | |
118 | ///\r | |
119 | /// Variable used to traverse the list of arguments. This type can vary by \r | |
120 | /// implementation and could be an array or structure. \r | |
121 | ///\r | |
122 | typedef CHAR8 *VA_LIST;\r | |
123 | \r | |
124 | /**\r | |
125 | Retrieves a pointer to the beginning of a variable argument list, based on \r | |
126 | the name of the parameter that immediately precedes the variable argument list. \r | |
127 | \r | |
128 | This function initializes Marker to point to the beginning of the variable \r | |
129 | argument list that immediately follows Parameter. The method for computing the \r | |
130 | pointer to the next argument in the argument list is CPU-specific following the \r | |
131 | EFIAPI ABI.\r | |
132 | \r | |
133 | @param Marker The VA_LIST used to traverse the list of arguments.\r | |
134 | @param Parameter The name of the parameter that immediately precedes \r | |
135 | the variable argument list.\r | |
136 | \r | |
137 | @return A pointer to the beginning of a variable argument list.\r | |
138 | \r | |
139 | **/\r | |
140 | #define VA_START(Marker, Parameter) (Marker = (VA_LIST) ((UINTN) & (Parameter) + _INT_SIZE_OF (Parameter)))\r | |
141 | \r | |
142 | /**\r | |
143 | Returns an argument of a specified type from a variable argument list and updates \r | |
144 | the pointer to the variable argument list to point to the next argument. \r | |
145 | \r | |
146 | This function returns an argument of the type specified by TYPE from the beginning \r | |
147 | of the variable argument list specified by Marker. Marker is then updated to point \r | |
148 | to the next argument in the variable argument list. The method for computing the \r | |
149 | pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.\r | |
150 | \r | |
151 | @param Marker VA_LIST used to traverse the list of arguments.\r | |
152 | @param TYPE The type of argument to retrieve from the beginning \r | |
153 | of the variable argument list.\r | |
154 | \r | |
155 | @return An argument of the type specified by TYPE.\r | |
156 | \r | |
157 | **/\r | |
158 | #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))\r | |
159 | \r | |
160 | /**\r | |
161 | Terminates the use of a variable argument list.\r | |
162 | \r | |
163 | This function initializes Marker so it can no longer be used with VA_ARG(). \r | |
164 | After this macro is used, the only way to access the variable argument list is \r | |
165 | by using VA_START() again.\r | |
166 | \r | |
167 | @param Marker VA_LIST used to traverse the list of arguments.\r | |
168 | \r | |
169 | **/\r | |
170 | #define VA_END(Marker) (Marker = (VA_LIST) 0)\r | |
171 | \r | |
172 | #define VA_COPY(dest, src) ((void)((dest) = (src)))\r | |
173 | \r | |
174 | #endif\r | |
175 | \r | |
176 | #endif\r | |
177 | \r | |
178 | #endif\r |