1 /****************************************************************************** 2 * 3 * Module Name: asllength - Tree walk to determine package and opcode lengths 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2018, 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 "aslcompiler.h" 153 #include "aslcompiler.y.h" 154 #include "amlcode.h" 155 #include "acconvert.h" 156 157 158 #define _COMPONENT ACPI_COMPILER 159 ACPI_MODULE_NAME ("asllength") 160 161 /* Local prototypes */ 162 163 static UINT8 164 CgGetPackageLenByteCount ( 165 ACPI_PARSE_OBJECT *Op, 166 UINT32 PackageLength); 167 168 static void 169 CgGenerateAmlOpcodeLength ( 170 ACPI_PARSE_OBJECT *Op); 171 172 173 #ifdef ACPI_OBSOLETE_FUNCTIONS 174 void 175 LnAdjustLengthToRoot ( 176 ACPI_PARSE_OBJECT *Op, 177 UINT32 LengthDelta); 178 #endif 179 180 181 /******************************************************************************* 182 * 183 * FUNCTION: LnInitLengthsWalk 184 * 185 * PARAMETERS: ASL_WALK_CALLBACK 186 * 187 * RETURN: Status 188 * 189 * DESCRIPTION: Walk callback to initialize (and re-initialize) the node 190 * subtree length(s) to zero. The Subtree lengths are bubbled 191 * up to the root node in order to get a total AML length. 192 * 193 ******************************************************************************/ 194 195 ACPI_STATUS 196 LnInitLengthsWalk ( 197 ACPI_PARSE_OBJECT *Op, 198 UINT32 Level, 199 void *Context) 200 { 201 202 Op->Asl.AmlSubtreeLength = 0; 203 return (AE_OK); 204 } 205 206 207 /******************************************************************************* 208 * 209 * FUNCTION: LnPackageLengthWalk 210 * 211 * PARAMETERS: ASL_WALK_CALLBACK 212 * 213 * RETURN: Status 214 * 215 * DESCRIPTION: Walk callback to calculate the total AML length. 216 * 1) Calculate the AML lengths (opcode, package length, etc.) for 217 * THIS node. 218 * 2) Bubbble up all of these lengths to the parent node by summing 219 * them all into the parent subtree length. 220 * 221 * Note: The SubtreeLength represents the total AML length of all child nodes 222 * in all subtrees under a given node. Therefore, once this walk is 223 * complete, the Root Node subtree length is the AML length of the entire 224 * tree (and thus, the entire ACPI table) 225 * 226 ******************************************************************************/ 227 228 ACPI_STATUS 229 LnPackageLengthWalk ( 230 ACPI_PARSE_OBJECT *Op, 231 UINT32 Level, 232 void *Context) 233 { 234 235 /* Generate the AML lengths for this node */ 236 237 CgGenerateAmlLengths (Op); 238 239 /* Bubble up all lengths (this node and all below it) to the parent */ 240 241 if ((Op->Asl.Parent) && 242 (Op->Asl.ParseOpcode != PARSEOP_DEFAULT_ARG)) 243 { 244 Op->Asl.Parent->Asl.AmlSubtreeLength += ( 245 Op->Asl.AmlLength + 246 Op->Asl.AmlOpcodeLength + 247 Op->Asl.AmlPkgLenBytes + 248 Op->Asl.AmlSubtreeLength + 249 CvCalculateCommentLengths (Op) 250 ); 251 } 252 return (AE_OK); 253 } 254 255 256 /******************************************************************************* 257 * 258 * FUNCTION: CgGetPackageLenByteCount 259 * 260 * PARAMETERS: Op - Parse node 261 * PackageLength - Length to be encoded 262 * 263 * RETURN: Required length of the package length encoding 264 * 265 * DESCRIPTION: Calculate the number of bytes required to encode the given 266 * package length. 267 * 268 ******************************************************************************/ 269 270 static UINT8 271 CgGetPackageLenByteCount ( 272 ACPI_PARSE_OBJECT *Op, 273 UINT32 PackageLength) 274 { 275 276 /* 277 * Determine the number of bytes required to encode the package length 278 * Note: the package length includes the number of bytes used to encode 279 * the package length, so we must account for this also. 280 */ 281 if (PackageLength <= (0x0000003F - 1)) 282 { 283 return (1); 284 } 285 else if (PackageLength <= (0x00000FFF - 2)) 286 { 287 return (2); 288 } 289 else if (PackageLength <= (0x000FFFFF - 3)) 290 { 291 return (3); 292 } 293 else if (PackageLength <= (0x0FFFFFFF - 4)) 294 { 295 return (4); 296 } 297 else 298 { 299 /* Fatal error - the package length is too large to encode */ 300 301 AslError (ASL_ERROR, ASL_MSG_ENCODING_LENGTH, Op, NULL); 302 } 303 304 return (0); 305 } 306 307 308 /******************************************************************************* 309 * 310 * FUNCTION: CgGenerateAmlOpcodeLength 311 * 312 * PARAMETERS: Op - Parse node whose AML opcode lengths will be 313 * calculated 314 * 315 * RETURN: None. 316 * 317 * DESCRIPTION: Calculate the AmlOpcodeLength, AmlPkgLenBytes, and AmlLength 318 * fields for this node. 319 * 320 ******************************************************************************/ 321 322 static void 323 CgGenerateAmlOpcodeLength ( 324 ACPI_PARSE_OBJECT *Op) 325 { 326 327 /* Check for two-byte opcode */ 328 329 if (Op->Asl.AmlOpcode > 0x00FF) 330 { 331 Op->Asl.AmlOpcodeLength = 2; 332 } 333 else 334 { 335 Op->Asl.AmlOpcodeLength = 1; 336 } 337 338 /* Does this opcode have an associated "PackageLength" field? */ 339 340 Op->Asl.AmlPkgLenBytes = 0; 341 if (Op->Asl.CompileFlags & OP_AML_PACKAGE) 342 { 343 Op->Asl.AmlPkgLenBytes = CgGetPackageLenByteCount ( 344 Op, Op->Asl.AmlSubtreeLength); 345 } 346 347 /* Data opcode lengths are easy */ 348 349 switch (Op->Asl.AmlOpcode) 350 { 351 case AML_BYTE_OP: 352 353 Op->Asl.AmlLength = 1; 354 break; 355 356 case AML_WORD_OP: 357 358 Op->Asl.AmlLength = 2; 359 break; 360 361 case AML_DWORD_OP: 362 363 Op->Asl.AmlLength = 4; 364 break; 365 366 case AML_QWORD_OP: 367 368 Op->Asl.AmlLength = 8; 369 break; 370 371 default: 372 373 /* All data opcodes must be above */ 374 break; 375 } 376 } 377 378 379 /******************************************************************************* 380 * 381 * FUNCTION: CgGenerateAmlLengths 382 * 383 * PARAMETERS: Op - Parse node 384 * 385 * RETURN: None. 386 * 387 * DESCRIPTION: Generate internal length fields based on the AML opcode or 388 * parse opcode. 389 * 390 ******************************************************************************/ 391 392 void 393 CgGenerateAmlLengths ( 394 ACPI_PARSE_OBJECT *Op) 395 { 396 char *Buffer; 397 ACPI_STATUS Status; 398 399 400 switch (Op->Asl.AmlOpcode) 401 { 402 case AML_RAW_DATA_BYTE: 403 404 Op->Asl.AmlOpcodeLength = 0; 405 Op->Asl.AmlLength = 1; 406 return; 407 408 case AML_RAW_DATA_WORD: 409 410 Op->Asl.AmlOpcodeLength = 0; 411 Op->Asl.AmlLength = 2; 412 return; 413 414 case AML_RAW_DATA_DWORD: 415 416 Op->Asl.AmlOpcodeLength = 0; 417 Op->Asl.AmlLength = 4; 418 return; 419 420 case AML_RAW_DATA_QWORD: 421 422 Op->Asl.AmlOpcodeLength = 0; 423 Op->Asl.AmlLength = 8; 424 return; 425 426 case AML_RAW_DATA_BUFFER: 427 428 /* Aml length is/was set by creator */ 429 430 Op->Asl.AmlOpcodeLength = 0; 431 return; 432 433 case AML_RAW_DATA_CHAIN: 434 435 /* Aml length is/was set by creator */ 436 437 Op->Asl.AmlOpcodeLength = 0; 438 return; 439 440 default: 441 442 break; 443 } 444 445 switch (Op->Asl.ParseOpcode) 446 { 447 case PARSEOP_DEFINITION_BLOCK: 448 449 Gbl_TableLength = sizeof (ACPI_TABLE_HEADER) + Op->Asl.AmlSubtreeLength; 450 break; 451 452 case PARSEOP_NAMESEG: 453 454 Op->Asl.AmlOpcodeLength = 0; 455 Op->Asl.AmlLength = 4; 456 Op->Asl.ExternalName = Op->Asl.Value.String; 457 break; 458 459 case PARSEOP_NAMESTRING: 460 case PARSEOP_METHODCALL: 461 462 if (Op->Asl.CompileFlags & OP_NAME_INTERNALIZED) 463 { 464 break; 465 } 466 467 Op->Asl.AmlOpcodeLength = 0; 468 Status = UtInternalizeName (Op->Asl.Value.String, &Buffer); 469 if (ACPI_FAILURE (Status)) 470 { 471 DbgPrint (ASL_DEBUG_OUTPUT, 472 "Failure from internalize name %X\n", Status); 473 break; 474 } 475 476 Op->Asl.ExternalName = Op->Asl.Value.String; 477 Op->Asl.Value.String = Buffer; 478 Op->Asl.CompileFlags |= OP_NAME_INTERNALIZED; 479 Op->Asl.AmlLength = strlen (Buffer); 480 481 /* 482 * Check for single backslash reference to root, 483 * make it a null terminated string in the AML 484 */ 485 if (Op->Asl.AmlLength == 1) 486 { 487 Op->Asl.AmlLength = 2; 488 } 489 break; 490 491 case PARSEOP_STRING_LITERAL: 492 493 Op->Asl.AmlOpcodeLength = 1; 494 495 /* Get null terminator */ 496 497 Op->Asl.AmlLength = strlen (Op->Asl.Value.String) + 1; 498 break; 499 500 case PARSEOP_PACKAGE_LENGTH: 501 502 Op->Asl.AmlOpcodeLength = 0; 503 Op->Asl.AmlPkgLenBytes = CgGetPackageLenByteCount (Op, 504 (UINT32) Op->Asl.Value.Integer); 505 break; 506 507 case PARSEOP_RAW_DATA: 508 509 Op->Asl.AmlOpcodeLength = 0; 510 break; 511 512 case PARSEOP_DEFAULT_ARG: 513 case PARSEOP_INCLUDE: 514 case PARSEOP_INCLUDE_END: 515 516 /* Ignore the "default arg" nodes, they are extraneous at this point */ 517 518 break; 519 520 case PARSEOP_EXTERNAL: 521 522 if (Gbl_DoExternals == TRUE) 523 { 524 CgGenerateAmlOpcodeLength (Op); 525 } 526 break; 527 528 default: 529 530 CgGenerateAmlOpcodeLength (Op); 531 break; 532 } 533 } 534 535 536 #ifdef ACPI_OBSOLETE_FUNCTIONS 537 /******************************************************************************* 538 * 539 * FUNCTION: LnAdjustLengthToRoot 540 * 541 * PARAMETERS: Op - Node whose Length was changed 542 * 543 * RETURN: None. 544 * 545 * DESCRIPTION: Change the Subtree length of the given node, and bubble the 546 * change all the way up to the root node. This allows for 547 * last second changes to a package length (for example, if the 548 * package length encoding gets shorter or longer.) 549 * 550 ******************************************************************************/ 551 552 void 553 LnAdjustLengthToRoot ( 554 ACPI_PARSE_OBJECT *SubtreeOp, 555 UINT32 LengthDelta) 556 { 557 ACPI_PARSE_OBJECT *Op; 558 559 560 /* Adjust all subtree lengths up to the root */ 561 562 Op = SubtreeOp->Asl.Parent; 563 while (Op) 564 { 565 Op->Asl.AmlSubtreeLength -= LengthDelta; 566 Op = Op->Asl.Parent; 567 } 568 569 /* Adjust the global table length */ 570 571 Gbl_TableLength -= LengthDelta; 572 } 573 #endif 574