api/nblib/tests/nbnxmsetup.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2021, 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  * Tests for nbnxm setup utilities
  38  *
  39  * \author Victor Holanda <victor.holanda@cscs.ch>
  40  * \author Joe Jordan <ejjordan@kth.se>
  41  * \author Prashanth Kanduri <kanduri@cscs.ch>
  42  * \author Sebastian Keller <keller@cscs.ch>
  43  */
  44 #include <cmath>
  45
  46 #include "gromacs/hardware/device_management.h"
  47 #include "gromacs/mdtypes/forcerec.h"
  48 #include "gromacs/mdtypes/interaction_const.h"
  49 #include "gromacs/mdtypes/simulation_workload.h"
  50 #include "gromacs/nbnxm/nbnxm.h"
  51 #include "gromacs/nbnxm/nbnxm_simd.h"
  52 #include "nblib/box.h"
  53 #include "nblib/nbnxmsetuphelpers.h"
  54
  55 #include "testutils/testasserts.h"
  56 #include "testutils/test_hardware_environment.h"
  57
  58 namespace nblib
  59 {
  60 namespace test
  61 {
  62 namespace
  63 {
  64
  65 TEST(NbnxmSetupTest, findNumEnergyGroups)
  66 {
  67     std::vector<int64_t> v(10);
  68     int                  arbitraryGid = 7;
  69
  70     // this sets some bit outside the range of bits used for the group ID
  71     // having all bits zero except those used for the group ID can otherwise hide bugs
  72     v[5] |= gmx::sc_atomInfo_HasCharge;
  73     v[5] = (v[5] & ~gmx::sc_atomInfo_EnergyGroupIdMask) | arbitraryGid;
  74
  75     int nEnergyGroups = arbitraryGid + 1;
  76     EXPECT_EQ(nEnergyGroups, findNumEnergyGroups(v));
  77 }
  78
  79 TEST(NbnxmSetupTest, canTranslateBenchmarkEnumAuto)
  80 {
  81     auto kernel = SimdKernels::SimdAuto;
  82     EXPECT_EQ(translateBenchmarkEnum(kernel), Nbnxm::KernelType::NotSet);
  83 }
  84
  85 TEST(NbnxmSetupTest, canTranslateBenchmarkEnumNo)
  86 {
  87     auto kernel = SimdKernels::SimdNo;
  88     EXPECT_EQ(translateBenchmarkEnum(kernel), Nbnxm::KernelType::Cpu4x4_PlainC);
  89 }
  90
  91 TEST(NbnxmSetupTest, canTranslateBenchmarkEnum2XM)
  92 {
  93     auto kernel = SimdKernels::Simd2XMM;
  94     EXPECT_EQ(translateBenchmarkEnum(kernel), Nbnxm::KernelType::Cpu4xN_Simd_2xNN);
  95 }
  96
  97 TEST(NbnxmSetupTest, canTranslateBenchmarkEnum4XM)
  98 {
  99     auto kernel = SimdKernels::Simd4XM;
 100     EXPECT_EQ(translateBenchmarkEnum(kernel), Nbnxm::KernelType::Cpu4xN_Simd_4xN);
 101 }
 102
 103 TEST(NbnxmSetupTest, CheckKernelSetupThrowsAuto)
 104 {
 105     EXPECT_ANY_THROW(checkKernelSetupSimd(SimdKernels::SimdAuto));
 106 }
 107
 108 TEST(NbnxmSetupTest, CheckKernelSetupThrowsCount)
 109 {
 110     EXPECT_ANY_THROW(checkKernelSetupSimd(SimdKernels::Count));
 111 }
 112
 113 TEST(NbnxmSetupTest, canCreateKernelSetupPlain)
 114 {
 115     NBKernelOptions nbKernelOptions;
 116     nbKernelOptions.nbnxmSimd = SimdKernels::SimdNo;
 117     Nbnxm::KernelSetup kernelSetup =
 118             createKernelSetupCPU(nbKernelOptions.nbnxmSimd, nbKernelOptions.useTabulatedEwaldCorr);
 119     EXPECT_EQ(kernelSetup.kernelType, Nbnxm::KernelType::Cpu4x4_PlainC);
 120     EXPECT_EQ(kernelSetup.ewaldExclusionType, Nbnxm::EwaldExclusionType::Table);
 121 }
 122
 123 TEST(NbnxmSetupTest, canCreateParticleInfoAllVdv)
 124 {
 125     size_t  numParticles = 2;
 126     int64_t mask         = 0;
 127     mask |= gmx::sc_atomInfo_HasVdw;
 128     mask |= gmx::sc_atomInfo_HasCharge;
 129     std::vector<int64_t> refParticles  = { mask, mask };
 130     std::vector<int64_t> testParticles = createParticleInfoAllVdw(numParticles);
 131     EXPECT_EQ(refParticles, testParticles);
 132 }
 133
 134 TEST(NbnxmSetupTest, ewaldCoeffWorks)
 135 {
 136     real                              ewald     = ewaldCoeff(1e-5, 1.0);
 137     gmx::test::FloatingPointTolerance tolerance = gmx::test::absoluteTolerance(1e-5);
 138     EXPECT_REAL_EQ_TOL(ewald, 3.12341, tolerance);
 139 }
 140
 141 TEST(NbnxmSetupTest, updateForcerecWorks)
 142 {
 143     t_forcerec forcerec;
 144     Box        box(3);
 145     EXPECT_NO_THROW(updateForcerec(&forcerec, box.legacyMatrix()));
 146 }
 147
 148 // The following tests check if the user is allowed to specify configurations not permitted due
 149 // to conflicting compile time setup flags
 150
 151 TEST(NbnxmSetupTest, canCheckKernelSetup)
 152 {
 153     NBKernelOptions nbKernelOptions;
 154     nbKernelOptions.nbnxmSimd = SimdKernels::SimdNo;
 155 #ifdef GMX_NBNXN_SIMD_4XN
 156     nbKernelOptions.nbnxmSimd = SimdKernels::Simd4XM;
 157 #endif
 158 #ifdef GMX_NBNXN_SIMD_2XNN
 159     nbKernelOptions.nbnxmSimd = SimdKernels::Simd2XMM;
 160 #endif
 161     EXPECT_NO_THROW(checkKernelSetupSimd(nbKernelOptions.nbnxmSimd));
 162 }
 163
 164 // check if the user is allowed to ask for SimdKernels::Simd2XMM when NBLIB is not compiled with it
 165 #ifndef GMX_NBNXN_SIMD_2XNN
 166 TEST(NbnxmSetupTest, cannotCreateKernelSetupCPU2XM)
 167 {
 168     NBKernelOptions nbKernelOptions;
 169     nbKernelOptions.nbnxmSimd             = SimdKernels::Simd2XMM;
 170     nbKernelOptions.useTabulatedEwaldCorr = true;
 171     EXPECT_ANY_THROW(createKernelSetupCPU(nbKernelOptions.nbnxmSimd, nbKernelOptions.useTabulatedEwaldCorr));
 172 }
 173 #endif
 174
 175 // check if the user is allowed to ask for SimdKernels::Simd4XM when NBLIB is not compiled with it
 176 #ifndef GMX_NBNXN_SIMD_4XN
 177 TEST(NbnxmSetupTest, cannotCreateKernelSetupCPU4XM)
 178 {
 179     NBKernelOptions nbKernelOptions;
 180     nbKernelOptions.nbnxmSimd             = SimdKernels::Simd4XM;
 181     nbKernelOptions.useTabulatedEwaldCorr = false;
 182     EXPECT_ANY_THROW(createKernelSetupCPU(nbKernelOptions.nbnxmSimd, nbKernelOptions.useTabulatedEwaldCorr));
 183 }
 184 #endif
 185
 186 TEST(NbnxmSetupTest, CanCreateNbnxmCPU)
 187 {
 188     size_t          numParticles = 1;
 189     NBKernelOptions nbKernelOptions;
 190     nbKernelOptions.nbnxmSimd             = SimdKernels::SimdNo;
 191     int               numEnergyGroups     = 1;
 192     std::vector<real> nonbondedParameters = { 1, 1 };
 193     EXPECT_NO_THROW(createNbnxmCPU(numParticles, nbKernelOptions, numEnergyGroups, nonbondedParameters));
 194 }
 195
 196 #if GMX_GPU_CUDA
 197 TEST(NbnxmSetupTest, canCreateKernelSetupGPU)
 198 {
 199     NBKernelOptions    nbKernelOptions;
 200     Nbnxm::KernelSetup kernelSetup = createKernelSetupGPU(nbKernelOptions.useTabulatedEwaldCorr);
 201     EXPECT_EQ(kernelSetup.kernelType, Nbnxm::KernelType::Gpu8x8x8);
 202     EXPECT_EQ(kernelSetup.ewaldExclusionType, Nbnxm::EwaldExclusionType::Analytical);
 203 }
 204
 205 TEST(NbnxmSetupTest, CanCreateDeviceStreamManager)
 206 {
 207     const auto& testDeviceList = gmx::test::getTestHardwareEnvironment()->getTestDeviceList();
 208     for (const auto& testDevice : testDeviceList)
 209     {
 210         const DeviceInformation& deviceInfo = testDevice->deviceInfo();
 211         setActiveDevice(deviceInfo);
 212         gmx::SimulationWorkload simulationWork = createSimulationWorkloadGpu();
 213         EXPECT_NO_THROW(createDeviceStreamManager(deviceInfo, simulationWork));
 214     }
 215 }
 216
 217 TEST(NbnxmSetupTest, CanCreateNbnxmGPU)
 218 {
 219     const auto& testDeviceList = gmx::test::getTestHardwareEnvironment()->getTestDeviceList();
 220     for (const auto& testDevice : testDeviceList)
 221     {
 222         const DeviceInformation& deviceInfo = testDevice->deviceInfo();
 223         setActiveDevice(deviceInfo);
 224         size_t                  numParticles = 1;
 225         NBKernelOptions         nbKernelOptions;
 226         std::vector<real>       nonbondedParameters = { 1, 1 };
 227         gmx::SimulationWorkload simulationWork      = createSimulationWorkloadGpu();
 228         interaction_const_t     interactionConst    = createInteractionConst(nbKernelOptions);
 229         // set DeviceInformation and create the DeviceStreamManager
 230         auto deviceStreamManager = createDeviceStreamManager(deviceInfo, simulationWork);
 231         EXPECT_NO_THROW(createNbnxmGPU(
 232                 numParticles, nbKernelOptions, nonbondedParameters, interactionConst, *deviceStreamManager));
 233     }
 234 }
 235
 236 #endif
 237
 238 } // namespace
 239 } // namespace test
 240 } // namespace nblib