Compute Library
 21.11
CLFFTRadixStageKernel Class Reference

Interface for the FFT radix stage kernel. More...

#include <CLFFTRadixStageKernel.h>

Collaboration diagram for CLFFTRadixStageKernel:
[legend]

Public Member Functions

 CLFFTRadixStageKernel ()
 Constructor. More...
 
 CLFFTRadixStageKernel (const CLFFTRadixStageKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLFFTRadixStageKerneloperator= (const CLFFTRadixStageKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLFFTRadixStageKernel (CLFFTRadixStageKernel &&)=default
 Default Move Constructor. More...
 
CLFFTRadixStageKerneloperator= (CLFFTRadixStageKernel &&)=default
 Default move assignment operator. More...
 
 ~CLFFTRadixStageKernel ()=default
 Default destructor. More...
 
void configure (ICLTensor *input, ICLTensor *output, const FFTRadixStageKernelInfo &config)
 Set the input and output tensors. More...
 
void configure (const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const FFTRadixStageKernelInfo &config)
 Set the input and output tensors. More...
 
void run (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...
 
CLKernelType type () const
 Returns the CL kernel type. 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_op (ITensorPack &tensors, 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 *input, const ITensorInfo *output, const FFTRadixStageKernelInfo &config)
 Static function to check if given info will lead to a valid configuration of CLFFTRadixStageKernel. More...
 
static std::set< unsigned int > supported_radix ()
 Returns the radix that are support by the FFT kernel. 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 the FFT radix stage kernel.

Definition at line 39 of file CLFFTRadixStageKernel.h.

Constructor & Destructor Documentation

◆ CLFFTRadixStageKernel() [1/3]

Constructor.

Definition at line 78 of file CLFFTRadixStageKernel.cpp.

References arm_compute::ELEMENTWISE.

79  : _input(nullptr), _output(nullptr), _run_in_place(false)
80 {
82 }
Elementeise CL kernel type.
Definition: CLTypes.h:84

◆ CLFFTRadixStageKernel() [2/3]

Prevent instances of this class from being copied (As this class contains pointers)

◆ CLFFTRadixStageKernel() [3/3]

Default Move Constructor.

◆ ~CLFFTRadixStageKernel()

~CLFFTRadixStageKernel ( )
default

Default destructor.

Member Function Documentation

◆ configure() [1/2]

void configure ( ICLTensor input,
ICLTensor output,
const FFTRadixStageKernelInfo config 
)

Set the input and output tensors.

Note
If the output tensor is nullptr, the FFT will be performed in-place
Parameters
[in,out]inputSource tensor. Data types supported: F16/F32.
[out]outputDestination tensor. Can be nullptr. Data type supported: same as input
[in]configFFT descriptor metadata.

Definition at line 84 of file CLFFTRadixStageKernel.cpp.

References CLKernelLibrary::get().

85 {
86  configure(CLKernelLibrary::get().get_compile_context(), input, output, config);
87 }
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
void configure(ICLTensor *input, ICLTensor *output, const FFTRadixStageKernelInfo &config)
Set the input and output tensors.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
ICLTensor input,
ICLTensor output,
const FFTRadixStageKernelInfo config 
)

Set the input and output tensors.

Note
If the output tensor is nullptr, the FFT will be performed in-place
Parameters
[in]compile_contextThe compile context to be used.
[in,out]inputSource tensor. Data types supported: F16/F32.
[out]outputDestination tensor. Can be nullptr. Data type supported: same as input
[in]configFFT descriptor metadata.

Definition at line 89 of file CLFFTRadixStageKernel.cpp.

References CLBuildOptions::add_option(), CLBuildOptions::add_option_if(), ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, FFTRadixStageKernelInfo::axis, arm_compute::create_kernel(), ITensorInfo::data_type(), ITensorInfo::dimension(), arm_compute::get_cl_type_from_data_type(), arm_compute::get_padding_info(), arm_compute::has_padding_changed(), ITensor::info(), arm_compute::test::validation::input, FFTRadixStageKernelInfo::is_first_stage, kernel_name, arm_compute::lower_string(), M_PI, ICLKernel::num_arguments_per_3D_tensor(), FFTRadixStageKernelInfo::Nx, CLBuildOptions::options(), FFTRadixStageKernelInfo::radix, arm_compute::string_from_data_type(), and arm_compute::support::cpp11::to_string().

90 {
92  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), (output != nullptr) ? output->info() : nullptr, config));
93  auto padding_info = get_padding_info({ input, output });
94 
95  _input = input;
96  _output = output;
97  _run_in_place = (output == nullptr) || (output == input);
98 
99  // Create build options
100  CLBuildOptions build_opts;
101  build_opts.add_option("-DDATA_TYPE=" + get_cl_type_from_data_type(input->info()->data_type()));
102  build_opts.add_option_if(_run_in_place, "-DIN_PLACE");
103 
104  // Create kernel
105  std::string kernel_name = "fft";
106  kernel_name += "_radix_" + support::cpp11::to_string(config.radix);
107  kernel_name += (config.is_first_stage) ? "_first_stage" : "";
108  kernel_name += "_axis_" + support::cpp11::to_string(config.axis);
109  _kernel = create_kernel(compile_context, kernel_name, build_opts.options());
110 
111  // Set static arguments if not the first stage
112  if(!config.is_first_stage)
113  {
114  const unsigned int Ni = config.Nx * config.radix;
115  const float exp_const = (-2.0 * M_PI) / static_cast<float>(Ni);
116  unsigned int idx = (1 + (_run_in_place ? 0 : 1)) * num_arguments_per_3D_tensor(); // Skip the input and output parameters
117  _kernel.setArg<cl_uint>(idx++, config.Nx);
118  _kernel.setArg<cl_uint>(idx++, Ni);
119  _kernel.setArg<cl_float>(idx, exp_const);
120  }
121 
122  // Configure kernel window
123  auto win_config = validate_and_configure_window(input->info(), (_run_in_place) ? nullptr : output->info(), config);
124  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
125  ICLKernel::configure_internal(win_config.second);
126 
127  // Set config_id for enabling LWS tuning
128  _config_id = kernel_name;
129  _config_id += "_";
130  _config_id += lower_string(string_from_data_type(input->info()->data_type()));
131  _config_id += "_";
132  _config_id += support::cpp11::to_string(input->info()->dimension(0));
133  _config_id += "_";
134  _config_id += support::cpp11::to_string(input->info()->dimension(1));
136 }
std::string to_string(T &&value)
Convert integer and float values to string.
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:466
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
#define M_PI
std::string lower_string(const std::string &val)
Lower a given string.
Definition: Utils.cpp:326
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:391
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
Definition: Utils.cpp:135
static constexpr unsigned int num_arguments_per_3D_tensor()
Returns the number of arguments enqueued per 3D tensor object.
Definition: ICLKernel.h:256
std::string get_cl_type_from_data_type(const DataType &dt)
Translates a tensor data type to the appropriate OpenCL type.
Definition: CLHelpers.cpp:39
bool has_padding_changed(const std::unordered_map< const ITensorInfo *, PaddingSize > &padding_map)
Check if the previously stored padding info has changed after configuring a kernel.
Definition: Utils.cpp:533
std::unordered_map< const ITensorInfo *, PaddingSize > get_padding_info(std::initializer_list< const ITensorInfo *> infos)
Stores padding information before configuring a kernel.
Definition: Utils.cpp:518
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:157
std::string kernel_name

◆ operator=() [1/2]

CLFFTRadixStageKernel& operator= ( const CLFFTRadixStageKernel )
delete

Prevent instances of this class from being copied (As this class contains pointers)

◆ operator=() [2/2]

CLFFTRadixStageKernel& operator= ( CLFFTRadixStageKernel &&  )
default

Default move assignment operator.

◆ run()

void run ( 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]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 155 of file CLFFTRadixStageKernel.cpp.

References 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(), Window::first_slice_window_3D(), ICLKernel::lws_hint(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_3D(), and IKernel::window().

156 {
159 
161  Window slice = collapsed.first_slice_window_3D();
162 
163  do
164  {
165  unsigned int idx = 0;
166  add_3D_tensor_argument(idx, _input, slice);
167  if(!_run_in_place)
168  {
169  add_3D_tensor_argument(idx, _output, slice);
170  }
171  enqueue(queue, *this, slice, lws_hint());
172  }
173  while(collapsed.slide_window_slice_3D(slice));
174 }
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:318
void add_3D_tensor_argument(unsigned int &idx, const ICLTensor *tensor, const Window &window)
Add the passed 3D tensor&#39;s parameters to the object&#39;s kernel&#39;s arguments starting from the index idx...
Definition: ICLKernel.h:214
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)

◆ supported_radix()

std::set< unsigned int > supported_radix ( )
static

Returns the radix that are support by the FFT kernel.

Returns
A set of supported radix

Definition at line 150 of file CLFFTRadixStageKernel.cpp.

Referenced by CLFFT1D::configure(), and CLFFT1D::validate().

151 {
152  return std::set<unsigned int> { 2, 3, 4, 5, 7, 8 };
153 }

◆ validate()

Status validate ( const ITensorInfo input,
const ITensorInfo output,
const FFTRadixStageKernelInfo config 
)
static

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

Parameters
[in]inputSource tensor info. Data types supported: F16/F32.
[in]outputDestination tensor info. Can be nullptr. Data type supported: same as input
[in]configFFT descriptor metadata.
Returns
a status

Definition at line 138 of file CLFFTRadixStageKernel.cpp.

References ARM_COMPUTE_RETURN_ON_ERROR, and ICloneable< T >::clone().

139 {
140  const bool run_in_place = (output == nullptr) || (output == input);
141  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, output, config));
142  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(input->clone().get(),
143  (run_in_place) ? nullptr : output->clone().get(),
144  config)
145  .first);
146 
147  return Status{};
148 }
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204

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