1 /******************************************************************************
3 * Module Name: uttrack - Memory allocation tracking routines (debug only)
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
13 * All rights reserved.
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
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
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;
38 * The above copyright and patent license is granted only if the following
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.
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
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
73 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
81 * 4. Disclaimer and Export Compliance
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
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
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.
115 *****************************************************************************/
118 * These procedures are used for tracking memory leaks in the subsystem, and
119 * they get compiled out when the ACPI_DBG_TRACK_ALLOCATIONS is not set.
121 * Each memory allocation is tracked via a doubly linked list. Each
122 * element contains the caller's component, module name, function name, and
123 * line number. AcpiUtAllocate and AcpiUtAllocateZeroed call
124 * AcpiUtTrackAllocation to add an element to the list; deletion
125 * occurs in the body of AcpiUtFree.
128 #define __UTTRACK_C__
132 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
134 #define _COMPONENT ACPI_UTILITIES
135 ACPI_MODULE_NAME ("uttrack")
137 /* Local prototypes */
139 static ACPI_DEBUG_MEM_BLOCK *
140 AcpiUtFindAllocation (
144 AcpiUtTrackAllocation (
145 ACPI_DEBUG_MEM_BLOCK *Address,
153 AcpiUtRemoveAllocation (
154 ACPI_DEBUG_MEM_BLOCK *Address,
160 /*******************************************************************************
162 * FUNCTION: AcpiUtCreateList
164 * PARAMETERS: CacheName - Ascii name for the cache
165 * ObjectSize - Size of each cached object
166 * ReturnCache - Where the new cache object is returned
170 * DESCRIPTION: Create a local memory list for tracking purposed
172 ******************************************************************************/
178 ACPI_MEMORY_LIST **ReturnCache)
180 ACPI_MEMORY_LIST *Cache;
183 Cache = AcpiOsAllocate (sizeof (ACPI_MEMORY_LIST));
186 return (AE_NO_MEMORY);
189 ACPI_MEMSET (Cache, 0, sizeof (ACPI_MEMORY_LIST));
191 Cache->ListName = ListName;
192 Cache->ObjectSize = ObjectSize;
194 *ReturnCache = Cache;
199 /*******************************************************************************
201 * FUNCTION: AcpiUtAllocateAndTrack
203 * PARAMETERS: Size - Size of the allocation
204 * Component - Component type of caller
205 * Module - Source file name of caller
206 * Line - Line number of caller
208 * RETURN: Address of the allocated memory on success, NULL on failure.
210 * DESCRIPTION: The subsystem's equivalent of malloc.
212 ******************************************************************************/
215 AcpiUtAllocateAndTrack (
221 ACPI_DEBUG_MEM_BLOCK *Allocation;
225 Allocation = AcpiUtAllocate (Size + sizeof (ACPI_DEBUG_MEM_HEADER),
226 Component, Module, Line);
232 Status = AcpiUtTrackAllocation (Allocation, Size,
233 ACPI_MEM_MALLOC, Component, Module, Line);
234 if (ACPI_FAILURE (Status))
236 AcpiOsFree (Allocation);
240 AcpiGbl_GlobalList->TotalAllocated++;
241 AcpiGbl_GlobalList->TotalSize += (UINT32) Size;
242 AcpiGbl_GlobalList->CurrentTotalSize += (UINT32) Size;
243 if (AcpiGbl_GlobalList->CurrentTotalSize > AcpiGbl_GlobalList->MaxOccupied)
245 AcpiGbl_GlobalList->MaxOccupied = AcpiGbl_GlobalList->CurrentTotalSize;
248 return ((void *) &Allocation->UserSpace);
252 /*******************************************************************************
254 * FUNCTION: AcpiUtAllocateZeroedAndTrack
256 * PARAMETERS: Size - Size of the allocation
257 * Component - Component type of caller
258 * Module - Source file name of caller
259 * Line - Line number of caller
261 * RETURN: Address of the allocated memory on success, NULL on failure.
263 * DESCRIPTION: Subsystem equivalent of calloc.
265 ******************************************************************************/
268 AcpiUtAllocateZeroedAndTrack (
274 ACPI_DEBUG_MEM_BLOCK *Allocation;
278 Allocation = AcpiUtAllocateZeroed (Size + sizeof (ACPI_DEBUG_MEM_HEADER),
279 Component, Module, Line);
282 /* Report allocation error */
284 ACPI_ERROR ((Module, Line,
285 "Could not allocate size %X", (UINT32) Size));
289 Status = AcpiUtTrackAllocation (Allocation, Size,
290 ACPI_MEM_CALLOC, Component, Module, Line);
291 if (ACPI_FAILURE (Status))
293 AcpiOsFree (Allocation);
297 AcpiGbl_GlobalList->TotalAllocated++;
298 AcpiGbl_GlobalList->TotalSize += (UINT32) Size;
299 AcpiGbl_GlobalList->CurrentTotalSize += (UINT32) Size;
300 if (AcpiGbl_GlobalList->CurrentTotalSize > AcpiGbl_GlobalList->MaxOccupied)
302 AcpiGbl_GlobalList->MaxOccupied = AcpiGbl_GlobalList->CurrentTotalSize;
305 return ((void *) &Allocation->UserSpace);
309 /*******************************************************************************
311 * FUNCTION: AcpiUtFreeAndTrack
313 * PARAMETERS: Allocation - Address of the memory to deallocate
314 * Component - Component type of caller
315 * Module - Source file name of caller
316 * Line - Line number of caller
320 * DESCRIPTION: Frees the memory at Allocation
322 ******************************************************************************/
331 ACPI_DEBUG_MEM_BLOCK *DebugBlock;
335 ACPI_FUNCTION_TRACE_PTR (UtFree, Allocation);
338 if (NULL == Allocation)
340 ACPI_ERROR ((Module, Line,
341 "Attempt to delete a NULL address"));
346 DebugBlock = ACPI_CAST_PTR (ACPI_DEBUG_MEM_BLOCK,
347 (((char *) Allocation) - sizeof (ACPI_DEBUG_MEM_HEADER)));
349 AcpiGbl_GlobalList->TotalFreed++;
350 AcpiGbl_GlobalList->CurrentTotalSize -= DebugBlock->Size;
352 Status = AcpiUtRemoveAllocation (DebugBlock,
353 Component, Module, Line);
354 if (ACPI_FAILURE (Status))
356 ACPI_EXCEPTION ((AE_INFO, Status, "Could not free memory"));
359 AcpiOsFree (DebugBlock);
360 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "%p freed\n", Allocation));
365 /*******************************************************************************
367 * FUNCTION: AcpiUtFindAllocation
369 * PARAMETERS: Allocation - Address of allocated memory
371 * RETURN: A list element if found; NULL otherwise.
373 * DESCRIPTION: Searches for an element in the global allocation tracking list.
375 ******************************************************************************/
377 static ACPI_DEBUG_MEM_BLOCK *
378 AcpiUtFindAllocation (
381 ACPI_DEBUG_MEM_BLOCK *Element;
384 ACPI_FUNCTION_ENTRY ();
387 Element = AcpiGbl_GlobalList->ListHead;
389 /* Search for the address. */
393 if (Element == Allocation)
398 Element = Element->Next;
405 /*******************************************************************************
407 * FUNCTION: AcpiUtTrackAllocation
409 * PARAMETERS: Allocation - Address of allocated memory
410 * Size - Size of the allocation
411 * AllocType - MEM_MALLOC or MEM_CALLOC
412 * Component - Component type of caller
413 * Module - Source file name of caller
414 * Line - Line number of caller
418 * DESCRIPTION: Inserts an element into the global allocation tracking list.
420 ******************************************************************************/
423 AcpiUtTrackAllocation (
424 ACPI_DEBUG_MEM_BLOCK *Allocation,
431 ACPI_MEMORY_LIST *MemList;
432 ACPI_DEBUG_MEM_BLOCK *Element;
433 ACPI_STATUS Status = AE_OK;
436 ACPI_FUNCTION_TRACE_PTR (UtTrackAllocation, Allocation);
439 MemList = AcpiGbl_GlobalList;
440 Status = AcpiUtAcquireMutex (ACPI_MTX_MEMORY);
441 if (ACPI_FAILURE (Status))
443 return_ACPI_STATUS (Status);
447 * Search list for this address to make sure it is not already on the list.
448 * This will catch several kinds of problems.
450 Element = AcpiUtFindAllocation (Allocation);
453 ACPI_ERROR ((AE_INFO,
454 "UtTrackAllocation: Allocation already present in list! (%p)",
457 ACPI_ERROR ((AE_INFO, "Element %p Address %p",
458 Element, Allocation));
463 /* Fill in the instance data. */
465 Allocation->Size = (UINT32) Size;
466 Allocation->AllocType = AllocType;
467 Allocation->Component = Component;
468 Allocation->Line = Line;
470 ACPI_STRNCPY (Allocation->Module, Module, ACPI_MAX_MODULE_NAME);
471 Allocation->Module[ACPI_MAX_MODULE_NAME-1] = 0;
473 /* Insert at list head */
475 if (MemList->ListHead)
477 ((ACPI_DEBUG_MEM_BLOCK *)(MemList->ListHead))->Previous = Allocation;
480 Allocation->Next = MemList->ListHead;
481 Allocation->Previous = NULL;
483 MemList->ListHead = Allocation;
487 Status = AcpiUtReleaseMutex (ACPI_MTX_MEMORY);
488 return_ACPI_STATUS (Status);
492 /*******************************************************************************
494 * FUNCTION: AcpiUtRemoveAllocation
496 * PARAMETERS: Allocation - Address of allocated memory
497 * Component - Component type of caller
498 * Module - Source file name of caller
499 * Line - Line number of caller
503 * DESCRIPTION: Deletes an element from the global allocation tracking list.
505 ******************************************************************************/
508 AcpiUtRemoveAllocation (
509 ACPI_DEBUG_MEM_BLOCK *Allocation,
514 ACPI_MEMORY_LIST *MemList;
518 ACPI_FUNCTION_TRACE (UtRemoveAllocation);
521 MemList = AcpiGbl_GlobalList;
522 if (NULL == MemList->ListHead)
524 /* No allocations! */
526 ACPI_ERROR ((Module, Line,
527 "Empty allocation list, nothing to free!"));
529 return_ACPI_STATUS (AE_OK);
532 Status = AcpiUtAcquireMutex (ACPI_MTX_MEMORY);
533 if (ACPI_FAILURE (Status))
535 return_ACPI_STATUS (Status);
540 if (Allocation->Previous)
542 (Allocation->Previous)->Next = Allocation->Next;
546 MemList->ListHead = Allocation->Next;
549 if (Allocation->Next)
551 (Allocation->Next)->Previous = Allocation->Previous;
554 /* Mark the segment as deleted */
556 ACPI_MEMSET (&Allocation->UserSpace, 0xEA, Allocation->Size);
558 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "Freeing size 0%X\n",
561 Status = AcpiUtReleaseMutex (ACPI_MTX_MEMORY);
562 return_ACPI_STATUS (Status);
566 /*******************************************************************************
568 * FUNCTION: AcpiUtDumpAllocationInfo
574 * DESCRIPTION: Print some info about the outstanding allocations.
576 ******************************************************************************/
579 AcpiUtDumpAllocationInfo (
583 ACPI_MEMORY_LIST *MemList;
586 ACPI_FUNCTION_TRACE (UtDumpAllocationInfo);
589 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
590 ("%30s: %4d (%3d Kb)\n", "Current allocations",
591 MemList->CurrentCount,
592 ROUND_UP_TO_1K (MemList->CurrentSize)));
594 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
595 ("%30s: %4d (%3d Kb)\n", "Max concurrent allocations",
596 MemList->MaxConcurrentCount,
597 ROUND_UP_TO_1K (MemList->MaxConcurrentSize)));
600 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
601 ("%30s: %4d (%3d Kb)\n", "Total (all) internal objects",
603 ROUND_UP_TO_1K (RunningObjectSize)));
605 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
606 ("%30s: %4d (%3d Kb)\n", "Total (all) allocations",
608 ROUND_UP_TO_1K (RunningAllocSize)));
611 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
612 ("%30s: %4d (%3d Kb)\n", "Current Nodes",
613 AcpiGbl_CurrentNodeCount,
614 ROUND_UP_TO_1K (AcpiGbl_CurrentNodeSize)));
616 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
617 ("%30s: %4d (%3d Kb)\n", "Max Nodes",
618 AcpiGbl_MaxConcurrentNodeCount,
619 ROUND_UP_TO_1K ((AcpiGbl_MaxConcurrentNodeCount *
620 sizeof (ACPI_NAMESPACE_NODE)))));
626 /*******************************************************************************
628 * FUNCTION: AcpiUtDumpAllocations
630 * PARAMETERS: Component - Component(s) to dump info for.
631 * Module - Module to dump info for. NULL means all.
635 * DESCRIPTION: Print a list of all outstanding allocations.
637 ******************************************************************************/
640 AcpiUtDumpAllocations (
644 ACPI_DEBUG_MEM_BLOCK *Element;
645 ACPI_DESCRIPTOR *Descriptor;
646 UINT32 NumOutstanding = 0;
649 ACPI_FUNCTION_TRACE (UtDumpAllocations);
653 * Walk the allocation list.
655 if (ACPI_FAILURE (AcpiUtAcquireMutex (ACPI_MTX_MEMORY)))
660 Element = AcpiGbl_GlobalList->ListHead;
663 if ((Element->Component & Component) &&
664 ((Module == NULL) || (0 == ACPI_STRCMP (Module, Element->Module))))
666 /* Ignore allocated objects that are in a cache */
668 Descriptor = ACPI_CAST_PTR (ACPI_DESCRIPTOR, &Element->UserSpace);
669 if (ACPI_GET_DESCRIPTOR_TYPE (Descriptor) != ACPI_DESC_TYPE_CACHED)
671 AcpiOsPrintf ("%p Len %04X %9.9s-%d [%s] ",
672 Descriptor, Element->Size, Element->Module,
673 Element->Line, AcpiUtGetDescriptorName (Descriptor));
675 /* Most of the elements will be Operand objects. */
677 switch (ACPI_GET_DESCRIPTOR_TYPE (Descriptor))
679 case ACPI_DESC_TYPE_OPERAND:
680 AcpiOsPrintf ("%12.12s R%hd",
681 AcpiUtGetTypeName (Descriptor->Object.Common.Type),
682 Descriptor->Object.Common.ReferenceCount);
685 case ACPI_DESC_TYPE_PARSER:
686 AcpiOsPrintf ("AmlOpcode %04hX",
687 Descriptor->Op.Asl.AmlOpcode);
690 case ACPI_DESC_TYPE_NAMED:
691 AcpiOsPrintf ("%4.4s",
692 AcpiUtGetNodeName (&Descriptor->Node));
699 AcpiOsPrintf ( "\n");
703 Element = Element->Next;
706 (void) AcpiUtReleaseMutex (ACPI_MTX_MEMORY);
713 "No outstanding allocations"));
717 ACPI_ERROR ((AE_INFO,
718 "%d(%X) Outstanding allocations",
719 NumOutstanding, NumOutstanding));
725 #endif /* ACPI_DBG_TRACK_ALLOCATIONS */