drivers/acpi/compiler/asllookup.c

   1 /******************************************************************************
   2  *
   3  * Module Name: asllookup- Namespace lookup functions
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  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.
  20  *
  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
  27  *
  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;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  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.
  53  *
  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.
  65  *
  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.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  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.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  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.
  89  *
  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.
  98  *
  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.
 113  *
 114  *****************************************************************************/
 115
 116 #include "aslcompiler.h"
 117 #include "aslcompiler.y.h"
 118 #include "acparser.h"
 119 #include "amlcode.h"
 120 #include "acnamesp.h"
 121 #include "acdispat.h"
 122
 123
 124 #define _COMPONENT          ACPI_COMPILER
 125         ACPI_MODULE_NAME    ("asllookup")
 126
 127 /* Local prototypes */
 128
 129 static ACPI_STATUS
 130 LkIsObjectUsed (
 131     ACPI_HANDLE             ObjHandle,
 132     UINT32                  Level,
 133     void                    *Context,
 134     void                    **ReturnValue);
 135
 136 static ACPI_PARSE_OBJECT *
 137 LkGetNameOp (
 138     ACPI_PARSE_OBJECT       *Op);
 139
 140
 141 /*******************************************************************************
 142  *
 143  * FUNCTION:    LkFindUnreferencedObjects
 144  *
 145  * PARAMETERS:  None
 146  *
 147  * RETURN:      None
 148  *
 149  * DESCRIPTION: Namespace walk to find objects that are not referenced in any
 150  *              way. Must be called after the namespace has been cross
 151  *              referenced.
 152  *
 153  ******************************************************************************/
 154
 155 void
 156 LkFindUnreferencedObjects (
 157     void)
 158 {
 159
 160     /* Walk entire namespace from the supplied root */
 161
 162     (void) AcpiNsWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
 163                 ACPI_UINT32_MAX, FALSE, LkIsObjectUsed, NULL,
 164                 NULL, NULL);
 165 }
 166
 167
 168 /*******************************************************************************
 169  *
 170  * FUNCTION:    LkIsObjectUsed
 171  *
 172  * PARAMETERS:  ACPI_WALK_CALLBACK
 173  *
 174  * RETURN:      Status
 175  *
 176  * DESCRIPTION: Check for an unreferenced namespace object and emit a warning.
 177  *              We have to be careful, because some types and names are
 178  *              typically or always unreferenced, we don't want to issue
 179  *              excessive warnings. Note: Names that are declared within a
 180  *              control method are temporary, so we always issue a remark
 181  *              if they are not referenced.
 182  *
 183  ******************************************************************************/
 184
 185 static ACPI_STATUS
 186 LkIsObjectUsed (
 187     ACPI_HANDLE             ObjHandle,
 188     UINT32                  Level,
 189     void                    *Context,
 190     void                    **ReturnValue)
 191 {
 192     ACPI_NAMESPACE_NODE     *Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjHandle);
 193     ACPI_NAMESPACE_NODE     *Next;
 194
 195
 196     /* Referenced flag is set during the namespace xref */
 197
 198     if (Node->Flags & ANOBJ_IS_REFERENCED)
 199     {
 200         return (AE_OK);
 201     }
 202
 203     if (!Node->Op)
 204     {
 205         return (AE_OK);
 206     }
 207
 208     /* These types are typically never directly referenced, ignore them */
 209
 210     switch (Node->Type)
 211     {
 212     case ACPI_TYPE_DEVICE:
 213     case ACPI_TYPE_PROCESSOR:
 214     case ACPI_TYPE_POWER:
 215     case ACPI_TYPE_THERMAL:
 216     case ACPI_TYPE_LOCAL_RESOURCE:
 217
 218         return (AE_OK);
 219
 220     default:
 221
 222         break;
 223     }
 224
 225     /* Determine if the name is within a control method */
 226
 227     Next = Node->Parent;
 228     while (Next)
 229     {
 230         if (Next->Type == ACPI_TYPE_METHOD)
 231         {
 232             /*
 233              * Name is within a method, therefore it is temporary.
 234              * Issue a remark even if it is a reserved name (starts
 235              * with an underscore).
 236              */
 237             sprintf (MsgBuffer, "Name is within method [%4.4s]",
 238                 Next->Name.Ascii);
 239             AslError (ASL_REMARK, ASL_MSG_NOT_REFERENCED,
 240                 LkGetNameOp (Node->Op), MsgBuffer);
 241             return (AE_OK);
 242         }
 243
 244         Next = Next->Parent;
 245     }
 246
 247     /* The name is not within a control method */
 248
 249     /*
 250      * Ignore names that start with an underscore. These are the reserved
 251      * ACPI names and are typically not referenced since they are meant
 252      * to be called by the host OS.
 253      */
 254     if (Node->Name.Ascii[0] == '_')
 255     {
 256         return (AE_OK);
 257     }
 258
 259     /*
 260      * What remains is an unresolved user name that is not within a method.
 261      * However, the object could be referenced via another table, so issue
 262      * the warning at level 2.
 263      */
 264     AslError (ASL_WARNING2, ASL_MSG_NOT_REFERENCED,
 265         LkGetNameOp (Node->Op), NULL);
 266     return (AE_OK);
 267 }
 268
 269
 270 /*******************************************************************************
 271  *
 272  * FUNCTION:    LkGetNameOp
 273  *
 274  * PARAMETERS:  Op              - Current Op
 275  *
 276  * RETURN:      NameOp associated with the input op
 277  *
 278  * DESCRIPTION: Find the name declaration op associated with the operator
 279  *
 280  ******************************************************************************/
 281
 282 static ACPI_PARSE_OBJECT *
 283 LkGetNameOp (
 284     ACPI_PARSE_OBJECT       *Op)
 285 {
 286     const ACPI_OPCODE_INFO  *OpInfo;
 287     ACPI_PARSE_OBJECT       *NameOp = Op;
 288
 289
 290     OpInfo = AcpiPsGetOpcodeInfo (Op->Asl.AmlOpcode);
 291
 292
 293     /* Get the NamePath from the appropriate place */
 294
 295     if (OpInfo->Flags & AML_NAMED)
 296     {
 297         /* For nearly all NAMED operators, the name reference is the first child */
 298
 299         NameOp = Op->Asl.Child;
 300         if (Op->Asl.AmlOpcode == AML_ALIAS_OP)
 301         {
 302             /*
 303              * ALIAS is the only oddball opcode, the name declaration
 304              * (alias name) is the second operand
 305              */
 306             NameOp = Op->Asl.Child->Asl.Next;
 307         }
 308     }
 309     else if (OpInfo->Flags & AML_CREATE)
 310     {
 311         /* Name must appear as the last parameter */
 312
 313         NameOp = Op->Asl.Child;
 314         while (!(NameOp->Asl.CompileFlags & NODE_IS_NAME_DECLARATION))
 315         {
 316             NameOp = NameOp->Asl.Next;
 317         }
 318     }
 319
 320     return (NameOp);
 321 }