gko::HipExecutor Class Reference

This is the Executor subclass which represents the HIP enhanced device. More...

#include <ginkgo/core/base/executor.hpp>

Inheritance diagram for gko::HipExecutor:

Collaboration diagram for gko::HipExecutor:

Public Member Functions
std::shared_ptr< Executor >	get_master () noexcept override
	Returns the master OmpExecutor of this Executor. More...
std::shared_ptr< const Executor >	get_master () const noexcept override
	Returns the master OmpExecutor of this Executor. More...
void	synchronize () const override
	Synchronize the operations launched on the executor with its master.
scoped_device_id_guard	get_scoped_device_id_guard () const override
int	get_device_id () const noexcept
	Get the HIP device id of the device associated to this executor.
int	get_num_warps_per_sm () const noexcept
	Get the number of warps per SM of this executor.
int	get_num_multiprocessor () const noexcept
	Get the number of multiprocessor of this executor.
int	get_major_version () const noexcept
	Get the major version of compute capability.
int	get_minor_version () const noexcept
	Get the minor version of compute capability.
int	get_num_warps () const noexcept
	Get the number of warps of this executor.
int	get_warp_size () const noexcept
	Get the warp size of this executor.
hipblasContext *	get_hipblas_handle () const
	Get the hipblas handle for this executor. More...
hipsparseContext *	get_hipsparse_handle () const
	Get the hipsparse handle for this executor. More...
int	get_closest_numa () const
	Get the closest NUMA node. More...
std::vector< int >	get_closest_pus () const
	Get the closest PUs. More...
CUstream_st *	get_stream () const

Static Public Member Functions
static std::shared_ptr< HipExecutor >	create (int device_id, std::shared_ptr< Executor > master, bool device_reset, allocation_mode alloc_mode=default_hip_alloc_mode, CUstream_st *stream=nullptr)
	Creates a new HipExecutor. More...
static std::shared_ptr< HipExecutor >	create (int device_id, std::shared_ptr< Executor > master, std::shared_ptr< HipAllocatorBase > alloc=std::make_shared< HipAllocator >(), CUstream_st *stream=nullptr)
static int	get_num_devices ()
	Get the number of devices present on the system.

Detailed Description

This is the Executor subclass which represents the HIP enhanced device.

Member Function Documentation

create()

static std::shared_ptr<HipExecutor> gko::HipExecutor::create ( int  device_id, std::shared_ptr< Executor >  master, bool  device_reset, allocation_mode  alloc_mode = default_hip_alloc_mode, CUstream_st *  stream = nullptr  )

static

Creates a new HipExecutor.

Parameters

device_id	the HIP device id of this device
master	an executor on the host that is used to invoke the device kernels
device_reset	whether to reset the device after the object exits the scope.
alloc_mode	the allocation mode that the executor should operate on. See @allocation_mode for more details

get_closest_numa()

int gko::HipExecutor::get_closest_numa ( ) const

inline

Get the closest NUMA node.

Returns

the closest NUMA node closest to this device

get_closest_pus()

std::vector<int> gko::HipExecutor::get_closest_pus ( ) const

inline

Get the closest PUs.

Returns

the array of PUs closest to this device

get_hipblas_handle()

hipblasContext* gko::HipExecutor::get_hipblas_handle ( ) const

inline

Get the hipblas handle for this executor.

Returns

the hipblas handle (hipblasContext*) for this executor

get_hipsparse_handle()

hipsparseContext* gko::HipExecutor::get_hipsparse_handle ( ) const

inline

Get the hipsparse handle for this executor.

Returns

the hipsparse handle (hipsparseContext*) for this executor

get_master() [1/2]

std::shared_ptr<const Executor> gko::HipExecutor::get_master ( ) const

overridevirtualnoexcept

Returns the master OmpExecutor of this Executor.

Returns

the master OmpExecutor of this Executor.

Implements gko::Executor.

get_master() [2/2]

std::shared_ptr<Executor> gko::HipExecutor::get_master ( )

overridevirtualnoexcept

Returns the master OmpExecutor of this Executor.

Returns

the master OmpExecutor of this Executor.

Implements gko::Executor.

---

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

• ginkgo/core/base/executor.hpp