pstree.c revision 69450
1/****************************************************************************** 2 * 3 * Module Name: pstree - Parser op tree manipulation/traversal/search 4 * $Revision: 25 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999, Intel Corp. All rights 13 * reserved. 14 * 15 * 2. License 16 * 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 20 * property rights. 21 * 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 28 * 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; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 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. 54 * 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 65 * make. 66 * 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 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 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. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 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 89 * PARTICULAR PURPOSE. 90 * 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 98 * LIMITED REMEDY. 99 * 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. 114 * 115 *****************************************************************************/ 116 117 118#define __PSTREE_C__ 119 120#include "acpi.h" 121#include "acparser.h" 122#include "amlcode.h" 123 124#define _COMPONENT PARSER 125 MODULE_NAME ("pstree") 126 127 128/******************************************************************************* 129 * 130 * FUNCTION: AcpiPsGetArg 131 * 132 * PARAMETERS: Op - Get an argument for this op 133 * Argn - Nth argument to get 134 * 135 * RETURN: The argument (as an Op object). NULL if argument does not exist 136 * 137 * DESCRIPTION: Get the specified op's argument. 138 * 139 ******************************************************************************/ 140 141ACPI_PARSE_OBJECT * 142AcpiPsGetArg ( 143 ACPI_PARSE_OBJECT *Op, 144 UINT32 Argn) 145{ 146 ACPI_PARSE_OBJECT *Arg = NULL; 147 ACPI_OPCODE_INFO *OpInfo; 148 149 150 /* Get the info structure for this opcode */ 151 152 OpInfo = AcpiPsGetOpcodeInfo (Op->Opcode); 153 if (ACPI_GET_OP_TYPE (OpInfo) != ACPI_OP_TYPE_OPCODE) 154 { 155 /* Invalid opcode or ASCII character */ 156 157 return (NULL); 158 } 159 160 /* Check if this opcode requires argument sub-objects */ 161 162 if (!(ACPI_GET_OP_ARGS (OpInfo))) 163 { 164 /* Has no linked argument objects */ 165 166 return (NULL); 167 } 168 169 /* Get the requested argument object */ 170 171 Arg = Op->Value.Arg; 172 while (Arg && Argn) 173 { 174 Argn--; 175 Arg = Arg->Next; 176 } 177 178 return (Arg); 179} 180 181 182/******************************************************************************* 183 * 184 * FUNCTION: AcpiPsAppendArg 185 * 186 * PARAMETERS: Op - Append an argument to this Op. 187 * Arg - Argument Op to append 188 * 189 * RETURN: None. 190 * 191 * DESCRIPTION: Append an argument to an op's argument list (a NULL arg is OK) 192 * 193 ******************************************************************************/ 194 195void 196AcpiPsAppendArg ( 197 ACPI_PARSE_OBJECT *Op, 198 ACPI_PARSE_OBJECT *Arg) 199{ 200 ACPI_PARSE_OBJECT *PrevArg; 201 ACPI_OPCODE_INFO *OpInfo; 202 203 204 if (!Op) 205 { 206 return; 207 } 208 209 /* Get the info structure for this opcode */ 210 211 OpInfo = AcpiPsGetOpcodeInfo (Op->Opcode); 212 if (ACPI_GET_OP_TYPE (OpInfo) != ACPI_OP_TYPE_OPCODE) 213 { 214 /* Invalid opcode */ 215 216 return; 217 } 218 219 /* Check if this opcode requires argument sub-objects */ 220 221 if (!(ACPI_GET_OP_ARGS (OpInfo))) 222 { 223 /* Has no linked argument objects */ 224 225 return; 226 } 227 228 229 /* Append the argument to the linked argument list */ 230 231 if (Op->Value.Arg) 232 { 233 /* Append to existing argument list */ 234 235 PrevArg = Op->Value.Arg; 236 while (PrevArg->Next) 237 { 238 PrevArg = PrevArg->Next; 239 } 240 PrevArg->Next = Arg; 241 } 242 243 else 244 { 245 /* No argument list, this will be the first argument */ 246 247 Op->Value.Arg = Arg; 248 } 249 250 251 /* Set the parent in this arg and any args linked after it */ 252 253 while (Arg) 254 { 255 Arg->Parent = Op; 256 Arg = Arg->Next; 257 } 258} 259 260 261/******************************************************************************* 262 * 263 * FUNCTION: AcpiPsGetChild 264 * 265 * PARAMETERS: Op - Get the child of this Op 266 * 267 * RETURN: Child Op, Null if none is found. 268 * 269 * DESCRIPTION: Get op's children or NULL if none 270 * 271 ******************************************************************************/ 272 273ACPI_PARSE_OBJECT * 274AcpiPsGetChild ( 275 ACPI_PARSE_OBJECT *Op) 276{ 277 ACPI_PARSE_OBJECT *Child = NULL; 278 279 280 switch (Op->Opcode) 281 { 282 case AML_SCOPE_OP: 283 case AML_ELSE_OP: 284 case AML_DEVICE_OP: 285 case AML_THERMAL_ZONE_OP: 286 case AML_METHODCALL_OP: 287 288 Child = AcpiPsGetArg (Op, 0); 289 break; 290 291 292 case AML_BUFFER_OP: 293 case AML_PACKAGE_OP: 294 case AML_METHOD_OP: 295 case AML_IF_OP: 296 case AML_WHILE_OP: 297 case AML_DEF_FIELD_OP: 298 299 Child = AcpiPsGetArg (Op, 1); 300 break; 301 302 303 case AML_POWER_RES_OP: 304 case AML_INDEX_FIELD_OP: 305 306 Child = AcpiPsGetArg (Op, 2); 307 break; 308 309 310 case AML_PROCESSOR_OP: 311 case AML_BANK_FIELD_OP: 312 313 Child = AcpiPsGetArg (Op, 3); 314 break; 315 316 } 317 318 return (Child); 319} 320 321 322/******************************************************************************* 323 * 324 * FUNCTION: AcpiPsGetDepthNext 325 * 326 * PARAMETERS: Origin - Root of subtree to search 327 * Op - Last (previous) Op that was found 328 * 329 * RETURN: Next Op found in the search. 330 * 331 * DESCRIPTION: Get next op in tree (walking the tree in depth-first order) 332 * Return NULL when reaching "origin" or when walking up from root 333 * 334 ******************************************************************************/ 335 336ACPI_PARSE_OBJECT * 337AcpiPsGetDepthNext ( 338 ACPI_PARSE_OBJECT *Origin, 339 ACPI_PARSE_OBJECT *Op) 340{ 341 ACPI_PARSE_OBJECT *Next = NULL; 342 ACPI_PARSE_OBJECT *Parent; 343 ACPI_PARSE_OBJECT *Arg; 344 345 346 if (!Op) 347 { 348 return (NULL); 349 } 350 351 /* look for an argument or child */ 352 353 Next = AcpiPsGetArg (Op, 0); 354 if (Next) 355 { 356 return (Next); 357 } 358 359 /* look for a sibling */ 360 361 Next = Op->Next; 362 if (Next) 363 { 364 return (Next); 365 } 366 367 /* look for a sibling of parent */ 368 369 Parent = Op->Parent; 370 371 while (Parent) 372 { 373 Arg = AcpiPsGetArg (Parent, 0); 374 while (Arg && (Arg != Origin) && (Arg != Op)) 375 { 376 Arg = Arg->Next; 377 } 378 379 if (Arg == Origin) 380 { 381 /* reached parent of origin, end search */ 382 383 return (NULL); 384 } 385 386 if (Parent->Next) 387 { 388 /* found sibling of parent */ 389 return (Parent->Next); 390 } 391 392 Op = Parent; 393 Parent = Parent->Parent; 394 } 395 396 return (Next); 397} 398 399 400