File size: 11,549 Bytes
5c7f7bd
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
/*
 * Copyright 2019 NVIDIA Corporation.  All rights reserved.
 *
 * NOTICE TO LICENSEE:
 *
 * This source code and/or documentation ("Licensed Deliverables") are
 * subject to NVIDIA intellectual property rights under U.S. and
 * international Copyright laws.
 *
 * These Licensed Deliverables contained herein is PROPRIETARY and
 * CONFIDENTIAL to NVIDIA and is being provided under the terms and
 * conditions of a form of NVIDIA software license agreement by and
 * between NVIDIA and Licensee ("License Agreement") or electronically
 * accepted by Licensee.  Notwithstanding any terms or conditions to
 * the contrary in the License Agreement, reproduction or disclosure
 * of the Licensed Deliverables to any third party without the express
 * written consent of NVIDIA is prohibited.
 *
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
 * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE.  IT IS
 * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
 * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
 * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
 * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
 * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
 * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THESE LICENSED DELIVERABLES.
 *
 * U.S. Government End Users.  These Licensed Deliverables are a
 * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
 * 1995), consisting of "commercial computer software" and "commercial
 * computer software documentation" as such terms are used in 48
 * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
 * only as a commercial end item.  Consistent with 48 C.F.R.12.212 and
 * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
 * U.S. Government End Users acquire the Licensed Deliverables with
 * only those rights set forth herein.
 *
 * Any use of the Licensed Deliverables in individual and commercial
 * software must include, in the user documentation and internal
 * comments to the code, the above Disclaimer and U.S. Government End
 * Users Notice.
 */

#if !defined(CUSOLVERMG_H_)
  #define CUSOLVERMG_H_

  #include <stdint.h>
  #include "cusolverDn.h"

  #if defined(__cplusplus)
extern "C" {
  #endif /* __cplusplus */

  struct cusolverMgContext;
  typedef struct cusolverMgContext *cusolverMgHandle_t;

  /**
   * \beief This enum decides how 1D device Ids (or process ranks) get mapped to
   * a 2D grid.
   */
  typedef enum {

    CUDALIBMG_GRID_MAPPING_ROW_MAJOR = 1,
    CUDALIBMG_GRID_MAPPING_COL_MAJOR = 0

  } cusolverMgGridMapping_t;

  /** \brief Opaque structure of the distributed grid */
  typedef void *cudaLibMgGrid_t;
  /** \brief Opaque structure of the distributed matrix descriptor */
  typedef void *cudaLibMgMatrixDesc_t;

  cusolverStatus_t CUSOLVERAPI cusolverMgCreate(cusolverMgHandle_t *handle);

  cusolverStatus_t CUSOLVERAPI cusolverMgDestroy(cusolverMgHandle_t handle);

  cusolverStatus_t CUSOLVERAPI cusolverMgDeviceSelect(
    cusolverMgHandle_t handle,
    int                nbDevices,
    int                deviceId[]);

  /**
   * \brief Allocates resources related to the shared memory device grid.
   * \param[out] grid the opaque data strcuture that holds the grid
   * \param[in] numRowDevices number of devices in the row
   * \param[in] numColDevices number of devices in the column
   * \param[in] deviceId This array of size height * width stores the
   *            device-ids of the 2D grid; each entry must correspond to a valid
   * gpu or to -1 (denoting CPU). \param[in] mapping whether the 2D grid is in
   * row/column major \returns the status code
   */
  cusolverStatus_t CUSOLVERAPI cusolverMgCreateDeviceGrid(
    cudaLibMgGrid_t *       grid,
    int32_t                 numRowDevices,
    int32_t                 numColDevices,
    const int32_t           deviceId[],
    cusolverMgGridMapping_t mapping);

  /**
   * \brief Releases the allocated resources related to the distributed grid.
   * \param[in] grid the opaque data strcuture that holds the distributed grid
   * \returns the status code
   */
  cusolverStatus_t CUSOLVERAPI cusolverMgDestroyGrid(cudaLibMgGrid_t grid);

  /**
   * \brief Allocates resources related to the distributed matrix descriptor.
   * \param[out] desc the opaque data strcuture that holds the descriptor
   * \param[in] numRows number of total rows
   * \param[in] numCols number of total columns
   * \param[in] rowBlockSize row block size
   * \param[in] colBlockSize column block size
   * \param[in] dataType the data type of each element in cudaDataType
   * \param[in] grid the opaque data structure of the distributed grid
   * \returns the status code
   */
  cusolverStatus_t CUSOLVERAPI cusolverMgCreateMatrixDesc(
    cudaLibMgMatrixDesc_t *desc,
    int64_t                numRows,
    int64_t                numCols,
    int64_t                rowBlockSize,
    int64_t                colBlockSize,
    cudaDataType           dataType,
    const cudaLibMgGrid_t  grid);

  /**
   * \brief Releases the allocated resources related to the distributed matrix
   * descriptor. \param[in] desc the opaque data strcuture that holds the
   * descriptor \returns the status code
   */
  cusolverStatus_t CUSOLVERAPI
    cusolverMgDestroyMatrixDesc(cudaLibMgMatrixDesc_t desc);

  cusolverStatus_t CUSOLVERAPI cusolverMgSyevd_bufferSize(
    cusolverMgHandle_t    handle,
    cusolverEigMode_t     jobz,
    cublasFillMode_t      uplo,
    int                   N,
    void *                array_d_A[],
    int                   IA,
    int                   JA,
    cudaLibMgMatrixDesc_t descrA,
    void *                W,
    cudaDataType          dataTypeW,
    cudaDataType          computeType,
    int64_t *             lwork);

  cusolverStatus_t CUSOLVERAPI cusolverMgSyevd(
    cusolverMgHandle_t    handle,
    cusolverEigMode_t     jobz,
    cublasFillMode_t      uplo,
    int                   N,
    void *                array_d_A[],
    int                   IA,
    int                   JA,
    cudaLibMgMatrixDesc_t descrA,
    void *                W,
    cudaDataType          dataTypeW,
    cudaDataType          computeType,
    void *                array_d_work[],
    int64_t               lwork,
    int *                 info);

  cusolverStatus_t CUSOLVERAPI cusolverMgGetrf_bufferSize(
    cusolverMgHandle_t    handle,
    int                   M,
    int                   N,
    void *                array_d_A[],
    int                   IA,
    int                   JA,
    cudaLibMgMatrixDesc_t descrA,
    int *                 array_d_IPIV[],
    cudaDataType          computeType,
    int64_t *             lwork);

  cusolverStatus_t CUSOLVERAPI cusolverMgGetrf(
    cusolverMgHandle_t    handle,
    int                   M,
    int                   N,
    void *                array_d_A[],
    int                   IA,
    int                   JA,
    cudaLibMgMatrixDesc_t descrA,
    int *                 array_d_IPIV[],
    cudaDataType          computeType,
    void *                array_d_work[],
    int64_t               lwork,
    int *                 info);

  cusolverStatus_t CUSOLVERAPI cusolverMgGetrs_bufferSize(
    cusolverMgHandle_t    handle,
    cublasOperation_t     TRANS,
    int                   N,
    int                   NRHS,
    void *                array_d_A[],
    int                   IA,
    int                   JA,
    cudaLibMgMatrixDesc_t descrA,
    int *                 array_d_IPIV[],
    void *                array_d_B[],
    int                   IB,
    int                   JB,
    cudaLibMgMatrixDesc_t descrB,
    cudaDataType          computeType,
    int64_t *             lwork);

  cusolverStatus_t CUSOLVERAPI cusolverMgGetrs(
    cusolverMgHandle_t    handle,
    cublasOperation_t     TRANS,
    int                   N,
    int                   NRHS,
    void *                array_d_A[],
    int                   IA,
    int                   JA,
    cudaLibMgMatrixDesc_t descrA,
    int *                 array_d_IPIV[],
    void *                array_d_B[],
    int                   IB,
    int                   JB,
    cudaLibMgMatrixDesc_t descrB,
    cudaDataType          computeType,
    void *                array_d_work[],
    int64_t               lwork,
    int *                 info);

  cusolverStatus_t CUSOLVERAPI cusolverMgPotrf_bufferSize(
    cusolverMgHandle_t    handle,
    cublasFillMode_t      uplo,
    int                   N,
    void *                array_d_A[],
    int                   IA,
    int                   JA,
    cudaLibMgMatrixDesc_t descrA,
    cudaDataType          computeType,
    int64_t *             lwork);

  cusolverStatus_t CUSOLVERAPI cusolverMgPotrf(
    cusolverMgHandle_t    handle,
    cublasFillMode_t      uplo,
    int                   N,
    void *                array_d_A[],
    int                   IA,
    int                   JA,
    cudaLibMgMatrixDesc_t descrA,
    cudaDataType          computeType,
    void *                array_d_work[],
    int64_t               lwork,
    int *                 h_info);

  cusolverStatus_t CUSOLVERAPI cusolverMgPotrs_bufferSize(
    cusolverMgHandle_t    handle,
    cublasFillMode_t      uplo,
    int                   n,
    int                   nrhs,
    void *                array_d_A[],
    int                   IA,
    int                   JA,
    cudaLibMgMatrixDesc_t descrA,
    void *                array_d_B[],
    int                   IB,
    int                   JB,
    cudaLibMgMatrixDesc_t descrB,
    cudaDataType          computeType,
    int64_t *             lwork);

  cusolverStatus_t CUSOLVERAPI cusolverMgPotrs(
    cusolverMgHandle_t    handle,
    cublasFillMode_t      uplo,
    int                   n,
    int                   nrhs,
    void *                array_d_A[],
    int                   IA,
    int                   JA,
    cudaLibMgMatrixDesc_t descrA,
    void *                array_d_B[],
    int                   IB,
    int                   JB,
    cudaLibMgMatrixDesc_t descrB,
    cudaDataType          computeType,
    void *                array_d_work[],
    int64_t               lwork,
    int *                 h_info);

  cusolverStatus_t CUSOLVERAPI cusolverMgPotri_bufferSize(
    cusolverMgHandle_t    handle,
    cublasFillMode_t      uplo,
    int                   N,
    void *                array_d_A[],
    int                   IA,
    int                   JA,
    cudaLibMgMatrixDesc_t descrA,
    cudaDataType          computeType,
    int64_t *             lwork);

  cusolverStatus_t CUSOLVERAPI cusolverMgPotri(
    cusolverMgHandle_t    handle,
    cublasFillMode_t      uplo,
    int                   N,
    void *                array_d_A[],
    int                   IA,
    int                   JA,
    cudaLibMgMatrixDesc_t descrA,
    cudaDataType          computeType,
    void *                array_d_work[],
    int64_t               lwork,
    int *                 h_info);

  #if defined(__cplusplus)
}
  #endif /* __cplusplus */

#endif // CUSOLVERMG_H_