/****************************************************************************** * * Module Name: asllistsup - Listing file support utilities * *****************************************************************************/ /****************************************************************************** * * 1. Copyright Notice * * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp. * All rights reserved. * * 2. License * * 2.1. This is your license from Intel Corp. under its intellectual property * rights. You may have additional license terms from the party that provided * you this software, covering your right to use that party's intellectual * property rights. * * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a * copy of the source code appearing in this file ("Covered Code") an * irrevocable, perpetual, worldwide license under Intel's copyrights in the * base code distributed originally by Intel ("Original Intel Code") to copy, * make derivatives, distribute, use and display any portion of the Covered * Code in any form, with the right to sublicense such rights; and * * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent * license (with the right to sublicense), under only those claims of Intel * patents that are infringed by the Original Intel Code, to make, use, sell, * offer to sell, and import the Covered Code and derivative works thereof * solely to the minimum extent necessary to exercise the above copyright * license, and in no event shall the patent license extend to any additions * to or modifications of the Original Intel Code. No other license or right * is granted directly or by implication, estoppel or otherwise; * * The above copyright and patent license is granted only if the following * conditions are met: * * 3. Conditions * * 3.1. Redistribution of Source with Rights to Further Distribute Source. * Redistribution of source code of any substantial portion of the Covered * Code or modification with rights to further distribute source must include * the above Copyright Notice, the above License, this list of Conditions, * and the following Disclaimer and Export Compliance provision. In addition, * Licensee must cause all Covered Code to which Licensee contributes to * contain a file documenting the changes Licensee made to create that Covered * Code and the date of any change. Licensee must include in that file the * documentation of any changes made by any predecessor Licensee. Licensee * must include a prominent statement that the modification is derived, * directly or indirectly, from Original Intel Code. * * 3.2. Redistribution of Source with no Rights to Further Distribute Source. * Redistribution of source code of any substantial portion of the Covered * Code or modification without rights to further distribute source must * include the following Disclaimer and Export Compliance provision in the * documentation and/or other materials provided with distribution. In * addition, Licensee may not authorize further sublicense of source of any * portion of the Covered Code, and must include terms to the effect that the * license from Licensee to its licensee is limited to the intellectual * property embodied in the software Licensee provides to its licensee, and * not to intellectual property embodied in modifications its licensee may * make. * * 3.3. Redistribution of Executable. Redistribution in executable form of any * substantial portion of the Covered Code or modification must reproduce the * above Copyright Notice, and the following Disclaimer and Export Compliance * provision in the documentation and/or other materials provided with the * distribution. * * 3.4. Intel retains all right, title, and interest in and to the Original * Intel Code. * * 3.5. Neither the name Intel nor any other trademark owned or controlled by * Intel shall be used in advertising or otherwise to promote the sale, use or * other dealings in products derived from or relating to the Covered Code * without prior written authorization from Intel. * * 4. Disclaimer and Export Compliance * * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A * PARTICULAR PURPOSE. * * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY * LIMITED REMEDY. * * 4.3. Licensee shall not export, either directly or indirectly, any of this * software or system incorporating such software without first obtaining any * required license or other approval from the U. S. Department of Commerce or * any other agency or department of the United States Government. In the * event Licensee exports any such software from the United States or * re-exports any such software from a foreign destination, Licensee shall * ensure that the distribution and export/re-export of the software is in * compliance with all laws, regulations, orders, or other restrictions of the * U.S. Export Administration Regulations. Licensee agrees that neither it nor * any of its subsidiaries will export/re-export any technical data, process, * software, or service, directly or indirectly, to any country for which the * United States government or any agency thereof requires an export license, * other governmental approval, or letter of assurance, without first obtaining * such license, approval or letter. * ***************************************************************************** * * Alternatively, you may choose to be licensed under the terms of the * following license: * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions, and the following disclaimer, * without modification. * 2. Redistributions in binary form must reproduce at minimum a disclaimer * substantially similar to the "NO WARRANTY" disclaimer below * ("Disclaimer") and any redistribution must be conditioned upon * including a substantially similar Disclaimer requirement for further * binary redistribution. * 3. Neither the names of the above-listed copyright holders nor the names * of any contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * * Alternatively, you may choose to be licensed under the terms of the * GNU General Public License ("GPL") version 2 as published by the Free * Software Foundation. * *****************************************************************************/ #include "aslcompiler.h" #include "aslcompiler.y.h" #define _COMPONENT ACPI_COMPILER ACPI_MODULE_NAME ("aslistsup") /******************************************************************************* * * FUNCTION: LsDumpAscii * * PARAMETERS: FileId - ID of current listing file * Count - Number of bytes to convert * Buffer - Buffer of bytes to convert * * RETURN: None * * DESCRIPTION: Convert hex bytes to ascii * ******************************************************************************/ void LsDumpAscii ( UINT32 FileId, UINT32 Count, UINT8 *Buffer) { UINT8 BufChar; UINT32 i; FlPrintFile (FileId, " \""); for (i = 0; i < Count; i++) { BufChar = Buffer[i]; if (isprint (BufChar)) { FlPrintFile (FileId, "%c", BufChar); } else { /* Not a printable character, just put out a dot */ FlPrintFile (FileId, "."); } } FlPrintFile (FileId, "\""); } /******************************************************************************* * * FUNCTION: LsDumpAsciiInComment * * PARAMETERS: FileId - ID of current listing file * Count - Number of bytes to convert * Buffer - Buffer of bytes to convert * * RETURN: None * * DESCRIPTION: Convert hex bytes to ascii * ******************************************************************************/ void LsDumpAsciiInComment ( UINT32 FileId, UINT32 Count, UINT8 *Buffer) { UINT8 BufChar = 0; UINT8 LastChar; UINT32 i; FlPrintFile (FileId, " \""); for (i = 0; i < Count; i++) { LastChar = BufChar; BufChar = Buffer[i]; if (isprint (BufChar)) { /* Handle embedded C comment sequences */ if (((LastChar == '*') && (BufChar == '/')) || ((LastChar == '/') && (BufChar == '*'))) { /* Insert a space to break the sequence */ FlPrintFile (FileId, ".", BufChar); } FlPrintFile (FileId, "%c", BufChar); } else { /* Not a printable character, just put out a dot */ FlPrintFile (FileId, "."); } } FlPrintFile (FileId, "\""); } /******************************************************************************* * * FUNCTION: LsCheckException * * PARAMETERS: LineNumber - Current logical (cumulative) line # * FileId - ID of output listing file * * RETURN: None * * DESCRIPTION: Check if there is an exception for this line, and if there is, * put it in the listing immediately. Handles multiple errors * per line. Gbl_NextError points to the next error in the * sorted (by line #) list of compile errors/warnings. * ******************************************************************************/ void LsCheckException ( UINT32 LineNumber, UINT32 FileId) { if ((!Gbl_NextError) || (LineNumber < Gbl_NextError->LogicalLineNumber )) { return; } /* Handle multiple errors per line */ if (FileId == ASL_FILE_LISTING_OUTPUT) { while (Gbl_NextError && (LineNumber >= Gbl_NextError->LogicalLineNumber)) { AePrintException (FileId, Gbl_NextError, "\n[****iasl****]\n"); Gbl_NextError = Gbl_NextError->Next; } FlPrintFile (FileId, "\n"); } } /******************************************************************************* * * FUNCTION: LsWriteListingHexBytes * * PARAMETERS: Buffer - AML code buffer * Length - Number of AML bytes to write * FileId - ID of current listing file. * * RETURN: None * * DESCRIPTION: Write the contents of the AML buffer to the listing file via * the listing buffer. The listing buffer is flushed every 16 * AML bytes. * ******************************************************************************/ void LsWriteListingHexBytes ( UINT8 *Buffer, UINT32 Length, UINT32 FileId) { UINT32 i; /* Transfer all requested bytes */ for (i = 0; i < Length; i++) { /* Print line header when buffer is empty */ if (Gbl_CurrentHexColumn == 0) { if (Gbl_HasIncludeFiles) { FlPrintFile (FileId, "%*s", 10, " "); } switch (FileId) { case ASL_FILE_LISTING_OUTPUT: FlPrintFile (FileId, "%8.8X%s", Gbl_CurrentAmlOffset, ASL_LISTING_LINE_PREFIX); break; case ASL_FILE_ASM_SOURCE_OUTPUT: FlPrintFile (FileId, " db "); break; case ASL_FILE_C_SOURCE_OUTPUT: FlPrintFile (FileId, " "); break; default: /* No other types supported */ return; } } /* Transfer AML byte and update counts */ Gbl_AmlBuffer[Gbl_CurrentHexColumn] = Buffer[i]; Gbl_CurrentHexColumn++; Gbl_CurrentAmlOffset++; /* Flush buffer when it is full */ if (Gbl_CurrentHexColumn >= HEX_LISTING_LINE_SIZE) { LsFlushListingBuffer (FileId); } } } /******************************************************************************* * * FUNCTION: LsWriteSourceLines * * PARAMETERS: ToLineNumber - * ToLogicalLineNumber - Write up to this source line number * FileId - ID of current listing file * * RETURN: None * * DESCRIPTION: Read then write source lines to the listing file until we have * reached the specified logical (cumulative) line number. This * automatically echos out comment blocks and other non-AML * generating text until we get to the actual AML-generating line * of ASL code specified by the logical line number. * ******************************************************************************/ void LsWriteSourceLines ( UINT32 ToLineNumber, UINT32 ToLogicalLineNumber, UINT32 FileId) { /* Nothing to do for these file types */ if ((FileId == ASL_FILE_ASM_INCLUDE_OUTPUT) || (FileId == ASL_FILE_C_INCLUDE_OUTPUT)) { return; } Gbl_CurrentLine = ToLogicalLineNumber; /* Flush any hex bytes remaining from the last opcode */ LsFlushListingBuffer (FileId); /* Read lines and write them as long as we are not caught up */ if (Gbl_SourceLine < Gbl_CurrentLine) { /* * If we just completed writing some AML hex bytes, output a linefeed * to add some whitespace for readability. */ if (Gbl_HexBytesWereWritten) { FlPrintFile (FileId, "\n"); Gbl_HexBytesWereWritten = FALSE; } if (FileId == ASL_FILE_C_SOURCE_OUTPUT) { FlPrintFile (FileId, " /*\n"); } /* Write one line at a time until we have reached the target line # */ while ((Gbl_SourceLine < Gbl_CurrentLine) && LsWriteOneSourceLine (FileId)) { ; } if (FileId == ASL_FILE_C_SOURCE_OUTPUT) { FlPrintFile (FileId, " */"); } FlPrintFile (FileId, "\n"); } } /******************************************************************************* * * FUNCTION: LsWriteOneSourceLine * * PARAMETERS: FileId - ID of current listing file * * RETURN: FALSE on EOF (input source file), TRUE otherwise * * DESCRIPTION: Read one line from the input source file and echo it to the * listing file, prefixed with the line number, and if the source * file contains include files, prefixed with the current filename * ******************************************************************************/ UINT32 LsWriteOneSourceLine ( UINT32 FileId) { UINT8 FileByte; UINT32 Column = 0; UINT32 Index = 16; BOOLEAN StartOfLine = FALSE; BOOLEAN ProcessLongLine = FALSE; Gbl_SourceLine++; Gbl_ListingNode->LineNumber++; /* Ignore lines that are completely blank (but count the line above) */ if (FlReadFile (ASL_FILE_SOURCE_OUTPUT, &FileByte, 1) != AE_OK) { return (0); } if (FileByte == '\n') { return (1); } /* * This is a non-empty line, we will print the entire line with * the line number and possibly other prefixes and transforms. */ /* Line prefixes for special files, C and ASM output */ if (FileId == ASL_FILE_C_SOURCE_OUTPUT) { FlPrintFile (FileId, " *"); } if (FileId == ASL_FILE_ASM_SOURCE_OUTPUT) { FlPrintFile (FileId, "; "); } if (Gbl_HasIncludeFiles) { /* * This file contains "include" statements, print the current * filename and line number within the current file */ FlPrintFile (FileId, "%12s %5d%s", Gbl_ListingNode->Filename, Gbl_ListingNode->LineNumber, ASL_LISTING_LINE_PREFIX); } else { /* No include files, just print the line number */ FlPrintFile (FileId, "%8u%s", Gbl_SourceLine, ASL_LISTING_LINE_PREFIX); } /* Read the rest of this line (up to a newline or EOF) */ do { if (FileId == ASL_FILE_C_SOURCE_OUTPUT) { if (FileByte == '/') { FileByte = '*'; } } /* Split long input lines for readability in the listing */ Column++; if (Column >= 128) { if (!ProcessLongLine) { if ((FileByte != '}') && (FileByte != '{')) { goto WriteByte; } ProcessLongLine = TRUE; } if (FileByte == '{') { FlPrintFile (FileId, "\n%*s{\n", Index, " "); StartOfLine = TRUE; Index += 4; continue; } else if (FileByte == '}') { if (!StartOfLine) { FlPrintFile (FileId, "\n"); } StartOfLine = TRUE; Index -= 4; FlPrintFile (FileId, "%*s}\n", Index, " "); continue; } /* Ignore spaces/tabs at the start of line */ else if ((FileByte == ' ') && StartOfLine) { continue; } else if (StartOfLine) { StartOfLine = FALSE; FlPrintFile (FileId, "%*s", Index, " "); } WriteByte: FlWriteFile (FileId, &FileByte, 1); if (FileByte == '\n') { /* * This line has been completed. * Check if an error occurred on this source line during the compile. * If so, we print the error message after the source line. */ LsCheckException (Gbl_SourceLine, FileId); return (1); } } else { FlWriteFile (FileId, &FileByte, 1); if (FileByte == '\n') { /* * This line has been completed. * Check if an error occurred on this source line during the compile. * If so, we print the error message after the source line. */ LsCheckException (Gbl_SourceLine, FileId); return (1); } } } while (FlReadFile (ASL_FILE_SOURCE_OUTPUT, &FileByte, 1) == AE_OK); /* EOF on the input file was reached */ return (0); } /******************************************************************************* * * FUNCTION: LsFlushListingBuffer * * PARAMETERS: FileId - ID of the listing file * * RETURN: None * * DESCRIPTION: Flush out the current contents of the 16-byte hex AML code * buffer. Usually called at the termination of a single line * of source code or when the buffer is full. * ******************************************************************************/ void LsFlushListingBuffer ( UINT32 FileId) { UINT32 i; if (Gbl_CurrentHexColumn == 0) { return; } /* Write the hex bytes */ switch (FileId) { case ASL_FILE_LISTING_OUTPUT: for (i = 0; i < Gbl_CurrentHexColumn; i++) { FlPrintFile (FileId, "%2.2X ", Gbl_AmlBuffer[i]); } for (i = 0; i < ((HEX_LISTING_LINE_SIZE - Gbl_CurrentHexColumn) * 3); i++) { FlWriteFile (FileId, ".", 1); } /* Write the ASCII character associated with each of the bytes */ LsDumpAscii (FileId, Gbl_CurrentHexColumn, Gbl_AmlBuffer); break; case ASL_FILE_ASM_SOURCE_OUTPUT: for (i = 0; i < Gbl_CurrentHexColumn; i++) { if (i > 0) { FlPrintFile (FileId, ","); } FlPrintFile (FileId, "0%2.2Xh", Gbl_AmlBuffer[i]); } for (i = 0; i < ((HEX_LISTING_LINE_SIZE - Gbl_CurrentHexColumn) * 5); i++) { FlWriteFile (FileId, " ", 1); } FlPrintFile (FileId, " ;%8.8X", Gbl_CurrentAmlOffset - HEX_LISTING_LINE_SIZE); /* Write the ASCII character associated with each of the bytes */ LsDumpAscii (FileId, Gbl_CurrentHexColumn, Gbl_AmlBuffer); break; case ASL_FILE_C_SOURCE_OUTPUT: for (i = 0; i < Gbl_CurrentHexColumn; i++) { FlPrintFile (FileId, "0x%2.2X,", Gbl_AmlBuffer[i]); } /* Pad hex output with spaces if line is shorter than max line size */ for (i = 0; i < ((HEX_LISTING_LINE_SIZE - Gbl_CurrentHexColumn) * 5); i++) { FlWriteFile (FileId, " ", 1); } /* AML offset for the start of the line */ FlPrintFile (FileId, " /* %8.8X", Gbl_CurrentAmlOffset - Gbl_CurrentHexColumn); /* Write the ASCII character associated with each of the bytes */ LsDumpAsciiInComment (FileId, Gbl_CurrentHexColumn, Gbl_AmlBuffer); FlPrintFile (FileId, " */"); break; default: /* No other types supported */ return; } FlPrintFile (FileId, "\n"); Gbl_CurrentHexColumn = 0; Gbl_HexBytesWereWritten = TRUE; } /******************************************************************************* * * FUNCTION: LsPushNode * * PARAMETERS: Filename - Pointer to the include filename * * RETURN: None * * DESCRIPTION: Push a listing node on the listing/include file stack. This * stack enables tracking of include files (infinitely nested) * and resumption of the listing of the parent file when the * include file is finished. * ******************************************************************************/ void LsPushNode ( char *Filename) { ASL_LISTING_NODE *Lnode; /* Create a new node */ Lnode = UtLocalCalloc (sizeof (ASL_LISTING_NODE)); /* Initialize */ Lnode->Filename = Filename; Lnode->LineNumber = 0; /* Link (push) */ Lnode->Next = Gbl_ListingNode; Gbl_ListingNode = Lnode; } /******************************************************************************* * * FUNCTION: LsPopNode * * PARAMETERS: None * * RETURN: List head after current head is popped off * * DESCRIPTION: Pop the current head of the list, free it, and return the * next node on the stack (the new current node). * ******************************************************************************/ ASL_LISTING_NODE * LsPopNode ( void) { ASL_LISTING_NODE *Lnode; /* Just grab the node at the head of the list */ Lnode = Gbl_ListingNode; if ((!Lnode) || (!Lnode->Next)) { AslError (ASL_ERROR, ASL_MSG_COMPILER_INTERNAL, NULL, "Could not pop empty listing stack"); return (Gbl_ListingNode); } Gbl_ListingNode = Lnode->Next; ACPI_FREE (Lnode); /* New "Current" node is the new head */ return (Gbl_ListingNode); }