src/testutils/mpi-printer.cpp

   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 #include "gmxpre.h"
  36
  37 #include "mpi-printer.h"
  38
  39 #include "config.h"
  40 #include "gromacs/utility/gmxmpi.h"
  41
  42 #ifdef GMX_LIB_MPI
  43
  44 #include <sstream>
  45 #include <vector>
  46
  47 #include <boost/scoped_ptr.hpp>
  48 #include <gtest/gtest.h>
  49
  50 #include "gromacs/utility/common.h"
  51 #include "gromacs/utility/gmxassert.h"
  52
  53 #define FORWARD_TO_DEFAULT_PRINTER1(MethodName, Param1Type) \
  54     virtual void MethodName(const Param1Type &param1) { \
  55         if (rank_ == 0) { \
  56             defaultPrinter_->MethodName(param1); \
  57         } \
  58     }
  59 #define FORWARD_TO_DEFAULT_PRINTER2(MethodName, Param1Type, Param2Type) \
  60     virtual void MethodName(const Param1Type &param1, Param2Type param2) { \
  61         if (rank_ == 0) { \
  62             defaultPrinter_->MethodName(param1, param2); \
  63         } \
  64     }
  65
  66 namespace
  67 {
  68
  69 class MPIEventForward : public ::testing::TestEventListener
  70 {
  71     public:
  72         MPIEventForward(TestEventListener* defaultPrinter, int rank, int size)
  73             : defaultPrinter_(defaultPrinter), rank_(rank), size_(size)
  74         {
  75         }
  76
  77         FORWARD_TO_DEFAULT_PRINTER1(OnTestProgramStart, ::testing::UnitTest);
  78         FORWARD_TO_DEFAULT_PRINTER2(OnTestIterationStart, ::testing::UnitTest, int);
  79         FORWARD_TO_DEFAULT_PRINTER1(OnEnvironmentsSetUpStart, ::testing::UnitTest);
  80         FORWARD_TO_DEFAULT_PRINTER1(OnEnvironmentsSetUpEnd, ::testing::UnitTest);
  81         FORWARD_TO_DEFAULT_PRINTER1(OnTestCaseStart, ::testing::TestCase);
  82         FORWARD_TO_DEFAULT_PRINTER1(OnTestStart, ::testing::TestInfo);
  83         virtual void OnTestPartResult(const ::testing::TestPartResult & /*result*/)
  84         {
  85             // Do nothing; all printing is done in OnTestEnd().
  86         }
  87         virtual void OnTestEnd(const ::testing::TestInfo &test_info);
  88         FORWARD_TO_DEFAULT_PRINTER1(OnTestCaseEnd, ::testing::TestCase);
  89         FORWARD_TO_DEFAULT_PRINTER1(OnEnvironmentsTearDownStart, ::testing::UnitTest);
  90         FORWARD_TO_DEFAULT_PRINTER1(OnEnvironmentsTearDownEnd, ::testing::UnitTest);
  91         FORWARD_TO_DEFAULT_PRINTER2(OnTestIterationEnd, ::testing::UnitTest, int);
  92         FORWARD_TO_DEFAULT_PRINTER1(OnTestProgramEnd, ::testing::UnitTest);
  93
  94     private:
  95         boost::scoped_ptr<TestEventListener> defaultPrinter_;
  96         int                                  rank_;
  97         int                                  size_;
  98
  99         GMX_DISALLOW_COPY_AND_ASSIGN(MPIEventForward);
 100 };
 101
 102 void MPIEventForward::OnTestEnd(const ::testing::TestInfo &test_info)
 103 {
 104     // Serialize printing test results to stdout in rank order by
 105     // passing a flag in order from ranks 0 .. (n-1). Rank 0 does not
 106     // need to recieve, rank n-1 does not need to send.
 107     int timeToPrint = (0 == rank_);
 108     if (!timeToPrint)
 109     {
 110         MPI_Recv(&timeToPrint, 1, MPI_INT, rank_ - 1, 0, MPI_COMM_WORLD, MPI_STATUS_IGNORE);
 111     }
 112
 113     // Now this rank can print
 114     int localPassed                     = true;
 115     const ::testing::TestResult *result = test_info.result();
 116     if (result->Failed())
 117     {
 118         // TODO: This sometimes races with the defaultPrinter_, but
 119         // unsure why
 120         printf("Test failures from rank %d:\n", rank_);
 121         for (int i = 0; i < result->total_part_count(); ++i)
 122         {
 123             /* TODO: A future implementation might forward the
 124                contents / output of OnTestPartResult to the master
 125                rank to handle all the output there. Currently, the
 126                output of the expected and actual behaviour only occurs
 127                if the failing ranks include rank 0, and is only
 128                indicative of rank 0. */
 129             defaultPrinter_->OnTestPartResult(result->GetTestPartResult(i));
 130         }
 131         localPassed = false;
 132     }
 133
 134     // Pass on the printing token to the next rank
 135     if (size_ != rank_ + 1)
 136     {
 137         MPI_Send(&timeToPrint, 1, MPI_INT, rank_ + 1, 0, MPI_COMM_WORLD);
 138     }
 139
 140     std::vector<int> bDidRankPass(size_);
 141     MPI_Gather(&localPassed, 1, MPI_INT, &(bDidRankPass[0]), 1, MPI_INT, 0, MPI_COMM_WORLD);
 142
 143     if (rank_ == 0)
 144     {
 145         std::stringstream failingRanks;
 146         bool              allPassed = true;
 147
 148         for (size_t i = 0; i != bDidRankPass.size(); ++i)
 149         {
 150             if (!bDidRankPass[i])
 151             {
 152                 if (!allPassed)
 153                 {
 154                     failingRanks << ",";
 155                 }
 156                 allPassed = false;
 157                 failingRanks << i;
 158             }
 159         }
 160
 161         defaultPrinter_->OnTestEnd(test_info);
 162
 163         if (!allPassed)
 164         {
 165             ::testing::Test::RecordProperty("AllFailingRanks", failingRanks.str().c_str());
 166             // This marks the current test failed, and modifies test_info
 167             // behind the scenes, so the default printer sees the test as
 168             // failed even if localPassed is true.
 169             ADD_FAILURE() <<
 170             "See AllFailingRanks for the rank IDs that failed. Only if "
 171             "rank 0 was among those that failed, will there be some "
 172             "accompanying information about the failure, and it will "
 173             "pertain only to that rank. Run this test manually to get "
 174             "more information.";
 175         }
 176     }
 177 }
 178
 179 } // namespace
 180
 181 #endif
 182
 183 //! \cond internal
 184 void gmx::test::initMPIOutput()
 185 {
 186 #ifdef GMX_LIB_MPI
 187     int size, rank;
 188
 189     MPI_Comm_size(MPI_COMM_WORLD, &size);
 190     if (size == 1)
 191     {
 192         return;
 193     }
 194     MPI_Comm_rank(MPI_COMM_WORLD, &rank);
 195     ::testing::UnitTest           &unit_test  = *::testing::UnitTest::GetInstance();
 196     ::testing::TestEventListeners &listeners  = unit_test.listeners();
 197     ::testing::TestEventListener  *defprinter =
 198         listeners.Release(listeners.default_result_printer());
 199     listeners.Append(new MPIEventForward(defprinter, rank, size));
 200     if (0 != rank)
 201     {
 202         /* Permit only rank 0 to write to the single GTest XML file,
 203            by removing the generator on the other ranks. This
 204            suppresses races when writing that file. */
 205         ::testing::TestEventListener *oldlistener = listeners.Release(listeners.default_xml_generator());
 206         delete oldlistener;
 207     }
 208 #endif
 209 }
 210 //! \endcond