Blame src/mpi/datatype/get_count.c

Packit Service c5cf8c
/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil ; -*- */
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
Packit Service c5cf8c
/* -- Begin Profiling Symbol Block for routine MPI_Get_count */
Packit Service c5cf8c
#if defined(HAVE_PRAGMA_WEAK)
Packit Service c5cf8c
#pragma weak MPI_Get_count = PMPI_Get_count
Packit Service c5cf8c
#elif defined(HAVE_PRAGMA_HP_SEC_DEF)
Packit Service c5cf8c
#pragma _HP_SECONDARY_DEF PMPI_Get_count  MPI_Get_count
Packit Service c5cf8c
#elif defined(HAVE_PRAGMA_CRI_DUP)
Packit Service c5cf8c
#pragma _CRI duplicate MPI_Get_count as PMPI_Get_count
Packit Service c5cf8c
#elif defined(HAVE_WEAK_ATTRIBUTE)
Packit Service c5cf8c
int MPI_Get_count(const MPI_Status * status, MPI_Datatype datatype, int *count)
Packit Service c5cf8c
    __attribute__ ((weak, alias("PMPI_Get_count")));
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_Get_count
Packit Service c5cf8c
#define MPI_Get_count PMPI_Get_count
Packit Service c5cf8c
Packit Service c5cf8c
#undef FUNCNAME
Packit Service c5cf8c
#define FUNCNAME MPIR_Get_count_impl
Packit Service c5cf8c
#undef FCNAME
Packit Service c5cf8c
#define FCNAME MPL_QUOTE(FUNCNAME)
Packit Service c5cf8c
void MPIR_Get_count_impl(const MPI_Status * status, MPI_Datatype datatype, MPI_Aint * count)
Packit Service c5cf8c
{
Packit Service c5cf8c
    MPI_Aint size;
Packit Service c5cf8c
Packit Service c5cf8c
    MPIR_Datatype_get_size_macro(datatype, size);
Packit Service c5cf8c
    MPIR_Assert(size >= 0 && MPIR_STATUS_GET_COUNT(*status) >= 0);
Packit Service c5cf8c
    if (size != 0) {
Packit Service c5cf8c
        /* MPI-3 says return MPI_UNDEFINED if too large for an int */
Packit Service c5cf8c
        if ((MPIR_STATUS_GET_COUNT(*status) % size) != 0)
Packit Service c5cf8c
            (*count) = MPI_UNDEFINED;
Packit Service c5cf8c
        else
Packit Service c5cf8c
            (*count) = (MPI_Aint) (MPIR_STATUS_GET_COUNT(*status) / size);
Packit Service c5cf8c
    } else {
Packit Service c5cf8c
        if (MPIR_STATUS_GET_COUNT(*status) > 0) {
Packit Service c5cf8c
            /* --BEGIN ERROR HANDLING-- */
Packit Service c5cf8c
Packit Service c5cf8c
            /* case where datatype size is 0 and count is > 0 should
Packit Service c5cf8c
             * never occur.
Packit Service c5cf8c
             */
Packit Service c5cf8c
Packit Service c5cf8c
            (*count) = MPI_UNDEFINED;
Packit Service c5cf8c
            /* --END ERROR HANDLING-- */
Packit Service c5cf8c
        } else {
Packit Service c5cf8c
            /* This is ambiguous.  However, discussions on MPI Forum
Packit Service c5cf8c
             * reached a consensus that this is the correct return
Packit Service c5cf8c
             * value
Packit Service c5cf8c
             */
Packit Service c5cf8c
            (*count) = 0;
Packit Service c5cf8c
        }
Packit Service c5cf8c
    }
Packit Service c5cf8c
}
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
#endif
Packit Service c5cf8c
Packit Service c5cf8c
#undef FUNCNAME
Packit Service c5cf8c
#define FUNCNAME MPI_Get_count
Packit Service c5cf8c
#undef FCNAME
Packit Service c5cf8c
#define FCNAME MPL_QUOTE(FUNCNAME)
Packit Service c5cf8c
/*@
Packit Service c5cf8c
  MPI_Get_count - Gets the number of "top level" elements
Packit Service c5cf8c
Packit Service c5cf8c
Input Parameters:
Packit Service c5cf8c
+ status - return status of receive operation (Status)
Packit Service c5cf8c
- datatype - datatype of each receive buffer element (handle)
Packit Service c5cf8c
Packit Service c5cf8c
Output Parameters:
Packit Service c5cf8c
. count - number of received elements (integer)
Packit Service c5cf8c
Notes:
Packit Service c5cf8c
If the size of the datatype is zero, this routine will return a count of
Packit Service c5cf8c
zero.  If the amount of data in 'status' is not an exact multiple of the
Packit Service c5cf8c
size of 'datatype' (so that 'count' would not be integral), a 'count' of
Packit Service c5cf8c
'MPI_UNDEFINED' is returned instead.
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_TYPE
Packit Service c5cf8c
@*/
Packit Service c5cf8c
int MPI_Get_count(const MPI_Status * status, MPI_Datatype datatype, int *count)
Packit Service c5cf8c
{
Packit Service c5cf8c
    int mpi_errno = MPI_SUCCESS;
Packit Service c5cf8c
    MPI_Aint count_x;
Packit Service c5cf8c
    MPIR_FUNC_TERSE_STATE_DECL(MPID_STATE_MPI_GET_COUNT);
Packit Service c5cf8c
Packit Service c5cf8c
    MPIR_ERRTEST_INITIALIZED_ORDIE();
Packit Service c5cf8c
Packit Service c5cf8c
    MPIR_FUNC_TERSE_ENTER(MPID_STATE_MPI_GET_COUNT);
Packit Service c5cf8c
Packit Service c5cf8c
#ifdef HAVE_ERROR_CHECKING
Packit Service c5cf8c
    {
Packit Service c5cf8c
        MPID_BEGIN_ERROR_CHECKS;
Packit Service c5cf8c
        {
Packit Service c5cf8c
            MPIR_Datatype *datatype_ptr = NULL;
Packit Service c5cf8c
Packit Service c5cf8c
            MPIR_ERRTEST_ARGNULL(status, "status", mpi_errno);
Packit Service c5cf8c
            MPIR_ERRTEST_ARGNULL(count, "count", mpi_errno);
Packit Service c5cf8c
            MPIR_ERRTEST_DATATYPE(datatype, "datatype", mpi_errno);
Packit Service c5cf8c
Packit Service c5cf8c
            /* Validate datatype_ptr */
Packit Service c5cf8c
            if (HANDLE_GET_KIND(datatype) != HANDLE_KIND_BUILTIN) {
Packit Service c5cf8c
                MPIR_Datatype_get_ptr(datatype, datatype_ptr);
Packit Service c5cf8c
                MPIR_Datatype_valid_ptr(datatype_ptr, mpi_errno);
Packit Service c5cf8c
                if (mpi_errno)
Packit Service c5cf8c
                    goto fn_fail;
Packit Service c5cf8c
                /* Q: Must the type be committed to be used with this function? */
Packit Service c5cf8c
            }
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
    MPIR_Get_count_impl(status, datatype, &count_x);
Packit Service c5cf8c
Packit Service c5cf8c
    /* clip the value if it cannot be correctly returned to the user */
Packit Service c5cf8c
    *count = (count_x > INT_MAX) ? MPI_UNDEFINED : (int) count_x;
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_MPI_GET_COUNT);
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
                                 "**mpi_get_count", "**mpi_get_count %p %D %p", status, datatype,
Packit Service c5cf8c
                                 count);
Packit Service c5cf8c
    }
Packit Service c5cf8c
    mpi_errno = MPIR_Err_return_comm(0, FCNAME, mpi_errno);
Packit Service c5cf8c
    goto fn_exit;
Packit Service c5cf8c
#endif
Packit Service c5cf8c
    /* --END ERROR HANDLING-- */
Packit Service c5cf8c
}