1 /******************************************************************************
3 * Module Name: psparse - Parser top level AML parse routines
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************/
117 * Parse the AML and build an operation tree as most interpreters,
118 * like Perl, do. Parsing is done by hand rather than with a YACC
119 * generated parser to tightly constrain stack and dynamic memory
120 * usage. At the same time, parsing is kept flexible and the code
121 * fairly compact by parsing based on a list of AML opcode
122 * templates in AmlOpInfo[]
126 #include "accommon.h"
127 #include "acparser.h"
128 #include "acdispat.h"
130 #include "acinterp.h"
132 #define _COMPONENT ACPI_PARSER
133 ACPI_MODULE_NAME ("psparse")
136 /*******************************************************************************
138 * FUNCTION: AcpiPsGetOpcodeSize
140 * PARAMETERS: Opcode - An AML opcode
142 * RETURN: Size of the opcode, in bytes (1 or 2)
144 * DESCRIPTION: Get the size of the current opcode.
146 ******************************************************************************/
149 AcpiPsGetOpcodeSize (
153 /* Extended (2-byte) opcode if > 255 */
160 /* Otherwise, just a single byte opcode */
166 /*******************************************************************************
168 * FUNCTION: AcpiPsPeekOpcode
170 * PARAMETERS: ParserState - A parser state object
172 * RETURN: Next AML opcode
174 * DESCRIPTION: Get next AML opcode (without incrementing AML pointer)
176 ******************************************************************************/
180 ACPI_PARSE_STATE
*ParserState
)
186 Aml
= ParserState
->Aml
;
187 Opcode
= (UINT16
) ACPI_GET8 (Aml
);
189 if (Opcode
== AML_EXTENDED_OP_PREFIX
)
191 /* Extended opcode, get the second opcode byte */
194 Opcode
= (UINT16
) ((Opcode
<< 8) | ACPI_GET8 (Aml
));
201 /*******************************************************************************
203 * FUNCTION: AcpiPsCompleteThisOp
205 * PARAMETERS: WalkState - Current State
206 * Op - Op to complete
210 * DESCRIPTION: Perform any cleanup at the completion of an Op.
212 ******************************************************************************/
215 AcpiPsCompleteThisOp (
216 ACPI_WALK_STATE
*WalkState
,
217 ACPI_PARSE_OBJECT
*Op
)
219 ACPI_PARSE_OBJECT
*Prev
;
220 ACPI_PARSE_OBJECT
*Next
;
221 const ACPI_OPCODE_INFO
*ParentInfo
;
222 ACPI_PARSE_OBJECT
*ReplacementOp
= NULL
;
223 ACPI_STATUS Status
= AE_OK
;
226 ACPI_FUNCTION_TRACE_PTR (PsCompleteThisOp
, Op
);
229 /* Check for null Op, can happen if AML code is corrupt */
233 return_ACPI_STATUS (AE_OK
); /* OK for now */
236 /* Delete this op and the subtree below it if asked to */
238 if (((WalkState
->ParseFlags
& ACPI_PARSE_TREE_MASK
) != ACPI_PARSE_DELETE_TREE
) ||
239 (WalkState
->OpInfo
->Class
== AML_CLASS_ARGUMENT
))
241 return_ACPI_STATUS (AE_OK
);
244 /* Make sure that we only delete this subtree */
246 if (Op
->Common
.Parent
)
248 Prev
= Op
->Common
.Parent
->Common
.Value
.Arg
;
251 /* Nothing more to do */
257 * Check if we need to replace the operator and its subtree
258 * with a return value op (placeholder op)
260 ParentInfo
= AcpiPsGetOpcodeInfo (Op
->Common
.Parent
->Common
.AmlOpcode
);
262 switch (ParentInfo
->Class
)
264 case AML_CLASS_CONTROL
:
268 case AML_CLASS_CREATE
:
270 * These opcodes contain TermArg operands. The current
271 * op must be replaced by a placeholder return op
273 ReplacementOp
= AcpiPsAllocOp (AML_INT_RETURN_VALUE_OP
);
276 Status
= AE_NO_MEMORY
;
280 case AML_CLASS_NAMED_OBJECT
:
282 * These opcodes contain TermArg operands. The current
283 * op must be replaced by a placeholder return op
285 if ((Op
->Common
.Parent
->Common
.AmlOpcode
== AML_REGION_OP
) ||
286 (Op
->Common
.Parent
->Common
.AmlOpcode
== AML_DATA_REGION_OP
) ||
287 (Op
->Common
.Parent
->Common
.AmlOpcode
== AML_BUFFER_OP
) ||
288 (Op
->Common
.Parent
->Common
.AmlOpcode
== AML_PACKAGE_OP
) ||
289 (Op
->Common
.Parent
->Common
.AmlOpcode
== AML_BANK_FIELD_OP
) ||
290 (Op
->Common
.Parent
->Common
.AmlOpcode
== AML_VAR_PACKAGE_OP
))
292 ReplacementOp
= AcpiPsAllocOp (AML_INT_RETURN_VALUE_OP
);
295 Status
= AE_NO_MEMORY
;
298 else if ((Op
->Common
.Parent
->Common
.AmlOpcode
== AML_NAME_OP
) &&
299 (WalkState
->PassNumber
<= ACPI_IMODE_LOAD_PASS2
))
301 if ((Op
->Common
.AmlOpcode
== AML_BUFFER_OP
) ||
302 (Op
->Common
.AmlOpcode
== AML_PACKAGE_OP
) ||
303 (Op
->Common
.AmlOpcode
== AML_VAR_PACKAGE_OP
))
305 ReplacementOp
= AcpiPsAllocOp (Op
->Common
.AmlOpcode
);
308 Status
= AE_NO_MEMORY
;
312 ReplacementOp
->Named
.Data
= Op
->Named
.Data
;
313 ReplacementOp
->Named
.Length
= Op
->Named
.Length
;
321 ReplacementOp
= AcpiPsAllocOp (AML_INT_RETURN_VALUE_OP
);
324 Status
= AE_NO_MEMORY
;
328 /* We must unlink this op from the parent tree */
332 /* This op is the first in the list */
336 ReplacementOp
->Common
.Parent
= Op
->Common
.Parent
;
337 ReplacementOp
->Common
.Value
.Arg
= NULL
;
338 ReplacementOp
->Common
.Node
= Op
->Common
.Node
;
339 Op
->Common
.Parent
->Common
.Value
.Arg
= ReplacementOp
;
340 ReplacementOp
->Common
.Next
= Op
->Common
.Next
;
344 Op
->Common
.Parent
->Common
.Value
.Arg
= Op
->Common
.Next
;
348 /* Search the parent list */
352 /* Traverse all siblings in the parent's argument list */
354 Next
= Prev
->Common
.Next
;
359 ReplacementOp
->Common
.Parent
= Op
->Common
.Parent
;
360 ReplacementOp
->Common
.Value
.Arg
= NULL
;
361 ReplacementOp
->Common
.Node
= Op
->Common
.Node
;
362 Prev
->Common
.Next
= ReplacementOp
;
363 ReplacementOp
->Common
.Next
= Op
->Common
.Next
;
368 Prev
->Common
.Next
= Op
->Common
.Next
;
379 /* Now we can actually delete the subtree rooted at Op */
381 AcpiPsDeleteParseTree (Op
);
382 return_ACPI_STATUS (Status
);
386 /*******************************************************************************
388 * FUNCTION: AcpiPsNextParseState
390 * PARAMETERS: WalkState - Current state
391 * Op - Current parse op
392 * CallbackStatus - Status from previous operation
396 * DESCRIPTION: Update the parser state based upon the return exception from
397 * the parser callback.
399 ******************************************************************************/
402 AcpiPsNextParseState (
403 ACPI_WALK_STATE
*WalkState
,
404 ACPI_PARSE_OBJECT
*Op
,
405 ACPI_STATUS CallbackStatus
)
407 ACPI_PARSE_STATE
*ParserState
= &WalkState
->ParserState
;
408 ACPI_STATUS Status
= AE_CTRL_PENDING
;
411 ACPI_FUNCTION_TRACE_PTR (PsNextParseState
, Op
);
414 switch (CallbackStatus
)
416 case AE_CTRL_TERMINATE
:
418 * A control method was terminated via a RETURN statement.
419 * The walk of this method is complete.
421 ParserState
->Aml
= ParserState
->AmlEnd
;
422 Status
= AE_CTRL_TERMINATE
;
427 ParserState
->Aml
= WalkState
->AmlLastWhile
;
428 WalkState
->ControlState
->Common
.Value
= FALSE
;
429 Status
= AE_CTRL_BREAK
;
432 case AE_CTRL_CONTINUE
:
434 ParserState
->Aml
= WalkState
->AmlLastWhile
;
435 Status
= AE_CTRL_CONTINUE
;
438 case AE_CTRL_PENDING
:
440 ParserState
->Aml
= WalkState
->AmlLastWhile
;
446 ParserState
->Aml
= ParserState
->Scope
->ParseScope
.PkgEnd
;
453 * Predicate of an IF was true, and we are at the matching ELSE.
454 * Just close out this package
456 ParserState
->Aml
= AcpiPsGetNextPackageEnd (ParserState
);
457 Status
= AE_CTRL_PENDING
;
462 * Either an IF/WHILE Predicate was false or we encountered a BREAK
463 * opcode. In both cases, we do not execute the rest of the
464 * package; We simply close out the parent (finishing the walk of
465 * this branch of the tree) and continue execution at the parent
468 ParserState
->Aml
= ParserState
->Scope
->ParseScope
.PkgEnd
;
470 /* In the case of a BREAK, just force a predicate (if any) to FALSE */
472 WalkState
->ControlState
->Common
.Value
= FALSE
;
473 Status
= AE_CTRL_END
;
476 case AE_CTRL_TRANSFER
:
478 /* A method call (invocation) -- transfer control */
480 Status
= AE_CTRL_TRANSFER
;
481 WalkState
->PrevOp
= Op
;
482 WalkState
->MethodCallOp
= Op
;
483 WalkState
->MethodCallNode
= (Op
->Common
.Value
.Arg
)->Common
.Node
;
485 /* Will return value (if any) be used by the caller? */
487 WalkState
->ReturnUsed
= AcpiDsIsResultUsed (Op
, WalkState
);
492 Status
= CallbackStatus
;
493 if ((CallbackStatus
& AE_CODE_MASK
) == AE_CODE_CONTROL
)
500 return_ACPI_STATUS (Status
);
504 /*******************************************************************************
506 * FUNCTION: AcpiPsParseAml
508 * PARAMETERS: WalkState - Current state
513 * DESCRIPTION: Parse raw AML and return a tree of ops
515 ******************************************************************************/
519 ACPI_WALK_STATE
*WalkState
)
522 ACPI_THREAD_STATE
*Thread
;
523 ACPI_THREAD_STATE
*PrevWalkList
= AcpiGbl_CurrentWalkList
;
524 ACPI_WALK_STATE
*PreviousWalkState
;
527 ACPI_FUNCTION_TRACE (PsParseAml
);
529 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE
,
530 "Entered with WalkState=%p Aml=%p size=%X\n",
531 WalkState
, WalkState
->ParserState
.Aml
,
532 WalkState
->ParserState
.AmlSize
));
534 if (!WalkState
->ParserState
.Aml
)
536 return_ACPI_STATUS (AE_NULL_OBJECT
);
539 /* Create and initialize a new thread state */
541 Thread
= AcpiUtCreateThreadState ();
544 if (WalkState
->MethodDesc
)
546 /* Executing a control method - additional cleanup */
548 AcpiDsTerminateControlMethod (WalkState
->MethodDesc
, WalkState
);
551 AcpiDsDeleteWalkState (WalkState
);
552 return_ACPI_STATUS (AE_NO_MEMORY
);
555 WalkState
->Thread
= Thread
;
558 * If executing a method, the starting SyncLevel is this method's
561 if (WalkState
->MethodDesc
)
563 WalkState
->Thread
->CurrentSyncLevel
= WalkState
->MethodDesc
->Method
.SyncLevel
;
566 AcpiDsPushWalkState (WalkState
, Thread
);
569 * This global allows the AML debugger to get a handle to the currently
570 * executing control method.
572 AcpiGbl_CurrentWalkList
= Thread
;
575 * Execute the walk loop as long as there is a valid Walk State. This
576 * handles nested control method invocations without recursion.
578 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE
, "State=%p\n", WalkState
));
583 if (ACPI_SUCCESS (Status
))
586 * The ParseLoop executes AML until the method terminates
587 * or calls another method.
589 Status
= AcpiPsParseLoop (WalkState
);
592 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE
,
593 "Completed one call to walk loop, %s State=%p\n",
594 AcpiFormatException (Status
), WalkState
));
596 if (Status
== AE_CTRL_TRANSFER
)
599 * A method call was detected.
600 * Transfer control to the called control method
602 Status
= AcpiDsCallControlMethod (Thread
, WalkState
, NULL
);
603 if (ACPI_FAILURE (Status
))
605 Status
= AcpiDsMethodError (Status
, WalkState
);
609 * If the transfer to the new method method call worked, a new walk
610 * state was created -- get it
612 WalkState
= AcpiDsGetCurrentWalkState (Thread
);
615 else if (Status
== AE_CTRL_TERMINATE
)
619 else if ((Status
!= AE_OK
) && (WalkState
->MethodDesc
))
621 /* Either the method parse or actual execution failed */
623 ACPI_ERROR_METHOD ("Method parse/execution failed",
624 WalkState
->MethodNode
, NULL
, Status
);
626 /* Check for possible multi-thread reentrancy problem */
628 if ((Status
== AE_ALREADY_EXISTS
) &&
629 (!(WalkState
->MethodDesc
->Method
.InfoFlags
& ACPI_METHOD_SERIALIZED
)))
632 * Method is not serialized and tried to create an object
633 * twice. The probable cause is that the method cannot
634 * handle reentrancy. Mark as "pending serialized" now, and
635 * then mark "serialized" when the last thread exits.
637 WalkState
->MethodDesc
->Method
.InfoFlags
|=
638 ACPI_METHOD_SERIALIZED_PENDING
;
642 /* We are done with this walk, move on to the parent if any */
644 WalkState
= AcpiDsPopWalkState (Thread
);
646 /* Reset the current scope to the beginning of scope stack */
648 AcpiDsScopeStackClear (WalkState
);
651 * If we just returned from the execution of a control method or if we
652 * encountered an error during the method parse phase, there's lots of
655 if (((WalkState
->ParseFlags
& ACPI_PARSE_MODE_MASK
) == ACPI_PARSE_EXECUTE
) ||
656 (ACPI_FAILURE (Status
)))
658 AcpiDsTerminateControlMethod (WalkState
->MethodDesc
, WalkState
);
661 /* Delete this walk state and all linked control states */
663 AcpiPsCleanupScope (&WalkState
->ParserState
);
664 PreviousWalkState
= WalkState
;
666 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE
,
667 "ReturnValue=%p, ImplicitValue=%p State=%p\n",
668 WalkState
->ReturnDesc
, WalkState
->ImplicitReturnObj
, WalkState
));
670 /* Check if we have restarted a preempted walk */
672 WalkState
= AcpiDsGetCurrentWalkState (Thread
);
675 if (ACPI_SUCCESS (Status
))
678 * There is another walk state, restart it.
679 * If the method return value is not used by the parent,
680 * The object is deleted
682 if (!PreviousWalkState
->ReturnDesc
)
685 * In slack mode execution, if there is no return value
686 * we should implicitly return zero (0) as a default value.
688 if (AcpiGbl_EnableInterpreterSlack
&&
689 !PreviousWalkState
->ImplicitReturnObj
)
691 PreviousWalkState
->ImplicitReturnObj
=
692 AcpiUtCreateIntegerObject ((UINT64
) 0);
693 if (!PreviousWalkState
->ImplicitReturnObj
)
695 return_ACPI_STATUS (AE_NO_MEMORY
);
699 /* Restart the calling control method */
701 Status
= AcpiDsRestartControlMethod (WalkState
,
702 PreviousWalkState
->ImplicitReturnObj
);
707 * We have a valid return value, delete any implicit
710 AcpiDsClearImplicitReturn (PreviousWalkState
);
712 Status
= AcpiDsRestartControlMethod (WalkState
,
713 PreviousWalkState
->ReturnDesc
);
715 if (ACPI_SUCCESS (Status
))
717 WalkState
->WalkType
|= ACPI_WALK_METHOD_RESTART
;
722 /* On error, delete any return object or implicit return */
724 AcpiUtRemoveReference (PreviousWalkState
->ReturnDesc
);
725 AcpiDsClearImplicitReturn (PreviousWalkState
);
730 * Just completed a 1st-level method, save the final internal return
733 else if (PreviousWalkState
->CallerReturnDesc
)
735 if (PreviousWalkState
->ImplicitReturnObj
)
737 *(PreviousWalkState
->CallerReturnDesc
) =
738 PreviousWalkState
->ImplicitReturnObj
;
742 /* NULL if no return value */
744 *(PreviousWalkState
->CallerReturnDesc
) =
745 PreviousWalkState
->ReturnDesc
;
750 if (PreviousWalkState
->ReturnDesc
)
752 /* Caller doesn't want it, must delete it */
754 AcpiUtRemoveReference (PreviousWalkState
->ReturnDesc
);
756 if (PreviousWalkState
->ImplicitReturnObj
)
758 /* Caller doesn't want it, must delete it */
760 AcpiUtRemoveReference (PreviousWalkState
->ImplicitReturnObj
);
764 AcpiDsDeleteWalkState (PreviousWalkState
);
769 AcpiExReleaseAllMutexes (Thread
);
770 AcpiUtDeleteGenericState (ACPI_CAST_PTR (ACPI_GENERIC_STATE
, Thread
));
771 AcpiGbl_CurrentWalkList
= PrevWalkList
;
772 return_ACPI_STATUS (Status
);