1 /****************************************************************************** 2 * 3 * Module Name: cvcompiler - ASL-/ASL+ converter functions 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2017, 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 "acparser.h" 154 #include "amlcode.h" 155 #include "acdebug.h" 156 #include "acconvert.h" 157 158 159 static void 160 CvPrintInclude( 161 ACPI_FILE_NODE *FNode, 162 UINT32 Level); 163 164 static BOOLEAN 165 CvListIsSingleton ( 166 ACPI_COMMENT_NODE *CommentList); 167 168 169 /******************************************************************************* 170 * 171 * FUNCTION: CvPrintOneCommentList 172 * 173 * PARAMETERS: CommentList 174 * Level 175 * 176 * RETURN: None 177 * 178 * DESCRIPTION: Prints all comments within the given list. 179 * This is referred as ASL_CV_PRINT_ONE_COMMENT_LIST. 180 * 181 ******************************************************************************/ 182 183 void 184 CvPrintOneCommentList ( 185 ACPI_COMMENT_NODE *CommentList, 186 UINT32 Level) 187 { 188 ACPI_COMMENT_NODE *Current = CommentList; 189 ACPI_COMMENT_NODE *Previous; 190 191 192 while (Current) 193 { 194 Previous = Current; 195 if (Current->Comment) 196 { 197 AcpiDmIndent(Level); 198 AcpiOsPrintf("%s\n", Current->Comment); 199 Current->Comment = NULL; 200 } 201 Current = Current->Next; 202 AcpiOsReleaseObject(AcpiGbl_RegCommentCache, Previous); 203 } 204 } 205 206 207 /******************************************************************************* 208 * 209 * FUNCTION: CvListIsSingleton 210 * 211 * PARAMETERS: CommentList -- check to see if this is a single item list. 212 * 213 * RETURN: BOOLEAN 214 * 215 * DESCRIPTION: Returns TRUE if CommentList only contains 1 node. 216 * 217 ******************************************************************************/ 218 219 static BOOLEAN 220 CvListIsSingleton ( 221 ACPI_COMMENT_NODE *CommentList) 222 223 { 224 if (!CommentList) 225 { 226 return FALSE; 227 } 228 else if (CommentList->Next) 229 { 230 return FALSE; 231 } 232 233 return TRUE; 234 } 235 236 237 /******************************************************************************* 238 * 239 * FUNCTION: CvPrintOneCommentType 240 * 241 * PARAMETERS: Op 242 * CommentType 243 * EndStr - String to print after printing the comment 244 * Level - indentation level for comment lists. 245 * 246 * RETURN: None 247 * 248 * DESCRIPTION: Prints all comments of CommentType within the given Op and 249 * clears the printed comment from the Op. 250 * This is referred as ASL_CV_PRINT_ONE_COMMENT. 251 * 252 ******************************************************************************/ 253 254 void 255 CvPrintOneCommentType ( 256 ACPI_PARSE_OBJECT *Op, 257 UINT8 CommentType, 258 char* EndStr, 259 UINT32 Level) 260 { 261 BOOLEAN CommentExists = FALSE; 262 char **CommentToPrint = NULL; 263 264 265 switch (CommentType) 266 { 267 case AML_COMMENT_STANDARD: 268 269 if (CvListIsSingleton (Op->Common.CommentList)) 270 { 271 CvPrintOneCommentList (Op->Common.CommentList, Level); 272 AcpiOsPrintf ("\n"); 273 } 274 else 275 { 276 CvPrintOneCommentList (Op->Common.CommentList, Level); 277 } 278 Op->Common.CommentList = NULL; 279 return; 280 281 case AML_COMMENT_ENDBLK: 282 283 if (Op->Common.EndBlkComment) 284 { 285 CvPrintOneCommentList (Op->Common.EndBlkComment, Level); 286 Op->Common.EndBlkComment = NULL; 287 AcpiDmIndent(Level); 288 } 289 return; 290 291 case AMLCOMMENT_INLINE: 292 293 CommentToPrint = &Op->Common.InlineComment; 294 break; 295 296 case AML_COMMENT_END_NODE: 297 298 CommentToPrint = &Op->Common.EndNodeComment; 299 break; 300 301 case AML_NAMECOMMENT: 302 303 CommentToPrint = &Op->Common.NameComment; 304 break; 305 306 case AML_COMMENT_CLOSE_BRACE: 307 308 CommentToPrint = &Op->Common.CloseBraceComment; 309 break; 310 311 default: 312 return; 313 } 314 315 if (*CommentToPrint) 316 { 317 AcpiOsPrintf ("%s", *CommentToPrint); 318 *CommentToPrint = NULL; 319 } 320 321 if (CommentExists && EndStr) 322 { 323 AcpiOsPrintf ("%s", EndStr); 324 } 325 } 326 327 328 /******************************************************************************* 329 * 330 * FUNCTION: CvCloseBraceWriteComment 331 * 332 * PARAMETERS: Op 333 * Level 334 * 335 * RETURN: none 336 * 337 * DESCRIPTION: Print a close brace } and any open brace comments associated 338 * with this parse object. 339 * This is referred as ASL_CV_CLOSE_BRACE. 340 * 341 ******************************************************************************/ 342 343 void 344 CvCloseBraceWriteComment( 345 ACPI_PARSE_OBJECT *Op, 346 UINT32 Level) 347 { 348 if (!Gbl_CaptureComments) 349 { 350 AcpiOsPrintf ("}"); 351 return; 352 } 353 354 CvPrintOneCommentType (Op, AML_COMMENT_ENDBLK, NULL, Level); 355 AcpiOsPrintf ("}"); 356 CvPrintOneCommentType (Op, AML_COMMENT_CLOSE_BRACE, NULL, Level); 357 } 358 359 360 /******************************************************************************* 361 * 362 * FUNCTION: CvCloseParenWriteComment 363 * 364 * PARAMETERS: Op 365 * Level 366 * 367 * RETURN: none 368 * 369 * DESCRIPTION: Print a closing paren ) and any end node comments associated 370 * with this parse object. 371 * This is referred as ASL_CV_CLOSE_PAREN. 372 * 373 ******************************************************************************/ 374 375 void 376 CvCloseParenWriteComment( 377 ACPI_PARSE_OBJECT *Op, 378 UINT32 Level) 379 { 380 if (!Gbl_CaptureComments) 381 { 382 AcpiOsPrintf (")"); 383 return; 384 } 385 386 /* 387 * If this op has a BLOCK_BRACE, then output the comment when the 388 * disassembler calls CvCloseBraceWriteComment 389 */ 390 if (AcpiDmBlockType (Op) == BLOCK_PAREN) 391 { 392 CvPrintOneCommentType (Op, AML_COMMENT_ENDBLK, NULL, Level); 393 } 394 395 AcpiOsPrintf (")"); 396 397 if (Op->Common.EndNodeComment) 398 { 399 CvPrintOneCommentType (Op, AML_COMMENT_END_NODE, NULL, Level); 400 } 401 else if ((Op->Common.Parent->Common.AmlOpcode == AML_IF_OP) && 402 Op->Common.Parent->Common.EndNodeComment) 403 { 404 CvPrintOneCommentType (Op->Common.Parent, 405 AML_COMMENT_END_NODE, NULL, Level); 406 } 407 } 408 409 410 /******************************************************************************* 411 * 412 * FUNCTION: CvFileHasSwitched 413 * 414 * PARAMETERS: Op 415 * 416 * RETURN: BOOLEAN 417 * 418 * DESCRIPTION: Determine whether if a file has switched. 419 * TRUE - file has switched. 420 * FALSE - file has not switched. 421 * This is referred as ASL_CV_FILE_HAS_SWITCHED. 422 * 423 ******************************************************************************/ 424 425 BOOLEAN 426 CvFileHasSwitched( 427 ACPI_PARSE_OBJECT *Op) 428 { 429 if (Op->Common.CvFilename && 430 AcpiGbl_CurrentFilename && 431 AcpiUtStricmp(Op->Common.CvFilename, AcpiGbl_CurrentFilename)) 432 { 433 return TRUE; 434 } 435 return FALSE; 436 } 437 438 439 /******************************************************************************* 440 * 441 * FUNCTION: CvPrintInclude 442 * 443 * PARAMETERS: FNode - Write an Include statement for the file that is pointed 444 * by FNode->File. 445 * Level - indentation level 446 * 447 * RETURN: None 448 * 449 * DESCRIPTION: Write the ASL Include statement for FNode->File in the file 450 * indicated by FNode->Parent->File. Note this function emits 451 * actual ASL code rather than comments. This switches the output 452 * file to FNode->Parent->File. 453 * 454 ******************************************************************************/ 455 456 static void 457 CvPrintInclude( 458 ACPI_FILE_NODE *FNode, 459 UINT32 Level) 460 { 461 if (!FNode || FNode->IncludeWritten) 462 { 463 return; 464 } 465 466 CvDbgPrint ("Writing include for %s within %s\n", FNode->Filename, FNode->Parent->Filename); 467 AcpiOsRedirectOutput (FNode->Parent->File); 468 CvPrintOneCommentList (FNode->IncludeComment, Level); 469 AcpiDmIndent (Level); 470 AcpiOsPrintf ("Include (\"%s\")\n", FNode->Filename); 471 CvDbgPrint ("emitted the following: Include (\"%s\")\n", FNode->Filename); 472 FNode->IncludeWritten = TRUE; 473 } 474 475 476 /******************************************************************************* 477 * 478 * FUNCTION: CvSwitchFiles 479 * 480 * PARAMETERS: Level - indentation level 481 * Op 482 * 483 * RETURN: None 484 * 485 * DESCRIPTION: Switch the outputfile and write ASL Include statement. Note, 486 * this function emits actual ASL code rather than comments. 487 * This is referred as ASL_CV_SWITCH_FILES. 488 * 489 ******************************************************************************/ 490 491 void 492 CvSwitchFiles( 493 UINT32 Level, 494 ACPI_PARSE_OBJECT *Op) 495 { 496 char *Filename = Op->Common.CvFilename; 497 ACPI_FILE_NODE *FNode; 498 499 CvDbgPrint ("Switching from %s to %s\n", AcpiGbl_CurrentFilename, Filename); 500 FNode = CvFilenameExists (Filename, AcpiGbl_FileTreeRoot); 501 if (!FNode) 502 { 503 /* 504 * At this point, each Filename should exist in AcpiGbl_FileTreeRoot 505 * if it does not exist, then abort. 506 */ 507 FlDeleteFile (ASL_FILE_AML_OUTPUT); 508 sprintf (MsgBuffer, "\"Cannot find %s\" - %s", Filename, strerror (errno)); 509 AslCommonError (ASL_ERROR, ASL_MSG_OPEN, 0, 0, 0, 0, NULL, MsgBuffer); 510 AslAbort (); 511 } 512 513 /* 514 * If the previous file is a descendent of the current file, 515 * make sure that Include statements from the current file 516 * to the previous have been emitted. 517 */ 518 while (FNode && 519 FNode->Parent && 520 AcpiUtStricmp (FNode->Filename, AcpiGbl_CurrentFilename)) 521 { 522 CvPrintInclude (FNode, Level); 523 FNode = FNode->Parent; 524 } 525 526 /* Redirect output to the Op->Common.CvFilename */ 527 528 FNode = CvFilenameExists (Filename, AcpiGbl_FileTreeRoot); 529 AcpiOsRedirectOutput (FNode->File); 530 AcpiGbl_CurrentFilename = FNode->Filename; 531 } 532