drivers/acpi/utilities/utalloc.c

   1 /******************************************************************************
   2  *
   3  * Module Name: utalloc - local memory allocation routines
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2006, R. Byron Moore
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #include <acpi/acpi.h>
  45
  46 #define _COMPONENT          ACPI_UTILITIES
  47 ACPI_MODULE_NAME("utalloc")
  48
  49 /*******************************************************************************
  50  *
  51  * FUNCTION:    acpi_ut_create_caches
  52  *
  53  * PARAMETERS:  None
  54  *
  55  * RETURN:      Status
  56  *
  57  * DESCRIPTION: Create all local caches
  58  *
  59  ******************************************************************************/
  60 acpi_status acpi_ut_create_caches(void)
  61 {
  62         acpi_status status;
  63
  64 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
  65
  66         /* Memory allocation lists */
  67
  68         status = acpi_ut_create_list("Acpi-Global", 0, &acpi_gbl_global_list);
  69         if (ACPI_FAILURE(status)) {
  70                 return (status);
  71         }
  72
  73         status =
  74             acpi_ut_create_list("Acpi-Namespace",
  75                                 sizeof(struct acpi_namespace_node),
  76                                 &acpi_gbl_ns_node_list);
  77         if (ACPI_FAILURE(status)) {
  78                 return (status);
  79         }
  80 #endif
  81
  82         /* Object Caches, for frequently used objects */
  83
  84         status =
  85             acpi_os_create_cache("Acpi-Namespace",
  86                                  sizeof(struct acpi_namespace_node),
  87                                  ACPI_MAX_NAMESPACE_CACHE_DEPTH,
  88                                  &acpi_gbl_namespace_cache);
  89         if (ACPI_FAILURE(status)) {
  90                 return (status);
  91         }
  92
  93         status =
  94             acpi_os_create_cache("Acpi-State", sizeof(union acpi_generic_state),
  95                                  ACPI_MAX_STATE_CACHE_DEPTH,
  96                                  &acpi_gbl_state_cache);
  97         if (ACPI_FAILURE(status)) {
  98                 return (status);
  99         }
 100
 101         status =
 102             acpi_os_create_cache("Acpi-Parse",
 103                                  sizeof(struct acpi_parse_obj_common),
 104                                  ACPI_MAX_PARSE_CACHE_DEPTH,
 105                                  &acpi_gbl_ps_node_cache);
 106         if (ACPI_FAILURE(status)) {
 107                 return (status);
 108         }
 109
 110         status =
 111             acpi_os_create_cache("Acpi-ParseExt",
 112                                  sizeof(struct acpi_parse_obj_named),
 113                                  ACPI_MAX_EXTPARSE_CACHE_DEPTH,
 114                                  &acpi_gbl_ps_node_ext_cache);
 115         if (ACPI_FAILURE(status)) {
 116                 return (status);
 117         }
 118
 119         status =
 120             acpi_os_create_cache("Acpi-Operand",
 121                                  sizeof(union acpi_operand_object),
 122                                  ACPI_MAX_OBJECT_CACHE_DEPTH,
 123                                  &acpi_gbl_operand_cache);
 124         if (ACPI_FAILURE(status)) {
 125                 return (status);
 126         }
 127
 128         return (AE_OK);
 129 }
 130
 131 /*******************************************************************************
 132  *
 133  * FUNCTION:    acpi_ut_delete_caches
 134  *
 135  * PARAMETERS:  None
 136  *
 137  * RETURN:      Status
 138  *
 139  * DESCRIPTION: Purge and delete all local caches
 140  *
 141  ******************************************************************************/
 142
 143 acpi_status acpi_ut_delete_caches(void)
 144 {
 145
 146         (void)acpi_os_delete_cache(acpi_gbl_namespace_cache);
 147         acpi_gbl_namespace_cache = NULL;
 148
 149         (void)acpi_os_delete_cache(acpi_gbl_state_cache);
 150         acpi_gbl_state_cache = NULL;
 151
 152         (void)acpi_os_delete_cache(acpi_gbl_operand_cache);
 153         acpi_gbl_operand_cache = NULL;
 154
 155         (void)acpi_os_delete_cache(acpi_gbl_ps_node_cache);
 156         acpi_gbl_ps_node_cache = NULL;
 157
 158         (void)acpi_os_delete_cache(acpi_gbl_ps_node_ext_cache);
 159         acpi_gbl_ps_node_ext_cache = NULL;
 160
 161         return (AE_OK);
 162 }
 163
 164 /*******************************************************************************
 165  *
 166  * FUNCTION:    acpi_ut_validate_buffer
 167  *
 168  * PARAMETERS:  Buffer              - Buffer descriptor to be validated
 169  *
 170  * RETURN:      Status
 171  *
 172  * DESCRIPTION: Perform parameter validation checks on an struct acpi_buffer
 173  *
 174  ******************************************************************************/
 175
 176 acpi_status acpi_ut_validate_buffer(struct acpi_buffer * buffer)
 177 {
 178
 179         /* Obviously, the structure pointer must be valid */
 180
 181         if (!buffer) {
 182                 return (AE_BAD_PARAMETER);
 183         }
 184
 185         /* Special semantics for the length */
 186
 187         if ((buffer->length == ACPI_NO_BUFFER) ||
 188             (buffer->length == ACPI_ALLOCATE_BUFFER) ||
 189             (buffer->length == ACPI_ALLOCATE_LOCAL_BUFFER)) {
 190                 return (AE_OK);
 191         }
 192
 193         /* Length is valid, the buffer pointer must be also */
 194
 195         if (!buffer->pointer) {
 196                 return (AE_BAD_PARAMETER);
 197         }
 198
 199         return (AE_OK);
 200 }
 201
 202 /*******************************************************************************
 203  *
 204  * FUNCTION:    acpi_ut_initialize_buffer
 205  *
 206  * PARAMETERS:  Buffer              - Buffer to be validated
 207  *              required_length     - Length needed
 208  *
 209  * RETURN:      Status
 210  *
 211  * DESCRIPTION: Validate that the buffer is of the required length or
 212  *              allocate a new buffer.  Returned buffer is always zeroed.
 213  *
 214  ******************************************************************************/
 215
 216 acpi_status
 217 acpi_ut_initialize_buffer(struct acpi_buffer * buffer,
 218                           acpi_size required_length)
 219 {
 220         acpi_status status = AE_OK;
 221
 222         switch (buffer->length) {
 223         case ACPI_NO_BUFFER:
 224
 225                 /* Set the exception and returned the required length */
 226
 227                 status = AE_BUFFER_OVERFLOW;
 228                 break;
 229
 230         case ACPI_ALLOCATE_BUFFER:
 231
 232                 /* Allocate a new buffer */
 233
 234                 buffer->pointer = acpi_os_allocate(required_length);
 235                 if (!buffer->pointer) {
 236                         return (AE_NO_MEMORY);
 237                 }
 238
 239                 /* Clear the buffer */
 240
 241                 ACPI_MEMSET(buffer->pointer, 0, required_length);
 242                 break;
 243
 244         case ACPI_ALLOCATE_LOCAL_BUFFER:
 245
 246                 /* Allocate a new buffer with local interface to allow tracking */
 247
 248                 buffer->pointer = ACPI_ALLOCATE_ZEROED(required_length);
 249                 if (!buffer->pointer) {
 250                         return (AE_NO_MEMORY);
 251                 }
 252                 break;
 253
 254         default:
 255
 256                 /* Existing buffer: Validate the size of the buffer */
 257
 258                 if (buffer->length < required_length) {
 259                         status = AE_BUFFER_OVERFLOW;
 260                         break;
 261                 }
 262
 263                 /* Clear the buffer */
 264
 265                 ACPI_MEMSET(buffer->pointer, 0, required_length);
 266                 break;
 267         }
 268
 269         buffer->length = required_length;
 270         return (status);
 271 }
 272
 273 /*******************************************************************************
 274  *
 275  * FUNCTION:    acpi_ut_allocate
 276  *
 277  * PARAMETERS:  Size                - Size of the allocation
 278  *              Component           - Component type of caller
 279  *              Module              - Source file name of caller
 280  *              Line                - Line number of caller
 281  *
 282  * RETURN:      Address of the allocated memory on success, NULL on failure.
 283  *
 284  * DESCRIPTION: Subsystem equivalent of malloc.
 285  *
 286  ******************************************************************************/
 287
 288 void *acpi_ut_allocate(acpi_size size, u32 component, char *module, u32 line)
 289 {
 290         void *allocation;
 291
 292         ACPI_FUNCTION_TRACE_U32(ut_allocate, size);
 293
 294         /* Check for an inadvertent size of zero bytes */
 295
 296         if (!size) {
 297                 ACPI_WARNING((module, line,
 298                               "Attempt to allocate zero bytes, allocating 1 byte"));
 299                 size = 1;
 300         }
 301
 302         allocation = acpi_os_allocate(size);
 303         if (!allocation) {
 304
 305                 /* Report allocation error */
 306
 307                 ACPI_WARNING((module, line,
 308                               "Could not allocate size %X", (u32) size));
 309
 310                 return_PTR(NULL);
 311         }
 312
 313         return_PTR(allocation);
 314 }
 315
 316 /*******************************************************************************
 317  *
 318  * FUNCTION:    acpi_ut_allocate_zeroed
 319  *
 320  * PARAMETERS:  Size                - Size of the allocation
 321  *              Component           - Component type of caller
 322  *              Module              - Source file name of caller
 323  *              Line                - Line number of caller
 324  *
 325  * RETURN:      Address of the allocated memory on success, NULL on failure.
 326  *
 327  * DESCRIPTION: Subsystem equivalent of calloc. Allocate and zero memory.
 328  *
 329  ******************************************************************************/
 330
 331 void *acpi_ut_allocate_zeroed(acpi_size size,
 332                               u32 component, char *module, u32 line)
 333 {
 334         void *allocation;
 335
 336         ACPI_FUNCTION_ENTRY();
 337
 338         allocation = acpi_ut_allocate(size, component, module, line);
 339         if (allocation) {
 340
 341                 /* Clear the memory block */
 342
 343                 ACPI_MEMSET(allocation, 0, size);
 344         }
 345
 346         return (allocation);
 347 }