psutils.c revision 99146
1/****************************************************************************** 2 * 3 * Module Name: psutils - Parser miscellaneous utilities (Parser only) 4 * $Revision: 50 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp. 13 * All rights 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#include "acpi.h" 119#include "acparser.h" 120#include "amlcode.h" 121 122#define _COMPONENT ACPI_PARSER 123 ACPI_MODULE_NAME ("psutils") 124 125 126/******************************************************************************* 127 * 128 * FUNCTION: AcpiPsInitOp 129 * 130 * PARAMETERS: Op - A newly allocated Op object 131 * Opcode - Opcode to store in the Op 132 * 133 * RETURN: Status 134 * 135 * DESCRIPTION: Allocate an acpi_op, choose op type (and thus size) based on 136 * opcode 137 * 138 ******************************************************************************/ 139 140void 141AcpiPsInitOp ( 142 ACPI_PARSE_OBJECT *Op, 143 UINT16 Opcode) 144{ 145 ACPI_FUNCTION_ENTRY (); 146 147 148 Op->DataType = ACPI_DESC_TYPE_PARSER; 149 Op->Opcode = Opcode; 150 151 ACPI_DEBUG_ONLY_MEMBERS (ACPI_STRNCPY (Op->OpName, 152 (AcpiPsGetOpcodeInfo (Opcode))->Name, sizeof (Op->OpName))); 153} 154 155 156/******************************************************************************* 157 * 158 * FUNCTION: AcpiPsAllocOp 159 * 160 * PARAMETERS: Opcode - Opcode that will be stored in the new Op 161 * 162 * RETURN: Pointer to the new Op. 163 * 164 * DESCRIPTION: Allocate an acpi_op, choose op type (and thus size) based on 165 * opcode. A cache of opcodes is available for the pure 166 * GENERIC_OP, since this is by far the most commonly used. 167 * 168 ******************************************************************************/ 169 170ACPI_PARSE_OBJECT* 171AcpiPsAllocOp ( 172 UINT16 Opcode) 173{ 174 ACPI_PARSE_OBJECT *Op = NULL; 175 UINT32 Size; 176 UINT8 Flags; 177 const ACPI_OPCODE_INFO *OpInfo; 178 179 180 ACPI_FUNCTION_ENTRY (); 181 182 183 OpInfo = AcpiPsGetOpcodeInfo (Opcode); 184 185 /* Allocate the minimum required size object */ 186 187 if (OpInfo->Flags & AML_DEFER) 188 { 189 Size = sizeof (ACPI_PARSE2_OBJECT); 190 Flags = ACPI_PARSEOP_DEFERRED; 191 } 192 else if (OpInfo->Flags & AML_NAMED) 193 { 194 Size = sizeof (ACPI_PARSE2_OBJECT); 195 Flags = ACPI_PARSEOP_NAMED; 196 } 197 else if (Opcode == AML_INT_BYTELIST_OP) 198 { 199 Size = sizeof (ACPI_PARSE2_OBJECT); 200 Flags = ACPI_PARSEOP_BYTELIST; 201 } 202 else 203 { 204 Size = sizeof (ACPI_PARSE_OBJECT); 205 Flags = ACPI_PARSEOP_GENERIC; 206 } 207 208 if (Size == sizeof (ACPI_PARSE_OBJECT)) 209 { 210 /* 211 * The generic op is by far the most common (16 to 1) 212 */ 213 Op = AcpiUtAcquireFromCache (ACPI_MEM_LIST_PSNODE); 214 } 215 else 216 { 217 Op = AcpiUtAcquireFromCache (ACPI_MEM_LIST_PSNODE_EXT); 218 } 219 220 /* Initialize the Op */ 221 222 if (Op) 223 { 224 AcpiPsInitOp (Op, Opcode); 225 Op->Flags = Flags; 226 } 227 228 return (Op); 229} 230 231 232/******************************************************************************* 233 * 234 * FUNCTION: AcpiPsFreeOp 235 * 236 * PARAMETERS: Op - Op to be freed 237 * 238 * RETURN: None. 239 * 240 * DESCRIPTION: Free an Op object. Either put it on the GENERIC_OP cache list 241 * or actually free it. 242 * 243 ******************************************************************************/ 244 245void 246AcpiPsFreeOp ( 247 ACPI_PARSE_OBJECT *Op) 248{ 249 ACPI_FUNCTION_NAME ("PsFreeOp"); 250 251 252 if (Op->Opcode == AML_INT_RETURN_VALUE_OP) 253 { 254 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "Free retval op: %p\n", Op)); 255 } 256 257 if (Op->Flags == ACPI_PARSEOP_GENERIC) 258 { 259 AcpiUtReleaseToCache (ACPI_MEM_LIST_PSNODE, Op); 260 } 261 else 262 { 263 AcpiUtReleaseToCache (ACPI_MEM_LIST_PSNODE_EXT, Op); 264 } 265} 266 267 268/******************************************************************************* 269 * 270 * FUNCTION: AcpiPsDeleteParseCache 271 * 272 * PARAMETERS: None 273 * 274 * RETURN: None 275 * 276 * DESCRIPTION: Free all objects that are on the parse cache list. 277 * 278 ******************************************************************************/ 279 280void 281AcpiPsDeleteParseCache ( 282 void) 283{ 284 ACPI_FUNCTION_TRACE ("PsDeleteParseCache"); 285 286 287 AcpiUtDeleteGenericCache (ACPI_MEM_LIST_PSNODE); 288 AcpiUtDeleteGenericCache (ACPI_MEM_LIST_PSNODE_EXT); 289 return_VOID; 290} 291 292 293/******************************************************************************* 294 * 295 * FUNCTION: Utility functions 296 * 297 * DESCRIPTION: Low level character and object functions 298 * 299 ******************************************************************************/ 300 301 302/* 303 * Is "c" a namestring lead character? 304 */ 305BOOLEAN 306AcpiPsIsLeadingChar ( 307 UINT32 c) 308{ 309 return ((BOOLEAN) (c == '_' || (c >= 'A' && c <= 'Z'))); 310} 311 312 313/* 314 * Is "c" a namestring prefix character? 315 */ 316BOOLEAN 317AcpiPsIsPrefixChar ( 318 UINT32 c) 319{ 320 return ((BOOLEAN) (c == '\\' || c == '^')); 321} 322 323 324/* 325 * Get op's name (4-byte name segment) or 0 if unnamed 326 */ 327UINT32 328AcpiPsGetName ( 329 ACPI_PARSE_OBJECT *Op) 330{ 331 332 333 /* The "generic" object has no name associated with it */ 334 335 if (Op->Flags & ACPI_PARSEOP_GENERIC) 336 { 337 return (0); 338 } 339 340 /* Only the "Extended" parse objects have a name */ 341 342 return (((ACPI_PARSE2_OBJECT *) Op)->Name); 343} 344 345 346/* 347 * Set op's name 348 */ 349void 350AcpiPsSetName ( 351 ACPI_PARSE_OBJECT *Op, 352 UINT32 name) 353{ 354 355 /* The "generic" object has no name associated with it */ 356 357 if (Op->Flags & ACPI_PARSEOP_GENERIC) 358 { 359 return; 360 } 361 362 ((ACPI_PARSE2_OBJECT *) Op)->Name = name; 363} 364 365