#include <e32cmn.h>
| class RAllocator : public MAllocator |
| Protected Attributes | |
|---|---|
| TInt | iAccessCount |
| TInt | iCellCount |
| TUint32 | iFlags |
| TInt | iHandleCount |
| TInt * | iHandles |
| TInt | iTotalAllocSize |
| Public Member Enumerations | |
|---|---|
| enum | anonymous { EMaxHandles } |
| enum | TAllocDebugOp { ECount, EMarkStart, EMarkEnd, ECheck, ..., EAlignAddr } |
| enum | TAllocFail { ERandom, ETrueRandom, EDeterministic, ENone, ..., ECheckFailure } |
| enum | TDbgHeapType { EUser, EKernel } |
| enum | TExtension_Op { EAllocAligned } |
| enum | TFlags { ESingleThreaded, EFixedSize, ETraceAllocs, EMonitorMemory } |
| enum | TReAllocMode { ENeverMove, EAllowMoveOnShrink } |
| Public Member Functions | |
|---|---|
| RAllocator() | |
| UIMPORT_C TInt | Align(TInt) |
| UIMPORT_C TAny * | Align(TAny *) |
| UIMPORT_C TAny * | AllocAligned(TInt, TInt) |
| IMPORT_C TAny * | AllocL(TInt) |
| IMPORT_C TAny * | AllocLC(TInt) |
| IMPORT_C TAny * | AllocZ(TInt) |
| IMPORT_C TAny * | AllocZL(TInt) |
| UIMPORT_C TUint8 * | Base() |
| UIMPORT_C void | Check() |
| IMPORT_C void | Close() |
| IMPORT_C TInt | Count() |
| IMPORT_C TInt | Count(TInt &) |
| IMPORT_C void | FreeZ(TAny *&) |
| UIMPORT_C TInt | MaxLength() |
| IMPORT_C TInt | Open() |
| IMPORT_C TAny * | ReAllocL(TAny *, TInt, TInt) |
| UIMPORT_C TInt | Size() |
| UIMPORT_C TUint | __DbgCheckFailure() |
| UIMPORT_C TAllocFail | __DbgGetAllocFail() |
| UIMPORT_C TInt | __DbgMarkCheck(TBool, TInt, const TDesC8 &, TInt) |
| void | __DbgMarkCheck(TBool, TInt, const TUint8 *, TInt) |
| UIMPORT_C TUint32 | __DbgMarkEnd(TInt) |
| UIMPORT_C void | __DbgMarkStart() |
| UIMPORT_C void | __DbgSetAllocFail(TAllocFail, TInt) |
| UIMPORT_C void | __DbgSetBurstAllocFail(TAllocFail, TUint, TUint) |
| Protected Member Functions | |
|---|---|
| virtual IMPORT_C void | DoClose() |
| virtual UIMPORT_C TInt | Extension_(TUint, TAny *&, TAny *) |
Base class for heaps.
| TInt | iAccessCount | [protected] |
| TInt | iCellCount | [protected] |
| TUint32 | iFlags | [protected] |
| TInt | iHandleCount | [protected] |
| TInt * | iHandles | [protected] |
| TInt | iTotalAllocSize | [protected] |
| Enumerator | Value | Description |
|---|---|---|
| EMaxHandles | 32 |
| Enumerator | Value | Description |
|---|---|---|
| ECount | ||
| EMarkStart | ||
| EMarkEnd | ||
| ECheck | ||
| ESetFail | ||
| ECopyDebugInfo | ||
| ESetBurstFail | ||
| EGetFail | ||
| EGetSize | 48 | |
| EGetMaxLength | ||
| EGetBase | ||
| EAlignInteger | ||
| EAlignAddr |
A set of heap allocation failure flags.
This enumeration indicates how to simulate heap allocation failure.
See also: RAllocator::__DbgSetAllocFail()
| Enumerator | Value | Description |
|---|---|---|
| ERandom |
Attempts to allocate from this heap fail at a random rate; however, the interval pattern between failures is the same every time simulation is started. | |
| ETrueRandom |
Attempts to allocate from this heap fail at a random rate. The interval pattern between failures may be different every time the simulation is started. | |
| EDeterministic |
Attempts to allocate from this heap fail at a rate aRate; for example, if aRate is 3, allocation fails at every third attempt. | |
| ENone |
Cancels simulated heap allocation failure. | |
| EFailNext |
An allocation from this heap will fail after the next aRate - 1 allocation attempts. For example, if aRate = 1 then the next attempt to allocate from this heap will fail. | |
| EReset |
Cancels simulated heap allocation failure, and sets the nesting level for all allocated cells to zero. | |
| EBurstRandom |
aBurst allocations from this heap fail at a random rate; however, the interval pattern between failures is the same every time the simulation is started. | |
| EBurstTrueRandom |
aBurst allocations from this heap fail at a random rate. The interval pattern between failures may be different every time the simulation is started. | |
| EBurstDeterministic |
aBurst allocations from this heap fail at a rate aRate. For example, if aRate is 10 and aBurst is 2, then 2 allocations will fail at every tenth attempt. | |
| EBurstFailNext |
aBurst allocations from this heap will fail after the next aRate - 1 allocation attempts have occurred. For example, if aRate = 1 and aBurst = 3 then the next 3 attempts to allocate from this heap will fail. | |
| ECheckFailure |
Use this to determine how many times the current debug failure mode has failed so far. See also: RAllocator::__DbgCheckFailure() |
| Enumerator | Value | Description |
|---|---|---|
| EAllocAligned |
| Enumerator | Value | Description |
|---|---|---|
| ESingleThreaded | 1 | |
| EFixedSize | 2 | |
| ETraceAllocs | 4 | |
| EMonitorMemory | 8 |
Flags controlling reallocation.
| Enumerator | Value | Description |
|---|---|---|
| ENeverMove | 1 |
A reallocation of a cell must not change the start address of the cell. |
| EAllowMoveOnShrink | 2 |
Allows the start address of the cell to change if the cell shrinks in size. |
| RAllocator | ( | ) | [inline] |
Allocates a cell with specified size from heap which is aligned in accord with the alignment argument. The alignment argument should be a power of two. If the argument is not a power of two, the nearest greater power is used.
See also: KMaxTInt
| Parameters | |
|---|---|
| aAlignment | Alignment value or allocated cell |
| aSize | The size of the cell to be allocated from the heap |
| Panic Codes | |
|---|---|
| USER | 47 if the maximum unsigned value of aSize is greater than or equal to the value of KMaxTInt/2; for example, calling Alloc(-1) raises this panic. |
Allocates a cell of specified size from the heap, and leaves if there is insufficient memory in the heap.
The resulting size of the allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.
| Parameters | |
|---|---|
| aSize | The size of the cell to be allocated from the heap. |
| Panic Codes | |
|---|---|
| USER | 47 if the maximum unsigned value of aSize is greater than or equal to KMaxTInt/2. For example, calling Alloc(-1) raises this panic. |
Allocates a cell of specified size from the heap, and, if successful, places a pointer to the cell onto the cleanup stack.
The function leaves if there is insufficient memory in the heap.
The resulting size of the allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.
| Parameters | |
|---|---|
| aSize | The size of the cell to be allocated from the heap. |
| Panic Codes | |
|---|---|
| USER | 47 if the maximum unsigned value of aSize is greater than or equal to KMaxTInt/2. For example, calling Alloc(-1) raises this panic. |
Allocates a cell of specified size from the heap, and clears it to binary zeroes.
If there is insufficient memory available on the heap from which to allocate a cell of the required size, the function returns NULL.
The resulting size of the allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.
| Parameters | |
|---|---|
| aSize | The size of the cell to be allocated from the current thread's heap. |
| Panic Codes | |
|---|---|
| USER | 47 if the maximum unsigned value of aSize is greater than or equal to KMaxTInt/2. For example, calling Alloc(-1) raises this panic. |
Allocates a cell of specified size from the heap, clears it to binary zeroes, and leaves if there is insufficient memory in the heap.
The resulting size of the allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.
| Parameters | |
|---|---|
| aSize | The size of the cell to be allocated from the heap. |
| Panic Codes | |
|---|---|
| USER | 47 if the maximum unsigned value of aSize is greater than or equal to KMaxTInt/2. For example, calling Alloc(-1) raises this panic. |
| UIMPORT_C TUint8 * | Base | ( | ) | const |
Gets a pointer to the start of the heap.
Note that this function exists mainly for compatibility reasons. In a modern heap implementation such as that present in Symbian it is not appropriate to concern oneself with details such as the address of the start of the heap, as it is not as meaningful as it was in older heap implementations. In fact, the "base" might not even be the base of the heap at all!
In other words, you can call this but it's not guaranteed to point to the start of the heap (and in fact it never really was, even in legacy implementations).
| UIMPORT_C void | Check | ( | ) | const |
Checks the validity of the heap.
The function walks through the list of allocated cells and the list of free cells checking that this heap is consistent and complete.
| Panic Codes | |
|---|---|
| USER | 47 if any corruption is found, specifically a bad allocated heap cell size. |
| USER | 48 if any corruption is found, specifically a bad allocated heap cell address. |
| USER | 49 if any corruption is found, specifically a bad free heap cell address. |
| IMPORT_C void | Close | ( | ) |
Closes this shared heap.
Closing the heap decreases the heap's access count by one.
| Panic Codes | |
|---|---|
| USER | 57 if the access count has already reached zero. |
| IMPORT_C TInt | Count | ( | ) | const |
Gets the total number of cells allocated on the heap.
| IMPORT_C void | DoClose | ( | ) | [protected, virtual] |
Reimplemented from MAllocator::Extension_(TUint,TAny *&,TAny *)
| IMPORT_C void | FreeZ | ( | TAny *& | aCell | ) |
Frees the specified cell, returns it to the heap, and resets the pointer to NULL.
| Parameters | |
|---|---|
| aCell | A reference to a pointer to a valid cell to be freed. If NULL this function call will be ignored. |
| Panic Codes | |
|---|---|
| USER | 42 if aCell is not NULL and does not point to a valid cell. |
| IMPORT_C TInt | Open | ( | ) |
Opens this heap for shared access.
Opening the heap increases the heap's access count by one.
Increases or decreases the size of an existing cell, and leaves if there is insufficient memory in the heap.
If the cell is being decreased in size, then it is guaranteed not to move, and the function returns the pointer originally passed in aCell. Note that the length of the cell will be the same if the difference between the old size and the new size is smaller than the minimum cell size.
If the cell is being increased in size, i.e. aSize is bigger than its current size, then the function tries to grow the cell in place. If successful, then the function returns the pointer originally passed in aCell. If unsuccessful, then:
1. if the cell cannot be moved, i.e. aMode has the ENeverMove bit set, then the function leaves. 2. if the cell can be moved, i.e. aMode does not have the ENeverMove bit set, then the function tries to allocate a new replacement cell, and, if successful, returns a pointer to the new cell; if unsuccessful, it leaves.
Note that in debug mode, the function leaves if the cell cannot be grown in place, regardless of whether the ENeverMove bit is set.
If the reallocated cell is at a different location from the original cell, then the content of the original cell is copied to the reallocated cell.
Note the following general points:
1. If reallocation fails, the content of the original cell is preserved.
2. The resulting size of the re-allocated cell may be rounded up to a value greater than aSize, but is guaranteed to be not less than aSize.
See also: RAllocator::TReAllocMode
| Parameters | |
|---|---|
| aCell | A pointer to the cell to be reallocated. This may be NULL. |
| aSize | The new size of the cell. This may be bigger or smaller than the size of the original cell. |
| aMode | Flags controlling the reallocation. The only bit which has any effect on this function is that defined by the enumeration ENeverMove of the enum RAllocator::TReAllocMode. If this is set, then any successful reallocation guarantees not to have changed the start address of the cell. By default, this parameter is zero. |
| Panic Codes | |
|---|---|
| USER | 42, if aCell is not NULL, and does not point to a valid cell. |
| USER | 47, if the maximum unsigned value of aSize is greater than or equal to KMaxTInt/2. For example, calling ReAlloc(someptr,-1) raises this panic. |
| UIMPORT_C TInt | Size | ( | ) | const |
Gets the current size of the heap.
This is the total number of bytes committed by the host chunk, less the number of bytes used by the heap's metadata (the internal structures used for keeping track of allocated and free memory).
Size = (Rounded committed size - size of heap metadata).
| UIMPORT_C TUint | __DbgCheckFailure | ( | ) |
Returns the number of heap allocation failures the current debug allocator fail function has caused so far.
This is intended to only be used with fail types RAllocator::EFailNext, RAllocator::EBurstFailNext, RAllocator::EDeterministic and RAllocator::EBurstDeterministic. The return value is unreliable for all other fail types.
See also: RAllocator::TAllocFail
| UIMPORT_C TAllocFail | __DbgGetAllocFail | ( | ) |
Obtains the current heap failure simulation type.
After calling __DbgSetAllocFail(), this function may be called to retrieve the value set. This is useful primarily for test code that doesn't know if a heap has been set to fail and needs to check.
Checks the current number of allocated heap cells for this heap.
If aCountAll is true, the function checks that the total number of allocated cells on this heap is the same as aCount. If aCountAll is false, then the function checks that the number of allocated cells at the current nested level is the same as aCount.
If checking fails, the function raises a panic. Information about the failure is put into the panic category, which takes the form:
ALLOC: aaaabbbb
Where aaaa is the value aCount and bbbb is the number of allocated heap cells. Both values are in hexadecimal format. The panic number is 1.
| Parameters | |
|---|---|
| aCountAll | If true, the function checks that the total number of allocated cells on this heap is the same as aCount. If false, the function checks that the number of allocated cells at the current nested level is the same as aCount. |
| aCount | The expected number of allocated cells. |
| aFileName | A filename; this is not used |
| aLineNum | A line number; this is not used |
Marks the end of heap cell checking at the current nested level for this heap.
A call to this function should match an earlier call to __DbgMarkStart().
The function checks that the number of heap cells allocated, at the current nested level, is aCount. The most common value for aCount is zero, reflecting the fact that most developers check that all memory allocated since a previous call to __DbgMarkStart() has been freed.
If the check fails, the function returns a pointer to the first orphaned heap cell.
See also: RAllocator::__DbgMarkStart()
| Parameters | |
|---|---|
| aCount | The number of allocated heap cells expected. |
| UIMPORT_C void | __DbgMarkStart | ( | ) |
Marks the start of heap cell checking for this heap.
If earlier calls to __DbgMarkStart() have been made, then this call to __DbgMarkStart() marks the start of a new nested level of heap cell checking.
Every call to __DbgMarkStart() should be matched by a later call to __DbgMarkEnd() to verify that the number of heap cells allocated, at the current nested level, is as expected. This expected number of heap cells is passed to __DbgMarkEnd() as a parameter; however, the most common expected number is zero, reflecting the fact that most developers check that all memory allocated since a previous call to __DbgMarkStart() has been freed.
See also: RAllocator::__DbgMarkEnd()
| UIMPORT_C void | __DbgSetAllocFail | ( | TAllocFail | aType, |
| TInt | aRate | |||
| ) | ||||
Simulates a heap allocation failure for this heap.
The failure occurs on subsequent calls to new or any of the functions which allocate memory from this heap.
The timing of the allocation failure depends on the type of allocation failure requested, i.e. on the value of aType.
The simulation of heap allocation failure is cancelled if aType is given the value RAllocator::ENone.
Notes:
1. If the failure type is RAllocator::EFailNext, the next attempt to allocate from this heap fails; however, no further failures will occur.
2. For failure types RAllocator::EFailNext and RAllocator::ENone, set aRate to 1.
| Parameters | |
|---|---|
| aType | An enumeration which indicates how to simulate heap allocation failure. |
| aRate | The rate of failure; when aType is RAllocator::EDeterministic, heap allocation fails every aRate attempts |
| UIMPORT_C void | __DbgSetBurstAllocFail | ( | TAllocFail | aType, |
| TUint | aRate, | |||
| TUint | aBurst | |||
| ) | ||||
Simulates a burst of heap allocation failures for this heap.
The failure occurs for aBurst allocations attempt via subsequent calls to new or any of the functions which allocate memory from this heap.
The timing of the allocation failure depends on the type of allocation failure requested, i.e. on the value of aType.
The simulation of heap allocation failure is cancelled if aType is given the value RAllocator::ENone.
Notes:
1. If the failure type is RAllocator::EFailNext or RAllocator::EBurstFailNext, the next one or aBurst attempts to allocate from this heap will fail; however, no further failures will occur.
2. For failure types RAllocator::EFailNext and RAllocator::ENone, set aRate to 1.
See also: RAllocator::TAllocFail
| Parameters | |
|---|---|
| aType | An enumeration which indicates how to simulate heap allocation failure. |
| aRate | The rate of failure; when aType is RAllocator::EDeterministic, heap allocation fails every aRate attempts. |
| aBurst | The number of consecutive heap allocations that will fail each time the allocations should fail. |