vtkDeviceArrayFactory Class Reference

#include <vtkDeviceArrayFactory.h>

Detailed Description

makes a vtkDataArray over GPU memory a vtkMemoryDescriptor describes

This is how wrapped code – vtkmodules.util.dlpack_support above all – puts GPU memory into VTK without copying it. Give it the shape, the VTK data type and one descriptor with the role "data" (interleaved values), and CreateArray() returns a vtkDeviceDataArray holding the memory. The array keeps the descriptor, so the descriptor's owner or release callback decides when the memory is freed.

VTK needs no GPU toolkit for this: the vendor's driver is loaded the first time it is needed (vtkDeviceMemory). IsMemorySpaceAvailable() says whether it can be: "cuda", "hip" and "level_zero".

Level Zero memory must be in VTK's Level Zero context, which the GetLevelZero*Handle() functions report: a producer allocates there, or gives VTK its own context first (SetLevelZeroContext).

See also

vtkDeviceDataArray vtkMemoryDescriptor

Tests:

vtkDeviceArrayFactory (Tests)

Definition at line 39 of file vtkDeviceArrayFactory.h.

Inheritance diagram for vtkDeviceArrayFactory:

Collaboration diagram for vtkDeviceArrayFactory:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkDeviceArrayFactory *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkDataArray *	CreateArray ()
	The array, or nullptr (with an error) if the descriptor, shape or type do not fit, or the memory space cannot be read here.
virtual void	SetNumberOfTuples (vtkIdType)
	The array's shape and VTK data type (VTK_FLOAT, VTK_INT, ...).
virtual vtkIdType	GetNumberOfTuples ()
	The array's shape and VTK data type (VTK_FLOAT, VTK_INT, ...).
virtual void	SetNumberOfComponents (int)
	The array's shape and VTK data type (VTK_FLOAT, VTK_INT, ...).
virtual int	GetNumberOfComponents ()
	The array's shape and VTK data type (VTK_FLOAT, VTK_INT, ...).
virtual void	SetDataType (int)
	The array's shape and VTK data type (VTK_FLOAT, VTK_INT, ...).
virtual int	GetDataType ()
	The array's shape and VTK data type (VTK_FLOAT, VTK_INT, ...).
void	AddBuffer (vtkMemoryDescriptor *descriptor)
	The memory: one descriptor, of role "data".
void	ClearBuffers ()
	The memory: one descriptor, of role "data".
int	GetNumberOfBuffers () const
	The memory: one descriptor, of role "data".
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkDeviceArrayFactory *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkDeviceArrayFactory *	SafeDownCast (vtkObjectBase *o)
static bool	IsMemorySpaceAvailable (const char *space)
	Whether memory of the space named ("cuda", "hip", "level_zero") can be held: whether the vendor's driver or runtime loads and has a device.
static int	GetDeviceOrdinal (vtkMemoryDescriptor *descriptor)
	The number of the device the memory a descriptor describes is on, as the vendor's runtime counts devices and DLPack's device_id does: CUDA's and HIP's device ordinal, or the device's index among its Level Zero driver's devices.
static void	SetLevelZeroContext (vtkTypeUInt64 driver, vtkTypeUInt64 device, vtkTypeUInt64 context)
	VTK's Level Zero context, as integers: the ze_driver_handle_t, ze_device_handle_t and ze_context_handle_t.
static bool	HasLevelZeroContext ()
	VTK's Level Zero context, as integers: the ze_driver_handle_t, ze_device_handle_t and ze_context_handle_t.
static vtkTypeUInt64	GetLevelZeroDriverHandle ()
	VTK's Level Zero context, as integers: the ze_driver_handle_t, ze_device_handle_t and ze_context_handle_t.
static vtkTypeUInt64	GetLevelZeroDeviceHandle ()
	VTK's Level Zero context, as integers: the ze_driver_handle_t, ze_device_handle_t and ze_context_handle_t.
static vtkTypeUInt64	GetLevelZeroContextHandle ()
	VTK's Level Zero context, as integers: the ze_driver_handle_t, ze_device_handle_t and ze_context_handle_t.
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkDeviceArrayFactory ()
	~vtkDeviceArrayFactory () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Member Typedef Documentation

Superclass

typedef vtkObject vtkDeviceArrayFactory::Superclass

Definition at line 43 of file vtkDeviceArrayFactory.h.

Constructor & Destructor Documentation

vtkDeviceArrayFactory()

vtkDeviceArrayFactory::vtkDeviceArrayFactory ( )

protected

~vtkDeviceArrayFactory()

vtkDeviceArrayFactory::~vtkDeviceArrayFactory ( )

overrideprotected

Member Function Documentation

New()

vtkDeviceArrayFactory * vtkDeviceArrayFactory::New ( )

static

IsTypeOf()

vtkTypeBool vtkDeviceArrayFactory::IsTypeOf ( const char * type )

static

IsA()

virtual vtkTypeBool vtkDeviceArrayFactory::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

SafeDownCast()

vtkDeviceArrayFactory * vtkDeviceArrayFactory::SafeDownCast ( vtkObjectBase * o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkDeviceArrayFactory::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkDeviceArrayFactory * vtkDeviceArrayFactory::NewInstance

(

)

const

PrintSelf()

void vtkDeviceArrayFactory::PrintSelf ( ostream & os, vtkIndent indent )

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObjectBase.

SetNumberOfTuples()

virtual void vtkDeviceArrayFactory::SetNumberOfTuples ( vtkIdType )

virtual

The array's shape and VTK data type (VTK_FLOAT, VTK_INT, ...).

GetNumberOfTuples()

virtual vtkIdType vtkDeviceArrayFactory::GetNumberOfTuples ( )

virtual

The array's shape and VTK data type (VTK_FLOAT, VTK_INT, ...).

SetNumberOfComponents()

virtual void vtkDeviceArrayFactory::SetNumberOfComponents ( int )

virtual

The array's shape and VTK data type (VTK_FLOAT, VTK_INT, ...).

GetNumberOfComponents()

virtual int vtkDeviceArrayFactory::GetNumberOfComponents ( )

virtual

The array's shape and VTK data type (VTK_FLOAT, VTK_INT, ...).

SetDataType()

virtual void vtkDeviceArrayFactory::SetDataType ( int )

virtual

The array's shape and VTK data type (VTK_FLOAT, VTK_INT, ...).

GetDataType()

virtual int vtkDeviceArrayFactory::GetDataType ( )

virtual

The array's shape and VTK data type (VTK_FLOAT, VTK_INT, ...).

AddBuffer()

void vtkDeviceArrayFactory::AddBuffer

(

vtkMemoryDescriptor *

descriptor

)

The memory: one descriptor, of role "data".

Adding a second replaces the first. The same names as vtkmDataArrayFactory's, so callers can use either.

ClearBuffers()

void vtkDeviceArrayFactory::ClearBuffers

(

)

The memory: one descriptor, of role "data".

Adding a second replaces the first. The same names as vtkmDataArrayFactory's, so callers can use either.

GetNumberOfBuffers()

int vtkDeviceArrayFactory::GetNumberOfBuffers

(

)

const

The memory: one descriptor, of role "data".

Adding a second replaces the first. The same names as vtkmDataArrayFactory's, so callers can use either.

CreateArray()

vtkDataArray * vtkDeviceArrayFactory::CreateArray

(

)

The array, or nullptr (with an error) if the descriptor, shape or type do not fit, or the memory space cannot be read here.

IsMemorySpaceAvailable()

bool vtkDeviceArrayFactory::IsMemorySpaceAvailable ( const char * space )

static

Whether memory of the space named ("cuda", "hip", "level_zero") can be held: whether the vendor's driver or runtime loads and has a device.

GetDeviceOrdinal()

int vtkDeviceArrayFactory::GetDeviceOrdinal ( vtkMemoryDescriptor * descriptor )

static

The number of the device the memory a descriptor describes is on, as the vendor's runtime counts devices and DLPack's device_id does: CUDA's and HIP's device ordinal, or the device's index among its Level Zero driver's devices.

Any descriptor of device memory, not only this factory's. -1 for host memory, or when the vendor's library cannot tell.

SetLevelZeroContext()

void vtkDeviceArrayFactory::SetLevelZeroContext ( vtkTypeUInt64 driver, vtkTypeUInt64 device, vtkTypeUInt64 context )

static

VTK's Level Zero context, as integers: the ze_driver_handle_t, ze_device_handle_t and ze_context_handle_t.

VTK has one per process: one given to SetLevelZeroContext (another library's, such as a SYCL runtime's default context, which VTK cannot make), else one VTK makes on the first Level Zero GPU the first time it is asked. The getters return 0 if there is no Level Zero GPU. Set the context before making any Level Zero array; setting a zero context forgets it. HasLevelZeroContext() says whether there is one already, without making one. The handles belong to whoever made them: use them, do not destroy them.

HasLevelZeroContext()

bool vtkDeviceArrayFactory::HasLevelZeroContext ( )

static

VTK's Level Zero context, as integers: the ze_driver_handle_t, ze_device_handle_t and ze_context_handle_t.

VTK has one per process: one given to SetLevelZeroContext (another library's, such as a SYCL runtime's default context, which VTK cannot make), else one VTK makes on the first Level Zero GPU the first time it is asked. The getters return 0 if there is no Level Zero GPU. Set the context before making any Level Zero array; setting a zero context forgets it. HasLevelZeroContext() says whether there is one already, without making one. The handles belong to whoever made them: use them, do not destroy them.

GetLevelZeroDriverHandle()

vtkTypeUInt64 vtkDeviceArrayFactory::GetLevelZeroDriverHandle ( )

static

VTK's Level Zero context, as integers: the ze_driver_handle_t, ze_device_handle_t and ze_context_handle_t.

VTK has one per process: one given to SetLevelZeroContext (another library's, such as a SYCL runtime's default context, which VTK cannot make), else one VTK makes on the first Level Zero GPU the first time it is asked. The getters return 0 if there is no Level Zero GPU. Set the context before making any Level Zero array; setting a zero context forgets it. HasLevelZeroContext() says whether there is one already, without making one. The handles belong to whoever made them: use them, do not destroy them.

GetLevelZeroDeviceHandle()

vtkTypeUInt64 vtkDeviceArrayFactory::GetLevelZeroDeviceHandle ( )

static

VTK's Level Zero context, as integers: the ze_driver_handle_t, ze_device_handle_t and ze_context_handle_t.

VTK has one per process: one given to SetLevelZeroContext (another library's, such as a SYCL runtime's default context, which VTK cannot make), else one VTK makes on the first Level Zero GPU the first time it is asked. The getters return 0 if there is no Level Zero GPU. Set the context before making any Level Zero array; setting a zero context forgets it. HasLevelZeroContext() says whether there is one already, without making one. The handles belong to whoever made them: use them, do not destroy them.

GetLevelZeroContextHandle()

vtkTypeUInt64 vtkDeviceArrayFactory::GetLevelZeroContextHandle ( )

static

VTK's Level Zero context, as integers: the ze_driver_handle_t, ze_device_handle_t and ze_context_handle_t.

VTK has one per process: one given to SetLevelZeroContext (another library's, such as a SYCL runtime's default context, which VTK cannot make), else one VTK makes on the first Level Zero GPU the first time it is asked. The getters return 0 if there is no Level Zero GPU. Set the context before making any Level Zero array; setting a zero context forgets it. HasLevelZeroContext() says whether there is one already, without making one. The handles belong to whoever made them: use them, do not destroy them.

---

The documentation for this class was generated from the following file:

• Common/Core/vtkDeviceArrayFactory.h