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 - 2023, 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 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 122 * 1. Redistributions of source code must retain the above copyright 123 * notice, this list of conditions, and the following disclaimer, 124 * without modification. 125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 * substantially similar to the "NO WARRANTY" disclaimer below 127 * ("Disclaimer") and any redistribution must be conditioned upon 128 * including a substantially similar Disclaimer requirement for further 129 * binary redistribution. 130 * 3. Neither the names of the above-listed copyright holders nor the names 131 * of any contributors may be used to endorse or promote products derived 132 * from this software without specific prior written permission. 133 * 134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 * 146 * Alternatively, you may choose to be licensed under the terms of the 147 * GNU General Public License ("GPL") version 2 as published by the Free 148 * Software Foundation. 149 * 150 *****************************************************************************/ 151 152 #include <contrib/dev/acpica/compiler/aslcompiler.h> 153 #include "aslcompiler.y.h" 154 #include <contrib/dev/acpica/include/acparser.h> 155 #include <contrib/dev/acpica/include/amlcode.h> 156 #include <contrib/dev/acpica/include/acnamesp.h> 157 #include <contrib/dev/acpica/include/acdispat.h> 158 159 160 #define _COMPONENT ACPI_COMPILER 161 ACPI_MODULE_NAME ("asllookup") 162 163 /* Local prototypes */ 164 165 static ACPI_STATUS 166 LkIsObjectUsed ( 167 ACPI_HANDLE ObjHandle, 168 UINT32 Level, 169 void *Context, 170 void **ReturnValue); 171 172 static ACPI_PARSE_OBJECT * 173 LkGetNameOp ( 174 ACPI_PARSE_OBJECT *Op); 175 176 177 /******************************************************************************* 178 * 179 * FUNCTION: LkFindUnreferencedObjects 180 * 181 * PARAMETERS: None 182 * 183 * RETURN: None 184 * 185 * DESCRIPTION: Namespace walk to find objects that are not referenced in any 186 * way. Must be called after the namespace has been cross 187 * referenced. 188 * 189 ******************************************************************************/ 190 191 void 192 LkFindUnreferencedObjects ( 193 void) 194 { 195 196 /* Walk entire namespace from the supplied root */ 197 198 (void) AcpiNsWalkNamespace (ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, 199 ACPI_UINT32_MAX, FALSE, LkIsObjectUsed, NULL, 200 NULL, NULL); 201 } 202 203 204 /******************************************************************************* 205 * 206 * FUNCTION: LkIsObjectUsed 207 * 208 * PARAMETERS: ACPI_WALK_CALLBACK 209 * 210 * RETURN: Status 211 * 212 * DESCRIPTION: Check for an unreferenced namespace object and emit a warning. 213 * We have to be careful, because some types and names are 214 * typically or always unreferenced, we don't want to issue 215 * excessive warnings. Note: Names that are declared within a 216 * control method are temporary, so we always issue a remark 217 * if they are not referenced. 218 * 219 ******************************************************************************/ 220 221 static ACPI_STATUS 222 LkIsObjectUsed ( 223 ACPI_HANDLE ObjHandle, 224 UINT32 Level, 225 void *Context, 226 void **ReturnValue) 227 { 228 ACPI_NAMESPACE_NODE *Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjHandle); 229 ACPI_NAMESPACE_NODE *Next; 230 ASL_METHOD_LOCAL *MethodLocals; 231 ASL_METHOD_LOCAL *MethodArgs; 232 UINT32 i; 233 234 235 if (Node->Type == ACPI_TYPE_METHOD) 236 { 237 if (!Node->Op || !Node->MethodLocals) 238 { 239 return (AE_OK); 240 } 241 242 MethodLocals = (ASL_METHOD_LOCAL *) Node->MethodLocals; 243 MethodArgs = (ASL_METHOD_LOCAL *) Node->MethodArgs; 244 245 /* 246 * Analysis of LocalX variables 247 */ 248 for (i = 0; i < ACPI_METHOD_NUM_LOCALS; i++) 249 { 250 /* Warn for Locals that are set but never referenced */ 251 252 if ((MethodLocals[i].Flags & ASL_LOCAL_INITIALIZED) && 253 (!(MethodLocals[i].Flags & ASL_LOCAL_REFERENCED))) 254 { 255 sprintf (AslGbl_MsgBuffer, "Local%u", i); 256 AslError (ASL_WARNING, ASL_MSG_LOCAL_NOT_USED, 257 MethodLocals[i].Op, AslGbl_MsgBuffer); 258 } 259 } 260 261 /* 262 * Analysis of ArgX variables (standard method arguments, 263 * and remaining unused ArgX can also be used as locals) 264 */ 265 for (i = 0; i < ACPI_METHOD_NUM_ARGS; i++) 266 { 267 if (MethodArgs[i].Flags & ASL_ARG_IS_LOCAL) 268 { 269 /* Warn if ArgX is being used as a local, but not referenced */ 270 271 if ((MethodArgs[i].Flags & ASL_ARG_INITIALIZED) && 272 (!(MethodArgs[i].Flags & ASL_ARG_REFERENCED))) 273 { 274 sprintf (AslGbl_MsgBuffer, "Arg%u", i); 275 AslError (ASL_WARNING, ASL_MSG_ARG_AS_LOCAL_NOT_USED, 276 MethodArgs[i].Op, AslGbl_MsgBuffer); 277 } 278 } 279 else 280 { 281 /* 282 * Remark if a normal method ArgX is not referenced. 283 * We ignore the predefined methods since often, not 284 * all arguments are needed or used. 285 */ 286 if ((Node->Name.Ascii[0] != '_') && 287 (!(MethodArgs[i].Flags & ASL_ARG_REFERENCED))) 288 { 289 sprintf (AslGbl_MsgBuffer, "Arg%u", i); 290 AslError (ASL_REMARK, ASL_MSG_ARG_NOT_USED, 291 MethodArgs[i].Op, AslGbl_MsgBuffer); 292 } 293 } 294 } 295 } 296 297 /* Referenced flag is set during the namespace xref */ 298 299 if (Node->Flags & ANOBJ_IS_REFERENCED) 300 { 301 return (AE_OK); 302 } 303 304 if (!Node->Op) 305 { 306 return (AE_OK); 307 } 308 309 /* These types are typically never directly referenced, ignore them */ 310 311 switch (Node->Type) 312 { 313 case ACPI_TYPE_DEVICE: 314 case ACPI_TYPE_PROCESSOR: 315 case ACPI_TYPE_POWER: 316 case ACPI_TYPE_THERMAL: 317 case ACPI_TYPE_LOCAL_RESOURCE: 318 case ACPI_TYPE_LOCAL_RESOURCE_FIELD: /* Names assigned to descriptor elements */ 319 320 return (AE_OK); 321 322 default: 323 324 break; 325 } 326 327 /* Determine if the name is within a control method */ 328 329 Next = Node->Parent; 330 while (Next) 331 { 332 if (Next->Type == ACPI_TYPE_METHOD) 333 { 334 /* 335 * Name is within a method, therefore it is temporary. 336 * Issue a remark even if it is a reserved name (starts 337 * with an underscore). 338 */ 339 sprintf (AslGbl_MsgBuffer, "Name [%4.4s] is within a method [%4.4s]", 340 Node->Name.Ascii, Next->Name.Ascii); 341 AslError (ASL_REMARK, ASL_MSG_NOT_REFERENCED, 342 LkGetNameOp (Node->Op), AslGbl_MsgBuffer); 343 return (AE_OK); 344 } 345 346 Next = Next->Parent; 347 } 348 349 /* The name is not within a control method */ 350 351 /* 352 * Ignore names that start with an underscore. These are the reserved 353 * ACPI names and are typically not referenced since they are meant 354 * to be called by the host OS. 355 */ 356 if (Node->Name.Ascii[0] == '_') 357 { 358 return (AE_OK); 359 } 360 361 /* 362 * What remains is an unresolved user name that is not within a method. 363 * However, the object could be referenced via another table, so issue 364 * the warning at level 2. 365 */ 366 AslError (ASL_WARNING2, ASL_MSG_NOT_REFERENCED, 367 LkGetNameOp (Node->Op), NULL); 368 return (AE_OK); 369 } 370 371 372 /******************************************************************************* 373 * 374 * FUNCTION: LkGetNameOp 375 * 376 * PARAMETERS: Op - Current Op 377 * 378 * RETURN: NameOp associated with the input op 379 * 380 * DESCRIPTION: Find the name declaration op associated with the operator 381 * 382 ******************************************************************************/ 383 384 static ACPI_PARSE_OBJECT * 385 LkGetNameOp ( 386 ACPI_PARSE_OBJECT *Op) 387 { 388 const ACPI_OPCODE_INFO *OpInfo; 389 ACPI_PARSE_OBJECT *NameOp = Op; 390 391 392 OpInfo = AcpiPsGetOpcodeInfo (Op->Asl.AmlOpcode); 393 394 395 /* Get the NamePath from the appropriate place */ 396 397 if (OpInfo->Flags & AML_NAMED) 398 { 399 /* For nearly all NAMED operators, the name reference is the first child */ 400 401 NameOp = Op->Asl.Child; 402 if (Op->Asl.AmlOpcode == AML_ALIAS_OP) 403 { 404 /* 405 * ALIAS is the only oddball opcode, the name declaration 406 * (alias name) is the second operand 407 */ 408 NameOp = Op->Asl.Child->Asl.Next; 409 } 410 } 411 else if (OpInfo->Flags & AML_CREATE) 412 { 413 /* Name must appear as the last parameter */ 414 415 NameOp = Op->Asl.Child; 416 while (!(NameOp->Asl.CompileFlags & OP_IS_NAME_DECLARATION)) 417 { 418 NameOp = NameOp->Asl.Next; 419 } 420 } 421 422 return (NameOp); 423 } 424