Home | History | Annotate | Line # | Download | only in compiler
      1 /******************************************************************************
      2  *
      3  * Module Name: prexpress - Preprocessor #if expression support
      4  *
      5  *****************************************************************************/
      6 
      7 /******************************************************************************
      8  *
      9  * 1. Copyright Notice
     10  *
     11  * Some or all of this work - Copyright (c) 1999 - 2025, 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 
    154 #define _COMPONENT          ASL_PREPROCESSOR
    155         ACPI_MODULE_NAME    ("prexpress")
    156 
    157 /* Local prototypes */
    158 
    159 static char *
    160 PrExpandMacros (
    161     char                    *Line);
    162 
    163 
    164 #ifdef _UNDER_DEVELOPMENT
    165 /******************************************************************************
    166  *
    167  * FUNCTION:    PrUnTokenize
    168  *
    169  * PARAMETERS:  Buffer              - Token Buffer
    170  *              Next                - "Next" buffer from GetNextToken
    171  *
    172  * RETURN:      None
    173  *
    174  * DESCRIPTION: Un-tokenized the current token buffer. The implementation is
    175  *              to simply set the null inserted by GetNextToken to a blank.
    176  *              If Next is NULL, there were no tokens found in the Buffer,
    177  *              so there is nothing to do.
    178  *
    179  *****************************************************************************/
    180 
    181 static void
    182 PrUnTokenize (
    183     char                    *Buffer,
    184     char                    *Next)
    185 {
    186     UINT32                  Length = strlen (Buffer);
    187 
    188 
    189     if (!Next)
    190     {
    191         return;
    192     }
    193 
    194     if (Buffer[Length] != '\n')
    195     {
    196         Buffer[strlen(Buffer)] = ' ';
    197     }
    198 }
    199 #endif
    200 
    201 
    202 /******************************************************************************
    203  *
    204  * FUNCTION:    PrExpandMacros
    205  *
    206  * PARAMETERS:  Line                - Pointer into the current line
    207  *
    208  * RETURN:      Updated pointer into the current line
    209  *
    210  * DESCRIPTION: Expand any macros found in the current line buffer.
    211  *
    212  *****************************************************************************/
    213 
    214 static char *
    215 PrExpandMacros (
    216     char                    *Line)
    217 {
    218     char                    *Token;
    219     char                    *ReplaceString;
    220     PR_DEFINE_INFO          *DefineInfo;
    221     ACPI_SIZE               TokenOffset;
    222     char                    *Next;
    223     int                     OffsetAdjust;
    224 
    225 
    226     strcpy (AslGbl_ExpressionTokenBuffer, AslGbl_CurrentLineBuffer);
    227     Token = PrGetNextToken (AslGbl_ExpressionTokenBuffer, PR_EXPR_SEPARATORS, &Next);
    228     OffsetAdjust = 0;
    229 
    230     while (Token)
    231     {
    232         DefineInfo = PrMatchDefine (Token);
    233         if (DefineInfo)
    234         {
    235             if (DefineInfo->Body)
    236             {
    237                 /* This is a macro. TBD: Is this allowed? */
    238 
    239                 DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
    240                     "Matched Macro: %s->%s\n",
    241                     AslGbl_CurrentLineNumber, DefineInfo->Identifier,
    242                     DefineInfo->Replacement);
    243 
    244                 PrDoMacroInvocation (AslGbl_ExpressionTokenBuffer, Token,
    245                     DefineInfo, &Next);
    246             }
    247             else
    248             {
    249                 ReplaceString = DefineInfo->Replacement;
    250 
    251                 /* Replace the name in the original line buffer */
    252 
    253                 TokenOffset = Token - AslGbl_ExpressionTokenBuffer + OffsetAdjust;
    254                 PrReplaceData (
    255                     &AslGbl_CurrentLineBuffer[TokenOffset], strlen (Token),
    256                     ReplaceString, strlen (ReplaceString));
    257 
    258                 /* Adjust for length difference between old and new name length */
    259 
    260                 OffsetAdjust += strlen (ReplaceString) - strlen (Token);
    261 
    262                 DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
    263                     "Matched #define within expression: %s->%s\n",
    264                     AslGbl_CurrentLineNumber, Token,
    265                     *ReplaceString ? ReplaceString : "(NULL STRING)");
    266             }
    267         }
    268 
    269         Token = PrGetNextToken (NULL, PR_EXPR_SEPARATORS, &Next);
    270     }
    271 
    272     return (Line);
    273 }
    274 
    275 
    276 /******************************************************************************
    277  *
    278  * FUNCTION:    PrIsDefined
    279  *
    280  * PARAMETERS:  Identifier          - Name to be resolved
    281  *
    282  * RETURN:      64-bit boolean integer value
    283  *
    284  * DESCRIPTION: Returns TRUE if the name is defined, FALSE otherwise (0).
    285  *
    286  *****************************************************************************/
    287 
    288 UINT64
    289 PrIsDefined (
    290     char                    *Identifier)
    291 {
    292     UINT64                  Value;
    293     PR_DEFINE_INFO          *DefineInfo;
    294 
    295 
    296     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
    297         "**** Is defined?:  %s\n", AslGbl_CurrentLineNumber, Identifier);
    298 
    299     Value = 0; /* Default is "Not defined" -- FALSE */
    300 
    301     DefineInfo = PrMatchDefine (Identifier);
    302     if (DefineInfo)
    303     {
    304         Value = ACPI_UINT64_MAX; /* TRUE */
    305     }
    306 
    307     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
    308         "[#if defined %s] resolved to: %8.8X%8.8X\n",
    309         AslGbl_CurrentLineNumber, Identifier, ACPI_FORMAT_UINT64 (Value));
    310 
    311     return (Value);
    312 }
    313 
    314 
    315 /******************************************************************************
    316  *
    317  * FUNCTION:    PrResolveDefine
    318  *
    319  * PARAMETERS:  Identifier          - Name to be resolved
    320  *
    321  * RETURN:      A 64-bit boolean integer value
    322  *
    323  * DESCRIPTION: Returns TRUE if the name is defined, FALSE otherwise (0).
    324  *
    325  *****************************************************************************/
    326 
    327 UINT64
    328 PrResolveDefine (
    329     char                    *Identifier)
    330 {
    331     UINT64                  Value;
    332     PR_DEFINE_INFO          *DefineInfo;
    333 
    334 
    335     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
    336         "**** Resolve #define:  %s\n", AslGbl_CurrentLineNumber, Identifier);
    337 
    338     Value = 0; /* Default is "Not defined" -- FALSE */
    339 
    340     DefineInfo = PrMatchDefine (Identifier);
    341     if (DefineInfo)
    342     {
    343         Value = ACPI_UINT64_MAX; /* TRUE */
    344     }
    345 
    346     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
    347         "[#if defined %s] resolved to: %8.8X%8.8X\n",
    348         AslGbl_CurrentLineNumber, Identifier, ACPI_FORMAT_UINT64 (Value));
    349 
    350     return (Value);
    351 }
    352 
    353 
    354 /******************************************************************************
    355  *
    356  * FUNCTION:    PrResolveIntegerExpression
    357  *
    358  * PARAMETERS:  Line                - Pointer to integer expression
    359  *              ReturnValue         - Where the resolved 64-bit integer is
    360  *                                    returned.
    361  *
    362  * RETURN:      Status
    363  *
    364  * DESCRIPTION: Resolve an integer expression to a single value. Supports
    365  *              both integer constants and labels.
    366  *
    367  *****************************************************************************/
    368 
    369 ACPI_STATUS
    370 PrResolveIntegerExpression (
    371     char                    *Line,
    372     UINT64                  *ReturnValue)
    373 {
    374     UINT64                  Result;
    375     char                    *ExpandedLine;
    376 
    377 
    378     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
    379         "**** Resolve #if:  %s\n", AslGbl_CurrentLineNumber, Line);
    380 
    381     /* Expand all macros within the expression first */
    382 
    383     ExpandedLine = PrExpandMacros (Line);
    384 
    385     /* Now we can evaluate the expression */
    386 
    387     Result = PrEvaluateExpression (ExpandedLine);
    388     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
    389         "**** Expression Resolved to: %8.8X%8.8X\n",
    390         AslGbl_CurrentLineNumber, ACPI_FORMAT_UINT64 (Result));
    391 
    392     *ReturnValue = Result;
    393     return (AE_OK);
    394 
    395 #if 0
    396 InvalidExpression:
    397 
    398     ACPI_FREE (EvalBuffer);
    399     PrError (ASL_ERROR, ASL_MSG_INVALID_EXPRESSION, 0);
    400     return (AE_ERROR);
    401 
    402 
    403 NormalExit:
    404 
    405     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
    406         "**** Expression Resolved to: %8.8X%8.8X\n",
    407         AslGbl_CurrentLineNumber, ACPI_FORMAT_UINT64 (Value1));
    408 
    409     *ReturnValue = Value1;
    410     return (AE_OK);
    411 #endif
    412 }
    413