1 /******************************************************************************
3 * Module Name: asldebug -- Debug output support
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, 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"
156 #define _COMPONENT ACPI_COMPILER
157 ACPI_MODULE_NAME ("asldebug")
160 /* Local prototypes */
164 ACPI_PARSE_OBJECT *Op,
169 /*******************************************************************************
171 * FUNCTION: CvDbgPrint
173 * PARAMETERS: Type - Type of output
174 * Fmt - Printf format string
175 * ... - variable printf list
179 * DESCRIPTION: Print statement for debug messages within the converter.
181 ******************************************************************************/
191 if (!Gbl_CaptureComments || !AcpiGbl_DebugAslConversion)
196 va_start (Args, Fmt);
197 (void) vfprintf (AcpiGbl_ConvDebugFile, Fmt, Args);
203 /*******************************************************************************
205 * FUNCTION: UtDumpIntegerOp
207 * PARAMETERS: Op - Current parse op
208 * Level - Current output indentation level
209 * IntegerLength - Output length of the integer (2/4/8/16)
213 * DESCRIPTION: Emit formatted debug output for "integer" ops.
214 * Note: IntegerLength must be one of 2,4,8,16.
216 ******************************************************************************/
220 ACPI_PARSE_OBJECT *Op,
222 UINT32 IntegerLength)
225 /* Emit the ParseOp name, leaving room for the integer */
227 UtDumpParseOpName (Op, Level, IntegerLength);
229 /* Emit the integer based upon length */
231 switch (IntegerLength)
237 DbgPrint (ASL_TREE_OUTPUT,
238 "%*.*X", IntegerLength, IntegerLength, Op->Asl.Value.Integer);
241 case 16: /* Qword and Integer */
243 DbgPrint (ASL_TREE_OUTPUT,
244 "%8.8X%8.8X", ACPI_FORMAT_UINT64 (Op->Asl.Value.Integer));
253 /*******************************************************************************
255 * FUNCTION: UtDumpStringOp
257 * PARAMETERS: Op - Current parse op
258 * Level - Current output indentation level
262 * DESCRIPTION: Emit formatted debug output for String/Pathname ops.
264 ******************************************************************************/
268 ACPI_PARSE_OBJECT *Op,
274 String = Op->Asl.Value.String;
276 if (Op->Asl.ParseOpcode != PARSEOP_STRING_LITERAL)
279 * For the "path" ops NAMEPATH, NAMESEG, METHODCALL -- if the
280 * ExternalName is valid, it takes precedence. In these cases the
281 * Value.String is the raw "internal" name from the AML code, which
282 * we don't want to use, because it contains non-ascii characters.
284 if (Op->Asl.ExternalName)
286 String = Op->Asl.ExternalName;
292 DbgPrint (ASL_TREE_OUTPUT,
293 " ERROR: Could not find a valid String/Path pointer\n");
297 /* Emit the ParseOp name, leaving room for the string */
299 UtDumpParseOpName (Op, Level, strlen (String));
300 DbgPrint (ASL_TREE_OUTPUT, "%s", String);
304 /*******************************************************************************
306 * FUNCTION: UtDumpBasicOp
308 * PARAMETERS: Op - Current parse op
309 * Level - Current output indentation level
313 * DESCRIPTION: Generic formatted debug output for "basic" ops that have no
314 * associated strings or integer values.
316 ******************************************************************************/
320 ACPI_PARSE_OBJECT *Op,
324 /* Just print out the ParseOp name, there is no extra data */
326 UtDumpParseOpName (Op, Level, 0);
330 /*******************************************************************************
332 * FUNCTION: UtDumpParseOpName
334 * PARAMETERS: Op - Current parse op
335 * Level - Current output indentation level
336 * DataLength - Length of data to appear after the name
340 * DESCRIPTION: Indent and emit the ascii ParseOp name for the op
342 ******************************************************************************/
346 ACPI_PARSE_OBJECT *Op,
354 UINT32 PaddingLength;
357 /* Emit the LineNumber/IndentLevel prefix on each output line */
359 DbgPrint (ASL_TREE_OUTPUT,
360 "%5.5d [%2d]", Op->Asl.LogicalLineNumber, Level);
362 ParseOpName = UtGetOpName (Op->Asl.ParseOpcode);
364 /* Calculate various lengths for output alignment */
366 IndentLength = Level * DEBUG_SPACES_PER_INDENT;
367 NameLength = strlen (ParseOpName);
368 LineLength = IndentLength + 1 + NameLength + 1 + DataLength;
369 PaddingLength = (DEBUG_MAX_LINE_LENGTH + 1) - LineLength;
371 /* Parse tree indentation is based upon the nesting/indent level */
375 DbgPrint (ASL_TREE_OUTPUT, "%*s", IndentLength, " ");
378 /* Emit the actual name here */
380 DbgPrint (ASL_TREE_OUTPUT, " %s", ParseOpName);
382 /* Emit extra padding blanks for alignment of later data items */
384 if (LineLength > DEBUG_MAX_LINE_LENGTH)
386 /* Split a long line immediately after the ParseOpName string */
388 DbgPrint (ASL_TREE_OUTPUT, "\n%*s",
389 (DEBUG_FULL_LINE_LENGTH - DataLength), " ");
393 DbgPrint (ASL_TREE_OUTPUT, "%*s", PaddingLength, " ");