diff options
| -rw-r--r-- | CMakeLists.txt | 2 | ||||
| -rw-r--r-- | include/clblast.h | 11 | ||||
| -rw-r--r-- | include/internal/routines/level2/xsymv.h | 58 | ||||
| -rw-r--r-- | src/clblast.cc | 42 | ||||
| -rw-r--r-- | src/routines/level2/xgemv.cc | 3 | ||||
| -rw-r--r-- | src/routines/level2/xsymv.cc | 100 | ||||
| -rw-r--r-- | test/correctness/routines/level2/xsymv.cc | 26 | ||||
| -rw-r--r-- | test/performance/routines/level2/xsymv.cc | 36 | ||||
| -rw-r--r-- | test/routines/level2/xsymv.h | 130 | ||||
| -rw-r--r-- | test/wrapper_clblas.h | 28 |
10 files changed, 434 insertions, 2 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt index 89dc0fd9..45429dfa 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -105,7 +105,7 @@ include_directories(${clblast_SOURCE_DIR}/include ${OPENCL_INCLUDE_DIRS}) set(KERNELS copy pad transpose padtranspose xaxpy xgemv xgemm) set(SAMPLE_PROGRAMS sgemm) set(LEVEL1_ROUTINES xaxpy) -set(LEVEL2_ROUTINES xgemv) +set(LEVEL2_ROUTINES xgemv xsymv) set(LEVEL3_ROUTINES xgemm xsymm xhemm xsyrk xherk xsyr2k xher2k xtrmm) set(ROUTINES ${LEVEL1_ROUTINES} ${LEVEL2_ROUTINES} ${LEVEL3_ROUTINES}) diff --git a/include/clblast.h b/include/clblast.h index 80ea1707..93acc03d 100644 --- a/include/clblast.h +++ b/include/clblast.h @@ -105,6 +105,17 @@ StatusCode Gemv(const Layout layout, const Transpose a_transpose, cl_mem y_buffer, const size_t y_offset, const size_t y_inc, cl_command_queue* queue, cl_event* event); +// Templated-precision symmetric matrix-vector multiplication: SSYMV/DSYMV +template <typename T> +StatusCode Symv(const Layout layout, const Triangle triangle, + const size_t n, + const T alpha, + const cl_mem a_buffer, const size_t a_offset, const size_t a_ld, + const cl_mem x_buffer, const size_t x_offset, const size_t x_inc, + const T beta, + cl_mem y_buffer, const size_t y_offset, const size_t y_inc, + cl_command_queue* queue, cl_event* event); + // ================================================================================================= // BLAS level-3 (matrix-matrix) routines diff --git a/include/internal/routines/level2/xsymv.h b/include/internal/routines/level2/xsymv.h new file mode 100644 index 00000000..d6a36489 --- /dev/null +++ b/include/internal/routines/level2/xsymv.h @@ -0,0 +1,58 @@ + +// ================================================================================================= +// This file is part of the CLBlast project. The project is licensed under Apache Version 2.0. This +// project loosely follows the Google C++ styleguide and uses a tab-size of two spaces and a max- +// width of 100 characters per line. +// +// Author(s): +// Cedric Nugteren <www.cedricnugteren.nl> +// +// This file implements the Xsymv routine. It is based on the generalized mat-vec multiplication +// routine (Xgemv). The Xsymv class inherits from the templated class Xgemv, allowing it to call the +// "DoGemm" function directly. The "DoSymv" function first preprocesses the symmetric matrix by +// transforming it into a general matrix, and then calls the regular GEMV code. +// +// ================================================================================================= + +#ifndef CLBLAST_ROUTINES_XSYMV_H_ +#define CLBLAST_ROUTINES_XSYMV_H_ + +#include "internal/routines/level2/xgemv.h" + +namespace clblast { +// ================================================================================================= + +// See comment at top of file for a description of the class +template <typename T> +class Xsymv: public Xgemv<T> { + public: + + // Members and methods from the base class + using Routine<T>::db_; + using Routine<T>::context_; + using Routine<T>::GetProgramFromCache; + using Routine<T>::TestMatrixA; + using Routine<T>::RunKernel; + using Routine<T>::ErrorIn; + + // Uses the regular Xgemv routine + using Xgemv<T>::DoGemv; + + // Constructor + Xsymv(Queue &queue, Event &event); + + // Templated-precision implementation of the routine + StatusCode DoSymv(const Layout layout, const Triangle triangle, + const size_t n, + const T alpha, + const Buffer<T> &a_buffer, const size_t a_offset, const size_t a_ld, + const Buffer<T> &x_buffer, const size_t x_offset, const size_t x_inc, + const T beta, + const Buffer<T> &y_buffer, const size_t y_offset, const size_t y_inc); +}; + +// ================================================================================================= +} // namespace clblast + +// CLBLAST_ROUTINES_XSYMV_H_ +#endif diff --git a/src/clblast.cc b/src/clblast.cc index eddb8022..c04462f3 100644 --- a/src/clblast.cc +++ b/src/clblast.cc @@ -22,6 +22,7 @@ // BLAS level-2 includes #include "internal/routines/level2/xgemv.h" +#include "internal/routines/level2/xsymv.h" // BLAS level-3 includes #include "internal/routines/level3/xgemm.h" @@ -36,6 +37,7 @@ namespace clblast { // ================================================================================================= // BLAS level-1 (vector-vector) routines +// ================================================================================================= // AXPY template <typename T> @@ -75,6 +77,7 @@ template StatusCode Axpy<double2>(const size_t, const double2, // ================================================================================================= // BLAS level-2 (matrix-vector) routines +// ================================================================================================= // GEMV template <typename T> @@ -125,7 +128,46 @@ template StatusCode Gemv<double2>(const Layout, const Transpose, cl_command_queue*, cl_event*); // ================================================================================================= + +// SYMV +template <typename T> +StatusCode Symv(const Layout layout, const Triangle triangle, + const size_t n, const T alpha, + const cl_mem a_buffer, const size_t a_offset, const size_t a_ld, + const cl_mem x_buffer, const size_t x_offset, const size_t x_inc, const T beta, + cl_mem y_buffer, const size_t y_offset, const size_t y_inc, + cl_command_queue* queue, cl_event* event) { + + auto queue_cpp = Queue(*queue); + auto event_cpp = Event(*event); + auto routine = Xsymv<T>(queue_cpp, event_cpp); + + // Compiles the routine's device kernels + auto status = routine.SetUp(); + if (status != StatusCode::kSuccess) { return status; } + + // Runs the routine + return routine.DoSymv(layout, triangle, n, alpha, + Buffer<T>(a_buffer), a_offset, a_ld, + Buffer<T>(x_buffer), x_offset, x_inc, beta, + Buffer<T>(y_buffer), y_offset, y_inc); +} +template StatusCode Symv<float>(const Layout, const Triangle, + const size_t, const float, + const cl_mem, const size_t, const size_t, + const cl_mem, const size_t, const size_t, const float, + cl_mem, const size_t, const size_t, + cl_command_queue*, cl_event*); +template StatusCode Symv<double>(const Layout, const Triangle, + const size_t, const double, + const cl_mem, const size_t, const size_t, + const cl_mem, const size_t, const size_t, const double, + cl_mem, const size_t, const size_t, + cl_command_queue*, cl_event*); + +// ================================================================================================= // BLAS level-3 (matrix-matrix) routines +// ================================================================================================= // GEMM template <typename T> diff --git a/src/routines/level2/xgemv.cc b/src/routines/level2/xgemv.cc index 75219b63..7505e9f7 100644 --- a/src/routines/level2/xgemv.cc +++ b/src/routines/level2/xgemv.cc @@ -30,8 +30,9 @@ template <> const Precision Xgemv<double2>::precision_ = Precision::kComplexDoub // Constructor: forwards to base class constructor template <typename T> Xgemv<T>::Xgemv(Queue &queue, Event &event): - Routine<T>(queue, event, "GEMV", {"Xgemv"}, precision_) { + Routine<T>(queue, event, "GEMV", {"Pad", "Xgemv"}, precision_) { source_string_ = + #include "../../kernels/pad.opencl" // For SymmUpperToSquared and SymmLowerToSquared (for SYMV) #include "../../kernels/xgemv.opencl" ; } diff --git a/src/routines/level2/xsymv.cc b/src/routines/level2/xsymv.cc new file mode 100644 index 00000000..1b0ab6d7 --- /dev/null +++ b/src/routines/level2/xsymv.cc @@ -0,0 +1,100 @@ + +// ================================================================================================= +// This file is part of the CLBlast project. The project is licensed under Apache Version 2.0. This +// project loosely follows the Google C++ styleguide and uses a tab-size of two spaces and a max- +// width of 100 characters per line. +// +// Author(s): +// Cedric Nugteren <www.cedricnugteren.nl> +// +// This file implements the Xsymv class (see the header for information about the class). +// +// ================================================================================================= + +#include "internal/routines/level2/xsymv.h" + +#include <string> +#include <vector> + +namespace clblast { +// ================================================================================================= + +// Constructor: forwards to base class constructor +template <typename T> +Xsymv<T>::Xsymv(Queue &queue, Event &event): + Xgemv<T>(queue, event) { +} + +// ================================================================================================= + +// The main routine +template <typename T> +StatusCode Xsymv<T>::DoSymv(const Layout layout, const Triangle triangle, + const size_t n, + const T alpha, + const Buffer<T> &a_buffer, const size_t a_offset, const size_t a_ld, + const Buffer<T> &x_buffer, const size_t x_offset, const size_t x_inc, + const T beta, + const Buffer<T> &y_buffer, const size_t y_offset, const size_t y_inc) { + + // Makes sure all dimensions are larger than zero + if (n == 0) { return StatusCode::kInvalidDimension; } + + // Checks for validity of the squared A matrix + auto status = TestMatrixA(n, n, a_buffer, a_offset, a_ld, sizeof(T)); + if (ErrorIn(status)) { return status; } + + // Determines which kernel to run based on the layout (the Xgemv kernel assumes column-major as + // default) and on whether we are dealing with an upper or lower triangle of the symmetric matrix + bool is_upper = ((triangle == Triangle::kUpper && layout != Layout::kRowMajor) || + (triangle == Triangle::kLower && layout == Layout::kRowMajor)); + auto kernel_name = (is_upper) ? "SymmUpperToSquared" : "SymmLowerToSquared"; + + // Temporary buffer for a copy of the symmetric matrix + try { + auto temp_symm = Buffer<T>(context_, n*n); + + // Creates a general matrix from the symmetric matrix to be able to run the regular Xgemv + // routine afterwards + try { + auto& program = GetProgramFromCache(); + auto kernel = Kernel(program, kernel_name); + + // Sets the arguments for the symmetric-to-squared kernel + kernel.SetArgument(0, static_cast<int>(n)); + kernel.SetArgument(1, static_cast<int>(a_ld)); + kernel.SetArgument(2, static_cast<int>(a_offset)); + kernel.SetArgument(3, a_buffer()); + kernel.SetArgument(4, static_cast<int>(n)); + kernel.SetArgument(5, static_cast<int>(n)); + kernel.SetArgument(6, static_cast<int>(0)); + kernel.SetArgument(7, temp_symm()); + + // Uses the common padding kernel's thread configuration. This is allowed, since the + // symmetric-to-squared kernel uses the same parameters. + auto global = std::vector<size_t>{Ceil(CeilDiv(n, db_["PAD_WPTX"]), db_["PAD_DIMX"]), + Ceil(CeilDiv(n, db_["PAD_WPTY"]), db_["PAD_DIMY"])}; + auto local = std::vector<size_t>{db_["PAD_DIMX"], db_["PAD_DIMY"]}; + status = RunKernel(kernel, global, local); + if (ErrorIn(status)) { return status; } + + // Runs the regular Xgemv code + status = DoGemv(layout, Transpose::kNo, n, n, alpha, + temp_symm, 0, n, + x_buffer, x_offset, x_inc, beta, + y_buffer, y_offset, y_inc); + + // Return the status of the Xgemv routine + return status; + } catch (...) { return StatusCode::kInvalidKernel; } + } catch (...) { return StatusCode::kTempBufferAllocFailure; } +} + +// ================================================================================================= + +// Compiles the templated class +template class Xsymv<float>; +template class Xsymv<double>; + +// ================================================================================================= +} // namespace clblast diff --git a/test/correctness/routines/level2/xsymv.cc b/test/correctness/routines/level2/xsymv.cc new file mode 100644 index 00000000..a479b999 --- /dev/null +++ b/test/correctness/routines/level2/xsymv.cc @@ -0,0 +1,26 @@ + +// ================================================================================================= +// This file is part of the CLBlast project. The project is licensed under Apache Version 2.0. This +// project loosely follows the Google C++ styleguide and uses a tab-size of two spaces and a max- +// width of 100 characters per line. +// +// Author(s): +// Cedric Nugteren <www.cedricnugteren.nl> +// +// This file implements the tests for the Xsymv routine. +// +// ================================================================================================= + +#include "correctness/testblas.h" +#include "routines/level2/xsymv.h" + +// ================================================================================================= + +// Main function (not within the clblast namespace) +int main(int argc, char *argv[]) { + clblast::RunTests<clblast::TestXsymv<float>, float, float>(argc, argv, false, "SSYMV"); + clblast::RunTests<clblast::TestXsymv<double>, double, double>(argc, argv, true, "DSYMV"); + return 0; +} + +// ================================================================================================= diff --git a/test/performance/routines/level2/xsymv.cc b/test/performance/routines/level2/xsymv.cc new file mode 100644 index 00000000..30e953a5 --- /dev/null +++ b/test/performance/routines/level2/xsymv.cc @@ -0,0 +1,36 @@ + +// ================================================================================================= +// This file is part of the CLBlast project. The project is licensed under Apache Version 2.0. This +// project loosely follows the Google C++ styleguide and uses a tab-size of two spaces and a max- +// width of 100 characters per line. +// +// Author(s): +// Cedric Nugteren <www.cedricnugteren.nl> +// +// This file implements the Xsymv command-line interface performance tester. +// +// ================================================================================================= + +#include "performance/client.h" +#include "routines/level2/xsymv.h" + +// ================================================================================================= + +// Main function (not within the clblast namespace) +int main(int argc, char *argv[]) { + switch(clblast::GetPrecision(argc, argv)) { + case clblast::Precision::kHalf: + throw std::runtime_error("Unsupported precision mode"); + case clblast::Precision::kSingle: + clblast::RunClient<clblast::TestXsymv<float>, float, float>(argc, argv); break; + case clblast::Precision::kDouble: + clblast::RunClient<clblast::TestXsymv<double>, double, double>(argc, argv); break; + case clblast::Precision::kComplexSingle: + throw std::runtime_error("Unsupported precision mode"); + case clblast::Precision::kComplexDouble: + throw std::runtime_error("Unsupported precision mode"); + } + return 0; +} + +// ================================================================================================= diff --git a/test/routines/level2/xsymv.h b/test/routines/level2/xsymv.h new file mode 100644 index 00000000..13473a3e --- /dev/null +++ b/test/routines/level2/xsymv.h @@ -0,0 +1,130 @@ + +// ================================================================================================= +// This file is part of the CLBlast project. The project is licensed under Apache Version 2.0. This +// project loosely follows the Google C++ styleguide and uses a tab-size of two spaces and a max- +// width of 100 characters per line. +// +// Author(s): +// Cedric Nugteren <www.cedricnugteren.nl> +// +// This file implements a class with static methods to describe the Xsymv routine. Examples of +// such 'descriptions' are how to calculate the size a of buffer or how to run the routine. These +// static methods are used by the correctness tester and the performance tester. +// +// ================================================================================================= + +#ifndef CLBLAST_TEST_ROUTINES_XSYMV_H_ +#define CLBLAST_TEST_ROUTINES_XSYMV_H_ + +#include <vector> +#include <string> + +#include "wrapper_clblas.h" + +namespace clblast { +// ================================================================================================= + +// See comment at top of file for a description of the class +template <typename T> +class TestXsymv { + public: + + // The BLAS level: 1, 2, or 3 + static size_t BLASLevel() { return 2; } + + // The list of arguments relevant for this routine + static std::vector<std::string> GetOptions() { + return {kArgN, + kArgLayout, kArgTriangle, + kArgALeadDim, kArgXInc, kArgYInc, + kArgAOffset, kArgXOffset, kArgYOffset, + kArgAlpha, kArgBeta}; + } + + // Describes how to obtain the sizes of the buffers + static size_t GetSizeX(const Arguments<T> &args) { + return args.n * args.x_inc + args.x_offset; + } + static size_t GetSizeY(const Arguments<T> &args) { + return args.n * args.y_inc + args.y_offset; + } + static size_t GetSizeA(const Arguments<T> &args) { + return args.n * args.a_ld + args.a_offset; + } + + // Describes how to set the sizes of all the buffers + static void SetSizes(Arguments<T> &args) { + args.a_size = GetSizeA(args); + args.x_size = GetSizeX(args); + args.y_size = GetSizeY(args); + } + + // Describes what the default values of the leading dimensions of the matrices are + static size_t DefaultLDA(const Arguments<T> &args) { return args.n; } + static size_t DefaultLDB(const Arguments<T> &) { return 1; } // N/A for this routine + static size_t DefaultLDC(const Arguments<T> &) { return 1; } // N/A for this routine + + // Describes which transpose options are relevant for this routine + using Transposes = std::vector<Transpose>; + static Transposes GetATransposes(const Transposes &) { return {}; } // N/A for this routine + static Transposes GetBTransposes(const Transposes &) { return {}; } // N/A for this routine + + // Describes how to run the CLBlast routine + static StatusCode RunRoutine(const Arguments<T> &args, const Buffers<T> &buffers, Queue &queue) { + auto queue_plain = queue(); + auto event = cl_event{}; + auto status = Symv(args.layout, args.triangle, + args.n, args.alpha, + buffers.a_mat(), args.a_offset, args.a_ld, + buffers.x_vec(), args.x_offset, args.x_inc, args.beta, + buffers.y_vec(), args.y_offset, args.y_inc, + &queue_plain, &event); + clWaitForEvents(1, &event); + return status; + } + + // Describes how to run the clBLAS routine (for correctness/performance comparison) + static StatusCode RunReference(const Arguments<T> &args, const Buffers<T> &buffers, Queue &queue) { + auto queue_plain = queue(); + auto event = cl_event{}; + auto status = clblasXsymv(static_cast<clblasOrder>(args.layout), + static_cast<clblasUplo>(args.triangle), + args.n, args.alpha, + buffers.a_mat(), args.a_offset, args.a_ld, + buffers.x_vec(), args.x_offset, args.x_inc, args.beta, + buffers.y_vec(), args.y_offset, args.y_inc, + 1, &queue_plain, 0, nullptr, &event); + clWaitForEvents(1, &event); + return static_cast<StatusCode>(status); + } + + // Describes how to download the results of the computation (more importantly: which buffer) + static std::vector<T> DownloadResult(const Arguments<T> &args, Buffers<T> &buffers, Queue &queue) { + std::vector<T> result(args.y_size, static_cast<T>(0)); + buffers.y_vec.Read(queue, args.y_size, result); + return result; + } + + // Describes how to compute the indices of the result buffer + static size_t ResultID1(const Arguments<T> &args) { + return args.n; + } + static size_t ResultID2(const Arguments<T> &) { return 1; } // N/A for this routine + static size_t GetResultIndex(const Arguments<T> &args, const size_t id1, const size_t) { + return id1*args.y_inc + args.y_offset; + } + + // Describes how to compute performance metrics + static size_t GetFlops(const Arguments<T> &args) { + return 2 * args.n * args.n; + } + static size_t GetBytes(const Arguments<T> &args) { + return (args.n*args.n + 2*args.n + args.n) * sizeof(T); + } +}; + +// ================================================================================================= +} // namespace clblast + +// CLBLAST_TEST_ROUTINES_XSYMV_H_ +#endif diff --git a/test/wrapper_clblas.h b/test/wrapper_clblas.h index 4aaf3705..d69109ac 100644 --- a/test/wrapper_clblas.h +++ b/test/wrapper_clblas.h @@ -132,6 +132,34 @@ clblasStatus clblasXgemv( num_queues, queues, num_wait_events, wait_events, events); } +// Calls {clblasSsymv, clblasDsymv} with the arguments forwarded. +clblasStatus clblasXsymv( + clblasOrder layout, clblasUplo triangle, size_t n, float alpha, + const cl_mem a_mat, size_t a_offset, size_t a_ld, + const cl_mem x_vec, size_t x_offset, size_t x_inc, float beta, + const cl_mem y_vec, size_t y_offset, size_t y_inc, + cl_uint num_queues, cl_command_queue *queues, + cl_uint num_wait_events, const cl_event *wait_events, cl_event *events) { + return clblasSsymv(layout, triangle, n, alpha, + a_mat, a_offset, a_ld, + x_vec, x_offset, static_cast<int>(x_inc), beta, + y_vec, y_offset, static_cast<int>(y_inc), + num_queues, queues, num_wait_events, wait_events, events); +} +clblasStatus clblasXsymv( + clblasOrder layout, clblasUplo triangle, size_t n, double alpha, + const cl_mem a_mat, size_t a_offset, size_t a_ld, + const cl_mem x_vec, size_t x_offset, size_t x_inc, double beta, + const cl_mem y_vec, size_t y_offset, size_t y_inc, + cl_uint num_queues, cl_command_queue *queues, + cl_uint num_wait_events, const cl_event *wait_events, cl_event *events) { + return clblasDsymv(layout, triangle, n, alpha, + a_mat, a_offset, a_ld, + x_vec, x_offset, static_cast<int>(x_inc), beta, + y_vec, y_offset, static_cast<int>(y_inc), + num_queues, queues, num_wait_events, wait_events, events); +} + // ================================================================================================= // BLAS level-3 (matrix-matrix) routines |