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
//! parallel statement related code
//!
//! This module contains code used for the implementation of parallel statements, e.g.
//! `parallel_for`, a Kokkos specific implementation of commonly used patterns.
//!
//! Parameters of aforementionned statements are defined in the [`parameters`] sub-module.
//!
//! Dispatch code is defined in the [`dispatch`] sub-module.
//!
//! Currently implemented statements:
//!
//! - `parallel_for`
pub mod dispatch;
pub mod parameters;
use std::fmt::Display;
use crate::functor::KernelArgs;
use self::{dispatch::DispatchError, parameters::ExecutionPolicy};
// Enums
/// Enum used to classify possible errors occuring in a parallel statement.
#[derive(Debug)]
pub enum StatementError {
/// Error occured during dispatch; The specific [DispatchError] is
/// used as the internal value of this variant.
Dispatch(DispatchError),
/// Error raised when parallel hierarchy isn't respected.
InconsistentDepth,
/// What did I mean by this?
InconsistentExecSpace,
}
impl From<DispatchError> for StatementError {
fn from(e: DispatchError) -> Self {
StatementError::Dispatch(e)
}
}
impl Display for StatementError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
StatementError::Dispatch(e) => write!(f, "{}", e),
StatementError::InconsistentDepth => {
write!(f, "inconsistent depth & range policy association")
}
StatementError::InconsistentExecSpace => {
write!(f, "?")
}
}
}
}
impl std::error::Error for StatementError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match self {
StatementError::Dispatch(e) => Some(e),
StatementError::InconsistentDepth => None,
StatementError::InconsistentExecSpace => None,
}
}
}
// Statements
// All of this would be half as long if impl trait in type aliases was stabilized
cfg_if::cfg_if! {
if #[cfg(feature = "threads")] {
/// Parallel For statement.
///
/// **Current version**: `threads`
///
/// ### Example
///
/// ```rust
/// use poc_kokkos_rs::{
/// functor::KernelArgs,
/// routines::{
/// parallel_for,
/// parameters::{ExecutionPolicy, ExecutionSpace, RangePolicy, Schedule},
/// },
/// };
///
/// let length: usize = 8;
///
/// let kern = |arg: KernelArgs<1>| match arg {
/// KernelArgs::Index1D(i) => {
/// // body of the kernel
/// println!("Hello from iteration {i}")
/// },
/// KernelArgs::IndexND(_) => unimplemented!(),
/// KernelArgs::Handle => unimplemented!(),
/// };
///
/// let execp = ExecutionPolicy {
/// space: ExecutionSpace::DeviceCPU,
/// range: RangePolicy::RangePolicy(0..length),
/// schedule: Schedule::Static,
/// };
///
/// parallel_for(execp, kern).unwrap();
/// ```
pub fn parallel_for<const N: usize>(
execp: ExecutionPolicy<N>,
func: impl Fn(KernelArgs<N>) + Send + Sync + Clone,
) -> Result<(), StatementError> {
// checks...
// data prep?
let kernel = Box::new(func);
// dispatch
let res = match execp.space {
parameters::ExecutionSpace::Serial => dispatch::serial(execp, kernel),
parameters::ExecutionSpace::DeviceCPU => dispatch::cpu(execp, kernel),
parameters::ExecutionSpace::DeviceGPU => dispatch::gpu(execp, kernel),
};
// Ok or converts error
res.map_err(|e| e.into())
}
} else if #[cfg(feature = "rayon")] {
/// Parallel For statement.
///
/// **Current version**: `rayon`
///
/// ### Example
///
/// ```rust
/// use poc_kokkos_rs::{
/// functor::KernelArgs,
/// routines::{
/// parallel_for,
/// parameters::{ExecutionPolicy, ExecutionSpace, RangePolicy, Schedule},
/// },
/// };
///
/// let length: usize = 8;
///
/// let kern = |arg: KernelArgs<1>| match arg {
/// KernelArgs::Index1D(i) => {
/// // body of the kernel
/// println!("Hello from iteration {i}")
/// },
/// KernelArgs::IndexND(_) => unimplemented!(),
/// KernelArgs::Handle => unimplemented!(),
/// };
///
/// let execp = ExecutionPolicy {
/// space: ExecutionSpace::DeviceCPU,
/// range: RangePolicy::RangePolicy(0..length),
/// schedule: Schedule::Static,
/// };
///
/// parallel_for(execp, kern).unwrap();
/// ```
pub fn parallel_for<const N: usize>(
execp: ExecutionPolicy<N>,
func: impl Fn(KernelArgs<N>) + Send + Sync,
) -> Result<(), StatementError> {
// checks...
// data prep?
let kernel = Box::new(func);
// dispatch
let res = match execp.space {
parameters::ExecutionSpace::Serial => dispatch::serial(execp, kernel),
parameters::ExecutionSpace::DeviceCPU => dispatch::cpu(execp, kernel),
parameters::ExecutionSpace::DeviceGPU => dispatch::gpu(execp, kernel),
};
// Ok or converts error
res.map_err(|e| e.into())
}
} else {
/// Parallel For statement.
///
/// **Current version**: no feature
///
/// ### Example
///
/// ```rust
/// use poc_kokkos_rs::{
/// functor::KernelArgs,
/// routines::{
/// parallel_for,
/// parameters::{ExecutionPolicy, ExecutionSpace, RangePolicy, Schedule},
/// },
/// };
///
/// let length: usize = 8;
///
/// let kern = |arg: KernelArgs<1>| match arg {
/// KernelArgs::Index1D(i) => {
/// // body of the kernel
/// println!("Hello from iteration {i}")
/// },
/// KernelArgs::IndexND(_) => unimplemented!(),
/// KernelArgs::Handle => unimplemented!(),
/// };
///
/// let execp = ExecutionPolicy {
/// space: ExecutionSpace::DeviceCPU,
/// range: RangePolicy::RangePolicy(0..length),
/// schedule: Schedule::Static,
/// };
///
/// parallel_for(execp, kern).unwrap();
/// ```
pub fn parallel_for<const N: usize>(
execp: ExecutionPolicy<N>,
func: impl FnMut(KernelArgs<N>),
) -> Result<(), StatementError> {
// checks...
// data prep?
let kernel = Box::new(func);
// dispatch
let res = match execp.space {
parameters::ExecutionSpace::Serial => dispatch::serial(execp, kernel),
parameters::ExecutionSpace::DeviceCPU => dispatch::cpu(execp, kernel),
parameters::ExecutionSpace::DeviceGPU => dispatch::gpu(execp, kernel),
};
// Ok or converts error
res.map_err(|e| e.into())
}
}
}