gko::OmpExecutor Class Reference

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

Inheritance diagram for gko::OmpExecutor:

Public Member Functions
std::shared_ptr< Executor >	get_master () noexcept override
std::shared_ptr< const Executor >	get_master () const noexcept override
void	synchronize () const override
int	get_num_cores () const
int	get_num_threads_per_core () const
scoped_device_id_guard	get_scoped_device_id_guard () const override
std::string	get_description () const override
virtual void	run (const Operation &op) const=0
template<typename ClosureOmp , typename ClosureCuda , typename ClosureHip , typename ClosureDpcpp >
void	run (const ClosureOmp &op_omp, const ClosureCuda &op_cuda, const ClosureHip &op_hip, const ClosureDpcpp &op_dpcpp) const
template<typename ClosureReference , typename ClosureOmp , typename ClosureCuda , typename ClosureHip , typename ClosureDpcpp >
void	run (std::string name, const ClosureReference &op_ref, const ClosureOmp &op_omp, const ClosureCuda &op_cuda, const ClosureHip &op_hip, const ClosureDpcpp &op_dpcpp) const

Static Public Member Functions
static std::shared_ptr< OmpExecutor >	create (std::shared_ptr< CpuAllocatorBase > alloc=std::make_shared< CpuAllocator >())
static int	get_num_omp_threads ()

Protected Member Functions
	OmpExecutor (std::shared_ptr< CpuAllocatorBase > alloc)
void	populate_exec_info (const machine_topology *mach_topo) override
void *	raw_alloc (size_type size) const override
void	raw_free (void *ptr) const noexcept override
void	raw_copy_to (const OmpExecutor *dest_exec, size_type n_bytes, const void *src_ptr, void *dest_ptr) const override
void	raw_copy_to (const HipExecutor *dest_exec, size_type n_bytes, const void *src_ptr, void *dest_ptr) const override
void	raw_copy_to (const DpcppExecutor *dest_exec, size_type n_bytes, const void *src_ptr, void *dest_ptr) const override
void	raw_copy_to (const CudaExecutor *dest_exec, size_type n_bytes, const void *src_ptr, void *dest_ptr) const override
virtual bool	verify_memory_to (const OmpExecutor *other) const override
virtual bool	verify_memory_to (const ReferenceExecutor *other) const override
virtual bool	verify_memory_to (const HipExecutor *other) const override
virtual bool	verify_memory_to (const CudaExecutor *other) const override
bool	verify_memory_to (const DpcppExecutor *dest_exec) const override

Protected Attributes
std::shared_ptr< CpuAllocatorBase >	alloc_

Detailed Description

This is the Executor subclass which represents the OpenMP device (typically CPU).

Member Function Documentation

create()

static std::shared_ptr< OmpExecutor > gko::OmpExecutor::create ( std::shared_ptr< CpuAllocatorBase >  alloc = std::make_shared<CpuAllocator>() )

inlinestatic

Creates a new OmpExecutor.

get_description()

std::string gko::OmpExecutor::get_description ( ) const

overridevirtual

Returns

a textual representation of the executor and its device.

Implements gko::Executor.

Reimplemented in gko::ReferenceExecutor.

get_master() [1/2]

std::shared_ptr< const Executor > gko::OmpExecutor::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::OmpExecutor::get_master ( )

overridevirtualnoexcept

Returns the master OmpExecutor of this Executor.

Returns

the master OmpExecutor of this Executor.

Implements gko::Executor.

get_scoped_device_id_guard()

scoped_device_id_guard gko::OmpExecutor::get_scoped_device_id_guard ( ) const

overridevirtual

Implements gko::Executor.

populate_exec_info()

void gko::OmpExecutor::populate_exec_info ( const machine_topology *  mach_topo )

overrideprotectedvirtual

Populates the executor specific info from the global machine topology object.

Parameters

mach_topo

the machine topology object.

Implements gko::Executor.

Reimplemented in gko::ReferenceExecutor.

raw_alloc()

void * gko::OmpExecutor::raw_alloc ( size_type  size ) const

overrideprotectedvirtual

Allocates raw memory in this Executor.

Parameters

size	number of bytes to allocate

Exceptions

AllocationError

if the allocation failed

Returns

raw pointer to allocated memory

Implements gko::Executor.

raw_copy_to() [1/4]

void gko::OmpExecutor::raw_copy_to ( const CudaExecutor *  dest_exec, size_type  n_bytes, const void *  src_ptr, void *  dest_ptr  ) const

overrideprotectedvirtual

Implements gko::Executor.

raw_copy_to() [2/4]

void gko::OmpExecutor::raw_copy_to ( const DpcppExecutor *  dest_exec, size_type  n_bytes, const void *  src_ptr, void *  dest_ptr  ) const

overrideprotectedvirtual

Implements gko::Executor.

raw_copy_to() [3/4]

void gko::OmpExecutor::raw_copy_to ( const HipExecutor *  dest_exec, size_type  n_bytes, const void *  src_ptr, void *  dest_ptr  ) const

overrideprotectedvirtual

Implements gko::Executor.

raw_copy_to() [4/4]

void gko::OmpExecutor::raw_copy_to ( const OmpExecutor *  dest_exec, size_type  n_bytes, const void *  src_ptr, void *  dest_ptr  ) const

overrideprotectedvirtual

Implements gko::Executor.

raw_free()

void gko::OmpExecutor::raw_free ( void *  ptr ) const

overrideprotectedvirtualnoexcept

Frees memory previously allocated with Executor::alloc().

If ptr is a nullptr, the function has no effect.

Parameters

ptr	pointer to the allocated memory block

Implements gko::Executor.

run() [1/3]

template<typename ClosureOmp , typename ClosureCuda , typename ClosureHip , typename ClosureDpcpp >

void gko::Executor::run ( const ClosureOmp &  op_omp, const ClosureCuda &  op_cuda, const ClosureHip &  op_hip, const ClosureDpcpp &  op_dpcpp  ) const

inline

Runs one of the passed in functors, depending on the Executor type.

Template Parameters

ClosureOmp	type of op_omp
ClosureCuda	type of op_cuda
ClosureHip	type of op_hip
ClosureDpcpp	type of op_dpcpp

Parameters

op_omp	functor to run in case of a OmpExecutor or ReferenceExecutor
op_cuda	functor to run in case of a CudaExecutor
op_hip	functor to run in case of a HipExecutor
op_dpcpp	functor to run in case of a DpcppExecutor

run() [2/3]

virtual void gko::Executor::run ( const Operation &  op ) const

virtual

Runs the specified Operation using this Executor.

Parameters

op	the operation to run

Implements gko::Executor.

Reimplemented in gko::ReferenceExecutor, and gko::ReferenceExecutor.

run() [3/3]

template<typename ClosureReference , typename ClosureOmp , typename ClosureCuda , typename ClosureHip , typename ClosureDpcpp >

void gko::Executor::run ( std::string  name, const ClosureReference &  op_ref, const ClosureOmp &  op_omp, const ClosureCuda &  op_cuda, const ClosureHip &  op_hip, const ClosureDpcpp &  op_dpcpp  ) const

inline

Runs one of the passed in functors, depending on the Executor type.

Template Parameters

ClosureReference	type of op_ref
ClosureOmp	type of op_omp
ClosureCuda	type of op_cuda
ClosureHip	type of op_hip
ClosureDpcpp	type of op_dpcpp

Parameters

name	the name of the operation
op_ref	functor to run in case of a ReferenceExecutor
op_omp	functor to run in case of a OmpExecutor
op_cuda	functor to run in case of a CudaExecutor
op_hip	functor to run in case of a HipExecutor
op_dpcpp	functor to run in case of a DpcppExecutor

synchronize()

void gko::OmpExecutor::synchronize ( ) const

overridevirtual

Synchronize the operations launched on the executor with its master.

Implements gko::Executor.

verify_memory_to() [1/5]

virtual bool gko::OmpExecutor::verify_memory_to ( const CudaExecutor *  other ) const

inlineoverrideprotectedvirtual

Implements gko::Executor.

verify_memory_to() [2/5]

bool gko::OmpExecutor::verify_memory_to ( const DpcppExecutor *  dest_exec ) const

overrideprotectedvirtual

Implements gko::Executor.

verify_memory_to() [3/5]

virtual bool gko::OmpExecutor::verify_memory_to ( const HipExecutor *  other ) const

inlineoverrideprotectedvirtual

Implements gko::Executor.

verify_memory_to() [4/5]

virtual bool gko::OmpExecutor::verify_memory_to ( const OmpExecutor *  other ) const

inlineoverrideprotectedvirtual

Implements gko::Executor.

verify_memory_to() [5/5]

virtual bool gko::OmpExecutor::verify_memory_to ( const ReferenceExecutor *  other ) const

inlineoverrideprotectedvirtual

Implements gko::Executor.

---

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

• ginkgo/core/base/executor.hpp