2 /******************************************************************************
4 * Module Name: aslfold - Constant folding
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
119 #include "aslcompiler.h"
120 #include "aslcompiler.y.h"
123 #include "acdispat.h"
124 #include "acparser.h"
126 #define _COMPONENT ACPI_COMPILER
127 ACPI_MODULE_NAME ("aslfold")
129 /* Local prototypes */
132 OpcAmlEvaluationWalk1 (
133 ACPI_PARSE_OBJECT
*Op
,
138 OpcAmlEvaluationWalk2 (
139 ACPI_PARSE_OBJECT
*Op
,
144 OpcAmlCheckForConstant (
145 ACPI_PARSE_OBJECT
*Op
,
150 /*******************************************************************************
152 * FUNCTION: OpcAmlEvaluationWalk1
154 * PARAMETERS: ASL_WALK_CALLBACK
158 * DESCRIPTION: Descending callback for AML execution of constant subtrees
160 ******************************************************************************/
163 OpcAmlEvaluationWalk1 (
164 ACPI_PARSE_OBJECT
*Op
,
168 ACPI_WALK_STATE
*WalkState
= Context
;
170 ACPI_PARSE_OBJECT
*OutOp
;
174 WalkState
->Opcode
= Op
->Common
.AmlOpcode
;
175 WalkState
->OpInfo
= AcpiPsGetOpcodeInfo (Op
->Common
.AmlOpcode
);
177 /* Copy child pointer to Arg for compatibility with Interpreter */
181 Op
->Common
.Value
.Arg
= Op
->Asl
.Child
;
184 /* Call AML dispatcher */
186 Status
= AcpiDsExecBeginOp (WalkState
, &OutOp
);
187 if (ACPI_FAILURE (Status
))
189 AcpiOsPrintf ("Constant interpretation failed - %s\n",
190 AcpiFormatException (Status
));
197 /*******************************************************************************
199 * FUNCTION: OpcAmlEvaluationWalk2
201 * PARAMETERS: ASL_WALK_CALLBACK
205 * DESCRIPTION: Ascending callback for AML execution of constant subtrees
207 ******************************************************************************/
210 OpcAmlEvaluationWalk2 (
211 ACPI_PARSE_OBJECT
*Op
,
215 ACPI_WALK_STATE
*WalkState
= Context
;
220 WalkState
->Opcode
= Op
->Common
.AmlOpcode
;
221 WalkState
->OpInfo
= AcpiPsGetOpcodeInfo (Op
->Common
.AmlOpcode
);
223 /* Copy child pointer to Arg for compatibility with Interpreter */
227 Op
->Common
.Value
.Arg
= Op
->Asl
.Child
;
230 /* Call AML dispatcher */
232 Status
= AcpiDsExecEndOp (WalkState
);
233 if (ACPI_FAILURE (Status
))
235 AcpiOsPrintf ("Constant interpretation failed - %s\n",
236 AcpiFormatException (Status
));
243 /*******************************************************************************
245 * FUNCTION: OpcAmlCheckForConstant
247 * PARAMETERS: ASL_WALK_CALLBACK
251 * DESCRIPTION: Check one Op for a type 3/4/5 AML opcode
253 ******************************************************************************/
256 OpcAmlCheckForConstant (
257 ACPI_PARSE_OBJECT
*Op
,
261 ACPI_WALK_STATE
*WalkState
= Context
;
265 WalkState
->Opcode
= Op
->Common
.AmlOpcode
;
266 WalkState
->OpInfo
= AcpiPsGetOpcodeInfo (Op
->Common
.AmlOpcode
);
268 DbgPrint (ASL_PARSE_OUTPUT
, "[%.4d] Opcode: %12.12s ",
269 Op
->Asl
.LogicalLineNumber
, Op
->Asl
.ParseOpName
);
271 if (!(WalkState
->OpInfo
->Flags
& AML_CONSTANT
))
273 /* The opcode is not a Type 3/4/5 opcode */
275 if (Op
->Asl
.CompileFlags
& NODE_IS_TARGET
)
277 DbgPrint (ASL_PARSE_OUTPUT
,
278 "**** Valid Target, cannot reduce ****\n");
282 DbgPrint (ASL_PARSE_OUTPUT
,
283 "**** Not a Type 3/4/5 opcode ****\n");
286 if (WalkState
->WalkType
== ACPI_WALK_CONST_OPTIONAL
)
289 * We are looking at at normal expression to see if it can be
290 * reduced. It can't. No error
296 * This is an expression that MUST reduce to a constant, and it
297 * can't be reduced. This is an error
299 if (Op
->Asl
.CompileFlags
& NODE_IS_TARGET
)
301 AslError (ASL_ERROR
, ASL_MSG_INVALID_TARGET
, Op
,
302 Op
->Asl
.ParseOpName
);
306 AslError (ASL_ERROR
, ASL_MSG_INVALID_CONSTANT_OP
, Op
,
307 Op
->Asl
.ParseOpName
);
315 DbgPrint (ASL_PARSE_OUTPUT
, "TYPE_345");
317 if (Op
->Asl
.CompileFlags
& NODE_IS_TARGET
)
319 DbgPrint (ASL_PARSE_OUTPUT
, " TARGET");
321 if (Op
->Asl
.CompileFlags
& NODE_IS_TERM_ARG
)
323 DbgPrint (ASL_PARSE_OUTPUT
, " TERMARG");
325 DbgPrint (ASL_PARSE_OUTPUT
, "\n");
331 /*******************************************************************************
333 * FUNCTION: OpcAmlConstantWalk
335 * PARAMETERS: ASL_WALK_CALLBACK
339 * DESCRIPTION: Reduce an Op and its subtree to a constant if possible
341 ******************************************************************************/
345 ACPI_PARSE_OBJECT
*Op
,
349 ACPI_WALK_STATE
*WalkState
;
350 ACPI_STATUS Status
= AE_OK
;
351 ACPI_OPERAND_OBJECT
*ObjDesc
;
352 ACPI_PARSE_OBJECT
*RootOp
;
353 ACPI_PARSE_OBJECT
*OriginalParentOp
;
358 * Only interested in subtrees that could possibly contain
359 * expressions that can be evaluated at this time
361 if ((!(Op
->Asl
.CompileFlags
& NODE_COMPILE_TIME_CONST
)) ||
362 (Op
->Asl
.CompileFlags
& NODE_IS_TARGET
))
367 /* Set the walk type based on the reduction used for this op */
369 if (Op
->Asl
.CompileFlags
& NODE_IS_TERM_ARG
)
371 /* Op is a TermArg, constant folding is merely optional */
373 if (!Gbl_FoldConstants
)
375 return (AE_CTRL_DEPTH
);
378 WalkType
= ACPI_WALK_CONST_OPTIONAL
;
382 /* Op is a DataObject, the expression MUST reduced to a constant */
384 WalkType
= ACPI_WALK_CONST_REQUIRED
;
387 /* Create a new walk state */
389 WalkState
= AcpiDsCreateWalkState (0, NULL
, NULL
, NULL
);
395 WalkState
->NextOp
= NULL
;
396 WalkState
->Params
= NULL
;
397 WalkState
->CallerReturnDesc
= &ObjDesc
;
398 WalkState
->WalkType
= WalkType
;
401 * Examine the entire subtree -- all nodes must be constants
402 * or type 3/4/5 opcodes
404 Status
= TrWalkParseTree (Op
, ASL_WALK_VISIT_DOWNWARD
,
405 OpcAmlCheckForConstant
, NULL
, WalkState
);
408 * Did we find an entire subtree that contains all constants and type 3/4/5
409 * opcodes? (Only AE_OK or AE_TYPE returned from above)
411 if (Status
== AE_TYPE
)
413 /* Subtree cannot be reduced to a constant */
415 if (WalkState
->WalkType
== ACPI_WALK_CONST_OPTIONAL
)
417 AcpiDsDeleteWalkState (WalkState
);
421 /* Don't descend any further, and use a default "constant" value */
423 Status
= AE_CTRL_DEPTH
;
427 /* Subtree can be reduced */
429 /* Allocate a new temporary root for this subtree */
431 RootOp
= TrAllocateNode (PARSEOP_INTEGER
);
434 return (AE_NO_MEMORY
);
437 RootOp
->Common
.AmlOpcode
= AML_INT_EVAL_SUBTREE_OP
;
439 OriginalParentOp
= Op
->Common
.Parent
;
440 Op
->Common
.Parent
= RootOp
;
442 /* Hand off the subtree to the AML interpreter */
444 Status
= TrWalkParseTree (Op
, ASL_WALK_VISIT_TWICE
,
445 OpcAmlEvaluationWalk1
, OpcAmlEvaluationWalk2
, WalkState
);
446 Op
->Common
.Parent
= OriginalParentOp
;
448 /* TBD: we really *should* release the RootOp node */
450 if (ACPI_SUCCESS (Status
))
454 /* Get the final result */
456 Status
= AcpiDsResultPop (&ObjDesc
, WalkState
);
460 if (ACPI_FAILURE (Status
))
462 /* We could not resolve the subtree for some reason */
464 AslCoreSubsystemError (Op
, Status
,
465 "Failure during constant evaluation", FALSE
);
466 AslError (ASL_ERROR
, ASL_MSG_CONSTANT_EVALUATION
, Op
,
467 Op
->Asl
.ParseOpName
);
469 /* Set the subtree value to ZERO anyway. Eliminates further errors */
471 Op
->Asl
.ParseOpcode
= PARSEOP_INTEGER
;
472 Op
->Common
.Value
.Integer
= 0;
473 OpcSetOptimalIntegerSize (Op
);
477 AslError (ASL_OPTIMIZATION
, ASL_MSG_CONSTANT_FOLDED
, Op
,
478 Op
->Asl
.ParseOpName
);
481 * Because we know we executed type 3/4/5 opcodes above, we know that
482 * the result must be either an Integer, String, or Buffer.
484 switch (ACPI_GET_OBJECT_TYPE (ObjDesc
))
486 case ACPI_TYPE_INTEGER
:
488 Op
->Asl
.ParseOpcode
= PARSEOP_INTEGER
;
489 Op
->Common
.Value
.Integer
= ObjDesc
->Integer
.Value
;
490 OpcSetOptimalIntegerSize (Op
);
492 DbgPrint (ASL_PARSE_OUTPUT
,
493 "Constant expression reduced to (INTEGER) %8.8X%8.8X\n",
494 ACPI_FORMAT_UINT64 (ObjDesc
->Integer
.Value
));
498 case ACPI_TYPE_STRING
:
500 Op
->Asl
.ParseOpcode
= PARSEOP_STRING_LITERAL
;
501 Op
->Common
.AmlOpcode
= AML_STRING_OP
;
502 Op
->Asl
.AmlLength
= ACPI_STRLEN (ObjDesc
->String
.Pointer
) + 1;
503 Op
->Common
.Value
.String
= ObjDesc
->String
.Pointer
;
505 DbgPrint (ASL_PARSE_OUTPUT
,
506 "Constant expression reduced to (STRING) %s\n",
507 Op
->Common
.Value
.String
);
512 case ACPI_TYPE_BUFFER
:
514 Op
->Asl
.ParseOpcode
= PARSEOP_BUFFER
;
515 Op
->Common
.AmlOpcode
= AML_BUFFER_OP
;
516 Op
->Asl
.CompileFlags
= NODE_AML_PACKAGE
;
517 UtSetParseOpName (Op
);
519 /* Child node is the buffer length */
521 RootOp
= TrAllocateNode (PARSEOP_INTEGER
);
523 RootOp
->Asl
.AmlOpcode
= AML_DWORD_OP
;
524 RootOp
->Asl
.Value
.Integer
= ObjDesc
->Buffer
.Length
;
525 RootOp
->Asl
.Parent
= Op
;
527 (void) OpcSetOptimalIntegerSize (RootOp
);
529 Op
->Asl
.Child
= RootOp
;
531 UtSetParseOpName (Op
);
533 /* Peer to the child is the raw buffer data */
535 RootOp
= TrAllocateNode (PARSEOP_RAW_DATA
);
536 RootOp
->Asl
.AmlOpcode
= AML_RAW_DATA_BUFFER
;
537 RootOp
->Asl
.AmlLength
= ObjDesc
->Buffer
.Length
;
538 RootOp
->Asl
.Value
.String
= (char *) ObjDesc
->Buffer
.Pointer
;
539 RootOp
->Asl
.Parent
= Op
->Asl
.Parent
;
541 Op
->Asl
.Next
= RootOp
;
544 DbgPrint (ASL_PARSE_OUTPUT
,
545 "Constant expression reduced to (BUFFER) length %X\n",
546 ObjDesc
->Buffer
.Length
);
551 printf ("Unsupported return type: %s\n",
552 AcpiUtGetObjectTypeName (ObjDesc
));
557 UtSetParseOpName (Op
);
558 Op
->Asl
.Child
= NULL
;
560 AcpiDsDeleteWalkState (WalkState
);
562 return (AE_CTRL_DEPTH
);