src/testutils/mpitest.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2018,2019,2020, 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 /*! \internal \file
  36  * \brief
  37  * Implements functions in mpitest.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_testutils
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "testutils/mpitest.h"
  45
  46 #include "config.h"
  47
  48 #include <gtest/gtest.h>
  49
  50 #include "thread_mpi/tmpi.h"
  51
  52 #include "gromacs/options/basicoptions.h"
  53 #include "gromacs/options/ioptionscontainer.h"
  54 #include "gromacs/utility/basenetwork.h"
  55 #include "gromacs/utility/exceptions.h"
  56
  57 #include "testutils/testoptions.h"
  58
  59 namespace gmx
  60 {
  61 namespace test
  62 {
  63
  64 #if GMX_THREAD_MPI
  65
  66 namespace
  67 {
  68
  69 //! Number of tMPI threads.
  70 int g_numThreads = 1;
  71 //! \cond
  72 GMX_TEST_OPTIONS(ThreadMpiTestOptions, options)
  73 {
  74     options->addOption(
  75             IntegerOption("ntmpi").store(&g_numThreads).description("Number of thread-MPI threads/ranks for the test"));
  76 }
  77 //! \endcond
  78
  79 //! Thread entry function for other thread-MPI threads.
  80 void threadStartFunc(const void* data)
  81 {
  82     const std::function<void()>& testBody = *reinterpret_cast<const std::function<void()>*>(data);
  83     try
  84     {
  85         testBody();
  86     }
  87     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
  88 }
  89
  90 //! Helper function for starting thread-MPI threads for a test.
  91 bool startThreads(std::function<void()>* testBody)
  92 {
  93     int ret = tMPI_Init_fn(TRUE, g_numThreads, TMPI_AFFINITY_NONE, threadStartFunc, testBody);
  94     return ret == TMPI_SUCCESS;
  95 }
  96
  97 class InTestGuard
  98 {
  99 public:
 100     explicit InTestGuard(bool* inTest) : inTest_(inTest) { *inTest = true; }
 101     ~InTestGuard() { *inTest_ = false; }
 102
 103 private:
 104     bool* inTest_;
 105 };
 106
 107 } // namespace
 108
 109 //! \cond internal
 110 bool threadMpiTestRunner(std::function<void()> testBody)
 111 {
 112     static bool inTest = false;
 113
 114     if (inTest || g_numThreads <= 1)
 115     {
 116         return true;
 117     }
 118 #    if GMX_THREAD_MPI && !defined(GTEST_IS_THREADSAFE)
 119     ADD_FAILURE() << "Google Test is not thread safe on this platform. "
 120                   << "Cannot run multi-rank tests with thread-MPI.";
 121 #    else
 122     InTestGuard guard(&inTest);
 123     if (!startThreads(&testBody))
 124     {
 125         return false;
 126     }
 127     try
 128     {
 129         testBody();
 130     }
 131     GMX_CATCH_ALL_AND_EXIT_WITH_FATAL_ERROR;
 132     tMPI_Finalize();
 133 #    endif
 134     return false;
 135 }
 136 //! \endcond
 137
 138 #endif
 139
 140 int getNumberOfTestMpiRanks()
 141 {
 142 #if GMX_THREAD_MPI
 143     return g_numThreads;
 144 #else
 145     return gmx_node_num();
 146 #endif
 147 }
 148
 149 } // namespace test
 150 } // namespace gmx