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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
#[cfg(feature = "cuda")]
use crate::cuda;
use crate::error::GPUError;
#[cfg(feature = "opencl")]
use crate::opencl;
/// Abstraction for running programs on CUDA or OpenCL.
pub enum Program {
/// CUDA program.
#[cfg(feature = "cuda")]
Cuda(cuda::Program),
/// OpenCL program.
#[cfg(feature = "opencl")]
Opencl(opencl::Program),
}
impl Program {
/// Run some code in the context of the program.
///
/// There is an implementation for OpenCL and for CUDA. Both use different Rust types, but
/// [`opencl::Program`] and [`cuda::Program`] implement the same API. This means that same
/// code code can be used to run on either of them. The only difference is the type of the
/// `Program`.
///
/// You need to pass in two closures, one for OpenCL, one for CUDA, both get their
/// corresponding program type as parameter. For convenience there is the [`program_closures`]
/// macro defined, which can help reducing code duplication by creating two closures out of
/// a single one.
///
/// CUDA and OpenCL support can be enabled/disabled by the `opencl` and `cuda` features. If
/// one of them is disabled, you still need to pass in two closures. This way the API stays,
/// the same, but you can disable it things at compile-time.
///
/// The second parameter is a single arbitrary argument, which will be passed on into the
/// closure. This is useful when you e.g. need to pass in a mutable reference. Such a reference
/// cannot be shared between closures, hence we pass it on, so that the compiler knows that it
/// is used at most once.
#[cfg(all(feature = "cuda", feature = "opencl"))]
pub fn run<F1, F2, R, E, A>(&self, fun: (F1, F2), arg: A) -> Result<R, E>
where
E: From<GPUError>,
F1: FnOnce(&cuda::Program, A) -> Result<R, E>,
F2: FnOnce(&opencl::Program, A) -> Result<R, E>,
{
match self {
Self::Cuda(program) => program.run(fun.0, arg),
Self::Opencl(program) => program.run(fun.1, arg),
}
}
/// Run some code in the context of the program.
///
/// There is an implementation for OpenCL and for CUDA. Both use different Rust types, but
/// [`opencl::Program`] and [`cuda::Program`] implement the same API. This means that same
/// code code can be used to run on either of them. The only difference is the type of the
/// `Program`.
///
/// You need to pass in two closures, one for OpenCL, one for CUDA, both get their
/// corresponding program type as parameter. For convenience there is the [`program_closures`]
/// macro defined, which can help reducing code duplication by creating two closures out of
/// a single one.
///
/// CUDA and OpenCL support can be enabled/disabled by the `opencl` and `cuda` features. If
/// one of them is disabled, you still need to pass in two closures. This way the API stays,
/// the same, but you can disable it things at compile-time.
///
/// The second parameter is a single arbitrary argument, which will be passed on into the
/// closure. This is useful when you e.g. need to pass in a mutable reference. Such a reference
/// cannot be shared between closures, hence we pass it on, so that the compiler knows that it
/// is used at most once.
#[cfg(all(feature = "cuda", not(feature = "opencl")))]
pub fn run<F1, F2, R, E, A>(&self, fun: (F1, F2), arg: A) -> Result<R, E>
where
E: From<GPUError>,
F1: FnOnce(&cuda::Program, A) -> Result<R, E>,
{
match self {
Self::Cuda(program) => program.run(fun.0, arg),
}
}
/// Run some code in the context of the program.
///
/// There is an implementation for OpenCL and for CUDA. Both use different Rust types, but
/// [`opencl::Program`] and [`cuda::Program`] implement the same API. This means that same
/// code code can be used to run on either of them. The only difference is the type of the
/// `Program`.
///
/// You need to pass in two closures, one for OpenCL, one for CUDA, both get their
/// corresponding program type as parameter. For convenience there is the [`define_closures`]
/// macro defined, which can help reducing code duplication by creating two closures out of
/// a single one.
///
/// CUDA and OpenCL support can be enabled/disabled by the `opencl` and `cuda` features. If
/// one of them is disabled, you still need to pass in two closures. This way the API stays,
/// the same, but you can disable it things at compile-time.
///
/// The second parameter is a single arbitrary argument, which will be passed on into the
/// closure. This is useful when you e.g. need to pass in a mutable reference. Such a reference
/// cannot be shared between closures, hence we pass it on, so that the compiler knows that it
/// is used at most once.
#[cfg(all(not(feature = "cuda"), feature = "opencl"))]
pub fn run<F1, F2, R, E, A>(&self, fun: (F1, F2), arg: A) -> Result<R, E>
where
E: From<GPUError>,
F2: FnOnce(&opencl::Program, A) -> Result<R, E>,
{
match self {
Self::Opencl(program) => program.run(fun.1, arg),
}
}
/// Returns the name of the GPU, e.g. "GeForce RTX 3090".
pub fn device_name(&self) -> &str {
match self {
#[cfg(feature = "cuda")]
Self::Cuda(program) => program.device_name(),
#[cfg(feature = "opencl")]
Self::Opencl(program) => program.device_name(),
}
}
}
/// Creates two closures, one for CUDA, one for OpenCL for the given one.
///
/// This macro is used to be able to interact with rust-gpu-tools with unified code for both,
/// CUDA and OpenCL, without the need to repeat the code. The input parameter is a `program` and
/// it will be mapped to &[`cuda::Program`] and &[`opencl::Program`].
///
/// The second parameter is a single arbitrary argument, which will be passed on into the closure.
/// This is useful when you e.g. need to pass in a mutable reference. Such a reference cannot be
/// shared between closures, hence we pass it on, so that the compiler knows that it is used at
/// most once.
///
/// Depending on whether the `cuda` and/or `opencl` feature is enabled, it will do the correct
/// thing and not specify one of them if it is appropriate.
///
/// ### Example
///
/// ```
/// use rust_gpu_tools::{cuda, opencl, program_closures};
///
/// let closures = program_closures!(|program, arg: u8| -> bool {
/// true
/// });
///
/// // Generates
/// let closures = (
/// |program: &cuda::Program, arg: u8| { true },
/// |program: &opencl::Program, arg: u8| { true },
/// );
///
/// // If e.g. the `cuda` feature is disabled, it would generate
/// let closures_without_cuda = (
/// (),
/// |program: &opencl::Program, arg: u8| { true },
/// );
/// ```
#[cfg(all(feature = "cuda", feature = "opencl"))]
#[macro_export]
macro_rules! program_closures {
// Additional argument without a type
(|$program:ident, $arg:ident| -> $ret:ty $body:block) => {
(
|$program: &$crate::cuda::Program, $arg| -> $ret { $body },
|$program: &$crate::opencl::Program, $arg| -> $ret { $body },
)
};
// Additional argument with a type
(|$program:ident, $arg:ident: $arg_type:ty| -> $ret:ty $body:block) => {
(
|$program: &$crate::cuda::Program, $arg: $arg_type| -> $ret { $body },
|$program: &$crate::opencl::Program, $arg: $arg_type| -> $ret { $body },
)
};
}
/// Creates two closures, one for CUDA, one for OpenCL for the given one.
///
/// This macro is used to be able to interact with rust-gpu-tools with unified code for both,
/// CUDA and OpenCL, without the need to repeat the code. The input parameter is a `program` and
/// it will be mapped to [`&cuda::Program`] and [`&opencl::Program`].
///
/// The second parameter is a single arbitrary argument, which will be passed on into the closure.
/// This is useful when you e.g. need to pass in a mutable reference. Such a reference cannot be
/// shared between closures, hence we pass it on, so that the compiler knows that it is used at
/// most once.
///
/// Depending on whether the `cuda` and/or `opencl` feature is enabled, it will do the correct
/// thing and not specify one of them if it is appropriate.
///
/// ### Example
///
/// ```
/// use rust_gpu_tools::{cuda, opencl, program_closures};
///
/// let closures = program_closures!(|program, arg: u8| -> bool {
/// true
/// });
///
/// // Generates
/// let closures = (
/// |program: &cuda::Program, arg: u8| { true },
/// |program: &opencl::Program, arg: u8| { true },
/// );
///
/// // If e.g. the `cuda` feature is disabled, it would generate
/// let closures_without_cuda = (
/// (),
/// |program: &opencl::Program, arg: u8| { true },
/// );
/// ```
#[macro_export]
#[cfg(all(feature = "cuda", not(feature = "opencl")))]
macro_rules! program_closures {
// Additional argument without a type
(|$program:ident, $arg:ident| -> $ret:ty $body:block) => {
(
|$program: &$crate::cuda::Program, $arg| -> $ret { $body },
(),
)
};
// Additional argument with a type
(|$program:ident, $arg:ident: $arg_type:ty| -> $ret:ty $body:block) => {
(
|$program: &$crate::cuda::Program, $arg: $arg_type| -> $ret { $body },
(),
)
};
}
/// Creates two closures, one for CUDA, one for OpenCL for the given one.
///
/// This macro is used to be able to interact with rust-gpu-tools with unified code for both,
/// CUDA and OpenCL, without the need to repeat the code. The input parameter is a `program` and
/// it will be mapped to [`&cuda::Program`] and [`&opencl::Program`].
///
/// The second parameter is a single arbitrary argument, which will be passed on into the closure.
/// This is useful when you e.g. need to pass in a mutable reference. Such a reference cannot be
/// shared between closures, hence we pass it on, so that the compiler knows that it is used at
/// most once.
///
/// Depending on whether the `cuda` and/or `opencl` feature is enabled, it will do the correct
/// thing and not specify one of them if it is appropriate.
///
/// ### Example
///
/// ```
/// use rust_gpu_tools::{cuda, opencl, program_closures};
///
/// let closures = program_closures!(|program, arg: u8| -> bool {
/// true
/// });
///
/// // Generates
/// let closures = (
/// |program: &cuda::Program, arg: u8| { true },
/// |program: &opencl::Program, arg: u8| { true },
/// );
///
/// // If e.g. the `cuda` feature is disabled, it would generate
/// let closures_without_cuda = (
/// (),
/// |program: &opencl::Program, arg: u8| { true },
/// );
/// ```
#[macro_export]
#[cfg(all(not(feature = "cuda"), feature = "opencl"))]
macro_rules! program_closures {
// Additional argument without a type
(|$program:ident, $arg:ident| -> $ret:ty $body:block) => {
((), |$program: &$crate::opencl::Program, $arg| -> $ret {
$body
})
};
// Additional argument with a type
(|$program:ident, $arg:ident: $arg_type:ty| -> $ret:ty $body:block) => {
(
(),
|$program: &$crate::opencl::Program, $arg: $arg_type| -> $ret { $body },
)
};
}