drivers/acpi/compiler/prexpress.c

   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 - 2015, 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 #include "aslcompiler.h"
 117 #include "dtcompiler.h"
 118
 119
 120 #define _COMPONENT          ASL_PREPROCESSOR
 121         ACPI_MODULE_NAME    ("prexpress")
 122
 123 /* Local prototypes */
 124
 125 static char *
 126 PrExpandMacros (
 127     char                    *Line);
 128
 129
 130 #ifdef _UNDER_DEVELOPMENT
 131 /******************************************************************************
 132  *
 133  * FUNCTION:    PrUnTokenize
 134  *
 135  * PARAMETERS:  Buffer              - Token Buffer
 136  *              Next                - "Next" buffer from GetNextToken
 137  *
 138  * RETURN:      None
 139  *
 140  * DESCRIPTION: Un-tokenized the current token buffer. The implementation is
 141  *              to simply set the null inserted by GetNextToken to a blank.
 142  *              If Next is NULL, there were no tokens found in the Buffer,
 143  *              so there is nothing to do.
 144  *
 145  *****************************************************************************/
 146
 147 static void
 148 PrUnTokenize (
 149     char                    *Buffer,
 150     char                    *Next)
 151 {
 152     UINT32                  Length = strlen (Buffer);
 153
 154
 155     if (!Next)
 156     {
 157         return;
 158     }
 159     if (Buffer[Length] != '\n')
 160     {
 161         Buffer[strlen(Buffer)] = ' ';
 162     }
 163 }
 164 #endif
 165
 166
 167 /******************************************************************************
 168  *
 169  * FUNCTION:    PrExpandMacros
 170  *
 171  * PARAMETERS:  Line                - Pointer into the current line
 172  *
 173  * RETURN:      Updated pointer into the current line
 174  *
 175  * DESCRIPTION: Expand any macros found in the current line buffer.
 176  *
 177  *****************************************************************************/
 178
 179 static char *
 180 PrExpandMacros (
 181     char                    *Line)
 182 {
 183     char                    *Token;
 184     char                    *ReplaceString;
 185     PR_DEFINE_INFO          *DefineInfo;
 186     ACPI_SIZE               TokenOffset;
 187     char                    *Next;
 188     int                     OffsetAdjust;
 189
 190
 191     strcpy (Gbl_ExpressionTokenBuffer, Gbl_CurrentLineBuffer);
 192     Token = PrGetNextToken (Gbl_ExpressionTokenBuffer, PR_EXPR_SEPARATORS, &Next);
 193     OffsetAdjust = 0;
 194
 195     while (Token)
 196     {
 197         DefineInfo = PrMatchDefine (Token);
 198         if (DefineInfo)
 199         {
 200             if (DefineInfo->Body)
 201             {
 202                 /* This is a macro. TBD: Is this allowed? */
 203
 204                 DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
 205                     "Matched Macro: %s->%s\n",
 206                     Gbl_CurrentLineNumber, DefineInfo->Identifier,
 207                     DefineInfo->Replacement);
 208
 209                 PrDoMacroInvocation (Gbl_ExpressionTokenBuffer, Token,
 210                     DefineInfo, &Next);
 211             }
 212             else
 213             {
 214                 ReplaceString = DefineInfo->Replacement;
 215
 216                 /* Replace the name in the original line buffer */
 217
 218                 TokenOffset = Token - Gbl_ExpressionTokenBuffer + OffsetAdjust;
 219                 PrReplaceData (
 220                     &Gbl_CurrentLineBuffer[TokenOffset], strlen (Token),
 221                     ReplaceString, strlen (ReplaceString));
 222
 223                 /* Adjust for length difference between old and new name length */
 224
 225                 OffsetAdjust += strlen (ReplaceString) - strlen (Token);
 226
 227                 DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
 228                     "Matched #define within expression: %s->%s\n",
 229                     Gbl_CurrentLineNumber, Token,
 230                     *ReplaceString ? ReplaceString : "(NULL STRING)");
 231             }
 232         }
 233
 234         Token = PrGetNextToken (NULL, PR_EXPR_SEPARATORS, &Next);
 235     }
 236
 237     return (Line);
 238 }
 239
 240
 241 /******************************************************************************
 242  *
 243  * FUNCTION:    PrIsDefined
 244  *
 245  * PARAMETERS:  Identifier          - Name to be resolved
 246  *
 247  * RETURN:      64-bit boolean integer value
 248  *
 249  * DESCRIPTION: Returns TRUE if the name is defined, FALSE otherwise (0).
 250  *
 251  *****************************************************************************/
 252
 253 UINT64
 254 PrIsDefined (
 255     char                    *Identifier)
 256 {
 257     UINT64                  Value;
 258     PR_DEFINE_INFO          *DefineInfo;
 259
 260
 261     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
 262         "**** Is defined?:  %s\n", Gbl_CurrentLineNumber, Identifier);
 263
 264     Value = 0; /* Default is "Not defined" -- FALSE */
 265
 266     DefineInfo = PrMatchDefine (Identifier);
 267     if (DefineInfo)
 268     {
 269         Value = ACPI_UINT64_MAX; /* TRUE */
 270     }
 271
 272     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
 273         "[#if defined %s] resolved to: %8.8X%8.8X\n",
 274         Gbl_CurrentLineNumber, Identifier, ACPI_FORMAT_UINT64 (Value));
 275
 276     return (Value);
 277 }
 278
 279
 280 /******************************************************************************
 281  *
 282  * FUNCTION:    PrResolveDefine
 283  *
 284  * PARAMETERS:  Identifier          - Name to be resolved
 285  *
 286  * RETURN:      A 64-bit boolean integer value
 287  *
 288  * DESCRIPTION: Returns TRUE if the name is defined, FALSE otherwise (0).
 289  *
 290  *****************************************************************************/
 291
 292 UINT64
 293 PrResolveDefine (
 294     char                    *Identifier)
 295 {
 296     UINT64                  Value;
 297     PR_DEFINE_INFO          *DefineInfo;
 298
 299
 300     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
 301         "**** Resolve #define:  %s\n", Gbl_CurrentLineNumber, Identifier);
 302
 303     Value = 0; /* Default is "Not defined" -- FALSE */
 304
 305     DefineInfo = PrMatchDefine (Identifier);
 306     if (DefineInfo)
 307     {
 308         Value = ACPI_UINT64_MAX; /* TRUE */
 309     }
 310
 311     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
 312         "[#if defined %s] resolved to: %8.8X%8.8X\n",
 313         Gbl_CurrentLineNumber, Identifier, ACPI_FORMAT_UINT64 (Value));
 314
 315     return (Value);
 316 }
 317
 318
 319 /******************************************************************************
 320  *
 321  * FUNCTION:    PrResolveIntegerExpression
 322  *
 323  * PARAMETERS:  Line                - Pointer to integer expression
 324  *              ReturnValue         - Where the resolved 64-bit integer is
 325  *                                    returned.
 326  *
 327  * RETURN:      Status
 328  *
 329  * DESCRIPTION: Resolve an integer expression to a single value. Supports
 330  *              both integer constants and labels.
 331  *
 332  *****************************************************************************/
 333
 334 ACPI_STATUS
 335 PrResolveIntegerExpression (
 336     char                    *Line,
 337     UINT64                  *ReturnValue)
 338 {
 339     UINT64                  Result;
 340     char                    *ExpandedLine;
 341
 342
 343     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
 344         "**** Resolve #if:  %s\n", Gbl_CurrentLineNumber, Line);
 345
 346     /* Expand all macros within the expression first */
 347
 348     ExpandedLine = PrExpandMacros (Line);
 349
 350     /* Now we can evaluate the expression */
 351
 352     Result = PrEvaluateExpression (ExpandedLine);
 353     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
 354         "**** Expression Resolved to: %8.8X%8.8X\n",
 355         Gbl_CurrentLineNumber, ACPI_FORMAT_UINT64 (Result));
 356
 357     *ReturnValue = Result;
 358     return (AE_OK);
 359
 360 #if 0
 361 InvalidExpression:
 362
 363     ACPI_FREE (EvalBuffer);
 364     PrError (ASL_ERROR, ASL_MSG_INVALID_EXPRESSION, 0);
 365     return (AE_ERROR);
 366
 367
 368 NormalExit:
 369
 370     DbgPrint (ASL_DEBUG_OUTPUT, PR_PREFIX_ID
 371         "**** Expression Resolved to: %8.8X%8.8X\n",
 372         Gbl_CurrentLineNumber, ACPI_FORMAT_UINT64 (Value1));
 373
 374     *ReturnValue = Value1;
 375     return (AE_OK);
 376 #endif
 377 }