Struct numa_gpu::runtime::nvtx::Range

pub struct Range { /* private fields */ }

A range denoting a time span.

A range denotes an arbitrary time span in a process. Each range can contain a text message or specify additional attributes.

A unique (opaque) correlation ID is created for each range. The correlation ID is annotated to the nvprof profiler output.

The official documentation is available in Nvidia’s Profiler User Guide.

Thread-safety

A range may be ended by a different thread than it is started by. Thus, a range is Send but not Sync, Copy or Clone. However, a pop must occur on the same thread as the push.

Examples

A range can be started and stopped at arbitrary points.

let message = unsafe { CStr::from_bytes_with_nul_unchecked(b"Hello World!\0") };
let range = Range::new(message);
// ...
let range_id = range.end();
println!("Range {} ended", range_id);

Alternatively, a ranges can be nested by pushing and popping them.

let message = unsafe { CStr::from_bytes_with_nul_unchecked(b"Hello World!\0") };
Range::push(&message).unwrap();
// ...
Range::pop().unwrap();

Implementations

impl Range

pub fn new(message: &CStr) -> Self

Start a process range.

The message is associated to this range event.

pub fn end(self) -> RangeId

End a process range.

pub fn id(&self) -> RangeId

Get the ID of a range.

pub fn push(message: &CStr) -> Result<u16>

Start a new nested process range.

The message is associated to this range event. The push returns the zero-based depth of the range being started.

pub fn pop() -> Result<u16>

Stop a nested range.

The pop returns the zero-based depth of the range being ended. A runtime error is returned if no range was pushed before the pop.

Trait Implementations

impl Debug for Range

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

Formats the value using the given formatter.