Subversion Repositories Kolibri OS

 *

 * Module Name: aslutils -- compiler utilities

 *

 *****************************************************************************/

 *

 * 1. Copyright Notice

 *

 * Some or all of this work - Copyright (c) 1999 - 2011, 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.

 *

 *****************************************************************************/

#include "aslcompiler.y.h"

#include "acdisasm.h"

#include "acnamesp.h"

#include "amlcode.h"

#include 

        ACPI_MODULE_NAME    ("aslutils")

{

    '0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'

};

UtPadNameWithUnderscores (

    char                    *NameSeg,

    char                    *PaddedNameSeg);

UtAttachNameseg (

    ACPI_PARSE_OBJECT       *Op,

    char                    *Name);

 *

 * FUNCTION:    UtDisplaySupportedTables

 *

 * PARAMETERS:  None

 *

 * RETURN:      None

 *

 * DESCRIPTION: Print all supported ACPI table names.

 *

 ******************************************************************************/

UtDisplaySupportedTables (

    void)

{

    ACPI_DMTABLE_DATA       *TableData;

    UINT32                  i = 6;

        "version %8.8X:\n"

        "  ASL and Data Table compilers\n"

        "  AML and Data Table disassemblers\n"

        "  ACPI table template generator\n\n", ACPI_CA_VERSION);

    printf ("%8u) %s    %s\n", 2, ACPI_SIG_SSDT, "Secondary System Description Table");

    printf ("%8u) %s    %s\n", 3, ACPI_SIG_FADT, "Fixed ACPI Description Table (FADT)");

    printf ("%8u) %s    %s\n", 4, ACPI_SIG_FACS, "Firmware ACPI Control Structure");

    printf ("%8u) %s    %s\n", 5, ACPI_RSDP_NAME, "Root System Description Pointer");

    {

        printf ("%8u) %s    %s\n", i, TableData->Signature, TableData->Name);

        i++;

    }

}

 *

 * FUNCTION:    AcpiPsDisplayConstantOpcodes

 *

 * PARAMETERS:  None

 *

 * RETURN:      None

 *

 * DESCRIPTION: Print AML opcodes that can be used in constant expressions.

 *

 ******************************************************************************/

UtDisplayConstantOpcodes (

    void)

{

    UINT32                  i;

    {

        if (AcpiGbl_AmlOpInfo[i].Flags & AML_CONSTANT)

        {

            printf ("%s\n", AcpiGbl_AmlOpInfo[i].Name);

        }

    }

}

 *

 * FUNCTION:    UtLocalCalloc

 *

 * PARAMETERS:  Size        - Bytes to be allocated

 *

 * RETURN:      Pointer to the allocated memory.  Guaranteed to be valid.

 *

 * DESCRIPTION: Allocate zero-initialized memory.  Aborts the compile on an

 *              allocation failure, on the assumption that nothing more can be

 *              accomplished.

 *

 ******************************************************************************/

UtLocalCalloc (

    UINT32                  Size)

{

    void                    *Allocated;

    if (!Allocated)

    {

        AslCommonError (ASL_ERROR, ASL_MSG_MEMORY_ALLOCATION,

            Gbl_CurrentLineNumber, Gbl_LogicalLineNumber,

            Gbl_InputByteCount, Gbl_CurrentColumn,

            Gbl_Files[ASL_FILE_INPUT].Filename, NULL);

        exit (1);

    }

    TotalAllocated += Size;

    return (Allocated);

}

 *

 * FUNCTION:    UtBeginEvent

 *

 * PARAMETERS:  Name        - Ascii name of this event

 *

 * RETURN:      Event       - Event number (integer index)

 *

 * DESCRIPTION: Saves the current time with this event

 *

 ******************************************************************************/

UtBeginEvent (

    char                    *Name)

{

    {

        AcpiOsPrintf ("Ran out of compiler event structs!\n");

        return (AslGbl_NextEvent);

    }

    AslGbl_Events[AslGbl_NextEvent].EventName = Name;

    AslGbl_Events[AslGbl_NextEvent].Valid = TRUE;

}

 *

 * FUNCTION:    UtEndEvent

 *

 * PARAMETERS:  Event       - Event number (integer index)

 *

 * RETURN:      None

 *

 * DESCRIPTION: Saves the current time (end time) with this event

 *

 ******************************************************************************/

UtEndEvent (

    UINT8                  Event)

{

    {

        return;

    }

}

 *

 * FUNCTION:    UtHexCharToValue

 *

 * PARAMETERS:  HexChar         - Hex character in Ascii

 *

 * RETURN:      The binary value of the hex character

 *

 * DESCRIPTION: Perform ascii-to-hex translation

 *

 ******************************************************************************/

UtHexCharToValue (

    int                     HexChar)

{

    {

        return ((UINT8) (HexChar - 0x30));

    }

    {

        return ((UINT8) (HexChar - 0x37));

    }

}

 *

 * FUNCTION:    UtConvertByteToHex

 *

 * PARAMETERS:  RawByte         - Binary data

 *              Buffer          - Pointer to where the hex bytes will be stored

 *

 * RETURN:      Ascii hex byte is stored in Buffer.

 *

 * DESCRIPTION: Perform hex-to-ascii translation.  The return data is prefixed

 *              with "0x"

 *

 ******************************************************************************/

UtConvertByteToHex (

    UINT8                   RawByte,

    UINT8                   *Buffer)

{

    Buffer[1] = 'x';

    Buffer[3] = (UINT8) AslHexLookup[RawByte & 0xF];

}

 *

 * FUNCTION:    UtConvertByteToAsmHex

 *

 * PARAMETERS:  RawByte         - Binary data

 *              Buffer          - Pointer to where the hex bytes will be stored

 *

 * RETURN:      Ascii hex byte is stored in Buffer.

 *

 * DESCRIPTION: Perform hex-to-ascii translation.  The return data is prefixed

 *              with "0x"

 *

 ******************************************************************************/

UtConvertByteToAsmHex (

    UINT8                   RawByte,

    UINT8                   *Buffer)

{

    Buffer[1] = (UINT8) AslHexLookup[(RawByte >> 4) & 0xF];

    Buffer[2] = (UINT8) AslHexLookup[RawByte & 0xF];

    Buffer[3] = 'h';

}

 *

 * FUNCTION:    DbgPrint

 *

 * PARAMETERS:  Type            - Type of output

 *              Fmt             - Printf format string

 *              ...             - variable printf list

 *

 * RETURN:      None

 *

 * DESCRIPTION: Conditional print statement.  Prints to stderr only if the

 *              debug flag is set.

 *

 ******************************************************************************/

DbgPrint (

    UINT32                  Type,

    char                    *Fmt,

    ...)

{

    va_list                 Args;

    {

        return;

    }

        (!(AslCompilerdebug)))

    {

        return;

    }

    va_end (Args);

    return;

}

 *

 * FUNCTION:    UtPrintFormattedName

 *

 * PARAMETERS:  ParseOpcode         - Parser keyword ID

 *              Level               - Indentation level

 *

 * RETURN:      None

 *

 * DESCRIPTION: Print the ascii name of the parse opcode.

 *

 ******************************************************************************/

UtPrintFormattedName (

    UINT16                  ParseOpcode,

    UINT32                  Level)

{

    {

        DbgPrint (ASL_TREE_OUTPUT,

            "%*s", (3 * Level), " ");

    }

    DbgPrint (ASL_TREE_OUTPUT,

        " %-20.20s", UtGetOpName (ParseOpcode));

    {

        DbgPrint (ASL_TREE_OUTPUT,

            "%*s", (TEXT_OFFSET - Level) * 3, " ");

    }

}

 *

 * FUNCTION:    UtSetParseOpName

 *

 * PARAMETERS:  Op

 *

 * RETURN:      None

 *

 * DESCRIPTION: Insert the ascii name of the parse opcode

 *

 ******************************************************************************/

UtSetParseOpName (

    ACPI_PARSE_OBJECT       *Op)

{

        ACPI_MAX_PARSEOP_NAME);

}

 *

 * FUNCTION:    UtDisplaySummary

 *

 * PARAMETERS:  FileID          - ID of outpout file

 *

 * RETURN:      None

 *

 * DESCRIPTION: Display compilation statistics

 *

 ******************************************************************************/

UtDisplaySummary (

    UINT32                  FileId)

{

    {

        /* Compiler name and version number */

            ASL_COMPILER_NAME, (UINT32) ACPI_CA_VERSION, ACPI_WIDTH, __DATE__);

    }

    {

        FlPrintFile (FileId,

            "Table Input:   %s - %u lines, %u bytes, %u fields\n",

            Gbl_Files[ASL_FILE_INPUT].Filename, Gbl_CurrentLineNumber,

            Gbl_InputByteCount, Gbl_InputFieldCount);

        {

            FlPrintFile (FileId,

                "Binary Output: %s - %u bytes\n\n",

                Gbl_Files[ASL_FILE_AML_OUTPUT].Filename, Gbl_TableLength);

        }

    }

    else

    {

        /* Input/Output summary */

            "ASL Input:  %s - %u lines, %u bytes, %u keywords\n",

            Gbl_Files[ASL_FILE_INPUT].Filename, Gbl_CurrentLineNumber,

            Gbl_InputByteCount, TotalKeywords);

        {

            FlPrintFile (FileId,

                "AML Output: %s - %u bytes, %u named objects, %u executable opcodes\n\n",

                Gbl_Files[ASL_FILE_AML_OUTPUT].Filename, Gbl_TableLength,

                TotalNamedObjects, TotalExecutableOpcodes);

        }

    }

        "Compilation complete. %u Errors, %u Warnings, %u Remarks",

        Gbl_ExceptionCount[ASL_ERROR],

        Gbl_ExceptionCount[ASL_WARNING] +

            Gbl_ExceptionCount[ASL_WARNING2] +

            Gbl_ExceptionCount[ASL_WARNING3],

        Gbl_ExceptionCount[ASL_REMARK]);

    {

        FlPrintFile (FileId,

            ", %u Optimizations", Gbl_ExceptionCount[ASL_OPTIMIZATION]);

    }

}

 *

 * FUNCTION:    UtDisplaySummary

 *

 * PARAMETERS:  Op              - Integer parse node

 *              LowValue        - Smallest allowed value

 *              HighValue       - Largest allowed value

 *

 * RETURN:      Op if OK, otherwise NULL

 *

 * DESCRIPTION: Check integer for an allowable range

 *

 ******************************************************************************/

UtCheckIntegerRange (

    ACPI_PARSE_OBJECT       *Op,

    UINT32                  LowValue,

    UINT32                  HighValue)

{

    char                    *ParseError = NULL;

    char                    Buffer[64];

    {

        return NULL;

    }

    {

        ParseError = "Value below valid range";

        Op->Asl.Value.Integer = LowValue;

    }

    {

        ParseError = "Value above valid range";

        Op->Asl.Value.Integer = HighValue;

    }

    {

        sprintf (Buffer, "%s 0x%X-0x%X", ParseError, LowValue, HighValue);

        AslCompilererror (Buffer);

    }

}

 *

 * FUNCTION:    UtGetStringBuffer

 *

 * PARAMETERS:  Length          - Size of buffer requested

 *

 * RETURN:      Pointer to the buffer.  Aborts on allocation failure

 *

 * DESCRIPTION: Allocate a string buffer.  Bypass the local

 *              dynamic memory manager for performance reasons (This has a

 *              major impact on the speed of the compiler.)

 *

 ******************************************************************************/

UtGetStringBuffer (

    UINT32                  Length)

{

    char                    *Buffer;

    {

        Gbl_StringCacheNext = UtLocalCalloc (ASL_STRING_CACHE_SIZE + Length);

        Gbl_StringCacheLast = Gbl_StringCacheNext + ASL_STRING_CACHE_SIZE +

                                Length;

    }

    Gbl_StringCacheNext += Length;

}

 *

 * FUNCTION:    UtInternalizeName

 *

 * PARAMETERS:  ExternalName            - Name to convert

 *              ConvertedName           - Where the converted name is returned

 *

 * RETURN:      Status

 *

 * DESCRIPTION: Convert an external (ASL) name to an internal (AML) name

 *

 ******************************************************************************/

UtInternalizeName (

    char                    *ExternalName,

    char                    **ConvertedName)

{

    ACPI_NAMESTRING_INFO    Info;

    ACPI_STATUS             Status;

    {

        return (AE_OK);

    }

    AcpiNsGetInternalNameLength (&Info);

    if (!Info.InternalName)

    {

        return (AE_NO_MEMORY);

    }

    if (ACPI_FAILURE (Status))

    {

        return (Status);

    }

    return (AE_OK);

}

 *

 * FUNCTION:    UtPadNameWithUnderscores

 *

 * PARAMETERS:  NameSeg         - Input nameseg

 *              PaddedNameSeg   - Output padded nameseg

 *

 * RETURN:      Padded nameseg.

 *

 * DESCRIPTION: Pads a NameSeg with underscores if necessary to form a full

 *              ACPI_NAME.

 *

 ******************************************************************************/

UtPadNameWithUnderscores (

    char                    *NameSeg,

    char                    *PaddedNameSeg)

{

    UINT32                  i;

    {

        if (*NameSeg)

        {

            *PaddedNameSeg = *NameSeg;

            NameSeg++;

        }

        else

        {

            *PaddedNameSeg = '_';

        }

        PaddedNameSeg++;

    }

}

 *

 * FUNCTION:    UtAttachNameseg

 *

 * PARAMETERS:  Op              - Parent parse node

 *              Name            - Full ExternalName

 *

 * RETURN:      None; Sets the NameSeg field in parent node

 *

 * DESCRIPTION: Extract the last nameseg of the ExternalName and store it

 *              in the NameSeg field of the Op.

 *

 ******************************************************************************/

UtAttachNameseg (

    ACPI_PARSE_OBJECT       *Op,

    char                    *Name)

{

    char                    *NameSeg;

    char                    PaddedNameSeg[4];

    {

        return;

    }

    if (NameSeg)

    {

        /* Found last dot, we have also found the final nameseg */

        UtPadNameWithUnderscores (NameSeg, PaddedNameSeg);

    }

    else

    {

        /* No dots in the namepath, there is only a single nameseg. */

        /* Handle prefixes */

        {

            Name++;

        }

    }

}

 *

 * FUNCTION:    UtAttachNamepathToOwner

 *

 * PARAMETERS:  Op            - Parent parse node

 *              NameOp        - Node that contains the name

 *

 * RETURN:      Sets the ExternalName and Namepath in the parent node

 *

 * DESCRIPTION: Store the name in two forms in the parent node:  The original

 *              (external) name, and the internalized name that is used within

 *              the ACPI namespace manager.

 *

 ******************************************************************************/

UtAttachNamepathToOwner (

    ACPI_PARSE_OBJECT       *Op,

    ACPI_PARSE_OBJECT       *NameOp)

{

    ACPI_STATUS             Status;

    if (ACPI_FAILURE (Status))

    {

        /* TBD: abort on no memory */

    }

}

 *

 * FUNCTION:    UtDoConstant

 *

 * PARAMETERS:  String      - Hex, Octal, or Decimal string

 *

 * RETURN:      Converted Integer

 *

 * DESCRIPTION: Convert a string to an integer.  With error checking.

 *

 ******************************************************************************/

UtDoConstant (

    char                    *String)

{

    ACPI_STATUS             Status;

    UINT64                  Converted;

    char                    ErrBuf[64];

    if (ACPI_FAILURE (Status))

    {

        sprintf (ErrBuf, "%s %s\n", "Conversion error:",

            AcpiFormatException (Status));

        AslCompilererror (ErrBuf);

    }

}

 *

 * FUNCTION:    UtStrtoul64

 *

 * PARAMETERS:  String          - Null terminated string

 *              Terminater      - Where a pointer to the terminating byte is

 *                                returned

 *              Base            - Radix of the string

 *

 * RETURN:      Converted value

 *

 * DESCRIPTION: Convert a string into an unsigned value.

 *

 ******************************************************************************/

UtStrtoul64 (

    char                    *String,

    UINT32                  Base,

    UINT64                  *RetInteger)

{

    UINT32                  Index;

    UINT32                  Sign;

    UINT64                  ReturnValue = 0;

    ACPI_STATUS             Status = AE_OK;

    {

    case 0:

    case 8:

    case 10:

    case 16:

        break;

        /*

         * The specified Base parameter is not in the domain of

         * this function:

         */

        return (AE_BAD_PARAMETER);

    }

    {

        ++String;

    }

     * The buffer may contain an optional plus or minus sign.

     * If it does, then skip over it but remember what is was:

     */

    if (*String == '-')

    {

        Sign = NEGATIVE;

        ++String;

    }

    else if (*String == '+')

    {

        ++String;

        Sign = POSITIVE;

    }

    else

    {

        Sign = POSITIVE;

    }

     * If the input parameter Base is zero, then we need to

     * determine if it is octal, decimal, or hexadecimal:

     */

    if (Base == 0)

    {

        if (*String == '0')

        {

            if (tolower ((int) *(++String)) == 'x')

            {

                Base = 16;

                ++String;

            }

            else

            {

                Base = 8;

            }

        }

        else

        {

            Base = 10;

        }

    }

     * For octal and hexadecimal bases, skip over the leading

     * 0 or 0x, if they are present.

     */

    if (Base == 8 && *String == '0')

    {

        String++;

    }

        *String == '0' &&

        tolower ((int) *(++String)) == 'x')

    {

        String++;

    }

    {

        if (isdigit ((int) *String))

        {

            Index = ((UINT8) *String) - '0';

        }

        else

        {

            Index = (UINT8) toupper ((int) *String);

            if (isupper ((int) Index))

            {

                Index = Index - 'A' + 10;

            }

            else

            {

                goto ErrorExit;

            }

        }

        {

            goto ErrorExit;

        }

                            (UINT64) Base))

        {

            goto ErrorExit;

        }

        else

        {

            ReturnValue *= Base;

            ReturnValue += Index;

        }

    }

    {

        ReturnValue = (ACPI_UINT32_MAX - ReturnValue) + 1;

    }

    return (Status);

    switch (Base)

    {

    case 8:

        Status = AE_BAD_OCTAL_CONSTANT;

        break;

        Status = AE_BAD_DECIMAL_CONSTANT;

        break;

        Status = AE_BAD_HEX_CONSTANT;

        break;

        /* Base validated above */

        break;

    }

}