sys/contrib/dev/acpica/source/compiler/aslprune.c

   1 /******************************************************************************
   2  *
   3  * Module Name: aslprune - Parse tree prune utility
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights. You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code. No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision. In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change. Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee. Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution. In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government. In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************
 115  *
 116  * Alternatively, you may choose to be licensed under the terms of the
 117  * following license:
 118  *
 119  * Redistribution and use in source and binary forms, with or without
 120  * modification, are permitted provided that the following conditions
 121  * are met:
 122  * 1. Redistributions of source code must retain the above copyright
 123  *    notice, this list of conditions, and the following disclaimer,
 124  *    without modification.
 125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 126  *    substantially similar to the "NO WARRANTY" disclaimer below
 127  *    ("Disclaimer") and any redistribution must be conditioned upon
 128  *    including a substantially similar Disclaimer requirement for further
 129  *    binary redistribution.
 130  * 3. Neither the names of the above-listed copyright holders nor the names
 131  *    of any contributors may be used to endorse or promote products derived
 132  *    from this software without specific prior written permission.
 133  *
 134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 145  *
 146  * Alternatively, you may choose to be licensed under the terms of the
 147  * GNU General Public License ("GPL") version 2 as published by the Free
 148  * Software Foundation.
 149  *
 150  *****************************************************************************/
 151
 152 #include "aslcompiler.h"
 153 #include "aslcompiler.y.h"
 154 #include "acapps.h"
 155
 156 #define _COMPONENT          ACPI_COMPILER
 157         ACPI_MODULE_NAME    ("aslprune")
 158
 159
 160 /* Local prototypes */
 161
 162 static ACPI_STATUS
 163 PrTreePruneWalk (
 164     ACPI_PARSE_OBJECT       *Op,
 165     UINT32                  Level,
 166     void                    *Context);
 167
 168 static void
 169 PrPrintObjectAtLevel (
 170     UINT32                  Level,
 171     const char              *ObjectName);
 172
 173
 174 /* Structure used for the pruning parse tree walk */
 175
 176 typedef struct acpi_prune_info
 177 {
 178     UINT32                  PruneLevel;
 179     UINT16                  ParseOpcode;
 180     UINT16                  Count;
 181
 182 } ACPI_PRUNE_INFO;
 183
 184
 185 /*******************************************************************************
 186  *
 187  * FUNCTION:    AslPruneParseTree
 188  *
 189  * PARAMETERS:  PruneDepth              - Number of levels to prune
 190  *              Type                    - Prune type (Device, Method, etc.)
 191  *
 192  * RETURN:      None
 193  *
 194  * DESCRIPTION: Prune off one or more levels of the ASL parse tree
 195  *
 196  ******************************************************************************/
 197
 198 void
 199 AslPruneParseTree (
 200     UINT32                  PruneDepth,
 201     UINT32                  Type)
 202 {
 203     ACPI_PRUNE_INFO         PruneObj;
 204
 205
 206     PruneObj.PruneLevel = PruneDepth;
 207     PruneObj.Count = 0;
 208
 209     switch (Type)
 210     {
 211     case 0:
 212         PruneObj.ParseOpcode = (UINT16) PARSEOP_DEVICE;
 213         break;
 214
 215     case 1:
 216         PruneObj.ParseOpcode = (UINT16) PARSEOP_METHOD;
 217         break;
 218
 219     case 2:
 220         PruneObj.ParseOpcode = (UINT16) PARSEOP_IF;
 221         break;
 222
 223     default:
 224         AcpiOsPrintf ("Unsupported type: %u\n", Type);
 225         return;
 226     }
 227
 228     AcpiOsPrintf ("Pruning parse tree, from depth %u\n",
 229         PruneDepth);
 230
 231     AcpiOsPrintf ("\nRemoving Objects:\n");
 232
 233     TrWalkParseTree (AslGbl_ParseTreeRoot, ASL_WALK_VISIT_DOWNWARD,
 234         PrTreePruneWalk, NULL, ACPI_CAST_PTR (void, &PruneObj));
 235
 236     AcpiOsPrintf ("\n%u Total Objects Removed\n", PruneObj.Count);
 237 }
 238
 239
 240 /*******************************************************************************
 241  *
 242  * FUNCTION:    PrPrintObjectAtLevel
 243  *
 244  * PARAMETERS:  Level                   - Current nesting level
 245  *              ObjectName              - ACPI name for the object
 246  *
 247  * RETURN:      None
 248  *
 249  * DESCRIPTION: Print object name with indent
 250  *
 251  ******************************************************************************/
 252
 253 static void
 254 PrPrintObjectAtLevel (
 255     UINT32                  Level,
 256     const char              *ObjectName)
 257 {
 258     UINT32                  i;
 259
 260
 261     for (i = 0; i < Level; i++)
 262     {
 263         AcpiOsPrintf ("  ");
 264     }
 265
 266     AcpiOsPrintf ("[%s] at Level [%u]\n", ObjectName, Level);
 267 }
 268
 269
 270 /*******************************************************************************
 271  *
 272  * FUNCTION:    PrTreePruneWalk
 273  *
 274  * PARAMETERS:  Parse tree walk callback
 275  *
 276  * RETURN:      Status
 277  *
 278  * DESCRIPTION: Prune off one or more levels of the ASL parse tree
 279  *
 280  * Current objects that can be pruned are: Devices, Methods, and If/Else
 281  * blocks.
 282  *
 283  ******************************************************************************/
 284
 285 static ACPI_STATUS
 286 PrTreePruneWalk (
 287     ACPI_PARSE_OBJECT       *Op,
 288     UINT32                  Level,
 289     void                    *Context)
 290 {
 291     ACPI_PRUNE_INFO         *PruneObj = (ACPI_PRUNE_INFO *) Context;
 292
 293
 294     /* We only care about objects below the Prune Level threshold */
 295
 296     if (Level <= PruneObj->PruneLevel)
 297     {
 298         return (AE_OK);
 299     }
 300
 301     if ((Op->Asl.ParseOpcode != PruneObj->ParseOpcode) &&
 302        !(Op->Asl.ParseOpcode == PARSEOP_ELSE &&
 303              PruneObj->ParseOpcode == PARSEOP_IF))
 304     {
 305         return (AE_OK);
 306     }
 307
 308     switch (Op->Asl.ParseOpcode)
 309     {
 310     case PARSEOP_METHOD:
 311
 312         AcpiOsPrintf ("Method");
 313         PrPrintObjectAtLevel (Level, Op->Asl.Child->Asl.Value.Name);
 314         Op->Asl.Child->Asl.Next->Asl.Next->Asl.Next->Asl.Next->Asl.Next->Asl.Next = NULL;
 315         PruneObj->Count++;
 316         break;
 317
 318     case PARSEOP_DEVICE:
 319
 320         AcpiOsPrintf ("Device");
 321         PrPrintObjectAtLevel (Level, Op->Asl.Child->Asl.Value.Name);
 322         Op->Asl.Child->Asl.Next = NULL;
 323         PruneObj->Count++;
 324         break;
 325
 326     case PARSEOP_IF:
 327     case PARSEOP_ELSE:
 328
 329         if (Op->Asl.ParseOpcode == PARSEOP_ELSE)
 330         {
 331             PrPrintObjectAtLevel(Level, "Else");
 332             Op->Asl.Child = NULL;
 333         }
 334         else
 335         {
 336             PrPrintObjectAtLevel(Level, "If");
 337             Op->Asl.Child->Asl.Next = NULL;
 338         }
 339
 340         PruneObj->Count++;
 341         break;
 342
 343     default:
 344
 345         break;
 346     }
 347
 348     return (AE_OK);
 349 }