Struct ActivitySession 

pub struct ActivitySession { /* private fields */ }

A host-side model of CUPTI’s asynchronous Activity buffer protocol.

The real flow is: the tool registers a requested callback (CUPTI calls it to obtain an empty buffer) and a completed callback (CUPTI calls it to hand back a full buffer for draining), enables one or more CuptiActivityKinds, runs GPU work (which fills buffers), then calls cuptiActivityFlushAll to force any partial buffer to be completed.

This struct reproduces that ownership dance deterministically: record fills the pending buffer, flush (and a full buffer) moves records into the completed queue which ActivitySession::drain empties — modelling the completed-buffer callback delivering records to the tool.

Implementations

impl ActivitySession

pub const DEFAULT_BUFFER_CAPACITY: usize = 256

Default per-buffer record capacity, echoing CUPTI’s habit of using a few-MB buffer that holds many fixed-size records.

pub fn new() -> Self

Create an idle session with no kinds enabled and no callbacks set.

pub fn with_buffer_capacity(buffer_capacity: usize) -> Self

Create a session with an explicit per-buffer record capacity.

pub fn register_callbacks(&mut self)

Model cuptiActivityRegisterCallbacks: install the buffer request / complete hooks. Idempotent.

pub fn callbacks_registered(&self) -> bool

Whether buffer callbacks have been registered.

pub fn enable( &mut self, kind: CuptiActivityKind, ) -> Result<(), CuptiActivityError>

Model cuptiActivityEnable(kind): turn a record kind on.

Errors

CuptiActivityError::CallbacksNotRegistered — CUPTI rejects enabling activity before buffer callbacks exist (there would be nowhere to put the records).

pub fn disable(&mut self, kind: CuptiActivityKind)

Model cuptiActivityDisable(kind): turn a record kind off.

pub fn is_enabled(&self, kind: CuptiActivityKind) -> bool

Whether the given kind is currently enabled.

pub fn enabled_kinds(&self) -> &[CuptiActivityKind]

The set of currently enabled kinds.

pub fn record( &mut self, record: ActivityRecord, ) -> Result<(), CuptiActivityError>

Emit one activity record into the pending buffer.

Models the GPU filling a buffer obtained from the requested callback. If the record’s kind is not enabled it is silently dropped (CUPTI does the same) and counted in ActivitySession::dropped_records.

Errors

• CuptiActivityError::CallbacksNotRegistered if no callbacks exist.
• CuptiActivityError::BufferFull if the pending buffer is already at capacity — the caller must ActivitySession::flush first.

pub fn flush(&mut self) -> Result<usize, CuptiActivityError>

Model cuptiActivityFlushAll: move every pending record into the completed queue, as CUPTI does when it hands a full / forced buffer to the completed callback. Returns the number of records flushed.

Errors

CuptiActivityError::CallbacksNotRegistered if no callbacks exist — cuptiActivityFlushAll is meaningless without a completed callback to deliver buffers to.

pub fn drain(&mut self) -> Vec<ActivityRecord>

Drain the completed queue, returning all records delivered to the tool since the last drain. Models the tool consuming the completed buffer.

pub fn pending_len(&self) -> usize

Number of records currently waiting in the (un-flushed) pending buffer.

pub fn completed_len(&self) -> usize

Number of records flushed and waiting to be drained.

pub fn dropped_records(&self) -> u64

Count of records dropped because their kind was disabled.

Trait Implementations

impl Debug for ActivitySession

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ActivitySession

fn default() -> Self

Returns the “default value” for a type.