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