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