Blame src/mpi/attr/type_get_attr.c

Packit Service c5cf8c
/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil ; -*- */
Packit Service c5cf8c
/*
Packit Service c5cf8c
 *
Packit Service c5cf8c
 *  (C) 2001 by Argonne National Laboratory.
Packit Service c5cf8c
 *      See COPYRIGHT in top-level directory.
Packit Service c5cf8c
 */
Packit Service c5cf8c
Packit Service c5cf8c
#include "mpiimpl.h"
Packit Service c5cf8c
#include "attr.h"
Packit Service c5cf8c
Packit Service c5cf8c
/* -- Begin Profiling Symbol Block for routine MPI_Type_get_attr */
Packit Service c5cf8c
#if defined(HAVE_PRAGMA_WEAK)
Packit Service c5cf8c
#pragma weak MPI_Type_get_attr = PMPI_Type_get_attr
Packit Service c5cf8c
#elif defined(HAVE_PRAGMA_HP_SEC_DEF)
Packit Service c5cf8c
#pragma _HP_SECONDARY_DEF PMPI_Type_get_attr  MPI_Type_get_attr
Packit Service c5cf8c
#elif defined(HAVE_PRAGMA_CRI_DUP)
Packit Service c5cf8c
#pragma _CRI duplicate MPI_Type_get_attr as PMPI_Type_get_attr
Packit Service c5cf8c
#elif defined(HAVE_WEAK_ATTRIBUTE)
Packit Service c5cf8c
int MPI_Type_get_attr(MPI_Datatype datatype, int type_keyval, void *attribute_val, int *flag)
Packit Service c5cf8c
    __attribute__ ((weak, alias("PMPI_Type_get_attr")));
Packit Service c5cf8c
#endif
Packit Service c5cf8c
/* -- End Profiling Symbol Block */
Packit Service c5cf8c
Packit Service c5cf8c
/* Define MPICH_MPI_FROM_PMPI if weak symbols are not supported to build
Packit Service c5cf8c
   the MPI routines */
Packit Service c5cf8c
#ifndef MPICH_MPI_FROM_PMPI
Packit Service c5cf8c
#undef MPI_Type_get_attr
Packit Service c5cf8c
#define MPI_Type_get_attr PMPI_Type_get_attr
Packit Service c5cf8c
Packit Service c5cf8c
#undef FUNCNAME
Packit Service c5cf8c
#define FUNCNAME MPII_Type_get_attr
Packit Service c5cf8c
#undef FCNAME
Packit Service c5cf8c
#define FCNAME MPL_QUOTE(FUNCNAME)
Packit Service c5cf8c
int MPII_Type_get_attr(MPI_Datatype datatype, int type_keyval, void *attribute_val,
Packit Service c5cf8c
                       int *flag, MPIR_Attr_type outAttrType)
Packit Service c5cf8c
{
Packit Service c5cf8c
    int mpi_errno = MPI_SUCCESS;
Packit Service c5cf8c
    MPIR_Datatype *type_ptr = NULL;
Packit Service c5cf8c
    MPIR_Attribute *p;
Packit Service c5cf8c
    MPIR_FUNC_TERSE_STATE_DECL(MPID_STATE_MPIR_TYPE_GET_ATTR);
Packit Service c5cf8c
Packit Service c5cf8c
    MPIR_ERRTEST_INITIALIZED_ORDIE();
Packit Service c5cf8c
Packit Service c5cf8c
    MPID_THREAD_CS_ENTER(GLOBAL, MPIR_THREAD_GLOBAL_ALLFUNC_MUTEX);
Packit Service c5cf8c
    MPIR_FUNC_TERSE_ENTER(MPID_STATE_MPIR_TYPE_GET_ATTR);
Packit Service c5cf8c
Packit Service c5cf8c
    /* Validate parameters, especially handles needing to be converted */
Packit Service c5cf8c
#ifdef HAVE_ERROR_CHECKING
Packit Service c5cf8c
    {
Packit Service c5cf8c
        MPID_BEGIN_ERROR_CHECKS;
Packit Service c5cf8c
        {
Packit Service c5cf8c
            MPIR_ERRTEST_DATATYPE(datatype, "datatype", mpi_errno);
Packit Service c5cf8c
            MPIR_ERRTEST_KEYVAL(type_keyval, MPIR_DATATYPE, "datatype", mpi_errno);
Packit Service c5cf8c
        }
Packit Service c5cf8c
        MPID_END_ERROR_CHECKS;
Packit Service c5cf8c
    }
Packit Service c5cf8c
#endif
Packit Service c5cf8c
Packit Service c5cf8c
    /* Convert MPI object handles to object pointers */
Packit Service c5cf8c
    MPIR_Datatype_get_ptr(datatype, type_ptr);
Packit Service c5cf8c
Packit Service c5cf8c
    /* Validate parameters and objects (post conversion) */
Packit Service c5cf8c
#ifdef HAVE_ERROR_CHECKING
Packit Service c5cf8c
    {
Packit Service c5cf8c
        MPID_BEGIN_ERROR_CHECKS;
Packit Service c5cf8c
        {
Packit Service c5cf8c
            /* Validate datatype pointer */
Packit Service c5cf8c
            MPIR_Datatype_valid_ptr(type_ptr, mpi_errno);
Packit Service c5cf8c
            /* If type_ptr is not valid, it will be reset to null */
Packit Service c5cf8c
            if (mpi_errno)
Packit Service c5cf8c
                goto fn_fail;
Packit Service c5cf8c
        }
Packit Service c5cf8c
        MPID_END_ERROR_CHECKS;
Packit Service c5cf8c
    }
Packit Service c5cf8c
#endif /* HAVE_ERROR_CHECKING */
Packit Service c5cf8c
Packit Service c5cf8c
    /* ... body of routine ...  */
Packit Service c5cf8c
Packit Service c5cf8c
    *flag = 0;
Packit Service c5cf8c
    p = type_ptr->attributes;
Packit Service c5cf8c
    while (p) {
Packit Service c5cf8c
        if (p->keyval->handle == type_keyval) {
Packit Service c5cf8c
            *flag = 1;
Packit Service c5cf8c
            if (outAttrType == MPIR_ATTR_PTR) {
Packit Service c5cf8c
                if (p->attrType == MPIR_ATTR_INT) {
Packit Service c5cf8c
                    /* This is the tricky case: if the system is
Packit Service c5cf8c
                     * bigendian, and we have to return a pointer to
Packit Service c5cf8c
                     * an int, then we may need to point to the
Packit Service c5cf8c
                     * correct location in the word. */
Packit Service c5cf8c
#if defined(WORDS_LITTLEENDIAN) || (SIZEOF_VOID_P == SIZEOF_INT)
Packit Service c5cf8c
                    *(void **) attribute_val = &(p->value);
Packit Service c5cf8c
#else
Packit Service c5cf8c
                    int *p_loc = (int *) &(p->value);
Packit Service c5cf8c
#if SIZEOF_VOID_P == 2 * SIZEOF_INT
Packit Service c5cf8c
                    p_loc++;
Packit Service c5cf8c
#else
Packit Service c5cf8c
#error Expected sizeof(void*) to be either sizeof(int) or 2*sizeof(int)
Packit Service c5cf8c
#endif
Packit Service c5cf8c
                    *(void **) attribute_val = p_loc;
Packit Service c5cf8c
#endif
Packit Service c5cf8c
                } else if (p->attrType == MPIR_ATTR_AINT) {
Packit Service c5cf8c
                    *(void **) attribute_val = &(p->value);
Packit Service c5cf8c
                } else {
Packit Service c5cf8c
                    *(void **) attribute_val = (void *) (intptr_t) (p->value);
Packit Service c5cf8c
                }
Packit Service c5cf8c
            } else
Packit Service c5cf8c
                *(void **) attribute_val = (void *) (intptr_t) (p->value);
Packit Service c5cf8c
Packit Service c5cf8c
            break;
Packit Service c5cf8c
        }
Packit Service c5cf8c
        p = p->next;
Packit Service c5cf8c
    }
Packit Service c5cf8c
Packit Service c5cf8c
    /* ... end of body of routine ... */
Packit Service c5cf8c
Packit Service c5cf8c
#ifdef HAVE_ERROR_CHECKING
Packit Service c5cf8c
  fn_exit:
Packit Service c5cf8c
#endif
Packit Service c5cf8c
    MPIR_FUNC_TERSE_EXIT(MPID_STATE_MPIR_TYPE_GET_ATTR);
Packit Service c5cf8c
    MPID_THREAD_CS_EXIT(GLOBAL, MPIR_THREAD_GLOBAL_ALLFUNC_MUTEX);
Packit Service c5cf8c
    return mpi_errno;
Packit Service c5cf8c
Packit Service c5cf8c
    /* --BEGIN ERROR HANDLING-- */
Packit Service c5cf8c
#ifdef HAVE_ERROR_CHECKING
Packit Service c5cf8c
  fn_fail:
Packit Service c5cf8c
    {
Packit Service c5cf8c
        mpi_errno =
Packit Service c5cf8c
            MPIR_Err_create_code(mpi_errno, MPIR_ERR_RECOVERABLE, FCNAME, __LINE__, MPI_ERR_OTHER,
Packit Service c5cf8c
                                 "**mpir_type_get_attr", "**mpir_type_get_attr %D %d %p %p",
Packit Service c5cf8c
                                 datatype, type_keyval, attribute_val, flag);
Packit Service c5cf8c
    }
Packit Service c5cf8c
    mpi_errno = MPIR_Err_return_comm(NULL, FCNAME, mpi_errno);
Packit Service c5cf8c
    goto fn_exit;
Packit Service c5cf8c
#endif
Packit Service c5cf8c
    /* --END ERROR HANDLING-- */
Packit Service c5cf8c
}
Packit Service c5cf8c
#endif
Packit Service c5cf8c
Packit Service c5cf8c
#undef FUNCNAME
Packit Service c5cf8c
#define FUNCNAME MPI_Type_get_attr
Packit Service c5cf8c
#undef FCNAME
Packit Service c5cf8c
#define FCNAME MPL_QUOTE(FUNCNAME)
Packit Service c5cf8c
Packit Service c5cf8c
/*@
Packit Service c5cf8c
   MPI_Type_get_attr - Retrieves attribute value by key
Packit Service c5cf8c
Packit Service c5cf8c
Input Parameters:
Packit Service c5cf8c
+ datatype - datatype to which the attribute is attached (handle)
Packit Service c5cf8c
- type_keyval - key value (integer)
Packit Service c5cf8c
Packit Service c5cf8c
Output Parameters:
Packit Service c5cf8c
+ attribute_val - attribute value, unless flag = false
Packit Service c5cf8c
- flag - false if no attribute is associated with the key (logical)
Packit Service c5cf8c
Packit Service c5cf8c
   Notes:
Packit Service c5cf8c
    Attributes must be extracted from the same language as they were inserted
Packit Service c5cf8c
    in with 'MPI_Type_set_attr'.  The notes for C and Fortran below explain
Packit Service c5cf8c
    why.
Packit Service c5cf8c
Packit Service c5cf8c
Notes for C:
Packit Service c5cf8c
    Even though the 'attr_value' argument is declared as 'void *', it is
Packit Service c5cf8c
    really the address of a void pointer.  See the rationale in the
Packit Service c5cf8c
    standard for more details.
Packit Service c5cf8c
Packit Service c5cf8c
.N ThreadSafe
Packit Service c5cf8c
Packit Service c5cf8c
.N Fortran
Packit Service c5cf8c
Packit Service c5cf8c
.N Errors
Packit Service c5cf8c
.N MPI_SUCCESS
Packit Service c5cf8c
.N MPI_ERR_KEYVAL
Packit Service c5cf8c
.N MPI_ERR_ARG
Packit Service c5cf8c
@*/
Packit Service c5cf8c
int MPI_Type_get_attr(MPI_Datatype datatype, int type_keyval, void *attribute_val, int *flag)
Packit Service c5cf8c
{
Packit Service c5cf8c
    int mpi_errno = MPI_SUCCESS;
Packit Service c5cf8c
    MPIR_FUNC_TERSE_STATE_DECL(MPID_STATE_MPI_TYPE_GET_ATTR);
Packit Service c5cf8c
Packit Service c5cf8c
    MPIR_ERRTEST_INITIALIZED_ORDIE();
Packit Service c5cf8c
Packit Service c5cf8c
    MPIR_FUNC_TERSE_ENTER(MPID_STATE_MPI_TYPE_GET_ATTR);
Packit Service c5cf8c
Packit Service c5cf8c
    /* ... body of routine ...  */
Packit Service c5cf8c
    mpi_errno = MPII_Type_get_attr(datatype, type_keyval, attribute_val, flag, MPIR_ATTR_PTR);
Packit Service c5cf8c
    if (mpi_errno)
Packit Service c5cf8c
        goto fn_fail;
Packit Service c5cf8c
Packit Service c5cf8c
    /* ... end of body of routine ... */
Packit Service c5cf8c
Packit Service c5cf8c
  fn_exit:
Packit Service c5cf8c
    MPIR_FUNC_TERSE_EXIT(MPID_STATE_MPI_TYPE_GET_ATTR);
Packit Service c5cf8c
    return mpi_errno;
Packit Service c5cf8c
Packit Service c5cf8c
    /* --BEGIN ERROR HANDLING-- */
Packit Service c5cf8c
  fn_fail:
Packit Service c5cf8c
#ifdef HAVE_ERROR_CHECKING
Packit Service c5cf8c
    {
Packit Service c5cf8c
        mpi_errno =
Packit Service c5cf8c
            MPIR_Err_create_code(mpi_errno, MPIR_ERR_RECOVERABLE, FCNAME, __LINE__, MPI_ERR_OTHER,
Packit Service c5cf8c
                                 "**mpi_type_get_attr", "**mpi_type_get_attr %D %d %p %p", datatype,
Packit Service c5cf8c
                                 type_keyval, attribute_val, flag);
Packit Service c5cf8c
    }
Packit Service c5cf8c
#endif
Packit Service c5cf8c
    mpi_errno = MPIR_Err_return_comm(NULL, FCNAME, mpi_errno);
Packit Service c5cf8c
    goto fn_exit;
Packit Service c5cf8c
    /* --END ERROR HANDLING-- */
Packit Service c5cf8c
}