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 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
use const_type_layout::TypeGraphLayout;
#[cfg(feature = "host")]
use rustacuda::error::CudaError;
#[cfg(feature = "derive")]
#[expect(clippy::module_name_repetitions)]
pub use rust_cuda_derive::LendRustToCuda;
#[cfg(any(feature = "host", feature = "device", doc))]
use crate::safety::{SafeMutableAliasing, StackOnly};
#[cfg(feature = "device")]
use crate::utils::ffi::{DeviceConstRef, DeviceMutRef, DeviceOwnedRef};
use crate::{alloc::CudaAlloc, safety::PortableBitSemantics};
#[cfg(any(feature = "host", feature = "device"))]
use crate::{alloc::EmptyCudaAlloc, utils::ffi::DeviceAccessible};
#[cfg(feature = "host")]
use crate::{
alloc::{CombinedCudaAlloc, NoCudaAlloc},
host::{HostAndDeviceConstRef, HostAndDeviceMutRef, HostAndDeviceOwned},
utils::r#async::{Async, CompletionFnMut, NoCompletion},
};
mod impls;
/// # Safety
///
/// This is an internal trait and should ONLY be derived automatically using
/// `#[derive(LendRustToCuda)]`
pub unsafe trait RustToCuda {
type CudaAllocation: CudaAlloc;
type CudaRepresentation: CudaAsRust<RustRepresentation = Self>;
#[doc(hidden)]
#[cfg(feature = "host")]
/// # Errors
///
/// Returns a [`rustacuda::error::CudaError`] iff an error occurs inside
/// CUDA
///
/// # Safety
///
/// This is an internal function and should NEVER be called manually
/// The returned [`Self::CudaRepresentation`] must NEVER be accessed on the
/// CPU as it contains a GPU-resident copy of `self`.
#[expect(clippy::type_complexity)]
unsafe fn borrow<A: CudaAlloc>(
&self,
alloc: A,
) -> rustacuda::error::CudaResult<(
DeviceAccessible<Self::CudaRepresentation>,
CombinedCudaAlloc<Self::CudaAllocation, A>,
)>;
#[doc(hidden)]
#[cfg(feature = "host")]
/// # Errors
///
/// Returns a [`rustacuda::error::CudaError`] iff an error occurs inside
/// CUDA
///
/// # Safety
///
/// This is an internal function and should NEVER be called manually
unsafe fn restore<A: CudaAlloc>(
&mut self,
alloc: CombinedCudaAlloc<Self::CudaAllocation, A>,
) -> rustacuda::error::CudaResult<A>;
}
/// # Safety
///
/// This is an internal trait and should ONLY be derived automatically using
/// `#[derive(LendRustToCuda)]`
pub unsafe trait RustToCudaAsync: RustToCuda {
type CudaAllocationAsync: CudaAlloc;
#[doc(hidden)]
#[cfg(feature = "host")]
/// # Errors
///
/// Returns a [`rustacuda::error::CudaError`] iff an error occurs inside
/// CUDA
///
/// # Safety
///
/// This is an internal function and should NEVER be called manually.
///
/// The returned
/// [`Self::CudaRepresentation`](RustToCuda::CudaRepresentation) must NEVER
/// be accessed on the CPU as it contains a GPU-resident copy of
/// `self`.
///
/// Since this method may perform asynchronous computation but returns its
/// result immediately, this result must only be used to construct compound
/// asynchronous computations before it has been synchronized on.
///
/// Similarly, `&self` should remain borrowed until synchronisation has
/// been performed.
#[expect(clippy::type_complexity)]
unsafe fn borrow_async<'stream, A: CudaAlloc>(
&self,
alloc: A,
stream: crate::host::Stream<'stream>,
) -> rustacuda::error::CudaResult<(
Async<'_, 'stream, DeviceAccessible<Self::CudaRepresentation>>,
CombinedCudaAlloc<Self::CudaAllocationAsync, A>,
)>;
#[doc(hidden)]
#[cfg(feature = "host")]
/// # Errors
///
/// Returns a [`rustacuda::error::CudaError`] iff an error occurs inside
/// CUDA
///
/// # Safety
///
/// This is an internal function and should NEVER be called manually.
///
/// Since this method may perform asynchronous computation but returns
/// immediately, `&mut self` not be used until it has been synchronized on.
///
/// Therefore, `&mut self` should remain mutably borrowed until
/// synchronisation has been performed.
#[expect(clippy::type_complexity)]
unsafe fn restore_async<'a, 'stream, A: CudaAlloc, O>(
this: owning_ref::BoxRefMut<'a, O, Self>,
alloc: CombinedCudaAlloc<Self::CudaAllocationAsync, A>,
stream: crate::host::Stream<'stream>,
) -> rustacuda::error::CudaResult<(
Async<'a, 'stream, owning_ref::BoxRefMut<'a, O, Self>, CompletionFnMut<'a, Self>>,
A,
)>;
}
/// # Safety
///
/// This is an internal trait and should NEVER be implemented manually
pub unsafe trait CudaAsRust: PortableBitSemantics + TypeGraphLayout {
type RustRepresentation: RustToCuda<CudaRepresentation = Self>;
#[doc(hidden)]
#[cfg(feature = "device")]
/// # Safety
///
/// This is an internal function and should NEVER be called manually
unsafe fn as_rust(this: &DeviceAccessible<Self>) -> Self::RustRepresentation;
}
pub trait RustToCudaProxy<T>: RustToCuda {
fn from_ref(val: &T) -> &Self;
fn from_mut(val: &mut T) -> &mut Self;
fn into(self) -> T;
}
#[cfg(feature = "host")]
#[expect(clippy::module_name_repetitions)]
pub trait LendToCuda: RustToCuda {
/// Lends an immutable borrow of `&self` to CUDA:
/// - code in the CUDA kernel can only access `&self` through the
/// [`DeviceConstRef`] inside the closure
/// - after the closure, `&self` will not have changed
///
/// # Errors
///
/// Returns a [`CudaError`] iff an error occurs inside CUDA
fn lend_to_cuda<
O,
E: From<CudaError>,
F: FnOnce(
HostAndDeviceConstRef<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
) -> Result<O, E>,
>(
&self,
inner: F,
) -> Result<O, E>
where
Self: Sync;
/// Lends a mutable borrow of `&mut self` to CUDA iff `Self` is
/// [`SafeMutableAliasing`]:
/// - code in the CUDA kernel can only access `&mut self` through the
/// `DeviceMutRef` inside the closure
/// - after the closure, `&mut self` will reflect the changes from the
/// kernel execution
///
/// # Errors
///
/// Returns a `rustacuda::errors::CudaError` iff an error occurs inside CUDA
fn lend_to_cuda_mut<
O,
E: From<CudaError>,
F: FnOnce(
HostAndDeviceMutRef<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
) -> Result<O, E>,
>(
&mut self,
inner: F,
) -> Result<O, E>
where
Self: Sync + SafeMutableAliasing;
/// Moves `self` to CUDA iff `Self` is [`StackOnly`].
///
/// # Errors
///
/// Returns a [`CudaError`] iff an error occurs inside CUDA
fn move_to_cuda<
O,
E: From<CudaError>,
F: FnOnce(
HostAndDeviceOwned<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
) -> Result<O, E>,
>(
self,
inner: F,
) -> Result<O, E>
where
Self: Send + RustToCuda<CudaRepresentation: StackOnly, CudaAllocation: EmptyCudaAlloc>;
}
#[cfg(feature = "host")]
impl<T: RustToCuda> LendToCuda for T {
fn lend_to_cuda<
O,
E: From<CudaError>,
F: FnOnce(
HostAndDeviceConstRef<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
) -> Result<O, E>,
>(
&self,
inner: F,
) -> Result<O, E>
where
Self: Sync,
{
let (cuda_repr, alloc) = unsafe { self.borrow(NoCudaAlloc) }?;
let result = HostAndDeviceConstRef::with_new(&cuda_repr, inner);
core::mem::drop(cuda_repr);
core::mem::drop(alloc);
result
}
fn lend_to_cuda_mut<
O,
E: From<CudaError>,
F: FnOnce(
HostAndDeviceMutRef<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
) -> Result<O, E>,
>(
&mut self,
inner: F,
) -> Result<O, E>
where
Self: Sync + SafeMutableAliasing,
{
let (mut cuda_repr, alloc) = unsafe { self.borrow(NoCudaAlloc) }?;
let result = HostAndDeviceMutRef::with_new(&mut cuda_repr, inner);
core::mem::drop(cuda_repr);
let _: NoCudaAlloc = unsafe { self.restore(alloc) }?;
result
}
fn move_to_cuda<
O,
E: From<CudaError>,
F: FnOnce(
HostAndDeviceOwned<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
) -> Result<O, E>,
>(
self,
inner: F,
) -> Result<O, E>
where
Self: Send + RustToCuda<CudaRepresentation: StackOnly, CudaAllocation: EmptyCudaAlloc>,
{
let (cuda_repr, alloc) = unsafe { self.borrow(NoCudaAlloc) }?;
let result = HostAndDeviceOwned::with_new(cuda_repr, inner);
core::mem::drop(alloc);
result
}
}
#[cfg(feature = "host")]
#[expect(clippy::module_name_repetitions)]
pub trait LendToCudaAsync: RustToCudaAsync {
/// Lends an immutable copy of `&self` to CUDA:
/// - code in the CUDA kernel can only access `&self` through the
/// [`DeviceConstRef`] inside the closure
/// - after the closure, `&self` will not have changed, i.e. interior
/// mutability is not handled by this method
///
/// Since the [`HostAndDeviceConstRef`] is wrapped in an [`Async`] with
/// [`NoCompletion`], this [`Async`] can be safely dropped or forgotten
/// without changing any behaviour. Therefore, this [`Async`] does *not*
/// need to be returned from the `inner` closure.
///
/// # Errors
///
/// Returns a [`CudaError`] iff an error occurs inside CUDA
fn lend_to_cuda_async<
'stream,
O,
E: From<CudaError>,
F: FnOnce(
Async<
'_,
'stream,
HostAndDeviceConstRef<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
NoCompletion,
>,
) -> Result<O, E>,
>(
&self,
stream: crate::host::Stream<'stream>,
inner: F,
) -> Result<O, E>
where
Self: Sync;
#[expect(clippy::type_complexity)]
/// Lends a mutable borrow of `&mut self` to CUDA iff `Self` is
/// [`SafeMutableAliasing`]:
/// - code in the CUDA kernel can only access `&mut self` through the
/// `DeviceMutRef` inside the closure
/// - after the closure, `&mut self` will reflect the changes from the
/// kernel execution
///
/// # Errors
///
/// Returns a `rustacuda::errors::CudaError` iff an error occurs inside CUDA
fn lend_to_cuda_mut_async<
'a,
'stream,
O,
E: From<CudaError>,
F: for<'b> FnOnce(
Async<
'b,
'stream,
HostAndDeviceMutRef<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
NoCompletion,
>,
) -> Result<O, E>,
T: 'a,
>(
this: owning_ref::BoxRefMut<'a, T, Self>,
stream: crate::host::Stream<'stream>,
inner: F,
) -> Result<
(
Async<'a, 'stream, owning_ref::BoxRefMut<'a, T, Self>, CompletionFnMut<'a, Self>>,
O,
),
E,
>
where
Self: Sync + SafeMutableAliasing;
/// Moves `self` to CUDA iff `self` is [`StackOnly`].
///
/// Since the [`HostAndDeviceOwned`] is wrapped in an [`Async`] with
/// [`NoCompletion`], this [`Async`] can be safely dropped or forgotten
/// without changing any behaviour. Therefore, this [`Async`] does *not*
/// need to be returned from the `inner` closure.
///
/// # Errors
///
/// Returns a [`CudaError`] iff an error occurs inside CUDA
fn move_to_cuda_async<
'stream,
O,
E: From<CudaError>,
F: for<'a> FnOnce(
Async<
'a,
'stream,
HostAndDeviceOwned<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
NoCompletion,
>,
) -> Result<O, E>,
>(
self,
stream: crate::host::Stream<'stream>,
inner: F,
) -> Result<O, E>
where
Self: Send + RustToCuda<CudaRepresentation: StackOnly, CudaAllocation: EmptyCudaAlloc>;
}
#[cfg(feature = "host")]
impl<T: RustToCudaAsync> LendToCudaAsync for T {
fn lend_to_cuda_async<
'stream,
O,
E: From<CudaError>,
F: FnOnce(
Async<
'_,
'stream,
HostAndDeviceConstRef<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
NoCompletion,
>,
) -> Result<O, E>,
>(
&self,
stream: crate::host::Stream<'stream>,
inner: F,
) -> Result<O, E>
where
Self: Sync,
{
let (cuda_repr, alloc) = unsafe { self.borrow_async(NoCudaAlloc, stream) }?;
let (cuda_repr, completion) = unsafe { cuda_repr.unwrap_unchecked()? };
let result = HostAndDeviceConstRef::with_new(&cuda_repr, |const_ref| {
let r#async = if matches!(completion, Some(NoCompletion)) {
Async::pending(const_ref, stream, NoCompletion)?
} else {
Async::ready(const_ref, stream)
};
inner(r#async)
});
core::mem::drop(cuda_repr);
core::mem::drop(alloc);
result
}
fn lend_to_cuda_mut_async<
'a,
'stream,
O,
E: From<CudaError>,
F: for<'b> FnOnce(
Async<
'b,
'stream,
HostAndDeviceMutRef<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
NoCompletion,
>,
) -> Result<O, E>,
S: 'a,
>(
this: owning_ref::BoxRefMut<'a, S, Self>,
stream: crate::host::Stream<'stream>,
inner: F,
) -> Result<
(
Async<'a, 'stream, owning_ref::BoxRefMut<'a, S, Self>, CompletionFnMut<'a, Self>>,
O,
),
E,
>
where
Self: Sync + SafeMutableAliasing,
{
let (cuda_repr, alloc) = unsafe { this.borrow_async(NoCudaAlloc, stream) }?;
let (mut cuda_repr, completion) = unsafe { cuda_repr.unwrap_unchecked()? };
let result = HostAndDeviceMutRef::with_new(&mut cuda_repr, |mut_ref| {
let r#async = if matches!(completion, Some(NoCompletion)) {
Async::pending(mut_ref, stream, NoCompletion)?
} else {
Async::ready(mut_ref, stream)
};
inner(r#async)
});
core::mem::drop(cuda_repr);
let (r#async, _): (_, NoCudaAlloc) = unsafe { Self::restore_async(this, alloc, stream) }?;
result.map(|ok| (r#async, ok))
}
fn move_to_cuda_async<
'stream,
O,
E: From<CudaError>,
F: for<'a> FnOnce(
Async<
'a,
'stream,
HostAndDeviceOwned<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
NoCompletion,
>,
) -> Result<O, E>,
>(
self,
stream: crate::host::Stream<'stream>,
inner: F,
) -> Result<O, E>
where
Self: Send + RustToCuda<CudaRepresentation: StackOnly, CudaAllocation: EmptyCudaAlloc>,
{
let (cuda_repr, alloc) = unsafe { self.borrow_async(NoCudaAlloc, stream) }?;
let (cuda_repr, completion) = unsafe { cuda_repr.unwrap_unchecked()? };
let result = HostAndDeviceOwned::with_new(cuda_repr, |owned_ref| {
if matches!(completion, Some(NoCompletion)) {
inner(Async::pending(owned_ref, stream, NoCompletion)?)
} else {
inner(Async::ready(owned_ref, stream))
}
});
core::mem::drop(alloc);
result
}
}
#[cfg(feature = "device")]
pub trait BorrowFromRust: RustToCuda {
/// # Safety
///
/// This function is only safe to call iff `cuda_repr` is the
/// [`DeviceConstRef`] borrowed on the CPU using the corresponding
/// [`LendToCuda::lend_to_cuda`].
unsafe fn with_borrow_from_rust<O, F: FnOnce(&Self) -> O>(
cuda_repr: DeviceConstRef<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
inner: F,
) -> O;
/// # Safety
///
/// This function is only safe to call iff `cuda_repr_mut` is the
/// [`DeviceMutRef`] borrowed on the CPU using the corresponding
/// [`LendToCuda::lend_to_cuda_mut`].
unsafe fn with_borrow_from_rust_mut<O, F: FnOnce(&mut Self) -> O>(
cuda_repr_mut: DeviceMutRef<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
inner: F,
) -> O
where
Self: SafeMutableAliasing;
/// # Safety
///
/// This function is only safe to call iff `cuda_repr` is the
/// [`DeviceOwnedRef`] borrowed on the CPU using the corresponding
/// [`LendToCuda::move_to_cuda`].
unsafe fn with_moved_from_rust<O, F: FnOnce(Self) -> O>(
cuda_repr: DeviceOwnedRef<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
inner: F,
) -> O
where
Self: Sized + RustToCuda<CudaRepresentation: StackOnly, CudaAllocation: EmptyCudaAlloc>;
}
#[cfg(feature = "device")]
impl<T: RustToCuda> BorrowFromRust for T {
#[inline]
unsafe fn with_borrow_from_rust<O, F: FnOnce(&Self) -> O>(
cuda_repr: DeviceConstRef<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
inner: F,
) -> O {
// `rust_repr` must never be dropped as we do NOT own any of the
// heap memory it might reference
let rust_repr = core::mem::ManuallyDrop::new(CudaAsRust::as_rust(cuda_repr.as_ref()));
inner(&rust_repr)
}
#[inline]
unsafe fn with_borrow_from_rust_mut<O, F: FnOnce(&mut Self) -> O>(
mut cuda_repr_mut: DeviceMutRef<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
inner: F,
) -> O
where
Self: SafeMutableAliasing,
{
// `rust_repr` must never be dropped as we do NOT own any of the
// heap memory it might reference
let mut rust_repr_mut =
core::mem::ManuallyDrop::new(CudaAsRust::as_rust(cuda_repr_mut.as_mut()));
inner(&mut rust_repr_mut)
}
#[inline]
unsafe fn with_moved_from_rust<O, F: FnOnce(Self) -> O>(
mut cuda_repr: DeviceOwnedRef<DeviceAccessible<<Self as RustToCuda>::CudaRepresentation>>,
inner: F,
) -> O
where
Self: RustToCuda<CudaRepresentation: StackOnly, CudaAllocation: EmptyCudaAlloc>,
{
inner(CudaAsRust::as_rust(cuda_repr.as_mut()))
}
}