1 /******************************************************************************
3 * Module Name: uttrack - Memory allocation tracking routines (debug only)
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, Intel Corp.
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.
45 * These procedures are used for tracking memory leaks in the subsystem, and
46 * they get compiled out when the ACPI_DBG_TRACK_ALLOCATIONS is not set.
48 * Each memory allocation is tracked via a doubly linked list. Each
49 * element contains the caller's component, module name, function name, and
50 * line number. AcpiUtAllocate and AcpiUtAllocateZeroed call
51 * AcpiUtTrackAllocation to add an element to the list; deletion
52 * occurs in the body of AcpiUtFree.
55 #include <contrib/dev/acpica/include/acpi.h>
56 #include <contrib/dev/acpica/include/accommon.h>
58 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
60 #define _COMPONENT ACPI_UTILITIES
61 ACPI_MODULE_NAME ("uttrack")
64 /* Local prototypes */
66 static ACPI_DEBUG_MEM_BLOCK *
67 AcpiUtFindAllocation (
68 ACPI_DEBUG_MEM_BLOCK *Allocation);
71 AcpiUtTrackAllocation (
72 ACPI_DEBUG_MEM_BLOCK *Address,
80 AcpiUtRemoveAllocation (
81 ACPI_DEBUG_MEM_BLOCK *Address,
87 /*******************************************************************************
89 * FUNCTION: AcpiUtCreateList
91 * PARAMETERS: CacheName - Ascii name for the cache
92 * ObjectSize - Size of each cached object
93 * ReturnCache - Where the new cache object is returned
97 * DESCRIPTION: Create a local memory list for tracking purposed
99 ******************************************************************************/
103 const char *ListName,
105 ACPI_MEMORY_LIST **ReturnCache)
107 ACPI_MEMORY_LIST *Cache;
110 Cache = AcpiOsAllocateZeroed (sizeof (ACPI_MEMORY_LIST));
113 return (AE_NO_MEMORY);
116 Cache->ListName = ListName;
117 Cache->ObjectSize = ObjectSize;
119 *ReturnCache = Cache;
124 /*******************************************************************************
126 * FUNCTION: AcpiUtAllocateAndTrack
128 * PARAMETERS: Size - Size of the allocation
129 * Component - Component type of caller
130 * Module - Source file name of caller
131 * Line - Line number of caller
133 * RETURN: Address of the allocated memory on success, NULL on failure.
135 * DESCRIPTION: The subsystem's equivalent of malloc.
137 ******************************************************************************/
140 AcpiUtAllocateAndTrack (
146 ACPI_DEBUG_MEM_BLOCK *Allocation;
150 /* Check for an inadvertent size of zero bytes */
154 ACPI_WARNING ((Module, Line,
155 "Attempt to allocate zero bytes, allocating 1 byte"));
159 Allocation = AcpiOsAllocate (Size + sizeof (ACPI_DEBUG_MEM_HEADER));
162 /* Report allocation error */
164 ACPI_WARNING ((Module, Line,
165 "Could not allocate size %u", (UINT32) Size));
170 Status = AcpiUtTrackAllocation (
171 Allocation, Size, ACPI_MEM_MALLOC, Component, Module, Line);
172 if (ACPI_FAILURE (Status))
174 AcpiOsFree (Allocation);
178 AcpiGbl_GlobalList->TotalAllocated++;
179 AcpiGbl_GlobalList->TotalSize += (UINT32) Size;
180 AcpiGbl_GlobalList->CurrentTotalSize += (UINT32) Size;
182 if (AcpiGbl_GlobalList->CurrentTotalSize >
183 AcpiGbl_GlobalList->MaxOccupied)
185 AcpiGbl_GlobalList->MaxOccupied =
186 AcpiGbl_GlobalList->CurrentTotalSize;
189 return ((void *) &Allocation->UserSpace);
193 /*******************************************************************************
195 * FUNCTION: AcpiUtAllocateZeroedAndTrack
197 * PARAMETERS: Size - Size of the allocation
198 * Component - Component type of caller
199 * Module - Source file name of caller
200 * Line - Line number of caller
202 * RETURN: Address of the allocated memory on success, NULL on failure.
204 * DESCRIPTION: Subsystem equivalent of calloc.
206 ******************************************************************************/
209 AcpiUtAllocateZeroedAndTrack (
215 ACPI_DEBUG_MEM_BLOCK *Allocation;
219 /* Check for an inadvertent size of zero bytes */
223 ACPI_WARNING ((Module, Line,
224 "Attempt to allocate zero bytes, allocating 1 byte"));
228 Allocation = AcpiOsAllocateZeroed (
229 Size + sizeof (ACPI_DEBUG_MEM_HEADER));
232 /* Report allocation error */
234 ACPI_ERROR ((Module, Line,
235 "Could not allocate size %u", (UINT32) Size));
239 Status = AcpiUtTrackAllocation (Allocation, Size,
240 ACPI_MEM_CALLOC, Component, Module, Line);
241 if (ACPI_FAILURE (Status))
243 AcpiOsFree (Allocation);
247 AcpiGbl_GlobalList->TotalAllocated++;
248 AcpiGbl_GlobalList->TotalSize += (UINT32) Size;
249 AcpiGbl_GlobalList->CurrentTotalSize += (UINT32) Size;
251 if (AcpiGbl_GlobalList->CurrentTotalSize >
252 AcpiGbl_GlobalList->MaxOccupied)
254 AcpiGbl_GlobalList->MaxOccupied =
255 AcpiGbl_GlobalList->CurrentTotalSize;
258 return ((void *) &Allocation->UserSpace);
262 /*******************************************************************************
264 * FUNCTION: AcpiUtFreeAndTrack
266 * PARAMETERS: Allocation - Address of the memory to deallocate
267 * Component - Component type of caller
268 * Module - Source file name of caller
269 * Line - Line number of caller
273 * DESCRIPTION: Frees the memory at Allocation
275 ******************************************************************************/
284 ACPI_DEBUG_MEM_BLOCK *DebugBlock;
288 ACPI_FUNCTION_TRACE_PTR (UtFree, Allocation);
291 if (NULL == Allocation)
293 ACPI_ERROR ((Module, Line,
294 "Attempt to delete a NULL address"));
299 DebugBlock = ACPI_CAST_PTR (ACPI_DEBUG_MEM_BLOCK,
300 (((char *) Allocation) - sizeof (ACPI_DEBUG_MEM_HEADER)));
302 AcpiGbl_GlobalList->TotalFreed++;
303 AcpiGbl_GlobalList->CurrentTotalSize -= DebugBlock->Size;
305 Status = AcpiUtRemoveAllocation (DebugBlock, Component, Module, Line);
306 if (ACPI_FAILURE (Status))
308 ACPI_EXCEPTION ((AE_INFO, Status, "Could not free memory"));
311 AcpiOsFree (DebugBlock);
312 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "%p freed (block %p)\n",
313 Allocation, DebugBlock));
318 /*******************************************************************************
320 * FUNCTION: AcpiUtFindAllocation
322 * PARAMETERS: Allocation - Address of allocated memory
324 * RETURN: Three cases:
325 * 1) List is empty, NULL is returned.
326 * 2) Element was found. Returns Allocation parameter.
327 * 3) Element was not found. Returns position where it should be
328 * inserted into the list.
330 * DESCRIPTION: Searches for an element in the global allocation tracking list.
331 * If the element is not found, returns the location within the
332 * list where the element should be inserted.
334 * Note: The list is ordered by larger-to-smaller addresses.
336 * This global list is used to detect memory leaks in ACPICA as
337 * well as other issues such as an attempt to release the same
338 * internal object more than once. Although expensive as far
339 * as cpu time, this list is much more helpful for finding these
340 * types of issues than using memory leak detectors outside of
343 ******************************************************************************/
345 static ACPI_DEBUG_MEM_BLOCK *
346 AcpiUtFindAllocation (
347 ACPI_DEBUG_MEM_BLOCK *Allocation)
349 ACPI_DEBUG_MEM_BLOCK *Element;
352 Element = AcpiGbl_GlobalList->ListHead;
359 * Search for the address.
361 * Note: List is ordered by larger-to-smaller addresses, on the
362 * assumption that a new allocation usually has a larger address
363 * than previous allocations.
365 while (Element > Allocation)
367 /* Check for end-of-list */
374 Element = Element->Next;
377 if (Element == Allocation)
382 return (Element->Previous);
386 /*******************************************************************************
388 * FUNCTION: AcpiUtTrackAllocation
390 * PARAMETERS: Allocation - Address of allocated memory
391 * Size - Size of the allocation
392 * AllocType - MEM_MALLOC or MEM_CALLOC
393 * Component - Component type of caller
394 * Module - Source file name of caller
395 * Line - Line number of caller
399 * DESCRIPTION: Inserts an element into the global allocation tracking list.
401 ******************************************************************************/
404 AcpiUtTrackAllocation (
405 ACPI_DEBUG_MEM_BLOCK *Allocation,
412 ACPI_MEMORY_LIST *MemList;
413 ACPI_DEBUG_MEM_BLOCK *Element;
414 ACPI_STATUS Status = AE_OK;
417 ACPI_FUNCTION_TRACE_PTR (UtTrackAllocation, Allocation);
420 if (AcpiGbl_DisableMemTracking)
422 return_ACPI_STATUS (AE_OK);
425 MemList = AcpiGbl_GlobalList;
426 Status = AcpiUtAcquireMutex (ACPI_MTX_MEMORY);
427 if (ACPI_FAILURE (Status))
429 return_ACPI_STATUS (Status);
433 * Search the global list for this address to make sure it is not
434 * already present. This will catch several kinds of problems.
436 Element = AcpiUtFindAllocation (Allocation);
437 if (Element == Allocation)
439 ACPI_ERROR ((AE_INFO,
440 "UtTrackAllocation: Allocation (%p) already present in global list!",
445 /* Fill in the instance data */
447 Allocation->Size = (UINT32) Size;
448 Allocation->AllocType = AllocType;
449 Allocation->Component = Component;
450 Allocation->Line = Line;
452 strncpy (Allocation->Module, Module, ACPI_MAX_MODULE_NAME);
453 Allocation->Module[ACPI_MAX_MODULE_NAME-1] = 0;
457 /* Insert at list head */
459 if (MemList->ListHead)
461 ((ACPI_DEBUG_MEM_BLOCK *)(MemList->ListHead))->Previous =
465 Allocation->Next = MemList->ListHead;
466 Allocation->Previous = NULL;
468 MemList->ListHead = Allocation;
472 /* Insert after element */
474 Allocation->Next = Element->Next;
475 Allocation->Previous = Element;
479 (Element->Next)->Previous = Allocation;
482 Element->Next = 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_NAME (UtRemoveAllocation);
521 if (AcpiGbl_DisableMemTracking)
526 MemList = AcpiGbl_GlobalList;
527 if (NULL == MemList->ListHead)
529 /* No allocations! */
531 ACPI_ERROR ((Module, Line,
532 "Empty allocation list, nothing to free!"));
537 Status = AcpiUtAcquireMutex (ACPI_MTX_MEMORY);
538 if (ACPI_FAILURE (Status))
545 if (Allocation->Previous)
547 (Allocation->Previous)->Next = Allocation->Next;
551 MemList->ListHead = Allocation->Next;
554 if (Allocation->Next)
556 (Allocation->Next)->Previous = Allocation->Previous;
559 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "Freeing %p, size 0%X\n",
560 &Allocation->UserSpace, Allocation->Size));
562 /* Mark the segment as deleted */
564 memset (&Allocation->UserSpace, 0xEA, Allocation->Size);
566 Status = AcpiUtReleaseMutex (ACPI_MTX_MEMORY);
571 /*******************************************************************************
573 * FUNCTION: AcpiUtDumpAllocationInfo
579 * DESCRIPTION: Print some info about the outstanding allocations.
581 ******************************************************************************/
584 AcpiUtDumpAllocationInfo (
588 ACPI_MEMORY_LIST *MemList;
591 ACPI_FUNCTION_TRACE (UtDumpAllocationInfo);
594 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
595 ("%30s: %4d (%3d Kb)\n", "Current allocations",
596 MemList->CurrentCount,
597 ROUND_UP_TO_1K (MemList->CurrentSize)));
599 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
600 ("%30s: %4d (%3d Kb)\n", "Max concurrent allocations",
601 MemList->MaxConcurrentCount,
602 ROUND_UP_TO_1K (MemList->MaxConcurrentSize)));
605 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
606 ("%30s: %4d (%3d Kb)\n", "Total (all) internal objects",
608 ROUND_UP_TO_1K (RunningObjectSize)));
610 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
611 ("%30s: %4d (%3d Kb)\n", "Total (all) allocations",
613 ROUND_UP_TO_1K (RunningAllocSize)));
616 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
617 ("%30s: %4d (%3d Kb)\n", "Current Nodes",
618 AcpiGbl_CurrentNodeCount,
619 ROUND_UP_TO_1K (AcpiGbl_CurrentNodeSize)));
621 ACPI_DEBUG_PRINT (TRACE_ALLOCATIONS | TRACE_TABLES,
622 ("%30s: %4d (%3d Kb)\n", "Max Nodes",
623 AcpiGbl_MaxConcurrentNodeCount,
624 ROUND_UP_TO_1K ((AcpiGbl_MaxConcurrentNodeCount *
625 sizeof (ACPI_NAMESPACE_NODE)))));
631 /*******************************************************************************
633 * FUNCTION: AcpiUtDumpAllocations
635 * PARAMETERS: Component - Component(s) to dump info for.
636 * Module - Module to dump info for. NULL means all.
640 * DESCRIPTION: Print a list of all outstanding allocations.
642 ******************************************************************************/
645 AcpiUtDumpAllocations (
649 ACPI_DEBUG_MEM_BLOCK *Element;
650 ACPI_DESCRIPTOR *Descriptor;
651 UINT32 NumOutstanding = 0;
652 UINT8 DescriptorType;
655 ACPI_FUNCTION_TRACE (UtDumpAllocations);
658 if (AcpiGbl_DisableMemTracking)
664 * Walk the allocation list.
666 if (ACPI_FAILURE (AcpiUtAcquireMutex (ACPI_MTX_MEMORY)))
671 Element = AcpiGbl_GlobalList->ListHead;
674 if ((Element->Component & Component) &&
675 ((Module == NULL) || (0 == strcmp (Module, Element->Module))))
677 Descriptor = ACPI_CAST_PTR (
678 ACPI_DESCRIPTOR, &Element->UserSpace);
680 if (Element->Size < sizeof (ACPI_COMMON_DESCRIPTOR))
682 AcpiOsPrintf ("%p Length 0x%04X %9.9s-%u "
683 "[Not a Descriptor - too small]\n",
684 Descriptor, Element->Size, Element->Module,
689 /* Ignore allocated objects that are in a cache */
691 if (ACPI_GET_DESCRIPTOR_TYPE (Descriptor) !=
692 ACPI_DESC_TYPE_CACHED)
694 AcpiOsPrintf ("%p Length 0x%04X %9.9s-%u [%s] ",
695 Descriptor, Element->Size, Element->Module,
696 Element->Line, AcpiUtGetDescriptorName (Descriptor));
698 /* Validate the descriptor type using Type field and length */
700 DescriptorType = 0; /* Not a valid descriptor type */
702 switch (ACPI_GET_DESCRIPTOR_TYPE (Descriptor))
704 case ACPI_DESC_TYPE_OPERAND:
706 if (Element->Size == sizeof (ACPI_OPERAND_OBJECT))
708 DescriptorType = ACPI_DESC_TYPE_OPERAND;
712 case ACPI_DESC_TYPE_PARSER:
714 if (Element->Size == sizeof (ACPI_PARSE_OBJECT))
716 DescriptorType = ACPI_DESC_TYPE_PARSER;
720 case ACPI_DESC_TYPE_NAMED:
722 if (Element->Size == sizeof (ACPI_NAMESPACE_NODE))
724 DescriptorType = ACPI_DESC_TYPE_NAMED;
733 /* Display additional info for the major descriptor types */
735 switch (DescriptorType)
737 case ACPI_DESC_TYPE_OPERAND:
739 AcpiOsPrintf ("%12.12s RefCount 0x%04X\n",
740 AcpiUtGetTypeName (Descriptor->Object.Common.Type),
741 Descriptor->Object.Common.ReferenceCount);
744 case ACPI_DESC_TYPE_PARSER:
746 AcpiOsPrintf ("AmlOpcode 0x%04hX\n",
747 Descriptor->Op.Asl.AmlOpcode);
750 case ACPI_DESC_TYPE_NAMED:
752 AcpiOsPrintf ("%4.4s\n",
753 AcpiUtGetNodeName (&Descriptor->Node));
758 AcpiOsPrintf ( "\n");
767 Element = Element->Next;
770 (void) AcpiUtReleaseMutex (ACPI_MTX_MEMORY);
776 ACPI_INFO (("No outstanding allocations"));
780 ACPI_ERROR ((AE_INFO, "%u(0x%X) Outstanding allocations",
781 NumOutstanding, NumOutstanding));
787 #endif /* ACPI_DBG_TRACK_ALLOCATIONS */