pstree.c revision 114237
1867Sache/****************************************************************************** 2867Sache * 3867Sache * Module Name: pstree - Parser op tree manipulation/traversal/search 4867Sache * $Revision: 41 $ 5867Sache * 6867Sache *****************************************************************************/ 7867Sache 8867Sache/****************************************************************************** 9867Sache * 10867Sache * 1. Copyright Notice 11867Sache * 12867Sache * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp. 13867Sache * All rights reserved. 141092Sache * 15867Sache * 2. License 16867Sache * 17867Sache * 2.1. This is your license from Intel Corp. under its intellectual property 18867Sache * rights. You may have additional license terms from the party that provided 19867Sache * you this software, covering your right to use that party's intellectual 20867Sache * property rights. 21867Sache * 22867Sache * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23867Sache * copy of the source code appearing in this file ("Covered Code") an 24867Sache * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25867Sache * base code distributed originally by Intel ("Original Intel Code") to copy, 26867Sache * make derivatives, distribute, use and display any portion of the Covered 27867Sache * Code in any form, with the right to sublicense such rights; and 28867Sache * 29867Sache * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30867Sache * license (with the right to sublicense), under only those claims of Intel 31867Sache * patents that are infringed by the Original Intel Code, to make, use, sell, 32867Sache * offer to sell, and import the Covered Code and derivative works thereof 33867Sache * solely to the minimum extent necessary to exercise the above copyright 34882Sache * license, and in no event shall the patent license extend to any additions 35867Sache * to or modifications of the Original Intel Code. No other license or right 36867Sache * is granted directly or by implication, estoppel or otherwise; 37867Sache * 38867Sache * The above copyright and patent license is granted only if the following 39867Sache * conditions are met: 40867Sache * 41867Sache * 3. Conditions 42867Sache * 43867Sache * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44867Sache * Redistribution of source code of any substantial portion of the Covered 45867Sache * Code or modification with rights to further distribute source must include 46867Sache * the above Copyright Notice, the above License, this list of Conditions, 47867Sache * and the following Disclaimer and Export Compliance provision. In addition, 482910Sache * Licensee must cause all Covered Code to which Licensee contributes to 492910Sache * contain a file documenting the changes Licensee made to create that Covered 502910Sache * Code and the date of any change. Licensee must include in that file the 51867Sache * documentation of any changes made by any predecessor Licensee. Licensee 52867Sache * must include a prominent statement that the modification is derived, 53867Sache * directly or indirectly, from Original Intel Code. 54867Sache * 55867Sache * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56867Sache * Redistribution of source code of any substantial portion of the Covered 57867Sache * Code or modification without rights to further distribute source must 58867Sache * include the following Disclaimer and Export Compliance provision in the 59867Sache * documentation and/or other materials provided with distribution. In 60867Sache * addition, Licensee may not authorize further sublicense of source of any 612910Sache * portion of the Covered Code, and must include terms to the effect that the 622910Sache * license from Licensee to its licensee is limited to the intellectual 632910Sache * property embodied in the software Licensee provides to its licensee, and 641092Sache * not to intellectual property embodied in modifications its licensee may 652910Sache * make. 661092Sache * 67867Sache * 3.3. Redistribution of Executable. Redistribution in executable form of any 684039Sache * substantial portion of the Covered Code or modification must reproduce the 69867Sache * above Copyright Notice, and the following Disclaimer and Export Compliance 70867Sache * provision in the documentation and/or other materials provided with the 71867Sache * distribution. 72867Sache * 73867Sache * 3.4. Intel retains all right, title, and interest in and to the Original 74867Sache * Intel Code. 75867Sache * 76867Sache * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77867Sache * Intel shall be used in advertising or otherwise to promote the sale, use or 78867Sache * other dealings in products derived from or relating to the Covered Code 79867Sache * without prior written authorization from Intel. 80867Sache * 81867Sache * 4. Disclaimer and Export Compliance 82867Sache * 83867Sache * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84867Sache * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85867Sache * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86867Sache * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87867Sache * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88867Sache * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89867Sache * PARTICULAR PURPOSE. 90867Sache * 91867Sache * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92867Sache * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93867Sache * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94867Sache * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95867Sache * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96867Sache * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97867Sache * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98867Sache * LIMITED REMEDY. 99867Sache * 1002910Sache * 4.3. Licensee shall not export, either directly or indirectly, any of this 1012910Sache * software or system incorporating such software without first obtaining any 1022910Sache * required license or other approval from the U. S. Department of Commerce or 1032910Sache * any other agency or department of the United States Government. In the 1042910Sache * event Licensee exports any such software from the United States or 1053368Sache * re-exports any such software from a foreign destination, Licensee shall 1063368Sache * ensure that the distribution and export/re-export of the software is in 107867Sache * compliance with all laws, regulations, orders, or other restrictions of the 108867Sache * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109867Sache * any of its subsidiaries will export/re-export any technical data, process, 110867Sache * software, or service, directly or indirectly, to any country for which the 111867Sache * United States government or any agency thereof requires an export license, 112867Sache * other governmental approval, or letter of assurance, without first obtaining 113867Sache * such license, approval or letter. 114867Sache * 115867Sache *****************************************************************************/ 116867Sache 1171092Sache 1181092Sache#define __PSTREE_C__ 1191092Sache 120867Sache#include "acpi.h" 121867Sache#include "acparser.h" 122867Sache#include "amlcode.h" 123867Sache 124867Sache#define _COMPONENT ACPI_PARSER 125867Sache ACPI_MODULE_NAME ("pstree") 126867Sache 127867Sache 1281092Sache/******************************************************************************* 1291092Sache * 1301092Sache * FUNCTION: AcpiPsGetArg 1311092Sache * 1321092Sache * PARAMETERS: Op - Get an argument for this op 1331092Sache * Argn - Nth argument to get 1341092Sache * 135867Sache * RETURN: The argument (as an Op object). NULL if argument does not exist 136867Sache * 137867Sache * DESCRIPTION: Get the specified op's argument. 138867Sache * 139867Sache ******************************************************************************/ 140867Sache 141867SacheACPI_PARSE_OBJECT * 1422910SacheAcpiPsGetArg ( 143882Sache ACPI_PARSE_OBJECT *Op, 144867Sache UINT32 Argn) 145882Sache{ 146882Sache ACPI_PARSE_OBJECT *Arg = NULL; 147882Sache const ACPI_OPCODE_INFO *OpInfo; 148882Sache 149882Sache 150882Sache ACPI_FUNCTION_ENTRY (); 151882Sache 152882Sache 153882Sache /* Get the info structure for this opcode */ 154882Sache 155882Sache OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode); 156882Sache if (OpInfo->Class == AML_CLASS_UNKNOWN) 157882Sache { 158882Sache /* Invalid opcode or ASCII character */ 1591092Sache 1601092Sache return (NULL); 1611092Sache } 1621092Sache 1631092Sache /* Check if this opcode requires argument sub-objects */ 1641092Sache 165882Sache if (!(OpInfo->Flags & AML_HAS_ARGS)) 166882Sache { 167882Sache /* Has no linked argument objects */ 168882Sache 169882Sache return (NULL); 170882Sache } 171882Sache 1722910Sache /* Get the requested argument object */ 173882Sache 174882Sache Arg = Op->Common.Value.Arg; 175882Sache while (Arg && Argn) 176882Sache { 177882Sache Argn--; 178882Sache Arg = Arg->Common.Next; 179882Sache } 180882Sache 181867Sache return (Arg); 182867Sache} 183867Sache 184867Sache 185867Sache/******************************************************************************* 186867Sache * 187867Sache * FUNCTION: AcpiPsAppendArg 188867Sache * 189867Sache * PARAMETERS: Op - Append an argument to this Op. 190867Sache * Arg - Argument Op to append 191867Sache * 192867Sache * RETURN: None. 1933368Sache * 1943368Sache * DESCRIPTION: Append an argument to an op's argument list (a NULL arg is OK) 1953368Sache * 1963368Sache ******************************************************************************/ 1973368Sache 1983368Sachevoid 1993368SacheAcpiPsAppendArg ( 2003368Sache ACPI_PARSE_OBJECT *Op, 2013368Sache ACPI_PARSE_OBJECT *Arg) 2023368Sache{ 2033368Sache ACPI_PARSE_OBJECT *PrevArg; 2043368Sache const ACPI_OPCODE_INFO *OpInfo; 2053368Sache 2063368Sache 2073368Sache ACPI_FUNCTION_ENTRY (); 2083368Sache 2093368Sache 2104039Sache if (!Op) 211867Sache { 212867Sache return; 213867Sache } 2144039Sache 2154039Sache /* Get the info structure for this opcode */ 2164039Sache 2174039Sache OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode); 2184039Sache if (OpInfo->Class == AML_CLASS_UNKNOWN) 2194039Sache { 2204039Sache /* Invalid opcode */ 2214039Sache 2224039Sache ACPI_REPORT_ERROR (("PsAppendArg: Invalid AML Opcode: 0x%2.2X\n", 2234039Sache Op->Common.AmlOpcode)); 2243368Sache return; 225867Sache } 226867Sache 2274039Sache /* Check if this opcode requires argument sub-objects */ 2284039Sache 2294039Sache if (!(OpInfo->Flags & AML_HAS_ARGS)) 2304039Sache { 2314039Sache /* Has no linked argument objects */ 2324039Sache 2334039Sache return; 2344039Sache } 235867Sache 236867Sache 237867Sache /* Append the argument to the linked argument list */ 2381092Sache 2391092Sache if (Op->Common.Value.Arg) 240867Sache { 241867Sache /* Append to existing argument list */ 242867Sache 243867Sache PrevArg = Op->Common.Value.Arg; 244 while (PrevArg->Common.Next) 245 { 246 PrevArg = PrevArg->Common.Next; 247 } 248 PrevArg->Common.Next = Arg; 249 } 250 251 else 252 { 253 /* No argument list, this will be the first argument */ 254 255 Op->Common.Value.Arg = Arg; 256 } 257 258 259 /* Set the parent in this arg and any args linked after it */ 260 261 while (Arg) 262 { 263 Arg->Common.Parent = Op; 264 Arg = Arg->Common.Next; 265 } 266} 267 268 269/******************************************************************************* 270 * 271 * FUNCTION: AcpiPsGetChild 272 * 273 * PARAMETERS: Op - Get the child of this Op 274 * 275 * RETURN: Child Op, Null if none is found. 276 * 277 * DESCRIPTION: Get op's children or NULL if none 278 * 279 ******************************************************************************/ 280 281ACPI_PARSE_OBJECT * 282AcpiPsGetChild ( 283 ACPI_PARSE_OBJECT *Op) 284{ 285 ACPI_PARSE_OBJECT *Child = NULL; 286 287 288 ACPI_FUNCTION_ENTRY (); 289 290 291 switch (Op->Common.AmlOpcode) 292 { 293 case AML_SCOPE_OP: 294 case AML_ELSE_OP: 295 case AML_DEVICE_OP: 296 case AML_THERMAL_ZONE_OP: 297 case AML_INT_METHODCALL_OP: 298 299 Child = AcpiPsGetArg (Op, 0); 300 break; 301 302 303 case AML_BUFFER_OP: 304 case AML_PACKAGE_OP: 305 case AML_METHOD_OP: 306 case AML_IF_OP: 307 case AML_WHILE_OP: 308 case AML_FIELD_OP: 309 310 Child = AcpiPsGetArg (Op, 1); 311 break; 312 313 314 case AML_POWER_RES_OP: 315 case AML_INDEX_FIELD_OP: 316 317 Child = AcpiPsGetArg (Op, 2); 318 break; 319 320 321 case AML_PROCESSOR_OP: 322 case AML_BANK_FIELD_OP: 323 324 Child = AcpiPsGetArg (Op, 3); 325 break; 326 327 328 default: 329 /* All others have no children */ 330 break; 331 } 332 333 return (Child); 334} 335 336 337/******************************************************************************* 338 * 339 * FUNCTION: AcpiPsGetDepthNext 340 * 341 * PARAMETERS: Origin - Root of subtree to search 342 * Op - Last (previous) Op that was found 343 * 344 * RETURN: Next Op found in the search. 345 * 346 * DESCRIPTION: Get next op in tree (walking the tree in depth-first order) 347 * Return NULL when reaching "origin" or when walking up from root 348 * 349 ******************************************************************************/ 350 351ACPI_PARSE_OBJECT * 352AcpiPsGetDepthNext ( 353 ACPI_PARSE_OBJECT *Origin, 354 ACPI_PARSE_OBJECT *Op) 355{ 356 ACPI_PARSE_OBJECT *Next = NULL; 357 ACPI_PARSE_OBJECT *Parent; 358 ACPI_PARSE_OBJECT *Arg; 359 360 361 ACPI_FUNCTION_ENTRY (); 362 363 364 if (!Op) 365 { 366 return (NULL); 367 } 368 369 /* look for an argument or child */ 370 371 Next = AcpiPsGetArg (Op, 0); 372 if (Next) 373 { 374 return (Next); 375 } 376 377 /* look for a sibling */ 378 379 Next = Op->Common.Next; 380 if (Next) 381 { 382 return (Next); 383 } 384 385 /* look for a sibling of parent */ 386 387 Parent = Op->Common.Parent; 388 389 while (Parent) 390 { 391 Arg = AcpiPsGetArg (Parent, 0); 392 while (Arg && (Arg != Origin) && (Arg != Op)) 393 { 394 Arg = Arg->Common.Next; 395 } 396 397 if (Arg == Origin) 398 { 399 /* reached parent of origin, end search */ 400 401 return (NULL); 402 } 403 404 if (Parent->Common.Next) 405 { 406 /* found sibling of parent */ 407 408 return (Parent->Common.Next); 409 } 410 411 Op = Parent; 412 Parent = Parent->Common.Parent; 413 } 414 415 return (Next); 416} 417 418 419