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
|
/*
* Copyright (c) 2023 Arm Limited.
*
* SPDX-License-Identifier: MIT
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef CKW_SRC_CL_HELPERS_ICLMEMORYOPHELPER_H
#define CKW_SRC_CL_HELPERS_ICLMEMORYOPHELPER_H
#include <cstdint>
#include <string>
namespace ckw
{
// Forward Declarations
class CLTile;
class CLKernelWriter;
class Tensor3dMapper;
enum class MemoryOperation;
/** Base class OpenCL memory operation helper classes
* that helps writing code for memory operations like load/store.
*/
class ICLMemoryOpHelper
{
public:
/** Constructor
*
* @param[in] x @ref ckw::CLKernelWriter object to write the code
* @param[in] mapper @ref ckw::Tensor3dMapper object that tells how to map the Nd tensor to 3d
* @param[in] op The memory operation to be done (e.g. Load/Store)
*/
ICLMemoryOpHelper(CLKernelWriter *x, Tensor3dMapper *mapper, MemoryOperation op)
: _writer(x), _mapper(mapper), _op(op)
{
}
/** Copy constructor */
ICLMemoryOpHelper(const ICLMemoryOpHelper &) = default;
/** Assignment operator overload */
ICLMemoryOpHelper &operator=(const ICLMemoryOpHelper &) = default;
/** Destructor */
virtual ~ICLMemoryOpHelper() = default;
/** Initialization method that takes a 3D tensor's x, z dimensions and
* the batch offset as a tile object, and initializes the code inside
* the writer object.
*
* @param[in] dst tile object to perform the memory operation on
* @param[in] x tile object that describes the x-coordinate of the tensor involved
* @param[in] z tile object that describes the z-coordinate of the tensor involved
* @param[in] b tile object that describes the batch offset of the tensor involved
*/
virtual void initialize(CLTile *dst, CLTile *x, CLTile *z, CLTile *b) = 0;
/** Method that writes the actual code to the writer that performs the mentioned memory
* operation on the tile initialized. It writes the code for a specific row given in the
* arguments.
*
* @param[in] row_id row id
* @param[in] coord_y y-coordinate as string
*/
virtual void write(int32_t row_id, const std::string &coord_y) = 0;
/** Method that finalizes the code in the writer object. This part is usually for taking
* care of finalizing anything that's been initialized inside @ref IMemoryHelper::initialize()
* such as matching compound statements, checking certain boundary conditions etc. No inputs
* and/or outputs, only the writer object is affected.
*/
virtual void finalize() = 0;
protected:
CLKernelWriter *_writer;
Tensor3dMapper *_mapper;
MemoryOperation _op;
CLTile *_dst{ nullptr };
int32_t _ls_width_full{ 0 };
std::string _coord_x{};
std::string _coord_z{};
std::string _coord_b{};
};
} // namespace ckw
#endif /* CKW_SRC_CL_HELPERS_ICLMEMORYOPHELPER_H */
|
