nswalk.c 11.0 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7
/******************************************************************************
 *
 * Module Name: nswalk - Functions for walking the ACPI namespace
 *
 *****************************************************************************/

/*
8
 * Copyright (C) 2000 - 2012, Intel Corp.
L
Linus Torvalds 已提交
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#include <acpi/acpi.h>
L
Len Brown 已提交
45 46
#include "accommon.h"
#include "acnamesp.h"
L
Linus Torvalds 已提交
47 48

#define _COMPONENT          ACPI_NAMESPACE
L
Len Brown 已提交
49
ACPI_MODULE_NAME("nswalk")
L
Linus Torvalds 已提交
50 51 52 53 54

/*******************************************************************************
 *
 * FUNCTION:    acpi_ns_get_next_node
 *
55
 * PARAMETERS:  parent_node         - Parent node whose children we are
R
Robert Moore 已提交
56
 *                                    getting
L
Linus Torvalds 已提交
57 58 59 60 61 62 63 64 65 66 67
 *              child_node          - Previous child that was found.
 *                                    The NEXT child will be returned
 *
 * RETURN:      struct acpi_namespace_node - Pointer to the NEXT child or NULL if
 *                                    none is found.
 *
 * DESCRIPTION: Return the next peer node within the namespace.  If Handle
 *              is valid, Scope is ignored.  Otherwise, the first node
 *              within Scope is returned.
 *
 ******************************************************************************/
68 69 70
struct acpi_namespace_node *acpi_ns_get_next_node(struct acpi_namespace_node
						  *parent_node,
						  struct acpi_namespace_node
L
Len Brown 已提交
71
						  *child_node)
L
Linus Torvalds 已提交
72
{
L
Len Brown 已提交
73
	ACPI_FUNCTION_ENTRY();
L
Linus Torvalds 已提交
74 75

	if (!child_node) {
B
Bob Moore 已提交
76

L
Linus Torvalds 已提交
77 78
		/* It's really the parent's _scope_ that we want */

79
		return parent_node->child;
L
Linus Torvalds 已提交
80 81
	}

82 83 84 85 86 87 88 89 90
	/* Otherwise just return the next peer */

	return child_node->peer;
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ns_get_next_node_typed
 *
91
 * PARAMETERS:  type                - Type of node to be searched for
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
 *              parent_node         - Parent node whose children we are
 *                                    getting
 *              child_node          - Previous child that was found.
 *                                    The NEXT child will be returned
 *
 * RETURN:      struct acpi_namespace_node - Pointer to the NEXT child or NULL if
 *                                    none is found.
 *
 * DESCRIPTION: Return the next peer node within the namespace.  If Handle
 *              is valid, Scope is ignored.  Otherwise, the first node
 *              within Scope is returned.
 *
 ******************************************************************************/

struct acpi_namespace_node *acpi_ns_get_next_node_typed(acpi_object_type type,
							struct
							acpi_namespace_node
							*parent_node,
							struct
							acpi_namespace_node
							*child_node)
{
	struct acpi_namespace_node *next_node = NULL;

	ACPI_FUNCTION_ENTRY();

	next_node = acpi_ns_get_next_node(parent_node, child_node);


L
Linus Torvalds 已提交
121 122 123
	/* If any type is OK, we are done */

	if (type == ACPI_TYPE_ANY) {
B
Bob Moore 已提交
124

L
Linus Torvalds 已提交
125 126 127 128 129 130 131 132
		/* next_node is NULL if we are at the end-of-list */

		return (next_node);
	}

	/* Must search for the node -- but within this scope only */

	while (next_node) {
B
Bob Moore 已提交
133

L
Linus Torvalds 已提交
134 135 136 137 138 139
		/* If type matches, we are done */

		if (next_node->type == type) {
			return (next_node);
		}

140
		/* Otherwise, move on to the next peer node */
L
Linus Torvalds 已提交
141

142
		next_node = next_node->peer;
L
Linus Torvalds 已提交
143 144 145 146 147 148 149 150 151 152 153
	}

	/* Not found */

	return (NULL);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ns_walk_namespace
 *
154
 * PARAMETERS:  type                - acpi_object_type to search for
L
Linus Torvalds 已提交
155 156
 *              start_node          - Handle in namespace where search begins
 *              max_depth           - Depth to which search is to reach
157
 *              flags               - Whether to unlock the NS before invoking
L
Linus Torvalds 已提交
158
 *                                    the callback routine
159 160 161 162
 *              pre_order_visit     - Called during tree pre-order visit
 *                                    when an object of "Type" is found
 *              post_order_visit    - Called during tree post-order visit
 *                                    when an object of "Type" is found
163
 *              context             - Passed to user function(s) above
164 165
 *              return_value        - from the user_function if terminated
 *                                    early. Otherwise, returns NULL.
L
Linus Torvalds 已提交
166 167 168 169
 * RETURNS:     Status
 *
 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
 *              starting (and ending) at the node specified by start_handle.
170 171
 *              The callback function is called whenever a node that matches
 *              the type parameter is found. If the callback function returns
172 173
 *              a non-zero value, the search is terminated immediately and
 *              this value is returned to the caller.
L
Linus Torvalds 已提交
174 175 176
 *
 *              The point of this procedure is to provide a generic namespace
 *              walk routine that can be called from multiple places to
177 178 179
 *              provide multiple services; the callback function(s) can be
 *              tailored to each task, whether it is a print function,
 *              a compare function, etc.
L
Linus Torvalds 已提交
180 181 182 183
 *
 ******************************************************************************/

acpi_status
L
Len Brown 已提交
184 185 186
acpi_ns_walk_namespace(acpi_object_type type,
		       acpi_handle start_node,
		       u32 max_depth,
187
		       u32 flags,
188 189
		       acpi_walk_callback pre_order_visit,
		       acpi_walk_callback post_order_visit,
L
Len Brown 已提交
190
		       void *context, void **return_value)
L
Linus Torvalds 已提交
191
{
L
Len Brown 已提交
192 193 194 195 196 197
	acpi_status status;
	acpi_status mutex_status;
	struct acpi_namespace_node *child_node;
	struct acpi_namespace_node *parent_node;
	acpi_object_type child_type;
	u32 level;
198
	u8 node_previously_visited = FALSE;
L
Linus Torvalds 已提交
199

B
Bob Moore 已提交
200
	ACPI_FUNCTION_TRACE(ns_walk_namespace);
L
Linus Torvalds 已提交
201 202 203 204 205 206 207 208 209 210

	/* Special case for the namespace Root Node */

	if (start_node == ACPI_ROOT_OBJECT) {
		start_node = acpi_gbl_root_node;
	}

	/* Null child means "get first node" */

	parent_node = start_node;
211
	child_node = acpi_ns_get_next_node(parent_node, NULL);
L
Len Brown 已提交
212 213
	child_type = ACPI_TYPE_ANY;
	level = 1;
L
Linus Torvalds 已提交
214 215 216 217 218 219

	/*
	 * Traverse the tree of nodes until we bubble back up to where we
	 * started. When Level is zero, the loop is done because we have
	 * bubbled up to (and passed) the original parent handle (start_entry)
	 */
220 221
	while (level > 0 && child_node) {
		status = AE_OK;
B
Bob Moore 已提交
222

223
		/* Found next child, get the type if we are not searching for ANY */
L
Linus Torvalds 已提交
224

225 226 227
		if (type != ACPI_TYPE_ANY) {
			child_type = child_node->type;
		}
B
Bob Moore 已提交
228

229 230 231 232 233 234 235 236 237 238 239 240
		/*
		 * Ignore all temporary namespace nodes (created during control
		 * method execution) unless told otherwise. These temporary nodes
		 * can cause a race condition because they can be deleted during
		 * the execution of the user function (if the namespace is
		 * unlocked before invocation of the user function.) Only the
		 * debugger namespace dump will examine the temporary nodes.
		 */
		if ((child_node->flags & ANOBJ_TEMPORARY) &&
		    !(flags & ACPI_NS_WALK_TEMP_NODES)) {
			status = AE_CTRL_DEPTH;
		}
B
Bob Moore 已提交
241

242
		/* Type must match requested type */
L
Linus Torvalds 已提交
243

244
		else if (child_type == type) {
B
Bob Moore 已提交
245
			/*
246 247
			 * Found a matching node, invoke the user callback function.
			 * Unlock the namespace if flag is set.
B
Bob Moore 已提交
248
			 */
249 250 251 252 253 254
			if (flags & ACPI_NS_WALK_UNLOCK) {
				mutex_status =
				    acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
				if (ACPI_FAILURE(mutex_status)) {
					return_ACPI_STATUS(mutex_status);
				}
255 256
			}

257 258 259 260 261 262 263 264 265 266
			/*
			 * Invoke the user function, either pre-order or post-order
			 * or both.
			 */
			if (!node_previously_visited) {
				if (pre_order_visit) {
					status =
					    pre_order_visit(child_node, level,
							    context,
							    return_value);
L
Linus Torvalds 已提交
267
				}
268 269 270 271 272 273 274 275
			} else {
				if (post_order_visit) {
					status =
					    post_order_visit(child_node, level,
							     context,
							     return_value);
				}
			}
L
Linus Torvalds 已提交
276

277 278 279 280 281
			if (flags & ACPI_NS_WALK_UNLOCK) {
				mutex_status =
				    acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
				if (ACPI_FAILURE(mutex_status)) {
					return_ACPI_STATUS(mutex_status);
L
Linus Torvalds 已提交
282
				}
283
			}
L
Linus Torvalds 已提交
284

285 286 287
			switch (status) {
			case AE_OK:
			case AE_CTRL_DEPTH:
L
Linus Torvalds 已提交
288

289 290
				/* Just keep going */
				break;
L
Linus Torvalds 已提交
291

292
			case AE_CTRL_TERMINATE:
L
Linus Torvalds 已提交
293

294
				/* Exit now, with OK status */
L
Linus Torvalds 已提交
295

296
				return_ACPI_STATUS(AE_OK);
L
Linus Torvalds 已提交
297

298
			default:
L
Linus Torvalds 已提交
299

300
				/* All others are valid exceptions */
L
Linus Torvalds 已提交
301

302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
				return_ACPI_STATUS(status);
			}
		}

		/*
		 * Depth first search: Attempt to go down another level in the
		 * namespace if we are allowed to.  Don't go any further if we have
		 * reached the caller specified maximum depth or if the user
		 * function has specified that the maximum depth has been reached.
		 */
		if (!node_previously_visited &&
		    (level < max_depth) && (status != AE_CTRL_DEPTH)) {
			if (child_node->child) {

				/* There is at least one child of this node, visit it */

				level++;
				parent_node = child_node;
				child_node =
				    acpi_ns_get_next_node(parent_node, NULL);
				continue;
L
Linus Torvalds 已提交
323
			}
324
		}
L
Linus Torvalds 已提交
325

326
		/* No more children, re-visit this node */
B
Bob Moore 已提交
327

328 329 330 331
		if (!node_previously_visited) {
			node_previously_visited = TRUE;
			continue;
		}
B
Bob Moore 已提交
332

333 334 335 336 337 338 339 340 341 342
		/* No more children, visit peers */

		child_node = acpi_ns_get_next_node(parent_node, child_node);
		if (child_node) {
			node_previously_visited = FALSE;
		}

		/* No peers, re-visit parent */

		else {
L
Linus Torvalds 已提交
343
			/*
B
Bob Moore 已提交
344 345
			 * No more children of this node (acpi_ns_get_next_node failed), go
			 * back upwards in the namespace tree to the node's parent.
L
Linus Torvalds 已提交
346 347 348
			 */
			level--;
			child_node = parent_node;
349
			parent_node = parent_node->parent;
350 351

			node_previously_visited = TRUE;
L
Linus Torvalds 已提交
352 353 354 355 356
		}
	}

	/* Complete walk, not terminated by user function */

L
Len Brown 已提交
357
	return_ACPI_STATUS(AE_OK);
L
Linus Torvalds 已提交
358
}