|
Zen API
|
|
Zen API
|
Debug memory allocator; tracks allocations and can report leaks.
Inheritance diagram for kDebugAlloc:Public Member Functions | |
| kAlloc | kAlloc_App () |
| Gets the allocator that should normally be used by applications to request memory. More... | |
| kAlloc | kAlloc_Fallback (kAlloc alloc) |
| Returns the passed allocator, or if null, the App allocator. More... | |
| kStatus | kAlloc_Free (kAlloc alloc, void *mem) |
| Frees a block of memory. More... | |
| kStatus | kAlloc_FreeRef (kAlloc alloc, void *mem) |
| Frees a block of memory and sets the memory pointer to kNULL. More... | |
| kStatus | kAlloc_Get (kAlloc alloc, kSize size, void *mem) |
| Allocates a block of memory. More... | |
| kStatus | kAlloc_GetZero (kAlloc alloc, kSize size, void *mem) |
| Allocates a block of memory and zero-initializes the block. More... | |
| kAlloc | kAlloc_System () |
| Gets the system allocator. More... | |
| kSize | kDebugAlloc_Allocated (kDebugAlloc object) |
| Returns the total amount of memory that has been allocated and not yet freed. More... | |
| kStatus | kDebugAlloc_Allocations (kDebugAlloc object, k64u since, kArrayList *history, kAlloc alloc) |
| Gets a list of all outstanding memory allocations performed after the given checkpoint. More... | |
| k64u | kDebugAlloc_Checkpoint (kDebugAlloc object) |
| Returns a memory checkpoint value, used in conjunction with allocation logging functions. More... | |
| kStatus | kDebugAlloc_Clear (kDebugAlloc object) |
| Clears all outstanding allocations (resets allocator). More... | |
| kStatus | kDebugAlloc_Construct (kDebugAlloc *object, const kChar *name, kAlloc allocator) |
| Constructs a new kDebugAlloc allocator. More... | |
| kStatus | kDebugAlloc_DetectLeakedAssemblyObjects (kDebugAlloc object, k64u since, kAssembly assembly) |
| Makes note of outstanding allocations that appear to be objects associated with the specified assembly. More... | |
| kStatus | kDebugAlloc_DetectLeakedObjects (kDebugAlloc object, k64u since) |
| Makes note of outstanding allocations that appear to be objects from any currently-loaded assembly. More... | |
| kStatus | kDebugAlloc_LogAllocations (kDebugAlloc object, k64u since) |
| Logs all outstanding memory allocations performed after the given checkpoint (using kLogf). More... | |
| kStatus | kDebugAlloc_SetAllocListener (kDebugAlloc object, kCallbackFx function, kPointer receiver) |
| Registers a user-defined function that is called whenever a memory allocation occurs. More... | |
| kAlloc | kObject_Alloc (kObject object) |
| Gets the memory allocator associated with this object. More... | |
| kStatus | kObject_Clone (kObject *object, kObject source, kAlloc allocator) |
| Constructs a new object by copying an existing object, including any aggregated child elements. More... | |
| kStatus | kObject_Destroy (kObject object) |
| Destroys the object. More... | |
| kStatus | kObject_Dispose (kObject object) |
| Destroys the object and any aggregated child elements. More... | |
| kBool | kObject_Equals (kObject object, kObject other) |
| Determines whether the object is equal to another object. More... | |
| kSize | kObject_HashCode (kObject object) |
| Gets a hash code representing the state of this object. More... | |
| kBool | kObject_Is (kObject object, kType type) |
| Determines whether this object is an instance of the specified type. More... | |
| kBool | kObject_IsShared (kObject object) |
| Reports whether the object is currently shared (reference count greater than one). More... | |
| kStatus | kObject_SetPool (kObject object, kObjectPool pool) |
| Sets the object pool associated with this object. More... | |
| kStatus | kObject_Share (kObject object) |
| Increments the reference count associated with this object. More... | |
| kSize | kObject_Size (kObject object) |
| Estimates the memory consumed by this object, including any aggregated child elements. More... | |
| kType | kObject_Type (kObject object) |
| Returns the type of the object. More... | |
|
inherited |
Gets the allocator that should normally be used by applications to request memory.
The App alloctor is typically implemented by layering additional allocators on the System allocator (e.g., kPoolAlloc, kDebugAlloc).
Returns the passed allocator, or if null, the App allocator.
| alloc | Allocator. |
Frees a block of memory.
| alloc | Allocator object. |
| mem | Pointer to memory to be freed. |
Frees a block of memory and sets the memory pointer to kNULL.
| alloc | Allocator object. |
| mem | Pointer to pointer to memory to be freed. |
Allocates a block of memory.
| alloc | Allocator object. |
| size | Size of memory to be allocated. |
| mem | Receives pointer to allocated memory. |
Allocates a block of memory and zero-initializes the block.
| alloc | Allocator object. |
| size | Size of memory to be allocated. |
| mem | Receives pointer to allocated memory. |
|
inherited |
Gets the system allocator.
The System allocator is a kUserAlloc instance that allocates directly from main system memory.
For most purposes, the App allocator should be prefered to the System allocator. Use of the System allocator may be appropriate when the additional layers provided by the App allocator are undesirable.
| kSize kDebugAlloc_Allocated | ( | kDebugAlloc | object | ) |
Returns the total amount of memory that has been allocated and not yet freed.
| object | Memory allocator. |
| kStatus kDebugAlloc_Allocations | ( | kDebugAlloc | object, |
| k64u | since, | ||
| kArrayList * | history, | ||
| kAlloc | alloc | ||
| ) |
Gets a list of all outstanding memory allocations performed after the given checkpoint.
| object | Memory allocator. |
| since | Memory checkpoint (or zero for beginning). |
| history | Receives list of outstanding allocations. |
| alloc | Allocator for history list (or kNULL for default). |
| k64u kDebugAlloc_Checkpoint | ( | kDebugAlloc | object | ) |
Returns a memory checkpoint value, used in conjunction with allocation logging functions.
| object | Memory allocator. |
| kStatus kDebugAlloc_Clear | ( | kDebugAlloc | object | ) |
Clears all outstanding allocations (resets allocator).
| object | Memory allocator. |
| kStatus kDebugAlloc_Construct | ( | kDebugAlloc * | object, |
| const kChar * | name, | ||
| kAlloc | allocator | ||
| ) |
Constructs a new kDebugAlloc allocator.
| object | Receives the constructed kDebugAlloc object. |
| name | Descriptive name for this memory allocator. |
| allocator | Memory allocator to use for internal allocations (or kNULL for default). |
| kStatus kDebugAlloc_DetectLeakedAssemblyObjects | ( | kDebugAlloc | object, |
| k64u | since, | ||
| kAssembly | assembly | ||
| ) |
Makes note of outstanding allocations that appear to be objects associated with the specified assembly.
This function records information about outstanding allocations that appear to be objects, for later use when logging leak information.
| object | Memory allocator. |
| since | Memory checkpoint (or zero for beginning). |
| assembly | Assembly associated with objects. |
| kStatus kDebugAlloc_DetectLeakedObjects | ( | kDebugAlloc | object, |
| k64u | since | ||
| ) |
Makes note of outstanding allocations that appear to be objects from any currently-loaded assembly.
This function records information about outstanding allocations that appear to be objects, for later use when logging leak information.
| object | Memory allocator. |
| since | Memory checkpoint (or zero for beginning). |
| kStatus kDebugAlloc_LogAllocations | ( | kDebugAlloc | object, |
| k64u | since | ||
| ) |
Logs all outstanding memory allocations performed after the given checkpoint (using kLogf).
| object | Memory allocator. |
| since | Memory checkpoint (or zero for beginning). |
| kStatus kDebugAlloc_SetAllocListener | ( | kDebugAlloc | object, |
| kCallbackFx | function, | ||
| kPointer | receiver | ||
| ) |
Registers a user-defined function that is called whenever a memory allocation occurs.
The args parameter of the callback will receive a pointer to a kDebugAllocation structure representing the memory allocation.
| object | Memory allocator. |
| function | Callback function. |
| receiver | Callback receiver. |
Gets the memory allocator associated with this object.
Most objects are constructed with an allocator, which is used to allocate the memory required by the object. Objects retain a reference to this allocator to enable further allocations and to free memory when the object is destroyed.
| object | Object. |
Constructs a new object by copying an existing object, including any aggregated child elements.
If the source object is an object collection (e.g. kArrayList<kString>), any aggregated child objects are also cloned. In this case, the kObject_Dispose method can be used to free the cloned collection and its associated elements.
This method will fail if the source object (or an aggregated child element) does not support cloning.
| object | Receives the constructed object. |
| source | Source object. |
| allocator | Memory allocator (or kNULL for default). |
Destroys the object.
The kObject_Destroy method destroys the object itself and any resources that are owned by the object. See Object Destruction for more information.
When an object is destroyed (or disposed), its reference count is decremented. The object is only truly destroyed when the reference count reaches zero. See Reference Counting for more information.
| object | Object (or kNULL). |
Destroys the object and any aggregated child elements.
The kObject_Dispose method destroys the object itself, any resources that are owned by the object, and if the object represents a collection of objects, any child objects in the collection. See Object Destruction for more information.
When an object is destroyed (or disposed), its reference count is decremented. The object is only truly destroyed when the reference count reaches zero. See Reference Counting for more information.
| object | Object (or kNULL). |
Determines whether the object is equal to another object.
By default, objects are compared by reference; objects are considered equal if the given handles refer to the same object instance. However, some classes override the Equals method to provide a more meaningful comparison (e.g. kString).
| object | Object. |
| other | Object for comparison. |
Gets a hash code representing the state of this object.
By default, objects return a hash code based on the object handle value. However, some classes override the HashCode method to provide a more useful hash (e.g. kString).
| object | Object. |
Determines whether this object is an instance of the specified type.
This function compares the type of this object with the given type. An object is considered to be an instance of a given type if a) the type represents a class and this object inherits from (or instantiates) that class, or b) the type represents an interface and this object implements the interface.
| object | Object. |
| type | Type. |
Reports whether the object is currently shared (reference count greater than one).
Objects are initialized with a reference count of one. The kObject_Share method can be used to increment the reference count. The kObject_Destroy and kObject_Dispose methods decrease the reference count, and when the reference count reaches zero, the object is actually destroyed/disposed.
This method can be used to determine if the reference count of an object is currently greater than one.
This method is thread-safe.
| object | Object. |
|
inherited |
Sets the object pool associated with this object.
Object pools can be used to implement custom lifecycle management. If an object has an assigned pool, then the kObjectPool_Reclaim method will be called just prior to destruction, to provide an opportunity for the object to be reclaimed.
| object | Object. |
| pool | Pool object (or kNULL to clear the pool assignment). |
Increments the reference count associated with this object.
This method is thread-safe.
| object | Object. |
Estimates the memory consumed by this object, including any aggregated child elements.
This method can be optionally overridden by kObject-derived classes to report the amount of memory consumed by an object. The default implementation reports only the size of the class instance (additional allocations performed by the class are excluded).
| object | Object. |
Returns the type of the object.
Each object is an instance of a specific class type. The type handle returned by this function can be used to learn about the class.
| object | Object. |
