1 /******************************************************************************
3 * Module Name: uttrack - Memory allocation tracking routines (debug only)
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************/
117 * These procedures are used for tracking memory leaks in the subsystem, and
118 * they get compiled out when the ACPI_DBG_TRACK_ALLOCATIONS is not set.
120 * Each memory allocation is tracked via a doubly linked list. Each
121 * element contains the caller's component, module name, function name, and
122 * line number. AcpiUtAllocate and AcpiUtAllocateZeroed call
123 * AcpiUtTrackAllocation to add an element to the list; deletion
124 * occurs in the body of AcpiUtFree.
127 #define __UTTRACK_C__
130 #include "accommon.h"
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 %u", (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 if (AcpiGbl_DisableMemTracking
)
441 return_ACPI_STATUS (AE_OK
);
444 MemList
= AcpiGbl_GlobalList
;
445 Status
= AcpiUtAcquireMutex (ACPI_MTX_MEMORY
);
446 if (ACPI_FAILURE (Status
))
448 return_ACPI_STATUS (Status
);
452 * Search list for this address to make sure it is not already on the list.
453 * This will catch several kinds of problems.
455 Element
= AcpiUtFindAllocation (Allocation
);
458 ACPI_ERROR ((AE_INFO
,
459 "UtTrackAllocation: Allocation already present in list! (%p)",
462 ACPI_ERROR ((AE_INFO
, "Element %p Address %p",
463 Element
, Allocation
));
468 /* Fill in the instance data. */
470 Allocation
->Size
= (UINT32
) Size
;
471 Allocation
->AllocType
= AllocType
;
472 Allocation
->Component
= Component
;
473 Allocation
->Line
= Line
;
475 ACPI_STRNCPY (Allocation
->Module
, Module
, ACPI_MAX_MODULE_NAME
);
476 Allocation
->Module
[ACPI_MAX_MODULE_NAME
-1] = 0;
478 /* Insert at list head */
480 if (MemList
->ListHead
)
482 ((ACPI_DEBUG_MEM_BLOCK
*)(MemList
->ListHead
))->Previous
= Allocation
;
485 Allocation
->Next
= MemList
->ListHead
;
486 Allocation
->Previous
= NULL
;
488 MemList
->ListHead
= Allocation
;
492 Status
= AcpiUtReleaseMutex (ACPI_MTX_MEMORY
);
493 return_ACPI_STATUS (Status
);
497 /*******************************************************************************
499 * FUNCTION: AcpiUtRemoveAllocation
501 * PARAMETERS: Allocation - Address of allocated memory
502 * Component - Component type of caller
503 * Module - Source file name of caller
504 * Line - Line number of caller
508 * DESCRIPTION: Deletes an element from the global allocation tracking list.
510 ******************************************************************************/
513 AcpiUtRemoveAllocation (
514 ACPI_DEBUG_MEM_BLOCK
*Allocation
,
519 ACPI_MEMORY_LIST
*MemList
;
523 ACPI_FUNCTION_TRACE (UtRemoveAllocation
);
526 if (AcpiGbl_DisableMemTracking
)
528 return_ACPI_STATUS (AE_OK
);
531 MemList
= AcpiGbl_GlobalList
;
532 if (NULL
== MemList
->ListHead
)
534 /* No allocations! */
536 ACPI_ERROR ((Module
, Line
,
537 "Empty allocation list, nothing to free!"));
539 return_ACPI_STATUS (AE_OK
);
542 Status
= AcpiUtAcquireMutex (ACPI_MTX_MEMORY
);
543 if (ACPI_FAILURE (Status
))
545 return_ACPI_STATUS (Status
);
550 if (Allocation
->Previous
)
552 (Allocation
->Previous
)->Next
= Allocation
->Next
;
556 MemList
->ListHead
= Allocation
->Next
;
559 if (Allocation
->Next
)
561 (Allocation
->Next
)->Previous
= Allocation
->Previous
;
564 /* Mark the segment as deleted */
566 ACPI_MEMSET (&Allocation
->UserSpace
, 0xEA, Allocation
->Size
);
568 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS
, "Freeing size 0%X\n",
571 Status
= AcpiUtReleaseMutex (ACPI_MTX_MEMORY
);
572 return_ACPI_STATUS (Status
);
576 /*******************************************************************************
578 * FUNCTION: AcpiUtDumpAllocationInfo
584 * DESCRIPTION: Print some info about the outstanding allocations.
586 ******************************************************************************/
589 AcpiUtDumpAllocationInfo (
593 ACPI_MEMORY_LIST *MemList;
596 ACPI_FUNCTION_TRACE (UtDumpAllocationInfo
);
599 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
600 ("%30s: %4d (%3d Kb)\n", "Current allocations",
601 MemList->CurrentCount,
602 ROUND_UP_TO_1K (MemList->CurrentSize)));
604 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
605 ("%30s: %4d (%3d Kb)\n", "Max concurrent allocations",
606 MemList->MaxConcurrentCount,
607 ROUND_UP_TO_1K (MemList->MaxConcurrentSize)));
610 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
611 ("%30s: %4d (%3d Kb)\n", "Total (all) internal objects",
613 ROUND_UP_TO_1K (RunningObjectSize)));
615 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
616 ("%30s: %4d (%3d Kb)\n", "Total (all) allocations",
618 ROUND_UP_TO_1K (RunningAllocSize)));
621 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
622 ("%30s: %4d (%3d Kb)\n", "Current Nodes",
623 AcpiGbl_CurrentNodeCount,
624 ROUND_UP_TO_1K (AcpiGbl_CurrentNodeSize)));
626 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
627 ("%30s: %4d (%3d Kb)\n", "Max Nodes",
628 AcpiGbl_MaxConcurrentNodeCount,
629 ROUND_UP_TO_1K ((AcpiGbl_MaxConcurrentNodeCount *
630 sizeof (ACPI_NAMESPACE_NODE)))));
636 /*******************************************************************************
638 * FUNCTION: AcpiUtDumpAllocations
640 * PARAMETERS: Component - Component(s) to dump info for.
641 * Module - Module to dump info for. NULL means all.
645 * DESCRIPTION: Print a list of all outstanding allocations.
647 ******************************************************************************/
650 AcpiUtDumpAllocations (
654 ACPI_DEBUG_MEM_BLOCK
*Element
;
655 ACPI_DESCRIPTOR
*Descriptor
;
656 UINT32 NumOutstanding
= 0;
657 UINT8 DescriptorType
;
660 ACPI_FUNCTION_TRACE (UtDumpAllocations
);
663 if (AcpiGbl_DisableMemTracking
)
669 * Walk the allocation list.
671 if (ACPI_FAILURE (AcpiUtAcquireMutex (ACPI_MTX_MEMORY
)))
676 Element
= AcpiGbl_GlobalList
->ListHead
;
679 if ((Element
->Component
& Component
) &&
680 ((Module
== NULL
) || (0 == ACPI_STRCMP (Module
, Element
->Module
))))
682 Descriptor
= ACPI_CAST_PTR (ACPI_DESCRIPTOR
, &Element
->UserSpace
);
684 if (Element
->Size
< sizeof (ACPI_COMMON_DESCRIPTOR
))
686 AcpiOsPrintf ("%p Length 0x%04X %9.9s-%u "
687 "[Not a Descriptor - too small]\n",
688 Descriptor
, Element
->Size
, Element
->Module
,
693 /* Ignore allocated objects that are in a cache */
695 if (ACPI_GET_DESCRIPTOR_TYPE (Descriptor
) != ACPI_DESC_TYPE_CACHED
)
697 AcpiOsPrintf ("%p Length 0x%04X %9.9s-%u [%s] ",
698 Descriptor
, Element
->Size
, Element
->Module
,
699 Element
->Line
, AcpiUtGetDescriptorName (Descriptor
));
701 /* Validate the descriptor type using Type field and length */
703 DescriptorType
= 0; /* Not a valid descriptor type */
705 switch (ACPI_GET_DESCRIPTOR_TYPE (Descriptor
))
707 case ACPI_DESC_TYPE_OPERAND
:
708 if (Element
->Size
== sizeof (ACPI_DESC_TYPE_OPERAND
))
710 DescriptorType
= ACPI_DESC_TYPE_OPERAND
;
714 case ACPI_DESC_TYPE_PARSER
:
715 if (Element
->Size
== sizeof (ACPI_DESC_TYPE_PARSER
))
717 DescriptorType
= ACPI_DESC_TYPE_PARSER
;
721 case ACPI_DESC_TYPE_NAMED
:
722 if (Element
->Size
== sizeof (ACPI_DESC_TYPE_NAMED
))
724 DescriptorType
= ACPI_DESC_TYPE_NAMED
;
732 /* Display additional info for the major descriptor types */
734 switch (DescriptorType
)
736 case ACPI_DESC_TYPE_OPERAND
:
737 AcpiOsPrintf ("%12.12s RefCount 0x%04X\n",
738 AcpiUtGetTypeName (Descriptor
->Object
.Common
.Type
),
739 Descriptor
->Object
.Common
.ReferenceCount
);
742 case ACPI_DESC_TYPE_PARSER
:
743 AcpiOsPrintf ("AmlOpcode 0x%04hX\n",
744 Descriptor
->Op
.Asl
.AmlOpcode
);
747 case ACPI_DESC_TYPE_NAMED
:
748 AcpiOsPrintf ("%4.4s\n",
749 AcpiUtGetNodeName (&Descriptor
->Node
));
753 AcpiOsPrintf ( "\n");
762 Element
= Element
->Next
;
765 (void) AcpiUtReleaseMutex (ACPI_MTX_MEMORY
);
771 ACPI_INFO ((AE_INFO
, "No outstanding allocations"));
775 ACPI_ERROR ((AE_INFO
, "%u(0x%X) Outstanding allocations",
776 NumOutstanding
, NumOutstanding
));
782 #endif /* ACPI_DBG_TRACK_ALLOCATIONS */