/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil ; -*- */

/*

 *  (C) 2011 by Argonne National Laboratory.

 *      See COPYRIGHT in top-level directory.

 */

#include "mpiimpl.h"

/* -- Begin Profiling Symbol Block for routine MPI_T_pvar_get_info */

#if defined(HAVE_PRAGMA_WEAK)

#pragma weak MPI_T_pvar_get_info = PMPI_T_pvar_get_info

#elif defined(HAVE_PRAGMA_HP_SEC_DEF)

#pragma _HP_SECONDARY_DEF PMPI_T_pvar_get_info  MPI_T_pvar_get_info

#elif defined(HAVE_PRAGMA_CRI_DUP)

#pragma _CRI duplicate MPI_T_pvar_get_info as PMPI_T_pvar_get_info

#elif defined(HAVE_WEAK_ATTRIBUTE)

int MPI_T_pvar_get_info(int pvar_index, char *name, int *name_len, int *verbosity, int *var_class,

                        MPI_Datatype *datatype, MPI_T_enum *enumtype, char *desc, int *desc_len,

                        int *binding, int *readonly, int *continuous, int *atomic) __attribute__((weak,alias("PMPI_T_pvar_get_info")));

#endif

/* -- End Profiling Symbol Block */

/* Define MPICH_MPI_FROM_PMPI if weak symbols are not supported to build

   the MPI routines */

#ifndef MPICH_MPI_FROM_PMPI

#undef MPI_T_pvar_get_info

#define MPI_T_pvar_get_info PMPI_T_pvar_get_info

#endif /* MPICH_MPI_FROM_PMPI */

#undef FUNCNAME

#define FUNCNAME MPI_T_pvar_get_info

#undef FCNAME

#define FCNAME MPL_QUOTE(FUNCNAME)

/*@

MPI_T_pvar_get_info - Get the inforamtion about a performance variable

Input/Output Parameters:

+ name_len - length of the string and/or buffer for name (integer)

- desc_len - length of the string and/or buffer for desc (integer)

Input Parameters:

. pvar_index - index of the performance variable to be queried between 0 and num_pvar-1 (integer)

Output Parameters:

+ name - buffer to return the string containing the name of the performance variable (string)

. verbosity - verbosity level of this variable (integer)

. var_class - class of performance variable (integer)

. datatype - MPI type of the information stored in the performance variable (handle)

. enumtype - optional descriptor for enumeration information (handle)

. desc - buffer to return the string containing a description of the performance variable (string)

. binding - type of MPI object to which this variable must be bound (integer)

. readonly - flag indicating whether the variable can be written/reset (integer)

. continuous - flag indicating whether the variable can be started and stopped or is continuously active (integer)

- atomic - flag indicating whether the variable can be atomically read and reset (integer)

.N ThreadSafe

.N Errors

.N MPI_SUCCESS

.N MPI_T_ERR_NOT_INITIALIZED

.N MPI_T_ERR_INVALID_INDEX

@*/

int MPI_T_pvar_get_info(int pvar_index, char *name, int *name_len, int *verbosity,

    int *var_class, MPI_Datatype *datatype, MPI_T_enum *enumtype, char *desc,

    int *desc_len, int *binding, int *readonly, int *continuous, int *atomic)

{

    int mpi_errno = MPI_SUCCESS;

    const pvar_table_entry_t *entry;

    const pvar_table_entry_t *info;

    MPID_MPI_STATE_DECL(MPID_STATE_MPI_T_PVAR_GET_INFO);

    MPIR_ERRTEST_MPIT_INITIALIZED(mpi_errno);

    MPIR_T_THREAD_CS_ENTER();

    MPID_MPI_FUNC_ENTER(MPID_STATE_MPI_T_PVAR_GET_INFO);

    /* Validate parameters */

#   ifdef HAVE_ERROR_CHECKING

    {

        MPID_BEGIN_ERROR_CHECKS

        {

            MPIR_ERRTEST_PVAR_INDEX(pvar_index, mpi_errno);

            /* Do not do _TEST_ARGNULL for other arguments, since this is

             * allowed or will be allowed by MPI_T standard.

             */

        }

        MPID_END_ERROR_CHECKS

    }

#   endif /* HAVE_ERROR_CHECKING */

    /* ... body of routine ...  */

    entry = (pvar_table_entry_t *) utarray_eltptr(pvar_table, pvar_index);

    if (!entry->active) {

        mpi_errno = MPI_T_ERR_INVALID_INDEX;

        goto fn_fail;

    }

    info = (pvar_table_entry_t *) utarray_eltptr(pvar_table, pvar_index);

    MPIR_T_strncpy(name, info->name, name_len);

    MPIR_T_strncpy(desc, info->desc, desc_len);

    if (verbosity != NULL)

        *verbosity = info->verbosity;

    if (var_class != NULL)

        *var_class = info->varclass;

    if (datatype != NULL)

        *datatype = info->datatype;

    if (enumtype != NULL)

        *enumtype = info->enumtype;

    if (binding != NULL)

        *binding = info->bind;

    if (readonly != NULL)

        *readonly = info->flags & MPIR_T_PVAR_FLAG_READONLY;

    if (continuous != NULL)

        *continuous = info->flags & MPIR_T_PVAR_FLAG_CONTINUOUS;

    if (atomic != NULL)

        *atomic = info->flags & MPIR_T_PVAR_FLAG_ATOMIC;

    /* ... end of body of routine ... */

fn_exit:

    MPID_MPI_FUNC_EXIT(MPID_STATE_MPI_T_PVAR_GET_INFO);

    MPIR_T_THREAD_CS_EXIT();

    return mpi_errno;

fn_fail:

    /* --BEGIN ERROR HANDLING-- */

#   ifdef HAVE_ERROR_CHECKING

    {

        mpi_errno = MPIR_Err_create_code(

            mpi_errno, MPIR_ERR_RECOVERABLE, FCNAME, __LINE__, MPI_ERR_OTHER,

            "**mpi_t_pvar_get_info", "**mpi_t_pvar_get_info %d %p %p %p %p %p %p %p %p %p %p %p %p",

            pvar_index, name, name_len, verbosity, var_class, datatype, enumtype, desc, desc_len,

            binding, readonly, continuous, atomic);

    }

#   endif

    mpi_errno = MPIR_Err_return_comm(NULL, FCNAME, mpi_errno);

    goto fn_exit;

    /* --END ERROR HANDLING-- */

}