1 /****************************************************************************** 2 * 3 * Module Name: utalloc - local memory allocation routines 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2016, 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 "acpi.h" 117 #include "accommon.h" 118 #include "acdebug.h" 119 120 #define _COMPONENT ACPI_UTILITIES 121 ACPI_MODULE_NAME ("utalloc") 122 123 124 #if !defined (USE_NATIVE_ALLOCATE_ZEROED) 125 /******************************************************************************* 126 * 127 * FUNCTION: AcpiOsAllocateZeroed 128 * 129 * PARAMETERS: Size - Size of the allocation 130 * 131 * RETURN: Address of the allocated memory on success, NULL on failure. 132 * 133 * DESCRIPTION: Subsystem equivalent of calloc. Allocate and zero memory. 134 * This is the default implementation. Can be overridden via the 135 * USE_NATIVE_ALLOCATE_ZEROED flag. 136 * 137 ******************************************************************************/ 138 139 void * 140 AcpiOsAllocateZeroed ( 141 ACPI_SIZE Size) 142 { 143 void *Allocation; 144 145 146 ACPI_FUNCTION_ENTRY (); 147 148 149 Allocation = AcpiOsAllocate (Size); 150 if (Allocation) 151 { 152 /* Clear the memory block */ 153 154 memset (Allocation, 0, Size); 155 } 156 157 return (Allocation); 158 } 159 160 #endif /* !USE_NATIVE_ALLOCATE_ZEROED */ 161 162 163 /******************************************************************************* 164 * 165 * FUNCTION: AcpiUtCreateCaches 166 * 167 * PARAMETERS: None 168 * 169 * RETURN: Status 170 * 171 * DESCRIPTION: Create all local caches 172 * 173 ******************************************************************************/ 174 175 ACPI_STATUS 176 AcpiUtCreateCaches ( 177 void) 178 { 179 ACPI_STATUS Status; 180 181 182 /* Object Caches, for frequently used objects */ 183 184 Status = AcpiOsCreateCache ("Acpi-Namespace", sizeof (ACPI_NAMESPACE_NODE), 185 ACPI_MAX_NAMESPACE_CACHE_DEPTH, &AcpiGbl_NamespaceCache); 186 if (ACPI_FAILURE (Status)) 187 { 188 return (Status); 189 } 190 191 Status = AcpiOsCreateCache ("Acpi-State", sizeof (ACPI_GENERIC_STATE), 192 ACPI_MAX_STATE_CACHE_DEPTH, &AcpiGbl_StateCache); 193 if (ACPI_FAILURE (Status)) 194 { 195 return (Status); 196 } 197 198 Status = AcpiOsCreateCache ("Acpi-Parse", sizeof (ACPI_PARSE_OBJ_COMMON), 199 ACPI_MAX_PARSE_CACHE_DEPTH, &AcpiGbl_PsNodeCache); 200 if (ACPI_FAILURE (Status)) 201 { 202 return (Status); 203 } 204 205 Status = AcpiOsCreateCache ("Acpi-ParseExt", sizeof (ACPI_PARSE_OBJ_NAMED), 206 ACPI_MAX_EXTPARSE_CACHE_DEPTH, &AcpiGbl_PsNodeExtCache); 207 if (ACPI_FAILURE (Status)) 208 { 209 return (Status); 210 } 211 212 Status = AcpiOsCreateCache ("Acpi-Operand", sizeof (ACPI_OPERAND_OBJECT), 213 ACPI_MAX_OBJECT_CACHE_DEPTH, &AcpiGbl_OperandCache); 214 if (ACPI_FAILURE (Status)) 215 { 216 return (Status); 217 } 218 219 220 #ifdef ACPI_DBG_TRACK_ALLOCATIONS 221 222 /* Memory allocation lists */ 223 224 Status = AcpiUtCreateList ("Acpi-Global", 0, 225 &AcpiGbl_GlobalList); 226 if (ACPI_FAILURE (Status)) 227 { 228 return (Status); 229 } 230 231 Status = AcpiUtCreateList ("Acpi-Namespace", sizeof (ACPI_NAMESPACE_NODE), 232 &AcpiGbl_NsNodeList); 233 if (ACPI_FAILURE (Status)) 234 { 235 return (Status); 236 } 237 #endif 238 239 return (AE_OK); 240 } 241 242 243 /******************************************************************************* 244 * 245 * FUNCTION: AcpiUtDeleteCaches 246 * 247 * PARAMETERS: None 248 * 249 * RETURN: Status 250 * 251 * DESCRIPTION: Purge and delete all local caches 252 * 253 ******************************************************************************/ 254 255 ACPI_STATUS 256 AcpiUtDeleteCaches ( 257 void) 258 { 259 #ifdef ACPI_DBG_TRACK_ALLOCATIONS 260 char Buffer[7]; 261 262 263 if (AcpiGbl_DisplayFinalMemStats) 264 { 265 strcpy (Buffer, "MEMORY"); 266 (void) AcpiDbDisplayStatistics (Buffer); 267 } 268 #endif 269 270 (void) AcpiOsDeleteCache (AcpiGbl_NamespaceCache); 271 AcpiGbl_NamespaceCache = NULL; 272 273 (void) AcpiOsDeleteCache (AcpiGbl_StateCache); 274 AcpiGbl_StateCache = NULL; 275 276 (void) AcpiOsDeleteCache (AcpiGbl_OperandCache); 277 AcpiGbl_OperandCache = NULL; 278 279 (void) AcpiOsDeleteCache (AcpiGbl_PsNodeCache); 280 AcpiGbl_PsNodeCache = NULL; 281 282 (void) AcpiOsDeleteCache (AcpiGbl_PsNodeExtCache); 283 AcpiGbl_PsNodeExtCache = NULL; 284 285 286 #ifdef ACPI_DBG_TRACK_ALLOCATIONS 287 288 /* Debug only - display leftover memory allocation, if any */ 289 290 AcpiUtDumpAllocations (ACPI_UINT32_MAX, NULL); 291 292 /* Free memory lists */ 293 294 AcpiOsFree (AcpiGbl_GlobalList); 295 AcpiGbl_GlobalList = NULL; 296 297 AcpiOsFree (AcpiGbl_NsNodeList); 298 AcpiGbl_NsNodeList = NULL; 299 #endif 300 301 return (AE_OK); 302 } 303 304 305 /******************************************************************************* 306 * 307 * FUNCTION: AcpiUtValidateBuffer 308 * 309 * PARAMETERS: Buffer - Buffer descriptor to be validated 310 * 311 * RETURN: Status 312 * 313 * DESCRIPTION: Perform parameter validation checks on an ACPI_BUFFER 314 * 315 ******************************************************************************/ 316 317 ACPI_STATUS 318 AcpiUtValidateBuffer ( 319 ACPI_BUFFER *Buffer) 320 { 321 322 /* Obviously, the structure pointer must be valid */ 323 324 if (!Buffer) 325 { 326 return (AE_BAD_PARAMETER); 327 } 328 329 /* Special semantics for the length */ 330 331 if ((Buffer->Length == ACPI_NO_BUFFER) || 332 (Buffer->Length == ACPI_ALLOCATE_BUFFER) || 333 (Buffer->Length == ACPI_ALLOCATE_LOCAL_BUFFER)) 334 { 335 return (AE_OK); 336 } 337 338 /* Length is valid, the buffer pointer must be also */ 339 340 if (!Buffer->Pointer) 341 { 342 return (AE_BAD_PARAMETER); 343 } 344 345 return (AE_OK); 346 } 347 348 349 /******************************************************************************* 350 * 351 * FUNCTION: AcpiUtInitializeBuffer 352 * 353 * PARAMETERS: Buffer - Buffer to be validated 354 * RequiredLength - Length needed 355 * 356 * RETURN: Status 357 * 358 * DESCRIPTION: Validate that the buffer is of the required length or 359 * allocate a new buffer. Returned buffer is always zeroed. 360 * 361 ******************************************************************************/ 362 363 ACPI_STATUS 364 AcpiUtInitializeBuffer ( 365 ACPI_BUFFER *Buffer, 366 ACPI_SIZE RequiredLength) 367 { 368 ACPI_SIZE InputBufferLength; 369 370 371 /* Parameter validation */ 372 373 if (!Buffer || !RequiredLength) 374 { 375 return (AE_BAD_PARAMETER); 376 } 377 378 /* 379 * Buffer->Length is used as both an input and output parameter. Get the 380 * input actual length and set the output required buffer length. 381 */ 382 InputBufferLength = Buffer->Length; 383 Buffer->Length = RequiredLength; 384 385 /* 386 * The input buffer length contains the actual buffer length, or the type 387 * of buffer to be allocated by this routine. 388 */ 389 switch (InputBufferLength) 390 { 391 case ACPI_NO_BUFFER: 392 393 /* Return the exception (and the required buffer length) */ 394 395 return (AE_BUFFER_OVERFLOW); 396 397 case ACPI_ALLOCATE_BUFFER: 398 /* 399 * Allocate a new buffer. We directectly call AcpiOsAllocate here to 400 * purposefully bypass the (optionally enabled) internal allocation 401 * tracking mechanism since we only want to track internal 402 * allocations. Note: The caller should use AcpiOsFree to free this 403 * buffer created via ACPI_ALLOCATE_BUFFER. 404 */ 405 Buffer->Pointer = AcpiOsAllocate (RequiredLength); 406 break; 407 408 case ACPI_ALLOCATE_LOCAL_BUFFER: 409 410 /* Allocate a new buffer with local interface to allow tracking */ 411 412 Buffer->Pointer = ACPI_ALLOCATE (RequiredLength); 413 break; 414 415 default: 416 417 /* Existing buffer: Validate the size of the buffer */ 418 419 if (InputBufferLength < RequiredLength) 420 { 421 return (AE_BUFFER_OVERFLOW); 422 } 423 break; 424 } 425 426 /* Validate allocation from above or input buffer pointer */ 427 428 if (!Buffer->Pointer) 429 { 430 return (AE_NO_MEMORY); 431 } 432 433 /* Have a valid buffer, clear it */ 434 435 memset (Buffer->Pointer, 0, RequiredLength); 436 return (AE_OK); 437 } 438