AM261x MCU+ SDK: HeapP.h Source File

| AM261x MCU+ SDK 26.00.00 |

HeapP.h
Go to the documentation of this file.
1 /*
2 * Copyright (C) 2018-2021 Texas Instruments Incorporated
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the
14 * distribution.
15 *
16 * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 #ifndef HEAPP_H
34 #define HEAPP_H
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 #include <stdint.h>
41 #include <kernel/dpl/SystemP.h>
42 #if !defined(__ICCARM__)
43 #include <sys/types.h>
44 #endif
45
56 #define HeapP_BYTE_ALIGNMENT (64u)
57
61 typedef struct HeapP_MemStats_
62 {
63 size_t availableHeapSpaceInBytes;
64 size_t sizeOfLargestFreeBlockInBytes;
65 size_t sizeOfSmallestFreeBlockInBytes;
66 size_t numberOfFreeBlocks;
67 size_t minimumEverFreeBytesRemaining;
68 size_t numberOfSuccessfulAllocations;
69 size_t numberOfSuccessfulFrees;
70 } HeapP_MemStats;
71
75 typedef struct HEAP_BLOCK_LINK
76 {
77 struct HEAP_BLOCK_LINK * pxNextFreeBlock; /* The next free block in the list. */
78 size_t xBlockSize; /* The size of the free block. */
79 } HeapBlockLink_t;
80
84 typedef struct StaticHeap_ {
85
86 /* Create a couple of list links to mark the start and end of the list. */
87 HeapBlockLink_t xStart;
88 HeapBlockLink_t *pxEnd;
89
90 /* Keeps track of the number of calls to allocate and free memory as well as the
91 * number of free bytes remaining, but says nothing about fragmentation. */
92 size_t xFreeBytesRemaining;
93 size_t xMinimumEverFreeBytesRemaining;
94 size_t xNumberOfSuccessfulAllocations;
95 size_t xNumberOfSuccessfulFrees;
96
97 /* Gets set to the top bit of an size_t type. When this bit in the xBlockSize
98 * member of an HeapBlockLink_t structure is set then the block belongs to the
99 * application. When the bit is free the block is still part of the free heap
100 * space. */
101 size_t xBlockAllocatedBit;
102
103 /* base address and size of heap */
104 void *pvHeap;
105 size_t xTotalHeapSize;
106
107 } StaticHeap_t;
108
113 #if defined (OS_FREERTOS) || defined (OS_FREERTOS_SMP) || defined (OS_FREERTOS_MPU)
114
115 #include <FreeRTOS.h>
116 #include <semphr.h>
117
118 typedef struct HeapP_Object_ {
119
120 StaticHeap_t heapHndl;
121 StaticSemaphore_t heapMutexObj;
122 SemaphoreHandle_t heapMutexHndl;
123
124 } HeapP_Object;
125
126 #else
127
128 typedef struct HeapP_Object_ {
129
130 StaticHeap_t heapHndl;
131
132 } HeapP_Object;
133
134 #endif
135
136
149 int32_t HeapP_construct( HeapP_Object *heapObj, void *heapAddr, size_t heapSize );
150
156 void HeapP_destruct( HeapP_Object *heapObj);
157
167 void* HeapP_alloc( HeapP_Object *heapObj, size_t allocSize );
168
177 int32_t HeapP_free( HeapP_Object *heapObj, void * ptr );
178
186 size_t HeapP_getFreeHeapSize( HeapP_Object *heapObj );
187
195 size_t HeapP_getMinimumEverFreeHeapSize( HeapP_Object *heapObj );
196
205 int32_t HeapP_getHeapStats( HeapP_Object *heapObj, HeapP_MemStats * pHeapStats );
206
209 #ifdef __cplusplus
210 }
211 #endif
212
213 #endif /* HEAPP_H */
HeapP_alloc
void * HeapP_alloc(HeapP_Object *heapObj, size_t allocSize)
Alloc memory from user defined heap.
HeapP_destruct
void HeapP_destruct(HeapP_Object *heapObj)
Delete the user defined heap.
HeapP_Object::heapHndl
StaticHeap_t heapHndl
Definition: HeapP.h:130
SystemP.h
HeapP_getHeapStats
int32_t HeapP_getHeapStats(HeapP_Object *heapObj, HeapP_MemStats *pHeapStats)
Get detailed heap statistics.
StaticHeap_t::pvHeap
void * pvHeap
Definition: HeapP.h:104
HeapP_getMinimumEverFreeHeapSize
size_t HeapP_getMinimumEverFreeHeapSize(HeapP_Object *heapObj)
Get lowest ever free heap size, in bytes.
StaticHeap_t::xTotalHeapSize
size_t xTotalHeapSize
Definition: HeapP.h:105
HeapBlockLink_t::xBlockSize
size_t xBlockSize
Definition: HeapP.h:78
HeapP_MemStats::minimumEverFreeBytesRemaining
size_t minimumEverFreeBytesRemaining
Definition: HeapP.h:67
HeapP_MemStats::numberOfFreeBlocks
size_t numberOfFreeBlocks
Definition: HeapP.h:66
HeapP_MemStats::sizeOfLargestFreeBlockInBytes
size_t sizeOfLargestFreeBlockInBytes
Definition: HeapP.h:64
StaticHeap_t
Static heap instance structure.
Definition: HeapP.h:84
HeapP_getFreeHeapSize
size_t HeapP_getFreeHeapSize(HeapP_Object *heapObj)
Get free heap size, in bytes.
StaticHeap_t::xNumberOfSuccessfulAllocations
size_t xNumberOfSuccessfulAllocations
Definition: HeapP.h:94
HeapP_MemStats::sizeOfSmallestFreeBlockInBytes
size_t sizeOfSmallestFreeBlockInBytes
Definition: HeapP.h:65
StaticHeap_t::xFreeBytesRemaining
size_t xFreeBytesRemaining
Definition: HeapP.h:92
StaticHeap_t::xStart
HeapBlockLink_t xStart
Definition: HeapP.h:87
HeapBlockLink_t
The linked list structure is used to link free blocks in order of their memory address.
Definition: HeapP.h:76
HeapP_MemStats::numberOfSuccessfulFrees
size_t numberOfSuccessfulFrees
Definition: HeapP.h:69
HeapBlockLink_t::pxNextFreeBlock
struct HEAP_BLOCK_LINK * pxNextFreeBlock
Definition: HeapP.h:77
HeapP_MemStats::availableHeapSpaceInBytes
size_t availableHeapSpaceInBytes
Definition: HeapP.h:63
HeapP_free
int32_t HeapP_free(HeapP_Object *heapObj, void *ptr)
Free memory from user defined heap.
StaticHeap_t::xNumberOfSuccessfulFrees
size_t xNumberOfSuccessfulFrees
Definition: HeapP.h:95
StaticHeap_t::xBlockAllocatedBit
size_t xBlockAllocatedBit
Definition: HeapP.h:101
HeapP_MemStats
Structure used to pass information about the heap out of HeapP_getHeapStats().
Definition: HeapP.h:62
StaticHeap_t::pxEnd
HeapBlockLink_t * pxEnd
Definition: HeapP.h:88
StaticHeap_t::xMinimumEverFreeBytesRemaining
size_t xMinimumEverFreeBytesRemaining
Definition: HeapP.h:93
HeapP_MemStats::numberOfSuccessfulAllocations
size_t numberOfSuccessfulAllocations
Definition: HeapP.h:68
HeapP_construct
int32_t HeapP_construct(HeapP_Object *heapObj, void *heapAddr, size_t heapSize)
Create a user defined heap.
HeapP_Object
Opaque heap object used with the heap APIs.
Definition: HeapP.h:128