BPicture: Fix archive constructor.
[haiku.git] / src / add-ons / kernel / bus_managers / acpi / acpica / components / parser / psparse.c
blobb9038f1a2f81d0973548cf8899e9f15d5132223b
1 /******************************************************************************
3 * Module Name: psparse - Parser top level AML parse routines
5 *****************************************************************************/
7 /******************************************************************************
9 * 1. Copyright Notice
11 * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp.
12 * All rights reserved.
14 * 2. License
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
19 * property rights.
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
38 * conditions are met:
40 * 3. Conditions
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
64 * make.
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
70 * distribution.
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
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
88 * PARTICULAR PURPOSE.
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
97 * LIMITED REMEDY.
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 *****************************************************************************/
118 * Parse the AML and build an operation tree as most interpreters,
119 * like Perl, do. Parsing is done by hand rather than with a YACC
120 * generated parser to tightly constrain stack and dynamic memory
121 * usage. At the same time, parsing is kept flexible and the code
122 * fairly compact by parsing based on a list of AML opcode
123 * templates in AmlOpInfo[]
126 #include "acpi.h"
127 #include "accommon.h"
128 #include "acparser.h"
129 #include "acdispat.h"
130 #include "amlcode.h"
131 #include "acinterp.h"
133 #define _COMPONENT ACPI_PARSER
134 ACPI_MODULE_NAME ("psparse")
137 /*******************************************************************************
139 * FUNCTION: AcpiPsGetOpcodeSize
141 * PARAMETERS: Opcode - An AML opcode
143 * RETURN: Size of the opcode, in bytes (1 or 2)
145 * DESCRIPTION: Get the size of the current opcode.
147 ******************************************************************************/
149 UINT32
150 AcpiPsGetOpcodeSize (
151 UINT32 Opcode)
154 /* Extended (2-byte) opcode if > 255 */
156 if (Opcode > 0x00FF)
158 return (2);
161 /* Otherwise, just a single byte opcode */
163 return (1);
167 /*******************************************************************************
169 * FUNCTION: AcpiPsPeekOpcode
171 * PARAMETERS: ParserState - A parser state object
173 * RETURN: Next AML opcode
175 * DESCRIPTION: Get next AML opcode (without incrementing AML pointer)
177 ******************************************************************************/
179 UINT16
180 AcpiPsPeekOpcode (
181 ACPI_PARSE_STATE *ParserState)
183 UINT8 *Aml;
184 UINT16 Opcode;
187 Aml = ParserState->Aml;
188 Opcode = (UINT16) ACPI_GET8 (Aml);
190 if (Opcode == AML_EXTENDED_OP_PREFIX)
192 /* Extended opcode, get the second opcode byte */
194 Aml++;
195 Opcode = (UINT16) ((Opcode << 8) | ACPI_GET8 (Aml));
198 return (Opcode);
202 /*******************************************************************************
204 * FUNCTION: AcpiPsCompleteThisOp
206 * PARAMETERS: WalkState - Current State
207 * Op - Op to complete
209 * RETURN: Status
211 * DESCRIPTION: Perform any cleanup at the completion of an Op.
213 ******************************************************************************/
215 ACPI_STATUS
216 AcpiPsCompleteThisOp (
217 ACPI_WALK_STATE *WalkState,
218 ACPI_PARSE_OBJECT *Op)
220 ACPI_PARSE_OBJECT *Prev;
221 ACPI_PARSE_OBJECT *Next;
222 const ACPI_OPCODE_INFO *ParentInfo;
223 ACPI_PARSE_OBJECT *ReplacementOp = NULL;
224 ACPI_STATUS Status = AE_OK;
227 ACPI_FUNCTION_TRACE_PTR (PsCompleteThisOp, Op);
230 /* Check for null Op, can happen if AML code is corrupt */
232 if (!Op)
234 return_ACPI_STATUS (AE_OK); /* OK for now */
237 /* Delete this op and the subtree below it if asked to */
239 if (((WalkState->ParseFlags & ACPI_PARSE_TREE_MASK) != ACPI_PARSE_DELETE_TREE) ||
240 (WalkState->OpInfo->Class == AML_CLASS_ARGUMENT))
242 return_ACPI_STATUS (AE_OK);
245 /* Make sure that we only delete this subtree */
247 if (Op->Common.Parent)
249 Prev = Op->Common.Parent->Common.Value.Arg;
250 if (!Prev)
252 /* Nothing more to do */
254 goto Cleanup;
258 * Check if we need to replace the operator and its subtree
259 * with a return value op (placeholder op)
261 ParentInfo = AcpiPsGetOpcodeInfo (Op->Common.Parent->Common.AmlOpcode);
263 switch (ParentInfo->Class)
265 case AML_CLASS_CONTROL:
267 break;
269 case AML_CLASS_CREATE:
271 * These opcodes contain TermArg operands. The current
272 * op must be replaced by a placeholder return op
274 ReplacementOp = AcpiPsAllocOp (AML_INT_RETURN_VALUE_OP);
275 if (!ReplacementOp)
277 Status = AE_NO_MEMORY;
279 break;
281 case AML_CLASS_NAMED_OBJECT:
283 * These opcodes contain TermArg operands. The current
284 * op must be replaced by a placeholder return op
286 if ((Op->Common.Parent->Common.AmlOpcode == AML_REGION_OP) ||
287 (Op->Common.Parent->Common.AmlOpcode == AML_DATA_REGION_OP) ||
288 (Op->Common.Parent->Common.AmlOpcode == AML_BUFFER_OP) ||
289 (Op->Common.Parent->Common.AmlOpcode == AML_PACKAGE_OP) ||
290 (Op->Common.Parent->Common.AmlOpcode == AML_BANK_FIELD_OP) ||
291 (Op->Common.Parent->Common.AmlOpcode == AML_VAR_PACKAGE_OP))
293 ReplacementOp = AcpiPsAllocOp (AML_INT_RETURN_VALUE_OP);
294 if (!ReplacementOp)
296 Status = AE_NO_MEMORY;
299 else if ((Op->Common.Parent->Common.AmlOpcode == AML_NAME_OP) &&
300 (WalkState->PassNumber <= ACPI_IMODE_LOAD_PASS2))
302 if ((Op->Common.AmlOpcode == AML_BUFFER_OP) ||
303 (Op->Common.AmlOpcode == AML_PACKAGE_OP) ||
304 (Op->Common.AmlOpcode == AML_VAR_PACKAGE_OP))
306 ReplacementOp = AcpiPsAllocOp (Op->Common.AmlOpcode);
307 if (!ReplacementOp)
309 Status = AE_NO_MEMORY;
311 else
313 ReplacementOp->Named.Data = Op->Named.Data;
314 ReplacementOp->Named.Length = Op->Named.Length;
318 break;
320 default:
322 ReplacementOp = AcpiPsAllocOp (AML_INT_RETURN_VALUE_OP);
323 if (!ReplacementOp)
325 Status = AE_NO_MEMORY;
329 /* We must unlink this op from the parent tree */
331 if (Prev == Op)
333 /* This op is the first in the list */
335 if (ReplacementOp)
337 ReplacementOp->Common.Parent = Op->Common.Parent;
338 ReplacementOp->Common.Value.Arg = NULL;
339 ReplacementOp->Common.Node = Op->Common.Node;
340 Op->Common.Parent->Common.Value.Arg = ReplacementOp;
341 ReplacementOp->Common.Next = Op->Common.Next;
343 else
345 Op->Common.Parent->Common.Value.Arg = Op->Common.Next;
349 /* Search the parent list */
351 else while (Prev)
353 /* Traverse all siblings in the parent's argument list */
355 Next = Prev->Common.Next;
356 if (Next == Op)
358 if (ReplacementOp)
360 ReplacementOp->Common.Parent = Op->Common.Parent;
361 ReplacementOp->Common.Value.Arg = NULL;
362 ReplacementOp->Common.Node = Op->Common.Node;
363 Prev->Common.Next = ReplacementOp;
364 ReplacementOp->Common.Next = Op->Common.Next;
365 Next = NULL;
367 else
369 Prev->Common.Next = Op->Common.Next;
370 Next = NULL;
373 Prev = Next;
378 Cleanup:
380 /* Now we can actually delete the subtree rooted at Op */
382 AcpiPsDeleteParseTree (Op);
383 return_ACPI_STATUS (Status);
387 /*******************************************************************************
389 * FUNCTION: AcpiPsNextParseState
391 * PARAMETERS: WalkState - Current state
392 * Op - Current parse op
393 * CallbackStatus - Status from previous operation
395 * RETURN: Status
397 * DESCRIPTION: Update the parser state based upon the return exception from
398 * the parser callback.
400 ******************************************************************************/
402 ACPI_STATUS
403 AcpiPsNextParseState (
404 ACPI_WALK_STATE *WalkState,
405 ACPI_PARSE_OBJECT *Op,
406 ACPI_STATUS CallbackStatus)
408 ACPI_PARSE_STATE *ParserState = &WalkState->ParserState;
409 ACPI_STATUS Status = AE_CTRL_PENDING;
412 ACPI_FUNCTION_TRACE_PTR (PsNextParseState, Op);
415 switch (CallbackStatus)
417 case AE_CTRL_TERMINATE:
419 * A control method was terminated via a RETURN statement.
420 * The walk of this method is complete.
422 ParserState->Aml = ParserState->AmlEnd;
423 Status = AE_CTRL_TERMINATE;
424 break;
426 case AE_CTRL_BREAK:
428 ParserState->Aml = WalkState->AmlLastWhile;
429 WalkState->ControlState->Common.Value = FALSE;
430 Status = AE_CTRL_BREAK;
431 break;
433 case AE_CTRL_CONTINUE:
435 ParserState->Aml = WalkState->AmlLastWhile;
436 Status = AE_CTRL_CONTINUE;
437 break;
439 case AE_CTRL_PENDING:
441 ParserState->Aml = WalkState->AmlLastWhile;
442 break;
444 #if 0
445 case AE_CTRL_SKIP:
447 ParserState->Aml = ParserState->Scope->ParseScope.PkgEnd;
448 Status = AE_OK;
449 break;
450 #endif
452 case AE_CTRL_TRUE:
454 * Predicate of an IF was true, and we are at the matching ELSE.
455 * Just close out this package
457 ParserState->Aml = AcpiPsGetNextPackageEnd (ParserState);
458 Status = AE_CTRL_PENDING;
459 break;
461 case AE_CTRL_FALSE:
463 * Either an IF/WHILE Predicate was false or we encountered a BREAK
464 * opcode. In both cases, we do not execute the rest of the
465 * package; We simply close out the parent (finishing the walk of
466 * this branch of the tree) and continue execution at the parent
467 * level.
469 ParserState->Aml = ParserState->Scope->ParseScope.PkgEnd;
471 /* In the case of a BREAK, just force a predicate (if any) to FALSE */
473 WalkState->ControlState->Common.Value = FALSE;
474 Status = AE_CTRL_END;
475 break;
477 case AE_CTRL_TRANSFER:
479 /* A method call (invocation) -- transfer control */
481 Status = AE_CTRL_TRANSFER;
482 WalkState->PrevOp = Op;
483 WalkState->MethodCallOp = Op;
484 WalkState->MethodCallNode = (Op->Common.Value.Arg)->Common.Node;
486 /* Will return value (if any) be used by the caller? */
488 WalkState->ReturnUsed = AcpiDsIsResultUsed (Op, WalkState);
489 break;
491 default:
493 Status = CallbackStatus;
494 if ((CallbackStatus & AE_CODE_MASK) == AE_CODE_CONTROL)
496 Status = AE_OK;
498 break;
501 return_ACPI_STATUS (Status);
505 /*******************************************************************************
507 * FUNCTION: AcpiPsParseAml
509 * PARAMETERS: WalkState - Current state
512 * RETURN: Status
514 * DESCRIPTION: Parse raw AML and return a tree of ops
516 ******************************************************************************/
518 ACPI_STATUS
519 AcpiPsParseAml (
520 ACPI_WALK_STATE *WalkState)
522 ACPI_STATUS Status;
523 ACPI_THREAD_STATE *Thread;
524 ACPI_THREAD_STATE *PrevWalkList = AcpiGbl_CurrentWalkList;
525 ACPI_WALK_STATE *PreviousWalkState;
528 ACPI_FUNCTION_TRACE (PsParseAml);
530 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
531 "Entered with WalkState=%p Aml=%p size=%X\n",
532 WalkState, WalkState->ParserState.Aml,
533 WalkState->ParserState.AmlSize));
535 if (!WalkState->ParserState.Aml)
537 return_ACPI_STATUS (AE_NULL_OBJECT);
540 /* Create and initialize a new thread state */
542 Thread = AcpiUtCreateThreadState ();
543 if (!Thread)
545 if (WalkState->MethodDesc)
547 /* Executing a control method - additional cleanup */
549 AcpiDsTerminateControlMethod (WalkState->MethodDesc, WalkState);
552 AcpiDsDeleteWalkState (WalkState);
553 return_ACPI_STATUS (AE_NO_MEMORY);
556 WalkState->Thread = Thread;
559 * If executing a method, the starting SyncLevel is this method's
560 * SyncLevel
562 if (WalkState->MethodDesc)
564 WalkState->Thread->CurrentSyncLevel = WalkState->MethodDesc->Method.SyncLevel;
567 AcpiDsPushWalkState (WalkState, Thread);
570 * This global allows the AML debugger to get a handle to the currently
571 * executing control method.
573 AcpiGbl_CurrentWalkList = Thread;
576 * Execute the walk loop as long as there is a valid Walk State. This
577 * handles nested control method invocations without recursion.
579 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "State=%p\n", WalkState));
581 Status = AE_OK;
582 while (WalkState)
584 if (ACPI_SUCCESS (Status))
587 * The ParseLoop executes AML until the method terminates
588 * or calls another method.
590 Status = AcpiPsParseLoop (WalkState);
593 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
594 "Completed one call to walk loop, %s State=%p\n",
595 AcpiFormatException (Status), WalkState));
597 if (Status == AE_CTRL_TRANSFER)
600 * A method call was detected.
601 * Transfer control to the called control method
603 Status = AcpiDsCallControlMethod (Thread, WalkState, NULL);
604 if (ACPI_FAILURE (Status))
606 Status = AcpiDsMethodError (Status, WalkState);
610 * If the transfer to the new method method call worked, a new walk
611 * state was created -- get it
613 WalkState = AcpiDsGetCurrentWalkState (Thread);
614 continue;
616 else if (Status == AE_CTRL_TERMINATE)
618 Status = AE_OK;
620 else if ((Status != AE_OK) && (WalkState->MethodDesc))
622 /* Either the method parse or actual execution failed */
624 ACPI_ERROR_METHOD ("Method parse/execution failed",
625 WalkState->MethodNode, NULL, Status);
627 /* Check for possible multi-thread reentrancy problem */
629 if ((Status == AE_ALREADY_EXISTS) &&
630 (!(WalkState->MethodDesc->Method.InfoFlags & ACPI_METHOD_SERIALIZED)))
633 * Method is not serialized and tried to create an object
634 * twice. The probable cause is that the method cannot
635 * handle reentrancy. Mark as "pending serialized" now, and
636 * then mark "serialized" when the last thread exits.
638 WalkState->MethodDesc->Method.InfoFlags |=
639 ACPI_METHOD_SERIALIZED_PENDING;
643 /* We are done with this walk, move on to the parent if any */
645 WalkState = AcpiDsPopWalkState (Thread);
647 /* Reset the current scope to the beginning of scope stack */
649 AcpiDsScopeStackClear (WalkState);
652 * If we just returned from the execution of a control method or if we
653 * encountered an error during the method parse phase, there's lots of
654 * cleanup to do
656 if (((WalkState->ParseFlags & ACPI_PARSE_MODE_MASK) == ACPI_PARSE_EXECUTE) ||
657 (ACPI_FAILURE (Status)))
659 AcpiDsTerminateControlMethod (WalkState->MethodDesc, WalkState);
662 /* Delete this walk state and all linked control states */
664 AcpiPsCleanupScope (&WalkState->ParserState);
665 PreviousWalkState = WalkState;
667 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
668 "ReturnValue=%p, ImplicitValue=%p State=%p\n",
669 WalkState->ReturnDesc, WalkState->ImplicitReturnObj, WalkState));
671 /* Check if we have restarted a preempted walk */
673 WalkState = AcpiDsGetCurrentWalkState (Thread);
674 if (WalkState)
676 if (ACPI_SUCCESS (Status))
679 * There is another walk state, restart it.
680 * If the method return value is not used by the parent,
681 * The object is deleted
683 if (!PreviousWalkState->ReturnDesc)
686 * In slack mode execution, if there is no return value
687 * we should implicitly return zero (0) as a default value.
689 if (AcpiGbl_EnableInterpreterSlack &&
690 !PreviousWalkState->ImplicitReturnObj)
692 PreviousWalkState->ImplicitReturnObj =
693 AcpiUtCreateIntegerObject ((UINT64) 0);
694 if (!PreviousWalkState->ImplicitReturnObj)
696 return_ACPI_STATUS (AE_NO_MEMORY);
700 /* Restart the calling control method */
702 Status = AcpiDsRestartControlMethod (WalkState,
703 PreviousWalkState->ImplicitReturnObj);
705 else
708 * We have a valid return value, delete any implicit
709 * return value.
711 AcpiDsClearImplicitReturn (PreviousWalkState);
713 Status = AcpiDsRestartControlMethod (WalkState,
714 PreviousWalkState->ReturnDesc);
716 if (ACPI_SUCCESS (Status))
718 WalkState->WalkType |= ACPI_WALK_METHOD_RESTART;
721 else
723 /* On error, delete any return object or implicit return */
725 AcpiUtRemoveReference (PreviousWalkState->ReturnDesc);
726 AcpiDsClearImplicitReturn (PreviousWalkState);
731 * Just completed a 1st-level method, save the final internal return
732 * value (if any)
734 else if (PreviousWalkState->CallerReturnDesc)
736 if (PreviousWalkState->ImplicitReturnObj)
738 *(PreviousWalkState->CallerReturnDesc) =
739 PreviousWalkState->ImplicitReturnObj;
741 else
743 /* NULL if no return value */
745 *(PreviousWalkState->CallerReturnDesc) =
746 PreviousWalkState->ReturnDesc;
749 else
751 if (PreviousWalkState->ReturnDesc)
753 /* Caller doesn't want it, must delete it */
755 AcpiUtRemoveReference (PreviousWalkState->ReturnDesc);
757 if (PreviousWalkState->ImplicitReturnObj)
759 /* Caller doesn't want it, must delete it */
761 AcpiUtRemoveReference (PreviousWalkState->ImplicitReturnObj);
765 AcpiDsDeleteWalkState (PreviousWalkState);
768 /* Normal exit */
770 AcpiExReleaseAllMutexes (Thread);
771 AcpiUtDeleteGenericState (ACPI_CAST_PTR (ACPI_GENERIC_STATE, Thread));
772 AcpiGbl_CurrentWalkList = PrevWalkList;
773 return_ACPI_STATUS (Status);