parsec_cgetrf.c

Go to the documentation of this file.

/**
 *
 * @file parsec_cgetrf.c
 *
 * PaStiX cgetrf PaRSEC wrapper.
 *
 * @copyright 2016-2024 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
 *                      Univ. Bordeaux. All rights reserved.
 *
 * @version 6.4.0
 * @author Mathieu Faverge
 * @author Esragul Korkmaz
 * @author Pierre Ramet
 * @date 2024-07-05
 * @generated from /builds/2mk6rsew/0/solverstack/pastix/sopalin/parsec/parsec_zgetrf.c, normal z -> c, Tue Feb 25 14:35:19 2025
 *
 * @addtogroup parsec_getrf
 * @{
 *
 **/
#include <parsec.h>
#include <parsec/data_distribution.h>
#include <parsec/private_mempool.h>
#include <parsec/arena.h>
#include <parsec/data_dist/matrix/matrix.h>
#include "common.h"
#include "blend/solver.h"
#include "sopalin/sopalin_data.h"
#include "cgetrf_sp1dplus.h"
#include "cgetrf_sp2d.h"
#include "pastix_parsec.h"
 
/**
 *******************************************************************************
 *
 * @brief Generate the PaRSEC taskpool object for the LU factorization with
 * 1D kernels.
 *
 * The function only return the object that describes the LU factorization of a
 * sparse general matrix A.
 * The factorization has the form
 *
 *    \f[ A = L\times U \f]
 *
 * where L is a sparse lower triangular matrix, and U a sparse upper triangular
 * with the same pattern as L^t.
 *
 * In this object, all operations are panel based operation which might result in
 * lower parallelism for large problems.
 *
 * @warning The computations are not done by this call.
 *
 *******************************************************************************
 *
 * @param[inout] A
 *          Descriptor of the sparse matrix A.
 *          On exit, A is overwritten with the factorized matrix.
 *
 * @param[inout] sopalin_data
 *          Solver matrix information structure that will guide the algorithm.
 *
 *******************************************************************************
 *
 * @retval NULL if incorrect parameters are given.
 * @retval The parsec taskpool describing the operation that can be
 *         enqueued in the runtime with parsec_enqueue(). It, then, needs to be
 *         destroy with parsec_cgetrf_sp1dplus_Destruct().
 *
 *******************************************************************************
 *
 * @sa parsec_cgetrf_sp1dplus
 * @sa parsec_cgetrf_sp1dplus_Destruct
 * @sa parsec_cgetrf_sp1dplus
 * @sa parsec_cgetrf_sp1dplus_New
 * @sa parsec_dgetrf_sp1dplus_New
 * @sa parsec_sgetrf_sp1dplus_New
 *
 ******************************************************************************/
parsec_taskpool_t*
parsec_cgetrf_sp1dplus_New( parsec_sparse_matrix_desc_t *A,
                            sopalin_data_t *sopalin_data )
{
    parsec_cgetrf_sp1dplus_taskpool_t *parsec_cgetrf_sp1dplus = NULL;
    pastix_int_t lwork;
 
    lwork = sopalin_data->solvmtx->gemmmax;
    if ( (sopalin_data->solvmtx->lowrank.compress_when != PastixCompressNever) &&
         (sopalin_data->solvmtx->lowrank.ilu_lvl < INT_MAX) )
    {
        lwork = pastix_imax( lwork, 2 * sopalin_data->solvmtx->blokmax );
    }
 
    parsec_cgetrf_sp1dplus = parsec_cgetrf_sp1dplus_new( A, sopalin_data, NULL, lwork );
 
    parsec_cgetrf_sp1dplus->_g_p_work = (parsec_memory_pool_t*)malloc(sizeof(parsec_memory_pool_t));
    parsec_private_memory_init( parsec_cgetrf_sp1dplus->_g_p_work,
                                lwork * sizeof(pastix_complex32_t) );
 
    parsec_arena_construct( parsec_cgetrf_sp1dplus->arenas[PARSEC_cgetrf_sp1dplus_DEFAULT_ARENA],
                            sizeof(pastix_complex32_t), PARSEC_ARENA_ALIGNMENT_SSE,
                            parsec_datatype_complex_t );
 
#if defined(PASTIX_GENERATE_MODEL)
    parsec_cgetrf_sp1dplus->_g_forced_pushout = 1;
#endif
    return (parsec_taskpool_t*)parsec_cgetrf_sp1dplus;
}
 
/**
 *******************************************************************************
 *
 * @brief Free the data structure associated to a taskpool created with
 * parsec_cgetrf_sp1dplus_New().
 *
 *******************************************************************************
 *
 * @param[inout] taskpool
 *          On entry, the taskpool to destroy.
 *          On exit, the taskpool cannot be used anymore.
 *
 ******************************************************************************/
void
parsec_cgetrf_sp1dplus_Destruct( parsec_taskpool_t *taskpool )
{
    parsec_cgetrf_sp1dplus_taskpool_t *parsec_cgetrf_sp1dplus = NULL;
    parsec_cgetrf_sp1dplus = (parsec_cgetrf_sp1dplus_taskpool_t *)taskpool;
 
    parsec_private_memory_fini( parsec_cgetrf_sp1dplus->_g_p_work );
    free( parsec_cgetrf_sp1dplus->_g_p_work );
 
    parsec_taskpool_free( taskpool );
}
 
/**
 *******************************************************************************
 *
 * @brief Perform a sparse LU factorization with 1D kernels.
 *
 * The function performs the LU factorization of a sparse general matrix A.
 * The factorization has the form
 *
 *    \f[ A = L\times U \f]
 *
 * where L is a sparse lower triangular matrix, and U a sparse upper triangular
 * with the same pattern as L^t.
 *
 *******************************************************************************
 *
 * @param[inout] parsec
 *          The parsec context of the application that will run the operation.
 *
 * @param[inout] A
 *          Descriptor of the sparse matrix A.
 *          On exit, A is overwritten with the factorized matrix.
 *
 * @param[inout] sopalin_data
 *          Solver matrix information structure that will guide the algorithm.
 *
 *******************************************************************************
 *
 * @retval NULL if incorrect parameters are given.
 * @retval The parsec taskpool describing the operation that can be
 *         enqueued in the runtime with parsec_enqueue(). It, then, needs to be
 *         destroy with parsec_cgetrf_sp1dplus_Destruct().
 *
 *******************************************************************************
 *
 * @sa parsec_cgetrf_sp1dplus_New
 * @sa parsec_cgetrf_sp1dplus_Destruct
 *
 ******************************************************************************/
int
parsec_cgetrf_sp1dplus( parsec_context_t *parsec,
                        parsec_sparse_matrix_desc_t *A,
                        sopalin_data_t *sopalin_data )
{
    parsec_taskpool_t *parsec_cgetrf_sp1dplus = NULL;
    int info = 0;
 
    parsec_cgetrf_sp1dplus = parsec_cgetrf_sp1dplus_New( A, sopalin_data );
 
    if ( parsec_cgetrf_sp1dplus == NULL ) {
        return -1;
    }
 
    parsec_context_add_taskpool( parsec, (parsec_taskpool_t*)parsec_cgetrf_sp1dplus );
    parsec_context_start( parsec );
    parsec_context_wait( parsec );
    parsec_cgetrf_sp1dplus_Destruct( parsec_cgetrf_sp1dplus );
 
    return info;
}
 
/**
 *******************************************************************************
 *
 * @brief Generate the PaRSEC taskpoolr object for the LU factorization with
 * 1D and 2D kernels.
 *
 * The function only return the object that describes the LU factorization of a
 * sparse general matrix A.
 * The factorization has the form
 *
 *    \f[ A = L\times U \f]
 *
 * where L is a sparse lower triangular matrix, and U a sparse upper triangular
 * with the same pattern as L^t.
 *
 * In this object, operations are panel based operations for the lower levels of
 * the elimination tree, and the higher levels are taskpoold by 2D tasks scheme to
 * create more parallelism and adapt to large architectures.
 *
 * @warning The computations are not done by this call.
 *
 *******************************************************************************
 *
 * @param[inout] A
 *          Descriptor of the sparse matrix A.
 *          On exit, A is overwritten with the factorized matrix.
 *
 * @param[inout] sopalin_data
 *          Solver matrix information structure that will guide the algorithm.
 *
 *******************************************************************************
 *
 * @retval NULL if incorrect parameters are given.
 * @retval The parsec taskpool describing the operation that can be
 *         enqueued in the runtime with parsec_enqueue(). It, then, needs to be
 *         destroy with parsec_cgetrf_sp2d_Destruct().
 *
 *******************************************************************************
 *
 * @sa parsec_cgetrf_sp2d
 * @sa parsec_cgetrf_sp2d_Destruct
 * @sa parsec_cgetrf_sp2d
 * @sa parsec_cgetrf_sp2d_New
 * @sa parsec_dgetrf_sp2d_New
 * @sa parsec_sgetrf_sp2d_New
 *
 ******************************************************************************/
parsec_taskpool_t*
parsec_cgetrf_sp2d_New( parsec_sparse_matrix_desc_t *A,
                        sopalin_data_t *sopalin_data )
{
    parsec_cgetrf_sp2d_taskpool_t *parsec_cgetrf_sp2d = NULL;
    pastix_int_t lwork;
 
    lwork = sopalin_data->solvmtx->gemmmax;
    if ( (sopalin_data->solvmtx->lowrank.compress_when != PastixCompressNever) &&
         (sopalin_data->solvmtx->lowrank.ilu_lvl < INT_MAX) )
    {
        lwork = pastix_imax( lwork, 2 * sopalin_data->solvmtx->blokmax );
    }
 
    parsec_cgetrf_sp2d = parsec_cgetrf_sp2d_new( A, sopalin_data, NULL, lwork );
 
    parsec_cgetrf_sp2d->_g_p_work = (parsec_memory_pool_t*)malloc(sizeof(parsec_memory_pool_t));
    parsec_private_memory_init( parsec_cgetrf_sp2d->_g_p_work,
                                lwork * sizeof(pastix_complex32_t) );
 
    parsec_arena_construct( parsec_cgetrf_sp2d->arenas[PARSEC_cgetrf_sp2d_DEFAULT_ARENA],
                            sizeof(pastix_complex32_t), PARSEC_ARENA_ALIGNMENT_SSE,
                            parsec_datatype_complex_t );
 
#if defined(PASTIX_GENERATE_MODEL)
    parsec_cgetrf_sp2d->_g_forced_pushout = 1;
#endif
    return (parsec_taskpool_t*)parsec_cgetrf_sp2d;
}
 
/**
 *******************************************************************************
 *
 * @brief Free the data structure associated to a taskpool created with
 * parsec_cgetrf_sp2d_New().
 *
 *******************************************************************************
 *
 * @param[inout] taskpool
 *          On entry, the taskpool to destroy.
 *          On exit, the taskpool cannot be used anymore.
 *
 ******************************************************************************/
void
parsec_cgetrf_sp2d_Destruct( parsec_taskpool_t *taskpool )
{
    parsec_cgetrf_sp2d_taskpool_t *parsec_cgetrf_sp2d = NULL;
    parsec_cgetrf_sp2d = (parsec_cgetrf_sp2d_taskpool_t *)taskpool;
 
    parsec_private_memory_fini( parsec_cgetrf_sp2d->_g_p_work );
    free( parsec_cgetrf_sp2d->_g_p_work );
 
    parsec_taskpool_free( taskpool );
}
 
/**
 *******************************************************************************
 *
 * @brief Perform a sparse LU factorization with 1D and 2D kernels.
 *
 * The function performs the LU factorization of a sparse general matrix A.
 * The factorization has the form
 *
 *    \f[ A = L\times U \f]
 *
 * where L is a sparse lower triangular matrix, and U a sparse upper triangular
 * with the same pattern as L^t.
 *
 *******************************************************************************
 *
 * @param[inout] parsec
 *          The parsec context of the application that will run the operation.
 *
 * @param[inout] A
 *          Descriptor of the sparse matrix A.
 *          On exit, A is overwritten with the factorized matrix.
 *
 * @param[inout] sopalin_data
 *          Solver matrix information structure that will guide the algorithm.
 *
 *******************************************************************************
 *
 * @retval NULL if incorrect parameters are given.
 * @retval The parsec taskpool describing the operation that can be
 *         enqueued in the runtime with parsec_enqueue(). It, then, needs to be
 *         destroy with parsec_cgetrf_sp2d_Destruct().
 *
 *******************************************************************************
 *
 * @sa parsec_cgetrf_sp2d_New
 * @sa parsec_cgetrf_sp2d_Destruct
 *
 ******************************************************************************/
int
parsec_cgetrf_sp2d( parsec_context_t     *parsec,
                    parsec_sparse_matrix_desc_t *A,
                    sopalin_data_t       *sopalin_data )
{
    parsec_taskpool_t *parsec_cgetrf_sp2d = NULL;
    int info = 0;
 
    parsec_cgetrf_sp2d = parsec_cgetrf_sp2d_New( A, sopalin_data );
 
    if ( parsec_cgetrf_sp2d == NULL ) {
        return -1;
    }
 
    parsec_context_add_taskpool( parsec, (parsec_taskpool_t*)parsec_cgetrf_sp2d );
    parsec_context_start( parsec );
    parsec_context_wait( parsec );
    parsec_cgetrf_sp2d_Destruct( parsec_cgetrf_sp2d );
 
    return info;
}
 
/**
 *******************************************************************************
 *
 * @brief Perform a sparse LU factorization using PaRSEC runtime.
 *
 * The function performs the LU factorization of a sparse general matrix A.
 * The factorization has the form
 *
 *    \f[ A = L\times U \f]
 *
 * where L is a sparse lower triangular matrix, and U a sparse upper triangular
 * with the same pattern as L^t.
 *
 * The algorithm is automatically chosen between the 1D and 2D version based on
 * the API parameter IPARM_TASKS2D_LEVEL. If IPARM_TASKS2D_LEVEL != 0
 * the 2D scheme is applied, the 1D otherwise.
 *
 *******************************************************************************
 *
 * @param[inout] pastix_data
 *          The pastix_data structure that describes the solver instance.
 *
 * @param[inout] sopalin_data
 *          Solver matrix information structure that will guide the algorithm.
 *
 *******************************************************************************
 *
 * @sa parsec_cgetrf_sp1dplus
 * @sa parsec_cgetrf_sp2d
 *
 ******************************************************************************/
void
parsec_cgetrf( pastix_data_t  *pastix_data,
               sopalin_data_t *sopalin_data )
{
    parsec_sparse_matrix_desc_t *sdesc = sopalin_data->solvmtx->parsec_desc;
    parsec_context_t *ctx;
 
    /*
     * Start PaRSEC if not already started
     */
    if (pastix_data->parsec == NULL) {
        int argc = 0;
        pastix_parsec_init( pastix_data, &argc, NULL, NULL );
    }
    ctx = pastix_data->parsec;
 
    if ( sdesc == NULL ) {
        /* Create the matrix descriptor */
        parsec_sparse_matrix_init( sopalin_data->solvmtx,
                                   sizeof( pastix_complex32_t ), PastixGeneral,
                                   pastix_data->inter_node_procnbr,
                                   pastix_data->inter_node_procnum );
        sdesc = sopalin_data->solvmtx->parsec_desc;
    }
 
    /*
     * Select 1D or 2D jdf based on 2d tasks level
     */
    if ( pastix_data->iparm[IPARM_TASKS2D_LEVEL] != 0 )
    {
        parsec_cgetrf_sp2d( ctx, sdesc,
                            sopalin_data );
    }
    else {
        parsec_cgetrf_sp1dplus( ctx, sdesc,
                                sopalin_data );
    }
 
    return;
}
 
/**
 *@}
 */