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 - 2020, 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 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 *    notice, this list of conditions, and the following disclaimer,
124 *    without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 *    substantially similar to the "NO WARRANTY" disclaimer below
127 *    ("Disclaimer") and any redistribution must be conditioned upon
128 *    including a substantially similar Disclaimer requirement for further
129 *    binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 *    of any contributors may be used to endorse or promote products derived
132 *    from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152#include <contrib/dev/acpica/compiler/aslcompiler.h>
153#include "dtparser.y.h"
154
155#define _COMPONENT          DT_COMPILER
156        ACPI_MODULE_NAME    ("dtexpress")
157
158
159/* Local prototypes */
160
161static void
162DtInsertLabelField (
163    DT_FIELD                *Field);
164
165static DT_FIELD *
166DtLookupLabel (
167    char                    *Name);
168
169/* Global used for errors during parse and related functions */
170
171DT_FIELD                *AslGbl_CurrentField;
172
173
174/******************************************************************************
175 *
176 * FUNCTION:    DtResolveIntegerExpression
177 *
178 * PARAMETERS:  Field               - Field object with Integer expression
179 *              ReturnValue         - Where the integer is returned
180 *
181 * RETURN:      Status, and the resolved 64-bit integer value
182 *
183 * DESCRIPTION: Resolve an integer expression to a single value. Supports
184 *              both integer constants and labels.
185 *
186 *****************************************************************************/
187
188ACPI_STATUS
189DtResolveIntegerExpression (
190    DT_FIELD                *Field,
191    UINT64                  *ReturnValue)
192{
193    UINT64                  Result;
194
195
196    DbgPrint (ASL_DEBUG_OUTPUT, "Full Integer expression: %s\n",
197        Field->Value);
198
199    AslGbl_CurrentField = Field;
200
201    Result = DtEvaluateExpression (Field->Value);
202    *ReturnValue = Result;
203    return (AE_OK);
204}
205
206
207/******************************************************************************
208 *
209 * FUNCTION:    DtDoOperator
210 *
211 * PARAMETERS:  LeftValue           - First 64-bit operand
212 *              Operator            - Parse token for the operator (OP_EXP_*)
213 *              RightValue          - Second 64-bit operand
214 *
215 * RETURN:      64-bit result of the requested operation
216 *
217 * DESCRIPTION: Perform the various 64-bit integer math functions
218 *
219 *****************************************************************************/
220
221UINT64
222DtDoOperator (
223    UINT64                  LeftValue,
224    UINT32                  Operator,
225    UINT64                  RightValue)
226{
227    UINT64                  Result;
228
229
230    /* Perform the requested operation */
231
232    switch (Operator)
233    {
234    case OP_EXP_ONES_COMPLIMENT:
235
236        Result = ~RightValue;
237        break;
238
239    case OP_EXP_LOGICAL_NOT:
240
241        Result = !RightValue;
242        break;
243
244    case OP_EXP_MULTIPLY:
245
246        Result = LeftValue * RightValue;
247        break;
248
249    case OP_EXP_DIVIDE:
250
251        if (!RightValue)
252        {
253            DtError (ASL_ERROR, ASL_MSG_DIVIDE_BY_ZERO,
254                AslGbl_CurrentField, NULL);
255            return (0);
256        }
257
258        Result = LeftValue / RightValue;
259        break;
260
261    case OP_EXP_MODULO:
262
263        if (!RightValue)
264        {
265            DtError (ASL_ERROR, ASL_MSG_DIVIDE_BY_ZERO,
266                AslGbl_CurrentField, NULL);
267            return (0);
268        }
269
270        Result = LeftValue % RightValue;
271        break;
272
273    case OP_EXP_ADD:
274        Result = LeftValue + RightValue;
275        break;
276
277    case OP_EXP_SUBTRACT:
278
279        Result = LeftValue - RightValue;
280        break;
281
282    case OP_EXP_SHIFT_RIGHT:
283
284        Result = LeftValue >> RightValue;
285        break;
286
287    case OP_EXP_SHIFT_LEFT:
288
289        Result = LeftValue << RightValue;
290        break;
291
292    case OP_EXP_LESS:
293
294        Result = LeftValue < RightValue;
295        break;
296
297    case OP_EXP_GREATER:
298
299        Result = LeftValue > RightValue;
300        break;
301
302    case OP_EXP_LESS_EQUAL:
303
304        Result = LeftValue <= RightValue;
305        break;
306
307    case OP_EXP_GREATER_EQUAL:
308
309        Result = LeftValue >= RightValue;
310        break;
311
312    case OP_EXP_EQUAL:
313
314        Result = LeftValue == RightValue;
315        break;
316
317    case OP_EXP_NOT_EQUAL:
318
319        Result = LeftValue != RightValue;
320        break;
321
322    case OP_EXP_AND:
323
324        Result = LeftValue & RightValue;
325        break;
326
327    case OP_EXP_XOR:
328
329        Result = LeftValue ^ RightValue;
330        break;
331
332    case OP_EXP_OR:
333
334        Result = LeftValue | RightValue;
335        break;
336
337    case OP_EXP_LOGICAL_AND:
338
339        Result = LeftValue && RightValue;
340        break;
341
342    case OP_EXP_LOGICAL_OR:
343
344        Result = LeftValue || RightValue;
345        break;
346
347   default:
348
349        /* Unknown operator */
350
351        DtFatal (ASL_MSG_INVALID_EXPRESSION,
352            AslGbl_CurrentField, NULL);
353        return (0);
354    }
355
356    DbgPrint (ASL_DEBUG_OUTPUT,
357        "IntegerEval: (%8.8X%8.8X %s %8.8X%8.8X) = %8.8X%8.8X\n",
358        ACPI_FORMAT_UINT64 (LeftValue),
359        DtGetOpName (Operator),
360        ACPI_FORMAT_UINT64 (RightValue),
361        ACPI_FORMAT_UINT64 (Result));
362
363    return (Result);
364}
365
366
367/******************************************************************************
368 *
369 * FUNCTION:    DtResolveLabel
370 *
371 * PARAMETERS:  LabelString         - Contains the label
372 *
373 * RETURN:      Table offset associated with the label
374 *
375 * DESCRIPTION: Lookup a label and return its value.
376 *
377 *****************************************************************************/
378
379UINT64
380DtResolveLabel (
381    char                    *LabelString)
382{
383    DT_FIELD                *LabelField;
384
385
386    DbgPrint (ASL_DEBUG_OUTPUT, "Resolve Label: %s\n", LabelString);
387
388    /* Resolve a label reference to an integer (table offset) */
389
390    if (*LabelString != '$')
391    {
392        return (0);
393    }
394
395    LabelField = DtLookupLabel (LabelString);
396    if (!LabelField)
397    {
398        DtError (ASL_ERROR, ASL_MSG_UNKNOWN_LABEL,
399            AslGbl_CurrentField, LabelString);
400        return (0);
401    }
402
403    /* All we need from the label is the offset in the table */
404
405    DbgPrint (ASL_DEBUG_OUTPUT, "Resolved Label: 0x%8.8X\n",
406        LabelField->TableOffset);
407
408    return (LabelField->TableOffset);
409}
410
411
412/******************************************************************************
413 *
414 * FUNCTION:    DtDetectAllLabels
415 *
416 * PARAMETERS:  FieldList           - Field object at start of generic list
417 *
418 * RETURN:      None
419 *
420 * DESCRIPTION: Detect all labels in a list of "generic" opcodes (such as
421 *              a UEFI table.) and insert them into the global label list.
422 *
423 *****************************************************************************/
424
425void
426DtDetectAllLabels (
427    DT_FIELD                *FieldList)
428{
429    ACPI_DMTABLE_INFO       *Info;
430    DT_FIELD                *GenericField;
431    UINT32                  TableOffset;
432
433
434    TableOffset = AslGbl_CurrentTableOffset;
435    GenericField = FieldList;
436
437    /*
438     * Process all "Label:" fields within the parse tree. We need
439     * to know the offsets for all labels before we can compile
440     * the parse tree in order to handle forward references. Traverse
441     * tree and get/set all field lengths of all operators in order to
442     * determine the label offsets.
443     */
444    while (GenericField)
445    {
446        Info = DtGetGenericTableInfo (GenericField->Name);
447        if (Info)
448        {
449            /* Maintain table offsets */
450
451            GenericField->TableOffset = TableOffset;
452            TableOffset += DtGetFieldLength (GenericField, Info);
453
454            /* Insert all labels in the global label list */
455
456            if (Info->Opcode == ACPI_DMT_LABEL)
457            {
458                DtInsertLabelField (GenericField);
459            }
460        }
461
462        GenericField = GenericField->Next;
463    }
464}
465
466
467/******************************************************************************
468 *
469 * FUNCTION:    DtInsertLabelField
470 *
471 * PARAMETERS:  Field               - Field object with Label to be inserted
472 *
473 * RETURN:      None
474 *
475 * DESCRIPTION: Insert a label field into the global label list
476 *
477 *****************************************************************************/
478
479static void
480DtInsertLabelField (
481    DT_FIELD                *Field)
482{
483
484    DbgPrint (ASL_DEBUG_OUTPUT,
485        "DtInsertLabelField: Found Label : %s at output table offset %X\n",
486        Field->Value, Field->TableOffset);
487
488    Field->NextLabel = AslGbl_LabelList;
489    AslGbl_LabelList = Field;
490}
491
492
493/******************************************************************************
494 *
495 * FUNCTION:    DtLookupLabel
496 *
497 * PARAMETERS:  Name                - Label to be resolved
498 *
499 * RETURN:      Field object associated with the label
500 *
501 * DESCRIPTION: Lookup a label in the global label list. Used during the
502 *              resolution of integer expressions.
503 *
504 *****************************************************************************/
505
506static DT_FIELD *
507DtLookupLabel (
508    char                    *Name)
509{
510    DT_FIELD                *LabelField;
511
512
513    /* Skip a leading $ */
514
515    if (*Name == '$')
516    {
517        Name++;
518    }
519
520    /* Search global list */
521
522    LabelField = AslGbl_LabelList;
523    while (LabelField)
524    {
525        if (!strcmp (Name, LabelField->Value))
526        {
527            return (LabelField);
528        }
529
530        LabelField = LabelField->NextLabel;
531    }
532
533    return (NULL);
534}
535