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

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

use core::marker::PhantomData;

/// User Defined Synchronization Object
pub struct UserSync<'a> {
    pub(super) handle: nvtx_sys::SyncUserHandle,
    pub(super) _lifetime: PhantomData<&'a ()>,
}

impl<'a> UserSync<'a> {
    /// Signal to tools that an attempt to acquire a user defined synchronization object.
    ///
    /// ```
    /// let d = nvtx::Domain::new(c"domain");
    /// let us = d.user_sync(c"custom object");
    /// // ...
    /// let started = us.acquire();
    /// ```
    #[must_use = "Dropping the return will violate the state machine"]
    pub fn acquire(self) -> UserSyncAcquireStart<'a> {
        nvtx_sys::domain_syncuser_acquire_start(self.handle);
        UserSyncAcquireStart { sync_object: self }
    }
}

impl Drop for UserSync<'_> {
    fn drop(&mut self) {
        nvtx_sys::domain_syncuser_destroy(self.handle);
    }
}

/// State modeling the start of acquiring the synchronization object.
pub struct UserSyncAcquireStart<'a> {
    sync_object: UserSync<'a>,
}

impl<'a> UserSyncAcquireStart<'a> {
    /// Signal to tools of failure in acquiring a user defined synchronization object.
    ///
    /// ```
    /// let d = nvtx::Domain::new(c"domain");
    /// let us = d.user_sync(c"custom object");
    /// // ...
    /// let started = us.acquire();
    /// // ...
    /// let us2 = started.failed();
    /// ```
    #[must_use = "Dropping the return will result in the Synchronization Object being destroyed"]
    pub fn failed(self) -> UserSync<'a> {
        nvtx_sys::domain_syncuser_acquire_failed(self.sync_object.handle);
        self.sync_object
    }

    /// Signal to tools of success in acquiring a user defined synchronization object.
    ///
    /// ```
    /// let d = nvtx::Domain::new(c"domain");
    /// let us = d.user_sync(c"custom object");
    /// // ...
    /// let started = us.acquire();
    /// // ...
    /// let success = started.success();
    /// ```
    #[must_use = "Dropping the return will violate the state machine"]
    pub fn success(self) -> UserSyncSuccess<'a> {
        nvtx_sys::domain_syncuser_acquire_success(self.sync_object.handle);
        UserSyncSuccess {
            sync_object: self.sync_object,
        }
    }
}

/// State modeling the success of acquiring the synchronization object.
pub struct UserSyncSuccess<'a> {
    sync_object: UserSync<'a>,
}

impl<'a> UserSyncSuccess<'a> {
    /// Signal to tools of releasing a reservation on user defined synchronization object.
    ///
    /// ```
    /// let d = nvtx::Domain::new(c"domain");
    /// let us = d.user_sync(c"custom object");
    /// // ...
    /// let started = us.acquire();
    /// // ...
    /// let success = started.success();
    /// // ...
    /// let us2 = success.release();
    /// ```
    #[must_use = "Dropping the return will result in the Synchronization Object being destroyed"]
    pub fn release(self) -> UserSync<'a> {
        nvtx_sys::domain_syncuser_acquire_releasing(self.sync_object.handle);
        self.sync_object
    }
}