1 2 /****************************************************************************** 3 * 4 * Module Name: asllength - Tree walk to determine package and opcode lengths 5 * $Revision: 31 $ 6 * 7 *****************************************************************************/ 8 9 /****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999 - 2004, Intel Corp. 14 * All rights reserved. 15 * 16 * 2. License 17 * 18 * 2.1. This is your license from Intel Corp. under its intellectual property 19 * rights. You may have additional license terms from the party that provided 20 * you this software, covering your right to use that party's intellectual 21 * property rights. 22 * 23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 24 * copy of the source code appearing in this file ("Covered Code") an 25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 26 * base code distributed originally by Intel ("Original Intel Code") to copy, 27 * make derivatives, distribute, use and display any portion of the Covered 28 * Code in any form, with the right to sublicense such rights; and 29 * 30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 31 * license (with the right to sublicense), under only those claims of Intel 32 * patents that are infringed by the Original Intel Code, to make, use, sell, 33 * offer to sell, and import the Covered Code and derivative works thereof 34 * solely to the minimum extent necessary to exercise the above copyright 35 * license, and in no event shall the patent license extend to any additions 36 * to or modifications of the Original Intel Code. No other license or right 37 * is granted directly or by implication, estoppel or otherwise; 38 * 39 * The above copyright and patent license is granted only if the following 40 * conditions are met: 41 * 42 * 3. Conditions 43 * 44 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 45 * Redistribution of source code of any substantial portion of the Covered 46 * Code or modification with rights to further distribute source must include 47 * the above Copyright Notice, the above License, this list of Conditions, 48 * and the following Disclaimer and Export Compliance provision. In addition, 49 * Licensee must cause all Covered Code to which Licensee contributes to 50 * contain a file documenting the changes Licensee made to create that Covered 51 * Code and the date of any change. Licensee must include in that file the 52 * documentation of any changes made by any predecessor Licensee. Licensee 53 * must include a prominent statement that the modification is derived, 54 * directly or indirectly, from Original Intel Code. 55 * 56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 57 * Redistribution of source code of any substantial portion of the Covered 58 * Code or modification without rights to further distribute source must 59 * include the following Disclaimer and Export Compliance provision in the 60 * documentation and/or other materials provided with distribution. In 61 * addition, Licensee may not authorize further sublicense of source of any 62 * portion of the Covered Code, and must include terms to the effect that the 63 * license from Licensee to its licensee is limited to the intellectual 64 * property embodied in the software Licensee provides to its licensee, and 65 * not to intellectual property embodied in modifications its licensee may 66 * make. 67 * 68 * 3.3. Redistribution of Executable. Redistribution in executable form of any 69 * substantial portion of the Covered Code or modification must reproduce the 70 * above Copyright Notice, and the following Disclaimer and Export Compliance 71 * provision in the documentation and/or other materials provided with the 72 * distribution. 73 * 74 * 3.4. Intel retains all right, title, and interest in and to the Original 75 * Intel Code. 76 * 77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 78 * Intel shall be used in advertising or otherwise to promote the sale, use or 79 * other dealings in products derived from or relating to the Covered Code 80 * without prior written authorization from Intel. 81 * 82 * 4. Disclaimer and Export Compliance 83 * 84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 90 * PARTICULAR PURPOSE. 91 * 92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 99 * LIMITED REMEDY. 100 * 101 * 4.3. Licensee shall not export, either directly or indirectly, any of this 102 * software or system incorporating such software without first obtaining any 103 * required license or other approval from the U. S. Department of Commerce or 104 * any other agency or department of the United States Government. In the 105 * event Licensee exports any such software from the United States or 106 * re-exports any such software from a foreign destination, Licensee shall 107 * ensure that the distribution and export/re-export of the software is in 108 * compliance with all laws, regulations, orders, or other restrictions of the 109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 110 * any of its subsidiaries will export/re-export any technical data, process, 111 * software, or service, directly or indirectly, to any country for which the 112 * United States government or any agency thereof requires an export license, 113 * other governmental approval, or letter of assurance, without first obtaining 114 * such license, approval or letter. 115 * 116 *****************************************************************************/ 117 118 119 #include "aslcompiler.h" 120 #include "aslcompiler.y.h" 121 #include "amlcode.h" 122 123 124 #define _COMPONENT ACPI_COMPILER 125 ACPI_MODULE_NAME ("asllength") 126 127 128 /******************************************************************************* 129 * 130 * FUNCTION: LnInitLengthsWalk 131 * 132 * PARAMETERS: ASL_WALK_CALLBACK 133 * 134 * RETURN: Status 135 * 136 * DESCRIPTION: Walk callback to initialize (and re-initialize) the node 137 * subtree length(s) to zero. The Subtree lengths are bubbled 138 * up to the root node in order to get a total AML length. 139 * 140 ******************************************************************************/ 141 142 ACPI_STATUS 143 LnInitLengthsWalk ( 144 ACPI_PARSE_OBJECT *Op, 145 UINT32 Level, 146 void *Context) 147 { 148 149 Op->Asl.AmlSubtreeLength = 0; 150 return (AE_OK); 151 } 152 153 154 /******************************************************************************* 155 * 156 * FUNCTION: LnPackageLengthWalk 157 * 158 * PARAMETERS: ASL_WALK_CALLBACK 159 * 160 * RETURN: Status 161 * 162 * DESCRIPTION: Walk callback to calculate the total AML length. 163 * 1) Calculate the AML lengths (opcode, package length, etc.) for 164 * THIS node. 165 * 2) Bubbble up all of these lengths to the parent node by summing 166 * them all into the parent subtree length. 167 * 168 * Note: The SubtreeLength represents the total AML length of all child nodes 169 * in all subtrees under a given node. Therefore, once this walk is 170 * complete, the Root Node subtree length is the AML length of the entire 171 * tree (and thus, the entire ACPI table) 172 * 173 ******************************************************************************/ 174 175 ACPI_STATUS 176 LnPackageLengthWalk ( 177 ACPI_PARSE_OBJECT *Op, 178 UINT32 Level, 179 void *Context) 180 { 181 182 /* Generate the AML lengths for this node */ 183 184 CgGenerateAmlLengths (Op); 185 186 /* Bubble up all lengths (this node and all below it) to the parent */ 187 188 if ((Op->Asl.Parent) && 189 (Op->Asl.ParseOpcode != PARSEOP_DEFAULT_ARG)) 190 { 191 Op->Asl.Parent->Asl.AmlSubtreeLength += (Op->Asl.AmlLength + 192 Op->Asl.AmlOpcodeLength + 193 Op->Asl.AmlPkgLenBytes + 194 Op->Asl.AmlSubtreeLength); 195 } 196 return (AE_OK); 197 } 198 199 200 /******************************************************************************* 201 * 202 * FUNCTION: LnAdjustLengthToRoot 203 * 204 * PARAMETERS: Op - Node whose Length was changed 205 * 206 * RETURN: None. 207 * 208 * DESCRIPTION: Change the Subtree length of the given node, and bubble the 209 * change all the way up to the root node. This allows for 210 * last second changes to a package length (for example, if the 211 * package length encoding gets shorter or longer.) 212 * 213 ******************************************************************************/ 214 215 void 216 LnAdjustLengthToRoot ( 217 ACPI_PARSE_OBJECT *SubtreeOp, 218 UINT32 LengthDelta) 219 { 220 ACPI_PARSE_OBJECT *Op; 221 222 223 /* Adjust all subtree lengths up to the root */ 224 225 Op = SubtreeOp->Asl.Parent; 226 while (Op) 227 { 228 Op->Asl.AmlSubtreeLength -= LengthDelta; 229 Op = Op->Asl.Parent; 230 } 231 232 /* Adjust the global table length */ 233 234 Gbl_TableLength -= LengthDelta; 235 } 236 237 238 /******************************************************************************* 239 * 240 * FUNCTION: CgGetPackageLenByteCount 241 * 242 * PARAMETERS: Op - Parse node 243 * PackageLength - Length to be encoded 244 * 245 * RETURN: Required length of the package length encoding 246 * 247 * DESCRIPTION: Calculate the number of bytes required to encode the given 248 * package length. 249 * 250 ******************************************************************************/ 251 252 UINT8 253 CgGetPackageLenByteCount ( 254 ACPI_PARSE_OBJECT *Op, 255 UINT32 PackageLength) 256 { 257 258 /* 259 * Determine the number of bytes required to encode the package length 260 * Note: the package length includes the number of bytes used to encode 261 * the package length, so we must account for this also. 262 */ 263 if (PackageLength <= (0x0000003F - 1)) 264 { 265 return (1); 266 } 267 else if (PackageLength <= (0x00000FFF - 2)) 268 { 269 return (2); 270 } 271 else if (PackageLength <= (0x000FFFFF - 3)) 272 { 273 return (3); 274 } 275 else if (PackageLength <= (0x0FFFFFFF - 4)) 276 { 277 return (4); 278 } 279 else 280 { 281 /* Fatal error - the package length is too large to encode */ 282 283 AslError (ASL_ERROR, ASL_MSG_ENCODING_LENGTH, Op, NULL); 284 } 285 286 return (0); 287 } 288 289 290 /******************************************************************************* 291 * 292 * FUNCTION: CgGenerateAmlOpcodeLength 293 * 294 * PARAMETERS: Op - Parse node whose AML opcode lengths will be 295 * calculated 296 * 297 * RETURN: None. 298 * 299 * DESCRIPTION: Calculate the AmlOpcodeLength, AmlPkgLenBytes, and AmlLength 300 * fields for this node. 301 * 302 ******************************************************************************/ 303 304 void 305 CgGenerateAmlOpcodeLength ( 306 ACPI_PARSE_OBJECT *Op) 307 { 308 309 /* Check for two-byte opcode */ 310 311 if (Op->Asl.AmlOpcode > 0x00FF) 312 { 313 Op->Asl.AmlOpcodeLength = 2; 314 } 315 else 316 { 317 Op->Asl.AmlOpcodeLength = 1; 318 } 319 320 /* Does this opcode have an associated "PackageLength" field? */ 321 322 Op->Asl.AmlPkgLenBytes = 0; 323 if (Op->Asl.CompileFlags & NODE_AML_PACKAGE) 324 { 325 Op->Asl.AmlPkgLenBytes = CgGetPackageLenByteCount (Op, Op->Asl.AmlSubtreeLength); 326 } 327 328 /* Data opcode lengths are easy */ 329 330 switch (Op->Asl.AmlOpcode) 331 { 332 case AML_BYTE_OP: 333 334 Op->Asl.AmlLength = 1; 335 break; 336 337 case AML_WORD_OP: 338 339 Op->Asl.AmlLength = 2; 340 break; 341 342 case AML_DWORD_OP: 343 344 Op->Asl.AmlLength = 4; 345 break; 346 347 case AML_QWORD_OP: 348 349 Op->Asl.AmlLength = 8; 350 break; 351 352 default: 353 /* All data opcodes must be above */ 354 break; 355 } 356 } 357 358 359 /******************************************************************************* 360 * 361 * FUNCTION: CgGenerateAmlLengths 362 * 363 * PARAMETERS: Op - Parse node 364 * 365 * RETURN: None. 366 * 367 * DESCRIPTION: Generate internal length fields based on the AML opcode or 368 * parse opcode. 369 * 370 ******************************************************************************/ 371 372 void 373 CgGenerateAmlLengths ( 374 ACPI_PARSE_OBJECT *Op) 375 { 376 char *Buffer; 377 ACPI_STATUS Status; 378 379 380 switch (Op->Asl.AmlOpcode) 381 { 382 case AML_RAW_DATA_BYTE: 383 384 Op->Asl.AmlOpcodeLength = 0; 385 Op->Asl.AmlLength = 1; 386 return; 387 388 case AML_RAW_DATA_WORD: 389 390 Op->Asl.AmlOpcodeLength = 0; 391 Op->Asl.AmlLength = 2; 392 return; 393 394 case AML_RAW_DATA_DWORD: 395 396 Op->Asl.AmlOpcodeLength = 0; 397 Op->Asl.AmlLength = 4; 398 return; 399 400 case AML_RAW_DATA_QWORD: 401 402 Op->Asl.AmlOpcodeLength = 0; 403 Op->Asl.AmlLength = 8; 404 return; 405 406 case AML_RAW_DATA_BUFFER: 407 408 /* Aml length is/was set by creator */ 409 410 Op->Asl.AmlOpcodeLength = 0; 411 return; 412 413 case AML_RAW_DATA_CHAIN: 414 415 /* Aml length is/was set by creator */ 416 417 Op->Asl.AmlOpcodeLength = 0; 418 return; 419 420 default: 421 break; 422 } 423 424 switch (Op->Asl.ParseOpcode) 425 { 426 case PARSEOP_DEFINITIONBLOCK: 427 428 Gbl_TableLength = sizeof (ACPI_TABLE_HEADER) + Op->Asl.AmlSubtreeLength; 429 break; 430 431 case PARSEOP_NAMESEG: 432 433 Op->Asl.AmlOpcodeLength = 0; 434 Op->Asl.AmlLength = 4; 435 Op->Asl.ExternalName = Op->Asl.Value.String; 436 break; 437 438 case PARSEOP_NAMESTRING: 439 case PARSEOP_METHODCALL: 440 441 if (Op->Asl.CompileFlags & NODE_NAME_INTERNALIZED) 442 { 443 break; 444 } 445 446 Op->Asl.AmlOpcodeLength = 0; 447 Status = UtInternalizeName (Op->Asl.Value.String, &Buffer); 448 if (ACPI_FAILURE (Status)) 449 { 450 DbgPrint (ASL_DEBUG_OUTPUT, 451 "Failure from internalize name %X\n", Status); 452 break; 453 } 454 455 Op->Asl.ExternalName = Op->Asl.Value.String; 456 Op->Asl.Value.String = Buffer; 457 Op->Asl.CompileFlags |= NODE_NAME_INTERNALIZED; 458 459 Op->Asl.AmlLength = strlen (Buffer); 460 461 /* 462 * Check for single backslash reference to root, 463 * make it a null terminated string in the AML 464 */ 465 if (Op->Asl.AmlLength == 1) 466 { 467 Op->Asl.AmlLength = 2; 468 } 469 break; 470 471 case PARSEOP_STRING_LITERAL: 472 473 Op->Asl.AmlOpcodeLength = 1; 474 Op->Asl.AmlLength = strlen (Op->Asl.Value.String) + 1; /* Get null terminator */ 475 break; 476 477 case PARSEOP_PACKAGE_LENGTH: 478 479 Op->Asl.AmlOpcodeLength = 0; 480 Op->Asl.AmlPkgLenBytes = CgGetPackageLenByteCount (Op, (UINT32) Op->Asl.Value.Integer); 481 break; 482 483 case PARSEOP_RAW_DATA: 484 485 Op->Asl.AmlOpcodeLength = 0; 486 break; 487 488 case PARSEOP_DEFAULT_ARG: 489 case PARSEOP_EXTERNAL: 490 case PARSEOP_INCLUDE: 491 case PARSEOP_INCLUDE_END: 492 493 /* Ignore the "default arg" nodes, they are extraneous at this point */ 494 495 break; 496 497 default: 498 499 CgGenerateAmlOpcodeLength (Op); 500 break; 501 } 502 } 503 504 505