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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
|
/* ************************************************************************
* Copyright (C) 2016-2023 Advanced Micro Devices, Inc. All rights reserved.
*
* 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 cop-
* ies 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 IM-
* PLIED, 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 CONNE-
* CTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* ************************************************************************ */
#ifndef ROCBLAS_AUXILIARY_H
#define ROCBLAS_AUXILIARY_H
#include "rocblas-export.h"
#include "rocblas-types.h"
#ifndef ROCBLAS_NO_DEPRECATED_WARNINGS
#ifndef ROCBLAS_DEPRECATED_MSG
#ifndef _MSC_VER
#define ROCBLAS_DEPRECATED_MSG(MSG) __attribute__((deprecated(#MSG)))
#else
#define ROCBLAS_DEPRECATED_MSG(MSG) __declspec(deprecated(#MSG))
#endif
#endif
#else
#ifndef ROCBLAS_DEPRECATED_MSG
#define ROCBLAS_DEPRECATED_MSG(MSG)
#endif
#endif
/*!\file
* \brief rocblas-auxiliary.h provides auxilary functions in rocblas
*/
#ifdef __cplusplus
extern "C" {
#endif
/*! \brief Create handle
*/
ROCBLAS_EXPORT rocblas_status rocblas_create_handle(rocblas_handle* handle);
/*! \brief Destroy handle
*/
ROCBLAS_EXPORT rocblas_status rocblas_destroy_handle(rocblas_handle handle);
/*! \brief Set stream for handle
*/
ROCBLAS_EXPORT rocblas_status rocblas_set_stream(rocblas_handle handle, hipStream_t stream);
/*! \brief Get stream [0] from handle
*/
ROCBLAS_EXPORT rocblas_status rocblas_get_stream(rocblas_handle handle, hipStream_t* stream);
/*! \brief Set rocblas_pointer_mode
*/
ROCBLAS_EXPORT rocblas_status rocblas_set_pointer_mode(rocblas_handle handle,
rocblas_pointer_mode pointer_mode);
/*! \brief Get rocblas_pointer_mode
*/
ROCBLAS_EXPORT rocblas_status rocblas_get_pointer_mode(rocblas_handle handle,
rocblas_pointer_mode* pointer_mode);
ROCBLAS_DEPRECATED_MSG("rocblas_set_int8_type_for_hipblas will be removed in a future release.")
/*! \brief Set rocblas_int8_type_for_hipblas
*/
ROCBLAS_EXPORT rocblas_status rocblas_set_int8_type_for_hipblas(
rocblas_handle handle, rocblas_int8_type_for_hipblas int8_type);
ROCBLAS_DEPRECATED_MSG("rocblas_get_int8_type_for_hipblas will be removed in a future release.")
/*! \brief Get rocblas_int8_type_for_hipblas
*/
ROCBLAS_EXPORT rocblas_status rocblas_get_int8_type_for_hipblas(
rocblas_handle handle, rocblas_int8_type_for_hipblas* int8_type);
/*! \brief Set rocblas_atomics_mode
*/
ROCBLAS_EXPORT rocblas_status rocblas_set_atomics_mode(rocblas_handle handle,
rocblas_atomics_mode atomics_mode);
/*! \brief Get rocblas_atomics_mode
*/
ROCBLAS_EXPORT rocblas_status rocblas_get_atomics_mode(rocblas_handle handle,
rocblas_atomics_mode* atomics_mode);
/*! \brief Query the preferable supported int8 input layout for gemm
\details
Indicates the supported int8 input layout for gemm according to the device.
If the device supports packed-int8x4 (1) only, output flag is rocblas_gemm_flags_pack_int8x4
and users must bitwise-or your flag with rocblas_gemm_flags_pack_int8x4.
If output flag is rocblas_gemm_flags_none (0), then unpacked int8 is preferable and suggested.
@param[in]
handle [rocblas_handle]
the handle of device
@param[out]
flag pointer to rocblas_gemm_flags
********************************************************************/
ROCBLAS_EXPORT rocblas_status rocblas_query_int8_layout_flag(rocblas_handle handle,
rocblas_gemm_flags* flag);
/*! \brief Indicates whether the pointer is on the host or device.
*/
ROCBLAS_EXPORT rocblas_pointer_mode rocblas_pointer_to_mode(void* ptr);
/*! \brief Copy vector from host to device
@param[in]
n [rocblas_int]
number of elements in the vector
@param[in]
elem_size [rocblas_int]
number of bytes per element in the matrix
@param[in]
x pointer to vector on the host
@param[in]
incx [rocblas_int]
specifies the increment for the elements of the vector
@param[out]
y pointer to vector on the device
@param[in]
incy [rocblas_int]
specifies the increment for the elements of the vector
*/
ROCBLAS_EXPORT rocblas_status rocblas_set_vector(rocblas_int n,
rocblas_int elem_size,
const void* x,
rocblas_int incx,
void* y,
rocblas_int incy);
/*! \brief Copy vector from device to host
@param[in]
n [rocblas_int]
number of elements in the vector
@param[in]
elem_size [rocblas_int]
number of bytes per element in the matrix
@param[in]
x pointer to vector on the device
@param[in]
incx [rocblas_int]
specifies the increment for the elements of the vector
@param[out]
y pointer to vector on the host
@param[in]
incy [rocblas_int]
specifies the increment for the elements of the vector
*/
ROCBLAS_EXPORT rocblas_status rocblas_get_vector(rocblas_int n,
rocblas_int elem_size,
const void* x,
rocblas_int incx,
void* y,
rocblas_int incy);
/*! \brief Copy matrix from host to device
@param[in]
rows [rocblas_int]
number of rows in matrices
@param[in]
cols [rocblas_int]
number of columns in matrices
@param[in]
elem_size [rocblas_int]
number of bytes per element in the matrix
@param[in]
a pointer to matrix on the host
@param[in]
lda [rocblas_int]
specifies the leading dimension of A, lda >= rows
@param[out]
b pointer to matrix on the GPU
@param[in]
ldb [rocblas_int]
specifies the leading dimension of B, ldb >= rows
*/
ROCBLAS_EXPORT rocblas_status rocblas_set_matrix(rocblas_int rows,
rocblas_int cols,
rocblas_int elem_size,
const void* a,
rocblas_int lda,
void* b,
rocblas_int ldb);
/*! \brief Copy matrix from device to host
@param[in]
rows [rocblas_int]
number of rows in matrices
@param[in]
cols [rocblas_int]
number of columns in matrices
@param[in]
elem_size [rocblas_int]
number of bytes per element in the matrix
@param[in]
a pointer to matrix on the GPU
@param[in]
lda [rocblas_int]
specifies the leading dimension of A, lda >= rows
@param[out]
b pointer to matrix on the host
@param[in]
ldb [rocblas_int]
specifies the leading dimension of B, ldb >= rows
*/
ROCBLAS_EXPORT rocblas_status rocblas_get_matrix(rocblas_int rows,
rocblas_int cols,
rocblas_int elem_size,
const void* a,
rocblas_int lda,
void* b,
rocblas_int ldb);
/*! \brief Asynchronously copy vector from host to device
\details
rocblas_set_vector_async copies a vector from pinned host memory to device memory asynchronously.
Memory on the host must be allocated with hipHostMalloc or the transfer will be synchronous.
@param[in]
n [rocblas_int]
number of elements in the vector
@param[in]
elem_size [rocblas_int]
number of bytes per element in the matrix
@param[in]
x pointer to vector on the host
@param[in]
incx [rocblas_int]
specifies the increment for the elements of the vector
@param[out]
y pointer to vector on the device
@param[in]
incy [rocblas_int]
specifies the increment for the elements of the vector
@param[in]
stream specifies the stream into which this transfer request is queued
********************************************************************/
ROCBLAS_EXPORT rocblas_status rocblas_set_vector_async(rocblas_int n,
rocblas_int elem_size,
const void* x,
rocblas_int incx,
void* y,
rocblas_int incy,
hipStream_t stream);
/*! \brief Asynchronously copy vector from device to host
\details
rocblas_get_vector_async copies a vector from pinned host memory to device memory asynchronously.
Memory on the host must be allocated with hipHostMalloc or the transfer will be synchronous.
@param[in]
n [rocblas_int]
number of elements in the vector
@param[in]
elem_size [rocblas_int]
number of bytes per element in the matrix
@param[in]
x pointer to vector on the device
@param[in]
incx [rocblas_int]
specifies the increment for the elements of the vector
@param[out]
y pointer to vector on the host
@param[in]
incy [rocblas_int]
specifies the increment for the elements of the vector
@param[in]
stream specifies the stream into which this transfer request is queued
********************************************************************/
ROCBLAS_EXPORT rocblas_status rocblas_get_vector_async(rocblas_int n,
rocblas_int elem_size,
const void* x,
rocblas_int incx,
void* y,
rocblas_int incy,
hipStream_t stream);
/*! \brief Asynchronously copy matrix from host to device
\details
rocblas_set_matrix_async copies a matrix from pinned host memory to device memory asynchronously.
Memory on the host must be allocated with hipHostMalloc or the transfer will be synchronous.
@param[in]
rows [rocblas_int]
number of rows in matrices
@param[in]
cols [rocblas_int]
number of columns in matrices
@param[in]
elem_size [rocblas_int]
number of bytes per element in the matrix
@param[in]
a pointer to matrix on the host
@param[in]
lda [rocblas_int]
specifies the leading dimension of A, lda >= rows
@param[out]
b pointer to matrix on the GPU
@param[in]
ldb [rocblas_int]
specifies the leading dimension of B, ldb >= rows
@param[in]
stream specifies the stream into which this transfer request is queued
********************************************************************/
ROCBLAS_EXPORT rocblas_status rocblas_set_matrix_async(rocblas_int rows,
rocblas_int cols,
rocblas_int elem_size,
const void* a,
rocblas_int lda,
void* b,
rocblas_int ldb,
hipStream_t stream);
/*! \brief asynchronously copy matrix from device to host
\details
rocblas_get_matrix_async copies a matrix from device memory to pinned host memory asynchronously.
Memory on the host must be allocated with hipHostMalloc or the transfer will be synchronous.
@param[in]
rows [rocblas_int]
number of rows in matrices
@param[in]
cols [rocblas_int]
number of columns in matrices
@param[in]
elem_size [rocblas_int]
number of bytes per element in the matrix
@param[in]
a pointer to matrix on the GPU
@param[in]
lda [rocblas_int]
specifies the leading dimension of A, lda >= rows
@param[out]
b pointer to matrix on the host
@param[in]
ldb [rocblas_int]
specifies the leading dimension of B, ldb >= rows
@param[in]
stream specifies the stream into which this transfer request is queued
********************************************************************/
ROCBLAS_EXPORT rocblas_status rocblas_get_matrix_async(rocblas_int rows,
rocblas_int cols,
rocblas_int elem_size,
const void* a,
rocblas_int lda,
void* b,
rocblas_int ldb,
hipStream_t stream);
/*******************************************************************************
* Function to set start/stop event handlers (for internal use only)
******************************************************************************/
ROCBLAS_EXPORT rocblas_status rocblas_set_start_stop_events(rocblas_handle handle,
hipEvent_t startEvent,
hipEvent_t stopEvent);
#define ROCBLAS_INVOKE_START_STOP_EVENTS(handle, startEvent, stopEvent, call) \
do \
{ \
rocblas_handle tmp_h = (handle); \
rocblas_set_start_stop_events(tmp_h, (startEvent), (stopEvent)); \
call; \
rocblas_set_start_stop_events(tmp_h, (hipEvent_t)0, (hipEvent_t)0); \
} while(0)
// For testing solution selection fitness -- for internal testing only
ROCBLAS_EXPORT rocblas_status rocblas_set_solution_fitness_query(rocblas_handle handle,
double* fitness);
/*! \brief specifies the performance metric that solution selection uses
\details
Determines which performance metric will be used by Tensile when selecting the optimal solution
for gemm problems. If a valid solution benchmarked for this performance metric does not exist
for a problem, Tensile will default to a solution benchmarked for overall performance instead.
@param[in]
handle [rocblas_handle]
the handle of device
@param[in]
metric [rocblas_performance_metric]
the performance metric to be used
********************************************************************/
ROCBLAS_EXPORT rocblas_status rocblas_set_performance_metric(rocblas_handle handle,
rocblas_performance_metric metric);
/*! \brief returns the performance metric being used for solution selection
\details
Returns the performance metric used by Tensile to select the optimal solution for gemm problems.
@param[in]
handle [rocblas_handle]
the handle of device
@param[out]
metric [rocblas_performance_metric*]
pointer to where the metric will be stored
********************************************************************/
ROCBLAS_EXPORT rocblas_status rocblas_get_performance_metric(rocblas_handle handle,
rocblas_performance_metric* metric);
#ifdef __cplusplus
}
#endif
#endif /* ROCBLAS_AUXILIARY_H */
|
