pstree.c revision 95b482a8d31116f3f5c2a5089569393234d06385 
1/******************************************************************************
2 *
3 * Module Name: pstree - Parser op tree manipulation/traversal/search
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2008, Intel Corp.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
25 *
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.
29 *
30 * NO WARRANTY
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.
42 */
43
44#include <acpi/acpi.h>
45#include <acpi/accommon.h>
46#include <acpi/acparser.h>
47#include <acpi/amlcode.h>
48
49#define _COMPONENT          ACPI_PARSER
50ACPI_MODULE_NAME("pstree")
51
52/* Local prototypes */
53#ifdef ACPI_OBSOLETE_FUNCTIONS
54union acpi_parse_object *acpi_ps_get_child(union acpi_parse_object *op);
55#endif
56
57/*******************************************************************************
58 *
59 * FUNCTION:    acpi_ps_get_arg
60 *
61 * PARAMETERS:  Op              - Get an argument for this op
62 *              Argn            - Nth argument to get
63 *
64 * RETURN:      The argument (as an Op object). NULL if argument does not exist
65 *
66 * DESCRIPTION: Get the specified op's argument.
67 *
68 ******************************************************************************/
69
70union acpi_parse_object *acpi_ps_get_arg(union acpi_parse_object *op, u32 argn)
71{
72	union acpi_parse_object *arg = NULL;
73	const struct acpi_opcode_info *op_info;
74
75	ACPI_FUNCTION_ENTRY();
76
77	/* Get the info structure for this opcode */
78
79	op_info = acpi_ps_get_opcode_info(op->common.aml_opcode);
80	if (op_info->class == AML_CLASS_UNKNOWN) {
81
82		/* Invalid opcode or ASCII character */
83
84		return (NULL);
85	}
86
87	/* Check if this opcode requires argument sub-objects */
88
89	if (!(op_info->flags & AML_HAS_ARGS)) {
90
91		/* Has no linked argument objects */
92
93		return (NULL);
94	}
95
96	/* Get the requested argument object */
97
98	arg = op->common.value.arg;
99	while (arg && argn) {
100		argn--;
101		arg = arg->common.next;
102	}
103
104	return (arg);
105}
106
107/*******************************************************************************
108 *
109 * FUNCTION:    acpi_ps_append_arg
110 *
111 * PARAMETERS:  Op              - Append an argument to this Op.
112 *              Arg             - Argument Op to append
113 *
114 * RETURN:      None.
115 *
116 * DESCRIPTION: Append an argument to an op's argument list (a NULL arg is OK)
117 *
118 ******************************************************************************/
119
120void
121acpi_ps_append_arg(union acpi_parse_object *op, union acpi_parse_object *arg)
122{
123	union acpi_parse_object *prev_arg;
124	const struct acpi_opcode_info *op_info;
125
126	ACPI_FUNCTION_ENTRY();
127
128	if (!op) {
129		return;
130	}
131
132	/* Get the info structure for this opcode */
133
134	op_info = acpi_ps_get_opcode_info(op->common.aml_opcode);
135	if (op_info->class == AML_CLASS_UNKNOWN) {
136
137		/* Invalid opcode */
138
139		ACPI_ERROR((AE_INFO, "Invalid AML Opcode: 0x%2.2X",
140			    op->common.aml_opcode));
141		return;
142	}
143
144	/* Check if this opcode requires argument sub-objects */
145
146	if (!(op_info->flags & AML_HAS_ARGS)) {
147
148		/* Has no linked argument objects */
149
150		return;
151	}
152
153	/* Append the argument to the linked argument list */
154
155	if (op->common.value.arg) {
156
157		/* Append to existing argument list */
158
159		prev_arg = op->common.value.arg;
160		while (prev_arg->common.next) {
161			prev_arg = prev_arg->common.next;
162		}
163		prev_arg->common.next = arg;
164	} else {
165		/* No argument list, this will be the first argument */
166
167		op->common.value.arg = arg;
168	}
169
170	/* Set the parent in this arg and any args linked after it */
171
172	while (arg) {
173		arg->common.parent = op;
174		arg = arg->common.next;
175
176		op->common.arg_list_length++;
177	}
178}
179
180#ifdef ACPI_FUTURE_USAGE
181/*******************************************************************************
182 *
183 * FUNCTION:    acpi_ps_get_depth_next
184 *
185 * PARAMETERS:  Origin          - Root of subtree to search
186 *              Op              - Last (previous) Op that was found
187 *
188 * RETURN:      Next Op found in the search.
189 *
190 * DESCRIPTION: Get next op in tree (walking the tree in depth-first order)
191 *              Return NULL when reaching "origin" or when walking up from root
192 *
193 ******************************************************************************/
194
195union acpi_parse_object *acpi_ps_get_depth_next(union acpi_parse_object *origin,
196						union acpi_parse_object *op)
197{
198	union acpi_parse_object *next = NULL;
199	union acpi_parse_object *parent;
200	union acpi_parse_object *arg;
201
202	ACPI_FUNCTION_ENTRY();
203
204	if (!op) {
205		return (NULL);
206	}
207
208	/* Look for an argument or child */
209
210	next = acpi_ps_get_arg(op, 0);
211	if (next) {
212		return (next);
213	}
214
215	/* Look for a sibling */
216
217	next = op->common.next;
218	if (next) {
219		return (next);
220	}
221
222	/* Look for a sibling of parent */
223
224	parent = op->common.parent;
225
226	while (parent) {
227		arg = acpi_ps_get_arg(parent, 0);
228		while (arg && (arg != origin) && (arg != op)) {
229			arg = arg->common.next;
230		}
231
232		if (arg == origin) {
233
234			/* Reached parent of origin, end search */
235
236			return (NULL);
237		}
238
239		if (parent->common.next) {
240
241			/* Found sibling of parent */
242
243			return (parent->common.next);
244		}
245
246		op = parent;
247		parent = parent->common.parent;
248	}
249
250	return (next);
251}
252
253#ifdef ACPI_OBSOLETE_FUNCTIONS
254/*******************************************************************************
255 *
256 * FUNCTION:    acpi_ps_get_child
257 *
258 * PARAMETERS:  Op              - Get the child of this Op
259 *
260 * RETURN:      Child Op, Null if none is found.
261 *
262 * DESCRIPTION: Get op's children or NULL if none
263 *
264 ******************************************************************************/
265
266union acpi_parse_object *acpi_ps_get_child(union acpi_parse_object *op)
267{
268	union acpi_parse_object *child = NULL;
269
270	ACPI_FUNCTION_ENTRY();
271
272	switch (op->common.aml_opcode) {
273	case AML_SCOPE_OP:
274	case AML_ELSE_OP:
275	case AML_DEVICE_OP:
276	case AML_THERMAL_ZONE_OP:
277	case AML_INT_METHODCALL_OP:
278
279		child = acpi_ps_get_arg(op, 0);
280		break;
281
282	case AML_BUFFER_OP:
283	case AML_PACKAGE_OP:
284	case AML_METHOD_OP:
285	case AML_IF_OP:
286	case AML_WHILE_OP:
287	case AML_FIELD_OP:
288
289		child = acpi_ps_get_arg(op, 1);
290		break;
291
292	case AML_POWER_RES_OP:
293	case AML_INDEX_FIELD_OP:
294
295		child = acpi_ps_get_arg(op, 2);
296		break;
297
298	case AML_PROCESSOR_OP:
299	case AML_BANK_FIELD_OP:
300
301		child = acpi_ps_get_arg(op, 3);
302		break;
303
304	default:
305		/* All others have no children */
306		break;
307	}
308
309	return (child);
310}
311#endif
312#endif				/*  ACPI_FUTURE_USAGE  */
313