sys/contrib/dev/acpica/source/compiler/prparser.y

   1 %{
   2 /******************************************************************************
   3  *
   4  * Module Name: prparser.y - Bison input file for preprocessor parser
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights. You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code. No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision. In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change. Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee. Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution. In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government. In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************
 116  *
 117  * Alternatively, you may choose to be licensed under the terms of the
 118  * following license:
 119  *
 120  * Redistribution and use in source and binary forms, with or without
 121  * modification, are permitted provided that the following conditions
 122  * are met:
 123  * 1. Redistributions of source code must retain the above copyright
 124  *    notice, this list of conditions, and the following disclaimer,
 125  *    without modification.
 126  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 127  *    substantially similar to the "NO WARRANTY" disclaimer below
 128  *    ("Disclaimer") and any redistribution must be conditioned upon
 129  *    including a substantially similar Disclaimer requirement for further
 130  *    binary redistribution.
 131  * 3. Neither the names of the above-listed copyright holders nor the names
 132  *    of any contributors may be used to endorse or promote products derived
 133  *    from this software without specific prior written permission.
 134  *
 135  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 136  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 137  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 138  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 139  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 140  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 141  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 142  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 143  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 144  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 145  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 146  *
 147  * Alternatively, you may choose to be licensed under the terms of the
 148  * GNU General Public License ("GPL") version 2 as published by the Free
 149  * Software Foundation.
 150  *
 151  *****************************************************************************/
 152
 153 #include "aslcompiler.h"
 154
 155 #define _COMPONENT          ASL_PREPROCESSOR
 156         ACPI_MODULE_NAME    ("prparser")
 157
 158 void *                      AslLocalAllocate (unsigned int Size);
 159
 160 /* Bison/yacc configuration */
 161
 162 #undef alloca
 163 #define alloca              AslLocalAllocate
 164
 165 int                         PrParserlex (void);
 166 int                         PrParserparse (void);
 167 void                        PrParsererror (char const *msg);
 168 extern char                 *PrParsertext;
 169
 170 UINT64                      PrParserResult; /* Expression return value */
 171
 172 /* Bison/yacc configuration */
 173
 174 #define yytname             PrParsername
 175 #define YYDEBUG             1               /* Enable debug output */
 176 #define YYERROR_VERBOSE     1               /* Verbose error messages */
 177 #define YYFLAG              -32768
 178
 179 /* Define YYMALLOC/YYFREE to prevent redefinition errors  */
 180
 181 #define YYMALLOC            malloc
 182 #define YYFREE              free
 183 %}
 184
 185 %union
 186 {
 187      UINT64                 value;
 188      UINT32                 op;
 189      char                   *str;
 190 }
 191
 192 /*! [Begin] no source code translation */
 193
 194 %type  <value>  Expression
 195
 196 %token <op>     EXPOP_EOF
 197 %token <op>     EXPOP_NEW_LINE
 198 %token <op>     EXPOP_NUMBER
 199 %token <op>     EXPOP_HEX_NUMBER
 200 %token <op>     EXPOP_RESERVED1
 201 %token <op>     EXPOP_RESERVED2
 202 %token <op>     EXPOP_PAREN_OPEN
 203 %token <op>     EXPOP_PAREN_CLOSE
 204
 205 %left <op>      EXPOP_LOGICAL_OR
 206 %left <op>      EXPOP_LOGICAL_AND
 207 %left <op>      EXPOP_OR
 208 %left <op>      EXPOP_XOR
 209 %left <op>      EXPOP_AND
 210 %left <op>      EXPOP_EQUAL EXPOP_NOT_EQUAL
 211 %left <op>      EXPOP_GREATER EXPOP_LESS EXPOP_GREATER_EQUAL EXPOP_LESS_EQUAL
 212 %left <op>      EXPOP_SHIFT_RIGHT EXPOP_SHIFT_LEFT
 213 %left <op>      EXPOP_ADD EXPOP_SUBTRACT
 214 %left <op>      EXPOP_MULTIPLY EXPOP_DIVIDE EXPOP_MODULO
 215 %right <op>     EXPOP_ONES_COMPLIMENT EXPOP_LOGICAL_NOT
 216
 217 /* Tokens above must be kept in synch with dtparser.y */
 218
 219 %token <op>     EXPOP_DEFINE
 220 %token <op>     EXPOP_IDENTIFIER
 221
 222 %%
 223
 224 /*
 225  *  Operator precedence rules (from K&R)
 226  *
 227  *  1)      ( )
 228  *  2)      ! ~ (unary operators that are supported here)
 229  *  3)      *   /   %
 230  *  4)      +   -
 231  *  5)      >>  <<
 232  *  6)      <   >   <=  >=
 233  *  7)      ==  !=
 234  *  8)      &
 235  *  9)      ^
 236  *  10)     |
 237  *  11)     &&
 238  *  12)     ||
 239  */
 240
 241 /*! [End] no source code translation !*/
 242
 243 Value
 244     : Expression EXPOP_NEW_LINE                     { PrParserResult=$1; return 0; } /* End of line (newline) */
 245     | Expression EXPOP_EOF                          { PrParserResult=$1; return 0; } /* End of string (0) */
 246     ;
 247
 248 Expression
 249
 250       /* Unary operators */
 251
 252     : EXPOP_LOGICAL_NOT         Expression          { $$ = DtDoOperator ($2, EXPOP_LOGICAL_NOT,     $2);}
 253     | EXPOP_ONES_COMPLIMENT     Expression          { $$ = DtDoOperator ($2, EXPOP_ONES_COMPLIMENT, $2);}
 254
 255       /* Binary operators */
 256
 257     | Expression EXPOP_MULTIPLY         Expression  { $$ = DtDoOperator ($1, EXPOP_MULTIPLY,        $3);}
 258     | Expression EXPOP_DIVIDE           Expression  { $$ = DtDoOperator ($1, EXPOP_DIVIDE,          $3);}
 259     | Expression EXPOP_MODULO           Expression  { $$ = DtDoOperator ($1, EXPOP_MODULO,          $3);}
 260     | Expression EXPOP_ADD              Expression  { $$ = DtDoOperator ($1, EXPOP_ADD,             $3);}
 261     | Expression EXPOP_SUBTRACT         Expression  { $$ = DtDoOperator ($1, EXPOP_SUBTRACT,        $3);}
 262     | Expression EXPOP_SHIFT_RIGHT      Expression  { $$ = DtDoOperator ($1, EXPOP_SHIFT_RIGHT,     $3);}
 263     | Expression EXPOP_SHIFT_LEFT       Expression  { $$ = DtDoOperator ($1, EXPOP_SHIFT_LEFT,      $3);}
 264     | Expression EXPOP_GREATER          Expression  { $$ = DtDoOperator ($1, EXPOP_GREATER,         $3);}
 265     | Expression EXPOP_LESS             Expression  { $$ = DtDoOperator ($1, EXPOP_LESS,            $3);}
 266     | Expression EXPOP_GREATER_EQUAL    Expression  { $$ = DtDoOperator ($1, EXPOP_GREATER_EQUAL,   $3);}
 267     | Expression EXPOP_LESS_EQUAL       Expression  { $$ = DtDoOperator ($1, EXPOP_LESS_EQUAL,      $3);}
 268     | Expression EXPOP_EQUAL            Expression  { $$ = DtDoOperator ($1, EXPOP_EQUAL,           $3);}
 269     | Expression EXPOP_NOT_EQUAL        Expression  { $$ = DtDoOperator ($1, EXPOP_NOT_EQUAL,       $3);}
 270     | Expression EXPOP_AND              Expression  { $$ = DtDoOperator ($1, EXPOP_AND,             $3);}
 271     | Expression EXPOP_XOR              Expression  { $$ = DtDoOperator ($1, EXPOP_XOR,             $3);}
 272     | Expression EXPOP_OR               Expression  { $$ = DtDoOperator ($1, EXPOP_OR,              $3);}
 273     | Expression EXPOP_LOGICAL_AND      Expression  { $$ = DtDoOperator ($1, EXPOP_LOGICAL_AND,     $3);}
 274     | Expression EXPOP_LOGICAL_OR       Expression  { $$ = DtDoOperator ($1, EXPOP_LOGICAL_OR,      $3);}
 275
 276       /* Parentheses: '(' Expression ')' */
 277
 278     | EXPOP_PAREN_OPEN          Expression
 279         EXPOP_PAREN_CLOSE                           { $$ = $2;}
 280
 281       /* #if defined (ID) or #if defined ID */
 282
 283     | EXPOP_DEFINE EXPOP_PAREN_OPEN EXPOP_IDENTIFIER
 284         EXPOP_PAREN_CLOSE                           { $$ = PrIsDefined (PrParserlval.str);}
 285
 286     | EXPOP_DEFINE EXPOP_IDENTIFIER                 { $$ = PrIsDefined (PrParserlval.str);}
 287
 288     | EXPOP_IDENTIFIER                              { $$ = PrResolveDefine (PrParserlval.str);}
 289
 290       /* Default base for a non-prefixed integer is 10 */
 291
 292     | EXPOP_NUMBER                                  { AcpiUtStrtoul64 (PrParsertext, &$$);}
 293
 294       /* Standard hex number (0x1234) */
 295
 296     | EXPOP_HEX_NUMBER                              { AcpiUtStrtoul64 (PrParsertext, &$$);}
 297     ;
 298 %%
 299
 300 /*
 301  * Local support functions, including parser entry point
 302  */
 303 #define PR_FIRST_PARSE_OPCODE   EXPOP_EOF
 304 #define PR_YYTNAME_START        3
 305
 306
 307 /******************************************************************************
 308  *
 309  * FUNCTION:    PrParsererror
 310  *
 311  * PARAMETERS:  Message             - Parser-generated error message
 312  *
 313  * RETURN:      None
 314  *
 315  * DESCRIPTION: Handler for parser errors
 316  *
 317  *****************************************************************************/
 318
 319 void
 320 PrParsererror (
 321     char const              *Message)
 322 {
 323
 324     sprintf (AslGbl_StringBuffer, "Preprocessor Parser : %s (near line %u)",
 325         Message, AslGbl_CurrentLineNumber);
 326     DtError (ASL_ERROR, ASL_MSG_SYNTAX,
 327         NULL, (char *) AslGbl_StringBuffer);
 328 }
 329
 330
 331 /******************************************************************************
 332  *
 333  * FUNCTION:    PrGetOpName
 334  *
 335  * PARAMETERS:  ParseOpcode         - Parser token (EXPOP_*)
 336  *
 337  * RETURN:      Pointer to the opcode name
 338  *
 339  * DESCRIPTION: Get the ascii name of the parse opcode for debug output
 340  *
 341  *****************************************************************************/
 342
 343 char *
 344 PrGetOpName (
 345     UINT32                  ParseOpcode)
 346 {
 347 #ifdef ASL_YYTNAME_START
 348     /*
 349      * First entries (PR_YYTNAME_START) in yytname are special reserved names.
 350      * Ignore first 6 characters of name (EXPOP_)
 351      */
 352     return ((char *) yytname
 353         [(ParseOpcode - PR_FIRST_PARSE_OPCODE) + PR_YYTNAME_START] + 6);
 354 #else
 355     return ("[Unknown parser generator]");
 356 #endif
 357 }
 358
 359
 360 /******************************************************************************
 361  *
 362  * FUNCTION:    PrEvaluateExpression
 363  *
 364  * PARAMETERS:  ExprString          - Expression to be evaluated. Must be
 365  *                                    terminated by either a newline or a NUL
 366  *                                    string terminator
 367  *
 368  * RETURN:      64-bit value for the expression
 369  *
 370  * DESCRIPTION: Main entry point for the DT expression parser
 371  *
 372  *****************************************************************************/
 373
 374 UINT64
 375 PrEvaluateExpression (
 376     char                    *ExprString)
 377 {
 378
 379     DbgPrint (ASL_DEBUG_OUTPUT,
 380         "**** Input expression: %s\n", ExprString);
 381
 382     /* Point lexer to the input string */
 383
 384     if (PrInitLexer (ExprString))
 385     {
 386         DtError (ASL_ERROR, ASL_MSG_COMPILER_INTERNAL,
 387             NULL, "Could not initialize lexer");
 388         return (0);
 389     }
 390
 391     /* Parse/Evaluate the input string (value returned in PrParserResult) */
 392
 393     PrParserparse ();
 394     PrTerminateLexer ();
 395
 396     DbgPrint (ASL_DEBUG_OUTPUT,
 397         "**** Parser returned value: %u (%8.8X%8.8X)\n",
 398         (UINT32) PrParserResult, ACPI_FORMAT_UINT64 (PrParserResult));
 399
 400     return (PrParserResult);
 401 }