Skip to main content

ExternalDeviceMemory

Struct ExternalDeviceMemory 

Source
pub struct ExternalDeviceMemory { /* private fields */ }
Expand description

Wrapper for externally-allocated device (GPU) memory.

This type wraps a raw pointer to GPU memory that is owned by an external framework (like vLLM). It provides the necessary traits for NIXL registration without taking ownership of the underlying memory.

§Safety

This type relies on the caller to guarantee that:

  • The pointer points to valid GPU memory on the specified device
  • The memory remains valid for the lifetime of this wrapper
  • The memory size is exactly as specified
  • The external framework doesn’t free the memory while this wrapper exists

§Example

// vLLM allocates KV cache tensors
let tensor_ptr = tensor.data_ptr();
let tensor_size = tensor.size_bytes();
let device_id = tensor.device.index;

// Wrap without taking ownership
let external = unsafe {
    ExternalDeviceMemory::new(tensor_ptr as *const u8, tensor_size, device_id as u64)
};

// Register with NIXL for RDMA
let registered = register_with_nixl(external, &agent, None)?;

Implementations§

Source§

impl ExternalDeviceMemory

Source

pub unsafe fn new(ptr: *const u8, size: usize, device_id: u64) -> Self

Create a wrapper for external device memory.

§Safety

Caller must ensure:

  • ptr points to valid GPU memory on CUDA device device_id
  • The memory remains valid for the lifetime of this wrapper
  • The memory size is exactly size bytes
  • The external framework doesn’t free the memory while this wrapper exists
Source

pub fn as_ptr(&self) -> *const u8

Get the raw pointer to the external memory.

Source

pub fn device_id(&self) -> u64

Get the CUDA device ID where this memory resides.

Trait Implementations§

Source§

impl Debug for ExternalDeviceMemory

Source§

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

Formats the value using the given formatter. Read more
Source§

impl MemoryDescriptor for ExternalDeviceMemory

Source§

fn addr(&self) -> usize

Base address of the memory region.
Source§

fn size(&self) -> usize

Size of the memory region in bytes.
Source§

fn storage_kind(&self) -> StorageKind

Type of storage backing this region.
Source§

fn as_any(&self) -> &dyn Any

Enable downcasting to concrete type.
Source§

fn nixl_descriptor(&self) -> Option<NixlDescriptor>

Get the NIXL descriptor for this memory region.
Source§

impl NixlCompatible for ExternalDeviceMemory

Source§

fn nixl_params(&self) -> (*const u8, usize, MemType, u64)

Get parameters needed for NIXL registration. Read more
Source§

impl Send for ExternalDeviceMemory

Source§

impl Sync for ExternalDeviceMemory

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> NixlRegisterExt for T

Source§

fn register( self, agent: &NixlAgent, opt: Option<&OptArgs>, ) -> Result<NixlRegistered<Self>, Self>

Get this memory as NIXL-registered. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> NixlMemory for T