drivers/acpi/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 - 2015, 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 #include "aslcompiler.h"
 118 #include "dtcompiler.h"
 119
 120 #define _COMPONENT          ASL_PREPROCESSOR
 121         ACPI_MODULE_NAME    ("prparser")
 122
 123 int                         PrParserlex (void);
 124 int                         PrParserparse (void);
 125 void                        PrParsererror (char const *msg);
 126 extern char                 *PrParsertext;
 127
 128 UINT64                      PrParserResult; /* Expression return value */
 129
 130 /* Bison/yacc configuration */
 131
 132 #define yytname             PrParsername
 133 #define YYDEBUG             1               /* Enable debug output */
 134 #define YYERROR_VERBOSE     1               /* Verbose error messages */
 135 #define YYFLAG              -32768
 136
 137 /* Define YYMALLOC/YYFREE to prevent redefinition errors  */
 138
 139 #define YYMALLOC            malloc
 140 #define YYFREE              free
 141 %}
 142
 143 %union
 144 {
 145      UINT64                 value;
 146      UINT32                 op;
 147      char                   *str;
 148 }
 149
 150 /*! [Begin] no source code translation */
 151
 152 %type  <value>  Expression
 153
 154 %token <op>     EXPOP_EOF
 155 %token <op>     EXPOP_NEW_LINE
 156 %token <op>     EXPOP_NUMBER
 157 %token <op>     EXPOP_HEX_NUMBER
 158 %token <op>     EXPOP_RESERVED1
 159 %token <op>     EXPOP_RESERVED2
 160 %token <op>     EXPOP_PAREN_OPEN
 161 %token <op>     EXPOP_PAREN_CLOSE
 162
 163 %left <op>      EXPOP_LOGICAL_OR
 164 %left <op>      EXPOP_LOGICAL_AND
 165 %left <op>      EXPOP_OR
 166 %left <op>      EXPOP_XOR
 167 %left <op>      EXPOP_AND
 168 %left <op>      EXPOP_EQUAL EXPOP_NOT_EQUAL
 169 %left <op>      EXPOP_GREATER EXPOP_LESS EXPOP_GREATER_EQUAL EXPOP_LESS_EQUAL
 170 %left <op>      EXPOP_SHIFT_RIGHT EXPOP_SHIFT_LEFT
 171 %left <op>      EXPOP_ADD EXPOP_SUBTRACT
 172 %left <op>      EXPOP_MULTIPLY EXPOP_DIVIDE EXPOP_MODULO
 173 %right <op>     EXPOP_ONES_COMPLIMENT EXPOP_LOGICAL_NOT
 174
 175 /* Tokens above must be kept in synch with dtparser.y */
 176
 177 %token <op>     EXPOP_DEFINE
 178 %token <op>     EXPOP_IDENTIFIER
 179
 180 %%
 181
 182 /*
 183  *  Operator precedence rules (from K&R)
 184  *
 185  *  1)      ( )
 186  *  2)      ! ~ (unary operators that are supported here)
 187  *  3)      *   /   %
 188  *  4)      +   -
 189  *  5)      >>  <<
 190  *  6)      <   >   <=  >=
 191  *  7)      ==  !=
 192  *  8)      &
 193  *  9)      ^
 194  *  10)     |
 195  *  11)     &&
 196  *  12)     ||
 197  */
 198
 199 /*! [End] no source code translation !*/
 200
 201 Value
 202     : Expression EXPOP_NEW_LINE                     { PrParserResult=$1; return 0; } /* End of line (newline) */
 203     | Expression EXPOP_EOF                          { PrParserResult=$1; return 0; } /* End of string (0) */
 204     ;
 205
 206 Expression
 207
 208       /* Unary operators */
 209
 210     : EXPOP_LOGICAL_NOT         Expression          { $$ = DtDoOperator ($2, EXPOP_LOGICAL_NOT,     $2);}
 211     | EXPOP_ONES_COMPLIMENT     Expression          { $$ = DtDoOperator ($2, EXPOP_ONES_COMPLIMENT, $2);}
 212
 213       /* Binary operators */
 214
 215     | Expression EXPOP_MULTIPLY         Expression  { $$ = DtDoOperator ($1, EXPOP_MULTIPLY,        $3);}
 216     | Expression EXPOP_DIVIDE           Expression  { $$ = DtDoOperator ($1, EXPOP_DIVIDE,          $3);}
 217     | Expression EXPOP_MODULO           Expression  { $$ = DtDoOperator ($1, EXPOP_MODULO,          $3);}
 218     | Expression EXPOP_ADD              Expression  { $$ = DtDoOperator ($1, EXPOP_ADD,             $3);}
 219     | Expression EXPOP_SUBTRACT         Expression  { $$ = DtDoOperator ($1, EXPOP_SUBTRACT,        $3);}
 220     | Expression EXPOP_SHIFT_RIGHT      Expression  { $$ = DtDoOperator ($1, EXPOP_SHIFT_RIGHT,     $3);}
 221     | Expression EXPOP_SHIFT_LEFT       Expression  { $$ = DtDoOperator ($1, EXPOP_SHIFT_LEFT,      $3);}
 222     | Expression EXPOP_GREATER          Expression  { $$ = DtDoOperator ($1, EXPOP_GREATER,         $3);}
 223     | Expression EXPOP_LESS             Expression  { $$ = DtDoOperator ($1, EXPOP_LESS,            $3);}
 224     | Expression EXPOP_GREATER_EQUAL    Expression  { $$ = DtDoOperator ($1, EXPOP_GREATER_EQUAL,   $3);}
 225     | Expression EXPOP_LESS_EQUAL       Expression  { $$ = DtDoOperator ($1, EXPOP_LESS_EQUAL,      $3);}
 226     | Expression EXPOP_EQUAL            Expression  { $$ = DtDoOperator ($1, EXPOP_EQUAL,           $3);}
 227     | Expression EXPOP_NOT_EQUAL        Expression  { $$ = DtDoOperator ($1, EXPOP_NOT_EQUAL,       $3);}
 228     | Expression EXPOP_AND              Expression  { $$ = DtDoOperator ($1, EXPOP_AND,             $3);}
 229     | Expression EXPOP_XOR              Expression  { $$ = DtDoOperator ($1, EXPOP_XOR,             $3);}
 230     | Expression EXPOP_OR               Expression  { $$ = DtDoOperator ($1, EXPOP_OR,              $3);}
 231     | Expression EXPOP_LOGICAL_AND      Expression  { $$ = DtDoOperator ($1, EXPOP_LOGICAL_AND,     $3);}
 232     | Expression EXPOP_LOGICAL_OR       Expression  { $$ = DtDoOperator ($1, EXPOP_LOGICAL_OR,      $3);}
 233
 234       /* Parentheses: '(' Expression ')' */
 235
 236     | EXPOP_PAREN_OPEN          Expression
 237         EXPOP_PAREN_CLOSE                           { $$ = $2;}
 238
 239       /* #if defined (ID) or #if defined ID */
 240
 241     | EXPOP_DEFINE EXPOP_PAREN_OPEN EXPOP_IDENTIFIER
 242         EXPOP_PAREN_CLOSE                           { $$ = PrIsDefined (PrParserlval.str);}
 243
 244     | EXPOP_DEFINE EXPOP_IDENTIFIER                 { $$ = PrIsDefined (PrParserlval.str);}
 245
 246     | EXPOP_IDENTIFIER                              { $$ = PrResolveDefine (PrParserlval.str);}
 247
 248       /* Default base for a non-prefixed integer is 10 */
 249
 250     | EXPOP_NUMBER                                  { UtStrtoul64 (PrParsertext, 10, &$$);}
 251
 252       /* Standard hex number (0x1234) */
 253
 254     | EXPOP_HEX_NUMBER                              { UtStrtoul64 (PrParsertext, 16, &$$);}
 255     ;
 256 %%
 257
 258 /*
 259  * Local support functions, including parser entry point
 260  */
 261 #define PR_FIRST_PARSE_OPCODE   EXPOP_EOF
 262 #define PR_YYTNAME_START        3
 263
 264
 265 /******************************************************************************
 266  *
 267  * FUNCTION:    PrParsererror
 268  *
 269  * PARAMETERS:  Message             - Parser-generated error message
 270  *
 271  * RETURN:      None
 272  *
 273  * DESCRIPTION: Handler for parser errors
 274  *
 275  *****************************************************************************/
 276
 277 void
 278 PrParsererror (
 279     char const              *Message)
 280 {
 281     DtError (ASL_ERROR, ASL_MSG_SYNTAX,
 282         NULL, (char *) Message);
 283 }
 284
 285
 286 /******************************************************************************
 287  *
 288  * FUNCTION:    PrGetOpName
 289  *
 290  * PARAMETERS:  ParseOpcode         - Parser token (EXPOP_*)
 291  *
 292  * RETURN:      Pointer to the opcode name
 293  *
 294  * DESCRIPTION: Get the ascii name of the parse opcode for debug output
 295  *
 296  *****************************************************************************/
 297
 298 char *
 299 PrGetOpName (
 300     UINT32                  ParseOpcode)
 301 {
 302 #ifdef ASL_YYTNAME_START
 303     /*
 304      * First entries (PR_YYTNAME_START) in yytname are special reserved names.
 305      * Ignore first 6 characters of name (EXPOP_)
 306      */
 307     return ((char *) yytname
 308         [(ParseOpcode - PR_FIRST_PARSE_OPCODE) + PR_YYTNAME_START] + 6);
 309 #else
 310     return ("[Unknown parser generator]");
 311 #endif
 312 }
 313
 314
 315 /******************************************************************************
 316  *
 317  * FUNCTION:    PrEvaluateExpression
 318  *
 319  * PARAMETERS:  ExprString          - Expression to be evaluated. Must be
 320  *                                    terminated by either a newline or a NUL
 321  *                                    string terminator
 322  *
 323  * RETURN:      64-bit value for the expression
 324  *
 325  * DESCRIPTION: Main entry point for the DT expression parser
 326  *
 327  *****************************************************************************/
 328
 329 UINT64
 330 PrEvaluateExpression (
 331     char                    *ExprString)
 332 {
 333
 334     DbgPrint (ASL_DEBUG_OUTPUT,
 335         "**** Input expression: %s\n", ExprString);
 336
 337     /* Point lexer to the input string */
 338
 339     if (PrInitLexer (ExprString))
 340     {
 341         DtError (ASL_ERROR, ASL_MSG_COMPILER_INTERNAL,
 342             NULL, "Could not initialize lexer");
 343         return (0);
 344     }
 345
 346     /* Parse/Evaluate the input string (value returned in PrParserResult) */
 347
 348     PrParserparse ();
 349     PrTerminateLexer ();
 350
 351     DbgPrint (ASL_DEBUG_OUTPUT,
 352         "**** Parser returned value: %u (%8.8X%8.8X)\n",
 353         (UINT32) PrParserResult, ACPI_FORMAT_UINT64 (PrParserResult));
 354
 355     return (PrParserResult);
 356 }