Compute Library
 21.05
ClFillKernel Class Reference

Interface for filling the planes of a tensor. More...

#include <ClFillKernel.h>

Collaboration diagram for ClFillKernel:
[legend]

Public Member Functions

 ClFillKernel ()=default
 
 ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE (ClFillKernel)
 
void configure (ITensorInfo *tensor, const PixelValue &constant_value, Window *window=nullptr)
 Initialise the kernel's tensor and filling value. More...
 
void configure (const CLCompileContext &compile_context, ITensorInfo *tensor, const PixelValue &constant_value, Window *window=nullptr)
 Initialise the kernel's tensor and filling value. More...
 
void run_op (ITensorPack &tensors, const Window &window, cl::CommandQueue &queue) override
 Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. More...
 
- Public Member Functions inherited from ICLKernel
 ICLKernel ()
 Constructor. More...
 
cl::Kernel & kernel ()
 Returns a reference to the OpenCL kernel of this object. More...
 
template<typename T >
void add_1D_array_argument (unsigned int &idx, const ICLArray< T > *array, const Strides &strides, unsigned int num_dimensions, const Window &window)
 Add the passed 1D array's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_1D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 1D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_1D_tensor_argument_if (bool cond, unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 1D tensor's parameters to the object's kernel's arguments starting from the index idx if the condition is true. More...
 
void add_2D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 2D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_2D_tensor_argument_if (bool cond, unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 2D tensor's parameters to the object's kernel's arguments starting from the index idx if the condition is true. More...
 
void add_3D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 3D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_4D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 4D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
virtual void run (const Window &window, cl::CommandQueue &queue)
 Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. More...
 
template<typename T >
void add_argument (unsigned int &idx, T value)
 Add the passed parameters to the object's kernel's arguments starting from the index idx. More...
 
void set_lws_hint (const cl::NDRange &lws_hint)
 Set the Local-Workgroup-Size hint. More...
 
cl::NDRange lws_hint () const
 Return the Local-Workgroup-Size hint. More...
 
void set_wbsm_hint (const cl_int &wbsm_hint)
 Set the workgroup batch size modifier hint. More...
 
cl_int wbsm_hint () const
 Return the workgroup batch size modifier hint. More...
 
const std::string & config_id () const
 Get the configuration ID. More...
 
void set_target (GPUTarget target)
 Set the targeted GPU architecture. More...
 
void set_target (cl::Device &device)
 Set the targeted GPU architecture according to the CL device. More...
 
GPUTarget get_target () const
 Get the targeted GPU architecture. More...
 
size_t get_max_workgroup_size ()
 Get the maximum workgroup size for the device the CLKernelLibrary uses. More...
 
template<unsigned int dimension_size>
void add_tensor_argument (unsigned &idx, const ICLTensor *tensor, const Window &window)
 
template<typename T , unsigned int dimension_size>
void add_array_argument (unsigned &idx, const ICLArray< T > *array, const Strides &strides, unsigned int num_dimensions, const Window &window)
 Add the passed array's parameters to the object's kernel's arguments starting from the index idx. More...
 
- Public Member Functions inherited from IKernel
 IKernel ()
 Constructor. More...
 
virtual ~IKernel ()=default
 Destructor. More...
 
virtual bool is_parallelisable () const
 Indicates whether or not the kernel is parallelisable. More...
 
virtual BorderSize border_size () const
 The size of the border for that kernel. More...
 
const Windowwindow () const
 The maximum window the kernel can be executed on. More...
 
bool is_window_configured () const
 Function to check if the embedded window of this kernel has been configured. More...
 

Static Public Member Functions

static Status validate (const ITensorInfo *tensor, const PixelValue &constant_value, Window *window=nullptr)
 Static function to check if given info will lead to a valid configuration of ClFillKernel. More...
 
- Static Public Member Functions inherited from ICLKernel
static constexpr unsigned int num_arguments_per_1D_array ()
 Returns the number of arguments enqueued per 1D array object. More...
 
static constexpr unsigned int num_arguments_per_1D_tensor ()
 Returns the number of arguments enqueued per 1D tensor object. More...
 
static constexpr unsigned int num_arguments_per_2D_tensor ()
 Returns the number of arguments enqueued per 2D tensor object. More...
 
static constexpr unsigned int num_arguments_per_3D_tensor ()
 Returns the number of arguments enqueued per 3D tensor object. More...
 
static constexpr unsigned int num_arguments_per_4D_tensor ()
 Returns the number of arguments enqueued per 4D tensor object. More...
 
static cl::NDRange gws_from_window (const Window &window)
 Get the global work size given an execution window. More...
 

Detailed Description

Interface for filling the planes of a tensor.

Definition at line 38 of file ClFillKernel.h.

Constructor & Destructor Documentation

◆ ClFillKernel()

ClFillKernel ( )
default

Member Function Documentation

◆ ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE()

ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE ( ClFillKernel  )

◆ configure() [1/2]

void configure ( ITensorInfo tensor,
const PixelValue constant_value,
Window window = nullptr 
)

Initialise the kernel's tensor and filling value.

Parameters
[in,out]tensorInput tensor info. Supported data types: All.
[in]constant_valueThe value used to fill the planes of the tensor
[in]windowWindow to be used in case setting only part of a tensor. Default is nullptr.

Definition at line 45 of file ClFillKernel.cpp.

48 {
49  configure(CLKernelLibrary::get().get_compile_context(), tensor, constant_value, window);
50 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
void configure(ITensorInfo *tensor, const PixelValue &constant_value, Window *window=nullptr)
Initialise the kernel's tensor and filling value.

References ClFillKernel::configure(), CLKernelLibrary::get(), and IKernel::window().

Referenced by ClFillKernel::configure().

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
ITensorInfo tensor,
const PixelValue constant_value,
Window window = nullptr 
)

Initialise the kernel's tensor and filling value.

Parameters
[in]compile_contextThe compile context to be used.
[in,out]tensorInput tensor info. Supported data types: All.
[in]constant_valueThe value used to fill the planes of the tensor
[in]windowWindow to be used in case setting only part of a tensor. Default is nullptr.

Definition at line 52 of file ClFillKernel.cpp.

55 {
57  ARM_COMPUTE_ERROR_THROW_ON(validate(tensor, constant_value, window));
58 
59  const DataType data_type = tensor->data_type();
60  const int vec_size_x = 16 / tensor->element_size();
61 
62  // Create and update the window (if needed)
63  _full_window = calculate_max_window(*tensor);
64  Window win = _full_window;
65  if(window != nullptr)
66  {
68  win = *window;
69  }
70 
71  const int output_width_x = win.num_iterations(0);
72  const bool multi_access_x = output_width_x >= vec_size_x;
73  const bool remainder_x = output_width_x % vec_size_x > 0;
74 
75  if(multi_access_x)
76  {
77  win.set(Window::DimX, Window::Dimension(win.x().start(), ceil_to_multiple(win.x().end(), vec_size_x), vec_size_x));
78  }
79  ICLKernel::configure_internal(win);
80 
81  // Create kernel
82  CLBuildOptions build_opts;
83  build_opts.add_option("-DDATA_TYPE=" + get_cl_type_from_data_type(data_type));
84  build_opts.add_option("-DCONSTANT_VALUE=" + string_from_pixel_value(constant_value, data_type));
85  build_opts.add_option_if(multi_access_x, "-DVEC_SIZE=" + support::cpp11::to_string(vec_size_x));
86  build_opts.add_option_if(multi_access_x && remainder_x, "-DLAST_ACCESSED_X=" + support::cpp11::to_string(std::max<int>(output_width_x - vec_size_x, 0)));
87  _kernel = create_kernel(compile_context, "memset", build_opts.options());
88 }
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
std::string to_string(T &&value)
Convert integer and float values to string.
std::string string_from_pixel_value(const PixelValue &value, const DataType data_type)
Convert a PixelValue to a string, represented through the specific data type.
Definition: Utils.cpp:248
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
constexpr size_t num_iterations(size_t dimension) const
Return the number of iterations needed to iterate through a given dimension.
Definition: Window.inl:182
const DataType data_type
Definition: Im2Col.cpp:150
cl::Kernel create_kernel(const CLCompileContext &ctx, const std::string &kernel_name, const std::set< std::string > &build_opts=std::set< std::string >())
Creates an opencl kernel using a compile context.
Definition: CLHelpers.cpp:403
static constexpr size_t DimX
Alias for dimension 0 also known as X dimension.
Definition: Window.h:43
auto ceil_to_multiple(S value, T divisor) -> decltype(((value+divisor - 1)/divisor) *divisor)
Computes the smallest number larger or equal to value that is a multiple of divisor.
Definition: Utils.h:71
std::string get_cl_type_from_data_type(const DataType &dt)
Translates a tensor data type to the appropriate OpenCL type.
Definition: CLHelpers.cpp:37
static Status validate(const ITensorInfo *tensor, const PixelValue &constant_value, Window *window=nullptr)
Static function to check if given info will lead to a valid configuration of ClFillKernel.
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:157
DataType
Available data types.
Definition: Types.h:77
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:201

References CLBuildOptions::add_option(), CLBuildOptions::add_option_if(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::calculate_max_window(), arm_compute::ceil_to_multiple(), arm_compute::create_kernel(), arm_compute::test::validation::data_type, ITensorInfo::data_type(), Window::DimX, ITensorInfo::element_size(), Window::Dimension::end(), arm_compute::get_cl_type_from_data_type(), Window::num_iterations(), CLBuildOptions::options(), Window::set(), Window::Dimension::start(), arm_compute::string_from_pixel_value(), arm_compute::support::cpp11::to_string(), ClFillKernel::validate(), IKernel::window(), and Window::x().

◆ run_op()

void run_op ( ITensorPack tensors,
const Window window,
cl::CommandQueue &  queue 
)
overridevirtual

Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.

Note
The queue is not flushed by this method, and therefore the kernel will not have been executed by the time this method returns.
Parameters
[in]tensorsA vector containing the tensors to operato on.
[in]windowRegion on which to execute the kernel. (Must be a valid region of the window returned by window()).
[in,out]queueCommand queue on which to enqueue the kernel.

Reimplemented from ICLKernel.

Definition at line 101 of file ClFillKernel.cpp.

102 {
105 
106  const auto tensor = utils::cast::polymorphic_downcast<const ICLTensor *>(tensors.get_const_tensor(TensorType::ACL_SRC));
107 
108  // Collapse all the batches on the third
109  Window collapsed = window.collapse_if_possible(_full_window, Window::DimZ);
110  Window slice = collapsed.first_slice_window_3D();
111 
112  do
113  {
114  unsigned int idx = 0;
115  add_3D_tensor_argument(idx, tensor, slice);
116  enqueue(queue, *this, slice, lws_hint());
117  }
118  while(collapsed.slide_window_slice_3D(slice));
119 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
void enqueue(cl::CommandQueue &queue, ICLKernel &kernel, const Window &window, const cl::NDRange &lws_hint=CLKernelLibrary::get().default_ndrange(), bool use_dummy_work_items=false)
Add the kernel to the command queue with the given window.
Definition: ICLKernel.cpp:32
cl::NDRange lws_hint() const
Return the Local-Workgroup-Size hint.
Definition: ICLKernel.h:276
void add_3D_tensor_argument(unsigned int &idx, const ICLTensor *tensor, const Window &window)
Add the passed 3D tensor's parameters to the object's kernel's arguments starting from the index idx.
Definition: ICLKernel.h:172
Window collapse_if_possible(const Window &full_window, size_t first, size_t last, bool *has_collapsed=nullptr) const
Collapse the dimensions between first and last if possible.
Definition: Window.inl:68
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:915
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:201
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

References arm_compute::ACL_SRC, ICLKernel::add_3D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, Window::collapse_if_possible(), Window::DimZ, arm_compute::enqueue(), ITensorPack::get_const_tensor(), ICLKernel::lws_hint(), arm_compute::test::validation::reference::slice(), and IKernel::window().

◆ validate()

Status validate ( const ITensorInfo tensor,
const PixelValue constant_value,
Window window = nullptr 
)
static

Static function to check if given info will lead to a valid configuration of ClFillKernel.

Parameters
[in]tensorSource tensor info. Data types supported: All.
[in]constant_valueThe value used to fill the planes of the tensor
[in]windowWindow to be used in case setting only part of a tensor. Default is nullptr.
Returns
a status

Definition at line 90 of file ClFillKernel.cpp.

91 {
92  ARM_COMPUTE_UNUSED(tensor);
93  ARM_COMPUTE_UNUSED(constant_value);
94  if(window != nullptr)
95  {
97  }
98  return Status{};
99 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
constexpr int step() const
Return the step of the dimension.
Definition: Window.h:104
#define ARM_COMPUTE_RETURN_ERROR_ON(cond)
If the condition is true, an error is returned.
Definition: Error.h:296
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
constexpr const Dimension & x() const
Alias to access the first dimension of the window.
Definition: Window.h:145

References ARM_COMPUTE_RETURN_ERROR_ON, ARM_COMPUTE_UNUSED, Window::Dimension::step(), IKernel::window(), and Window::x().

Referenced by ClFillKernel::configure(), and ClFill::validate().


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