drivers/acpi/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 - 2015, 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 #include "aslcompiler.h"
 117 #include "aslcompiler.y.h"
 118 #include "acapps.h"
 119
 120 #define _COMPONENT          ACPI_COMPILER
 121         ACPI_MODULE_NAME    ("aslprune")
 122
 123
 124 /* Local prototypes */
 125
 126 static ACPI_STATUS
 127 PrTreePruneWalk (
 128     ACPI_PARSE_OBJECT       *Op,
 129     UINT32                  Level,
 130     void                    *Context);
 131
 132 static void
 133 PrPrintObjectAtLevel (
 134     UINT32                  Level,
 135     const char              *ObjectName);
 136
 137
 138 typedef struct acpi_prune_info
 139 {
 140     UINT32                  PruneLevel;
 141     UINT16                  ParseOpcode;
 142     UINT16                  Count;
 143
 144 } ACPI_PRUNE_INFO;
 145
 146
 147 /*******************************************************************************
 148  *
 149  * FUNCTION:    AslPruneParseTree
 150  *
 151  * PARAMETERS:  PruneDepth              - Number of levels to prune
 152  *              Type                    - Prune type (Device, Method, etc.)
 153  *
 154  * RETURN:      None
 155  *
 156  * DESCRIPTION: Prune off one or more levels of the ASL parse tree
 157  *
 158  ******************************************************************************/
 159
 160 void
 161 AslPruneParseTree (
 162     UINT32                  PruneDepth,
 163     UINT32                  Type)
 164 {
 165     ACPI_PRUNE_INFO         PruneObj;
 166
 167
 168     PruneObj.PruneLevel = PruneDepth;
 169     PruneObj.Count = 0;
 170
 171     switch (Type)
 172     {
 173     case 0:
 174         PruneObj.ParseOpcode = (UINT16) PARSEOP_DEVICE;
 175         break;
 176
 177     case 1:
 178         PruneObj.ParseOpcode = (UINT16) PARSEOP_METHOD;
 179         break;
 180
 181     case 2:
 182         PruneObj.ParseOpcode = (UINT16) PARSEOP_IF;
 183         break;
 184
 185     default:
 186         AcpiOsPrintf ("Unsupported type: %u\n", Type);
 187         return;
 188     }
 189
 190     AcpiOsPrintf ("Pruning parse tree, from depth %u\n",
 191         PruneDepth);
 192
 193     AcpiOsPrintf ("\nRemoving Objects:\n");
 194
 195     TrWalkParseTree (RootNode, ASL_WALK_VISIT_DOWNWARD,
 196         PrTreePruneWalk, NULL, ACPI_CAST_PTR (void, &PruneObj));
 197
 198     AcpiOsPrintf ("\n%u Total Objects Removed\n", PruneObj.Count);
 199 }
 200
 201
 202 /*******************************************************************************
 203  *
 204  * FUNCTION:    PrPrintObjectAtLevel
 205  *
 206  * PARAMETERS:  Level                   - Current nesting level
 207  *              ObjectName              - ACPI name for the object
 208  *
 209  * RETURN:      None
 210  *
 211  * DESCRIPTION: Print object name with indent
 212  *
 213  ******************************************************************************/
 214
 215 static void
 216 PrPrintObjectAtLevel (
 217     UINT32                  Level,
 218     const char              *ObjectName)
 219 {
 220     UINT32                  i;
 221
 222
 223     for (i = 0; i < Level; i++)
 224     {
 225         AcpiOsPrintf ("  ");
 226     }
 227
 228     AcpiOsPrintf ("[%s] at Level [%u]\n", ObjectName, Level);
 229 }
 230
 231
 232 /*******************************************************************************
 233  *
 234  * FUNCTION:    PrTreePruneWalk
 235  *
 236  * PARAMETERS:  Parse tree walk callback
 237  *
 238  * RETURN:      Status
 239  *
 240  * DESCRIPTION: Prune off one or more levels of the ASL parse tree
 241  *
 242  * Current objects that can be pruned are: Devices, Methods, and If/Else
 243  * blocks.
 244  *
 245  ******************************************************************************/
 246
 247 static ACPI_STATUS
 248 PrTreePruneWalk (
 249     ACPI_PARSE_OBJECT       *Op,
 250     UINT32                  Level,
 251     void                    *Context)
 252 {
 253     ACPI_PRUNE_INFO         *PruneObj = (ACPI_PRUNE_INFO *) Context;
 254
 255
 256     /* We only care about objects below the Prune Level threshold */
 257
 258     if (Level <= PruneObj->PruneLevel)
 259     {
 260         return (AE_OK);
 261     }
 262
 263     if ((Op->Asl.ParseOpcode != PruneObj->ParseOpcode) &&
 264        !(Op->Asl.ParseOpcode == PARSEOP_ELSE &&
 265              PruneObj->ParseOpcode == PARSEOP_IF))
 266     {
 267         return (AE_OK);
 268     }
 269
 270     switch (Op->Asl.ParseOpcode)
 271     {
 272     case PARSEOP_METHOD:
 273
 274         AcpiOsPrintf ("Method");
 275         PrPrintObjectAtLevel (Level, Op->Asl.Child->Asl.Value.Name);
 276         Op->Asl.Child->Asl.Next->Asl.Next->Asl.Next->Asl.Next->Asl.Next->Asl.Next = NULL;
 277         PruneObj->Count++;
 278         break;
 279
 280     case PARSEOP_DEVICE:
 281
 282         AcpiOsPrintf ("Device");
 283         PrPrintObjectAtLevel (Level, Op->Asl.Child->Asl.Value.Name);
 284         Op->Asl.Child->Asl.Next = NULL;
 285         PruneObj->Count++;
 286         break;
 287
 288     case PARSEOP_IF:
 289     case PARSEOP_ELSE:
 290
 291         if (Op->Asl.ParseOpcode == PARSEOP_ELSE)
 292         {
 293             PrPrintObjectAtLevel(Level, "Else");
 294             Op->Asl.Child = NULL;
 295         }
 296         else
 297         {
 298             PrPrintObjectAtLevel(Level, "If");
 299             Op->Asl.Child->Asl.Next = NULL;
 300         }
 301
 302         PruneObj->Count++;
 303         break;
 304
 305     default:
 306
 307         break;
 308     }
 309
 310     return (AE_OK);
 311 }