src/gromacs/hardware/detecthardware.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2016 by the GROMACS development team.
   5  * Copyright (c) 2017,2018,2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 #ifndef GMX_HARDWARE_DETECTHARDWARE_H
  37 #define GMX_HARDWARE_DETECTHARDWARE_H
  38
  39 #include <memory>
  40
  41 struct gmx_hw_info_t;
  42
  43 namespace gmx
  44 {
  45 class HardwareTopology;
  46 class MDLogger;
  47 class PhysicalNodeCommunicator;
  48
  49 /*! \brief Run detection and make correct and consistent
  50  * hardware information available on all ranks.
  51  *
  52  * May do communication on MPI_COMM_WORLD when compiled with real MPI.
  53  *
  54  * This routine is designed to be called once on each process.  In a
  55  * thread-MPI configuration, it may only be called before the threads
  56  * are spawned. With real MPI, communication is needed to coordinate
  57  * the results. In all cases, any thread within a process may use the
  58  * returned handle.
  59  *
  60  * \todo Replace the use of MPI_COMM_WORLD e.g. by using a libraryCommWorld
  61  * argument. See https://gitlab.com/gromacs/gromacs/-/issues/3650
  62  */
  63 std::unique_ptr<gmx_hw_info_t> gmx_detect_hardware(const PhysicalNodeCommunicator& physicalNodeComm);
  64
  65 /*! \brief Sanity check hardware topology and print some notes to log
  66  *
  67  *  \param mdlog            Logger.
  68  *  \param hardwareTopology Reference to hardwareTopology object.
  69  */
  70 void hardwareTopologyDoubleCheckDetection(const gmx::MDLogger&         mdlog,
  71                                           const gmx::HardwareTopology& hardwareTopology);
  72
  73 /*! \brief Issue warnings to mdlog that were decided during detection
  74  *
  75  * \param[in] mdlog                Logger
  76  * \param[in] hardwareInformation  The hardwareInformation */
  77 void logHardwareDetectionWarnings(const gmx::MDLogger& mdlog, const gmx_hw_info_t& hardwareInformation);
  78
  79 } // namespace gmx
  80
  81 #endif