zbuild.c 9.92 KB
Newer Older
1 2
/**
 *
Mathieu Faverge's avatar
Mathieu Faverge committed
3 4
 * @copyright 2009-2014 The University of Tennessee and The University of
 *                      Tennessee Research Foundation. All rights reserved.
5 6
 * @copyright 2012-2014 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
 *                      Univ. Bordeaux. All rights reserved.
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 *
 * @file zbuild.c
 *
 *  MORSE computational routines
 *  MORSE is a software package provided by Univ. of Tennessee,
 *  Univ. of California Berkeley and Univ. of Colorado Denver
 *
 * @version 2.5.0
 * @comment This file has been automatically generated
 *          from Plasma 2.5.0 for MORSE 1.0.0
 * @author Mathieu Faverge
 * @author Emmanuel Agullo
 * @author Cedric Castagnede
 * @author Guillaume Sylvand
 * @date 2016-09-05
 * @precisions normal z -> s d c
 *
 **/
#include "control/common.h"

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
 *
 * @ingroup MORSE_Complex64_t
 *
 *  MORSE_zbuild - Generate a matrix by calling user provided function.
 *
 *******************************************************************************
 *
 * @param[in] uplo
 *          Specifies the part of the matrix A to be copied to B.
 *            = MorseUpperLower: All the matrix A
 *            = MorseUpper: Upper triangular part
 *            = MorseLower: Lower triangular part
 *
 * @param[in] M
 *          The number of rows of A.
 *
 * @param[in] N
 *          The order of the matrix A. N >= 0.
 *
 * @param[out] A
 *          On exit, The matrix A generated.
 *
 * @param[in] LDA
 *          The leading dimension of the array A. LDA >= max(1,M).
 *
 * @param[in] user_data
 *          The user data used in the matrix generation, it will be passed by chameleon
 *          to the build callback function (see below).
 *
 * @param[in] user_build_callback
 *          The user function to call to generate tiles.
 *          The prototype of the callback is :
 *          void myFcn(int row_min, int row_max, int col_min, int col_max, void *buffer, int ld, void *user_data)
 *          It is expected to build the block of matrix [row_min, row_max] x [col_min, col_max]
 *          (with both min and max values included in the intervals,
 *          index start at 0 like in C, NOT 1 like in Fortran)
 *          and store it at the adresse 'buffer' with leading dimension 'ld'
 *          The argument 'user_data' is an opaque pointer on any user data, it is passed by
 *          the user to Morse_zbuild (see above) and transmitted by chameleon to the callback.
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *          \retval <0 if -i, the i-th argument had an illegal value
 *
 *******************************************************************************
 *
 * @sa MORSE_zbuild_Tile
 * @sa MORSE_zbuild_Tile_Async
 * @sa MORSE_cbuild
 * @sa MORSE_dbuild
 * @sa MORSE_sbuild
 *
 ******************************************************************************/
int MORSE_zbuild( MORSE_enum uplo, int M, int N,
                  MORSE_Complex64_t *A, int LDA,
Mathieu Faverge's avatar
Minor  
Mathieu Faverge committed
86
                  void *user_data, void* user_build_callback )
87
{
Mathieu Faverge's avatar
Mathieu Faverge committed
88 89 90 91 92
    int NB;
    int status;
    MORSE_context_t *morse;
    MORSE_sequence_t *sequence = NULL;
    MORSE_request_t request = MORSE_REQUEST_INITIALIZER;
Mathieu Faverge's avatar
Mathieu Faverge committed
93
    MORSE_desc_t descAl, descAt;
94

Mathieu Faverge's avatar
Mathieu Faverge committed
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zbuild", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    /* Check input arguments */
    if (M < 0) {
        morse_error("MORSE_zbuild", "illegal value of M");
        return -1;
    }
    if (N < 0) {
        morse_error("MORSE_zbuild", "illegal value of N");
        return -2;
    }
    if (LDA < chameleon_max(1, M)) {
        morse_error("MORSE_zbuild", "illegal value of LDA");
        return -4;
    }
    /* Quick return */
    if (chameleon_min(M, N) == 0)
        return MORSE_SUCCESS;
116

Mathieu Faverge's avatar
Mathieu Faverge committed
117 118 119 120 121 122
    /* Tune NB depending on M, N & NRHS; Set NBNB */
    status = morse_tune(MORSE_FUNC_ZGEMM, M, N, 0);
    if (status != MORSE_SUCCESS) {
        morse_error("MORSE_zbuild", "morse_tune() failed");
        return status;
    }
123

Mathieu Faverge's avatar
Mathieu Faverge committed
124 125
    /* Set NT */
    NB = MORSE_NB;
126
    morse_sequence_create( morse, &sequence );
127 128

    /* Submit the matrix conversion */
129
    morse_zlap2tile( morse, &descAl, &descAt, MorseDescOutput, uplo,
130
                     A, NB, NB, LDA, N, M, N, sequence, &request );
131

Mathieu Faverge's avatar
Mathieu Faverge committed
132
    /* Call the tile interface */
133
    MORSE_zbuild_Tile_Async( uplo, &descAt, user_data, user_build_callback, sequence, &request );
134

Mathieu Faverge's avatar
Mathieu Faverge committed
135
    /* Submit the matrix conversion back */
Mathieu Faverge's avatar
Mathieu Faverge committed
136
    morse_ztile2lap( morse, &descAl, &descAt,
137
                     MorseDescOutput, uplo, sequence, &request );
Mathieu Faverge's avatar
Mathieu Faverge committed
138

139
    morse_sequence_wait( morse, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
140

Mathieu Faverge's avatar
Mathieu Faverge committed
141 142
    /* Cleanup the temporary data */
    morse_ztile2lap_cleanup( morse, &descAl, &descAt );
143

Mathieu Faverge's avatar
Mathieu Faverge committed
144
    status = sequence->status;
145
    morse_sequence_destroy( morse, sequence );
146

Mathieu Faverge's avatar
Mathieu Faverge committed
147
    return status;
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
 *
 * @ingroup MORSE_Complex64_t_Tile
 *
 *  MORSE_zbuild_Tile - Generate a matrix by tiles by calling user provided function.
 *  Tile equivalent of MORSE_zbuild().
 *  Operates on matrices stored by tiles.
 *  All matrices are passed through descriptors.
 *  All dimensions are taken from the descriptors.
 *
 *******************************************************************************
 *
 * @param[in] uplo
 *          Specifies the part of the matrix A to be copied to B.
 *            = MorseUpperLower: All the matrix A
 *            = MorseUpper: Upper triangular part
 *            = MorseLower: Lower triangular part
 *
 * @param[in] A
 *          On exit, The matrix A generated.
 *
 * @param[in] user_data
 *          The data used in the matrix generation.
 *
 * @param[in] user_build_callback
 *          The function called by the codelet to fill the tiles (see MORSE_zbuild)
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *
 *******************************************************************************
 *
 * @sa MORSE_zbuild
 * @sa MORSE_zbuild_Tile_Async
 * @sa MORSE_cbuild_Tile
 * @sa MORSE_dbuild_Tile
 * @sa MORSE_sbuild_Tile
 *
 ******************************************************************************/
int MORSE_zbuild_Tile( MORSE_enum uplo, MORSE_desc_t *A,
                       void *user_data, void* user_build_callback )
{
Mathieu Faverge's avatar
Mathieu Faverge committed
195 196 197 198
    MORSE_context_t *morse;
    MORSE_sequence_t *sequence = NULL;
    MORSE_request_t request = MORSE_REQUEST_INITIALIZER;
    int status;
199

Mathieu Faverge's avatar
Mathieu Faverge committed
200 201 202 203 204
    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zbuild_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
205 206
    morse_sequence_create( morse, &sequence );

Mathieu Faverge's avatar
Mathieu Faverge committed
207
    MORSE_zbuild_Tile_Async( uplo, A, user_data, user_build_callback, sequence, &request );
Mathieu Faverge's avatar
Mathieu Faverge committed
208

209
    MORSE_Desc_Flush( A, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
210

211
    morse_sequence_wait( morse, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
212
    status = sequence->status;
213
    morse_sequence_destroy( morse, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
214
    return status;
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
 *
 * @ingroup MORSE_Complex64_t_Tile_Async
 *
 *  MORSE_zbuild_Tile_Async - Generate a matrix by tiles by calling user provided function.
 *  Non-blocking equivalent of MORSE_zbuild_Tile().
 *  May return before the computation is finished.
 *  Allows for pipelining of operations at runtime.
 *
 *******************************************************************************
 *
 * @param[in] uplo
 *          Specifies the part of the matrix A to be copied to B.
 *            = MorseUpperLower: All the matrix A
 *            = MorseUpper: Upper triangular part
 *            = MorseLower: Lower triangular part
 *
 * @param[in] A
 *          On exit, The matrix A generated.
 *
 * @param[in] user_data
 *          The data used in the matrix generation.
 *
 * @param[in] user_build_callback
 *          The function called by the codelet to fill the tiles (see MORSE_zbuild)
 *
 * @param[in] sequence
 *          Identifies the sequence of function calls that this call belongs to
 *          (for completion checks and exception handling purposes).
 *
 * @param[out] request
 *          Identifies this function call (for exception handling purposes).
 *
 *******************************************************************************
 *
 * @sa MORSE_zbuild
 * @sa MORSE_zbuild_Tile
 * @sa MORSE_cbuild_Tile_Async
 * @sa MORSE_dbuild_Tile_Async
 * @sa MORSE_sbuild_Tile_Async
 *
 ******************************************************************************/
int MORSE_zbuild_Tile_Async( MORSE_enum uplo, MORSE_desc_t     *A,
                             void *user_data, void* user_build_callback,
                             MORSE_sequence_t *sequence,
Mathieu Faverge's avatar
Minor  
Mathieu Faverge committed
263
                             MORSE_request_t  *request )
264
{
Mathieu Faverge's avatar
Mathieu Faverge committed
265
    MORSE_context_t *morse;
266

Mathieu Faverge's avatar
Mathieu Faverge committed
267 268 269 270 271 272 273 274 275 276 277 278 279 280
    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zbuild_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    if (sequence == NULL) {
        morse_fatal_error("MORSE_zbuild_Tile", "NULL sequence");
        return MORSE_ERR_UNALLOCATED;
    }
    if (request == NULL) {
        morse_fatal_error("MORSE_zbuild_Tile", "NULL request");
        return MORSE_ERR_UNALLOCATED;
    }
    /* Check sequence status */
Mathieu Faverge's avatar
Mathieu Faverge committed
281
    if (sequence->status == MORSE_SUCCESS) {
Mathieu Faverge's avatar
Mathieu Faverge committed
282
        request->status = MORSE_SUCCESS;
Mathieu Faverge's avatar
Mathieu Faverge committed
283 284
    }
    else {
Mathieu Faverge's avatar
Mathieu Faverge committed
285
        return morse_request_fail(sequence, request, MORSE_ERR_SEQUENCE_FLUSHED);
Mathieu Faverge's avatar
Mathieu Faverge committed
286
    }
287

Mathieu Faverge's avatar
Mathieu Faverge committed
288 289 290 291 292
    /* Check descriptors for correctness */
    if (morse_desc_check(A) != MORSE_SUCCESS) {
        morse_error("MORSE_zbuild_Tile", "invalid descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
293

Mathieu Faverge's avatar
Mathieu Faverge committed
294
    /* Quick return */
Mathieu Faverge's avatar
Minor  
Mathieu Faverge committed
295
    if (chameleon_min( A->m, A->n ) == 0) {
Mathieu Faverge's avatar
Mathieu Faverge committed
296
        return MORSE_SUCCESS;
Mathieu Faverge's avatar
Minor  
Mathieu Faverge committed
297
    }
298

Mathieu Faverge's avatar
Mathieu Faverge committed
299
    morse_pzbuild( uplo, A, user_data, user_build_callback, sequence, request );
300

Mathieu Faverge's avatar
Mathieu Faverge committed
301
    return MORSE_SUCCESS;
302
}