Struct CheckpointProcess 

pub struct CheckpointProcess { /* private fields */ }

A CUDA process controlled through the driver checkpoint APIs.

These APIs are intended for an external controller process. Locking a process blocks further CUDA API calls in that process until it is restored and unlocked.

Implementations

impl CheckpointProcess

pub const fn new(pid: ProcessId) -> Self

Creates a CUDA checkpoint target from an operating-system process ID.

pub const fn from_pid(pid: ProcessId) -> Self

Creates a CUDA checkpoint target from an operating-system process ID.

pub fn current() -> Self

Creates a CUDA checkpoint target for the current process.

pub const fn pid(self) -> ProcessId

Returns the operating-system process ID controlled by this value.

pub fn state(self) -> Result<ProcessState>

Returns the current CUDA checkpoint state of the process.

pub fn is_running(self) -> bool

Returns true when this process currently has ProcessState::Running.

pub fn is_locked(self) -> bool

Returns true when this process currently has ProcessState::Locked.

pub fn is_checkpointed(self) -> bool

Returns true when this process currently has ProcessState::Checkpointed.

pub fn wait_for_state( self, expected: ProcessState, timeout: Duration, ) -> Result<ProcessState>

Blocks until the process reaches expected, or returns a timeout error.

pub fn restore_thread_id(self) -> Result<i32>

Returns the CUDA restore thread ID for the process.

pub fn lock(self, options: LockOptions) -> Result<()>

Locks a running CUDA process so further CUDA API calls in that process block.

On success the process enters ProcessState::Locked.

pub fn try_lock(self, options: LockOptions) -> Result<LockResult>

Attempts to lock a running CUDA process and reports whether the timeout was hit.

On success the process usually enters ProcessState::Locked. If a timeout is set and reached, this returns LockResult::TimedOut.

pub fn checkpoint(self) -> Result<()>

Moves the locked process’s GPU memory into host memory managed by the driver.

On success the process enters ProcessState::Checkpointed.

pub fn checkpoint_with_options(self, options: CheckpointOptions) -> Result<()>

Moves the locked process’s GPU memory into host memory managed by the driver.

This variant accepts explicit checkpoint options.

pub fn suspend(self, options: LockOptions) -> Result<()>

Locks and checkpoints a running CUDA process.

On success the process enters ProcessState::Checkpointed.

pub fn toggle( self, options: LockOptions, gpu_pairs: impl AsRef<[GpuPair]>, ) -> Result<ProcessState>

Toggles the process between running and checkpointed states.

• From Running, performs CheckpointProcess::suspend.
• From Checkpointed, performs CheckpointProcess::resume.

pub fn restore_with_options(self, options: RestoreOptions) -> Result<()>

Restores a checkpointed process, optionally remapping checkpointed GPUs.

If gpu_pairs is not empty, CUDA requires it to contain every checkpointed GPU.

On success the process enters ProcessState::Locked.

pub fn restore(self, gpu_pairs: impl AsRef<[GpuPair]>) -> Result<()>

Restores a checkpointed process, optionally remapping checkpointed GPUs.

If gpu_pairs is not empty, CUDA requires it to contain every checkpointed GPU.

On success the process enters ProcessState::Locked.

pub fn resume(self, gpu_pairs: impl AsRef<[GpuPair]>) -> Result<()>

Restores and unlocks a checkpointed CUDA process.

On success the process enters ProcessState::Running.

pub fn unlock(self) -> Result<()>

Unlocks a locked CUDA process so it can resume CUDA API calls.

On success the process enters ProcessState::Running.

pub fn unlock_with_options(self, options: UnlockOptions) -> Result<()>

Unlocks a locked CUDA process so it can resume CUDA API calls with options.

On success the process enters ProcessState::Running.

Trait Implementations

impl Clone for CheckpointProcess

fn clone(&self) -> CheckpointProcess

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for CheckpointProcess

impl Debug for CheckpointProcess

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for CheckpointProcess

impl Hash for CheckpointProcess

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CheckpointProcess

fn eq(&self, other: &CheckpointProcess) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CheckpointProcess