src/gromacs/utility/gmxmpi.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014,2016,2017,2018 by the GROMACS development team.
   5  * Copyright (c) 2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \libinternal \file
  37  * \brief
  38  * Wraps mpi.h usage in Gromacs.
  39  *
  40  * This header wraps the MPI header <mpi.h>, and should be included instead of
  41  * that one.  It abstracts away the case that depending on compilation
  42  * settings, MPI routines may be provided by <mpi.h> or by thread-MPI.
  43  * In the absence of MPI, this header still declares some types for
  44  * convenience.  It also disables MPI C++ bindings that can cause compilation
  45  * issues.
  46  *
  47  * \inlibraryapi
  48  * \ingroup module_utility
  49  */
  50 #ifndef GMX_UTILITY_GMXMPI_H
  51 #define GMX_UTILITY_GMXMPI_H
  52
  53 #include "config.h"
  54
  55 /*! \cond */
  56 #if GMX_LIB_MPI
  57 /* MPI C++ binding is deprecated and can cause name conflicts (e.g. stdio/mpi seek) */
  58 #    define MPICH_SKIP_MPICXX 1
  59 #    define OMPI_SKIP_MPICXX 1
  60 /* disable bindings for SGI MPT also */
  61 #    define MPI_NO_CPPBIND 1
  62 #    include <mpi.h>
  63 /* Starting with 2.2 MPI_INT64_T is required. Earlier version still might have it.
  64    In theory MPI_Datatype doesn't have to be a #define, but current available MPI
  65    implementations (OpenMPI + MPICH (+derivates)) use #define and future versions
  66    should support 2.2. */
  67 #    if (MPI_VERSION == 1 || (MPI_VERSION == 2 && MPI_SUBVERSION < 2)) && !defined MPI_INT64_T
  68 #        include <limits.h>
  69 #        if LONG_MAX == 9223372036854775807L
  70 #            define MPI_INT64_T MPI_LONG
  71 #        elif LONG_LONG_MAX == 9223372036854775807L
  72 #            define MPI_INT64_T MPI_LONG_LONG
  73 #        else
  74 #            error No MPI_INT64_T and no 64 bit integer found.
  75 #        endif
  76 #    endif /*MPI_INT64_T*/
  77 #else
  78 #    if GMX_THREAD_MPI
  79 #        include "thread_mpi/mpi_bindings.h" /* IWYU pragma: export */
  80 #        include "thread_mpi/tmpi.h"         /* IWYU pragma: export */
  81 #    else
  82 typedef void* MPI_Comm;
  83 typedef void* MPI_Request;
  84 typedef void* MPI_Status;
  85 typedef void* MPI_Group;
  86 #        define MPI_COMM_NULL nullptr
  87 #        define MPI_GROUP_NULL nullptr
  88 #        define MPI_COMM_WORLD nullptr
  89 #    endif
  90 #endif
  91 //! \endcond
  92
  93 #endif