1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
* Copyright (c) 2026-present Eclipse ThreadX contributors
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** USBX Component */
/** */
/** Utility */
/** */
/**************************************************************************/
/**************************************************************************/
/* Include necessary system files. */
#define UX_SOURCE_CODE
#include "ux_api.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_utility_memory_free PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function frees a previously allocated memory block. */
/* */
/* INPUT */
/* */
/* memory Pointer to memory block */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* _ux_utility_mutex_on Start system protection */
/* _ux_utility_mutex_off End system protection */
/* */
/* CALLED BY */
/* */
/* USBX Components */
/* */
/**************************************************************************/
VOID _ux_utility_memory_free(VOID *memory)
{
UX_MEMORY_BYTE_POOL *pool_ptr;
UCHAR *work_ptr;
UCHAR *temp_ptr;
UCHAR *next_block_ptr;
ALIGN_TYPE *free_ptr;
UX_MEMORY_BYTE_POOL **byte_pool_ptr;
UCHAR **block_link_ptr;
#ifdef UX_ENABLE_MEMORY_POOL_SANITY_CHECK
UCHAR *memory_address;
UCHAR *regular_start, *regular_end;
UCHAR *cache_safe_start, *cache_safe_end;
#endif
#ifdef UX_ENABLE_MEMORY_STATISTICS
UINT index;
#endif
/* Get the mutex as this is a critical section. */
_ux_system_mutex_on(&_ux_system -> ux_system_mutex);
#ifdef UX_ENABLE_MEMORY_POOL_SANITY_CHECK
/* Sanity check, check if the memory is in memory pool. */
regular_start = (UCHAR *)_ux_system -> ux_system_memory_byte_pool[UX_MEMORY_BYTE_POOL_REGULAR] -> ux_byte_pool_start;
regular_end = regular_start + _ux_system -> ux_system_memory_byte_pool[UX_MEMORY_BYTE_POOL_REGULAR] -> ux_byte_pool_size;
regular_start += UX_MEMORY_BLOCK_HEADER_SIZE;
cache_safe_start = (UCHAR *)_ux_system -> ux_system_memory_byte_pool[UX_MEMORY_BYTE_POOL_CACHE_SAFE] -> ux_byte_pool_start;
cache_safe_end = cache_safe_start + _ux_system -> ux_system_memory_byte_pool[UX_MEMORY_BYTE_POOL_CACHE_SAFE] -> ux_byte_pool_size;
cache_safe_start += UX_MEMORY_BLOCK_HEADER_SIZE;
memory_address = (UCHAR *)memory;
if (!((memory_address >= regular_start && memory_address < regular_end) ||
(memory_address >= cache_safe_start && memory_address < cache_safe_end)))
{
/* Not valid. Release the protection. */
_ux_system_mutex_off(&_ux_system -> ux_system_mutex);
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD,
UX_SYSTEM_CONTEXT_UTILITY, UX_MEMORY_CORRUPTED);
/* No action taken. */
return;
}
#endif
/* Set the pool pointer to NULL. */
pool_ptr = UX_NULL;
/* Determine if the memory pointer is valid. */
work_ptr = UX_VOID_TO_UCHAR_POINTER_CONVERT(memory);
if (work_ptr != UX_NULL)
{
/* Back off the memory pointer to pickup its header. */
work_ptr = UX_UCHAR_POINTER_SUB(work_ptr, UX_MEMORY_BLOCK_HEADER_SIZE);
/* There is a pointer, pickup the pool pointer address. */
temp_ptr = UX_UCHAR_POINTER_ADD(work_ptr, (sizeof(UCHAR *)));
free_ptr = UX_UCHAR_TO_ALIGN_TYPE_POINTER_CONVERT(temp_ptr);
if ((*free_ptr) != UX_BYTE_BLOCK_FREE)
{
/* Pickup the pool pointer. */
temp_ptr = UX_UCHAR_POINTER_ADD(work_ptr, (sizeof(UCHAR *)));
byte_pool_ptr = UX_UCHAR_TO_INDIRECT_BYTE_POOL_POINTER(temp_ptr);
pool_ptr = *byte_pool_ptr;
/* See if we have a valid pool pointer. */
if ((pool_ptr == UX_NULL) ||
((pool_ptr != _ux_system -> ux_system_memory_byte_pool[UX_MEMORY_BYTE_POOL_REGULAR]) &&
(pool_ptr != _ux_system -> ux_system_memory_byte_pool[UX_MEMORY_BYTE_POOL_CACHE_SAFE])))
{
/* Release the protection. */
_ux_system_mutex_off(&_ux_system -> ux_system_mutex);
/* Error trap: maybe double free/memory issue here! */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD,
UX_SYSTEM_CONTEXT_UTILITY, UX_MEMORY_CORRUPTED);
/* Return to caller. */
return;
}
}
else
{
/* Release the protection. */
_ux_system_mutex_off(&_ux_system -> ux_system_mutex);
/* Error trap: maybe double free/memory issue here! */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD,
UX_SYSTEM_CONTEXT_UTILITY, UX_MEMORY_CORRUPTED);
/* Return to caller. */
return;
}
}
else
{
/* Release the protection. */
_ux_system_mutex_off(&_ux_system -> ux_system_mutex);
/* Error trap: maybe double free/bad flow here! */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD,
UX_SYSTEM_CONTEXT_UTILITY, UX_MEMORY_CORRUPTED);
/* Return to caller. */
return;
}
/* At this point, we know that the pool pointer is valid. */
/* Release the memory. */
temp_ptr = UX_UCHAR_POINTER_ADD(work_ptr, (sizeof(UCHAR *)));
free_ptr = UX_UCHAR_TO_ALIGN_TYPE_POINTER_CONVERT(temp_ptr);
*free_ptr = UX_BYTE_BLOCK_FREE;
/* Update the number of available bytes in the pool. */
block_link_ptr = UX_UCHAR_TO_INDIRECT_UCHAR_POINTER_CONVERT(work_ptr);
next_block_ptr = *block_link_ptr;
pool_ptr -> ux_byte_pool_available =
pool_ptr -> ux_byte_pool_available + UX_UCHAR_POINTER_DIF(next_block_ptr, work_ptr);
/* Determine if the free block is prior to current search pointer. */
if (work_ptr < (pool_ptr -> ux_byte_pool_search))
{
/* Yes, update the search pointer to the released block. */
pool_ptr -> ux_byte_pool_search = work_ptr;
}
#ifdef UX_ENABLE_MEMORY_STATISTICS
if (((UCHAR*)memory >= _ux_system -> ux_system_memory_byte_pool[UX_MEMORY_BYTE_POOL_REGULAR] -> ux_byte_pool_start) &&
((UCHAR*)memory < (_ux_system -> ux_system_memory_byte_pool[UX_MEMORY_BYTE_POOL_REGULAR] -> ux_byte_pool_start + _ux_system -> ux_system_memory_byte_pool[UX_MEMORY_BYTE_POOL_REGULAR] -> ux_byte_pool_size)))
index = UX_MEMORY_BYTE_POOL_REGULAR;
else
index = UX_MEMORY_BYTE_POOL_CACHE_SAFE;
_ux_system -> ux_system_memory_byte_pool[index] -> ux_byte_pool_alloc_count --;
_ux_system -> ux_system_memory_byte_pool[index] -> ux_byte_pool_alloc_total -= UX_UCHAR_POINTER_DIF(next_block_ptr, work_ptr);
#endif
/* Release the protection. */
_ux_system_mutex_off(&_ux_system -> ux_system_mutex);
/* Return to caller. */
return;
}
|
