1bc36eafdSMike Gerdts /******************************************************************************
2bc36eafdSMike Gerdts *
3bc36eafdSMike Gerdts * Module Name: prmacros - Preprocessor #define macro support
4bc36eafdSMike Gerdts *
5bc36eafdSMike Gerdts *****************************************************************************/
6bc36eafdSMike Gerdts
7*35786f68SRobert Mustacchi /******************************************************************************
8*35786f68SRobert Mustacchi *
9*35786f68SRobert Mustacchi * 1. Copyright Notice
10*35786f68SRobert Mustacchi *
11*35786f68SRobert Mustacchi * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12bc36eafdSMike Gerdts * All rights reserved.
13bc36eafdSMike Gerdts *
14*35786f68SRobert Mustacchi * 2. License
15*35786f68SRobert Mustacchi *
16*35786f68SRobert Mustacchi * 2.1. This is your license from Intel Corp. under its intellectual property
17*35786f68SRobert Mustacchi * rights. You may have additional license terms from the party that provided
18*35786f68SRobert Mustacchi * you this software, covering your right to use that party's intellectual
19*35786f68SRobert Mustacchi * property rights.
20*35786f68SRobert Mustacchi *
21*35786f68SRobert Mustacchi * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22*35786f68SRobert Mustacchi * copy of the source code appearing in this file ("Covered Code") an
23*35786f68SRobert Mustacchi * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24*35786f68SRobert Mustacchi * base code distributed originally by Intel ("Original Intel Code") to copy,
25*35786f68SRobert Mustacchi * make derivatives, distribute, use and display any portion of the Covered
26*35786f68SRobert Mustacchi * Code in any form, with the right to sublicense such rights; and
27*35786f68SRobert Mustacchi *
28*35786f68SRobert Mustacchi * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29*35786f68SRobert Mustacchi * license (with the right to sublicense), under only those claims of Intel
30*35786f68SRobert Mustacchi * patents that are infringed by the Original Intel Code, to make, use, sell,
31*35786f68SRobert Mustacchi * offer to sell, and import the Covered Code and derivative works thereof
32*35786f68SRobert Mustacchi * solely to the minimum extent necessary to exercise the above copyright
33*35786f68SRobert Mustacchi * license, and in no event shall the patent license extend to any additions
34*35786f68SRobert Mustacchi * to or modifications of the Original Intel Code. No other license or right
35*35786f68SRobert Mustacchi * is granted directly or by implication, estoppel or otherwise;
36*35786f68SRobert Mustacchi *
37*35786f68SRobert Mustacchi * The above copyright and patent license is granted only if the following
38*35786f68SRobert Mustacchi * conditions are met:
39*35786f68SRobert Mustacchi *
40*35786f68SRobert Mustacchi * 3. Conditions
41*35786f68SRobert Mustacchi *
42*35786f68SRobert Mustacchi * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
44*35786f68SRobert Mustacchi * Code or modification with rights to further distribute source must include
45*35786f68SRobert Mustacchi * the above Copyright Notice, the above License, this list of Conditions,
46*35786f68SRobert Mustacchi * and the following Disclaimer and Export Compliance provision. In addition,
47*35786f68SRobert Mustacchi * Licensee must cause all Covered Code to which Licensee contributes to
48*35786f68SRobert Mustacchi * contain a file documenting the changes Licensee made to create that Covered
49*35786f68SRobert Mustacchi * Code and the date of any change. Licensee must include in that file the
50*35786f68SRobert Mustacchi * documentation of any changes made by any predecessor Licensee. Licensee
51*35786f68SRobert Mustacchi * must include a prominent statement that the modification is derived,
52*35786f68SRobert Mustacchi * directly or indirectly, from Original Intel Code.
53*35786f68SRobert Mustacchi *
54*35786f68SRobert Mustacchi * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
56*35786f68SRobert Mustacchi * Code or modification without rights to further distribute source must
57*35786f68SRobert Mustacchi * include the following Disclaimer and Export Compliance provision in the
58*35786f68SRobert Mustacchi * documentation and/or other materials provided with distribution. In
59*35786f68SRobert Mustacchi * addition, Licensee may not authorize further sublicense of source of any
60*35786f68SRobert Mustacchi * portion of the Covered Code, and must include terms to the effect that the
61*35786f68SRobert Mustacchi * license from Licensee to its licensee is limited to the intellectual
62*35786f68SRobert Mustacchi * property embodied in the software Licensee provides to its licensee, and
63*35786f68SRobert Mustacchi * not to intellectual property embodied in modifications its licensee may
64*35786f68SRobert Mustacchi * make.
65*35786f68SRobert Mustacchi *
66*35786f68SRobert Mustacchi * 3.3. Redistribution of Executable. Redistribution in executable form of any
67*35786f68SRobert Mustacchi * substantial portion of the Covered Code or modification must reproduce the
68*35786f68SRobert Mustacchi * above Copyright Notice, and the following Disclaimer and Export Compliance
69*35786f68SRobert Mustacchi * provision in the documentation and/or other materials provided with the
70*35786f68SRobert Mustacchi * distribution.
71*35786f68SRobert Mustacchi *
72*35786f68SRobert Mustacchi * 3.4. Intel retains all right, title, and interest in and to the Original
73*35786f68SRobert Mustacchi * Intel Code.
74*35786f68SRobert Mustacchi *
75*35786f68SRobert Mustacchi * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76*35786f68SRobert Mustacchi * Intel shall be used in advertising or otherwise to promote the sale, use or
77*35786f68SRobert Mustacchi * other dealings in products derived from or relating to the Covered Code
78*35786f68SRobert Mustacchi * without prior written authorization from Intel.
79*35786f68SRobert Mustacchi *
80*35786f68SRobert Mustacchi * 4. Disclaimer and Export Compliance
81*35786f68SRobert Mustacchi *
82*35786f68SRobert Mustacchi * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83*35786f68SRobert Mustacchi * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84*35786f68SRobert Mustacchi * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85*35786f68SRobert Mustacchi * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86*35786f68SRobert Mustacchi * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87*35786f68SRobert Mustacchi * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88*35786f68SRobert Mustacchi * PARTICULAR PURPOSE.
89*35786f68SRobert Mustacchi *
90*35786f68SRobert Mustacchi * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91*35786f68SRobert Mustacchi * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92*35786f68SRobert Mustacchi * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93*35786f68SRobert Mustacchi * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94*35786f68SRobert Mustacchi * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95*35786f68SRobert Mustacchi * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96*35786f68SRobert Mustacchi * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97*35786f68SRobert Mustacchi * LIMITED REMEDY.
98*35786f68SRobert Mustacchi *
99*35786f68SRobert Mustacchi * 4.3. Licensee shall not export, either directly or indirectly, any of this
100*35786f68SRobert Mustacchi * software or system incorporating such software without first obtaining any
101*35786f68SRobert Mustacchi * required license or other approval from the U. S. Department of Commerce or
102*35786f68SRobert Mustacchi * any other agency or department of the United States Government. In the
103*35786f68SRobert Mustacchi * event Licensee exports any such software from the United States or
104*35786f68SRobert Mustacchi * re-exports any such software from a foreign destination, Licensee shall
105*35786f68SRobert Mustacchi * ensure that the distribution and export/re-export of the software is in
106*35786f68SRobert Mustacchi * compliance with all laws, regulations, orders, or other restrictions of the
107*35786f68SRobert Mustacchi * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108*35786f68SRobert Mustacchi * any of its subsidiaries will export/re-export any technical data, process,
109*35786f68SRobert Mustacchi * software, or service, directly or indirectly, to any country for which the
110*35786f68SRobert Mustacchi * United States government or any agency thereof requires an export license,
111*35786f68SRobert Mustacchi * other governmental approval, or letter of assurance, without first obtaining
112*35786f68SRobert Mustacchi * such license, approval or letter.
113*35786f68SRobert Mustacchi *
114*35786f68SRobert Mustacchi *****************************************************************************
115*35786f68SRobert Mustacchi *
116*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
117*35786f68SRobert Mustacchi * following license:
118*35786f68SRobert Mustacchi *
119bc36eafdSMike Gerdts * Redistribution and use in source and binary forms, with or without
120bc36eafdSMike Gerdts * modification, are permitted provided that the following conditions
121bc36eafdSMike Gerdts * are met:
122bc36eafdSMike Gerdts * 1. Redistributions of source code must retain the above copyright
123bc36eafdSMike Gerdts * notice, this list of conditions, and the following disclaimer,
124bc36eafdSMike Gerdts * without modification.
125bc36eafdSMike Gerdts * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126bc36eafdSMike Gerdts * substantially similar to the "NO WARRANTY" disclaimer below
127bc36eafdSMike Gerdts * ("Disclaimer") and any redistribution must be conditioned upon
128bc36eafdSMike Gerdts * including a substantially similar Disclaimer requirement for further
129bc36eafdSMike Gerdts * binary redistribution.
130bc36eafdSMike Gerdts * 3. Neither the names of the above-listed copyright holders nor the names
131bc36eafdSMike Gerdts * of any contributors may be used to endorse or promote products derived
132bc36eafdSMike Gerdts * from this software without specific prior written permission.
133bc36eafdSMike Gerdts *
134bc36eafdSMike Gerdts * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135bc36eafdSMike Gerdts * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136*35786f68SRobert Mustacchi * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137bc36eafdSMike Gerdts * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138*35786f68SRobert Mustacchi * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139*35786f68SRobert Mustacchi * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140*35786f68SRobert Mustacchi * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141*35786f68SRobert Mustacchi * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142*35786f68SRobert Mustacchi * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143*35786f68SRobert Mustacchi * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144*35786f68SRobert Mustacchi * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145*35786f68SRobert Mustacchi *
146*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
147*35786f68SRobert Mustacchi * GNU General Public License ("GPL") version 2 as published by the Free
148*35786f68SRobert Mustacchi * Software Foundation.
149*35786f68SRobert Mustacchi *
150*35786f68SRobert Mustacchi *****************************************************************************/
151bc36eafdSMike Gerdts
152bc36eafdSMike Gerdts #include "aslcompiler.h"
153bc36eafdSMike Gerdts
154bc36eafdSMike Gerdts #define _COMPONENT ASL_PREPROCESSOR
155bc36eafdSMike Gerdts ACPI_MODULE_NAME ("prmacros")
156bc36eafdSMike Gerdts
157bc36eafdSMike Gerdts
158bc36eafdSMike Gerdts /*******************************************************************************
159bc36eafdSMike Gerdts *
160bc36eafdSMike Gerdts * FUNCTION: PrDumpPredefinedNames
161bc36eafdSMike Gerdts *
162bc36eafdSMike Gerdts * PARAMETERS: None
163bc36eafdSMike Gerdts *
164bc36eafdSMike Gerdts * RETURN: None
165bc36eafdSMike Gerdts *
166bc36eafdSMike Gerdts * DESCRIPTION: Dump the list of #defines. Used as the preprocessor starts, to
167bc36eafdSMike Gerdts * display the names that were defined on the command line.
168bc36eafdSMike Gerdts * Debug information only.
169bc36eafdSMike Gerdts *
170bc36eafdSMike Gerdts ******************************************************************************/
171bc36eafdSMike Gerdts
172bc36eafdSMike Gerdts void
PrDumpPredefinedNames(void)173bc36eafdSMike Gerdts PrDumpPredefinedNames (
174bc36eafdSMike Gerdts void)
175bc36eafdSMike Gerdts {
176bc36eafdSMike Gerdts PR_DEFINE_INFO *DefineInfo;
177bc36eafdSMike Gerdts
178bc36eafdSMike Gerdts
179bc36eafdSMike Gerdts DefineInfo = Gbl_DefineList;
180bc36eafdSMike Gerdts while (DefineInfo)
181bc36eafdSMike Gerdts {
182bc36eafdSMike Gerdts DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
183bc36eafdSMike Gerdts "Predefined #define: %s->%s\n",
184bc36eafdSMike Gerdts 0, DefineInfo->Identifier, DefineInfo->Replacement);
185bc36eafdSMike Gerdts
186bc36eafdSMike Gerdts DefineInfo = DefineInfo->Next;
187bc36eafdSMike Gerdts }
188bc36eafdSMike Gerdts }
189bc36eafdSMike Gerdts
190bc36eafdSMike Gerdts
191bc36eafdSMike Gerdts /*******************************************************************************
192bc36eafdSMike Gerdts *
193bc36eafdSMike Gerdts * FUNCTION: PrAddDefine
194bc36eafdSMike Gerdts *
195bc36eafdSMike Gerdts * PARAMETERS: Identifier - Name to be replaced
196bc36eafdSMike Gerdts * Replacement - Replacement for Identifier
197bc36eafdSMike Gerdts * Persist - Keep define across multiple compiles?
198bc36eafdSMike Gerdts *
199bc36eafdSMike Gerdts * RETURN: A new define_info struct. NULL on error.
200bc36eafdSMike Gerdts *
201bc36eafdSMike Gerdts * DESCRIPTION: Add a new #define to the global list
202bc36eafdSMike Gerdts *
203bc36eafdSMike Gerdts ******************************************************************************/
204bc36eafdSMike Gerdts
205bc36eafdSMike Gerdts PR_DEFINE_INFO *
PrAddDefine(char * Identifier,char * Replacement,BOOLEAN Persist)206bc36eafdSMike Gerdts PrAddDefine (
207bc36eafdSMike Gerdts char *Identifier,
208bc36eafdSMike Gerdts char *Replacement,
209bc36eafdSMike Gerdts BOOLEAN Persist)
210bc36eafdSMike Gerdts {
211bc36eafdSMike Gerdts char *IdentifierString;
212bc36eafdSMike Gerdts char *ReplacementString;
213bc36eafdSMike Gerdts PR_DEFINE_INFO *DefineInfo;
214bc36eafdSMike Gerdts
215bc36eafdSMike Gerdts
216bc36eafdSMike Gerdts if (!Replacement)
217bc36eafdSMike Gerdts {
218bc36eafdSMike Gerdts Replacement = "";
219bc36eafdSMike Gerdts }
220bc36eafdSMike Gerdts
221bc36eafdSMike Gerdts /* Check for already-defined first */
222bc36eafdSMike Gerdts
223bc36eafdSMike Gerdts DefineInfo = PrMatchDefine (Identifier);
224bc36eafdSMike Gerdts if (DefineInfo)
225bc36eafdSMike Gerdts {
226bc36eafdSMike Gerdts DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID,
227bc36eafdSMike Gerdts "#define: name already exists: %s\n",
228bc36eafdSMike Gerdts Gbl_CurrentLineNumber, Identifier);
229bc36eafdSMike Gerdts
230bc36eafdSMike Gerdts /*
231bc36eafdSMike Gerdts * Name already exists. This is only an error if the target name
232bc36eafdSMike Gerdts * is different.
233bc36eafdSMike Gerdts */
234bc36eafdSMike Gerdts if (strcmp (Replacement, DefineInfo->Replacement))
235bc36eafdSMike Gerdts {
236bc36eafdSMike Gerdts PrError (ASL_ERROR, ASL_MSG_EXISTING_NAME,
237bc36eafdSMike Gerdts THIS_TOKEN_OFFSET (Identifier));
238bc36eafdSMike Gerdts
239bc36eafdSMike Gerdts return (NULL);
240bc36eafdSMike Gerdts }
241bc36eafdSMike Gerdts
242bc36eafdSMike Gerdts return (DefineInfo);
243bc36eafdSMike Gerdts }
244bc36eafdSMike Gerdts
245bc36eafdSMike Gerdts /* Copy input strings */
246bc36eafdSMike Gerdts
247bc36eafdSMike Gerdts IdentifierString = UtLocalCalloc (strlen (Identifier) + 1);
248bc36eafdSMike Gerdts strcpy (IdentifierString, Identifier);
249bc36eafdSMike Gerdts
250bc36eafdSMike Gerdts ReplacementString = UtLocalCalloc (strlen (Replacement) + 1);
251bc36eafdSMike Gerdts strcpy (ReplacementString, Replacement);
252bc36eafdSMike Gerdts
253bc36eafdSMike Gerdts /* Init and link new define info struct */
254bc36eafdSMike Gerdts
255bc36eafdSMike Gerdts DefineInfo = UtLocalCalloc (sizeof (PR_DEFINE_INFO));
256bc36eafdSMike Gerdts DefineInfo->Replacement = ReplacementString;
257bc36eafdSMike Gerdts DefineInfo->Identifier = IdentifierString;
258bc36eafdSMike Gerdts DefineInfo->Persist = Persist;
259bc36eafdSMike Gerdts
260bc36eafdSMike Gerdts if (Gbl_DefineList)
261bc36eafdSMike Gerdts {
262bc36eafdSMike Gerdts Gbl_DefineList->Previous = DefineInfo;
263bc36eafdSMike Gerdts }
264bc36eafdSMike Gerdts
265bc36eafdSMike Gerdts DefineInfo->Next = Gbl_DefineList;
266bc36eafdSMike Gerdts Gbl_DefineList = DefineInfo;
267bc36eafdSMike Gerdts return (DefineInfo);
268bc36eafdSMike Gerdts }
269bc36eafdSMike Gerdts
270bc36eafdSMike Gerdts
271bc36eafdSMike Gerdts /*******************************************************************************
272bc36eafdSMike Gerdts *
273bc36eafdSMike Gerdts * FUNCTION: PrRemoveDefine
274bc36eafdSMike Gerdts *
275bc36eafdSMike Gerdts * PARAMETERS: DefineName - Name of define to be removed
276bc36eafdSMike Gerdts *
277bc36eafdSMike Gerdts * RETURN: None
278bc36eafdSMike Gerdts *
279bc36eafdSMike Gerdts * DESCRIPTION: Implements #undef. Remove a #define if found in the global
280bc36eafdSMike Gerdts * list. No error if the target of the #undef does not exist,
281bc36eafdSMike Gerdts * as per the C #undef definition.
282bc36eafdSMike Gerdts *
283bc36eafdSMike Gerdts ******************************************************************************/
284bc36eafdSMike Gerdts
285bc36eafdSMike Gerdts void
PrRemoveDefine(char * DefineName)286bc36eafdSMike Gerdts PrRemoveDefine (
287bc36eafdSMike Gerdts char *DefineName)
288bc36eafdSMike Gerdts {
289bc36eafdSMike Gerdts PR_DEFINE_INFO *DefineInfo;
290bc36eafdSMike Gerdts
291bc36eafdSMike Gerdts
292bc36eafdSMike Gerdts /* Match name and delete the node */
293bc36eafdSMike Gerdts
294bc36eafdSMike Gerdts DefineInfo = Gbl_DefineList;
295bc36eafdSMike Gerdts while (DefineInfo)
296bc36eafdSMike Gerdts {
297bc36eafdSMike Gerdts if (!strcmp (DefineName, DefineInfo->Identifier))
298bc36eafdSMike Gerdts {
299bc36eafdSMike Gerdts /* Remove from linked list */
300bc36eafdSMike Gerdts
301bc36eafdSMike Gerdts if (DefineInfo->Previous)
302bc36eafdSMike Gerdts {
303bc36eafdSMike Gerdts (DefineInfo->Previous)->Next = DefineInfo->Next;
304bc36eafdSMike Gerdts }
305bc36eafdSMike Gerdts else
306bc36eafdSMike Gerdts {
307bc36eafdSMike Gerdts Gbl_DefineList = DefineInfo->Next;
308bc36eafdSMike Gerdts }
309bc36eafdSMike Gerdts
310bc36eafdSMike Gerdts if (DefineInfo->Next)
311bc36eafdSMike Gerdts {
312bc36eafdSMike Gerdts (DefineInfo->Next)->Previous = DefineInfo->Previous;
313bc36eafdSMike Gerdts }
314bc36eafdSMike Gerdts
315bc36eafdSMike Gerdts free (DefineInfo);
316bc36eafdSMike Gerdts return;
317bc36eafdSMike Gerdts }
318bc36eafdSMike Gerdts
319bc36eafdSMike Gerdts DefineInfo = DefineInfo->Next;
320bc36eafdSMike Gerdts }
321bc36eafdSMike Gerdts
322bc36eafdSMike Gerdts /*
323bc36eafdSMike Gerdts * Name was not found. By definition of #undef, this is not
324bc36eafdSMike Gerdts * an error, however.
325bc36eafdSMike Gerdts */
326bc36eafdSMike Gerdts DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
327bc36eafdSMike Gerdts "#undef: could not find %s\n",
328bc36eafdSMike Gerdts Gbl_CurrentLineNumber, DefineName);
329bc36eafdSMike Gerdts }
330bc36eafdSMike Gerdts
331bc36eafdSMike Gerdts
332bc36eafdSMike Gerdts /*******************************************************************************
333bc36eafdSMike Gerdts *
334bc36eafdSMike Gerdts * FUNCTION: PrMatchDefine
335bc36eafdSMike Gerdts *
336bc36eafdSMike Gerdts * PARAMETERS: MatchString - Name associated with the #define
337bc36eafdSMike Gerdts *
338bc36eafdSMike Gerdts * RETURN: Matched string if found. NULL otherwise.
339bc36eafdSMike Gerdts *
340bc36eafdSMike Gerdts * DESCRIPTION: Find a name in global #define list
341bc36eafdSMike Gerdts *
342bc36eafdSMike Gerdts ******************************************************************************/
343bc36eafdSMike Gerdts
344bc36eafdSMike Gerdts PR_DEFINE_INFO *
PrMatchDefine(char * MatchString)345bc36eafdSMike Gerdts PrMatchDefine (
346bc36eafdSMike Gerdts char *MatchString)
347bc36eafdSMike Gerdts {
348bc36eafdSMike Gerdts PR_DEFINE_INFO *DefineInfo;
349bc36eafdSMike Gerdts
350bc36eafdSMike Gerdts
351bc36eafdSMike Gerdts DefineInfo = Gbl_DefineList;
352bc36eafdSMike Gerdts while (DefineInfo)
353bc36eafdSMike Gerdts {
354bc36eafdSMike Gerdts if (!strcmp (MatchString, DefineInfo->Identifier))
355bc36eafdSMike Gerdts {
356bc36eafdSMike Gerdts return (DefineInfo);
357bc36eafdSMike Gerdts }
358bc36eafdSMike Gerdts
359bc36eafdSMike Gerdts DefineInfo = DefineInfo->Next;
360bc36eafdSMike Gerdts }
361bc36eafdSMike Gerdts
362bc36eafdSMike Gerdts return (NULL);
363bc36eafdSMike Gerdts }
364bc36eafdSMike Gerdts
365bc36eafdSMike Gerdts
366bc36eafdSMike Gerdts /*******************************************************************************
367bc36eafdSMike Gerdts *
368bc36eafdSMike Gerdts * FUNCTION: PrAddMacro
369bc36eafdSMike Gerdts *
370bc36eafdSMike Gerdts * PARAMETERS: Name - Start of the macro definition
371bc36eafdSMike Gerdts * Next - "Next" buffer from GetNextToken
372bc36eafdSMike Gerdts *
373bc36eafdSMike Gerdts * RETURN: None
374bc36eafdSMike Gerdts *
375bc36eafdSMike Gerdts * DESCRIPTION: Add a new macro to the list of #defines. Handles argument
376bc36eafdSMike Gerdts * processing.
377bc36eafdSMike Gerdts *
378bc36eafdSMike Gerdts ******************************************************************************/
379bc36eafdSMike Gerdts
380bc36eafdSMike Gerdts void
PrAddMacro(char * Name,char ** Next)381bc36eafdSMike Gerdts PrAddMacro (
382bc36eafdSMike Gerdts char *Name,
383bc36eafdSMike Gerdts char **Next)
384bc36eafdSMike Gerdts {
385bc36eafdSMike Gerdts char *Token = NULL;
386bc36eafdSMike Gerdts ACPI_SIZE TokenOffset;
387bc36eafdSMike Gerdts ACPI_SIZE MacroBodyOffset;
388bc36eafdSMike Gerdts PR_DEFINE_INFO *DefineInfo;
389bc36eafdSMike Gerdts PR_MACRO_ARG *Args;
390bc36eafdSMike Gerdts char *Body;
391bc36eafdSMike Gerdts char *BodyInSource;
392bc36eafdSMike Gerdts UINT32 i;
393bc36eafdSMike Gerdts UINT16 UseCount = 0;
394bc36eafdSMike Gerdts UINT16 ArgCount = 0;
395bc36eafdSMike Gerdts UINT32 Depth = 1;
396bc36eafdSMike Gerdts UINT32 EndOfArgList;
397bc36eafdSMike Gerdts char BufferChar;
398bc36eafdSMike Gerdts
399bc36eafdSMike Gerdts
400bc36eafdSMike Gerdts /* Find the end of the arguments list */
401bc36eafdSMike Gerdts
402bc36eafdSMike Gerdts TokenOffset = Name - Gbl_MainTokenBuffer + strlen (Name) + 1;
403bc36eafdSMike Gerdts while (1)
404bc36eafdSMike Gerdts {
405bc36eafdSMike Gerdts BufferChar = Gbl_CurrentLineBuffer[TokenOffset];
406bc36eafdSMike Gerdts if (BufferChar == '(')
407bc36eafdSMike Gerdts {
408bc36eafdSMike Gerdts Depth++;
409bc36eafdSMike Gerdts }
410bc36eafdSMike Gerdts else if (BufferChar == ')')
411bc36eafdSMike Gerdts {
412bc36eafdSMike Gerdts Depth--;
413bc36eafdSMike Gerdts }
414bc36eafdSMike Gerdts else if (BufferChar == 0)
415bc36eafdSMike Gerdts {
416bc36eafdSMike Gerdts PrError (ASL_ERROR, ASL_MSG_MACRO_SYNTAX, TokenOffset);
417bc36eafdSMike Gerdts return;
418bc36eafdSMike Gerdts }
419bc36eafdSMike Gerdts
420bc36eafdSMike Gerdts if (Depth == 0)
421bc36eafdSMike Gerdts {
422bc36eafdSMike Gerdts /* Found arg list end */
423bc36eafdSMike Gerdts
424bc36eafdSMike Gerdts EndOfArgList = TokenOffset;
425bc36eafdSMike Gerdts break;
426bc36eafdSMike Gerdts }
427bc36eafdSMike Gerdts
428bc36eafdSMike Gerdts TokenOffset++;
429bc36eafdSMike Gerdts }
430bc36eafdSMike Gerdts
431bc36eafdSMike Gerdts /* At this point, we know that we have a reasonable argument list */
432bc36eafdSMike Gerdts
433bc36eafdSMike Gerdts Args = UtLocalCalloc (sizeof (PR_MACRO_ARG) * PR_MAX_MACRO_ARGS);
434bc36eafdSMike Gerdts
435bc36eafdSMike Gerdts /* Get the macro argument names */
436bc36eafdSMike Gerdts
437bc36eafdSMike Gerdts for (i = 0; i < PR_MAX_MACRO_ARGS; i++)
438bc36eafdSMike Gerdts {
439bc36eafdSMike Gerdts Token = PrGetNextToken (NULL, PR_MACRO_SEPARATORS, Next);
440bc36eafdSMike Gerdts if (!Token)
441bc36eafdSMike Gerdts {
442bc36eafdSMike Gerdts /* This is the case for a NULL macro body */
443bc36eafdSMike Gerdts
444bc36eafdSMike Gerdts BodyInSource = "";
445bc36eafdSMike Gerdts goto AddMacroToList;
446bc36eafdSMike Gerdts }
447bc36eafdSMike Gerdts
448bc36eafdSMike Gerdts /* Don't go beyond the argument list */
449bc36eafdSMike Gerdts
450bc36eafdSMike Gerdts TokenOffset = Token - Gbl_MainTokenBuffer + strlen (Token);
451bc36eafdSMike Gerdts if (TokenOffset > EndOfArgList)
452bc36eafdSMike Gerdts {
453bc36eafdSMike Gerdts break;
454bc36eafdSMike Gerdts }
455bc36eafdSMike Gerdts
456bc36eafdSMike Gerdts DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
457bc36eafdSMike Gerdts "Macro arg: %s \n",
458bc36eafdSMike Gerdts Gbl_CurrentLineNumber, Token);
459bc36eafdSMike Gerdts
460bc36eafdSMike Gerdts Args[i].Name = UtLocalCalloc (strlen (Token) + 1);
461bc36eafdSMike Gerdts strcpy (Args[i].Name, Token);
462bc36eafdSMike Gerdts
463bc36eafdSMike Gerdts Args[i].UseCount = 0;
464bc36eafdSMike Gerdts
465bc36eafdSMike Gerdts ArgCount++;
466bc36eafdSMike Gerdts if (ArgCount >= PR_MAX_MACRO_ARGS)
467bc36eafdSMike Gerdts {
468bc36eafdSMike Gerdts PrError (ASL_ERROR, ASL_MSG_TOO_MANY_ARGUMENTS, TokenOffset);
469bc36eafdSMike Gerdts goto ErrorExit;
470bc36eafdSMike Gerdts }
471bc36eafdSMike Gerdts }
472bc36eafdSMike Gerdts
473bc36eafdSMike Gerdts /* Get the macro body. Token now points to start of body */
474bc36eafdSMike Gerdts
475bc36eafdSMike Gerdts MacroBodyOffset = Token - Gbl_MainTokenBuffer;
476bc36eafdSMike Gerdts
477bc36eafdSMike Gerdts /* Match each method arg in the macro body for later use */
478bc36eafdSMike Gerdts
479bc36eafdSMike Gerdts Token = PrGetNextToken (NULL, PR_MACRO_SEPARATORS, Next);
480bc36eafdSMike Gerdts while (Token)
481bc36eafdSMike Gerdts {
482bc36eafdSMike Gerdts /* Search the macro arg list for matching arg */
483bc36eafdSMike Gerdts
484*35786f68SRobert Mustacchi for (i = 0; ((i < PR_MAX_MACRO_ARGS) && Args[i].Name); i++)
485bc36eafdSMike Gerdts {
486bc36eafdSMike Gerdts /*
487bc36eafdSMike Gerdts * Save argument offset within macro body. This is the mechanism
488bc36eafdSMike Gerdts * used to expand the macro upon invocation.
489bc36eafdSMike Gerdts *
490bc36eafdSMike Gerdts * Handles multiple instances of the same argument
491bc36eafdSMike Gerdts */
492bc36eafdSMike Gerdts if (!strcmp (Token, Args[i].Name))
493bc36eafdSMike Gerdts {
494bc36eafdSMike Gerdts UseCount = Args[i].UseCount;
495bc36eafdSMike Gerdts
496bc36eafdSMike Gerdts Args[i].Offset[UseCount] =
497bc36eafdSMike Gerdts (Token - Gbl_MainTokenBuffer) - MacroBodyOffset;
498bc36eafdSMike Gerdts
499bc36eafdSMike Gerdts DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
500bc36eafdSMike Gerdts "Macro Arg #%u: %s UseCount %u Offset %u \n",
501bc36eafdSMike Gerdts Gbl_CurrentLineNumber, i, Token,
502bc36eafdSMike Gerdts UseCount+1, Args[i].Offset[UseCount]);
503bc36eafdSMike Gerdts
504bc36eafdSMike Gerdts Args[i].UseCount++;
505bc36eafdSMike Gerdts if (Args[i].UseCount >= PR_MAX_ARG_INSTANCES)
506bc36eafdSMike Gerdts {
507bc36eafdSMike Gerdts PrError (ASL_ERROR, ASL_MSG_TOO_MANY_ARGUMENTS,
508bc36eafdSMike Gerdts THIS_TOKEN_OFFSET (Token));
509bc36eafdSMike Gerdts
510bc36eafdSMike Gerdts goto ErrorExit;
511bc36eafdSMike Gerdts }
512bc36eafdSMike Gerdts break;
513bc36eafdSMike Gerdts }
514bc36eafdSMike Gerdts }
515bc36eafdSMike Gerdts
516bc36eafdSMike Gerdts Token = PrGetNextToken (NULL, PR_MACRO_SEPARATORS, Next);
517bc36eafdSMike Gerdts }
518bc36eafdSMike Gerdts
519bc36eafdSMike Gerdts BodyInSource = &Gbl_CurrentLineBuffer[MacroBodyOffset];
520bc36eafdSMike Gerdts
521bc36eafdSMike Gerdts
522bc36eafdSMike Gerdts AddMacroToList:
523bc36eafdSMike Gerdts
524bc36eafdSMike Gerdts /* Check if name is already defined first */
525bc36eafdSMike Gerdts
526bc36eafdSMike Gerdts DefineInfo = PrMatchDefine (Name);
527bc36eafdSMike Gerdts if (DefineInfo)
528bc36eafdSMike Gerdts {
529bc36eafdSMike Gerdts DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
530bc36eafdSMike Gerdts "#define: macro name already exists: %s\n",
531bc36eafdSMike Gerdts Gbl_CurrentLineNumber, Name);
532bc36eafdSMike Gerdts
533bc36eafdSMike Gerdts /* Error only if not exactly the same macro */
534bc36eafdSMike Gerdts
535bc36eafdSMike Gerdts if (strcmp (DefineInfo->Body, BodyInSource) ||
536bc36eafdSMike Gerdts (DefineInfo->ArgCount != ArgCount))
537bc36eafdSMike Gerdts {
538bc36eafdSMike Gerdts PrError (ASL_ERROR, ASL_MSG_EXISTING_NAME,
539bc36eafdSMike Gerdts THIS_TOKEN_OFFSET (Name));
540bc36eafdSMike Gerdts }
541bc36eafdSMike Gerdts
542bc36eafdSMike Gerdts goto ErrorExit;
543bc36eafdSMike Gerdts }
544bc36eafdSMike Gerdts
545bc36eafdSMike Gerdts DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
546bc36eafdSMike Gerdts "Macro body: %s \n",
547bc36eafdSMike Gerdts Gbl_CurrentLineNumber, BodyInSource);
548bc36eafdSMike Gerdts
549bc36eafdSMike Gerdts /* Add macro to the #define list */
550bc36eafdSMike Gerdts
551bc36eafdSMike Gerdts DefineInfo = PrAddDefine (Name, BodyInSource, FALSE);
552bc36eafdSMike Gerdts if (DefineInfo)
553bc36eafdSMike Gerdts {
554bc36eafdSMike Gerdts Body = UtLocalCalloc (strlen (BodyInSource) + 1);
555bc36eafdSMike Gerdts strcpy (Body, BodyInSource);
556bc36eafdSMike Gerdts
557bc36eafdSMike Gerdts DefineInfo->Body = Body;
558bc36eafdSMike Gerdts DefineInfo->Args = Args;
559bc36eafdSMike Gerdts DefineInfo->ArgCount = ArgCount;
560bc36eafdSMike Gerdts }
561bc36eafdSMike Gerdts
562bc36eafdSMike Gerdts return;
563bc36eafdSMike Gerdts
564bc36eafdSMike Gerdts
565bc36eafdSMike Gerdts ErrorExit:
566bc36eafdSMike Gerdts ACPI_FREE (Args);
567bc36eafdSMike Gerdts return;
568bc36eafdSMike Gerdts }
569bc36eafdSMike Gerdts
570bc36eafdSMike Gerdts
571bc36eafdSMike Gerdts /*******************************************************************************
572bc36eafdSMike Gerdts *
573bc36eafdSMike Gerdts * FUNCTION: PrDoMacroInvocation
574bc36eafdSMike Gerdts *
575bc36eafdSMike Gerdts * PARAMETERS: TokenBuffer - Current line buffer
576bc36eafdSMike Gerdts * MacroStart - Start of the macro invocation within
577bc36eafdSMike Gerdts * the token buffer
578bc36eafdSMike Gerdts * DefineInfo - Info for this macro
579bc36eafdSMike Gerdts * Next - "Next" buffer from GetNextToken
580bc36eafdSMike Gerdts *
581bc36eafdSMike Gerdts * RETURN: None
582bc36eafdSMike Gerdts *
583bc36eafdSMike Gerdts * DESCRIPTION: Expand a macro invocation
584bc36eafdSMike Gerdts *
585bc36eafdSMike Gerdts ******************************************************************************/
586bc36eafdSMike Gerdts
587bc36eafdSMike Gerdts void
PrDoMacroInvocation(char * TokenBuffer,char * MacroStart,PR_DEFINE_INFO * DefineInfo,char ** Next)588bc36eafdSMike Gerdts PrDoMacroInvocation (
589bc36eafdSMike Gerdts char *TokenBuffer,
590bc36eafdSMike Gerdts char *MacroStart,
591bc36eafdSMike Gerdts PR_DEFINE_INFO *DefineInfo,
592bc36eafdSMike Gerdts char **Next)
593bc36eafdSMike Gerdts {
594bc36eafdSMike Gerdts PR_MACRO_ARG *Args;
595bc36eafdSMike Gerdts char *Token = NULL;
596bc36eafdSMike Gerdts UINT32 TokenOffset;
597bc36eafdSMike Gerdts UINT32 Length;
598bc36eafdSMike Gerdts UINT32 i;
599bc36eafdSMike Gerdts
600bc36eafdSMike Gerdts
601bc36eafdSMike Gerdts /* Take a copy of the macro body for expansion */
602bc36eafdSMike Gerdts
603bc36eafdSMike Gerdts strcpy (Gbl_MacroTokenBuffer, DefineInfo->Body);
604bc36eafdSMike Gerdts
605bc36eafdSMike Gerdts /* Replace each argument within the prototype body */
606bc36eafdSMike Gerdts
607bc36eafdSMike Gerdts Args = DefineInfo->Args;
608bc36eafdSMike Gerdts if (!Args->Name)
609bc36eafdSMike Gerdts {
610bc36eafdSMike Gerdts /* This macro has no arguments */
611bc36eafdSMike Gerdts
612bc36eafdSMike Gerdts Token = PrGetNextToken (NULL, PR_MACRO_ARGUMENTS, Next);
613bc36eafdSMike Gerdts if (!Token)
614bc36eafdSMike Gerdts {
615bc36eafdSMike Gerdts goto BadInvocation;
616bc36eafdSMike Gerdts }
617bc36eafdSMike Gerdts
618bc36eafdSMike Gerdts TokenOffset = (MacroStart - TokenBuffer);
619bc36eafdSMike Gerdts Length = Token - MacroStart + strlen (Token) + 1;
620bc36eafdSMike Gerdts
621bc36eafdSMike Gerdts PrReplaceData (
622bc36eafdSMike Gerdts &Gbl_CurrentLineBuffer[TokenOffset], Length,
623bc36eafdSMike Gerdts Gbl_MacroTokenBuffer, strlen (Gbl_MacroTokenBuffer));
624bc36eafdSMike Gerdts return;
625bc36eafdSMike Gerdts }
626bc36eafdSMike Gerdts
627bc36eafdSMike Gerdts while (Args->Name)
628bc36eafdSMike Gerdts {
629bc36eafdSMike Gerdts /* Get the next argument from macro invocation */
630bc36eafdSMike Gerdts
631bc36eafdSMike Gerdts Token = PrGetNextToken (NULL, PR_MACRO_SEPARATORS, Next);
632bc36eafdSMike Gerdts if (!Token)
633bc36eafdSMike Gerdts {
634bc36eafdSMike Gerdts goto BadInvocation;
635bc36eafdSMike Gerdts }
636bc36eafdSMike Gerdts
637bc36eafdSMike Gerdts /* Replace all instances of this argument */
638bc36eafdSMike Gerdts
639bc36eafdSMike Gerdts for (i = 0; i < Args->UseCount; i++)
640bc36eafdSMike Gerdts {
641bc36eafdSMike Gerdts /* Offset zero indicates "arg not used" */
642bc36eafdSMike Gerdts /* TBD: Not really needed now, with UseCount available */
643bc36eafdSMike Gerdts
644bc36eafdSMike Gerdts if (Args->Offset[i] == 0)
645bc36eafdSMike Gerdts {
646bc36eafdSMike Gerdts break;
647bc36eafdSMike Gerdts }
648bc36eafdSMike Gerdts
649bc36eafdSMike Gerdts PrReplaceData (
650bc36eafdSMike Gerdts &Gbl_MacroTokenBuffer[Args->Offset[i]], strlen (Args->Name),
651bc36eafdSMike Gerdts Token, strlen (Token));
652bc36eafdSMike Gerdts
653bc36eafdSMike Gerdts DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
654bc36eafdSMike Gerdts "ExpandArg: %s \n",
655bc36eafdSMike Gerdts Gbl_CurrentLineNumber, Gbl_MacroTokenBuffer);
656bc36eafdSMike Gerdts }
657bc36eafdSMike Gerdts
658bc36eafdSMike Gerdts Args++;
659bc36eafdSMike Gerdts }
660bc36eafdSMike Gerdts
661bc36eafdSMike Gerdts /* TBD: need to make sure macro was not invoked with too many arguments */
662bc36eafdSMike Gerdts
663bc36eafdSMike Gerdts if (!Token)
664bc36eafdSMike Gerdts {
665bc36eafdSMike Gerdts return;
666bc36eafdSMike Gerdts }
667bc36eafdSMike Gerdts
668bc36eafdSMike Gerdts /* Replace the entire macro invocation with the expanded macro */
669bc36eafdSMike Gerdts
670bc36eafdSMike Gerdts TokenOffset = (MacroStart - TokenBuffer);
671bc36eafdSMike Gerdts Length = Token - MacroStart + strlen (Token) + 1;
672bc36eafdSMike Gerdts
673bc36eafdSMike Gerdts PrReplaceData (
674bc36eafdSMike Gerdts &Gbl_CurrentLineBuffer[TokenOffset], Length,
675bc36eafdSMike Gerdts Gbl_MacroTokenBuffer, strlen (Gbl_MacroTokenBuffer));
676bc36eafdSMike Gerdts
677bc36eafdSMike Gerdts return;
678bc36eafdSMike Gerdts
679bc36eafdSMike Gerdts
680bc36eafdSMike Gerdts BadInvocation:
681bc36eafdSMike Gerdts PrError (ASL_ERROR, ASL_MSG_INVALID_INVOCATION,
682bc36eafdSMike Gerdts THIS_TOKEN_OFFSET (MacroStart));
683bc36eafdSMike Gerdts
684bc36eafdSMike Gerdts DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
685bc36eafdSMike Gerdts "Bad macro invocation: %s \n",
686bc36eafdSMike Gerdts Gbl_CurrentLineNumber, Gbl_MacroTokenBuffer);
687bc36eafdSMike Gerdts return;
688bc36eafdSMike Gerdts }
689