-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMemory.cpp
More file actions
495 lines (366 loc) · 13.5 KB
/
Memory.cpp
File metadata and controls
495 lines (366 loc) · 13.5 KB
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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
/*
Copyright (C) 1998-2007 Emil Maskovsky
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
@file
Memory handling base (implementation).
@author Emil Maskovsky
*/
/* Framework libraries. */
/* Application specific. */
#include "mx/Memory.hpp"
#include "mx/internal/OutOfMem.hpp"
#ifdef Allocate
#undef Allocate
#endif
#ifdef Reallocate
#undef Reallocate
#endif
#ifdef Free
#undef Free
#endif
#ifdef malloc
#undef malloc
#endif
#ifdef calloc
#undef calloc
#endif
#ifdef realloc
#undef realloc
#endif
#ifdef free
#undef free
#endif
/**
@fn mx::Memory::Allocate(Size)
Allocate memory block.
Allocates a memory block of at least @p iSize bytes. The block may be larger
than @p iSize bytes because of space required for alignment and maintenance
information.
@param [in] iSize Number of bytes to allocate.
@note
In regular cases, you should use the new C++ style operators
@c new or @c new[] for dynamic allocation (and @c delete or @c delete[]
operators for de-allocation).
@return
The address of allocated memory block.
@retval NULL The return value is @c NULL, if the @p iSize is zero. If the
@p iSize is not zero and the allocation cannot be done because
of insufficient memory space, the MemoryException will be
caught.
@exception MemoryException
Memory allocation problem occured.
@see Memory::Reallocate(), Memory::Free()
@internal
@note
The Memory::Allocate() is in the fact "fake" method, which is not really
implemented, and with cooperation of the macro Allocate() it is remaped to
the Memory::AllocateImpl() method.
But we define this method to provide it along with the Memory interface, to
allow e.g. code completation when used.
@see Allocate(), Memory::AllocateImpl()
*/
/**
@fn mx::Memory::Reallocate(void *, Size)
Reallocate memory block.
Reallocates a memory block (@p pMemoryBlock) that was previously allocated by
a call to Memory::Allocate() or Memory::Reallocate().
@param [in] pMemoryBlock The address of previously allocated memory block.
@param [in] iSize New size in bytes.
@note
If the @p pMemoryBlock is @c NULL, Memory::Reallocate() behaves the same way
as Memory::Allocate() and allocates a new block of @p iSize bytes.
@note
If the @p pMemoryBlock is not @c NULL, it should be a pointer returned by
a previous call to Memory::Allocate() or Memory::Reallocate().
@warning
Do not ever try to reallocate pointer returned by Memory::AllocateOnStack()!
@warning
Attempting to reallocate an invalid pointer (a pointer to a memory block that
was not allocated by Memory::Allocate() or Memory::Reallocate()) may affect
subsequent allocation requests and cause errors.
@return
The address of reallocated (and possibly moved) memory block.
@retval NULL The return value is @c NULL, if the @p iSize is zero. In that
case the @p pMemoryBlock will be freed. If the @p iSize is not
zero and the allocation cannot be done because of insufficient
memory space, the MemoryException will be caught.
@exception MemoryException
Memory allocation problem occured.
@see Memory::Allocate(), Memory::Free()
@internal
@note
The Memory::Reallocate() is in the fact "fake" method, which is not really
implemented, and with cooperation of the macro Reallocate() it is remaped to
the Memory::ReallocateImpl() method.
But we define this method to provide it along with the Memory interface, to
allow e.g. code completation when used.
@see Reallocate(), Memory::ReallocateImpl()
*/
/**
@fn mx::Memory::Free(void *)
Free memory block.
Deallocates a memory block (@p pMemoryBlock) that was previously allocated by
a call to Memory::Allocate() or Memory::Reallocate(). The number of bytes
freed is equivalent to the number of bytes requested when the block was
allocated (or reallocated, in the case of Memory::Reallocate()).
@param [in] pMemoryBlock The address of allocated memory block to be freed.
@note
If @p pMemoryBlock is @c NULL, the pointer is ignored and Memory::Free()
returns immediately.
@note
If the @p pMemoryBlock is not @c NULL, it should be a pointer returned by
a previous call to Memory::Allocate() or Memory::Reallocate().
@warning
Do not ever try to free pointer returned by Memory::AllocateOnStack()!
@warning
Attempting to free an invalid pointer (a pointer to a memory block that
was not allocated by Memory::Allocate() or Memory::Reallocate()) may affect
subsequent allocation requests and cause errors.
@see Memory::Allocate(), Memory::Reallocate()
@internal
@note
The Memory::Free() is in the fact "fake" method, which is not really
implemented, and with cooperation of the macro Free() it is remaped to
the Memory::FreeImpl() method.
But we define this method to provide it along with the Memory interface, to
allow e.g. code completation when used.
@see Free(), Memory::FreeImpl()
*/
namespace mx
{
/**
Memory handler.
*/
class MemoryHandler
{
MX_CLASS_NO_COPY(MemoryHandler);
MX_CLASS_NO_ASSIGNMENT(MemoryHandler);
// Class methods (static).
public:
static void * Allocate(
const Size iSize,
const Debug::Checkpoint & xFileLocation = Debug::Checkpoint());
static void * Reallocate(
void * const pMemoryBlock,
const Size iSize,
const Debug::Checkpoint & xFileLocation = Debug::Checkpoint());
static void Free(
void * const pMemoryBlock,
const Debug::Checkpoint & xFileLocation = Debug::Checkpoint());
}; // class MemoryHandler
} // namespace mx
/**
@internal
Allocate memory block (the real worker).
This worker is used to provide extra debugging information to the memory
handling operations.
@param [in] iSize Number of bytes to allocate.
@param [in] xFileLocation Source file location information (for debugging
purposes).
@note
This method is not to be used directly, it is designed to work along with the
"fake" method Memory::Allocate() and the macro Allocate().
@return
See Memory::Allocate() for description of return values.
@see Memory::Allocate(), Allocate()
@see ReallocateImpl(), FreeImpl()
*/
/* static */ void * mx::Memory::AllocateImpl(
const Size iSize,
const Debug::Checkpoint & xFileLocation)
{
return MemoryHandler::Allocate(iSize, xFileLocation);
}
/**
@internal
Reallocate memory block (the real worker).
This worker is used to provide extra debugging information to the memory
handling operations.
@param [in] pMemoryBlock The address of previously allocated memory block.
@param [in] iSize New size in bytes.
@param [in] xFileLocation Source file location information (for debugging
purposes).
@note
This method is not to be used directly, it is designed to work along with the
"fake" method Memory::Reallocate() and the macro Reallocate().
@return
See Memory::Reallocate() for description of return values.
@see Memory::Reallocate(), Reallocate()
@see AllocateImpl(), FreeImpl()
*/
/* static */ void * mx::Memory::ReallocateImpl(
void * const pMemoryBlock,
const Size iSize,
const Debug::Checkpoint & xFileLocation)
{
return MemoryHandler::Reallocate(pMemoryBlock, iSize, xFileLocation);
}
/**
@internal
Free memory block (the real worker).
This worker is used to provide extra debugging information to the memory
handling operations.
@param [in] pMemoryBlock The address of allocated memory block to be freed.
@param [in] xFileLocation Source file location information (for debugging
purposes).
@note
This method is not to be used directly, it is designed to work along with the
"fake" method Memory::Free() and the macro Free().
@return
See Memory::Free() for description of return values.
@see Memory::Free(), Free()
@see AllocateImpl(), ReallocateImpl()
*/
/* static */ void mx::Memory::FreeImpl(
void * const pMemoryBlock,
const Debug::Checkpoint & xFileLocation)
{
MemoryHandler::Free(pMemoryBlock, xFileLocation);
}
/**
The real implementation of the global @c new operators.
@param [in] iSize Number of bytes to allocate.
@param [in] xFileInfo Source file location information (for debugging
purposes).
@param [in] bVector Allocated as vector (using the @c new[] operator).
*/
/* static */ void * mx::AllocOperatorsImplementation::New(
const Size iSize,
const Debug::Checkpoint & xFileInfo,
const bool MX_UNUSED(bVector))
{
return MemoryHandler::Allocate(iSize, xFileInfo);
}
/**
The real implementation of the global @c delete operators.
@param [in] pMemoryBlock The address of allocated memory block to be deleted.
@param [in] xFileInfo Source file location information (for debugging
purposes).
@param [in] bVector Deleted as vector (using the @c delete[] operator).
*/
/* static */ void mx::AllocOperatorsImplementation::Delete(
void * const pMemoryBlock,
const Debug::Checkpoint & xFileInfo,
const bool MX_UNUSED(bVector))
{
MemoryHandler::Free(pMemoryBlock, xFileInfo);
}
/**
The real implementation of the global @c delete operators.
@param [in] pMemoryBlock The address of allocated memory block to be deleted.
@param [in] bVector Deleted as vector (using the @c delete[] operator).
*/
/* static */ void mx::OperatorDeleteImplementation::Delete(
void * const pMemoryBlock,
const bool MX_UNUSED(bVector))
{
MemoryHandler::Free(pMemoryBlock);
}
/**
Allocate memory block.
@param [in] iSize Number of bytes to allocate.
@param [in] xFileLocation Source file location information (for debugging
purposes).
@return
See Memory::Allocate() for description of return values.
@see Memory::Allocate()
*/
/* static */ void * mx::MemoryHandler::Allocate(
const Size iSize,
const Debug::Checkpoint & xFileLocation)
{
if (!iSize)
{
// Warn about allocation of 0 bytes.
mx::Log(mx::Log::LOG_Trace, xFileLocation).LogTrace(
mx::Log::TRACE_Memory, mx::Log::LEVEL_Normal,
_("Requested allocation of 0 bytes!"));
return NULL;
}
void * const block = malloc(iSize);
if (!block)
{
ThrowException(OutOfMemory(iSize), xFileLocation);
}
return block;
}
/**
Reallocate memory block.
@param [in] pMemoryBlock The address of previously allocated memory block.
@param [in] iSize New size in bytes.
@param [in] xFileLocation Source file location information (for debugging
purposes).
@return
See Memory::Reallocate() for description of return values.
@see Memory::Reallocate()
*/
/* static */ void * mx::MemoryHandler::Reallocate(
void * const pMemoryBlock,
const Size iSize,
const Debug::Checkpoint & xFileLocation)
{
if (!pMemoryBlock)
{
// Warn about reallocation of NULL pointer.
mx::Log(mx::Log::LOG_Trace, xFileLocation).LogTrace(
mx::Log::TRACE_Memory, mx::Log::LEVEL_Normal,
_("Requested reallocation of NULL pointer!"));
}
if (!iSize)
{
// Warn about allocation of 0 bytes.
mx::Log(mx::Log::LOG_Trace, xFileLocation).LogTrace(
mx::Log::TRACE_Memory, mx::Log::LEVEL_Normal,
_("Requested allocation of 0 bytes!"));
if (pMemoryBlock)
{
// Avoid the message about freeing NULL pointer.
Free(pMemoryBlock, xFileLocation);
}
return NULL;
}
void * const block = realloc(pMemoryBlock, iSize);
if (!block)
{
ThrowException(OutOfMemory(iSize), xFileLocation);
}
return block;
}
/**
Free memory block.
@param [in] pMemoryBlock The address of allocated memory block to be freed.
@param [in] xFileLocation Source file location information (for debugging
purposes).
@return
See Memory::Free() for description of return values.
@see Memory::Free()
*/
/* static */ void mx::MemoryHandler::Free(
void * const pMemoryBlock,
const Debug::Checkpoint & xFileLocation)
{
if (!pMemoryBlock)
{
// Warn about de-allocation of NULL pointer.
mx::Log(mx::Log::LOG_Trace, xFileLocation).LogTrace(
mx::Log::TRACE_Memory, mx::Log::LEVEL_Normal,
_("Requested deallocation of NULL pointer!"));
}
free(pMemoryBlock);
}
// Define inline methods here if inlining is disabled.
#ifndef MX_INLINE_ENABLED
#include "mx/Memory.inl"
#endif
/* EOF */