asldebug.c revision 1.1.1.1.2.2 1 1.1.1.1.2.2 skrll /******************************************************************************
2 1.1.1.1.2.2 skrll *
3 1.1.1.1.2.2 skrll * Module Name: asldebug -- Debug output support
4 1.1.1.1.2.2 skrll *
5 1.1.1.1.2.2 skrll *****************************************************************************/
6 1.1.1.1.2.2 skrll
7 1.1.1.1.2.2 skrll /*
8 1.1.1.1.2.2 skrll * Copyright (C) 2000 - 2016, Intel Corp.
9 1.1.1.1.2.2 skrll * All rights reserved.
10 1.1.1.1.2.2 skrll *
11 1.1.1.1.2.2 skrll * Redistribution and use in source and binary forms, with or without
12 1.1.1.1.2.2 skrll * modification, are permitted provided that the following conditions
13 1.1.1.1.2.2 skrll * are met:
14 1.1.1.1.2.2 skrll * 1. Redistributions of source code must retain the above copyright
15 1.1.1.1.2.2 skrll * notice, this list of conditions, and the following disclaimer,
16 1.1.1.1.2.2 skrll * without modification.
17 1.1.1.1.2.2 skrll * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 1.1.1.1.2.2 skrll * substantially similar to the "NO WARRANTY" disclaimer below
19 1.1.1.1.2.2 skrll * ("Disclaimer") and any redistribution must be conditioned upon
20 1.1.1.1.2.2 skrll * including a substantially similar Disclaimer requirement for further
21 1.1.1.1.2.2 skrll * binary redistribution.
22 1.1.1.1.2.2 skrll * 3. Neither the names of the above-listed copyright holders nor the names
23 1.1.1.1.2.2 skrll * of any contributors may be used to endorse or promote products derived
24 1.1.1.1.2.2 skrll * from this software without specific prior written permission.
25 1.1.1.1.2.2 skrll *
26 1.1.1.1.2.2 skrll * Alternatively, this software may be distributed under the terms of the
27 1.1.1.1.2.2 skrll * GNU General Public License ("GPL") version 2 as published by the Free
28 1.1.1.1.2.2 skrll * Software Foundation.
29 1.1.1.1.2.2 skrll *
30 1.1.1.1.2.2 skrll * NO WARRANTY
31 1.1.1.1.2.2 skrll * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 1.1.1.1.2.2 skrll * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 1.1.1.1.2.2 skrll * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 1.1.1.1.2.2 skrll * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 1.1.1.1.2.2 skrll * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 1.1.1.1.2.2 skrll * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 1.1.1.1.2.2 skrll * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 1.1.1.1.2.2 skrll * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 1.1.1.1.2.2 skrll * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 1.1.1.1.2.2 skrll * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 1.1.1.1.2.2 skrll * POSSIBILITY OF SUCH DAMAGES.
42 1.1.1.1.2.2 skrll */
43 1.1.1.1.2.2 skrll
44 1.1.1.1.2.2 skrll #include "aslcompiler.h"
45 1.1.1.1.2.2 skrll #include "aslcompiler.y.h"
46 1.1.1.1.2.2 skrll
47 1.1.1.1.2.2 skrll
48 1.1.1.1.2.2 skrll #define _COMPONENT ACPI_COMPILER
49 1.1.1.1.2.2 skrll ACPI_MODULE_NAME ("asldebug")
50 1.1.1.1.2.2 skrll
51 1.1.1.1.2.2 skrll
52 1.1.1.1.2.2 skrll /* Local prototypes */
53 1.1.1.1.2.2 skrll
54 1.1.1.1.2.2 skrll static void
55 1.1.1.1.2.2 skrll UtDumpParseOpName (
56 1.1.1.1.2.2 skrll ACPI_PARSE_OBJECT *Op,
57 1.1.1.1.2.2 skrll UINT32 Level,
58 1.1.1.1.2.2 skrll UINT32 DataLength);
59 1.1.1.1.2.2 skrll
60 1.1.1.1.2.2 skrll
61 1.1.1.1.2.2 skrll /*******************************************************************************
62 1.1.1.1.2.2 skrll *
63 1.1.1.1.2.2 skrll * FUNCTION: UtDumpIntegerOp
64 1.1.1.1.2.2 skrll *
65 1.1.1.1.2.2 skrll * PARAMETERS: Op - Current parse op
66 1.1.1.1.2.2 skrll * Level - Current output indentation level
67 1.1.1.1.2.2 skrll * IntegerLength - Output length of the integer (2/4/8/16)
68 1.1.1.1.2.2 skrll *
69 1.1.1.1.2.2 skrll * RETURN: None
70 1.1.1.1.2.2 skrll *
71 1.1.1.1.2.2 skrll * DESCRIPTION: Emit formatted debug output for "integer" ops.
72 1.1.1.1.2.2 skrll * Note: IntegerLength must be one of 2,4,8,16.
73 1.1.1.1.2.2 skrll *
74 1.1.1.1.2.2 skrll ******************************************************************************/
75 1.1.1.1.2.2 skrll
76 1.1.1.1.2.2 skrll void
77 1.1.1.1.2.2 skrll UtDumpIntegerOp (
78 1.1.1.1.2.2 skrll ACPI_PARSE_OBJECT *Op,
79 1.1.1.1.2.2 skrll UINT32 Level,
80 1.1.1.1.2.2 skrll UINT32 IntegerLength)
81 1.1.1.1.2.2 skrll {
82 1.1.1.1.2.2 skrll
83 1.1.1.1.2.2 skrll /* Emit the ParseOp name, leaving room for the integer */
84 1.1.1.1.2.2 skrll
85 1.1.1.1.2.2 skrll UtDumpParseOpName (Op, Level, IntegerLength);
86 1.1.1.1.2.2 skrll
87 1.1.1.1.2.2 skrll /* Emit the integer based upon length */
88 1.1.1.1.2.2 skrll
89 1.1.1.1.2.2 skrll switch (IntegerLength)
90 1.1.1.1.2.2 skrll {
91 1.1.1.1.2.2 skrll case 2: /* Byte */
92 1.1.1.1.2.2 skrll case 4: /* Word */
93 1.1.1.1.2.2 skrll case 8: /* Dword */
94 1.1.1.1.2.2 skrll
95 1.1.1.1.2.2 skrll DbgPrint (ASL_TREE_OUTPUT,
96 1.1.1.1.2.2 skrll "%*.*X", IntegerLength, IntegerLength, Op->Asl.Value.Integer);
97 1.1.1.1.2.2 skrll break;
98 1.1.1.1.2.2 skrll
99 1.1.1.1.2.2 skrll case 16: /* Qword and Integer */
100 1.1.1.1.2.2 skrll
101 1.1.1.1.2.2 skrll DbgPrint (ASL_TREE_OUTPUT,
102 1.1.1.1.2.2 skrll "%8.8X%8.8X", ACPI_FORMAT_UINT64 (Op->Asl.Value.Integer));
103 1.1.1.1.2.2 skrll break;
104 1.1.1.1.2.2 skrll
105 1.1.1.1.2.2 skrll default:
106 1.1.1.1.2.2 skrll break;
107 1.1.1.1.2.2 skrll }
108 1.1.1.1.2.2 skrll }
109 1.1.1.1.2.2 skrll
110 1.1.1.1.2.2 skrll
111 1.1.1.1.2.2 skrll /*******************************************************************************
112 1.1.1.1.2.2 skrll *
113 1.1.1.1.2.2 skrll * FUNCTION: UtDumpStringOp
114 1.1.1.1.2.2 skrll *
115 1.1.1.1.2.2 skrll * PARAMETERS: Op - Current parse op
116 1.1.1.1.2.2 skrll * Level - Current output indentation level
117 1.1.1.1.2.2 skrll *
118 1.1.1.1.2.2 skrll * RETURN: None
119 1.1.1.1.2.2 skrll *
120 1.1.1.1.2.2 skrll * DESCRIPTION: Emit formatted debug output for String/Pathname ops.
121 1.1.1.1.2.2 skrll *
122 1.1.1.1.2.2 skrll ******************************************************************************/
123 1.1.1.1.2.2 skrll
124 1.1.1.1.2.2 skrll void
125 1.1.1.1.2.2 skrll UtDumpStringOp (
126 1.1.1.1.2.2 skrll ACPI_PARSE_OBJECT *Op,
127 1.1.1.1.2.2 skrll UINT32 Level)
128 1.1.1.1.2.2 skrll {
129 1.1.1.1.2.2 skrll char *String;
130 1.1.1.1.2.2 skrll
131 1.1.1.1.2.2 skrll
132 1.1.1.1.2.2 skrll String = Op->Asl.Value.String;
133 1.1.1.1.2.2 skrll
134 1.1.1.1.2.2 skrll if (Op->Asl.ParseOpcode != PARSEOP_STRING_LITERAL)
135 1.1.1.1.2.2 skrll {
136 1.1.1.1.2.2 skrll /*
137 1.1.1.1.2.2 skrll * For the "path" ops NAMEPATH, NAMESEG, METHODCALL -- if the
138 1.1.1.1.2.2 skrll * ExternalName is valid, it takes precedence. In these cases the
139 1.1.1.1.2.2 skrll * Value.String is the raw "internal" name from the AML code, which
140 1.1.1.1.2.2 skrll * we don't want to use, because it contains non-ascii characters.
141 1.1.1.1.2.2 skrll */
142 1.1.1.1.2.2 skrll if (Op->Asl.ExternalName)
143 1.1.1.1.2.2 skrll {
144 1.1.1.1.2.2 skrll String = Op->Asl.ExternalName;
145 1.1.1.1.2.2 skrll }
146 1.1.1.1.2.2 skrll }
147 1.1.1.1.2.2 skrll
148 1.1.1.1.2.2 skrll if (!String)
149 1.1.1.1.2.2 skrll {
150 1.1.1.1.2.2 skrll DbgPrint (ASL_TREE_OUTPUT,
151 1.1.1.1.2.2 skrll " ERROR: Could not find a valid String/Path pointer\n");
152 1.1.1.1.2.2 skrll return;
153 1.1.1.1.2.2 skrll }
154 1.1.1.1.2.2 skrll
155 1.1.1.1.2.2 skrll /* Emit the ParseOp name, leaving room for the string */
156 1.1.1.1.2.2 skrll
157 1.1.1.1.2.2 skrll UtDumpParseOpName (Op, Level, strlen (String));
158 1.1.1.1.2.2 skrll DbgPrint (ASL_TREE_OUTPUT, "%s", String);
159 1.1.1.1.2.2 skrll }
160 1.1.1.1.2.2 skrll
161 1.1.1.1.2.2 skrll
162 1.1.1.1.2.2 skrll /*******************************************************************************
163 1.1.1.1.2.2 skrll *
164 1.1.1.1.2.2 skrll * FUNCTION: UtDumpBasicOp
165 1.1.1.1.2.2 skrll *
166 1.1.1.1.2.2 skrll * PARAMETERS: Op - Current parse op
167 1.1.1.1.2.2 skrll * Level - Current output indentation level
168 1.1.1.1.2.2 skrll *
169 1.1.1.1.2.2 skrll * RETURN: None
170 1.1.1.1.2.2 skrll *
171 1.1.1.1.2.2 skrll * DESCRIPTION: Generic formatted debug output for "basic" ops that have no
172 1.1.1.1.2.2 skrll * associated strings or integer values.
173 1.1.1.1.2.2 skrll *
174 1.1.1.1.2.2 skrll ******************************************************************************/
175 1.1.1.1.2.2 skrll
176 1.1.1.1.2.2 skrll void
177 1.1.1.1.2.2 skrll UtDumpBasicOp (
178 1.1.1.1.2.2 skrll ACPI_PARSE_OBJECT *Op,
179 1.1.1.1.2.2 skrll UINT32 Level)
180 1.1.1.1.2.2 skrll {
181 1.1.1.1.2.2 skrll
182 1.1.1.1.2.2 skrll /* Just print out the ParseOp name, there is no extra data */
183 1.1.1.1.2.2 skrll
184 1.1.1.1.2.2 skrll UtDumpParseOpName (Op, Level, 0);
185 1.1.1.1.2.2 skrll }
186 1.1.1.1.2.2 skrll
187 1.1.1.1.2.2 skrll
188 1.1.1.1.2.2 skrll /*******************************************************************************
189 1.1.1.1.2.2 skrll *
190 1.1.1.1.2.2 skrll * FUNCTION: UtDumpParseOpName
191 1.1.1.1.2.2 skrll *
192 1.1.1.1.2.2 skrll * PARAMETERS: Op - Current parse op
193 1.1.1.1.2.2 skrll * Level - Current output indentation level
194 1.1.1.1.2.2 skrll * DataLength - Length of data to appear after the name
195 1.1.1.1.2.2 skrll *
196 1.1.1.1.2.2 skrll * RETURN: None
197 1.1.1.1.2.2 skrll *
198 1.1.1.1.2.2 skrll * DESCRIPTION: Indent and emit the ascii ParseOp name for the op
199 1.1.1.1.2.2 skrll *
200 1.1.1.1.2.2 skrll ******************************************************************************/
201 1.1.1.1.2.2 skrll
202 1.1.1.1.2.2 skrll static void
203 1.1.1.1.2.2 skrll UtDumpParseOpName (
204 1.1.1.1.2.2 skrll ACPI_PARSE_OBJECT *Op,
205 1.1.1.1.2.2 skrll UINT32 Level,
206 1.1.1.1.2.2 skrll UINT32 DataLength)
207 1.1.1.1.2.2 skrll {
208 1.1.1.1.2.2 skrll char *ParseOpName;
209 1.1.1.1.2.2 skrll UINT32 IndentLength;
210 1.1.1.1.2.2 skrll UINT32 NameLength;
211 1.1.1.1.2.2 skrll UINT32 LineLength;
212 1.1.1.1.2.2 skrll UINT32 PaddingLength;
213 1.1.1.1.2.2 skrll
214 1.1.1.1.2.2 skrll
215 1.1.1.1.2.2 skrll /* Emit the LineNumber/IndentLevel prefix on each output line */
216 1.1.1.1.2.2 skrll
217 1.1.1.1.2.2 skrll DbgPrint (ASL_TREE_OUTPUT,
218 1.1.1.1.2.2 skrll "%5.5d [%2d]", Op->Asl.LogicalLineNumber, Level);
219 1.1.1.1.2.2 skrll
220 1.1.1.1.2.2 skrll ParseOpName = UtGetOpName (Op->Asl.ParseOpcode);
221 1.1.1.1.2.2 skrll
222 1.1.1.1.2.2 skrll /* Calculate various lengths for output alignment */
223 1.1.1.1.2.2 skrll
224 1.1.1.1.2.2 skrll IndentLength = Level * DEBUG_SPACES_PER_INDENT;
225 1.1.1.1.2.2 skrll NameLength = strlen (ParseOpName);
226 1.1.1.1.2.2 skrll LineLength = IndentLength + 1 + NameLength + 1 + DataLength;
227 1.1.1.1.2.2 skrll PaddingLength = (DEBUG_MAX_LINE_LENGTH + 1) - LineLength;
228 1.1.1.1.2.2 skrll
229 1.1.1.1.2.2 skrll /* Parse tree indentation is based upon the nesting/indent level */
230 1.1.1.1.2.2 skrll
231 1.1.1.1.2.2 skrll if (Level)
232 1.1.1.1.2.2 skrll {
233 1.1.1.1.2.2 skrll DbgPrint (ASL_TREE_OUTPUT, "%*s", IndentLength, " ");
234 1.1.1.1.2.2 skrll }
235 1.1.1.1.2.2 skrll
236 1.1.1.1.2.2 skrll /* Emit the actual name here */
237 1.1.1.1.2.2 skrll
238 1.1.1.1.2.2 skrll DbgPrint (ASL_TREE_OUTPUT, " %s", ParseOpName);
239 1.1.1.1.2.2 skrll
240 1.1.1.1.2.2 skrll /* Emit extra padding blanks for alignment of later data items */
241 1.1.1.1.2.2 skrll
242 1.1.1.1.2.2 skrll if (LineLength > DEBUG_MAX_LINE_LENGTH)
243 1.1.1.1.2.2 skrll {
244 1.1.1.1.2.2 skrll /* Split a long line immediately after the ParseOpName string */
245 1.1.1.1.2.2 skrll
246 1.1.1.1.2.2 skrll DbgPrint (ASL_TREE_OUTPUT, "\n%*s",
247 1.1.1.1.2.2 skrll (DEBUG_FULL_LINE_LENGTH - DataLength), " ");
248 1.1.1.1.2.2 skrll }
249 1.1.1.1.2.2 skrll else
250 1.1.1.1.2.2 skrll {
251 1.1.1.1.2.2 skrll DbgPrint (ASL_TREE_OUTPUT, "%*s", PaddingLength, " ");
252 1.1.1.1.2.2 skrll }
253 1.1.1.1.2.2 skrll }
254