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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
/*
* 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_PROTOTYPE_INCLUDE_CKW_TENSORINFO_H
#define CKW_PROTOTYPE_INCLUDE_CKW_TENSORINFO_H
#include "ckw/types/DataType.h"
#include <array>
#include <cstdint>
namespace ckw
{
/** Compute Kernel Writer tensor data layout (or memory format) */
enum class TensorDataLayout
{
Unknown,
Nhwc,
Ndhwc
};
/** Compute Kernel Writer tensor data layout component */
enum class TensorDataLayoutComponent
{
Unknown,
N,
D,
H,
W,
C,
};
/** Compute Kernel Writer tensor component bitmask. The bitmask can be used to retrieve
* the info from @ref TensorComponent.
*/
enum class TensorComponentBitmask : uint32_t
{
OffsetFirstElement = 0x01000000, // For example, OffsetFirstElement in @ref TensorComponent
Stride = 0x02000000, // For example, stride0 in @ref TensorComponent
Dimension = 0x04000000, // For example, Dim0 in @ref TensorComponent
FoldedDimensions = 0x08000000, // For example, Dim0xDim1 in @ref TensorComponent
};
/** Compute Kernel Writer tensor component. The tensor components are used to access specific backend-agnostic tensor arguments,
* such as the tensor dimensions and tensor strides.
* The data type is represented as an integer. The value of the integer value
* is assigned to retrieve the information through the @ref TensorComponentBitmask.
*/
enum class TensorComponentType : uint32_t
{
Unknown = 0x00000000,
OffsetFirstElement = 0x01000000,
Stride0 = 0x02000001,
Stride1 = 0x02000010,
Stride2 = 0x02000100,
Stride3 = 0x02001000,
Stride4 = 0x02010000,
Dim0 = 0x04000001,
Dim1 = 0x04000010,
Dim2 = 0x04000100,
Dim3 = 0x04001000,
Dim4 = 0x04010000,
Dim1xDim2 = 0x08000110,
Dim2xDim3 = 0x08001100,
Dim1xDim2xDim3 = 0x08001110
};
/** Compute Kernel Writer tensor storage. The tensor storage represents the type of tensor memory object.
*/
enum class TensorStorageType : uint32_t
{
Unknown = 0x00000000,
BufferUint8Ptr = 0x01000000,
Texture2dReadOnly = 0x02000001,
Texture2dWriteOnly = 0x02000010,
};
/** Compute Kernel Writer tensor shape
* Negative dimensions can be interpreted as dynamic dimensions by the Compute Kernel Writer
*/
using TensorShape = std::array<int32_t, 5>;
/** Compute Kernel Writer tensor info */
class TensorInfo
{
public:
/** Constructor
*
* @param[in] dt Tensor data type
* @param[in] shape Tensor shape
* @param[in] dl Tensor data layout
* @param[in] id Tensor id. The id is used to keep track of the bound user tensor. Through the id,
* the user can know what tensor has been used by the Compute Kernel Writer.
* Possible id values:
* - greater than or equal to 0: bind a user specific tensors
* - less than 0: bind a virtual tensor (tile)
*/
TensorInfo(DataType dt, const TensorShape &shape, TensorDataLayout dl, int32_t id);
/** Set shape */
TensorInfo &shape(const TensorShape &shape);
/** Get shape */
TensorShape shape() const;
/** Set data type */
TensorInfo &data_type(DataType dt);
/** Get data type */
DataType data_type() const;
/** Set data layout */
TensorInfo &data_layout(TensorDataLayout dl);
/** Get data layout */
TensorDataLayout data_layout() const;
/** Set id */
TensorInfo &id(int32_t id);
/** Get layout */
int32_t id() const;
private:
TensorShape _shape{{0}};
DataType _dt{DataType::Unknown};
TensorDataLayout _dl{TensorDataLayout::Unknown};
int32_t _id{-1};
};
} // namespace ckw
#endif /* CKW_PROTOTYPE_INCLUDE_CKW_TENSORINFO_H */
|
