src/gromacs/timing/wallcyclereporting.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2008, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2016,2017 by the GROMACS development team.
   7  * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 #ifndef GMX_TIMING_WALLCYCLEREPORTING_H
  39 #define GMX_TIMING_WALLCYCLEREPORTING_H
  40
  41 /* NOTE: None of the routines here are safe to call within an OpenMP
  42  * region */
  43
  44 #include <stdio.h>
  45
  46 #include <array>
  47
  48 #include "gromacs/utility/basedefinitions.h"
  49
  50 struct t_commrec;
  51
  52 namespace gmx
  53 {
  54 class MDLogger;
  55 }
  56
  57 typedef struct gmx_wallcycle* gmx_wallcycle_t;
  58 struct gmx_wallclock_gpu_nbnxn_t;
  59 struct gmx_wallclock_gpu_pme_t;
  60
  61 typedef std::array<double, ewcNR + ewcsNR> WallcycleCounts;
  62 /* Convenience typedef */
  63
  64 WallcycleCounts wallcycle_sum(const t_commrec* cr, gmx_wallcycle_t wc);
  65 /* Return a vector of the sum of cycle counts over the nodes in
  66    cr->mpi_comm_mysim. */
  67
  68 void wallcycle_print(FILE*                            fplog,
  69                      const gmx::MDLogger&             mdlog,
  70                      int                              nnodes,
  71                      int                              npme,
  72                      int                              nth_pp,
  73                      int                              nth_pme,
  74                      double                           realtime,
  75                      gmx_wallcycle_t                  wc,
  76                      const WallcycleCounts&           cyc_sum,
  77                      const gmx_wallclock_gpu_nbnxn_t* gpu_nbnxn_t,
  78                      const gmx_wallclock_gpu_pme_t*   gpu_pme_t);
  79 /* Print the cycle and time accounting */
  80
  81 #endif