1 /******************************************************************************
3 * Module Name: asltransform - Parse tree transforms
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <contrib/dev/acpica/compiler/aslcompiler.h>
45 #include "aslcompiler.y.h"
47 #define _COMPONENT ACPI_COMPILER
48 ACPI_MODULE_NAME ("asltransform")
50 /* Local prototypes */
54 ACPI_PARSE_OBJECT *Op);
57 TrAmlGetNextTempName (
58 ACPI_PARSE_OBJECT *Op,
62 TrAmlInitLineNumbers (
63 ACPI_PARSE_OBJECT *Op,
64 ACPI_PARSE_OBJECT *Neighbor);
68 ACPI_PARSE_OBJECT *Op,
72 TrAmlSetSubtreeParent (
73 ACPI_PARSE_OBJECT *Op,
74 ACPI_PARSE_OBJECT *Parent);
78 ACPI_PARSE_OBJECT *Op,
79 ACPI_PARSE_OBJECT *NewPeer);
83 ACPI_PARSE_OBJECT *Op);
87 ACPI_PARSE_OBJECT *StartNode);
90 /*******************************************************************************
92 * FUNCTION: TrAmlGetNextTempName
94 * PARAMETERS: Op - Current parse op
95 * TempCount - Current temporary counter. Was originally
96 * per-module; Currently per method, could be
97 * expanded to per-scope.
99 * RETURN: A pointer to name (allocated here).
101 * DESCRIPTION: Generate an ACPI name of the form _T_x. These names are
102 * reserved for use by the ASL compiler. (_T_0 through _T_Z)
104 ******************************************************************************/
107 TrAmlGetNextTempName (
108 ACPI_PARSE_OBJECT *Op,
114 if (*TempCount >= (10 + 26)) /* 0-35 valid: 0-9 and A-Z for TempName[3] */
118 AslError (ASL_ERROR, ASL_MSG_TOO_MANY_TEMPS, Op, NULL);
122 TempName = UtLocalCalloc (5);
124 if (*TempCount < 10) /* 0-9 */
126 TempName[3] = (char) (*TempCount + '0');
128 else /* 10-35: A-Z */
130 TempName[3] = (char) (*TempCount + ('A' - 10));
135 /* First three characters are always "_T_" */
145 /*******************************************************************************
147 * FUNCTION: TrAmlInitLineNumbers
149 * PARAMETERS: Op - Op to be initialized
150 * Neighbor - Op used for initialization values
154 * DESCRIPTION: Initialized the various line numbers for a parse node.
156 ******************************************************************************/
159 TrAmlInitLineNumbers (
160 ACPI_PARSE_OBJECT *Op,
161 ACPI_PARSE_OBJECT *Neighbor)
164 Op->Asl.EndLine = Neighbor->Asl.EndLine;
165 Op->Asl.EndLogicalLine = Neighbor->Asl.EndLogicalLine;
166 Op->Asl.LineNumber = Neighbor->Asl.LineNumber;
167 Op->Asl.LogicalByteOffset = Neighbor->Asl.LogicalByteOffset;
168 Op->Asl.LogicalLineNumber = Neighbor->Asl.LogicalLineNumber;
172 /*******************************************************************************
174 * FUNCTION: TrAmlInitNode
176 * PARAMETERS: Op - Op to be initialized
177 * ParseOpcode - Opcode for this node
181 * DESCRIPTION: Initialize a node with the parse opcode and opcode name.
183 ******************************************************************************/
187 ACPI_PARSE_OBJECT *Op,
191 Op->Asl.ParseOpcode = ParseOpcode;
192 UtSetParseOpName (Op);
196 /*******************************************************************************
198 * FUNCTION: TrAmlSetSubtreeParent
200 * PARAMETERS: Op - First node in a list of peer nodes
201 * Parent - Parent of the subtree
205 * DESCRIPTION: Set the parent for all peer nodes in a subtree
207 ******************************************************************************/
210 TrAmlSetSubtreeParent (
211 ACPI_PARSE_OBJECT *Op,
212 ACPI_PARSE_OBJECT *Parent)
214 ACPI_PARSE_OBJECT *Next;
220 Next->Asl.Parent = Parent;
221 Next = Next->Asl.Next;
226 /*******************************************************************************
228 * FUNCTION: TrAmlInsertPeer
230 * PARAMETERS: Op - First node in a list of peer nodes
231 * NewPeer - Peer node to insert
235 * DESCRIPTION: Insert a new peer node into a list of peers.
237 ******************************************************************************/
241 ACPI_PARSE_OBJECT *Op,
242 ACPI_PARSE_OBJECT *NewPeer)
245 NewPeer->Asl.Next = Op->Asl.Next;
246 Op->Asl.Next = NewPeer;
250 /*******************************************************************************
252 * FUNCTION: TrAmlTransformWalkBegin
254 * PARAMETERS: ASL_WALK_CALLBACK
258 * DESCRIPTION: Parse tree walk to generate both the AML opcodes and the AML
261 ******************************************************************************/
264 TrAmlTransformWalkBegin (
265 ACPI_PARSE_OBJECT *Op,
270 TrTransformSubtree (Op);
275 /*******************************************************************************
277 * FUNCTION: TrAmlTransformWalkEnd
279 * PARAMETERS: ASL_WALK_CALLBACK
283 * DESCRIPTION: Parse tree walk to generate both the AML opcodes and the AML
286 ******************************************************************************/
289 TrAmlTransformWalkEnd (
290 ACPI_PARSE_OBJECT *Op,
295 /* Save possible Externals list in the DefintionBlock Op */
297 if (Op->Asl.ParseOpcode == PARSEOP_DEFINITION_BLOCK)
299 Op->Asl.Value.Arg = Gbl_ExternalsListHead;
300 Gbl_ExternalsListHead = NULL;
307 /*******************************************************************************
309 * FUNCTION: TrTransformSubtree
311 * PARAMETERS: Op - The parent parse node
315 * DESCRIPTION: Prepare nodes to be output as AML data and operands. The more
316 * complex AML opcodes require processing of the child nodes
317 * (arguments/operands).
319 ******************************************************************************/
323 ACPI_PARSE_OBJECT *Op)
326 if (Op->Asl.AmlOpcode == AML_RAW_DATA_BYTE)
331 switch (Op->Asl.ParseOpcode)
333 case PARSEOP_DEFINITION_BLOCK:
335 TrDoDefinitionBlock (Op);
345 * TBD: Zero the tempname (_T_x) count. Probably shouldn't be a global,
351 case PARSEOP_EXTERNAL:
353 if (Gbl_DoExternals == TRUE)
362 /* Nothing to do here for other opcodes */
369 /*******************************************************************************
371 * FUNCTION: TrDoDefinitionBlock
373 * PARAMETERS: Op - Parse node
377 * DESCRIPTION: Find the end of the definition block and set a global to this
378 * node. It is used by the compiler to insert compiler-generated
379 * names at the root level of the namespace.
381 ******************************************************************************/
384 TrDoDefinitionBlock (
385 ACPI_PARSE_OBJECT *Op)
387 ACPI_PARSE_OBJECT *Next;
391 /* Reset external list when starting a definition block */
393 Gbl_ExternalsListHead = NULL;
395 Next = Op->Asl.Child;
396 for (i = 0; i < 5; i++)
398 Next = Next->Asl.Next;
402 * This is the table signature. Only the DSDT can be assumed
403 * to be at the root of the namespace; Therefore, namepath
404 * optimization can only be performed on the DSDT.
406 if (!ACPI_COMPARE_NAME (Next->Asl.Value.String, ACPI_SIG_DSDT))
408 Gbl_ReferenceOptimizationFlag = FALSE;
413 Gbl_FirstLevelInsertionNode = Next;
417 /*******************************************************************************
419 * FUNCTION: TrDoSwitch
421 * PARAMETERS: StartNode - Parse node for SWITCH
425 * DESCRIPTION: Translate ASL SWITCH statement to if/else pairs. There is
426 * no actual AML opcode for SWITCH -- it must be simulated.
428 ******************************************************************************/
432 ACPI_PARSE_OBJECT *StartNode)
434 ACPI_PARSE_OBJECT *Next;
435 ACPI_PARSE_OBJECT *CaseOp = NULL;
436 ACPI_PARSE_OBJECT *CaseBlock = NULL;
437 ACPI_PARSE_OBJECT *DefaultOp = NULL;
438 ACPI_PARSE_OBJECT *CurrentParentNode;
439 ACPI_PARSE_OBJECT *Conditional = NULL;
440 ACPI_PARSE_OBJECT *Predicate;
441 ACPI_PARSE_OBJECT *Peer;
442 ACPI_PARSE_OBJECT *NewOp;
443 ACPI_PARSE_OBJECT *NewOp2;
444 ACPI_PARSE_OBJECT *MethodOp;
445 ACPI_PARSE_OBJECT *StoreOp;
446 ACPI_PARSE_OBJECT *BreakOp;
447 ACPI_PARSE_OBJECT *BufferOp;
448 char *PredicateValueName;
453 /* Start node is the Switch() node */
455 CurrentParentNode = StartNode;
457 /* Create a new temp name of the form _T_x */
459 PredicateValueName = TrAmlGetNextTempName (StartNode, &Gbl_TempCount);
460 if (!PredicateValueName)
465 /* First child is the Switch() predicate */
467 Next = StartNode->Asl.Child;
470 * Examine the return type of the Switch Value -
471 * must be Integer/Buffer/String
473 Index = (UINT16) (Next->Asl.ParseOpcode - ASL_PARSE_OPCODE_BASE);
474 Btype = AslKeywordMapping[Index].AcpiBtype;
475 if ((Btype != ACPI_BTYPE_INTEGER) &&
476 (Btype != ACPI_BTYPE_STRING) &&
477 (Btype != ACPI_BTYPE_BUFFER))
479 AslError (ASL_WARNING, ASL_MSG_SWITCH_TYPE, Next, NULL);
480 Btype = ACPI_BTYPE_INTEGER;
483 /* CASE statements start at next child */
485 Peer = Next->Asl.Next;
489 Peer = Next->Asl.Next;
491 if (Next->Asl.ParseOpcode == PARSEOP_CASE)
495 /* Add an ELSE to complete the previous CASE */
497 NewOp = TrCreateLeafNode (PARSEOP_ELSE);
498 NewOp->Asl.Parent = Conditional->Asl.Parent;
499 TrAmlInitLineNumbers (NewOp, NewOp->Asl.Parent);
501 /* Link ELSE node as a peer to the previous IF */
503 TrAmlInsertPeer (Conditional, NewOp);
504 CurrentParentNode = NewOp;
508 Conditional = CaseOp;
509 CaseBlock = CaseOp->Asl.Child->Asl.Next;
510 Conditional->Asl.Child->Asl.Next = NULL;
511 Predicate = CaseOp->Asl.Child;
513 if ((Predicate->Asl.ParseOpcode == PARSEOP_PACKAGE) ||
514 (Predicate->Asl.ParseOpcode == PARSEOP_VAR_PACKAGE))
517 * Convert the package declaration to this form:
519 * If (LNotEqual (Match (Package(<size>){<data>},
520 * MEQ, _T_x, MTR, Zero, Zero), Ones))
522 NewOp2 = TrCreateLeafNode (PARSEOP_MATCHTYPE_MEQ);
523 Predicate->Asl.Next = NewOp2;
524 TrAmlInitLineNumbers (NewOp2, Conditional);
527 NewOp2 = TrCreateValuedLeafNode (PARSEOP_NAMESTRING,
528 (UINT64) ACPI_TO_INTEGER (PredicateValueName));
529 NewOp->Asl.Next = NewOp2;
530 TrAmlInitLineNumbers (NewOp2, Predicate);
533 NewOp2 = TrCreateLeafNode (PARSEOP_MATCHTYPE_MTR);
534 NewOp->Asl.Next = NewOp2;
535 TrAmlInitLineNumbers (NewOp2, Predicate);
538 NewOp2 = TrCreateLeafNode (PARSEOP_ZERO);
539 NewOp->Asl.Next = NewOp2;
540 TrAmlInitLineNumbers (NewOp2, Predicate);
543 NewOp2 = TrCreateLeafNode (PARSEOP_ZERO);
544 NewOp->Asl.Next = NewOp2;
545 TrAmlInitLineNumbers (NewOp2, Predicate);
547 NewOp2 = TrCreateLeafNode (PARSEOP_MATCH);
548 NewOp2->Asl.Child = Predicate; /* PARSEOP_PACKAGE */
549 TrAmlInitLineNumbers (NewOp2, Conditional);
550 TrAmlSetSubtreeParent (Predicate, NewOp2);
553 NewOp2 = TrCreateLeafNode (PARSEOP_ONES);
554 NewOp->Asl.Next = NewOp2;
555 TrAmlInitLineNumbers (NewOp2, Conditional);
557 NewOp2 = TrCreateLeafNode (PARSEOP_LEQUAL);
558 NewOp2->Asl.Child = NewOp;
559 NewOp->Asl.Parent = NewOp2;
560 TrAmlInitLineNumbers (NewOp2, Conditional);
561 TrAmlSetSubtreeParent (NewOp, NewOp2);
564 NewOp2 = TrCreateLeafNode (PARSEOP_LNOT);
565 NewOp2->Asl.Child = NewOp;
566 NewOp2->Asl.Parent = Conditional;
567 NewOp->Asl.Parent = NewOp2;
568 TrAmlInitLineNumbers (NewOp2, Conditional);
570 Conditional->Asl.Child = NewOp2;
571 NewOp2->Asl.Next = CaseBlock;
576 * Integer and Buffer case.
578 * Change CaseOp() to: If (LEqual (SwitchValue, CaseValue)) {...}
579 * Note: SwitchValue is first to allow the CaseValue to be implicitly
580 * converted to the type of SwitchValue if necessary.
582 * CaseOp->Child is the case value
583 * CaseOp->Child->Peer is the beginning of the case block
585 NewOp = TrCreateValuedLeafNode (PARSEOP_NAMESTRING,
586 (UINT64) ACPI_TO_INTEGER (PredicateValueName));
587 NewOp->Asl.Next = Predicate;
588 TrAmlInitLineNumbers (NewOp, Predicate);
590 NewOp2 = TrCreateLeafNode (PARSEOP_LEQUAL);
591 NewOp2->Asl.Parent = Conditional;
592 NewOp2->Asl.Child = NewOp;
593 TrAmlInitLineNumbers (NewOp2, Conditional);
595 TrAmlSetSubtreeParent (NewOp, NewOp2);
598 Predicate->Asl.Next = CaseBlock;
600 TrAmlSetSubtreeParent (Predicate, Conditional);
601 Conditional->Asl.Child = Predicate;
604 /* Reinitialize the CASE node to an IF node */
606 TrAmlInitNode (Conditional, PARSEOP_IF);
609 * The first CASE(IF) is not nested under an ELSE.
610 * All other CASEs are children of a parent ELSE.
612 if (CurrentParentNode == StartNode)
614 Conditional->Asl.Next = NULL;
619 * The IF is a child of previous IF/ELSE. It
620 * is therefore without peer.
622 CurrentParentNode->Asl.Child = Conditional;
623 Conditional->Asl.Parent = CurrentParentNode;
624 Conditional->Asl.Next = NULL;
627 else if (Next->Asl.ParseOpcode == PARSEOP_DEFAULT)
632 * More than one Default
633 * (Parser does not catch this, must check here)
635 AslError (ASL_ERROR, ASL_MSG_MULTIPLE_DEFAULT, Next, NULL);
639 /* Save the DEFAULT node for later, after CASEs */
646 /* Unknown peer opcode */
648 AcpiOsPrintf ("Unknown parse opcode for switch statement: %s (%u)\n",
649 Next->Asl.ParseOpName, Next->Asl.ParseOpcode);
653 /* Add the default case at the end of the if/else construct */
657 /* If no CASE statements, this is an error - see below */
661 /* Convert the DEFAULT node to an ELSE */
663 TrAmlInitNode (DefaultOp, PARSEOP_ELSE);
664 DefaultOp->Asl.Parent = Conditional->Asl.Parent;
666 /* Link ELSE node as a peer to the previous IF */
668 TrAmlInsertPeer (Conditional, DefaultOp);
674 AslError (ASL_ERROR, ASL_MSG_NO_CASES, StartNode, NULL);
679 * Create a Name(_T_x, ...) statement. This statement must appear at the
680 * method level, in case a loop surrounds the switch statement and could
681 * cause the name to be created twice (error).
684 /* Create the Name node */
686 Predicate = StartNode->Asl.Child;
687 NewOp = TrCreateLeafNode (PARSEOP_NAME);
688 TrAmlInitLineNumbers (NewOp, StartNode);
690 /* Find the parent method */
693 while ((Next->Asl.ParseOpcode != PARSEOP_METHOD) &&
694 (Next->Asl.ParseOpcode != PARSEOP_DEFINITION_BLOCK))
696 Next = Next->Asl.Parent;
700 NewOp->Asl.CompileFlags |= NODE_COMPILER_EMITTED;
701 NewOp->Asl.Parent = Next;
703 /* Insert name after the method name and arguments */
705 Next = Next->Asl.Child; /* Name */
706 Next = Next->Asl.Next; /* NumArgs */
707 Next = Next->Asl.Next; /* SerializeRule */
710 * If method is not Serialized, we must make is so, because of the way
711 * that Switch() must be implemented -- we cannot allow multiple threads
712 * to execute this method concurrently since we need to create local
715 if (Next->Asl.ParseOpcode != PARSEOP_SERIALIZERULE_SERIAL)
717 AslError (ASL_REMARK, ASL_MSG_SERIALIZED, MethodOp,
718 "Due to use of Switch operator");
719 Next->Asl.ParseOpcode = PARSEOP_SERIALIZERULE_SERIAL;
722 Next = Next->Asl.Next; /* SyncLevel */
723 Next = Next->Asl.Next; /* ReturnType */
724 Next = Next->Asl.Next; /* ParameterTypes */
726 TrAmlInsertPeer (Next, NewOp);
727 TrAmlInitLineNumbers (NewOp, Next);
729 /* Create the NameSeg child for the Name node */
731 NewOp2 = TrCreateValuedLeafNode (PARSEOP_NAMESEG,
732 (UINT64) ACPI_TO_INTEGER (PredicateValueName));
733 TrAmlInitLineNumbers (NewOp2, NewOp);
734 NewOp2->Asl.CompileFlags |= NODE_IS_NAME_DECLARATION;
735 NewOp->Asl.Child = NewOp2;
737 /* Create the initial value for the Name. Btype was already validated above */
741 case ACPI_BTYPE_INTEGER:
743 NewOp2->Asl.Next = TrCreateValuedLeafNode (PARSEOP_ZERO,
745 TrAmlInitLineNumbers (NewOp2->Asl.Next, NewOp);
748 case ACPI_BTYPE_STRING:
750 NewOp2->Asl.Next = TrCreateValuedLeafNode (PARSEOP_STRING_LITERAL,
751 (UINT64) ACPI_TO_INTEGER (""));
752 TrAmlInitLineNumbers (NewOp2->Asl.Next, NewOp);
755 case ACPI_BTYPE_BUFFER:
757 (void) TrLinkPeerNode (NewOp2, TrCreateValuedLeafNode (PARSEOP_BUFFER,
759 Next = NewOp2->Asl.Next;
760 TrAmlInitLineNumbers (Next, NewOp2);
761 (void) TrLinkChildren (Next, 1, TrCreateValuedLeafNode (PARSEOP_ZERO,
763 TrAmlInitLineNumbers (Next->Asl.Child, Next);
765 BufferOp = TrCreateValuedLeafNode (PARSEOP_DEFAULT_ARG, (UINT64) 0);
766 TrAmlInitLineNumbers (BufferOp, Next->Asl.Child);
767 (void) TrLinkPeerNode (Next->Asl.Child, BufferOp);
769 TrAmlSetSubtreeParent (Next->Asl.Child, Next);
777 TrAmlSetSubtreeParent (NewOp2, NewOp);
780 * Transform the Switch() into a While(One)-Break node.
781 * And create a Store() node which will be used to save the
782 * Switch() value. The store is of the form: Store (Value, _T_x)
783 * where _T_x is the temp variable.
785 TrAmlInitNode (StartNode, PARSEOP_WHILE);
786 NewOp = TrCreateLeafNode (PARSEOP_ONE);
787 TrAmlInitLineNumbers (NewOp, StartNode);
788 NewOp->Asl.Next = Predicate->Asl.Next;
789 NewOp->Asl.Parent = StartNode;
790 StartNode->Asl.Child = NewOp;
792 /* Create a Store() node */
794 StoreOp = TrCreateLeafNode (PARSEOP_STORE);
795 TrAmlInitLineNumbers (StoreOp, NewOp);
796 StoreOp->Asl.Parent = StartNode;
797 TrAmlInsertPeer (NewOp, StoreOp);
799 /* Complete the Store subtree */
801 StoreOp->Asl.Child = Predicate;
802 Predicate->Asl.Parent = StoreOp;
804 NewOp = TrCreateValuedLeafNode (PARSEOP_NAMESEG,
805 (UINT64) ACPI_TO_INTEGER (PredicateValueName));
806 TrAmlInitLineNumbers (NewOp, StoreOp);
807 NewOp->Asl.Parent = StoreOp;
808 Predicate->Asl.Next = NewOp;
810 /* Create a Break() node and insert it into the end of While() */
812 Conditional = StartNode->Asl.Child;
813 while (Conditional->Asl.Next)
815 Conditional = Conditional->Asl.Next;
818 BreakOp = TrCreateLeafNode (PARSEOP_BREAK);
819 TrAmlInitLineNumbers (BreakOp, NewOp);
820 BreakOp->Asl.Parent = StartNode;
821 TrAmlInsertPeer (Conditional, BreakOp);