acpica/parser/pstree.c

0001 /******************************************************************************
0002  *
0003  * Module Name: pstree - Parser op tree manipulation/traversal/search
0004  *
0005  *****************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "acparser.h"
0155 #include "amlcode.h"
0156 #include "acconvert.h"
0157
0158 #define _COMPONENT          ACPI_PARSER
0159         ACPI_MODULE_NAME    ("pstree")
0160
0161 /* Local prototypes */
0162
0163 #ifdef ACPI_OBSOLETE_FUNCTIONS
0164 ACPI_PARSE_OBJECT *
0165 AcpiPsGetChild (
0166     ACPI_PARSE_OBJECT       *op);
0167 #endif
0168
0169
0170 /*******************************************************************************
0171  *
0172  * FUNCTION:    AcpiPsGetArg
0173  *
0174  * PARAMETERS:  Op              - Get an argument for this op
0175  *              Argn            - Nth argument to get
0176  *
0177  * RETURN:      The argument (as an Op object). NULL if argument does not exist
0178  *
0179  * DESCRIPTION: Get the specified op's argument.
0180  *
0181  ******************************************************************************/
0182
0183 ACPI_PARSE_OBJECT *
0184 AcpiPsGetArg (
0185     ACPI_PARSE_OBJECT       *Op,
0186     UINT32                  Argn)
0187 {
0188     ACPI_PARSE_OBJECT       *Arg = NULL;
0189     const ACPI_OPCODE_INFO  *OpInfo;
0190
0191
0192     ACPI_FUNCTION_ENTRY ();
0193
0194 /*
0195     if (Op->Common.AmlOpcode == AML_INT_CONNECTION_OP)
0196     {
0197         return (Op->Common.Value.Arg);
0198     }
0199 */
0200     /* Get the info structure for this opcode */
0201
0202     OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
0203     if (OpInfo->Class == AML_CLASS_UNKNOWN)
0204     {
0205         /* Invalid opcode or ASCII character */
0206
0207         return (NULL);
0208     }
0209
0210     /* Check if this opcode requires argument sub-objects */
0211
0212     if (!(OpInfo->Flags & AML_HAS_ARGS))
0213     {
0214         /* Has no linked argument objects */
0215
0216         return (NULL);
0217     }
0218
0219     /* Get the requested argument object */
0220
0221     Arg = Op->Common.Value.Arg;
0222     while (Arg && Argn)
0223     {
0224         Argn--;
0225         Arg = Arg->Common.Next;
0226     }
0227
0228     return (Arg);
0229 }
0230
0231
0232 /*******************************************************************************
0233  *
0234  * FUNCTION:    AcpiPsAppendArg
0235  *
0236  * PARAMETERS:  Op              - Append an argument to this Op.
0237  *              Arg             - Argument Op to append
0238  *
0239  * RETURN:      None.
0240  *
0241  * DESCRIPTION: Append an argument to an op's argument list (a NULL arg is OK)
0242  *
0243  ******************************************************************************/
0244
0245 void
0246 AcpiPsAppendArg (
0247     ACPI_PARSE_OBJECT       *Op,
0248     ACPI_PARSE_OBJECT       *Arg)
0249 {
0250     ACPI_PARSE_OBJECT       *PrevArg;
0251     const ACPI_OPCODE_INFO  *OpInfo;
0252
0253
0254     ACPI_FUNCTION_TRACE (PsAppendArg);
0255
0256
0257     if (!Op)
0258     {
0259         return_VOID;
0260     }
0261
0262     /* Get the info structure for this opcode */
0263
0264     OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
0265     if (OpInfo->Class == AML_CLASS_UNKNOWN)
0266     {
0267         /* Invalid opcode */
0268
0269         ACPI_ERROR ((AE_INFO, "Invalid AML Opcode: 0x%2.2X",
0270             Op->Common.AmlOpcode));
0271         return_VOID;
0272     }
0273
0274     /* Check if this opcode requires argument sub-objects */
0275
0276     if (!(OpInfo->Flags & AML_HAS_ARGS))
0277     {
0278         /* Has no linked argument objects */
0279
0280         return_VOID;
0281     }
0282
0283     /* Append the argument to the linked argument list */
0284
0285     if (Op->Common.Value.Arg)
0286     {
0287         /* Append to existing argument list */
0288
0289         PrevArg = Op->Common.Value.Arg;
0290         while (PrevArg->Common.Next)
0291         {
0292             PrevArg = PrevArg->Common.Next;
0293         }
0294         PrevArg->Common.Next = Arg;
0295     }
0296     else
0297     {
0298         /* No argument list, this will be the first argument */
0299
0300         Op->Common.Value.Arg = Arg;
0301     }
0302
0303     /* Set the parent in this arg and any args linked after it */
0304
0305     while (Arg)
0306     {
0307         Arg->Common.Parent = Op;
0308         Arg = Arg->Common.Next;
0309
0310         Op->Common.ArgListLength++;
0311     }
0312
0313     return_VOID;
0314 }
0315
0316
0317 /*******************************************************************************
0318  *
0319  * FUNCTION:    AcpiPsGetDepthNext
0320  *
0321  * PARAMETERS:  Origin          - Root of subtree to search
0322  *              Op              - Last (previous) Op that was found
0323  *
0324  * RETURN:      Next Op found in the search.
0325  *
0326  * DESCRIPTION: Get next op in tree (walking the tree in depth-first order)
0327  *              Return NULL when reaching "origin" or when walking up from root
0328  *
0329  ******************************************************************************/
0330
0331 ACPI_PARSE_OBJECT *
0332 AcpiPsGetDepthNext (
0333     ACPI_PARSE_OBJECT       *Origin,
0334     ACPI_PARSE_OBJECT       *Op)
0335 {
0336     ACPI_PARSE_OBJECT       *Next = NULL;
0337     ACPI_PARSE_OBJECT       *Parent;
0338     ACPI_PARSE_OBJECT       *Arg;
0339
0340
0341     ACPI_FUNCTION_ENTRY ();
0342
0343
0344     if (!Op)
0345     {
0346         return (NULL);
0347     }
0348
0349     /* Look for an argument or child */
0350
0351     Next = AcpiPsGetArg (Op, 0);
0352     if (Next)
0353     {
0354         ASL_CV_LABEL_FILENODE (Next);
0355         return (Next);
0356     }
0357
0358     /* Look for a sibling */
0359
0360     Next = Op->Common.Next;
0361     if (Next)
0362     {
0363         ASL_CV_LABEL_FILENODE (Next);
0364         return (Next);
0365     }
0366
0367     /* Look for a sibling of parent */
0368
0369     Parent = Op->Common.Parent;
0370
0371     while (Parent)
0372     {
0373         Arg = AcpiPsGetArg (Parent, 0);
0374         while (Arg && (Arg != Origin) && (Arg != Op))
0375         {
0376
0377             ASL_CV_LABEL_FILENODE (Arg);
0378             Arg = Arg->Common.Next;
0379         }
0380
0381         if (Arg == Origin)
0382         {
0383             /* Reached parent of origin, end search */
0384
0385             return (NULL);
0386         }
0387
0388         if (Parent->Common.Next)
0389         {
0390             /* Found sibling of parent */
0391
0392             ASL_CV_LABEL_FILENODE (Parent->Common.Next);
0393             return (Parent->Common.Next);
0394         }
0395
0396         Op = Parent;
0397         Parent = Parent->Common.Parent;
0398     }
0399
0400     ASL_CV_LABEL_FILENODE (Next);
0401     return (Next);
0402 }
0403
0404
0405 #ifdef ACPI_OBSOLETE_FUNCTIONS
0406 /*******************************************************************************
0407  *
0408  * FUNCTION:    AcpiPsGetChild
0409  *
0410  * PARAMETERS:  Op              - Get the child of this Op
0411  *
0412  * RETURN:      Child Op, Null if none is found.
0413  *
0414  * DESCRIPTION: Get op's children or NULL if none
0415  *
0416  ******************************************************************************/
0417
0418 ACPI_PARSE_OBJECT *
0419 AcpiPsGetChild (
0420     ACPI_PARSE_OBJECT       *Op)
0421 {
0422     ACPI_PARSE_OBJECT       *Child = NULL;
0423
0424
0425     ACPI_FUNCTION_ENTRY ();
0426
0427
0428     switch (Op->Common.AmlOpcode)
0429     {
0430     case AML_SCOPE_OP:
0431     case AML_ELSE_OP:
0432     case AML_DEVICE_OP:
0433     case AML_THERMAL_ZONE_OP:
0434     case AML_INT_METHODCALL_OP:
0435
0436         Child = AcpiPsGetArg (Op, 0);
0437         break;
0438
0439     case AML_BUFFER_OP:
0440     case AML_PACKAGE_OP:
0441     case AML_VARIABLE_PACKAGE_OP:
0442     case AML_METHOD_OP:
0443     case AML_IF_OP:
0444     case AML_WHILE_OP:
0445     case AML_FIELD_OP:
0446
0447         Child = AcpiPsGetArg (Op, 1);
0448         break;
0449
0450     case AML_POWER_RESOURCE_OP:
0451     case AML_INDEX_FIELD_OP:
0452
0453         Child = AcpiPsGetArg (Op, 2);
0454         break;
0455
0456     case AML_PROCESSOR_OP:
0457     case AML_BANK_FIELD_OP:
0458
0459         Child = AcpiPsGetArg (Op, 3);
0460         break;
0461
0462     default:
0463
0464         /* All others have no children */
0465
0466         break;
0467     }
0468
0469     return (Child);
0470 }
0471 #endif