1 /******************************************************************************
3 * Module Name: utalloc - local memory allocation routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2006, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
46 #define _COMPONENT ACPI_UTILITIES
47 ACPI_MODULE_NAME("utalloc")
49 /* Local prototypes */
50 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
51 static struct acpi_debug_mem_block *acpi_ut_find_allocation(void *allocation);
54 acpi_ut_track_allocation(struct acpi_debug_mem_block *address,
56 u8 alloc_type, u32 component, char *module, u32 line);
59 acpi_ut_remove_allocation(struct acpi_debug_mem_block *address,
60 u32 component, char *module, u32 line);
63 acpi_ut_create_list(char *list_name,
64 u16 object_size, struct acpi_memory_list **return_cache);
67 /*******************************************************************************
69 * FUNCTION: acpi_ut_create_caches
75 * DESCRIPTION: Create all local caches
77 ******************************************************************************/
79 acpi_status acpi_ut_create_caches(void)
83 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
85 /* Memory allocation lists */
87 status = acpi_ut_create_list("Acpi-Global", 0, &acpi_gbl_global_list);
88 if (ACPI_FAILURE(status)) {
93 acpi_ut_create_list("Acpi-Namespace",
94 sizeof(struct acpi_namespace_node),
95 &acpi_gbl_ns_node_list);
96 if (ACPI_FAILURE(status)) {
101 /* Object Caches, for frequently used objects */
104 acpi_os_create_cache("acpi_state", sizeof(union acpi_generic_state),
105 ACPI_MAX_STATE_CACHE_DEPTH,
106 &acpi_gbl_state_cache);
107 if (ACPI_FAILURE(status)) {
112 acpi_os_create_cache("acpi_parse",
113 sizeof(struct acpi_parse_obj_common),
114 ACPI_MAX_PARSE_CACHE_DEPTH,
115 &acpi_gbl_ps_node_cache);
116 if (ACPI_FAILURE(status)) {
121 acpi_os_create_cache("acpi_parse_ext",
122 sizeof(struct acpi_parse_obj_named),
123 ACPI_MAX_EXTPARSE_CACHE_DEPTH,
124 &acpi_gbl_ps_node_ext_cache);
125 if (ACPI_FAILURE(status)) {
130 acpi_os_create_cache("acpi_operand",
131 sizeof(union acpi_operand_object),
132 ACPI_MAX_OBJECT_CACHE_DEPTH,
133 &acpi_gbl_operand_cache);
134 if (ACPI_FAILURE(status)) {
141 /*******************************************************************************
143 * FUNCTION: acpi_ut_delete_caches
149 * DESCRIPTION: Purge and delete all local caches
151 ******************************************************************************/
153 acpi_status acpi_ut_delete_caches(void)
156 (void)acpi_os_delete_cache(acpi_gbl_state_cache);
157 acpi_gbl_state_cache = NULL;
159 (void)acpi_os_delete_cache(acpi_gbl_operand_cache);
160 acpi_gbl_operand_cache = NULL;
162 (void)acpi_os_delete_cache(acpi_gbl_ps_node_cache);
163 acpi_gbl_ps_node_cache = NULL;
165 (void)acpi_os_delete_cache(acpi_gbl_ps_node_ext_cache);
166 acpi_gbl_ps_node_ext_cache = NULL;
171 /*******************************************************************************
173 * FUNCTION: acpi_ut_validate_buffer
175 * PARAMETERS: Buffer - Buffer descriptor to be validated
179 * DESCRIPTION: Perform parameter validation checks on an struct acpi_buffer
181 ******************************************************************************/
183 acpi_status acpi_ut_validate_buffer(struct acpi_buffer * buffer)
186 /* Obviously, the structure pointer must be valid */
189 return (AE_BAD_PARAMETER);
192 /* Special semantics for the length */
194 if ((buffer->length == ACPI_NO_BUFFER) ||
195 (buffer->length == ACPI_ALLOCATE_BUFFER) ||
196 (buffer->length == ACPI_ALLOCATE_LOCAL_BUFFER)) {
200 /* Length is valid, the buffer pointer must be also */
202 if (!buffer->pointer) {
203 return (AE_BAD_PARAMETER);
209 /*******************************************************************************
211 * FUNCTION: acpi_ut_initialize_buffer
213 * PARAMETERS: Buffer - Buffer to be validated
214 * required_length - Length needed
218 * DESCRIPTION: Validate that the buffer is of the required length or
219 * allocate a new buffer. Returned buffer is always zeroed.
221 ******************************************************************************/
224 acpi_ut_initialize_buffer(struct acpi_buffer * buffer,
225 acpi_size required_length)
227 acpi_status status = AE_OK;
229 switch (buffer->length) {
232 /* Set the exception and returned the required length */
234 status = AE_BUFFER_OVERFLOW;
237 case ACPI_ALLOCATE_BUFFER:
239 /* Allocate a new buffer */
241 buffer->pointer = acpi_os_allocate(required_length);
242 if (!buffer->pointer) {
243 return (AE_NO_MEMORY);
246 /* Clear the buffer */
248 ACPI_MEMSET(buffer->pointer, 0, required_length);
251 case ACPI_ALLOCATE_LOCAL_BUFFER:
253 /* Allocate a new buffer with local interface to allow tracking */
255 buffer->pointer = ACPI_ALLOCATE_ZEROED(required_length);
256 if (!buffer->pointer) {
257 return (AE_NO_MEMORY);
263 /* Existing buffer: Validate the size of the buffer */
265 if (buffer->length < required_length) {
266 status = AE_BUFFER_OVERFLOW;
270 /* Clear the buffer */
272 ACPI_MEMSET(buffer->pointer, 0, required_length);
276 buffer->length = required_length;
280 /*******************************************************************************
282 * FUNCTION: acpi_ut_allocate
284 * PARAMETERS: Size - Size of the allocation
285 * Component - Component type of caller
286 * Module - Source file name of caller
287 * Line - Line number of caller
289 * RETURN: Address of the allocated memory on success, NULL on failure.
291 * DESCRIPTION: The subsystem's equivalent of malloc.
293 ******************************************************************************/
295 void *acpi_ut_allocate(acpi_size size, u32 component, char *module, u32 line)
299 ACPI_FUNCTION_TRACE_U32("ut_allocate", size);
301 /* Check for an inadvertent size of zero bytes */
304 ACPI_ERROR((module, line,
305 "ut_allocate: Attempt to allocate zero bytes, allocating 1 byte"));
309 allocation = acpi_os_allocate(size);
312 /* Report allocation error */
314 ACPI_ERROR((module, line,
315 "ut_allocate: Could not allocate size %X",
321 return_PTR(allocation);
324 /*******************************************************************************
326 * FUNCTION: acpi_ut_callocate
328 * PARAMETERS: Size - Size of the allocation
329 * Component - Component type of caller
330 * Module - Source file name of caller
331 * Line - Line number of caller
333 * RETURN: Address of the allocated memory on success, NULL on failure.
335 * DESCRIPTION: Subsystem equivalent of calloc.
337 ******************************************************************************/
339 void *acpi_ut_callocate(acpi_size size, u32 component, char *module, u32 line)
343 ACPI_FUNCTION_TRACE_U32("ut_callocate", size);
345 /* Check for an inadvertent size of zero bytes */
348 ACPI_ERROR((module, line,
349 "Attempt to allocate zero bytes, allocating 1 byte"));
353 allocation = acpi_os_allocate(size);
356 /* Report allocation error */
358 ACPI_ERROR((module, line,
359 "Could not allocate size %X", (u32) size));
363 /* Clear the memory block */
365 ACPI_MEMSET(allocation, 0, size);
366 return_PTR(allocation);
369 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
371 * These procedures are used for tracking memory leaks in the subsystem, and
372 * they get compiled out when the ACPI_DBG_TRACK_ALLOCATIONS is not set.
374 * Each memory allocation is tracked via a doubly linked list. Each
375 * element contains the caller's component, module name, function name, and
376 * line number. acpi_ut_allocate and acpi_ut_callocate call
377 * acpi_ut_track_allocation to add an element to the list; deletion
378 * occurs in the body of acpi_ut_free.
381 /*******************************************************************************
383 * FUNCTION: acpi_ut_create_list
385 * PARAMETERS: cache_name - Ascii name for the cache
386 * object_size - Size of each cached object
387 * return_cache - Where the new cache object is returned
391 * DESCRIPTION: Create a local memory list for tracking purposed
393 ******************************************************************************/
396 acpi_ut_create_list(char *list_name,
397 u16 object_size, struct acpi_memory_list **return_cache)
399 struct acpi_memory_list *cache;
401 cache = acpi_os_allocate(sizeof(struct acpi_memory_list));
403 return (AE_NO_MEMORY);
406 ACPI_MEMSET(cache, 0, sizeof(struct acpi_memory_list));
408 cache->list_name = list_name;
409 cache->object_size = object_size;
411 *return_cache = cache;
415 /*******************************************************************************
417 * FUNCTION: acpi_ut_allocate_and_track
419 * PARAMETERS: Size - Size of the allocation
420 * Component - Component type of caller
421 * Module - Source file name of caller
422 * Line - Line number of caller
424 * RETURN: Address of the allocated memory on success, NULL on failure.
426 * DESCRIPTION: The subsystem's equivalent of malloc.
428 ******************************************************************************/
430 void *acpi_ut_allocate_and_track(acpi_size size,
431 u32 component, char *module, u32 line)
433 struct acpi_debug_mem_block *allocation;
437 acpi_ut_allocate(size + sizeof(struct acpi_debug_mem_header),
438 component, module, line);
443 status = acpi_ut_track_allocation(allocation, size,
444 ACPI_MEM_MALLOC, component, module,
446 if (ACPI_FAILURE(status)) {
447 acpi_os_free(allocation);
451 acpi_gbl_global_list->total_allocated++;
452 acpi_gbl_global_list->current_total_size += (u32) size;
454 return ((void *)&allocation->user_space);
457 /*******************************************************************************
459 * FUNCTION: acpi_ut_callocate_and_track
461 * PARAMETERS: Size - Size of the allocation
462 * Component - Component type of caller
463 * Module - Source file name of caller
464 * Line - Line number of caller
466 * RETURN: Address of the allocated memory on success, NULL on failure.
468 * DESCRIPTION: Subsystem equivalent of calloc.
470 ******************************************************************************/
472 void *acpi_ut_callocate_and_track(acpi_size size,
473 u32 component, char *module, u32 line)
475 struct acpi_debug_mem_block *allocation;
479 acpi_ut_callocate(size + sizeof(struct acpi_debug_mem_header),
480 component, module, line);
483 /* Report allocation error */
485 ACPI_ERROR((module, line,
486 "Could not allocate size %X", (u32) size));
490 status = acpi_ut_track_allocation(allocation, size,
491 ACPI_MEM_CALLOC, component, module,
493 if (ACPI_FAILURE(status)) {
494 acpi_os_free(allocation);
498 acpi_gbl_global_list->total_allocated++;
499 acpi_gbl_global_list->current_total_size += (u32) size;
501 return ((void *)&allocation->user_space);
504 /*******************************************************************************
506 * FUNCTION: acpi_ut_free_and_track
508 * PARAMETERS: Allocation - Address of the memory to deallocate
509 * Component - Component type of caller
510 * Module - Source file name of caller
511 * Line - Line number of caller
515 * DESCRIPTION: Frees the memory at Allocation
517 ******************************************************************************/
520 acpi_ut_free_and_track(void *allocation, u32 component, char *module, u32 line)
522 struct acpi_debug_mem_block *debug_block;
525 ACPI_FUNCTION_TRACE_PTR("ut_free", allocation);
527 if (NULL == allocation) {
528 ACPI_ERROR((module, line, "Attempt to delete a NULL address"));
533 debug_block = ACPI_CAST_PTR(struct acpi_debug_mem_block,
534 (((char *)allocation) -
535 sizeof(struct acpi_debug_mem_header)));
537 acpi_gbl_global_list->total_freed++;
538 acpi_gbl_global_list->current_total_size -= debug_block->size;
540 status = acpi_ut_remove_allocation(debug_block,
541 component, module, line);
542 if (ACPI_FAILURE(status)) {
543 ACPI_EXCEPTION((AE_INFO, status, "Could not free memory"));
546 acpi_os_free(debug_block);
547 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS, "%p freed\n", allocation));
551 /*******************************************************************************
553 * FUNCTION: acpi_ut_find_allocation
555 * PARAMETERS: Allocation - Address of allocated memory
557 * RETURN: A list element if found; NULL otherwise.
559 * DESCRIPTION: Searches for an element in the global allocation tracking list.
561 ******************************************************************************/
563 static struct acpi_debug_mem_block *acpi_ut_find_allocation(void *allocation)
565 struct acpi_debug_mem_block *element;
567 ACPI_FUNCTION_ENTRY();
569 element = acpi_gbl_global_list->list_head;
571 /* Search for the address. */
574 if (element == allocation) {
578 element = element->next;
584 /*******************************************************************************
586 * FUNCTION: acpi_ut_track_allocation
588 * PARAMETERS: Allocation - Address of allocated memory
589 * Size - Size of the allocation
590 * alloc_type - MEM_MALLOC or MEM_CALLOC
591 * Component - Component type of caller
592 * Module - Source file name of caller
593 * Line - Line number of caller
597 * DESCRIPTION: Inserts an element into the global allocation tracking list.
599 ******************************************************************************/
602 acpi_ut_track_allocation(struct acpi_debug_mem_block *allocation,
604 u8 alloc_type, u32 component, char *module, u32 line)
606 struct acpi_memory_list *mem_list;
607 struct acpi_debug_mem_block *element;
608 acpi_status status = AE_OK;
610 ACPI_FUNCTION_TRACE_PTR("ut_track_allocation", allocation);
612 mem_list = acpi_gbl_global_list;
613 status = acpi_ut_acquire_mutex(ACPI_MTX_MEMORY);
614 if (ACPI_FAILURE(status)) {
615 return_ACPI_STATUS(status);
619 * Search list for this address to make sure it is not already on the list.
620 * This will catch several kinds of problems.
622 element = acpi_ut_find_allocation(allocation);
625 "ut_track_allocation: Allocation already present in list! (%p)",
628 ACPI_ERROR((AE_INFO, "Element %p Address %p",
629 element, allocation));
631 goto unlock_and_exit;
634 /* Fill in the instance data. */
636 allocation->size = (u32) size;
637 allocation->alloc_type = alloc_type;
638 allocation->component = component;
639 allocation->line = line;
641 ACPI_STRNCPY(allocation->module, module, ACPI_MAX_MODULE_NAME);
642 allocation->module[ACPI_MAX_MODULE_NAME - 1] = 0;
644 /* Insert at list head */
646 if (mem_list->list_head) {
647 ((struct acpi_debug_mem_block *)(mem_list->list_head))->
648 previous = allocation;
651 allocation->next = mem_list->list_head;
652 allocation->previous = NULL;
654 mem_list->list_head = allocation;
657 status = acpi_ut_release_mutex(ACPI_MTX_MEMORY);
658 return_ACPI_STATUS(status);
661 /*******************************************************************************
663 * FUNCTION: acpi_ut_remove_allocation
665 * PARAMETERS: Allocation - Address of allocated memory
666 * Component - Component type of caller
667 * Module - Source file name of caller
668 * Line - Line number of caller
672 * DESCRIPTION: Deletes an element from the global allocation tracking list.
674 ******************************************************************************/
677 acpi_ut_remove_allocation(struct acpi_debug_mem_block *allocation,
678 u32 component, char *module, u32 line)
680 struct acpi_memory_list *mem_list;
683 ACPI_FUNCTION_TRACE("ut_remove_allocation");
685 mem_list = acpi_gbl_global_list;
686 if (NULL == mem_list->list_head) {
688 /* No allocations! */
690 ACPI_ERROR((module, line,
691 "Empty allocation list, nothing to free!"));
693 return_ACPI_STATUS(AE_OK);
696 status = acpi_ut_acquire_mutex(ACPI_MTX_MEMORY);
697 if (ACPI_FAILURE(status)) {
698 return_ACPI_STATUS(status);
703 if (allocation->previous) {
704 (allocation->previous)->next = allocation->next;
706 mem_list->list_head = allocation->next;
709 if (allocation->next) {
710 (allocation->next)->previous = allocation->previous;
713 /* Mark the segment as deleted */
715 ACPI_MEMSET(&allocation->user_space, 0xEA, allocation->size);
717 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS, "Freeing size 0%X\n",
720 status = acpi_ut_release_mutex(ACPI_MTX_MEMORY);
721 return_ACPI_STATUS(status);
724 /*******************************************************************************
726 * FUNCTION: acpi_ut_dump_allocation_info
732 * DESCRIPTION: Print some info about the outstanding allocations.
734 ******************************************************************************/
736 #ifdef ACPI_FUTURE_USAGE
737 void acpi_ut_dump_allocation_info(void)
740 struct acpi_memory_list *mem_list;
743 ACPI_FUNCTION_TRACE("ut_dump_allocation_info");
746 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
747 ("%30s: %4d (%3d Kb)\n", "Current allocations",
748 mem_list->current_count,
749 ROUND_UP_TO_1K (mem_list->current_size)));
751 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
752 ("%30s: %4d (%3d Kb)\n", "Max concurrent allocations",
753 mem_list->max_concurrent_count,
754 ROUND_UP_TO_1K (mem_list->max_concurrent_size)));
756 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
757 ("%30s: %4d (%3d Kb)\n", "Total (all) internal objects",
758 running_object_count,
759 ROUND_UP_TO_1K (running_object_size)));
761 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
762 ("%30s: %4d (%3d Kb)\n", "Total (all) allocations",
764 ROUND_UP_TO_1K (running_alloc_size)));
766 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
767 ("%30s: %4d (%3d Kb)\n", "Current Nodes",
768 acpi_gbl_current_node_count,
769 ROUND_UP_TO_1K (acpi_gbl_current_node_size)));
771 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
772 ("%30s: %4d (%3d Kb)\n", "Max Nodes",
773 acpi_gbl_max_concurrent_node_count,
774 ROUND_UP_TO_1K ((acpi_gbl_max_concurrent_node_count *
775 sizeof (struct acpi_namespace_node)))));
779 #endif /* ACPI_FUTURE_USAGE */
781 /*******************************************************************************
783 * FUNCTION: acpi_ut_dump_allocations
785 * PARAMETERS: Component - Component(s) to dump info for.
786 * Module - Module to dump info for. NULL means all.
790 * DESCRIPTION: Print a list of all outstanding allocations.
792 ******************************************************************************/
794 void acpi_ut_dump_allocations(u32 component, char *module)
796 struct acpi_debug_mem_block *element;
797 union acpi_descriptor *descriptor;
798 u32 num_outstanding = 0;
800 ACPI_FUNCTION_TRACE("ut_dump_allocations");
803 * Walk the allocation list.
805 if (ACPI_FAILURE(acpi_ut_acquire_mutex(ACPI_MTX_MEMORY))) {
809 element = acpi_gbl_global_list->list_head;
811 if ((element->component & component) &&
813 || (0 == ACPI_STRCMP(module, element->module)))) {
815 /* Ignore allocated objects that are in a cache */
818 ACPI_CAST_PTR(union acpi_descriptor,
819 &element->user_space);
820 if (descriptor->descriptor_id != ACPI_DESC_TYPE_CACHED) {
821 acpi_os_printf("%p Len %04X %9.9s-%d [%s] ",
822 descriptor, element->size,
823 element->module, element->line,
824 acpi_ut_get_descriptor_name
827 /* Most of the elements will be Operand objects. */
829 switch (ACPI_GET_DESCRIPTOR_TYPE(descriptor)) {
830 case ACPI_DESC_TYPE_OPERAND:
831 acpi_os_printf("%12.12s R%hd",
832 acpi_ut_get_type_name
836 common.reference_count);
839 case ACPI_DESC_TYPE_PARSER:
840 acpi_os_printf("aml_opcode %04hX",
845 case ACPI_DESC_TYPE_NAMED:
846 acpi_os_printf("%4.4s",
847 acpi_ut_get_node_name
848 (&descriptor->node));
855 acpi_os_printf("\n");
859 element = element->next;
862 (void)acpi_ut_release_mutex(ACPI_MTX_MEMORY);
866 if (!num_outstanding) {
867 ACPI_INFO((AE_INFO, "No outstanding allocations"));
870 "%d(%X) Outstanding allocations",
871 num_outstanding, num_outstanding));
877 #endif /* #ifdef ACPI_DBG_TRACK_ALLOCATIONS */