src/gromacs/mdrunutility/tests/threadaffinitytest.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,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 #ifndef GMX_MDRUNUTILITY_TESTS_THREADAFFINITYTEST_H
  36 #define GMX_MDRUNUTILITY_TESTS_THREADAFFINITYTEST_H
  37
  38 #include <initializer_list>
  39 #include <memory>
  40
  41 #include <gmock/gmock.h>
  42
  43 #include "gromacs/hardware/hw_info.h"
  44 #include "gromacs/mdrunutility/threadaffinity.h"
  45 #include "gromacs/utility/basedefinitions.h"
  46 #include "gromacs/utility/logger.h"
  47 #include "gromacs/utility/physicalnodecommunicator.h"
  48 #include "gromacs/utility/stringutil.h"
  49
  50 #include "testutils/loggertest.h"
  51
  52 struct t_commrec;
  53
  54 namespace gmx
  55 {
  56
  57 class HardwareTopology;
  58
  59 namespace test
  60 {
  61
  62 class MockThreadAffinityAccess : public IThreadAffinityAccess
  63 {
  64 public:
  65     MockThreadAffinityAccess();
  66     ~MockThreadAffinityAccess() override;
  67
  68     void setSupported(bool supported) { supported_ = supported; }
  69
  70     bool isThreadAffinitySupported() const override { return supported_; }
  71     MOCK_METHOD1(setCurrentThreadAffinityToCore, bool(int core));
  72
  73 private:
  74     bool supported_;
  75 };
  76
  77 class ThreadAffinityTestHelper
  78 {
  79 public:
  80     ThreadAffinityTestHelper();
  81     ~ThreadAffinityTestHelper();
  82
  83     void setAffinitySupported(bool supported) { affinityAccess_.setSupported(supported); }
  84     void setAffinityOption(ThreadAffinity affinityOption)
  85     {
  86         hwOpt_.threadAffinity = affinityOption;
  87     }
  88     void setOffsetAndStride(int offset, int stride)
  89     {
  90         hwOpt_.core_pinning_offset = offset;
  91         hwOpt_.core_pinning_stride = stride;
  92     }
  93
  94     void setPhysicalNodeId(int nodeId) { physicalNodeId_ = nodeId; }
  95
  96     void setLogicalProcessorCount(int logicalProcessorCount);
  97
  98     void setTotNumThreadsIsAuto(bool isAuto) { hwOpt_.totNumThreadsIsAuto = isAuto; }
  99
 100     void expectAffinitySet(int core)
 101     {
 102         EXPECT_CALL(affinityAccess_, setCurrentThreadAffinityToCore(core));
 103     }
 104     void expectAffinitySet(std::initializer_list<int> cores)
 105     {
 106         for (int core : cores)
 107         {
 108             expectAffinitySet(core);
 109         }
 110     }
 111     // NOLINTNEXTLINE readability-convert-member-functions-to-static
 112     void expectAffinitySetThatFails(int core)
 113     {
 114         using ::testing::Return;
 115         EXPECT_CALL(affinityAccess_, setCurrentThreadAffinityToCore(core)).WillOnce(Return(false));
 116     }
 117
 118     void expectWarningMatchingRegex(const char* re) { expectWarningMatchingRegexIf(re, true); }
 119     void expectWarningMatchingRegexIf(const char* re, bool condition)
 120     {
 121         expectLogMessageMatchingRegexIf(MDLogger::LogLevel::Warning, re, condition);
 122     }
 123     void expectInfoMatchingRegex(const char* re) { expectInfoMatchingRegexIf(re, true); }
 124     void expectInfoMatchingRegexIf(const char* re, bool condition)
 125     {
 126         expectLogMessageMatchingRegexIf(MDLogger::LogLevel::Info, re, condition);
 127     }
 128     void expectGenericFailureMessage() { expectGenericFailureMessageIf(true); }
 129     void expectGenericFailureMessageIf(bool condition)
 130     {
 131         expectWarningMatchingRegexIf("NOTE: Thread affinity was not set.", condition);
 132     }
 133     void expectPinningMessage(bool userSpecifiedStride, int stride)
 134     {
 135         std::string pattern = formatString("Pinning threads .* %s.* stride of %d",
 136                                            userSpecifiedStride ? "user" : "auto", stride);
 137         expectInfoMatchingRegex(pattern.c_str());
 138     }
 139     void expectLogMessageMatchingRegexIf(MDLogger::LogLevel level, const char* re, bool condition)
 140     {
 141         if (condition)
 142         {
 143             logHelper_.expectEntryMatchingRegex(level, re);
 144         }
 145     }
 146
 147     void setAffinity(int numThreadsOnThisRank)
 148     {
 149         if (hwTop_ == nullptr)
 150         {
 151             setLogicalProcessorCount(1);
 152         }
 153         gmx::PhysicalNodeCommunicator comm(MPI_COMM_WORLD, physicalNodeId_);
 154         int                           numThreadsOnThisNode, indexWithinNodeOfFirstThreadOnThisRank;
 155         analyzeThreadsOnThisNode(comm, numThreadsOnThisRank, &numThreadsOnThisNode,
 156                                  &indexWithinNodeOfFirstThreadOnThisRank);
 157         gmx_set_thread_affinity(logHelper_.logger(), cr_, &hwOpt_, *hwTop_, numThreadsOnThisRank,
 158                                 numThreadsOnThisNode, indexWithinNodeOfFirstThreadOnThisRank,
 159                                 &affinityAccess_);
 160     }
 161
 162 private:
 163     t_commrec*                        cr_;
 164     gmx_hw_opt_t                      hwOpt_;
 165     std::unique_ptr<HardwareTopology> hwTop_;
 166     MockThreadAffinityAccess          affinityAccess_;
 167     LoggerTestHelper                  logHelper_;
 168     int                               physicalNodeId_;
 169 };
 170
 171 } // namespace test
 172 } // namespace gmx
 173
 174 #endif