Home | History | Annotate | Line # | Download | only in compiler
dtparser.y revision 1.20
      1 %{
      2 /******************************************************************************
      3  *
      4  * Module Name: dtparser.y - Bison input file for table compiler parser
      5  *
      6  *****************************************************************************/
      7 
      8 /******************************************************************************
      9  *
     10  * 1. Copyright Notice
     11  *
     12  * Some or all of this work - Copyright (c) 1999 - 2025, 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          DT_COMPILER
    156         ACPI_MODULE_NAME    ("dtparser")
    157 
    158 void *                      AslLocalAllocate (unsigned int Size);
    159 
    160 /* Bison/yacc configuration */
    161 
    162 #undef alloca
    163 #define alloca              AslLocalAllocate
    164 
    165 int                         DtParserlex (void);
    166 int                         DtParserparse (void);
    167 void                        DtParsererror (char const *msg);
    168 extern char                 *DtParsertext;
    169 extern DT_FIELD             *AslGbl_CurrentField;
    170 
    171 UINT64                      DtParserResult; /* Expression return value */
    172 
    173 /* Bison/yacc configuration */
    174 
    175 #ifndef yytname
    176 #define yytname             DtParsername
    177 #endif
    178 #define YYDEBUG             1               /* Enable debug output */
    179 #define YYERROR_VERBOSE     1               /* Verbose error messages */
    180 #define YYFLAG              -32768
    181 
    182 /* Define YYMALLOC/YYFREE to prevent redefinition errors  */
    183 
    184 #define YYMALLOC            malloc
    185 #define YYFREE              free
    186 %}
    187 
    188 %union
    189 {
    190      UINT64                 value;
    191      UINT32                 op;
    192 }
    193 
    194 /*! [Begin] no source code translation */
    195 
    196 %type  <value>  Expression
    197 
    198 %token <op>     OP_EXP_EOF
    199 %token <op>     OP_EXP_NEW_LINE
    200 %token <op>     OP_EXP_NUMBER
    201 %token <op>     OP_EXP_HEX_NUMBER
    202 %token <op>     OP_EXP_DECIMAL_NUMBER
    203 %token <op>     OP_EXP_LABEL
    204 %token <op>     OP_EXP_PAREN_OPEN
    205 %token <op>     OP_EXP_PAREN_CLOSE
    206 
    207 %left <op>      OP_EXP_LOGICAL_OR
    208 %left <op>      OP_EXP_LOGICAL_AND
    209 %left <op>      OP_EXP_OR
    210 %left <op>      OP_EXP_XOR
    211 %left <op>      OP_EXP_AND
    212 %left <op>      OP_EXP_EQUAL OP_EXP_NOT_EQUAL
    213 %left <op>      OP_EXP_GREATER OP_EXP_LESS OP_EXP_GREATER_EQUAL OP_EXP_LESS_EQUAL
    214 %left <op>      OP_EXP_SHIFT_RIGHT OP_EXP_SHIFT_LEFT
    215 %left <op>      OP_EXP_ADD OP_EXP_SUBTRACT
    216 %left <op>      OP_EXP_MULTIPLY OP_EXP_DIVIDE OP_EXP_MODULO
    217 %right <op>     OP_EXP_ONES_COMPLIMENT OP_EXP_LOGICAL_NOT
    218 
    219 %%
    220 
    221 /*
    222  *  Operator precedence rules (from K&R)
    223  *
    224  *  1)      ( )
    225  *  2)      ! ~ (unary operators that are supported here)
    226  *  3)      *   /   %
    227  *  4)      +   -
    228  *  5)      >>  <<
    229  *  6)      <   >   <=  >=
    230  *  7)      ==  !=
    231  *  8)      &
    232  *  9)      ^
    233  *  10)     |
    234  *  11)     &&
    235  *  12)     ||
    236  */
    237 Value
    238     : Expression OP_EXP_NEW_LINE                     { DtParserResult=$1; return 0; } /* End of line (newline) */
    239     | Expression OP_EXP_EOF                          { DtParserResult=$1; return 0; } /* End of string (0) */
    240     ;
    241 
    242 Expression
    243 
    244       /* Unary operators */
    245 
    246     : OP_EXP_LOGICAL_NOT         Expression          { $$ = DtDoOperator ($2, OP_EXP_LOGICAL_NOT,     $2);}
    247     | OP_EXP_ONES_COMPLIMENT     Expression          { $$ = DtDoOperator ($2, OP_EXP_ONES_COMPLIMENT, $2);}
    248 
    249       /* Binary operators */
    250 
    251     | Expression OP_EXP_MULTIPLY         Expression  { $$ = DtDoOperator ($1, OP_EXP_MULTIPLY,        $3);}
    252     | Expression OP_EXP_DIVIDE           Expression  { $$ = DtDoOperator ($1, OP_EXP_DIVIDE,          $3);}
    253     | Expression OP_EXP_MODULO           Expression  { $$ = DtDoOperator ($1, OP_EXP_MODULO,          $3);}
    254     | Expression OP_EXP_ADD              Expression  { $$ = DtDoOperator ($1, OP_EXP_ADD,             $3);}
    255     | Expression OP_EXP_SUBTRACT         Expression  { $$ = DtDoOperator ($1, OP_EXP_SUBTRACT,        $3);}
    256     | Expression OP_EXP_SHIFT_RIGHT      Expression  { $$ = DtDoOperator ($1, OP_EXP_SHIFT_RIGHT,     $3);}
    257     | Expression OP_EXP_SHIFT_LEFT       Expression  { $$ = DtDoOperator ($1, OP_EXP_SHIFT_LEFT,      $3);}
    258     | Expression OP_EXP_GREATER          Expression  { $$ = DtDoOperator ($1, OP_EXP_GREATER,         $3);}
    259     | Expression OP_EXP_LESS             Expression  { $$ = DtDoOperator ($1, OP_EXP_LESS,            $3);}
    260     | Expression OP_EXP_GREATER_EQUAL    Expression  { $$ = DtDoOperator ($1, OP_EXP_GREATER_EQUAL,   $3);}
    261     | Expression OP_EXP_LESS_EQUAL       Expression  { $$ = DtDoOperator ($1, OP_EXP_LESS_EQUAL,      $3);}
    262     | Expression OP_EXP_EQUAL            Expression  { $$ = DtDoOperator ($1, OP_EXP_EQUAL,           $3);}
    263     | Expression OP_EXP_NOT_EQUAL        Expression  { $$ = DtDoOperator ($1, OP_EXP_NOT_EQUAL,       $3);}
    264     | Expression OP_EXP_AND              Expression  { $$ = DtDoOperator ($1, OP_EXP_AND,             $3);}
    265     | Expression OP_EXP_XOR              Expression  { $$ = DtDoOperator ($1, OP_EXP_XOR,             $3);}
    266     | Expression OP_EXP_OR               Expression  { $$ = DtDoOperator ($1, OP_EXP_OR,              $3);}
    267     | Expression OP_EXP_LOGICAL_AND      Expression  { $$ = DtDoOperator ($1, OP_EXP_LOGICAL_AND,     $3);}
    268     | Expression OP_EXP_LOGICAL_OR       Expression  { $$ = DtDoOperator ($1, OP_EXP_LOGICAL_OR,      $3);}
    269 
    270       /* Parentheses: '(' Expression ')' */
    271 
    272     | OP_EXP_PAREN_OPEN          Expression
    273         OP_EXP_PAREN_CLOSE                           { $$ = $2;}
    274 
    275       /* Label references (prefixed with $) */
    276 
    277     | OP_EXP_LABEL                                   { $$ = DtResolveLabel (DtParsertext);}
    278 
    279       /*
    280        * All constants for the data table compiler are in hex, whether a (optional) 0x
    281        * prefix is present or not. For example, these two input strings are equivalent:
    282        *    1234
    283        *    0x1234
    284        */
    285 
    286       /* Non-prefixed hex number */
    287 
    288     | OP_EXP_NUMBER                                  { $$ = DtDoConstant (DtParsertext);}
    289 
    290       /* Standard hex number (0x1234) */
    291 
    292     | OP_EXP_HEX_NUMBER                              { $$ = DtDoConstant (DtParsertext);}
    293 
    294       /* Possible TBD: Decimal number with prefix (0d1234) - Not supported this time */
    295 
    296     | OP_EXP_DECIMAL_NUMBER                          { $$ = DtDoConstant (DtParsertext);}
    297     ;
    298 %%
    299 
    300 /*! [End] no source code translation !*/
    301 
    302 /*
    303  * Local support functions, including parser entry point
    304  */
    305 #define PR_FIRST_PARSE_OPCODE   OP_EXP_EOF
    306 #define PR_YYTNAME_START        3
    307 
    308 
    309 /******************************************************************************
    310  *
    311  * FUNCTION:    DtParsererror
    312  *
    313  * PARAMETERS:  Message             - Parser-generated error message
    314  *
    315  * RETURN:      None
    316  *
    317  * DESCRIPTION: Handler for parser errors
    318  *
    319  *****************************************************************************/
    320 
    321 void
    322 DtParsererror (
    323     char const              *Message)
    324 {
    325     DtError (ASL_ERROR, ASL_MSG_SYNTAX,
    326         AslGbl_CurrentField, (char *) Message);
    327 }
    328 
    329 
    330 /******************************************************************************
    331  *
    332  * FUNCTION:    DtGetOpName
    333  *
    334  * PARAMETERS:  ParseOpcode         - Parser token (OP_EXP_*)
    335  *
    336  * RETURN:      Pointer to the opcode name
    337  *
    338  * DESCRIPTION: Get the ascii name of the parse opcode for debug output
    339  *
    340  *****************************************************************************/
    341 
    342 char *
    343 DtGetOpName (
    344     UINT32                  ParseOpcode)
    345 {
    346 #ifdef ASL_YYTNAME_START
    347     /*
    348      * First entries (PR_YYTNAME_START) in yytname are special reserved names.
    349      * Ignore first 6 characters of name (OP_EXP_)
    350      */
    351     return ((char *) yytname
    352         [(ParseOpcode - PR_FIRST_PARSE_OPCODE) + PR_YYTNAME_START] + 6);
    353 #else
    354     return ("[Unknown parser generator]");
    355 #endif
    356 }
    357 
    358 
    359 /******************************************************************************
    360  *
    361  * FUNCTION:    DtEvaluateExpression
    362  *
    363  * PARAMETERS:  ExprString          - Expression to be evaluated. Must be
    364  *                                    terminated by either a newline or a NUL
    365  *                                    string terminator
    366  *
    367  * RETURN:      64-bit value for the expression
    368  *
    369  * DESCRIPTION: Main entry point for the DT expression parser
    370  *
    371  *****************************************************************************/
    372 
    373 UINT64
    374 DtEvaluateExpression (
    375     char                    *ExprString)
    376 {
    377 
    378     DbgPrint (ASL_DEBUG_OUTPUT,
    379         "**** Input expression: %s  (Base 16)\n", ExprString);
    380 
    381     /* Point lexer to the input string */
    382 
    383     if (DtInitLexer (ExprString))
    384     {
    385         DtError (ASL_ERROR, ASL_MSG_COMPILER_INTERNAL,
    386             AslGbl_CurrentField, "Could not initialize lexer");
    387         return (0);
    388     }
    389 
    390     /* Parse/Evaluate the input string (value returned in DtParserResult) */
    391 
    392     DtParserparse ();
    393     DtTerminateLexer ();
    394 
    395     DbgPrint (ASL_DEBUG_OUTPUT,
    396         "**** Parser returned value: %u (%8.8X%8.8X)\n",
    397         (UINT32) DtParserResult, ACPI_FORMAT_UINT64 (DtParserResult));
    398 
    399     return (DtParserResult);
    400 }
    401