1 /******************************************************************************
3 * Module Name: pswalk - Parser routines to walk parsed op tree(s)
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/pswalk.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $ */
120 #include "acparser.h"
121 #include "acdispat.h"
123 #define _COMPONENT ACPI_PARSER
124 ACPI_MODULE_NAME ("pswalk")
127 /*******************************************************************************
129 * FUNCTION: AcpiPsGetNextWalkOp
131 * PARAMETERS: WalkState - Current state of the walk
132 * Op - Current Op to be walked
133 * AscendingCallback - Procedure called when Op is complete
137 * DESCRIPTION: Get the next Op in a walk of the parse tree.
139 ******************************************************************************/
142 AcpiPsGetNextWalkOp (
143 ACPI_WALK_STATE *WalkState,
144 ACPI_PARSE_OBJECT *Op,
145 ACPI_PARSE_UPWARDS AscendingCallback)
147 ACPI_PARSE_OBJECT *Next;
148 ACPI_PARSE_OBJECT *Parent;
149 ACPI_PARSE_OBJECT *GrandParent;
153 ACPI_FUNCTION_TRACE_PTR ("PsGetNextWalkOp", Op);
156 /* Check for a argument only if we are descending in the tree */
158 if (WalkState->NextOpInfo != ACPI_NEXT_OP_UPWARD)
160 /* Look for an argument or child of the current op */
162 Next = AcpiPsGetArg (Op, 0);
165 /* Still going downward in tree (Op is not completed yet) */
167 WalkState->PrevOp = Op;
168 WalkState->NextOp = Next;
169 WalkState->NextOpInfo = ACPI_NEXT_OP_DOWNWARD;
171 return_ACPI_STATUS (AE_OK);
175 * No more children, this Op is complete. Save Next and Parent
176 * in case the Op object gets deleted by the callback routine
178 Next = Op->Common.Next;
179 Parent = Op->Common.Parent;
182 WalkState->OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
183 WalkState->Opcode = Op->Common.AmlOpcode;
185 Status = AscendingCallback (WalkState);
188 * If we are back to the starting point, the walk is complete.
190 if (Op == WalkState->Origin)
192 /* Reached the point of origin, the walk is complete */
194 WalkState->PrevOp = Op;
195 WalkState->NextOp = NULL;
197 return_ACPI_STATUS (Status);
201 * Check for a sibling to the current op. A sibling means
202 * we are still going "downward" in the tree.
206 /* There is a sibling, it will be next */
208 WalkState->PrevOp = Op;
209 WalkState->NextOp = Next;
210 WalkState->NextOpInfo = ACPI_NEXT_OP_DOWNWARD;
212 /* Continue downward */
214 return_ACPI_STATUS (Status);
218 * Drop into the loop below because we are moving upwards in
225 * We are resuming a walk, and we were (are) going upward in the tree.
226 * So, we want to drop into the parent loop below.
232 * Look for a sibling of the current Op's parent
233 * Continue moving up the tree until we find a node that has not been
234 * visited, or we get back to where we started.
238 /* We are moving up the tree, therefore this parent Op is complete */
240 GrandParent = Parent->Common.Parent;
241 Next = Parent->Common.Next;
243 WalkState->Op = Parent;
244 WalkState->OpInfo = AcpiPsGetOpcodeInfo (Parent->Common.AmlOpcode);
245 WalkState->Opcode = Parent->Common.AmlOpcode;
247 Status = AscendingCallback (WalkState);
250 * If we are back to the starting point, the walk is complete.
252 if (Parent == WalkState->Origin)
254 /* Reached the point of origin, the walk is complete */
256 WalkState->PrevOp = Parent;
257 WalkState->NextOp = NULL;
259 return_ACPI_STATUS (Status);
263 * If there is a sibling to this parent (it is not the starting point
264 * Op), then we will visit it.
268 /* found sibling of parent */
270 WalkState->PrevOp = Parent;
271 WalkState->NextOp = Next;
272 WalkState->NextOpInfo = ACPI_NEXT_OP_DOWNWARD;
274 return_ACPI_STATUS (Status);
277 /* No siblings, no errors, just move up one more level in the tree */
280 Parent = GrandParent;
281 WalkState->PrevOp = Op;
286 * Got all the way to the top of the tree, we must be done!
287 * However, the code should have terminated in the loop above
289 WalkState->NextOp = NULL;
291 return_ACPI_STATUS (AE_OK);
295 /*******************************************************************************
297 * FUNCTION: AcpiPsDeleteCompletedOp
299 * PARAMETERS: State - Walk state
304 * DESCRIPTION: Callback function for AcpiPsGetNextWalkOp(). Used during
305 * AcpiPsDeleteParse tree to delete Op objects when all sub-objects
306 * have been visited (and deleted.)
308 ******************************************************************************/
311 AcpiPsDeleteCompletedOp (
312 ACPI_WALK_STATE *WalkState)
315 AcpiPsFreeOp (WalkState->Op);
320 /*******************************************************************************
322 * FUNCTION: AcpiPsDeleteParseTree
324 * PARAMETERS: SubtreeRoot - Root of tree (or subtree) to delete
328 * DESCRIPTION: Delete a portion of or an entire parse tree.
330 ******************************************************************************/
333 AcpiPsDeleteParseTree (
334 ACPI_PARSE_OBJECT *SubtreeRoot)
336 ACPI_WALK_STATE *WalkState;
337 ACPI_THREAD_STATE *Thread;
341 ACPI_FUNCTION_TRACE_PTR ("PsDeleteParseTree", SubtreeRoot);
349 /* Create and initialize a new walk list */
351 Thread = AcpiUtCreateThreadState ();
357 WalkState = AcpiDsCreateWalkState (TABLE_ID_DSDT, NULL, NULL, Thread);
363 WalkState->ParseFlags = 0;
364 WalkState->DescendingCallback = NULL;
365 WalkState->AscendingCallback = NULL;
367 WalkState->Origin = SubtreeRoot;
368 WalkState->NextOp = SubtreeRoot;
370 /* Head downward in the tree */
372 WalkState->NextOpInfo = ACPI_NEXT_OP_DOWNWARD;
374 /* Visit all nodes in the subtree */
376 while (WalkState->NextOp)
378 Status = AcpiPsGetNextWalkOp (WalkState, WalkState->NextOp,
379 AcpiPsDeleteCompletedOp);
380 if (ACPI_FAILURE (Status))
386 /* We are done with this walk */
388 AcpiUtDeleteGenericState (ACPI_CAST_PTR (ACPI_GENERIC_STATE, Thread));
389 AcpiDsDeleteWalkState (WalkState);