singe-nvml 0.1.0-alpha.7

Safe Rust wrappers for NVIDIA Management Library (NVML), monitoring, MIG, and vGPU APIs.
Documentation 
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

#[allow(unused_imports)]
use crate::error::Status;

use std::{mem::ManuallyDrop, ops::Deref, ptr::read as ptr_read};

use singe_nvml_sys as sys;

use crate::{
    device::Device,
    error::Result,
    gpu_instance::GpuInstance,
    try_ffi,
    types::{ComputeInstanceInfo, ComputeInstancePlacement},
};

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[repr(transparent)]
pub struct ComputeInstance(sys::nvmlComputeInstance_t);

#[derive(Debug)]
pub struct OwnedComputeInstance(ComputeInstance);

impl ComputeInstance {
    pub const unsafe fn from_raw(handle: sys::nvmlComputeInstance_t) -> Self {
        Self(handle)
    }

    pub const fn as_raw(&self) -> sys::nvmlComputeInstance_t {
        self.0
    }

    pub const fn is_null(&self) -> bool {
        self.0.is_null()
    }

    /// Returns compute instance information.
    ///
    /// For Ampere or newer fully supported devices.
    /// Supported on Linux only.
    ///
    /// # Errors
    ///
    /// Returns an error if the handle or output arguments are rejected by NVML, if
    /// the current process does not have permission to query the instance, or if
    /// NVML has not been initialized.
    pub fn info(&self) -> Result<ComputeInstanceInfo> {
        let mut info = sys::nvmlComputeInstanceInfo_t::default();
        unsafe {
            try_ffi!(sys::nvmlComputeInstanceGetInfo_v2(self.0, &raw mut info))?;
        }
        Ok(info.into())
    }

    pub fn parent_device(&self) -> Result<Device> {
        Ok(self.info()?.device)
    }

    pub fn parent_gpu_instance(&self) -> Result<GpuInstance> {
        Ok(self.info()?.gpu_instance)
    }

    pub fn id(&self) -> Result<u32> {
        Ok(self.info()?.id)
    }

    pub fn profile_id(&self) -> Result<u32> {
        Ok(self.info()?.profile_id)
    }

    pub fn placement(&self) -> Result<ComputeInstancePlacement> {
        Ok(self.info()?.placement)
    }
}

impl OwnedComputeInstance {
    pub const unsafe fn from_raw(handle: sys::nvmlComputeInstance_t) -> Self {
        Self(ComputeInstance(handle))
    }

    pub const fn as_compute_instance(&self) -> &ComputeInstance {
        &self.0
    }

    pub fn into_inner(self) -> ComputeInstance {
        let this = ManuallyDrop::new(self);
        unsafe { ptr_read(&this.0) }
    }
}

impl Deref for OwnedComputeInstance {
    type Target = ComputeInstance;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl Drop for OwnedComputeInstance {
    fn drop(&mut self) {
        unsafe {
            let _ = sys::nvmlComputeInstanceDestroy(self.0.0);
        }
    }
}