src/gromacs/ewald/tests/testhardwarecontexts.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017, 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 test environment class which performs hardware enumeration for unit tests.
  38  *
  39  * \author Aleksei Iupinov <a.yupinov@gmail.com>
  40  * \ingroup module_ewald
  41  */
  42
  43 #include "gmxpre.h"
  44
  45 #include "testhardwarecontexts.h"
  46
  47 #include "config.h"
  48
  49 #include "gromacs/gmxlib/network.h"
  50 #include "gromacs/gpu_utils/gpu_utils.h"
  51 #include "gromacs/hardware/hw_info.h"
  52 #include "gromacs/utility/exceptions.h"
  53 #include "gromacs/utility/loggerbuilder.h"
  54 #include "gromacs/utility/unique_cptr.h"
  55
  56 namespace gmx
  57 {
  58 namespace test
  59 {
  60
  61 /* Implements the "construct on first use" idiom to avoid any static
  62  * initialization order fiasco.
  63  *
  64  * Note that thread-safety of the initialization is guaranteed by the
  65  * C++11 language standard.
  66  *
  67  * The pointer itself (not the memory it points to) has no destructor,
  68  * so there is no deinitialization issue.  See
  69  * https://isocpp.org/wiki/faq/ctors for discussion of alternatives
  70  * and trade-offs. */
  71 const PmeTestEnvironment *getPmeTestEnv()
  72 {
  73     static PmeTestEnvironment *pmeTestEnvironment = nullptr;
  74     if (pmeTestEnvironment == nullptr)
  75     {
  76         // Ownership of the TestEnvironment is taken by GoogleTest, so nothing can leak
  77         pmeTestEnvironment = static_cast<PmeTestEnvironment *>(::testing::AddGlobalTestEnvironment(new PmeTestEnvironment));
  78     }
  79     return pmeTestEnvironment;
  80 }
  81
  82 void callAddGlobalTestEnvironment()
  83 {
  84     getPmeTestEnv();
  85 }
  86
  87 //! Simple hardware initialization
  88 static gmx_hw_info_t *hardwareInit()
  89 {
  90     unique_cptr<t_commrec, done_commrec> commrec(init_commrec());
  91     gmx_init_intranode_counters(commrec.get());
  92     LoggerBuilder builder;
  93     LoggerOwner   logOwner(builder.build());
  94     MDLogger      log(logOwner.logger());
  95     return gmx_detect_hardware(log, commrec.get());
  96 }
  97
  98 void PmeTestEnvironment::SetUp()
  99 {
 100     TestHardwareContext emptyContext("", nullptr);
 101     hardwareContextsByMode_[CodePath::CPU].push_back(emptyContext);
 102
 103     hardwareInfo_ = hardwareInit();
 104
 105     // Constructing contexts for all compatible GPUs - will be empty on non-GPU builds
 106     TestHardwareContexts gpuContexts;
 107     for (int gpuIndex : getCompatibleGpus(hardwareInfo_->gpu_info))
 108     {
 109         char        stmp[200] = {};
 110         get_gpu_device_info_string(stmp, hardwareInfo_->gpu_info, gpuIndex);
 111         std::string description = "(GPU " + std::string(stmp) + ") ";
 112         gpuContexts.emplace_back(TestHardwareContext(description.c_str(), getDeviceInfo(hardwareInfo_->gpu_info, gpuIndex)));
 113     }
 114 #if GMX_GPU == GMX_GPU_CUDA
 115     hardwareContextsByMode_[CodePath::CUDA] = gpuContexts;
 116 #endif
 117 }
 118
 119 void PmeTestEnvironment::TearDown()
 120 {
 121     gmx_hardware_info_free();
 122 }
 123
 124 }
 125 }