1 /*******************************************************************************
3 * Module Name: dsutils - Dispatcher utilities
6 ******************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2004, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
117 #define __DSUTILS_C__
120 #include "acparser.h"
122 #include "acdispat.h"
123 #include "acinterp.h"
124 #include "acnamesp.h"
127 #define _COMPONENT ACPI_DISPATCHER
128 ACPI_MODULE_NAME ("dsutils")
131 #ifndef ACPI_NO_METHOD_EXECUTION
133 /*******************************************************************************
135 * FUNCTION: AcpiDsIsResultUsed
143 * DESCRIPTION: Check if a result object will be used by the parent
145 ******************************************************************************/
149 ACPI_PARSE_OBJECT *Op,
150 ACPI_WALK_STATE *WalkState)
152 const ACPI_OPCODE_INFO *ParentInfo;
155 ACPI_FUNCTION_TRACE_PTR ("DsIsResultUsed", Op);
158 /* Must have both an Op and a Result Object */
162 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Null Op\n"));
167 * If there is no parent, the result can't possibly be used!
168 * (An executing method typically has no parent, since each
169 * method is parsed separately) However, a method that is
170 * invoked from another method has a parent.
172 if (!Op->Common.Parent)
174 return_VALUE (FALSE);
178 * Get info on the parent. The root Op is AML_SCOPE
180 ParentInfo = AcpiPsGetOpcodeInfo (Op->Common.Parent->Common.AmlOpcode);
181 if (ParentInfo->Class == AML_CLASS_UNKNOWN)
183 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Unknown parent opcode. Op=%p\n", Op));
184 return_VALUE (FALSE);
188 * Decide what to do with the result based on the parent. If
189 * the parent opcode will not use the result, delete the object.
190 * Otherwise leave it as is, it will be deleted when it is used
191 * as an operand later.
193 switch (ParentInfo->Class)
195 case AML_CLASS_CONTROL:
197 switch (Op->Common.Parent->Common.AmlOpcode)
201 /* Never delete the return value associated with a return opcode */
209 * If we are executing the predicate AND this is the predicate op,
210 * we will use the return value
212 if ((WalkState->ControlState->Common.State == ACPI_CONTROL_PREDICATE_EXECUTING) &&
213 (WalkState->ControlState->Control.PredicateOp == Op))
220 /* Ignore other control opcodes */
224 /* The general control opcode returns no result */
229 case AML_CLASS_CREATE:
232 * These opcodes allow TermArg(s) as operands and therefore
233 * the operands can be method calls. The result is used.
238 case AML_CLASS_NAMED_OBJECT:
240 if ((Op->Common.Parent->Common.AmlOpcode == AML_REGION_OP) ||
241 (Op->Common.Parent->Common.AmlOpcode == AML_DATA_REGION_OP) ||
242 (Op->Common.Parent->Common.AmlOpcode == AML_PACKAGE_OP) ||
243 (Op->Common.Parent->Common.AmlOpcode == AML_VAR_PACKAGE_OP) ||
244 (Op->Common.Parent->Common.AmlOpcode == AML_BUFFER_OP) ||
245 (Op->Common.Parent->Common.AmlOpcode == AML_INT_EVAL_SUBTREE_OP))
248 * These opcodes allow TermArg(s) as operands and therefore
249 * the operands can be method calls. The result is used.
260 * In all other cases. the parent will actually use the return
261 * object, so keep it.
268 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Result of [%s] used by Parent [%s] Op=%p\n",
269 AcpiPsGetOpcodeName (Op->Common.AmlOpcode),
270 AcpiPsGetOpcodeName (Op->Common.Parent->Common.AmlOpcode), Op));
276 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Result of [%s] not used by Parent [%s] Op=%p\n",
277 AcpiPsGetOpcodeName (Op->Common.AmlOpcode),
278 AcpiPsGetOpcodeName (Op->Common.Parent->Common.AmlOpcode), Op));
280 return_VALUE (FALSE);
284 /*******************************************************************************
286 * FUNCTION: AcpiDsDeleteResultIfNotUsed
294 * DESCRIPTION: Used after interpretation of an opcode. If there is an internal
295 * result descriptor, check if the parent opcode will actually use
296 * this result. If not, delete the result now so that it will
297 * not become orphaned.
299 ******************************************************************************/
302 AcpiDsDeleteResultIfNotUsed (
303 ACPI_PARSE_OBJECT *Op,
304 ACPI_OPERAND_OBJECT *ResultObj,
305 ACPI_WALK_STATE *WalkState)
307 ACPI_OPERAND_OBJECT *ObjDesc;
311 ACPI_FUNCTION_TRACE_PTR ("DsDeleteResultIfNotUsed", ResultObj);
316 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Null Op\n"));
325 if (!AcpiDsIsResultUsed (Op, WalkState))
328 * Must pop the result stack (ObjDesc should be equal to ResultObj)
330 Status = AcpiDsResultPop (&ObjDesc, WalkState);
331 if (ACPI_SUCCESS (Status))
333 AcpiUtRemoveReference (ResultObj);
341 /*******************************************************************************
343 * FUNCTION: AcpiDsResolveOperands
345 * PARAMETERS: WalkState - Current walk state with operands on stack
349 * DESCRIPTION: Resolve all operands to their values. Used to prepare
350 * arguments to a control method invocation (a call from one
351 * method to another.)
353 ******************************************************************************/
356 AcpiDsResolveOperands (
357 ACPI_WALK_STATE *WalkState)
360 ACPI_STATUS Status = AE_OK;
363 ACPI_FUNCTION_TRACE_PTR ("DsResolveOperands", WalkState);
367 * Attempt to resolve each of the valid operands
368 * Method arguments are passed by reference, not by value. This means
369 * that the actual objects are passed, not copies of the objects.
371 for (i = 0; i < WalkState->NumOperands; i++)
373 Status = AcpiExResolveToValue (&WalkState->Operands[i], WalkState);
374 if (ACPI_FAILURE (Status))
380 return_ACPI_STATUS (Status);
384 /*******************************************************************************
386 * FUNCTION: AcpiDsClearOperands
388 * PARAMETERS: WalkState - Current walk state with operands on stack
392 * DESCRIPTION: Clear all operands on the current walk state operand stack.
394 ******************************************************************************/
397 AcpiDsClearOperands (
398 ACPI_WALK_STATE *WalkState)
403 ACPI_FUNCTION_TRACE_PTR ("AcpiDsClearOperands", WalkState);
407 * Remove a reference on each operand on the stack
409 for (i = 0; i < WalkState->NumOperands; i++)
412 * Remove a reference to all operands, including both
413 * "Arguments" and "Targets".
415 AcpiUtRemoveReference (WalkState->Operands[i]);
416 WalkState->Operands[i] = NULL;
419 WalkState->NumOperands = 0;
425 /*******************************************************************************
427 * FUNCTION: AcpiDsCreateOperand
429 * PARAMETERS: WalkState
434 * DESCRIPTION: Translate a parse tree object that is an argument to an AML
435 * opcode to the equivalent interpreter object. This may include
436 * looking up a name or entering a new name into the internal
439 ******************************************************************************/
442 AcpiDsCreateOperand (
443 ACPI_WALK_STATE *WalkState,
444 ACPI_PARSE_OBJECT *Arg,
447 ACPI_STATUS Status = AE_OK;
450 ACPI_OPERAND_OBJECT *ObjDesc;
451 ACPI_PARSE_OBJECT *ParentOp;
453 ACPI_INTERPRETER_MODE InterpreterMode;
454 const ACPI_OPCODE_INFO *OpInfo;
457 ACPI_FUNCTION_TRACE_PTR ("DsCreateOperand", Arg);
460 /* A valid name must be looked up in the namespace */
462 if ((Arg->Common.AmlOpcode == AML_INT_NAMEPATH_OP) &&
463 (Arg->Common.Value.String))
465 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Getting a name: Arg=%p\n", Arg));
467 /* Get the entire name string from the AML stream */
469 Status = AcpiExGetNameString (ACPI_TYPE_ANY, Arg->Common.Value.Buffer,
470 &NameString, &NameLength);
472 if (ACPI_FAILURE (Status))
474 return_ACPI_STATUS (Status);
478 * All prefixes have been handled, and the name is
484 * Special handling for BufferField declarations. This is a deferred
485 * opcode that unfortunately defines the field name as the last
486 * parameter instead of the first. We get here when we are performing
487 * the deferred execution, so the actual name of the field is already
488 * in the namespace. We don't want to attempt to look it up again
489 * because we may be executing in a different scope than where the
490 * actual opcode exists.
492 if ((WalkState->DeferredNode) &&
493 (WalkState->DeferredNode->Type == ACPI_TYPE_BUFFER_FIELD) &&
496 ObjDesc = ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, WalkState->DeferredNode);
499 else /* All other opcodes */
502 * Differentiate between a namespace "create" operation
503 * versus a "lookup" operation (IMODE_LOAD_PASS2 vs.
504 * IMODE_EXECUTE) in order to support the creation of
505 * namespace objects during the execution of control methods.
507 ParentOp = Arg->Common.Parent;
508 OpInfo = AcpiPsGetOpcodeInfo (ParentOp->Common.AmlOpcode);
509 if ((OpInfo->Flags & AML_NSNODE) &&
510 (ParentOp->Common.AmlOpcode != AML_INT_METHODCALL_OP) &&
511 (ParentOp->Common.AmlOpcode != AML_REGION_OP) &&
512 (ParentOp->Common.AmlOpcode != AML_INT_NAMEPATH_OP))
514 /* Enter name into namespace if not found */
516 InterpreterMode = ACPI_IMODE_LOAD_PASS2;
520 /* Return a failure if name not found */
522 InterpreterMode = ACPI_IMODE_EXECUTE;
525 Status = AcpiNsLookup (WalkState->ScopeInfo, NameString,
526 ACPI_TYPE_ANY, InterpreterMode,
527 ACPI_NS_SEARCH_PARENT | ACPI_NS_DONT_OPEN_SCOPE,
529 ACPI_CAST_INDIRECT_PTR (ACPI_NAMESPACE_NODE, &ObjDesc));
531 * The only case where we pass through (ignore) a NOT_FOUND
532 * error is for the CondRefOf opcode.
534 if (Status == AE_NOT_FOUND)
536 if (ParentOp->Common.AmlOpcode == AML_COND_REF_OF_OP)
539 * For the Conditional Reference op, it's OK if
540 * the name is not found; We just need a way to
541 * indicate this to the interpreter, set the
544 ObjDesc = ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, AcpiGbl_RootNode);
550 * We just plain didn't find it -- which is a
551 * very serious error at this point
553 Status = AE_AML_NAME_NOT_FOUND;
557 if (ACPI_FAILURE (Status))
559 ACPI_REPORT_NSERROR (NameString, Status);
563 /* Free the namestring created above */
565 ACPI_MEM_FREE (NameString);
567 /* Check status from the lookup */
569 if (ACPI_FAILURE (Status))
571 return_ACPI_STATUS (Status);
574 /* Put the resulting object onto the current object stack */
576 Status = AcpiDsObjStackPush (ObjDesc, WalkState);
577 if (ACPI_FAILURE (Status))
579 return_ACPI_STATUS (Status);
581 ACPI_DEBUGGER_EXEC (AcpiDbDisplayArgumentObject (ObjDesc, WalkState));
585 /* Check for null name case */
587 if (Arg->Common.AmlOpcode == AML_INT_NAMEPATH_OP)
590 * If the name is null, this means that this is an
591 * optional result parameter that was not specified
592 * in the original ASL. Create a Zero Constant for a
593 * placeholder. (Store to a constant is a Noop.)
595 Opcode = AML_ZERO_OP; /* Has no arguments! */
597 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Null namepath: Arg=%p\n", Arg));
601 Opcode = Arg->Common.AmlOpcode;
604 /* Get the object type of the argument */
606 OpInfo = AcpiPsGetOpcodeInfo (Opcode);
607 if (OpInfo->ObjectType == ACPI_TYPE_INVALID)
609 return_ACPI_STATUS (AE_NOT_IMPLEMENTED);
612 if (OpInfo->Flags & AML_HAS_RETVAL)
614 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
615 "Argument previously created, already stacked \n"));
617 ACPI_DEBUGGER_EXEC (AcpiDbDisplayArgumentObject (
618 WalkState->Operands [WalkState->NumOperands - 1], WalkState));
621 * Use value that was already previously returned
622 * by the evaluation of this argument
624 Status = AcpiDsResultPopFromBottom (&ObjDesc, WalkState);
625 if (ACPI_FAILURE (Status))
628 * Only error is underflow, and this indicates
629 * a missing or null operand!
631 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Missing or null operand, %s\n",
632 AcpiFormatException (Status)));
633 return_ACPI_STATUS (Status);
638 /* Create an ACPI_INTERNAL_OBJECT for the argument */
640 ObjDesc = AcpiUtCreateInternalObject (OpInfo->ObjectType);
643 return_ACPI_STATUS (AE_NO_MEMORY);
646 /* Initialize the new object */
648 Status = AcpiDsInitObjectFromOp (WalkState, Arg,
650 if (ACPI_FAILURE (Status))
652 AcpiUtDeleteObjectDesc (ObjDesc);
653 return_ACPI_STATUS (Status);
657 /* Put the operand object on the object stack */
659 Status = AcpiDsObjStackPush (ObjDesc, WalkState);
660 if (ACPI_FAILURE (Status))
662 return_ACPI_STATUS (Status);
665 ACPI_DEBUGGER_EXEC (AcpiDbDisplayArgumentObject (ObjDesc, WalkState));
668 return_ACPI_STATUS (AE_OK);
672 /*******************************************************************************
674 * FUNCTION: AcpiDsCreateOperands
676 * PARAMETERS: FirstArg - First argument of a parser argument tree
680 * DESCRIPTION: Convert an operator's arguments from a parse tree format to
681 * namespace objects and place those argument object on the object
682 * stack in preparation for evaluation by the interpreter.
684 ******************************************************************************/
687 AcpiDsCreateOperands (
688 ACPI_WALK_STATE *WalkState,
689 ACPI_PARSE_OBJECT *FirstArg)
691 ACPI_STATUS Status = AE_OK;
692 ACPI_PARSE_OBJECT *Arg;
696 ACPI_FUNCTION_TRACE_PTR ("DsCreateOperands", FirstArg);
699 /* For all arguments in the list... */
704 Status = AcpiDsCreateOperand (WalkState, Arg, ArgCount);
705 if (ACPI_FAILURE (Status))
710 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Arg #%d (%p) done, Arg1=%p\n",
711 ArgCount, Arg, FirstArg));
713 /* Move on to next argument, if any */
715 Arg = Arg->Common.Next;
719 return_ACPI_STATUS (Status);
724 * We must undo everything done above; meaning that we must
725 * pop everything off of the operand stack and delete those
728 (void) AcpiDsObjStackPopAndDelete (ArgCount, WalkState);
730 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "While creating Arg %d - %s\n",
731 (ArgCount + 1), AcpiFormatException (Status)));
732 return_ACPI_STATUS (Status);