Skip to main content

MemoryTracker

Struct MemoryTracker 

Source
pub struct MemoryTracker { /* private fields */ }
Expand description

Core memory tracking functionality.

The MemoryTracker maintains records of all memory allocations and deallocations, provides statistics, and supports exporting data in various formats.

§Performance Characteristics

  • DashMap: Lock-free concurrent access for allocations
  • Atomic counters: Lock-free statistics updates
  • Thread-local: Zero-contention for per-thread tracking

Implementations§

Source§

impl MemoryTracker

Source

pub fn new() -> Self

Create a new memory tracker.

Source

pub fn track_allocation(&self, ptr: usize, size: usize) -> TrackingResult<()>

Track a memory allocation.

§Arguments
  • ptr - Memory pointer address
  • size - Allocation size in bytes
Source

pub fn track_deallocation(&self, ptr: usize) -> TrackingResult<bool>

Track a memory deallocation.

§Arguments
  • ptr - Memory pointer address
§Returns
  • Ok(true) if the allocation was found and removed
  • Ok(false) if the pointer was not tracked (possible double-free or untracked allocation)
Source

pub fn get_allocation_size(&self, ptr: usize) -> Option<usize>

Get the size of an active allocation.

§Arguments
  • ptr - Memory pointer address
§Returns
  • Some(size) if the allocation exists
  • None if the pointer is not tracked
Source

pub fn associate_var( &self, ptr: usize, var_name: String, type_name: String, source_file: Option<&str>, source_line: Option<u32>, ) -> TrackingResult<()>

Associate a variable name and type with an allocation.

§Arguments
  • ptr - Memory pointer address
  • var_name - Variable name
  • type_name - Type name
  • source_file - Source file (optional)
  • source_line - Source line (optional)
Source

pub fn fast_track_allocation( &self, ptr: usize, size: usize, var_name: String, ) -> TrackingResult<()>

Fast track allocation with variable name.

§Arguments
  • ptr - Memory pointer address
  • size - Allocation size in bytes
  • var_name - Variable name
Source

pub fn get_stats(&self) -> TrackingResult<MemoryStats>

Get current memory statistics.

Source

pub fn detect_leaks(&self) -> (usize, u64)

Detect memory leaks at program shutdown.

This should be called when the program is shutting down to detect allocations that were never freed. Returns the count and total size of allocations that are still active.

Source

pub fn get_active_allocations(&self) -> TrackingResult<Vec<AllocationInfo>>

Get all currently active allocations.

Source

pub fn get_memory_by_type(&self) -> TrackingResult<HashMap<String, usize>>

Get memory grouped by type.

Source

pub fn set_fast_mode(&self, enabled: bool)

Enable or disable fast mode.

Source

pub fn is_fast_mode(&self) -> bool

Check if fast mode is enabled.

Source

pub fn enable_fast_mode(&self)

Enable fast mode for testing.

Source

pub fn ensure_memory_analysis_path<P: AsRef<Path>>(&self, path: P) -> PathBuf

Ensure memory analysis path exists and return the full path.

Source

pub fn ensure_memscope_path<P: AsRef<Path>>(&self, path: P) -> PathBuf

Ensure path uses .memscope extension and is in MemoryAnalysis directory.

Source

pub fn export_to_memscope<P: AsRef<Path>>(&self, path: P) -> TrackingResult<()>

Export memory tracking data to .memscope file format (JSON content).

This method exports memory tracking data with a .memscope file extension. The content is serialized as JSON for human readability and interoperability.

Source

pub fn export_to_json<P: AsRef<Path>>(&self, path: P) -> TrackingResult<()>

Export memory tracking data to JSON format.

Trait Implementations§

Source§

impl Default for MemoryTracker

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Drop for MemoryTracker

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more