spla
cl_v_eadd.hpp
Go to the documentation of this file.
1 /**********************************************************************************/
2 /* This file is part of spla project */
3 /* https://github.com/JetBrains-Research/spla */
4 /**********************************************************************************/
5 /* MIT License */
6 /* */
7 /* Copyright (c) 2023 SparseLinearAlgebra */
8 /* */
9 /* Permission is hereby granted, free of charge, to any person obtaining a copy */
10 /* of this software and associated documentation files (the "Software"), to deal */
11 /* in the Software without restriction, including without limitation the rights */
12 /* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell */
13 /* copies of the Software, and to permit persons to whom the Software is */
14 /* furnished to do so, subject to the following conditions: */
15 /* */
16 /* The above copyright notice and this permission notice shall be included in all */
17 /* copies or substantial portions of the Software. */
18 /* */
19 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR */
20 /* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, */
21 /* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE */
22 /* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER */
23 /* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, */
24 /* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE */
25 /* SOFTWARE. */
26 /**********************************************************************************/
27 
28 #ifndef SPLA_CL_VECTOR_HPP
29 #define SPLA_CL_VECTOR_HPP
30 
32 
33 #include <core/dispatcher.hpp>
34 #include <core/registry.hpp>
35 #include <core/top.hpp>
36 #include <core/tscalar.hpp>
37 #include <core/ttype.hpp>
38 #include <core/tvector.hpp>
39 
40 #include <opencl/cl_counter.hpp>
41 #include <opencl/cl_fill.hpp>
42 #include <opencl/cl_formats.hpp>
44 
45 #include <sstream>
46 
47 namespace spla {
48 
49  template<typename T>
50  class Algo_v_eadd_cl final : public RegistryAlgo {
51  public:
52  ~Algo_v_eadd_cl() override = default;
53 
54  std::string get_name() override {
55  return "v_eadd";
56  }
57 
58  std::string get_description() override {
59  return "parallel vector element-wise add on opencl device";
60  }
61 
62  Status execute(const DispatchContext& ctx) override {
63  auto t = ctx.task.template cast_safe<ScheduleTask_v_eadd>();
64  ref_ptr<TVector<T>> u = t->u.template cast_safe<TVector<T>>();
65  ref_ptr<TVector<T>> v = t->v.template cast_safe<TVector<T>>();
66 
67  if (u->is_valid(FormatVector::AccDense) && v->is_valid(FormatVector::AccDense)) {
68  return execute_dn2dn(ctx);
69  }
70 
71  return execute_dn2dn(ctx);
72  }
73 
74  private:
75  Status execute_dn2dn(const DispatchContext& ctx) {
76  TIME_PROFILE_SCOPE("cl/vector_eadd_dn2dn");
77 
78  auto t = ctx.task.template cast_safe<ScheduleTask_v_eadd>();
79  ref_ptr<TVector<T>> r = t->r.template cast_safe<TVector<T>>();
80  ref_ptr<TVector<T>> u = t->u.template cast_safe<TVector<T>>();
81  ref_ptr<TVector<T>> v = t->v.template cast_safe<TVector<T>>();
82  ref_ptr<TOpBinary<T, T, T>> op = t->op.template cast_safe<TOpBinary<T, T, T>>();
83 
84  std::shared_ptr<CLProgram> program;
85  if (!ensure_kernel(op, program)) return Status::CompilationError;
86 
87  r->validate_wd(FormatVector::AccDense);
88  u->validate_rw(FormatVector::AccDense);
89  v->validate_rw(FormatVector::AccDense);
90 
91  auto* p_cl_r = r->template get<CLDenseVec<T>>();
92  const auto* p_cl_u = u->template get<CLDenseVec<T>>();
93  const auto* p_cl_v = v->template get<CLDenseVec<T>>();
94  auto* p_cl_acc = get_acc_cl();
95  auto& queue = p_cl_acc->get_queue_default();
96 
97  const uint n = r->get_n_rows();
98 
99  auto kernel = program->make_kernel("dense_to_dense");
100  kernel.setArg(0, p_cl_r->Ax);
101  kernel.setArg(1, p_cl_u->Ax);
102  kernel.setArg(2, p_cl_v->Ax);
103  kernel.setArg(3, n);
104 
105  cl::NDRange global(p_cl_acc->get_default_wgs() * div_up_clamp(n, p_cl_acc->get_default_wgs(), 1u, 1024u));
106  cl::NDRange local(p_cl_acc->get_default_wgs());
107  queue.enqueueNDRangeKernel(kernel, cl::NullRange, global, local);
108 
109  return Status::Ok;
110  }
111 
112  bool ensure_kernel(const ref_ptr<TOpBinary<T, T, T>>& op, std::shared_ptr<CLProgram>& program) {
113  CLProgramBuilder program_builder;
114  program_builder
115  .set_name("vector_eadd")
116  .add_type("TYPE", get_ttype<T>().template as<Type>())
117  .add_op("OP_BINARY", op.template as<OpBinary>())
118  .set_source(source_vector_eadd)
119  .acquire();
120 
121  program = program_builder.get_program();
122 
123  return true;
124  }
125  };
126 
127 }// namespace spla
128 
129 #endif//SPLA_CL_VECTOR_HPP
Status of library operation execution.
Definition: cl_v_eadd.hpp:50
std::string get_description() override
Definition: cl_v_eadd.hpp:58
Status execute(const DispatchContext &ctx) override
Definition: cl_v_eadd.hpp:62
~Algo_v_eadd_cl() override=default
std::string get_name() override
Definition: cl_v_eadd.hpp:54
Algorithm suitable to process schedule task based on task string key.
Definition: registry.hpp:66
Automates reference counting and behaves as shared smart pointer.
Definition: ref.hpp:117
std::uint32_t uint
Library index and size type.
Definition: config.hpp:56
Definition: algorithm.hpp:37
Execution context of a single task.
Definition: dispatcher.hpp:46
ref_ptr< ScheduleTask > task
Definition: dispatcher.hpp:48
#define TIME_PROFILE_SCOPE(name)
Definition: time_profiler.hpp:92