nvtx 2.0.0

NVIDIA Tools Extension SDK
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

// SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

use core::marker::PhantomData;

use super::EventArgument;
use crate::Domain;

/// A RAII-like object for modeling process-wide Ranges within a Domain.
#[derive(Debug)]
pub struct Range<'a> {
    pub(super) id: Option<nvtx_sys::RangeId>,
    pub(super) domain: &'a Domain,
}

impl<'a> Range<'a> {
    pub(super) fn new(arg: impl Into<EventArgument<'a>>, domain: &'a Domain) -> Range<'a> {
        Range::new_from_arg_with_domain(arg, domain)
    }

    fn new_from_arg_with_domain(arg: impl Into<EventArgument<'a>>, domain: &'a Domain) -> Self {
        Range {
            id: Some(domain.range_start(arg)),
            domain,
        }
    }
}

impl Drop for Range<'_> {
    fn drop(&mut self) {
        if let Some(id) = self.id {
            self.domain.range_end(id);
        }
    }
}

/// A RAII-like object for modeling callstack (thread-local) Ranges within a Domain.
#[derive(Debug)]
pub struct LocalRange<'a> {
    pub(super) domain: &'a Domain,
    pub(super) active: bool,
    // prevent Sync + Send
    _phantom: PhantomData<*mut i32>,
}

impl<'a> LocalRange<'a> {
    pub(super) fn new(arg: impl Into<EventArgument<'a>>, domain: &'a Domain) -> LocalRange<'a> {
        let arg = match arg.into() {
            EventArgument::Attributes(attr) => attr,
            EventArgument::Message(m) => domain.event_attributes_builder().message(m).build(),
        };
        nvtx_sys::domain_range_push_ex(domain.handle, &arg.encode());
        LocalRange {
            domain,
            active: true,
            _phantom: PhantomData,
        }
    }
}

impl Drop for LocalRange<'_> {
    fn drop(&mut self) {
        if self.active {
            nvtx_sys::domain_range_pop(self.domain.handle);
        }
    }
}