cuda.core.Buffer#

class cuda.core.Buffer(*args, **kwargs)#

Represent a handle to allocated memory.

This generic object provides a unified representation for how different memory resources are to give access to their memory allocations.

Support for data interchange mechanisms are provided by DLPack.

Methods

__init__(*args, **kwargs)#
close(self, stream: Stream | GraphBuilder | None = None)#

Deallocate this buffer asynchronously on the given stream.

This buffer is released back to their memory resource asynchronously on the given stream.

Parameters:

stream (Stream | GraphBuilder, optional) – The stream object to use for asynchronous deallocation. If None, the behavior depends on the underlying memory resource.

copy_from(
self,
Buffer src: Buffer,
*,
stream: Stream | GraphBuilder,
)#

Copy from the src buffer to this buffer asynchronously on the given stream.

Parameters:

  • src (Buffer) – Source buffer to copy data from

  • stream (Stream | GraphBuilder) – Keyword argument specifying the stream for the asynchronous copy

copy_to(
self,
Buffer dst: Buffer = None,
*,
stream: Stream | GraphBuilder,
) → Buffer#

Copy from this buffer to the dst buffer asynchronously on the given stream.

Copies the data from this buffer to the provided dst buffer. If the dst buffer is not provided, then a new buffer is first allocated using the associated memory resource before the copy.

Parameters:

  • dst (Buffer) – Source buffer to copy data from

  • stream (Stream | GraphBuilder) – Keyword argument specifying the stream for the asynchronous copy

fill(
self,
value: int | BufferProtocol,
*,
stream: Stream | GraphBuilder,
)#

Fill this buffer with a repeating byte pattern.

Parameters:
Raises:

  • TypeError – If value is not an int and does not support the buffer protocol.

  • ValueError – If value byte length is not 1, 2, or 4. If buffer size is not divisible by value byte length.

  • OverflowError – If int value is outside [0, 256).

static from_handle(
ptr: DevicePointerT,
size_t size,
MemoryResource mr: MemoryResource | None = None,
owner: object | None = None,
) → Buffer#

Create a new Buffer object from a pointer.

Parameters:

  • ptr (DevicePointerT) – Allocated buffer handle object

  • size (int) – Memory size of the buffer

  • mr (MemoryResource, optional) – Memory resource associated with the buffer

  • owner (object, optional) – An object holding external allocation that the ptr points to. The reference is kept as long as the buffer is alive. The owner and mr cannot be specified together.

classmethod from_ipc_descriptor(
cls,
mr: DeviceMemoryResource | PinnedMemoryResource,
IPCBufferDescriptor ipc_descriptor: IPCBufferDescriptor,
Stream stream: Stream = None,
) → Buffer#

Import a buffer that was exported from another process.

get_ipc_descriptor(self) → IPCBufferDescriptor#

Export a buffer allocated for sharing between processes.

Attributes