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

/*

 *  (C) 2012 by Argonne National Laboratory.

 *      See COPYRIGHT in top-level directory.

 */

#include "mpiimpl.h"

/*

=== BEGIN_MPI_T_CVAR_INFO_BLOCK ===

cvars:

    - name        : MPIR_CVAR_NEIGHBOR_ALLGATHER_INTRA_ALGORITHM

      category    : COLLECTIVE

      type        : string

      default     : auto

      class       : device

      verbosity   : MPI_T_VERBOSITY_USER_BASIC

      scope       : MPI_T_SCOPE_ALL_EQ

      description : |-

        Variable to select ineighbor_allgather algorithm

        auto - Internal algorithm selection

        nb   - Force nonblocking algorithm

    - name        : MPIR_CVAR_NEIGHBOR_ALLGATHER_INTER_ALGORITHM

      category    : COLLECTIVE

      type        : string

      default     : auto

      class       : device

      verbosity   : MPI_T_VERBOSITY_USER_BASIC

      scope       : MPI_T_SCOPE_ALL_EQ

      description : |-

        Variable to select ineighbor_allgather algorithm

        auto - Internal algorithm selection

        nb   - Force nonblocking algorithm

    - name        : MPIR_CVAR_NEIGHBOR_ALLGATHER_DEVICE_COLLECTIVE

      category    : COLLECTIVE

      type        : boolean

      default     : true

      class       : device

      verbosity   : MPI_T_VERBOSITY_USER_BASIC

      scope       : MPI_T_SCOPE_ALL_EQ

      description : >-

        If set to true, MPI_neighbor_allgather will allow the device to override the

        MPIR-level collective algorithms. The device still has the

        option to call the MPIR-level algorithms manually.

        If set to false, the device-level neighbor_allgather function will not be

        called.

=== END_MPI_T_CVAR_INFO_BLOCK ===

*/

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

#if defined(HAVE_PRAGMA_WEAK)

#pragma weak MPI_Neighbor_allgather = PMPI_Neighbor_allgather

#elif defined(HAVE_PRAGMA_HP_SEC_DEF)

#pragma _HP_SECONDARY_DEF PMPI_Neighbor_allgather  MPI_Neighbor_allgather

#elif defined(HAVE_PRAGMA_CRI_DUP)

#pragma _CRI duplicate MPI_Neighbor_allgather as PMPI_Neighbor_allgather

#elif defined(HAVE_WEAK_ATTRIBUTE)

int MPI_Neighbor_allgather(const void *sendbuf, int sendcount, MPI_Datatype sendtype,

                           void *recvbuf, int recvcount, MPI_Datatype recvtype, MPI_Comm comm)

    __attribute__ ((weak, alias("PMPI_Neighbor_allgather")));

#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_Neighbor_allgather

#define MPI_Neighbor_allgather PMPI_Neighbor_allgather

/* any non-MPI functions go here, especially non-static ones */

#undef FUNCNAME

#define FUNCNAME MPIR_Neighbor_allgather_intra_auto

#undef FCNAME

#define FCNAME MPL_QUOTE(FUNCNAME)

int MPIR_Neighbor_allgather_intra_auto(const void *sendbuf, int sendcount, MPI_Datatype sendtype,

                                       void *recvbuf, int recvcount, MPI_Datatype recvtype,

                                       MPIR_Comm * comm_ptr)

{

    int mpi_errno = MPI_SUCCESS;

    mpi_errno =

        MPIR_Neighbor_allgather_allcomm_nb(sendbuf, sendcount, sendtype, recvbuf, recvcount,

                                           recvtype, comm_ptr);

    if (mpi_errno)

        MPIR_ERR_POP(mpi_errno);

  fn_exit:

    return mpi_errno;

  fn_fail:

    goto fn_exit;

}

#undef FUNCNAME

#define FUNCNAME MPIR_Neighbor_allgather_inter_auto

#undef FCNAME

#define FCNAME MPL_QUOTE(FUNCNAME)

int MPIR_Neighbor_allgather_inter_auto(const void *sendbuf, int sendcount, MPI_Datatype sendtype,

                                       void *recvbuf, int recvcount, MPI_Datatype recvtype,

                                       MPIR_Comm * comm_ptr)

{

    int mpi_errno = MPI_SUCCESS;

    mpi_errno =

        MPIR_Neighbor_allgather_allcomm_nb(sendbuf, sendcount, sendtype, recvbuf, recvcount,

                                           recvtype, comm_ptr);

    if (mpi_errno)

        MPIR_ERR_POP(mpi_errno);

  fn_exit:

    return mpi_errno;

  fn_fail:

    goto fn_exit;

}

#undef FUNCNAME

#define FUNCNAME MPIR_Neighbor_allgather_impl

#undef FCNAME

#define FCNAME MPL_QUOTE(FUNCNAME)

int MPIR_Neighbor_allgather_impl(const void *sendbuf, int sendcount,

                                 MPI_Datatype sendtype, void *recvbuf,

                                 int recvcount, MPI_Datatype recvtype, MPIR_Comm * comm_ptr)

{

    int mpi_errno = MPI_SUCCESS;

    if (comm_ptr->comm_kind == MPIR_COMM_KIND__INTRACOMM) {

        switch (MPIR_Neighbor_allgather_intra_algo_choice) {

            case MPIR_NEIGHBOR_ALLGATHER_INTRA_ALGO_NB:

                mpi_errno =

                    MPIR_Neighbor_allgather_allcomm_nb(sendbuf, sendcount, sendtype, recvbuf,

                                                       recvcount, recvtype, comm_ptr);

                break;

            case MPIR_NEIGHBOR_ALLGATHER_INTRA_ALGO_AUTO:

                MPL_FALLTHROUGH;

            default:

                mpi_errno =

                    MPIR_Neighbor_allgather_intra_auto(sendbuf, sendcount, sendtype, recvbuf,

                                                       recvcount, recvtype, comm_ptr);

                break;

        }

    } else {

        switch (MPIR_Neighbor_allgather_inter_algo_choice) {

            case MPIR_NEIGHBOR_ALLGATHER_INTER_ALGO_NB:

                mpi_errno =

                    MPIR_Neighbor_allgather_allcomm_nb(sendbuf, sendcount, sendtype, recvbuf,

                                                       recvcount, recvtype, comm_ptr);

                break;

            case MPIR_NEIGHBOR_ALLGATHER_INTER_ALGO_AUTO:

                MPL_FALLTHROUGH;

            default:

                mpi_errno =

                    MPIR_Neighbor_allgather_inter_auto(sendbuf, sendcount, sendtype, recvbuf,

                                                       recvcount, recvtype, comm_ptr);

                break;

        }

    }

    if (mpi_errno)

        MPIR_ERR_POP(mpi_errno);

  fn_exit:

    return mpi_errno;

  fn_fail:

    goto fn_exit;

}

#undef FUNCNAME

#define FUNCNAME MPIR_Neighbor_allgather

#undef FCNAME

#define FCNAME MPL_QUOTE(FUNCNAME)

int MPIR_Neighbor_allgather(const void *sendbuf, int sendcount,

                            MPI_Datatype sendtype, void *recvbuf,

                            int recvcount, MPI_Datatype recvtype, MPIR_Comm * comm_ptr)

{

    int mpi_errno = MPI_SUCCESS;

    if (MPIR_CVAR_BARRIER_DEVICE_COLLECTIVE && MPIR_CVAR_DEVICE_COLLECTIVES) {

        mpi_errno = MPID_Neighbor_allgather(sendbuf, sendcount, sendtype,

                                            recvbuf, recvcount, recvtype, comm_ptr);

    } else {

        mpi_errno = MPIR_Neighbor_allgather_impl(sendbuf, sendcount, sendtype,

                                                 recvbuf, recvcount, recvtype, comm_ptr);

    }

    return mpi_errno;

}

#endif /* MPICH_MPI_FROM_PMPI */

#undef FUNCNAME

#define FUNCNAME MPI_Neighbor_allgather

#undef FCNAME

#define FCNAME MPL_QUOTE(FUNCNAME)

/*@

MPI_Neighbor_allgather - In this function, each process i gathers data items

from each process j if an edge (j,i) exists in the topology graph, and each

process i sends the same data items to all processes j where an edge (i,j)

exists. The send buffer is sent to each neighboring process and the l-th block

in the receive buffer is received from the l-th neighbor.

Input Parameters:

+ sendbuf - starting address of the send buffer (choice)

. sendcount - number of elements sent to each neighbor (non-negative integer)

. sendtype - data type of send buffer elements (handle)

. recvcount - number of elements received from each neighbor (non-negative integer)

. recvtype - data type of receive buffer elements (handle)

- comm - communicator (handle)

Output Parameters:

. recvbuf - starting address of the receive buffer (choice)

.N ThreadSafe

.N Fortran

.N Errors

@*/

int MPI_Neighbor_allgather(const void *sendbuf, int sendcount, MPI_Datatype sendtype, void *recvbuf,

                           int recvcount, MPI_Datatype recvtype, MPI_Comm comm)

{

    int mpi_errno = MPI_SUCCESS;

    MPIR_Comm *comm_ptr = NULL;

    MPIR_FUNC_TERSE_STATE_DECL(MPID_STATE_MPI_NEIGHBOR_ALLGATHER);

    MPID_THREAD_CS_ENTER(GLOBAL, MPIR_THREAD_GLOBAL_ALLFUNC_MUTEX);

    MPIR_FUNC_TERSE_ENTER(MPID_STATE_MPI_NEIGHBOR_ALLGATHER);

    /* Validate parameters, especially handles needing to be converted */

#ifdef HAVE_ERROR_CHECKING

    {

        MPID_BEGIN_ERROR_CHECKS;

        {

            MPIR_ERRTEST_DATATYPE(sendtype, "sendtype", mpi_errno);

            MPIR_ERRTEST_DATATYPE(recvtype, "recvtype", mpi_errno);

            MPIR_ERRTEST_COMM(comm, mpi_errno);

            /* TODO more checks may be appropriate */

        }

        MPID_END_ERROR_CHECKS;

    }

#endif /* HAVE_ERROR_CHECKING */

    /* Convert MPI object handles to object pointers */

    MPIR_Comm_get_ptr(comm, comm_ptr);

    /* Validate parameters and objects (post conversion) */

#ifdef HAVE_ERROR_CHECKING

    {

        MPID_BEGIN_ERROR_CHECKS;

        {

            if (HANDLE_GET_KIND(sendtype) != HANDLE_KIND_BUILTIN) {

                MPIR_Datatype *sendtype_ptr = NULL;

                MPIR_Datatype_get_ptr(sendtype, sendtype_ptr);

                MPIR_Datatype_valid_ptr(sendtype_ptr, mpi_errno);

                MPIR_Datatype_committed_ptr(sendtype_ptr, mpi_errno);

            }

            if (HANDLE_GET_KIND(recvtype) != HANDLE_KIND_BUILTIN) {

                MPIR_Datatype *recvtype_ptr = NULL;

                MPIR_Datatype_get_ptr(recvtype, recvtype_ptr);

                MPIR_Datatype_valid_ptr(recvtype_ptr, mpi_errno);

                MPIR_Datatype_committed_ptr(recvtype_ptr, mpi_errno);

            }

            MPIR_Comm_valid_ptr(comm_ptr, mpi_errno, FALSE);

            /* TODO more checks may be appropriate (counts, in_place, buffer aliasing, etc) */

            if (mpi_errno != MPI_SUCCESS)

                goto fn_fail;

        }

        MPID_END_ERROR_CHECKS;

    }

#endif /* HAVE_ERROR_CHECKING */

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

    mpi_errno = MPIR_Neighbor_allgather(sendbuf, sendcount, sendtype, recvbuf,

                                        recvcount, recvtype, comm_ptr);

    if (mpi_errno)

        MPIR_ERR_POP(mpi_errno);

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

  fn_exit:

    MPIR_FUNC_TERSE_EXIT(MPID_STATE_MPI_NEIGHBOR_ALLGATHER);

    MPID_THREAD_CS_EXIT(GLOBAL, MPIR_THREAD_GLOBAL_ALLFUNC_MUTEX);

    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_neighbor_allgather",

                                 "**mpi_neighbor_allgather %p %d %D %p %d %D %C", sendbuf,

                                 sendcount, sendtype, recvbuf, recvcount, recvtype, comm);

    }

#endif

    mpi_errno = MPIR_Err_return_comm(NULL, FCNAME, mpi_errno);

    goto fn_exit;

    /* --END ERROR HANDLING-- */

}