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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

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

use super::Identifier;
use crate::TypeValueEncodable;

/// Identifiers used for Generic resources
pub enum GenericIdentifier {
    /// Generic pointer
    Pointer(*const core::ffi::c_void),
    /// Generic handle
    Handle(u64),
    /// Generic thread native
    NativeThread(u64),
    /// Generic thread posix
    PosixThread(u64),
}

impl From<GenericIdentifier> for Identifier {
    fn from(value: GenericIdentifier) -> Self {
        Self::Generic(value)
    }
}

impl TypeValueEncodable for GenericIdentifier {
    type Type = u32;
    type Value = nvtx_sys::ResourceAttributesIdentifier;

    fn encode(&self) -> (Self::Type, Self::Value) {
        match self {
            Self::Pointer(p) => (
                nvtx_sys::resource_type::GENERIC_POINTER,
                Self::Value { pValue: *p },
            ),
            Self::Handle(h) => (
                nvtx_sys::resource_type::GENERIC_HANDLE,
                Self::Value { ullValue: *h },
            ),
            Self::NativeThread(t) => (
                nvtx_sys::resource_type::GENERIC_THREAD_NATIVE,
                Self::Value { ullValue: *t },
            ),
            Self::PosixThread(t) => (
                nvtx_sys::resource_type::GENERIC_THREAD_POSIX,
                Self::Value { ullValue: *t },
            ),
        }
    }

    fn default_encoding() -> (Self::Type, Self::Value) {
        Identifier::default_encoding()
    }
}

#[cfg(all(test, feature = "std"))]
mod tests {

    use super::*;

    #[test]
    fn test_identifier_pointer() {
        let dummy = ();
        // CAST: Raw pointer retyping has no `From`; use pointer `.cast()` for this test value.
        let ptr = std::ptr::addr_of!(dummy).cast::<std::os::raw::c_void>();
        let x = GenericIdentifier::Pointer(ptr);
        let i = Identifier::from(x);
        assert!(matches!(i, Identifier::Generic(GenericIdentifier::Pointer(p)) if p == ptr));
    }

    #[test]
    fn test_identifier_handle() {
        let val = 0xDEADBEEF01234567_u64;
        let x = GenericIdentifier::Handle(val);
        let i = Identifier::from(x);
        assert!(matches!(i, Identifier::Generic(GenericIdentifier::Handle(v)) if v == val));
    }

    #[test]
    fn test_identifier_native_thread() {
        let val = 0xDEADBEEF01234567_u64;
        let x = GenericIdentifier::NativeThread(val);
        let i = Identifier::from(x);
        assert!(matches!(i, Identifier::Generic(GenericIdentifier::NativeThread(v)) if v == val));
    }

    #[test]
    fn test_identifier_posix_thread() {
        let val = 0xDEADBEEF01234567_u64;
        let x = GenericIdentifier::PosixThread(val);
        let i = Identifier::from(x);
        assert!(matches!(i, Identifier::Generic(GenericIdentifier::PosixThread(v)) if v == val));
    }

    #[test]
    fn test_encode_pointer() {
        let dummy = ();
        // CAST: Raw pointer retyping has no `From`; use pointer `.cast()` for this test value.
        let ptr = std::ptr::addr_of!(dummy).cast::<std::os::raw::c_void>();
        let x = GenericIdentifier::Pointer(ptr);
        let (t, v) = x.encode();
        assert_eq!(t, nvtx_sys::resource_type::GENERIC_POINTER);
        // SAFETY: The pointer resource type is asserted above, so reading `pValue` is valid.
        unsafe {
            assert!(matches!(v, nvtx_sys::ResourceAttributesIdentifier { pValue: p } if p == ptr));
        }
    }

    #[test]
    fn test_encode_handle() {
        let val = 0xDEADBEEF01234567_u64;
        let x = GenericIdentifier::Handle(val);
        let (t, v) = x.encode();
        assert_eq!(t, nvtx_sys::resource_type::GENERIC_HANDLE);
        // SAFETY: The handle resource type is asserted above, so reading `ullValue` is valid.
        unsafe {
            assert!(
                matches!(v, nvtx_sys::ResourceAttributesIdentifier { ullValue: v } if v == val)
            );
        }
    }

    #[test]
    fn test_encode_native_thread() {
        let val = 0xDEADBEEF01234567_u64;
        let x = GenericIdentifier::NativeThread(val);
        let (t, v) = x.encode();
        assert_eq!(t, nvtx_sys::resource_type::GENERIC_THREAD_NATIVE);
        // SAFETY: The native thread type is asserted above, so reading `ullValue` is valid.
        unsafe {
            assert!(
                matches!(v, nvtx_sys::ResourceAttributesIdentifier { ullValue: v } if v == val)
            );
        }
    }

    #[test]
    fn test_encode_posix_thread() {
        let val = 0xDEADBEEF01234567_u64;
        let x = GenericIdentifier::PosixThread(val);
        let (t, v) = x.encode();
        assert_eq!(t, nvtx_sys::resource_type::GENERIC_THREAD_POSIX);
        // SAFETY: The POSIX thread type is asserted above, so reading `ullValue` is valid.
        unsafe {
            assert!(
                matches!(v, nvtx_sys::ResourceAttributesIdentifier { ullValue: v } if v == val)
            );
        }
    }
}