1 /******************************************************************************
3 * Module Name: aslmethod.c - Control method analysis walk
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
45 #include "aslcompiler.h"
46 #include "aslcompiler.y.h"
51 #define _COMPONENT ACPI_COMPILER
52 ACPI_MODULE_NAME ("aslmethod")
55 /* Local prototypes */
58 MtCheckNamedObjectInMethod (
59 ACPI_PARSE_OBJECT *Op,
60 ASL_METHOD_INFO *MethodInfo);
63 /*******************************************************************************
65 * FUNCTION: MtMethodAnalysisWalkBegin
67 * PARAMETERS: ASL_WALK_CALLBACK
71 * DESCRIPTION: Descending callback for the analysis walk. Check methods for:
72 * 1) Initialized local variables
76 ******************************************************************************/
79 MtMethodAnalysisWalkBegin (
80 ACPI_PARSE_OBJECT *Op,
84 ASL_ANALYSIS_WALK_INFO *WalkInfo = (ASL_ANALYSIS_WALK_INFO *) Context;
85 ASL_METHOD_INFO *MethodInfo = WalkInfo->MethodStack;
86 ACPI_PARSE_OBJECT *Next;
87 UINT32 RegisterNumber;
89 char LocalName[] = "Local0";
90 char ArgName[] = "Arg0";
91 ACPI_PARSE_OBJECT *ArgNode;
92 ACPI_PARSE_OBJECT *NextType;
93 ACPI_PARSE_OBJECT *NextParamType;
97 switch (Op->Asl.ParseOpcode)
103 /* Create and init method info */
105 MethodInfo = UtLocalCalloc (sizeof (ASL_METHOD_INFO));
106 MethodInfo->Next = WalkInfo->MethodStack;
109 WalkInfo->MethodStack = MethodInfo;
111 /* Special handling for _DSD, must have a _HID also */
113 if (!ACPI_STRCMP (METHOD_NAME__DSD, Op->Asl.NameSeg))
115 if (!ApFindNameInScope (METHOD_NAME__HID, Op))
117 AslError (ASL_WARNING, ASL_MSG_MISSING_DEPENDENCY, Op,
118 "_DSD requires _HID in same scope");
122 /* Get the name node */
124 Next = Op->Asl.Child;
126 /* Get the NumArguments node */
128 Next = Next->Asl.Next;
129 MethodInfo->NumArguments = (UINT8)
130 (((UINT8) Next->Asl.Value.Integer) & 0x07);
132 /* Get the SerializeRule and SyncLevel nodes, ignored here */
134 Next = Next->Asl.Next;
135 MethodInfo->ShouldBeSerialized = (UINT8) Next->Asl.Value.Integer;
137 Next = Next->Asl.Next;
140 /* Get the ReturnType node */
142 Next = Next->Asl.Next;
144 NextType = Next->Asl.Child;
147 /* Get and map each of the ReturnTypes */
149 MethodInfo->ValidReturnTypes |= AnMapObjTypeToBtype (NextType);
150 NextType->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
151 NextType = NextType->Asl.Next;
154 /* Get the ParameterType node */
156 Next = Next->Asl.Next;
158 NextType = Next->Asl.Child;
161 if (NextType->Asl.ParseOpcode == PARSEOP_DEFAULT_ARG)
163 NextParamType = NextType->Asl.Child;
164 while (NextParamType)
166 MethodInfo->ValidArgTypes[ActualArgs] |= AnMapObjTypeToBtype (NextParamType);
167 NextParamType->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
168 NextParamType = NextParamType->Asl.Next;
173 MethodInfo->ValidArgTypes[ActualArgs] =
174 AnMapObjTypeToBtype (NextType);
175 NextType->Asl.ParseOpcode = PARSEOP_DEFAULT_ARG;
179 NextType = NextType->Asl.Next;
182 if ((MethodInfo->NumArguments) &&
183 (MethodInfo->NumArguments != ActualArgs))
185 /* error: Param list did not match number of args */
188 /* Allow numarguments == 0 for Function() */
190 if ((!MethodInfo->NumArguments) && (ActualArgs))
192 MethodInfo->NumArguments = ActualArgs;
193 ArgNode->Asl.Value.Integer |= ActualArgs;
197 * Actual arguments are initialized at method entry.
198 * All other ArgX "registers" can be used as locals, so we
199 * track their initialization.
201 for (i = 0; i < MethodInfo->NumArguments; i++)
203 MethodInfo->ArgInitialized[i] = TRUE;
207 case PARSEOP_METHODCALL:
210 (Op->Asl.Node == MethodInfo->Op->Asl.Node))
212 AslError (ASL_REMARK, ASL_MSG_RECURSION, Op, Op->Asl.ExternalName);
228 * Local was used outside a control method, or there was an error
229 * in the method declaration.
231 AslError (ASL_REMARK, ASL_MSG_LOCAL_OUTSIDE_METHOD, Op, Op->Asl.ExternalName);
235 RegisterNumber = (Op->Asl.AmlOpcode & 0x000F);
238 * If the local is being used as a target, mark the local
241 if (Op->Asl.CompileFlags & NODE_IS_TARGET)
243 MethodInfo->LocalInitialized[RegisterNumber] = TRUE;
247 * Otherwise, this is a reference, check if the local
248 * has been previously initialized.
250 * The only operator that accepts an uninitialized value is ObjectType()
252 else if ((!MethodInfo->LocalInitialized[RegisterNumber]) &&
253 (Op->Asl.Parent->Asl.ParseOpcode != PARSEOP_OBJECTTYPE))
255 LocalName[strlen (LocalName) -1] = (char) (RegisterNumber + 0x30);
256 AslError (ASL_ERROR, ASL_MSG_LOCAL_INIT, Op, LocalName);
271 * Arg was used outside a control method, or there was an error
272 * in the method declaration.
274 AslError (ASL_REMARK, ASL_MSG_LOCAL_OUTSIDE_METHOD, Op, Op->Asl.ExternalName);
278 RegisterNumber = (Op->Asl.AmlOpcode & 0x000F) - 8;
279 ArgName[strlen (ArgName) -1] = (char) (RegisterNumber + 0x30);
282 * If the Arg is being used as a target, mark the local
285 if (Op->Asl.CompileFlags & NODE_IS_TARGET)
287 MethodInfo->ArgInitialized[RegisterNumber] = TRUE;
291 * Otherwise, this is a reference, check if the Arg
292 * has been previously initialized.
294 * The only operator that accepts an uninitialized value is ObjectType()
296 else if ((!MethodInfo->ArgInitialized[RegisterNumber]) &&
297 (Op->Asl.Parent->Asl.ParseOpcode != PARSEOP_OBJECTTYPE))
299 AslError (ASL_ERROR, ASL_MSG_ARG_INIT, Op, ArgName);
302 /* Flag this arg if it is not a "real" argument to the method */
304 if (RegisterNumber >= MethodInfo->NumArguments)
306 AslError (ASL_REMARK, ASL_MSG_NOT_PARAMETER, Op, ArgName);
315 * Probably was an error in the method declaration,
316 * no additional error here
318 ACPI_WARNING ((AE_INFO, "%p, No parent method", Op));
323 * A child indicates a possible return value. A simple Return or
324 * Return() is marked with NODE_IS_NULL_RETURN by the parser so
325 * that it is not counted as a "real" return-with-value, although
326 * the AML code that is actually emitted is Return(0). The AML
327 * definition of Return has a required parameter, so we are
328 * forced to convert a null return to Return(0).
330 if ((Op->Asl.Child) &&
331 (Op->Asl.Child->Asl.ParseOpcode != PARSEOP_DEFAULT_ARG) &&
332 (!(Op->Asl.Child->Asl.CompileFlags & NODE_IS_NULL_RETURN)))
334 MethodInfo->NumReturnWithValue++;
338 MethodInfo->NumReturnNoValue++;
343 case PARSEOP_CONTINUE:
345 Next = Op->Asl.Parent;
348 if (Next->Asl.ParseOpcode == PARSEOP_WHILE)
352 Next = Next->Asl.Parent;
357 AslError (ASL_ERROR, ASL_MSG_NO_WHILE, Op, NULL);
363 /* We can range check if the argument is an integer */
365 if ((Op->Asl.Child->Asl.ParseOpcode == PARSEOP_INTEGER) &&
366 (Op->Asl.Child->Asl.Value.Integer > ACPI_UINT8_MAX))
368 AslError (ASL_ERROR, ASL_MSG_INVALID_TIME, Op, NULL);
375 case PARSEOP_OPERATIONREGION:
376 case PARSEOP_POWERRESOURCE:
377 case PARSEOP_PROCESSOR:
378 case PARSEOP_THERMALZONE:
381 * The first operand is a name to be created in the namespace.
382 * Check against the reserved list.
384 i = ApCheckForPredefinedName (Op, Op->Asl.NameSeg);
385 if (i < ACPI_VALID_RESERVED_NAME_MAX)
387 AslError (ASL_ERROR, ASL_MSG_RESERVED_USE, Op, Op->Asl.ExternalName);
393 /* Typecheck any predefined names statically defined with Name() */
395 ApCheckForPredefinedObject (Op, Op->Asl.NameSeg);
397 /* Special typechecking for _HID */
399 if (!ACPI_STRCMP (METHOD_NAME__HID, Op->Asl.NameSeg))
401 Next = Op->Asl.Child->Asl.Next;
402 AnCheckId (Next, ASL_TYPE_HID);
405 /* Special typechecking for _CID */
407 else if (!ACPI_STRCMP (METHOD_NAME__CID, Op->Asl.NameSeg))
409 Next = Op->Asl.Child->Asl.Next;
411 if ((Next->Asl.ParseOpcode == PARSEOP_PACKAGE) ||
412 (Next->Asl.ParseOpcode == PARSEOP_VAR_PACKAGE))
414 Next = Next->Asl.Child;
417 AnCheckId (Next, ASL_TYPE_CID);
418 Next = Next->Asl.Next;
423 AnCheckId (Next, ASL_TYPE_CID);
427 else if (!ACPI_STRCMP (METHOD_NAME__DSD, Op->Asl.NameSeg))
429 if (!ApFindNameInScope (METHOD_NAME__HID, Op))
431 AslError (ASL_WARNING, ASL_MSG_MISSING_DEPENDENCY, Op,
432 "_DSD requires _HID in same scope");
443 /* Check for named object creation within a non-serialized method */
445 MtCheckNamedObjectInMethod (Op, MethodInfo);
450 /*******************************************************************************
452 * FUNCTION: MtCheckNamedObjectInMethod
454 * PARAMETERS: Op - Current parser op
455 * MethodInfo - Info for method being parsed
459 * DESCRIPTION: Detect if a non-serialized method is creating a named object,
460 * which could possibly cause problems if two threads execute
461 * the method concurrently. Emit a remark in this case.
463 ******************************************************************************/
466 MtCheckNamedObjectInMethod (
467 ACPI_PARSE_OBJECT *Op,
468 ASL_METHOD_INFO *MethodInfo)
470 const ACPI_OPCODE_INFO *OpInfo;
473 /* We don't care about actual method declarations */
475 if (Op->Asl.AmlOpcode == AML_METHOD_OP)
480 /* Determine if we are creating a named object */
482 OpInfo = AcpiPsGetOpcodeInfo (Op->Asl.AmlOpcode);
483 if (OpInfo->Class == AML_CLASS_NAMED_OBJECT)
486 * If we have a named object created within a non-serialized method,
487 * emit a remark that the method should be serialized.
489 * Reason: If a thread blocks within the method for any reason, and
490 * another thread enters the method, the method will fail because an
491 * attempt will be made to create the same object twice.
493 if (MethodInfo && !MethodInfo->ShouldBeSerialized)
495 AslError (ASL_REMARK, ASL_MSG_SERIALIZED_REQUIRED, MethodInfo->Op,
496 "due to creation of named objects within");
498 /* Emit message only ONCE per method */
500 MethodInfo->ShouldBeSerialized = TRUE;
506 /*******************************************************************************
508 * FUNCTION: MtMethodAnalysisWalkEnd
510 * PARAMETERS: ASL_WALK_CALLBACK
514 * DESCRIPTION: Ascending callback for analysis walk. Complete method
517 ******************************************************************************/
520 MtMethodAnalysisWalkEnd (
521 ACPI_PARSE_OBJECT *Op,
525 ASL_ANALYSIS_WALK_INFO *WalkInfo = (ASL_ANALYSIS_WALK_INFO *) Context;
526 ASL_METHOD_INFO *MethodInfo = WalkInfo->MethodStack;
529 switch (Op->Asl.ParseOpcode)
536 printf ("No method info for method! [%s]\n", Op->Asl.Namepath);
537 AslError (ASL_ERROR, ASL_MSG_COMPILER_INTERNAL, Op,
538 "No method info for this method");
541 return (AE_AML_INTERNAL);
550 switch (Op->Asl.ParseOpcode)
554 WalkInfo->MethodStack = MethodInfo->Next;
557 * Check if there is no return statement at the end of the
558 * method AND we can actually get there -- i.e., the execution
559 * of the method can possibly terminate without a return statement.
561 if ((!AnLastStatementIsReturn (Op)) &&
562 (!(Op->Asl.CompileFlags & NODE_HAS_NO_EXIT)))
565 * No return statement, and execution can possibly exit
566 * via this path. This is equivalent to Return ()
568 MethodInfo->NumReturnNoValue++;
572 * Check for case where some return statements have a return value
573 * and some do not. Exit without a return statement is a return with
576 if (MethodInfo->NumReturnNoValue &&
577 MethodInfo->NumReturnWithValue)
579 AslError (ASL_WARNING, ASL_MSG_RETURN_TYPES, Op,
580 Op->Asl.ExternalName);
584 * If there are any RETURN() statements with no value, or there is a
585 * control path that allows the method to exit without a return value,
586 * we mark the method as a method that does not return a value. This
587 * knowledge can be used to check method invocations that expect a
590 if (MethodInfo->NumReturnNoValue)
592 if (MethodInfo->NumReturnWithValue)
594 Op->Asl.CompileFlags |= NODE_METHOD_SOME_NO_RETVAL;
598 Op->Asl.CompileFlags |= NODE_METHOD_NO_RETVAL;
603 * Check predefined method names for correct return behavior
604 * and correct number of arguments. Also, some special checks
605 * For GPE and _REG methods.
607 if (ApCheckForPredefinedMethod (Op, MethodInfo))
609 /* Special check for two names like _L01 and _E01 in same scope */
611 ApCheckForGpeNameConflict (Op);
614 * Special check for _REG: Must have an operation region definition
615 * within the same scope!
617 ApCheckRegMethod (Op);
620 ACPI_FREE (MethodInfo);
625 /* Special check for two names like _L01 and _E01 in same scope */
627 ApCheckForGpeNameConflict (Op);
633 * If the parent is a predefined method name, attempt to typecheck
634 * the return value. Only static types can be validated.
636 ApCheckPredefinedReturnValue (Op, MethodInfo);
639 * The parent block does not "exit" and continue execution -- the
640 * method is terminated here with the Return() statement.
642 Op->Asl.Parent->Asl.CompileFlags |= NODE_HAS_NO_EXIT;
644 /* Used in the "typing" pass later */
646 Op->Asl.ParentMethod = MethodInfo->Op;
649 * If there is a peer node after the return statement, then this
650 * node is unreachable code -- i.e., it won't be executed because of
651 * the preceding Return() statement.
655 AslError (ASL_WARNING, ASL_MSG_UNREACHABLE_CODE, Op->Asl.Next, NULL);
661 if ((Op->Asl.CompileFlags & NODE_HAS_NO_EXIT) &&
663 (Op->Asl.Next->Asl.ParseOpcode == PARSEOP_ELSE))
666 * This IF has a corresponding ELSE. The IF block has no exit,
667 * (it contains an unconditional Return)
668 * mark the ELSE block to remember this fact.
670 Op->Asl.Next->Asl.CompileFlags |= NODE_IF_HAS_NO_EXIT;
676 if ((Op->Asl.CompileFlags & NODE_HAS_NO_EXIT) &&
677 (Op->Asl.CompileFlags & NODE_IF_HAS_NO_EXIT))
680 * This ELSE block has no exit and the corresponding IF block
681 * has no exit either. Therefore, the parent node has no exit.
683 Op->Asl.Parent->Asl.CompileFlags |= NODE_HAS_NO_EXIT;
690 if ((Op->Asl.CompileFlags & NODE_HAS_NO_EXIT) &&
693 /* If this node has no exit, then the parent has no exit either */
695 Op->Asl.Parent->Asl.CompileFlags |= NODE_HAS_NO_EXIT;