CLKernelLibrary class. More...

#include <CLKernelLibrary.h>

Public Member Functions
void	init (std::string kernel_path, cl::Context context, cl::Device device)
	Initialises the kernel library. More...

void	set_kernel_path (const std::string &kernel_path)
	Sets the path that the kernels reside in. More...

std::string	get_kernel_path ()
	Gets the path that the kernels reside in. More...

std::pair< std::string, bool >	get_program (const std::string &program_name) const
	Gets the source of the selected program. More...

cl::Context &	context ()
	Accessor for the associated CL context. More...

const cl::Device &	get_device ()
	Gets the CL device for which the programs are created. More...

void	set_device (cl::Device device)
	Sets the CL device for which the programs are created. More...

std::string	get_device_version ()
	Return the device version. More...

cl_uint	get_num_compute_units ()
	Return the maximum number of compute units in the device. More...

Kernel	create_kernel (const std::string &kernel_name, const std::set< std::string > &build_options_set={}) const
	Creates a kernel from the kernel library. More...

size_t	max_local_workgroup_size (const cl::Kernel &kernel) const
	Find the maximum number of local work items in a workgroup can be supported for the kernel. More...

cl::NDRange	default_ndrange () const
	Return the default NDRange for the device. More...

void	clear_programs_cache ()
	Clear the library's cache of binary programs. More...

const std::map< std::string, cl::Program > &	get_built_programs () const
	Access the cache of built OpenCL programs. More...

void	add_built_program (const std::string &built_program_name, const cl::Program &program)
	Add a new built program to the cache. More...

bool	fp16_supported () const
	Returns true if FP16 is supported by the CL device. More...

bool	int64_base_atomics_supported () const
	Returns true if int64_base_atomics extension is supported by the CL device. More...

std::string	get_program_name (const std::string &kernel_name) const
	Returns the program name given a kernel name. More...

bool	is_wbsm_supported ()

void	set_context (cl::Context context)
	Sets the CL context used to create programs. More...

CLCompileContext &	get_compile_context ()
	Gets the compile context used. More...

Static Public Member Functions
static CLKernelLibrary &	get ()
	Access the KernelLibrary singleton. More...

Detailed Description

CLKernelLibrary class.

Definition at line 38 of file CLKernelLibrary.h.

Member Function Documentation

◆ add_built_program()

void add_built_program	(	const std::string &	built_program_name,
		const cl::Program &	program
	)

Add a new built program to the cache.

Parameters

[in]	built_program_name	Name of the program
[in]	program	Built program to add to the cache

Definition at line 93 of file CLKernelLibrary.cpp.

 {
     _compile_context.add_built_program(built_program_name, program);
 }

Referenced by arm_compute::restore_program_cache_from_file().

◆ clear_programs_cache()

void clear_programs_cache ( )

Clear the library's cache of binary programs.

Definition at line 85 of file CLKernelLibrary.cpp.

 {
     _compile_context.clear_programs_cache();
 }

Referenced by Framework::run().

◆ context()

cl::Context & context ( )

Accessor for the associated CL context.

Returns: A CL context.

Definition at line 65 of file CLKernelLibrary.cpp.

 {
     return _compile_context.context();
 }

Referenced by ClContext::ClContext(), CLScheduler::context(), and arm_compute::create_image2d_from_tensor().

◆ create_kernel()

Kernel create_kernel	(	const std::string &	kernel_name,
		const std::set< std::string > &	build_options_set = `{}`
	)		const

Creates a kernel from the kernel library.

Parameters

[in]	kernel_name	Kernel name.
[in]	build_options_set	Kernel build options as a set.

Returns: The created kernel.

Definition at line 44 of file CLKernelLibrary.cpp.

 {
     const opencl::ClKernelLibrary &klib         = opencl::ClKernelLibrary::get();
     const std::string              program_name = klib.program_name(kernel_name);
     auto                           program      = klib.program(program_name);
     const std::string             &kernel_path  = CLKernelLibrary::get().get_kernel_path();
     return _compile_context.create_kernel(kernel_name, program_name, program.program, kernel_path, build_options_set, program.is_binary);
 }

References kernel_name, ClKernelLibrary::program(), and ClKernelLibrary::program_name().

◆ default_ndrange()

cl::NDRange default_ndrange ( ) const

Return the default NDRange for the device.

Definition at line 118 of file CLKernelLibrary.cpp.

 {
     return _compile_context.default_ndrange();
 }

Referenced by arm_compute::get_default_lws_for_type().

◆ fp16_supported()

bool fp16_supported ( ) const

Returns true if FP16 is supported by the CL device.

Returns: true if the CL device supports FP16

Definition at line 97 of file CLKernelLibrary.cpp.

 {
     return _compile_context.fp16_supported();
 }

◆ get()

CLKernelLibrary & get ( )

static

Access the KernelLibrary singleton.

This method has been deprecated and will be removed in future releases

Returns: The KernelLibrary instance.

Definition at line 39 of file CLKernelLibrary.cpp.

 {
     static CLKernelLibrary _kernel_library;
     return _kernel_library;
 }

◆ get_built_programs()

const std::map< std::string, cl::Program > & get_built_programs ( ) const

Access the cache of built OpenCL programs.

Definition at line 89 of file CLKernelLibrary.cpp.

 {
     return _compile_context.get_built_programs();
 }

Referenced by OpenCLMemoryUsage::test_measurements().

◆ get_compile_context()

CLCompileContext & get_compile_context ( )

Gets the compile context used.

Returns: The used compile context

Definition at line 130 of file CLKernelLibrary.cpp.

 {
     return _compile_context;
 }

Referenced by CLSynthetizeOperatorInitOutputWithZeroAndWithZeroConstantBorder< K, bordersize >::configure(), and arm_compute::test::validation::TEST_CASE().

◆ get_device()

const cl::Device & get_device ( )

Gets the CL device for which the programs are created.

Definition at line 69 of file CLKernelLibrary.cpp.

 {
     return _compile_context.get_device();
 }

Referenced by ClContext::ClContext(), arm_compute::create_image2d_from_tensor(), arm_compute::export_to_cl_image(), arm_compute::test::validation::TEST_CASE(), and arm_compute::opencl::kernels::gemm::validate_image2d_support_on_rhs().

◆ get_device_version()

std::string get_device_version ( )

Return the device version.

Returns: The content of CL_DEVICE_VERSION

Definition at line 122 of file CLKernelLibrary.cpp.

 {
     return _compile_context.get_device_version();
 }

◆ get_kernel_path()

std::string get_kernel_path ( )

Gets the path that the kernels reside in.

Definition at line 81 of file CLKernelLibrary.cpp.

 {
     return opencl::ClKernelLibrary::get().kernel_path();
 }

Referenced by arm_compute::test::validation::TEST_CASE().

◆ get_num_compute_units()

cl_uint get_num_compute_units ( )

Return the maximum number of compute units in the device.

Returns: The content of CL_DEVICE_MAX_COMPUTE_UNITS

Definition at line 126 of file CLKernelLibrary.cpp.

 {
     return _compile_context.get_num_compute_units();
 }

◆ get_program()

std::pair< std::string, bool > get_program ( const std::string & program_name ) const

Gets the source of the selected program.

Parameters

[in] program_name Program name.

Returns: A pair with the source (false) or the binary (true), of the selected program.

Definition at line 109 of file CLKernelLibrary.cpp.

 {
     auto program_info = opencl::ClKernelLibrary::get().program(program_name);
     return std::make_pair(std::move(program_info.program), program_info.is_binary);
 }

Referenced by arm_compute::test::validation::TEST_CASE().

◆ get_program_name()

std::string get_program_name ( const std::string & kernel_name ) const

Returns the program name given a kernel name.

Returns: Program name

Definition at line 52 of file CLKernelLibrary.cpp.

 {
     return opencl::ClKernelLibrary::get().program_name(kernel_name);
 }

References kernel_name.

Referenced by arm_compute::test::validation::TEST_CASE().

◆ init()

void init	(	std::string	kernel_path,
		cl::Context	context,
		cl::Device	device
	)

Initialises the kernel library.

Parameters

[in]	kernel_path	Path of the directory from which kernel sources are loaded.
[in]	context	CL context used to create programs.
[in]	device	CL device for which the programs are created.

Definition at line 56 of file CLKernelLibrary.cpp.

 {
     _compile_context = CLCompileContext(context, device);
     opencl::ClKernelLibrary::get().set_kernel_path(kernel_path);
 }

References arm_compute::test::validation::context.

Referenced by CLRuntimeContext::CLRuntimeContext(), CLScheduler::default_init(), and CLScheduler::default_init_with_context().

◆ int64_base_atomics_supported()

bool int64_base_atomics_supported ( ) const

Returns true if int64_base_atomics extension is supported by the CL device.

Returns: true if the CL device supports int64_base_atomics extension

Definition at line 101 of file CLKernelLibrary.cpp.

 {
     return _compile_context.int64_base_atomics_supported();
 }

◆ is_wbsm_supported()

bool is_wbsm_supported ( )

Definition at line 105 of file CLKernelLibrary.cpp.

 {
     return _compile_context.is_wbsm_supported();
 }

◆ max_local_workgroup_size()

size_t max_local_workgroup_size ( const cl::Kernel & kernel ) const

Find the maximum number of local work items in a workgroup can be supported for the kernel.

Definition at line 114 of file CLKernelLibrary.cpp.

 {
     return _compile_context.max_local_workgroup_size(kernel);
 }

Referenced by ICLKernel::get_max_workgroup_size().

◆ set_context()

void set_context ( cl::Context context )

Sets the CL context used to create programs.

Note: Setting the context also resets the device to the first one available in the new context.

Parameters

[in] context A CL context.

Definition at line 77 of file CLKernelLibrary.cpp.

 {
     _compile_context.set_context(context);
 }

References arm_compute::test::validation::context.

Referenced by CLScheduler::set_context().

◆ set_device()

void set_device ( cl::Device device )

Sets the CL device for which the programs are created.

Parameters

[in] device A CL device.

Definition at line 73 of file CLKernelLibrary.cpp.

 {
     _compile_context.set_device(device);
 }

◆ set_kernel_path()

void set_kernel_path ( const std::string & kernel_path )

Sets the path that the kernels reside in.

Parameters

[in] kernel_path Path of the kernel.

Definition at line 61 of file CLKernelLibrary.cpp.

 {
     opencl::ClKernelLibrary::get().set_kernel_path(kernel_path);
 }

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

arm_compute/core/CL/CLKernelLibrary.h
src/core/CL/CLKernelLibrary.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ add_built_program()

◆ clear_programs_cache()

◆ context()

◆ create_kernel()

◆ default_ndrange()

◆ fp16_supported()

◆ get()

◆ get_built_programs()

◆ get_compile_context()

◆ get_device()

◆ get_device_version()

◆ get_kernel_path()

◆ get_num_compute_units()

◆ get_program()

◆ get_program_name()

◆ init()

◆ int64_base_atomics_supported()

◆ is_wbsm_supported()

◆ max_local_workgroup_size()

◆ set_context()

◆ set_device()

◆ set_kernel_path()