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,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 #ifndef GMX_HARDWARE_DETECTHARDWARE_H
  36 #define GMX_HARDWARE_DETECTHARDWARE_H
  37
  38 #include <cstdio>
  39
  40 #include <string>
  41 #include <vector>
  42
  43 #include "gromacs/utility/basedefinitions.h"
  44
  45 struct gmx_gpu_info_t;
  46 struct gmx_hw_info_t;
  47 struct gmx_hw_opt_t;
  48 struct t_commrec;
  49
  50 namespace gmx
  51 {
  52 class MDLogger;
  53 }
  54
  55 /*! \brief Run detection, consistency checks, and make available on all ranks.
  56  *
  57  * This routine constructs the global hwinfo structure and returns a pointer to
  58  * it. It will run a preamble before executing cpu and hardware checks, and
  59  * then run consistency checks afterwards. The results will also be made
  60  * available on all nodes.
  61  * Caller is responsible for freeing this pointer.
  62  */
  63 gmx_hw_info_t *gmx_detect_hardware(const gmx::MDLogger &mdlog,
  64                                    const t_commrec *cr, gmx_bool bDetectGPUs);
  65
  66 void gmx_hardware_info_free(gmx_hw_info_t *hwinfo);
  67
  68 //! Return whether compatible GPUs were found.
  69 bool compatibleGpusFound(const gmx_gpu_info_t &gpu_info);
  70
  71 /*! \brief Check the consistency of hw_opt with hwinfo.
  72  *
  73  * This function should be called once on each MPI rank. */
  74 void gmx_check_hw_runconf_consistency(const gmx::MDLogger    &mdlog,
  75                                       const gmx_hw_info_t    *hwinfo,
  76                                       const t_commrec        *cr,
  77                                       const gmx_hw_opt_t     &hw_opt,
  78                                       bool                    userSetGpuIds,
  79                                       const std::vector<int> &gpuSelection);
  80
  81 #endif