cudarc 0.19.4

Safe and minimal CUDA bindings
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
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198

use std::mem::MaybeUninit;

use super::sys;

/// Wrapper around [sys::cusolverStatus_t]
#[derive(Clone, Copy, PartialEq, Eq, Debug)]
pub struct CusolverError(pub sys::cusolverStatus_t);

impl sys::cusolverStatus_t {
    pub fn result(self) -> Result<(), CusolverError> {
        match self {
            sys::cusolverStatus_t::CUSOLVER_STATUS_SUCCESS => Ok(()),
            _ => Err(CusolverError(self)),
        }
    }
}

#[cfg(feature = "std")]
impl std::fmt::Display for CusolverError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{self:?}")
    }
}

#[cfg(feature = "std")]
impl std::error::Error for CusolverError {}

/// See [cuda docs](https://docs.nvidia.com/cuda/cusolver/index.html#cusolverdncreate)
pub fn dn_create() -> Result<sys::cusolverDnHandle_t, CusolverError> {
    let mut handle = MaybeUninit::uninit();
    unsafe { sys::cusolverDnCreate(handle.as_mut_ptr()) }.result()?;
    Ok(unsafe { handle.assume_init() })
}

/// See [cuda docs](https://docs.nvidia.com/cuda/cusolver/index.html#cusolverdndestroy)
///
/// # Safety
/// Make sure `handle` has not already been freed
pub unsafe fn dn_destroy(handle: sys::cusolverDnHandle_t) -> Result<(), CusolverError> {
    sys::cusolverDnDestroy(handle).result()
}

/// See [cuda docs](https://docs.nvidia.com/cuda/cusolver/index.html#cusolverdnsetstream)
///
/// # Safety
/// Make sure `handle` and `stream` are valid (not destroyed)
pub unsafe fn dn_set_stream(
    handle: sys::cusolverDnHandle_t,
    stream: sys::cudaStream_t,
) -> Result<(), CusolverError> {
    sys::cusolverDnSetStream(handle, stream).result()
}

/// See [cuda docs](https://docs.nvidia.com/cuda/cusolver/index.html#cusolverdngetdeterministicmode)
///
/// # Safety
/// Make sure `handle` is valid (not destroyed)
#[cfg(any(
    feature = "cuda-12020",
    feature = "cuda-12030",
    feature = "cuda-12040",
    feature = "cuda-12050",
    feature = "cuda-12060",
    feature = "cuda-12080",
    feature = "cuda-12090",
    feature = "cuda-13000",
))]
pub unsafe fn dn_get_deterministic_mode(
    handle: sys::cusolverDnHandle_t,
) -> Result<sys::cusolverDeterministicMode_t, CusolverError> {
    let mut mode = MaybeUninit::uninit();
    sys::cusolverDnGetDeterministicMode(handle, mode.as_mut_ptr()).result()?;
    Ok(unsafe { mode.assume_init() })
}

/// See [cuda docs](https://docs.nvidia.com/cuda/cusolver/index.html#cusolverdnsetdeterministicmode)
///
/// # Safety
/// Make sure `handle` is valid (not destroyed)
#[cfg(any(
    feature = "cuda-12020",
    feature = "cuda-12030",
    feature = "cuda-12040",
    feature = "cuda-12050",
    feature = "cuda-12060",
    feature = "cuda-12080",
    feature = "cuda-12090",
    feature = "cuda-13000",
))]
pub unsafe fn dn_set_deterministic_mode(
    handle: sys::cusolverDnHandle_t,
    mode: sys::cusolverDeterministicMode_t,
) -> Result<(), CusolverError> {
    sys::cusolverDnSetDeterministicMode(handle, mode).result()
}

/// See [cuda docs](https://docs.nvidia.com/cuda/cusolver/index.html#cusolverdncreateparams)
pub fn dn_create_params() -> Result<sys::cusolverDnParams_t, CusolverError> {
    let mut params = MaybeUninit::uninit();
    unsafe { sys::cusolverDnCreateParams(params.as_mut_ptr()) }.result()?;
    Ok(unsafe { params.assume_init() })
}

/// See [cuda docs](https://docs.nvidia.com/cuda/cusolver/index.html#cusolverdnsetadvoptions)
///
/// # Safety
/// Make sure `params` is valid (not destroyed)
pub unsafe fn dn_set_adv_options(
    params: sys::cusolverDnParams_t,
    function: sys::cusolverDnFunction_t,
    algo: sys::cusolverAlgMode_t,
) -> Result<(), CusolverError> {
    sys::cusolverDnSetAdvOptions(params, function, algo).result()
}

/// See [cuda docs](https://docs.nvidia.com/cuda/cusolver/index.html#cusolverdndestroyparams)
///
/// # Safety
/// Make sure `params` is valid (not destroyed)
pub unsafe fn dn_destroy_params(params: sys::cusolverDnParams_t) -> Result<(), CusolverError> {
    sys::cusolverDnDestroyParams(params).result()
}

/// See [cuda docs](https://docs.nvidia.com/cuda/cusolver/index.html#cusolverspcreate)
pub fn sp_create() -> Result<sys::cusolverSpHandle_t, CusolverError> {
    let mut handle = MaybeUninit::uninit();
    unsafe { sys::cusolverSpCreate(handle.as_mut_ptr()) }.result()?;
    Ok(unsafe { handle.assume_init() })
}

/// See [cuda docs](https://docs.nvidia.com/cuda/cusolver/index.html#cusolverspdestroy)
///
/// # Safety
/// Make sure `handle` is valid (not destroyed)
pub unsafe fn sp_destroy(handle: sys::cusolverSpHandle_t) -> Result<(), CusolverError> {
    sys::cusolverSpDestroy(handle).result()
}

/// See [cuda docs](https://docs.nvidia.com/cuda/cusolver/index.html#cusolverspsetstream)
///
/// # Safety
/// Make sure `handle` and `stream` are valid (not destroyed)
pub unsafe fn sp_set_stream(
    handle: sys::cusolverSpHandle_t,
    stream: sys::cudaStream_t,
) -> Result<(), CusolverError> {
    sys::cusolverSpSetStream(handle, stream).result()
}

/// See [cuda docs](https://docs.nvidia.com/cuda/cusolver/index.html#cusolverrfcreate)
pub fn rf_create() -> Result<sys::cusolverRfHandle_t, CusolverError> {
    let mut handle = MaybeUninit::uninit();
    unsafe { sys::cusolverRfCreate(handle.as_mut_ptr()) }.result()?;
    Ok(unsafe { handle.assume_init() })
}

/// See [cuda docs](https://docs.nvidia.com/cuda/cusolver/index.html#cusolverrfdestroy)
///
/// # Safety
/// Make sure `handle` is valid (not destroyed)
pub unsafe fn rf_destroy(handle: sys::cusolverRfHandle_t) -> Result<(), CusolverError> {
    sys::cusolverRfDestroy(handle).result()
}

/// See [cuda docs](https://docs.nvidia.com/cuda/cusolver/index.html#cusolverrfsetmatrixformat)
pub unsafe fn rf_set_matrix_format(
    handle: sys::cusolverRfHandle_t,
    format: sys::cusolverRfMatrixFormat_t,
    diag: sys::cusolverRfUnitDiagonal_t,
) -> Result<(), CusolverError> {
    sys::cusolverRfSetMatrixFormat(handle, format, diag).result()
}

/// See [cuda docs](https://docs.nvidia.com/cuda/cusolver/index.html#cusolverrfsetnumericproperties)
pub unsafe fn rf_set_numeric_properties(
    handle: sys::cusolverRfHandle_t,
    zero: f64,
    boost: f64,
) -> Result<(), CusolverError> {
    sys::cusolverRfSetNumericProperties(handle, zero, boost).result()
}

/// See [cuda docs](https://docs.nvidia.com/cuda/cusolver/index.html#cusolverrfsetresetvaluesfastmode)
pub unsafe fn rf_set_reset_values_fast_mode(
    handle: sys::cusolverRfHandle_t,
    fast_mode: sys::cusolverRfResetValuesFastMode_t,
) -> Result<(), CusolverError> {
    sys::cusolverRfSetResetValuesFastMode(handle, fast_mode).result()
}

/// See [cuda docs](https://docs.nvidia.com/cuda/cusolver/index.html#cusolverrfsetalgs)
pub unsafe fn rf_set_algs(
    handle: sys::cusolverRfHandle_t,
    fact_alg: sys::cusolverRfFactorization_t,
    alg: sys::cusolverRfTriangularSolve_t,
) -> Result<(), CusolverError> {
    sys::cusolverRfSetAlgs(handle, fact_alg, alg).result()
}