1 /******************************************************************************
3 * Module Name: utalloc - local memory allocation routines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2005, 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_MEM_CALLOCATE(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_REPORT_ERROR(module, line, component,
305 ("ut_allocate: Attempt to allocate zero bytes, allocating 1 byte\n"));
309 allocation = acpi_os_allocate(size);
311 /* Report allocation error */
313 _ACPI_REPORT_ERROR(module, line, component,
314 ("ut_allocate: Could not allocate size %X\n",
320 return_PTR(allocation);
323 /*******************************************************************************
325 * FUNCTION: acpi_ut_callocate
327 * PARAMETERS: Size - Size of the allocation
328 * Component - Component type of caller
329 * Module - Source file name of caller
330 * Line - Line number of caller
332 * RETURN: Address of the allocated memory on success, NULL on failure.
334 * DESCRIPTION: Subsystem equivalent of calloc.
336 ******************************************************************************/
338 void *acpi_ut_callocate(acpi_size size, u32 component, char *module, u32 line)
342 ACPI_FUNCTION_TRACE_U32("ut_callocate", size);
344 /* Check for an inadvertent size of zero bytes */
347 _ACPI_REPORT_ERROR(module, line, component,
348 ("ut_callocate: Attempt to allocate zero bytes, allocating 1 byte\n"));
352 allocation = acpi_os_allocate(size);
354 /* Report allocation error */
356 _ACPI_REPORT_ERROR(module, line, component,
357 ("ut_callocate: Could not allocate size %X\n",
362 /* Clear the memory block */
364 ACPI_MEMSET(allocation, 0, size);
365 return_PTR(allocation);
368 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
370 * These procedures are used for tracking memory leaks in the subsystem, and
371 * they get compiled out when the ACPI_DBG_TRACK_ALLOCATIONS is not set.
373 * Each memory allocation is tracked via a doubly linked list. Each
374 * element contains the caller's component, module name, function name, and
375 * line number. acpi_ut_allocate and acpi_ut_callocate call
376 * acpi_ut_track_allocation to add an element to the list; deletion
377 * occurs in the body of acpi_ut_free.
380 /*******************************************************************************
382 * FUNCTION: acpi_ut_create_list
384 * PARAMETERS: cache_name - Ascii name for the cache
385 * object_size - Size of each cached object
386 * return_cache - Where the new cache object is returned
390 * DESCRIPTION: Create a local memory list for tracking purposed
392 ******************************************************************************/
395 acpi_ut_create_list(char *list_name,
396 u16 object_size, struct acpi_memory_list **return_cache)
398 struct acpi_memory_list *cache;
400 cache = acpi_os_allocate(sizeof(struct acpi_memory_list));
402 return (AE_NO_MEMORY);
405 ACPI_MEMSET(cache, 0, sizeof(struct acpi_memory_list));
407 cache->list_name = list_name;
408 cache->object_size = object_size;
410 *return_cache = cache;
414 /*******************************************************************************
416 * FUNCTION: acpi_ut_allocate_and_track
418 * PARAMETERS: Size - Size of the allocation
419 * Component - Component type of caller
420 * Module - Source file name of caller
421 * Line - Line number of caller
423 * RETURN: Address of the allocated memory on success, NULL on failure.
425 * DESCRIPTION: The subsystem's equivalent of malloc.
427 ******************************************************************************/
429 void *acpi_ut_allocate_and_track(acpi_size size,
430 u32 component, char *module, u32 line)
432 struct acpi_debug_mem_block *allocation;
436 acpi_ut_allocate(size + sizeof(struct acpi_debug_mem_header),
437 component, module, line);
442 status = acpi_ut_track_allocation(allocation, size,
443 ACPI_MEM_MALLOC, component, module,
445 if (ACPI_FAILURE(status)) {
446 acpi_os_free(allocation);
450 acpi_gbl_global_list->total_allocated++;
451 acpi_gbl_global_list->current_total_size += (u32) size;
453 return ((void *)&allocation->user_space);
456 /*******************************************************************************
458 * FUNCTION: acpi_ut_callocate_and_track
460 * PARAMETERS: Size - Size of the allocation
461 * Component - Component type of caller
462 * Module - Source file name of caller
463 * Line - Line number of caller
465 * RETURN: Address of the allocated memory on success, NULL on failure.
467 * DESCRIPTION: Subsystem equivalent of calloc.
469 ******************************************************************************/
471 void *acpi_ut_callocate_and_track(acpi_size size,
472 u32 component, char *module, u32 line)
474 struct acpi_debug_mem_block *allocation;
478 acpi_ut_callocate(size + sizeof(struct acpi_debug_mem_header),
479 component, module, line);
481 /* Report allocation error */
483 _ACPI_REPORT_ERROR(module, line, component,
484 ("ut_callocate: Could not allocate size %X\n",
489 status = acpi_ut_track_allocation(allocation, size,
490 ACPI_MEM_CALLOC, component, module,
492 if (ACPI_FAILURE(status)) {
493 acpi_os_free(allocation);
497 acpi_gbl_global_list->total_allocated++;
498 acpi_gbl_global_list->current_total_size += (u32) size;
500 return ((void *)&allocation->user_space);
503 /*******************************************************************************
505 * FUNCTION: acpi_ut_free_and_track
507 * PARAMETERS: Allocation - Address of the memory to deallocate
508 * Component - Component type of caller
509 * Module - Source file name of caller
510 * Line - Line number of caller
514 * DESCRIPTION: Frees the memory at Allocation
516 ******************************************************************************/
519 acpi_ut_free_and_track(void *allocation, u32 component, char *module, u32 line)
521 struct acpi_debug_mem_block *debug_block;
524 ACPI_FUNCTION_TRACE_PTR("ut_free", allocation);
526 if (NULL == allocation) {
527 _ACPI_REPORT_ERROR(module, line, component,
528 ("acpi_ut_free: Attempt to delete a NULL address\n"));
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_DEBUG_PRINT((ACPI_DB_ERROR, "Could not free memory, %s\n",
544 acpi_format_exception(status)));
547 acpi_os_free(debug_block);
549 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS, "%p freed\n", allocation));
554 /*******************************************************************************
556 * FUNCTION: acpi_ut_find_allocation
558 * PARAMETERS: Allocation - Address of allocated memory
560 * RETURN: A list element if found; NULL otherwise.
562 * DESCRIPTION: Searches for an element in the global allocation tracking list.
564 ******************************************************************************/
566 static struct acpi_debug_mem_block *acpi_ut_find_allocation(void *allocation)
568 struct acpi_debug_mem_block *element;
570 ACPI_FUNCTION_ENTRY();
572 element = acpi_gbl_global_list->list_head;
574 /* Search for the address. */
577 if (element == allocation) {
581 element = element->next;
587 /*******************************************************************************
589 * FUNCTION: acpi_ut_track_allocation
591 * PARAMETERS: Allocation - Address of allocated memory
592 * Size - Size of the allocation
593 * alloc_type - MEM_MALLOC or MEM_CALLOC
594 * Component - Component type of caller
595 * Module - Source file name of caller
596 * Line - Line number of caller
600 * DESCRIPTION: Inserts an element into the global allocation tracking list.
602 ******************************************************************************/
605 acpi_ut_track_allocation(struct acpi_debug_mem_block *allocation,
607 u8 alloc_type, u32 component, char *module, u32 line)
609 struct acpi_memory_list *mem_list;
610 struct acpi_debug_mem_block *element;
611 acpi_status status = AE_OK;
613 ACPI_FUNCTION_TRACE_PTR("ut_track_allocation", allocation);
615 mem_list = acpi_gbl_global_list;
616 status = acpi_ut_acquire_mutex(ACPI_MTX_MEMORY);
617 if (ACPI_FAILURE(status)) {
618 return_ACPI_STATUS(status);
622 * Search list for this address to make sure it is not already on the list.
623 * This will catch several kinds of problems.
625 element = acpi_ut_find_allocation(allocation);
627 ACPI_REPORT_ERROR(("ut_track_allocation: Allocation already present in list! (%p)\n", allocation));
629 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Element %p Address %p\n",
630 element, allocation));
632 goto unlock_and_exit;
635 /* Fill in the instance data. */
637 allocation->size = (u32) size;
638 allocation->alloc_type = alloc_type;
639 allocation->component = component;
640 allocation->line = line;
642 ACPI_STRNCPY(allocation->module, module, ACPI_MAX_MODULE_NAME);
643 allocation->module[ACPI_MAX_MODULE_NAME - 1] = 0;
645 /* Insert at list head */
647 if (mem_list->list_head) {
648 ((struct acpi_debug_mem_block *)(mem_list->list_head))->
649 previous = allocation;
652 allocation->next = mem_list->list_head;
653 allocation->previous = NULL;
655 mem_list->list_head = allocation;
658 status = acpi_ut_release_mutex(ACPI_MTX_MEMORY);
659 return_ACPI_STATUS(status);
662 /*******************************************************************************
664 * FUNCTION: acpi_ut_remove_allocation
666 * PARAMETERS: Allocation - Address of allocated memory
667 * Component - Component type of caller
668 * Module - Source file name of caller
669 * Line - Line number of caller
673 * DESCRIPTION: Deletes an element from the global allocation tracking list.
675 ******************************************************************************/
678 acpi_ut_remove_allocation(struct acpi_debug_mem_block *allocation,
679 u32 component, char *module, u32 line)
681 struct acpi_memory_list *mem_list;
684 ACPI_FUNCTION_TRACE("ut_remove_allocation");
686 mem_list = acpi_gbl_global_list;
687 if (NULL == mem_list->list_head) {
688 /* No allocations! */
690 _ACPI_REPORT_ERROR(module, line, component,
691 ("ut_remove_allocation: Empty allocation list, nothing to free!\n"));
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)))) {
814 /* Ignore allocated objects that are in a cache */
817 ACPI_CAST_PTR(union acpi_descriptor,
818 &element->user_space);
819 if (descriptor->descriptor_id != ACPI_DESC_TYPE_CACHED) {
820 acpi_os_printf("%p Len %04X %9.9s-%d [%s] ",
821 descriptor, element->size,
822 element->module, element->line,
823 acpi_ut_get_descriptor_name
826 /* Most of the elements will be Operand objects. */
828 switch (ACPI_GET_DESCRIPTOR_TYPE(descriptor)) {
829 case ACPI_DESC_TYPE_OPERAND:
830 acpi_os_printf("%12.12s R%hd",
831 acpi_ut_get_type_name
835 common.reference_count);
838 case ACPI_DESC_TYPE_PARSER:
839 acpi_os_printf("aml_opcode %04hX",
844 case ACPI_DESC_TYPE_NAMED:
845 acpi_os_printf("%4.4s",
846 acpi_ut_get_node_name
847 (&descriptor->node));
854 acpi_os_printf("\n");
858 element = element->next;
861 (void)acpi_ut_release_mutex(ACPI_MTX_MEMORY);
865 if (!num_outstanding) {
866 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
867 "No outstanding allocations\n"));
869 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
870 "%d(%X) Outstanding allocations\n",
871 num_outstanding, num_outstanding));
877 #endif /* #ifdef ACPI_DBG_TRACK_ALLOCATIONS */