src/gromacs/utility/gmxmpi.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \file
  36  * \brief
  37  * Wraps <mpi.h> usage in Gromacs.
  38  *
  39  * This header wraps the MPI header <mpi.h>, and should be included instead of
  40  * that one.  It abstracts away the case that depending on compilation
  41  * settings, MPI routines may be provided by <mpi.h> or by thread-MPI.
  42  * In the absence of MPI, this header still declares some types for
  43  * convenience.  It also disables MPI C++ bindings that can cause compilation
  44  * issues.
  45  *
  46  * \todo
  47  * This header is installed because commrec.h depends on it; it would be good
  48  * to encapsulate this dependency within the library, making the public
  49  * interface less dependent on the compilation options.
  50  *
  51  * \inlibraryapi
  52  * \ingroup module_utility
  53  */
  54 #ifndef GMX_UTILITY_GMXMPI_H
  55 #define GMX_UTILITY_GMXMPI_H
  56
  57 /*! \cond */
  58 #ifdef GMX_LIB_MPI
  59 /* MPI C++ binding is deprecated and can cause name conflicts (e.g. stdio/mpi seek) */
  60 #define MPICH_SKIP_MPICXX 1
  61 #define OMPI_SKIP_MPICXX 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 #ifdef GMX_THREAD_MPI
  79 #include "../legacyheaders/thread_mpi/tmpi.h"
  80 #include "../legacyheaders/thread_mpi/mpi_bindings.h"
  81 #else
  82 typedef void* MPI_Comm;
  83 typedef void* MPI_Request;
  84 typedef void* MPI_Group;
  85 #define MPI_COMM_NULL NULL
  86 #endif
  87 #endif
  88 //! \endcond
  89
  90 #endif