1 /******************************************************************************
3 * Module Name: aslutils -- compiler utilities
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
152 #include <contrib/dev/acpica/compiler/aslcompiler.h>
153 #include "aslcompiler.y.h"
154 #include <contrib/dev/acpica/include/acdisasm.h>
155 #include <contrib/dev/acpica/include/acnamesp.h>
156 #include <contrib/dev/acpica/include/amlcode.h>
157 #include <contrib/dev/acpica/include/acapps.h>
158 #include <sys/stat.h>
161 #define _COMPONENT ACPI_COMPILER
162 ACPI_MODULE_NAME ("aslutils")
165 /* Local prototypes */
168 UtPadNameWithUnderscores (
170 char *PaddedNameSeg);
174 ACPI_PARSE_OBJECT *Op,
178 /*******************************************************************************
180 * FUNCTION: UtIsBigEndianMachine
184 * RETURN: TRUE if machine is big endian
185 * FALSE if machine is little endian
187 * DESCRIPTION: Detect whether machine is little endian or big endian.
189 ******************************************************************************/
192 UtIsBigEndianMachine (
198 } Overlay = {0xFF000000};
201 return (Overlay.Bytes[0]); /* Returns 0xFF (TRUE) for big endian */
205 /******************************************************************************
207 * FUNCTION: UtQueryForOverwrite
209 * PARAMETERS: Pathname - Output filename
211 * RETURN: TRUE if file does not exist or overwrite is authorized
213 * DESCRIPTION: Query for file overwrite if it already exists.
215 ******************************************************************************/
218 UtQueryForOverwrite (
221 struct stat StatInfo;
224 if (!stat (Pathname, &StatInfo))
226 fprintf (stderr, "Target file \"%s\" already exists, overwrite? [y|n] ",
229 if (getchar () != 'y')
239 /*******************************************************************************
241 * FUNCTION: UtNodeIsDescendantOf
243 * PARAMETERS: Node1 - Child node
244 * Node2 - Possible parent node
248 * DESCRIPTION: Returns TRUE if Node1 is a descendant of Node2. Otherwise,
249 * return FALSE. Note, we assume a NULL Node2 element to be the
250 * topmost (root) scope. All nodes are descendants of the root.
251 * Note: Nodes at the same level (siblings) are not considered
254 ******************************************************************************/
257 UtNodeIsDescendantOf (
258 ACPI_NAMESPACE_NODE *Node1,
259 ACPI_NAMESPACE_NODE *Node2)
269 return (TRUE); /* All nodes descend from the root */
272 /* Walk upward until the root is reached or parent is found */
281 Node1 = Node1->Parent;
288 /*******************************************************************************
290 * FUNCTION: UtGetParentMethod
292 * PARAMETERS: Node - Namespace node for any object
294 * RETURN: Namespace node for the parent method
295 * NULL - object is not within a method
297 * DESCRIPTION: Find the parent (owning) method node for a namespace object
299 ******************************************************************************/
303 ACPI_NAMESPACE_NODE *Node)
305 ACPI_NAMESPACE_NODE *ParentNode;
313 /* Walk upward until a method is found, or the root is reached */
315 ParentNode = Node->Parent;
318 if (ParentNode->Type == ACPI_TYPE_METHOD)
323 ParentNode = ParentNode->Parent;
326 return (NULL); /* Object is not within a control method */
330 /*******************************************************************************
332 * FUNCTION: UtDisplaySupportedTables
338 * DESCRIPTION: Print all supported ACPI table names.
340 ******************************************************************************/
343 UtDisplaySupportedTables (
346 const AH_TABLE *TableData;
350 printf ("\nACPI tables supported by iASL version %8.8X:\n"
351 " (Compiler, Disassembler, Template Generator)\n\n",
354 /* All ACPI tables with the common table header */
356 printf ("\n Supported ACPI tables:\n");
357 for (TableData = AcpiGbl_SupportedTables, i = 1;
358 TableData->Signature; TableData++, i++)
360 printf ("%8u) %s %s\n", i,
361 TableData->Signature, TableData->Description);
366 /*******************************************************************************
368 * FUNCTION: UtDisplayConstantOpcodes
374 * DESCRIPTION: Print AML opcodes that can be used in constant expressions.
376 ******************************************************************************/
379 UtDisplayConstantOpcodes (
385 printf ("Constant expression opcode information\n\n");
387 for (i = 0; i < sizeof (AcpiGbl_AmlOpInfo) / sizeof (ACPI_OPCODE_INFO); i++)
389 if (AcpiGbl_AmlOpInfo[i].Flags & AML_CONSTANT)
391 printf ("%s\n", AcpiGbl_AmlOpInfo[i].Name);
397 /*******************************************************************************
399 * FUNCTION: UtBeginEvent
401 * PARAMETERS: Name - Ascii name of this event
403 * RETURN: Event number (integer index)
405 * DESCRIPTION: Saves the current time with this event
407 ******************************************************************************/
414 if (AslGbl_NextEvent >= ASL_NUM_EVENTS)
416 AcpiOsPrintf ("Ran out of compiler event structs!\n");
417 return (AslGbl_NextEvent);
420 /* Init event with current (start) time */
422 AslGbl_Events[AslGbl_NextEvent].StartTime = AcpiOsGetTimer ();
423 AslGbl_Events[AslGbl_NextEvent].EventName = Name;
424 AslGbl_Events[AslGbl_NextEvent].Valid = TRUE;
425 return (AslGbl_NextEvent++);
429 /*******************************************************************************
431 * FUNCTION: UtEndEvent
433 * PARAMETERS: Event - Event number (integer index)
437 * DESCRIPTION: Saves the current time (end time) with this event
439 ******************************************************************************/
446 if (Event >= ASL_NUM_EVENTS)
451 /* Insert end time for event */
453 AslGbl_Events[Event].EndTime = AcpiOsGetTimer ();
457 /*******************************************************************************
461 * PARAMETERS: Type - Type of output
462 * Fmt - Printf format string
463 * ... - variable printf list
467 * DESCRIPTION: Conditional print statement. Prints to stderr only if the
470 ******************************************************************************/
481 if (!AslGbl_DebugFlag)
486 if ((Type == ASL_PARSE_OUTPUT) &&
487 (!(AslCompilerdebug)))
492 va_start (Args, Fmt);
493 (void) vfprintf (stderr, Fmt, Args);
499 /*******************************************************************************
501 * FUNCTION: UtSetParseOpName
503 * PARAMETERS: Op - Parse op to be named.
507 * DESCRIPTION: Insert the ascii name of the parse opcode
509 ******************************************************************************/
513 ACPI_PARSE_OBJECT *Op)
516 AcpiUtSafeStrncpy (Op->Asl.ParseOpName, UtGetOpName (Op->Asl.ParseOpcode),
517 ACPI_MAX_PARSEOP_NAME);
521 /*******************************************************************************
523 * FUNCTION: UtDisplaySummary
525 * PARAMETERS: FileID - ID of outpout file
529 * DESCRIPTION: Display compilation statistics
531 ******************************************************************************/
540 if (FileId != ASL_FILE_STDOUT)
542 /* Compiler name and version number */
544 FlPrintFile (FileId, "%s version %X\n\n",
545 ASL_COMPILER_NAME, (UINT32) ACPI_CA_VERSION);
548 /* Summary of main input and output files */
550 if (AslGbl_FileType == ASL_INPUT_TYPE_ASCII_DATA)
553 "%-14s %s - %u lines, %u bytes, %u fields\n",
555 AslGbl_Files[ASL_FILE_INPUT].Filename, AslGbl_CurrentLineNumber,
556 AslGbl_InputByteCount, AslGbl_InputFieldCount);
558 if ((AslGbl_ExceptionCount[ASL_ERROR] == 0) || (AslGbl_IgnoreErrors))
561 "%-14s %s - %u bytes\n",
563 AslGbl_Files[ASL_FILE_AML_OUTPUT].Filename, AslGbl_TableLength);
569 "%-14s %s - %u lines, %u bytes, %u keywords\n",
571 AslGbl_Files[ASL_FILE_INPUT].Filename, AslGbl_CurrentLineNumber,
572 AslGbl_OriginalInputFileSize, AslGbl_TotalKeywords);
576 if ((AslGbl_ExceptionCount[ASL_ERROR] == 0) || (AslGbl_IgnoreErrors))
578 if (AslGbl_Files[ASL_FILE_AML_OUTPUT].Handle)
581 "%-14s %s - %u bytes, %u named objects, "
582 "%u executable opcodes\n",
584 AslGbl_Files[ASL_FILE_AML_OUTPUT].Filename,
585 FlGetFileSize (ASL_FILE_AML_OUTPUT),
586 AslGbl_TotalNamedObjects, AslGbl_TotalExecutableOpcodes);
591 /* Display summary of any optional files */
593 for (i = ASL_FILE_SOURCE_OUTPUT; i <= ASL_MAX_FILE_TYPE; i++)
595 if (!AslGbl_Files[i].Filename || !AslGbl_Files[i].Handle)
600 /* .SRC is a temp file unless specifically requested */
602 if ((i == ASL_FILE_SOURCE_OUTPUT) && (!AslGbl_SourceOutputFlag))
607 /* .PRE is the preprocessor intermediate file */
609 if ((i == ASL_FILE_PREPROCESSOR) && (!AslGbl_KeepPreprocessorTempFile))
614 FlPrintFile (FileId, "%14s %s - %u bytes\n",
615 AslGbl_Files[i].ShortDescription,
616 AslGbl_Files[i].Filename, FlGetFileSize (i));
622 "\nCompilation complete. %u Errors, %u Warnings, %u Remarks",
623 AslGbl_ExceptionCount[ASL_ERROR],
624 AslGbl_ExceptionCount[ASL_WARNING] +
625 AslGbl_ExceptionCount[ASL_WARNING2] +
626 AslGbl_ExceptionCount[ASL_WARNING3],
627 AslGbl_ExceptionCount[ASL_REMARK]);
629 if (AslGbl_FileType != ASL_INPUT_TYPE_ASCII_DATA)
631 FlPrintFile (FileId, ", %u Optimizations",
632 AslGbl_ExceptionCount[ASL_OPTIMIZATION]);
634 if (AslGbl_TotalFolds)
636 FlPrintFile (FileId, ", %u Constants Folded", AslGbl_TotalFolds);
640 FlPrintFile (FileId, "\n");
644 /*******************************************************************************
646 * FUNCTION: UtCheckIntegerRange
648 * PARAMETERS: Op - Integer parse node
649 * LowValue - Smallest allowed value
650 * HighValue - Largest allowed value
652 * RETURN: Op if OK, otherwise NULL
654 * DESCRIPTION: Check integer for an allowable range
656 ******************************************************************************/
659 UtCheckIntegerRange (
660 ACPI_PARSE_OBJECT *Op,
670 if ((Op->Asl.Value.Integer < LowValue) ||
671 (Op->Asl.Value.Integer > HighValue))
673 sprintf (AslGbl_MsgBuffer, "0x%X, allowable: 0x%X-0x%X",
674 (UINT32) Op->Asl.Value.Integer, LowValue, HighValue);
676 AslError (ASL_ERROR, ASL_MSG_RANGE, Op, AslGbl_MsgBuffer);
684 /*******************************************************************************
686 * FUNCTION: UtInternalizeName
688 * PARAMETERS: ExternalName - Name to convert
689 * ConvertedName - Where the converted name is returned
693 * DESCRIPTION: Convert an external (ASL) name to an internal (AML) name
695 ******************************************************************************/
700 char **ConvertedName)
702 ACPI_NAMESTRING_INFO Info;
711 /* Get the length of the new internal name */
713 Info.ExternalName = ExternalName;
714 AcpiNsGetInternalNameLength (&Info);
716 /* We need a segment to store the internal name */
718 Info.InternalName = UtLocalCacheCalloc (Info.Length);
722 Status = AcpiNsBuildInternalName (&Info);
723 if (ACPI_FAILURE (Status))
728 *ConvertedName = Info.InternalName;
733 /*******************************************************************************
735 * FUNCTION: UtPadNameWithUnderscores
737 * PARAMETERS: NameSeg - Input nameseg
738 * PaddedNameSeg - Output padded nameseg
740 * RETURN: Padded nameseg.
742 * DESCRIPTION: Pads a NameSeg with underscores if necessary to form a full
745 ******************************************************************************/
748 UtPadNameWithUnderscores (
755 for (i = 0; (i < ACPI_NAME_SIZE); i++)
759 *PaddedNameSeg = *NameSeg;
764 *PaddedNameSeg = '_';
772 /*******************************************************************************
774 * FUNCTION: UtAttachNameseg
776 * PARAMETERS: Op - Parent parse node
777 * Name - Full ExternalName
779 * RETURN: None; Sets the NameSeg field in parent node
781 * DESCRIPTION: Extract the last nameseg of the ExternalName and store it
782 * in the NameSeg field of the Op.
784 ******************************************************************************/
788 ACPI_PARSE_OBJECT *Op,
792 char PaddedNameSeg[4];
800 /* Look for the last dot in the namepath */
802 NameSeg = strrchr (Name, '.');
805 /* Found last dot, we have also found the final nameseg */
808 UtPadNameWithUnderscores (NameSeg, PaddedNameSeg);
812 /* No dots in the namepath, there is only a single nameseg. */
813 /* Handle prefixes */
815 while (ACPI_IS_ROOT_PREFIX (*Name) ||
816 ACPI_IS_PARENT_PREFIX (*Name))
821 /* Remaining string should be one single nameseg */
823 UtPadNameWithUnderscores (Name, PaddedNameSeg);
826 ACPI_MOVE_NAME (Op->Asl.NameSeg, PaddedNameSeg);
830 /*******************************************************************************
832 * FUNCTION: UtAttachNamepathToOwner
834 * PARAMETERS: Op - Parent parse node
835 * NameOp - Node that contains the name
837 * RETURN: Sets the ExternalName and Namepath in the parent node
839 * DESCRIPTION: Store the name in two forms in the parent node: The original
840 * (external) name, and the internalized name that is used within
841 * the ACPI namespace manager.
843 ******************************************************************************/
846 UtAttachNamepathToOwner (
847 ACPI_PARSE_OBJECT *Op,
848 ACPI_PARSE_OBJECT *NameOp)
853 /* Full external path */
855 Op->Asl.ExternalName = NameOp->Asl.Value.String;
857 /* Save the NameOp for possible error reporting later */
859 Op->Asl.ParentMethod = (void *) NameOp;
861 /* Last nameseg of the path */
863 UtAttachNameseg (Op, Op->Asl.ExternalName);
865 /* Create internalized path */
867 Status = UtInternalizeName (NameOp->Asl.Value.String, &Op->Asl.Namepath);
868 if (ACPI_FAILURE (Status))
870 /* TBD: abort on no memory */
875 /*******************************************************************************
877 * FUNCTION: UtDoConstant
879 * PARAMETERS: String - Hex/Decimal/Octal
881 * RETURN: Converted Integer
883 * DESCRIPTION: Convert a string to an integer, with overflow/error checking.
885 ******************************************************************************/
892 UINT64 ConvertedInteger;
896 Status = AcpiUtStrtoul64 (String, &ConvertedInteger);
897 if (ACPI_FAILURE (Status))
899 sprintf (ErrBuf, "While creating 64-bit constant: %s\n",
900 AcpiFormatException (Status));
902 AslCommonError (ASL_ERROR, ASL_MSG_SYNTAX, AslGbl_CurrentLineNumber,
903 AslGbl_LogicalLineNumber, AslGbl_CurrentLineOffset,
904 AslGbl_CurrentColumn, AslGbl_Files[ASL_FILE_INPUT].Filename, ErrBuf);
907 return (ConvertedInteger);