sys/contrib/dev/acpica-unix/compiler/dtexpress.c

   1 /******************************************************************************
   2  *
   3  * Module Name: dtexpress.c - Support for integer expressions and labels
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2011, 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 #define __DTEXPRESS_C__
 117
 118 #include "aslcompiler.h"
 119 #include "dtcompiler.h"
 120 #include "dtparser.y.h"
 121
 122 #define _COMPONENT          DT_COMPILER
 123         ACPI_MODULE_NAME    ("dtexpress")
 124
 125
 126 /* Local prototypes */
 127
 128 static void
 129 DtInsertLabelField (
 130     DT_FIELD                *Field);
 131
 132 static DT_FIELD *
 133 DtLookupLabel (
 134     char                    *Name);
 135
 136 /* Global used for errors during parse and related functions */
 137
 138 DT_FIELD                *Gbl_CurrentField;
 139
 140
 141 /******************************************************************************
 142  *
 143  * FUNCTION:    DtResolveIntegerExpression
 144  *
 145  * PARAMETERS:  Field               - Field object with Integer expression
 146  *              ReturnValue         - Where the integer is returned
 147  *
 148  * RETURN:      Status, and the resolved 64-bit integer value
 149  *
 150  * DESCRIPTION: Resolve an integer expression to a single value. Supports
 151  *              both integer constants and labels.
 152  *
 153  *****************************************************************************/
 154
 155 ACPI_STATUS
 156 DtResolveIntegerExpression (
 157     DT_FIELD                *Field,
 158     UINT64                  *ReturnValue)
 159 {
 160     UINT64                  Result;
 161
 162
 163     DbgPrint (ASL_DEBUG_OUTPUT, "Full Integer expression: %s\n",
 164         Field->Value);
 165
 166     Gbl_CurrentField = Field;
 167
 168     Result = DtEvaluateExpression (Field->Value);
 169     *ReturnValue = Result;
 170     return (AE_OK);
 171 }
 172
 173
 174 /******************************************************************************
 175  *
 176  * FUNCTION:    DtDoOperator
 177  *
 178  * PARAMETERS:  LeftValue           - First 64-bit operand
 179  *              Operator            - Parse token for the operator (EXPOP_*)
 180  *              RightValue          - Second 64-bit operand
 181  *
 182  * RETURN:      64-bit result of the requested operation
 183  *
 184  * DESCRIPTION: Perform the various 64-bit integer math functions
 185  *
 186  *****************************************************************************/
 187
 188 UINT64
 189 DtDoOperator (
 190     UINT64                  LeftValue,
 191     UINT32                  Operator,
 192     UINT64                  RightValue)
 193 {
 194     UINT64                  Result;
 195
 196
 197     /* Perform the requested operation */
 198
 199     switch (Operator)
 200     {
 201     case EXPOP_ONES_COMPLIMENT:
 202         Result = ~RightValue;
 203         break;
 204
 205     case EXPOP_LOGICAL_NOT:
 206         Result = !RightValue;
 207         break;
 208
 209     case EXPOP_MULTIPLY:
 210         Result = LeftValue * RightValue;
 211         break;
 212
 213     case EXPOP_DIVIDE:
 214         if (!RightValue)
 215         {
 216             DtError (ASL_ERROR, ASL_MSG_DIVIDE_BY_ZERO,
 217                 Gbl_CurrentField, Gbl_CurrentField->Value);
 218             return (0);
 219         }
 220         Result = LeftValue / RightValue;
 221         break;
 222
 223     case EXPOP_MODULO:
 224         if (!RightValue)
 225         {
 226             DtError (ASL_ERROR, ASL_MSG_DIVIDE_BY_ZERO,
 227                 Gbl_CurrentField, Gbl_CurrentField->Value);
 228             return (0);
 229         }
 230         Result = LeftValue % RightValue;
 231         break;
 232
 233     case EXPOP_ADD:
 234         Result = LeftValue + RightValue;
 235         break;
 236
 237     case EXPOP_SUBTRACT:
 238         Result = LeftValue - RightValue;
 239         break;
 240
 241     case EXPOP_SHIFT_RIGHT:
 242         Result = LeftValue >> RightValue;
 243         break;
 244
 245     case EXPOP_SHIFT_LEFT:
 246         Result = LeftValue << RightValue;
 247         break;
 248
 249     case EXPOP_LESS:
 250         Result = LeftValue < RightValue;
 251         break;
 252
 253     case EXPOP_GREATER:
 254         Result = LeftValue > RightValue;
 255         break;
 256
 257     case EXPOP_LESS_EQUAL:
 258         Result = LeftValue <= RightValue;
 259         break;
 260
 261     case EXPOP_GREATER_EQUAL:
 262         Result = LeftValue >= RightValue;
 263         break;
 264
 265     case EXPOP_EQUAL:
 266         Result = LeftValue = RightValue;
 267         break;
 268
 269     case EXPOP_NOT_EQUAL:
 270         Result = LeftValue != RightValue;
 271         break;
 272
 273     case EXPOP_AND:
 274         Result = LeftValue & RightValue;
 275         break;
 276
 277     case EXPOP_XOR:
 278         Result = LeftValue ^ RightValue;
 279         break;
 280
 281     case EXPOP_OR:
 282         Result = LeftValue | RightValue;
 283         break;
 284
 285     case EXPOP_LOGICAL_AND:
 286         Result = LeftValue && RightValue;
 287         break;
 288
 289     case EXPOP_LOGICAL_OR:
 290         Result = LeftValue || RightValue;
 291         break;
 292
 293    default:
 294
 295         /* Unknown operator */
 296
 297         DtFatal (ASL_MSG_INVALID_EXPRESSION,
 298             Gbl_CurrentField, Gbl_CurrentField->Value);
 299         return (0);
 300     }
 301
 302     DbgPrint (ASL_DEBUG_OUTPUT,
 303         "IntegerEval: %s (%8.8X%8.8X %s %8.8X%8.8X) = %8.8X%8.8X\n",
 304         Gbl_CurrentField->Value,
 305         ACPI_FORMAT_UINT64 (LeftValue),
 306         DtGetOpName (Operator),
 307         ACPI_FORMAT_UINT64 (RightValue),
 308         ACPI_FORMAT_UINT64 (Result));
 309
 310     return (Result);
 311 }
 312
 313
 314 /******************************************************************************
 315  *
 316  * FUNCTION:    DtResolveLabel
 317  *
 318  * PARAMETERS:  LabelString         - Contains the label
 319  *
 320  * RETURN:      Table offset associated with the label
 321  *
 322  * DESCRIPTION: Lookup a lable and return its value.
 323  *
 324  *****************************************************************************/
 325
 326 UINT64
 327 DtResolveLabel (
 328     char                    *LabelString)
 329 {
 330     DT_FIELD                *LabelField;
 331
 332
 333     DbgPrint (ASL_DEBUG_OUTPUT, "Resolve Label: %s\n", LabelString);
 334
 335     /* Resolve a label reference to an integer (table offset) */
 336
 337     if (*LabelString != '$')
 338     {
 339         return (0);
 340     }
 341
 342     LabelField = DtLookupLabel (LabelString);
 343     if (!LabelField)
 344     {
 345         DtError (ASL_ERROR, ASL_MSG_UNKNOWN_LABEL,
 346             Gbl_CurrentField, LabelString);
 347         return (0);
 348     }
 349
 350     /* All we need from the label is the offset in the table */
 351
 352     DbgPrint (ASL_DEBUG_OUTPUT, "Resolved Label: 0x%8.8X\n",
 353         LabelField->TableOffset);
 354
 355     return (LabelField->TableOffset);
 356 }
 357
 358
 359 /******************************************************************************
 360  *
 361  * FUNCTION:    DtDetectAllLabels
 362  *
 363  * PARAMETERS:  FieldList           - Field object at start of generic list
 364  *
 365  * RETURN:      None
 366  *
 367  * DESCRIPTION: Detect all labels in a list of "generic" opcodes (such as
 368  *              a UEFI table.) and insert them into the global label list.
 369  *
 370  *****************************************************************************/
 371
 372 void
 373 DtDetectAllLabels (
 374     DT_FIELD                *FieldList)
 375 {
 376     ACPI_DMTABLE_INFO       *Info;
 377     DT_FIELD                *GenericField;
 378     UINT32                  TableOffset;
 379
 380
 381     TableOffset = Gbl_CurrentTableOffset;
 382     GenericField = FieldList;
 383
 384     /*
 385      * Process all "Label:" fields within the parse tree. We need
 386      * to know the offsets for all labels before we can compile
 387      * the parse tree in order to handle forward references. Traverse
 388      * tree and get/set all field lengths of all operators in order to
 389      * determine the label offsets.
 390      */
 391     while (GenericField)
 392     {
 393         Info = DtGetGenericTableInfo (GenericField->Name);
 394         if (Info)
 395         {
 396             /* Maintain table offsets */
 397
 398             GenericField->TableOffset = TableOffset;
 399             TableOffset += DtGetFieldLength (GenericField, Info);
 400
 401             /* Insert all labels in the global label list */
 402
 403             if (Info->Opcode == ACPI_DMT_LABEL)
 404             {
 405                 DtInsertLabelField (GenericField);
 406             }
 407         }
 408
 409         GenericField = GenericField->Next;
 410     }
 411 }
 412
 413
 414 /******************************************************************************
 415  *
 416  * FUNCTION:    DtInsertLabelField
 417  *
 418  * PARAMETERS:  Field               - Field object with Label to be inserted
 419  *
 420  * RETURN:      None
 421  *
 422  * DESCRIPTION: Insert a label field into the global label list
 423  *
 424  *****************************************************************************/
 425
 426 static void
 427 DtInsertLabelField (
 428     DT_FIELD                *Field)
 429 {
 430
 431     DbgPrint (ASL_DEBUG_OUTPUT,
 432         "DtInsertLabelField: Found Label : %s at output table offset %X\n",
 433         Field->Value, Field->TableOffset);
 434
 435     Field->NextLabel = Gbl_LabelList;
 436     Gbl_LabelList = Field;
 437 }
 438
 439
 440 /******************************************************************************
 441  *
 442  * FUNCTION:    DtLookupLabel
 443  *
 444  * PARAMETERS:  Name                - Label to be resolved
 445  *
 446  * RETURN:      Field object associated with the label
 447  *
 448  * DESCRIPTION: Lookup a label in the global label list. Used during the
 449  *              resolution of integer expressions.
 450  *
 451  *****************************************************************************/
 452
 453 static DT_FIELD *
 454 DtLookupLabel (
 455     char                    *Name)
 456 {
 457     DT_FIELD                *LabelField;
 458
 459
 460     /* Skip a leading $ */
 461
 462     if (*Name == '$')
 463     {
 464         Name++;
 465     }
 466
 467     /* Search global list */
 468
 469     LabelField = Gbl_LabelList;
 470     while (LabelField)
 471     {
 472         if (!ACPI_STRCMP (Name, LabelField->Value))
 473         {
 474             return (LabelField);
 475         }
 476         LabelField = LabelField->NextLabel;
 477     }
 478
 479     return (NULL);
 480 }