1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
// =================================================================================================
// 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 all the basic functionality for the BLAS routines. This class serves as a
// base class for the actual routines (e.g. Xaxpy, Xgemm). It contains common functionality such as
// compiling the OpenCL kernel, connecting to the database, etc.
//
// =================================================================================================
#ifndef CLBLAST_ROUTINE_H_
#define CLBLAST_ROUTINE_H_
#include <string>
#include <vector>
#include "internal/utilities.h"
#include "internal/database.h"
namespace clblast {
// =================================================================================================
// See comment at top of file for a description of the class
class Routine {
public:
// The cache of compiled OpenCL programs, along with some meta-data
struct ProgramCache {
Program program;
std::string device_name;
Precision precision;
std::string routine_name_;
// Finds out whether the properties match
bool MatchInCache(const std::string &ref_device, const Precision &ref_precision,
const std::string &ref_routine) {
return (device_name == ref_device &&
precision == ref_precision &&
routine_name_ == ref_routine);
}
};
// The actual cache, implemented as a vector of the above data-type
static std::vector<ProgramCache> program_cache_;
// Helper functions which check for errors in the status code
static constexpr bool ErrorIn(const StatusCode s) { return (s != StatusCode::kSuccess); }
// Base class constructor
explicit Routine(CommandQueue &queue, Event &event, const std::string &name,
const std::vector<std::string> &routines, const Precision precision);
// Set-up phase of the kernel
StatusCode SetUp();
protected:
// Runs a kernel given the global and local thread sizes
StatusCode RunKernel(const Kernel &kernel, std::vector<size_t> &global,
const std::vector<size_t> &local);
// Tests for valid inputs of matrices A, B, and C
StatusCode TestMatrixA(const size_t one, const size_t two, const Buffer &buffer,
const size_t offset, const size_t ld, const size_t data_size);
StatusCode TestMatrixB(const size_t one, const size_t two, const Buffer &buffer,
const size_t offset, const size_t ld, const size_t data_size);
StatusCode TestMatrixC(const size_t one, const size_t two, const Buffer &buffer,
const size_t offset, const size_t ld, const size_t data_size);
// Tests for valid inputs of vectors X and Y
StatusCode TestVectorX(const size_t n, const Buffer &buffer, const size_t offset,
const size_t inc, const size_t data_size);
StatusCode TestVectorY(const size_t n, const Buffer &buffer, const size_t offset,
const size_t inc, const size_t data_size);
// Copies/transposes a matrix and padds/unpads it with zeroes. This method is also able to write
// to symmetric and triangular matrices through optional arguments.
StatusCode PadCopyTransposeMatrix(const size_t src_one, const size_t src_two,
const size_t src_ld, const size_t src_offset,
const Buffer &src,
const size_t dest_one, const size_t dest_two,
const size_t dest_ld, const size_t dest_offset,
const Buffer &dest,
const Program &program, const bool do_pad,
const bool do_transpose, const bool do_conjugate,
const bool upper = false, const bool lower = false,
const bool diagonal_imag_zero = false);
// Queries the cache and retrieve either a matching program or a boolean whether a match exists.
// The first assumes that the program is available in the cache and will throw an exception
// otherwise.
const Program& GetProgramFromCache() const;
bool ProgramIsInCache() const;
// Non-static variable for the precision. Note that the same variable (but static) might exist in
// a derived class.
const Precision precision_;
// The routine's name and its kernel-source in string form
const std::string routine_name_;
std::string source_string_;
// The OpenCL objects, accessible only from derived classes
CommandQueue queue_;
Event event_;
const Context context_;
const Device device_;
// OpenCL device properties
const std::string device_name_;
const cl_uint max_work_item_dimensions_;
const std::vector<size_t> max_work_item_sizes_;
const size_t max_work_group_size_;
// Connection to the database for all the device-specific parameters
const Database db_;
};
// =================================================================================================
} // namespace clblast
// CLBLAST_ROUTINE_H_
#endif
|
