ReactOS  0.4.14-dev-1314-gacf135d
nsparse.c
Go to the documentation of this file.
1 /******************************************************************************
2  *
3  * Module Name: nsparse - namespace interface to AML parser
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2020, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  * notice, this list of conditions, and the following disclaimer,
16  * without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  * substantially similar to the "NO WARRANTY" disclaimer below
19  * ("Disclaimer") and any redistribution must be conditioned upon
20  * including a substantially similar Disclaimer requirement for further
21  * binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  * of any contributors may be used to endorse or promote products derived
24  * from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR 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,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43 
44 #include "acpi.h"
45 #include "accommon.h"
46 #include "acnamesp.h"
47 #include "acparser.h"
48 #include "acdispat.h"
49 #include "actables.h"
50 #include "acinterp.h"
51 
52 
53 #define _COMPONENT ACPI_NAMESPACE
54  ACPI_MODULE_NAME ("nsparse")
55 
56 
57 /*******************************************************************************
58  *
59  * FUNCTION: NsExecuteTable
60  *
61  * PARAMETERS: TableDesc - An ACPI table descriptor for table to parse
62  * StartNode - Where to enter the table into the namespace
63  *
64  * RETURN: Status
65  *
66  * DESCRIPTION: Load ACPI/AML table by executing the entire table as a single
67  * large control method.
68  *
69  * NOTE: The point of this is to execute any module-level code in-place
70  * as the table is parsed. Some AML code depends on this behavior.
71  *
72  * It is a run-time option at this time, but will eventually become
73  * the default.
74  *
75  * Note: This causes the table to only have a single-pass parse.
76  * However, this is compatible with other ACPI implementations.
77  *
78  ******************************************************************************/
79 
82  UINT32 TableIndex,
83  ACPI_NAMESPACE_NODE *StartNode)
84 {
89  UINT32 AmlLength;
90  UINT8 *AmlStart;
91  ACPI_OPERAND_OBJECT *MethodObj = NULL;
92 
93 
94  ACPI_FUNCTION_TRACE (NsExecuteTable);
95 
96 
97  Status = AcpiGetTableByIndex (TableIndex, &Table);
98  if (ACPI_FAILURE (Status))
99  {
101  }
102 
103  /* Table must consist of at least a complete header */
104 
105  if (Table->Length < sizeof (ACPI_TABLE_HEADER))
106  {
108  }
109 
110  AmlStart = (UINT8 *) Table + sizeof (ACPI_TABLE_HEADER);
111  AmlLength = Table->Length - sizeof (ACPI_TABLE_HEADER);
112 
113  Status = AcpiTbGetOwnerId (TableIndex, &OwnerId);
114  if (ACPI_FAILURE (Status))
115  {
117  }
118 
119  /* Create, initialize, and link a new temporary method object */
120 
122  if (!MethodObj)
123  {
125  }
126 
127  /* Allocate the evaluation information block */
128 
130  if (!Info)
131  {
133  goto Cleanup;
134  }
135 
137  "%s: Create table pseudo-method for [%4.4s] @%p, method %p\n",
138  ACPI_GET_FUNCTION_NAME, Table->Signature, Table, MethodObj));
139 
140  MethodObj->Method.AmlStart = AmlStart;
141  MethodObj->Method.AmlLength = AmlLength;
142  MethodObj->Method.OwnerId = OwnerId;
144 
145  Info->PassNumber = ACPI_IMODE_EXECUTE;
146  Info->Node = StartNode;
147  Info->ObjDesc = MethodObj;
148  Info->NodeFlags = Info->Node->Flags;
149  Info->FullPathname = AcpiNsGetNormalizedPathname (Info->Node, TRUE);
150  if (!Info->FullPathname)
151  {
153  goto Cleanup;
154  }
155 
156  /* Optional object evaluation log */
157 
159  "%-26s: (Definition Block level)\n", "Module-level evaluation"));
160 
162 
163  /* Optional object evaluation log */
164 
166  "%-26s: (Definition Block level)\n", "Module-level complete"));
167 
168 Cleanup:
169  if (Info)
170  {
171  ACPI_FREE (Info->FullPathname);
172  Info->FullPathname = NULL;
173  }
174  ACPI_FREE (Info);
175  AcpiUtRemoveReference (MethodObj);
177 }
178 
179 
180 /*******************************************************************************
181  *
182  * FUNCTION: NsOneCompleteParse
183  *
184  * PARAMETERS: PassNumber - 1 or 2
185  * TableDesc - The table to be parsed.
186  *
187  * RETURN: Status
188  *
189  * DESCRIPTION: Perform one complete parse of an ACPI/AML table.
190  *
191  ******************************************************************************/
192 
195  UINT32 PassNumber,
196  UINT32 TableIndex,
197  ACPI_NAMESPACE_NODE *StartNode)
198 {
199  ACPI_PARSE_OBJECT *ParseRoot;
201  UINT32 AmlLength;
202  UINT8 *AmlStart;
203  ACPI_WALK_STATE *WalkState;
206 
207 
208  ACPI_FUNCTION_TRACE (NsOneCompleteParse);
209 
210 
211  Status = AcpiGetTableByIndex (TableIndex, &Table);
212  if (ACPI_FAILURE (Status))
213  {
215  }
216 
217  /* Table must consist of at least a complete header */
218 
219  if (Table->Length < sizeof (ACPI_TABLE_HEADER))
220  {
222  }
223 
224  AmlStart = (UINT8 *) Table + sizeof (ACPI_TABLE_HEADER);
225  AmlLength = Table->Length - sizeof (ACPI_TABLE_HEADER);
226 
227  Status = AcpiTbGetOwnerId (TableIndex, &OwnerId);
228  if (ACPI_FAILURE (Status))
229  {
231  }
232 
233  /* Create and init a Root Node */
234 
235  ParseRoot = AcpiPsCreateScopeOp (AmlStart);
236  if (!ParseRoot)
237  {
239  }
240 
241  /* Create and initialize a new walk state */
242 
243  WalkState = AcpiDsCreateWalkState (OwnerId, NULL, NULL, NULL);
244  if (!WalkState)
245  {
246  AcpiPsFreeOp (ParseRoot);
248  }
249 
250  Status = AcpiDsInitAmlWalk (WalkState, ParseRoot, NULL,
251  AmlStart, AmlLength, NULL, (UINT8) PassNumber);
252  if (ACPI_FAILURE (Status))
253  {
254  AcpiDsDeleteWalkState (WalkState);
255  goto Cleanup;
256  }
257 
258  /* Found OSDT table, enable the namespace override feature */
259 
260  if (ACPI_COMPARE_NAMESEG (Table->Signature, ACPI_SIG_OSDT) &&
261  PassNumber == ACPI_IMODE_LOAD_PASS1)
262  {
263  WalkState->NamespaceOverride = TRUE;
264  }
265 
266  /* StartNode is the default location to load the table */
267 
268  if (StartNode && StartNode != AcpiGbl_RootNode)
269  {
271  StartNode, ACPI_TYPE_METHOD, WalkState);
272  if (ACPI_FAILURE (Status))
273  {
274  AcpiDsDeleteWalkState (WalkState);
275  goto Cleanup;
276  }
277  }
278 
279  /* Parse the AML */
280 
282  "*PARSE* pass %u parse\n", PassNumber));
284  Status = AcpiPsParseAml (WalkState);
286 
287 Cleanup:
288  AcpiPsDeleteParseTree (ParseRoot);
290 }
291 
292 
293 /*******************************************************************************
294  *
295  * FUNCTION: AcpiNsParseTable
296  *
297  * PARAMETERS: TableDesc - An ACPI table descriptor for table to parse
298  * StartNode - Where to enter the table into the namespace
299  *
300  * RETURN: Status
301  *
302  * DESCRIPTION: Parse AML within an ACPI table and return a tree of ops
303  *
304  ******************************************************************************/
305 
308  UINT32 TableIndex,
309  ACPI_NAMESPACE_NODE *StartNode)
310 {
312 
313 
314  ACPI_FUNCTION_TRACE (NsParseTable);
315 
316 
317  /*
318  * Executes the AML table as one large control method.
319  * The point of this is to execute any module-level code in-place
320  * as the table is parsed. Some AML code depends on this behavior.
321  *
322  * Note: This causes the table to only have a single-pass parse.
323  * However, this is compatible with other ACPI implementations.
324  */
326  "%s: **** Start table execution pass\n", ACPI_GET_FUNCTION_NAME));
327 
328  Status = AcpiNsExecuteTable (TableIndex, StartNode);
329 
331 }
#define ACPI_DEBUG_PRINT_RAW(pl)
Definition: acoutput.h:476
#define ACPI_FREE(a)
Definition: actypes.h:386
UINT8 * AmlStart
Definition: acobject.h:220
void AcpiPsDeleteParseTree(ACPI_PARSE_OBJECT *root)
Definition: pswalk.c:67
ASMGENDATA Table[]
Definition: genincdata.c:61
#define ACPI_ALLOCATE_ZEROED(a)
Definition: actypes.h:385
#define TRUE
Definition: types.h:120
ACPI_STATUS AcpiDsInitAmlWalk(ACPI_WALK_STATE *WalkState, ACPI_PARSE_OBJECT *Op, ACPI_NAMESPACE_NODE *MethodNode, UINT8 *AmlStart, UINT32 AmlLength, ACPI_EVALUATE_INFO *Info, UINT8 PassNumber)
Definition: dswstate.c:662
void AcpiDsDeleteWalkState(ACPI_WALK_STATE *WalkState)
Definition: dswstate.c:780
ACPI_WALK_STATE * AcpiDsCreateWalkState(ACPI_OWNER_ID OwnerId, ACPI_PARSE_OBJECT *Origin, ACPI_OPERAND_OBJECT *MethodDesc, ACPI_THREAD_STATE *Thread)
Definition: dswstate.c:600
#define AE_NO_MEMORY
Definition: acexcep.h:112
ActualNumberDriverObjects * sizeof(PDRIVER_OBJECT)) PDRIVER_OBJECT *DriverObjectList
ACPI_OBJECT_COMMON_HEADER UINT8 InfoFlags
Definition: acobject.h:215
ACPI_STATUS AcpiDsScopeStackPush(ACPI_NAMESPACE_NODE *Node, ACPI_OBJECT_TYPE Type, ACPI_WALK_STATE *WalkState)
Definition: dswscope.c:107
ACPI_STATUS AcpiTbGetOwnerId(UINT32 TableIndex, ACPI_OWNER_ID *OwnerId)
Definition: tbdata.c:958
#define ACPI_DB_PARSE
Definition: acoutput.h:162
UINT32 ACPI_STATUS
Definition: actypes.h:460
struct TraceInfo Info
ACPI_STATUS AcpiPsExecuteTable(ACPI_EVALUATE_INFO *Info)
Definition: psxface.c:297
ACPI_STATUS AcpiNsExecuteTable(UINT32 TableIndex, ACPI_NAMESPACE_NODE *StartNode)
Definition: nsparse.c:81
struct acpi_table_header ACPI_TABLE_HEADER
#define ACPI_FAILURE(a)
Definition: acexcep.h:95
ACPI_STATUS AcpiGetTableByIndex(UINT32 TableIndex, ACPI_TABLE_HEADER **OutTable)
Definition: tbxface.c:491
unsigned int UINT32
#define ACPI_MODULE_NAME(Name)
Definition: acoutput.h:216
smooth NULL
Definition: ftsmooth.c:416
#define ACPI_TYPE_METHOD
Definition: actypes.h:687
ACPI_PARSE_OBJECT * AcpiPsCreateScopeOp(UINT8 *Aml)
Definition: psutils.c:67
UINT16 ACPI_OWNER_ID
Definition: actypes.h:486
#define ACPI_DEBUG_PRINT(pl)
Definition: acoutput.h:475
#define ACPI_SIG_OSDT
Definition: actbl.h:70
#define ACPI_COMPARE_NAMESEG(a, b)
Definition: actypes.h:561
#define ACPI_METHOD_MODULE_LEVEL
Definition: acobject.h:235
static const WCHAR Cleanup[]
Definition: register.c:80
#define ACPI_GET_FUNCTION_NAME
Definition: acgcc.h:67
Status
Definition: gdiplustypes.h:24
BOOLEAN NamespaceOverride
Definition: acstruct.h:88
ACPI_OBJECT_METHOD Method
Definition: acobject.h:523
#define AE_BAD_HEADER
Definition: acexcep.h:168
char * AcpiNsGetNormalizedPathname(ACPI_NAMESPACE_NODE *Node, BOOLEAN NoTrailing)
Definition: nsnames.c:367
void AcpiExExitInterpreter(void)
Definition: exutils.c:139
void AcpiExEnterInterpreter(void)
Definition: exutils.c:91
#define return_ACPI_STATUS(s)
Definition: acoutput.h:496
#define ACPI_FUNCTION_TRACE(a)
Definition: acoutput.h:480
void AcpiUtRemoveReference(ACPI_OPERAND_OBJECT *Object)
Definition: utdelete.c:785
ACPI_STATUS AcpiPsParseAml(ACPI_WALK_STATE *WalkState)
Definition: psparse.c:453
void AcpiPsFreeOp(ACPI_PARSE_OBJECT *Op)
Definition: psutils.c:212
#define ACPI_DB_EVALUATION
Definition: acoutput.h:181
ACPI_OWNER_ID OwnerId
Definition: acobject.h:228
#define AcpiUtCreateInternalObject(t)
Definition: acutils.h:655
_Must_inspect_result_ _In_opt_ PVOID OwnerId
Definition: fsrtlfuncs.h:907
unsigned char UINT8
ACPI_STATUS AcpiNsParseTable(UINT32 TableIndex, ACPI_NAMESPACE_NODE *StartNode)
Definition: nsparse.c:307
ACPI_STATUS AcpiNsOneCompleteParse(UINT32 PassNumber, UINT32 TableIndex, ACPI_NAMESPACE_NODE *StartNode)
Definition: nsparse.c:194