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 - 2016, 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 129static ACPI_STATUS 130LkIsObjectUsed ( 131 ACPI_HANDLE ObjHandle, 132 UINT32 Level, 133 void *Context, 134 void **ReturnValue); 135 136static ACPI_PARSE_OBJECT * 137LkGetNameOp ( 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 155void 156LkFindUnreferencedObjects ( 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 185static ACPI_STATUS 186LkIsObjectUsed ( 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 ASL_METHOD_LOCAL *MethodLocals; 195 ASL_METHOD_LOCAL *MethodArgs; 196 UINT32 i; 197 198 199 if (Node->Type == ACPI_TYPE_METHOD) 200 { 201 if (!Node->Op || !Node->MethodLocals) 202 { 203 return (AE_OK); 204 } 205 206 MethodLocals = (ASL_METHOD_LOCAL *) Node->MethodLocals; 207 MethodArgs = (ASL_METHOD_LOCAL *) Node->MethodArgs; 208 209 /* 210 * Analysis of LocalX variables 211 */ 212 for (i = 0; i < ACPI_METHOD_NUM_LOCALS; i++) 213 { 214 /* Warn for Locals that are set but never referenced */ 215 216 if ((MethodLocals[i].Flags & ASL_LOCAL_INITIALIZED) && 217 (!(MethodLocals[i].Flags & ASL_LOCAL_REFERENCED))) 218 { 219 sprintf (MsgBuffer, "Local%u", i); 220 AslError (ASL_WARNING, ASL_MSG_LOCAL_NOT_USED, 221 MethodLocals[i].Op, MsgBuffer); 222 } 223 } 224 225 /* 226 * Analysis of ArgX variables (standard method arguments, 227 * and remaining unused ArgX can also be used as locals) 228 */ 229 for (i = 0; i < ACPI_METHOD_NUM_ARGS; i++) 230 { 231 if (MethodArgs[i].Flags & ASL_ARG_IS_LOCAL) 232 { 233 /* Warn if ArgX is being used as a local, but not referenced */ 234 235 if ((MethodArgs[i].Flags & ASL_ARG_INITIALIZED) && 236 (!(MethodArgs[i].Flags & ASL_ARG_REFERENCED))) 237 { 238 sprintf (MsgBuffer, "Arg%u", i); 239 AslError (ASL_WARNING, ASL_MSG_ARG_AS_LOCAL_NOT_USED, 240 MethodArgs[i].Op, MsgBuffer); 241 } 242 } 243 else 244 { 245 /* 246 * Remark if a normal method ArgX is not referenced. 247 * We ignore the predefined methods since often, not 248 * all arguments are needed or used. 249 */ 250 if ((Node->Name.Ascii[0] != '_') && 251 (!(MethodArgs[i].Flags & ASL_ARG_REFERENCED))) 252 { 253 sprintf (MsgBuffer, "Arg%u", i); 254 AslError (ASL_REMARK, ASL_MSG_ARG_NOT_USED, 255 MethodArgs[i].Op, MsgBuffer); 256 } 257 } 258 } 259 } 260 261 /* Referenced flag is set during the namespace xref */ 262 263 if (Node->Flags & ANOBJ_IS_REFERENCED) 264 { 265 return (AE_OK); 266 } 267 268 if (!Node->Op) 269 { 270 return (AE_OK); 271 } 272 273 /* These types are typically never directly referenced, ignore them */ 274 275 switch (Node->Type) 276 { 277 case ACPI_TYPE_DEVICE: 278 case ACPI_TYPE_PROCESSOR: 279 case ACPI_TYPE_POWER: 280 case ACPI_TYPE_THERMAL: 281 case ACPI_TYPE_LOCAL_RESOURCE: 282 case ACPI_TYPE_LOCAL_RESOURCE_FIELD: /* Names assigned to descriptor elements */ 283 284 return (AE_OK); 285 286 default: 287 288 break; 289 } 290 291 /* Determine if the name is within a control method */ 292 293 Next = Node->Parent; 294 while (Next) 295 { 296 if (Next->Type == ACPI_TYPE_METHOD) 297 { 298 /* 299 * Name is within a method, therefore it is temporary. 300 * Issue a remark even if it is a reserved name (starts 301 * with an underscore). 302 */ 303 sprintf (MsgBuffer, "Name [%4.4s] is within a method [%4.4s]", 304 Node->Name.Ascii, Next->Name.Ascii); 305 AslError (ASL_REMARK, ASL_MSG_NOT_REFERENCED, 306 LkGetNameOp (Node->Op), MsgBuffer); 307 return (AE_OK); 308 } 309 310 Next = Next->Parent; 311 } 312 313 /* The name is not within a control method */ 314 315 /* 316 * Ignore names that start with an underscore. These are the reserved 317 * ACPI names and are typically not referenced since they are meant 318 * to be called by the host OS. 319 */ 320 if (Node->Name.Ascii[0] == '_') 321 { 322 return (AE_OK); 323 } 324 325 /* 326 * What remains is an unresolved user name that is not within a method. 327 * However, the object could be referenced via another table, so issue 328 * the warning at level 2. 329 */ 330 AslError (ASL_WARNING2, ASL_MSG_NOT_REFERENCED, 331 LkGetNameOp (Node->Op), NULL); 332 return (AE_OK); 333} 334 335 336/******************************************************************************* 337 * 338 * FUNCTION: LkGetNameOp 339 * 340 * PARAMETERS: Op - Current Op 341 * 342 * RETURN: NameOp associated with the input op 343 * 344 * DESCRIPTION: Find the name declaration op associated with the operator 345 * 346 ******************************************************************************/ 347 348static ACPI_PARSE_OBJECT * 349LkGetNameOp ( 350 ACPI_PARSE_OBJECT *Op) 351{ 352 const ACPI_OPCODE_INFO *OpInfo; 353 ACPI_PARSE_OBJECT *NameOp = Op; 354 355 356 OpInfo = AcpiPsGetOpcodeInfo (Op->Asl.AmlOpcode); 357 358 359 /* Get the NamePath from the appropriate place */ 360 361 if (OpInfo->Flags & AML_NAMED) 362 { 363 /* For nearly all NAMED operators, the name reference is the first child */ 364 365 NameOp = Op->Asl.Child; 366 if (Op->Asl.AmlOpcode == AML_ALIAS_OP) 367 { 368 /* 369 * ALIAS is the only oddball opcode, the name declaration 370 * (alias name) is the second operand 371 */ 372 NameOp = Op->Asl.Child->Asl.Next; 373 } 374 } 375 else if (OpInfo->Flags & AML_CREATE) 376 { 377 /* Name must appear as the last parameter */ 378 379 NameOp = Op->Asl.Child; 380 while (!(NameOp->Asl.CompileFlags & NODE_IS_NAME_DECLARATION)) 381 { 382 NameOp = NameOp->Asl.Next; 383 } 384 } 385 386 return (NameOp); 387} 388