/*! \file
Copyright (c) 2003, The Regents of the University of California, through
Lawrence Berkeley National Laboratory (subject to receipt of any required
approvals from U.S. Dept. of Energy)

All rights reserved.

The source code is distributed under BSD license, see the file License.txt
at the top-level directory.
*/


/*! @file
 * \brief Memory utilities
 *
 * <pre>
 * -- Distributed SuperLU routine (version 9.0) --
 * Lawrence Berkeley National Lab, Univ. of California Berkeley.
 * October 1, 2014
 * </pre>
 */

#include "superlu_sdefs.h"


/* Variables external to this file */
extern SuperLU_LU_stack_t stack;


void *suser_malloc_dist(int_t bytes, int_t which_end)
{
    void *buf;

    if ( SuperLU_StackFull(bytes) ) return (NULL);

    if ( which_end == HEAD ) {
	buf = (char*) stack.array + stack.top1;
	stack.top1 += bytes;
    } else {
	stack.top2 -= bytes;
	buf = (char*) stack.array + stack.top2;
    }

    stack.used += bytes;
    return buf;
}


void suser_free_dist(int_t bytes, int_t which_end)
{
    if ( which_end == HEAD ) {
	stack.top1 -= bytes;
    } else {
	stack.top2 += bytes;
    }
    stack.used -= bytes;
}



/*! \brief
 *
 * <pre>
 * mem_usage consists of the following fields:
 *    - for_lu (float)
 *      The amount of space used in bytes for the L\U data structures.
 *    - total (float)
 *      The amount of space needed in bytes to perform factorization.
 *    - expansions (int)
 *      Number of memory expansions during the LU factorization.
 * </pre>
 */
int_t sQuerySpace_dist(int_t n, sLUstruct_t *LUstruct, gridinfo_t *grid,
		       SuperLUStat_t *stat, superlu_dist_mem_usage_t *mem_usage)
{
    register int_t dword, gb, iword, k, nb, nsupers;
    int_t *index, *xsup;
    int iam, mycol, myrow;
    Glu_persist_t *Glu_persist = LUstruct->Glu_persist;
    sLocalLU_t *Llu = LUstruct->Llu;

    iam = grid->iam;
    myrow = MYROW( iam, grid );
    mycol = MYCOL( iam, grid );
    iword = sizeof(int_t);
    dword = sizeof(float);
    nsupers = Glu_persist->supno[n-1] + 1;
    xsup = Glu_persist->xsup;
    mem_usage->for_lu = 0.;

    /* For L factor */
    nb = CEILING( nsupers, grid->npcol ); /* Number of local column blocks */
    for (k = 0; k < nb; ++k) {
	gb = k * grid->npcol + mycol; /* Global block number. */
	if ( gb < nsupers ) {
	    index = Llu->Lrowind_bc_ptr[k];
	    if ( index ) {
		mem_usage->for_lu += (float)
		    ((BC_HEADER + index[0]*LB_DESCRIPTOR + index[1]) * iword);
		mem_usage->for_lu += (float)(index[1]*SuperSize( gb )*dword);
	    }
	}
    }

    /* For U factor */
    nb = CEILING( nsupers, grid->nprow ); /* Number of local row blocks */
    for (k = 0; k < nb; ++k) {
	gb = k * grid->nprow + myrow; /* Global block number. */
	if ( gb < nsupers ) {
	    index = Llu->Ufstnz_br_ptr[k];
	    if ( index ) {
		mem_usage->for_lu += (float)(index[2] * iword);
		mem_usage->for_lu += (float)(index[1] * dword);
	    }
	}
    }

    /* Working storage to support factorization */
    mem_usage->total = mem_usage->for_lu;
#if 0
    mem_usage->total +=
	(float)(( Llu->bufmax[0] + Llu->bufmax[2] ) * iword +
		( Llu->bufmax[1] + Llu->bufmax[3] + maxsup ) * dword );
    /**** another buffer to use mpi_irecv in pdgstrf_irecv.c ****/
    mem_usage->total +=
	(float)( Llu->bufmax[0] * iword +  Llu->bufmax[1] * dword );
    mem_usage->total += (float)( maxsup * maxsup + maxsup) * iword;
    k = CEILING( nsupers, grid->nprow );
    mem_usage->total += (float)(2 * k * iword);
#else
    /*mem_usage->total += stat->current_buffer;*/
    mem_usage->total += stat->peak_buffer;

#if ( PRNTlevel>=1 )
    if (iam==0) printf(".. sQuerySpace: peak_buffer %.2f (MB)\n",
                       stat->peak_buffer * 1.0e-6);
#endif
#endif
    return 0;
} /* sQuerySpace_dist */


/*
 * Allocate storage for original matrix A
 */
void
sallocateA_dist(int_t n, int_t nnz, float **a, int_t **asub, int_t **xa)
{
    *a    = (float *) floatMalloc_dist(nnz);
    *asub = (int_t *) intMalloc_dist(nnz);
    *xa   = (int_t *) intMalloc_dist(n+1);
}


float *floatMalloc_dist(int_t n)
{
    float *buf;
    buf = (float *) SUPERLU_MALLOC( SUPERLU_MAX(1, n) * sizeof(float) );
    return (buf);
}

float *floatCalloc_dist(int_t n)
{
    float *buf;
    register int_t i;
    float zero = 0.0;
    buf = (float *) SUPERLU_MALLOC( SUPERLU_MAX(1, n) * sizeof(float));
    if ( !buf ) return (buf);
    for (i = 0; i < n; ++i) buf[i] = zero;
    return (buf);
}

/***************************************
 * The following are from 3D code.
 ***************************************/

double sgetLUMem(int_t nodeId, sLUstruct_t *LUstruct, gridinfo3d_t *grid3d)
{
    double memlu = 0.0;
    gridinfo_t* grid = &(grid3d->grid2d);
    sLocalLU_t *Llu = LUstruct->Llu;
    int_t* xsup = LUstruct->Glu_persist->xsup;
    int_t** Lrowind_bc_ptr = Llu->Lrowind_bc_ptr;
    float** Lnzval_bc_ptr = Llu->Lnzval_bc_ptr;
    int_t** Ufstnz_br_ptr = Llu->Ufstnz_br_ptr;
    // double** Unzval_br_ptr = Llu->Unzval_br_ptr;
    int_t iam = grid->iam;

    int_t myrow = MYROW (iam, grid);
    int_t mycol = MYCOL (iam, grid);

    int_t pc = PCOL( nodeId, grid );
    if (mycol == pc)
    {
        int_t ljb = LBj( nodeId, grid ); /* Local block number */
        int_t  *lsub;
        float* lnzval;
        lsub = Lrowind_bc_ptr[ljb];
        lnzval = Lnzval_bc_ptr[ljb];

        if (lsub != NULL)
        {
            int_t nrbl  =   lsub[0]; /*number of L blocks */
            int_t  len   = lsub[1];       /* LDA of the nzval[] */
            int_t len1  = len + BC_HEADER + nrbl * LB_DESCRIPTOR;
            int_t len2  = SuperSize(nodeId) * len;
            memlu += 1.0 * (len1 * sizeof(int_t)  + len2 * sizeof(float));
        }
    }

    int_t pr = PROW( nodeId, grid );
    if (myrow == pr)
    {
        int_t lib = LBi( nodeId, grid ); /* Local block number */
        int_t  *usub;
        // double* unzval;
        usub = Ufstnz_br_ptr[lib];

        if (usub != NULL)
        {
            int_t lenv = usub[1];
            int_t lens = usub[2];
            memlu += 1.0 * (lenv * sizeof(int_t)  + lens * sizeof(float));
        }
    }
    return memlu;
}

double  smemForest(sForest_t*sforest, sLUstruct_t *LUstruct, gridinfo3d_t *grid3d)
{
    double memlu = 0;

    int_t *perm_c_supno = sforest->nodeList;
    int_t nnodes =   sforest->nNodes;
    for (int i = 0; i < nnodes; ++i)
    {
        memlu += sgetLUMem(perm_c_supno[i], LUstruct, grid3d);
    }

    return memlu;
}

void s3D_printMemUse( strf3Dpartition_t*  trf3Dpartition,  sLUstruct_t *LUstruct,
		      gridinfo3d_t * grid3d )
{
    int_t* myTreeIdxs = trf3Dpartition->myTreeIdxs;
    int_t* myZeroTrIdxs = trf3Dpartition->myZeroTrIdxs;
    sForest_t** sForests = trf3Dpartition->sForests;

    double memNzLU = 0.0;
    double memzLU = 0.0;
    int_t maxLvl = log2i(grid3d->zscp.Np) + 1;

    for (int_t ilvl = 0; ilvl < maxLvl; ++ilvl)
    {
        sForest_t* sforest = sForests[myTreeIdxs[ilvl]];

        if (sforest)
        {
            if (!myZeroTrIdxs[ilvl])
            {
                memNzLU += smemForest(sforest, LUstruct, grid3d);
            }
            else
            {
                memzLU += smemForest(sforest, LUstruct, grid3d);
            }
        }
    }
    double sumMem = memNzLU + memzLU;
    double maxMem, minMem,  avgNzLU, avgzLU;
    /*Now reduce it among all the procs*/
    MPI_Reduce(&sumMem, &maxMem, 1, MPI_DOUBLE, MPI_MAX, 0, grid3d->comm);
    MPI_Reduce(&sumMem, &minMem, 1, MPI_DOUBLE, MPI_MIN, 0, grid3d->comm);
    MPI_Reduce(&memNzLU, &avgNzLU, 1, MPI_DOUBLE, MPI_SUM, 0, grid3d->comm);
    MPI_Reduce(&memzLU, &avgzLU, 1, MPI_DOUBLE, MPI_SUM, 0, grid3d->comm);

    int_t nProcs = grid3d->nprow * grid3d->npcol * grid3d->npdep;
    if (!(grid3d->iam))
    {
        /* code */
        printf("| Total Memory \t| %.2g  \t| %.2g  \t|%.2g  \t|\n", (avgNzLU + avgzLU) / nProcs, maxMem, minMem );
        printf("| LU-LU(repli) \t| %.2g  \t| %.2g  \t|\n", (avgNzLU) / nProcs, avgzLU / nProcs );
    }
}

