sys/contrib/dev/acpica/source/compiler/asllookup.c

   1 /******************************************************************************
   2  *
   3  * Module Name: asllookup- Namespace lookup functions
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2015, 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 "aslcompiler.h"
  45 #include "aslcompiler.y.h"
  46 #include "acparser.h"
  47 #include "amlcode.h"
  48 #include "acnamesp.h"
  49 #include "acdispat.h"
  50
  51
  52 #define _COMPONENT          ACPI_COMPILER
  53         ACPI_MODULE_NAME    ("asllookup")
  54
  55 /* Local prototypes */
  56
  57 static ACPI_STATUS
  58 LkIsObjectUsed (
  59     ACPI_HANDLE             ObjHandle,
  60     UINT32                  Level,
  61     void                    *Context,
  62     void                    **ReturnValue);
  63
  64 static ACPI_PARSE_OBJECT *
  65 LkGetNameOp (
  66     ACPI_PARSE_OBJECT       *Op);
  67
  68
  69 /*******************************************************************************
  70  *
  71  * FUNCTION:    LkFindUnreferencedObjects
  72  *
  73  * PARAMETERS:  None
  74  *
  75  * RETURN:      None
  76  *
  77  * DESCRIPTION: Namespace walk to find objects that are not referenced in any
  78  *              way. Must be called after the namespace has been cross
  79  *              referenced.
  80  *
  81  ******************************************************************************/
  82
  83 void
  84 LkFindUnreferencedObjects (
  85     void)
  86 {
  87
  88     /* Walk entire namespace from the supplied root */
  89
  90     (void) AcpiNsWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
  91                 ACPI_UINT32_MAX, FALSE, LkIsObjectUsed, NULL,
  92                 NULL, NULL);
  93 }
  94
  95
  96 /*******************************************************************************
  97  *
  98  * FUNCTION:    LkIsObjectUsed
  99  *
 100  * PARAMETERS:  ACPI_WALK_CALLBACK
 101  *
 102  * RETURN:      Status
 103  *
 104  * DESCRIPTION: Check for an unreferenced namespace object and emit a warning.
 105  *              We have to be careful, because some types and names are
 106  *              typically or always unreferenced, we don't want to issue
 107  *              excessive warnings. Note: Names that are declared within a
 108  *              control method are temporary, so we always issue a remark
 109  *              if they are not referenced.
 110  *
 111  ******************************************************************************/
 112
 113 static ACPI_STATUS
 114 LkIsObjectUsed (
 115     ACPI_HANDLE             ObjHandle,
 116     UINT32                  Level,
 117     void                    *Context,
 118     void                    **ReturnValue)
 119 {
 120     ACPI_NAMESPACE_NODE     *Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjHandle);
 121     ACPI_NAMESPACE_NODE     *Next;
 122
 123
 124     /* Referenced flag is set during the namespace xref */
 125
 126     if (Node->Flags & ANOBJ_IS_REFERENCED)
 127     {
 128         return (AE_OK);
 129     }
 130
 131     if (!Node->Op)
 132     {
 133         return (AE_OK);
 134     }
 135
 136     /* These types are typically never directly referenced, ignore them */
 137
 138     switch (Node->Type)
 139     {
 140     case ACPI_TYPE_DEVICE:
 141     case ACPI_TYPE_PROCESSOR:
 142     case ACPI_TYPE_POWER:
 143     case ACPI_TYPE_THERMAL:
 144     case ACPI_TYPE_LOCAL_RESOURCE:
 145
 146         return (AE_OK);
 147
 148     default:
 149
 150         break;
 151     }
 152
 153     /* Determine if the name is within a control method */
 154
 155     Next = Node->Parent;
 156     while (Next)
 157     {
 158         if (Next->Type == ACPI_TYPE_METHOD)
 159         {
 160             /*
 161              * Name is within a method, therefore it is temporary.
 162              * Issue a remark even if it is a reserved name (starts
 163              * with an underscore).
 164              */
 165             sprintf (MsgBuffer, "Name is within method [%4.4s]",
 166                 Next->Name.Ascii);
 167             AslError (ASL_REMARK, ASL_MSG_NOT_REFERENCED,
 168                 LkGetNameOp (Node->Op), MsgBuffer);
 169             return (AE_OK);
 170         }
 171
 172         Next = Next->Parent;
 173     }
 174
 175     /* The name is not within a control method */
 176
 177     /*
 178      * Ignore names that start with an underscore. These are the reserved
 179      * ACPI names and are typically not referenced since they are meant
 180      * to be called by the host OS.
 181      */
 182     if (Node->Name.Ascii[0] == '_')
 183     {
 184         return (AE_OK);
 185     }
 186
 187     /*
 188      * What remains is an unresolved user name that is not within a method.
 189      * However, the object could be referenced via another table, so issue
 190      * the warning at level 2.
 191      */
 192     AslError (ASL_WARNING2, ASL_MSG_NOT_REFERENCED,
 193         LkGetNameOp (Node->Op), NULL);
 194     return (AE_OK);
 195 }
 196
 197
 198 /*******************************************************************************
 199  *
 200  * FUNCTION:    LkGetNameOp
 201  *
 202  * PARAMETERS:  Op              - Current Op
 203  *
 204  * RETURN:      NameOp associated with the input op
 205  *
 206  * DESCRIPTION: Find the name declaration op associated with the operator
 207  *
 208  ******************************************************************************/
 209
 210 static ACPI_PARSE_OBJECT *
 211 LkGetNameOp (
 212     ACPI_PARSE_OBJECT       *Op)
 213 {
 214     const ACPI_OPCODE_INFO  *OpInfo;
 215     ACPI_PARSE_OBJECT       *NameOp = Op;
 216
 217
 218     OpInfo = AcpiPsGetOpcodeInfo (Op->Asl.AmlOpcode);
 219
 220
 221     /* Get the NamePath from the appropriate place */
 222
 223     if (OpInfo->Flags & AML_NAMED)
 224     {
 225         /* For nearly all NAMED operators, the name reference is the first child */
 226
 227         NameOp = Op->Asl.Child;
 228         if (Op->Asl.AmlOpcode == AML_ALIAS_OP)
 229         {
 230             /*
 231              * ALIAS is the only oddball opcode, the name declaration
 232              * (alias name) is the second operand
 233              */
 234             NameOp = Op->Asl.Child->Asl.Next;
 235         }
 236     }
 237     else if (OpInfo->Flags & AML_CREATE)
 238     {
 239         /* Name must appear as the last parameter */
 240
 241         NameOp = Op->Asl.Child;
 242         while (!(NameOp->Asl.CompileFlags & NODE_IS_NAME_DECLARATION))
 243         {
 244             NameOp = NameOp->Asl.Next;
 245         }
 246     }
 247
 248     return (NameOp);
 249 }