src/gromacs/timing/wallcycle.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,2017,2018,2019, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #ifndef GMX_TIMING_WALLCYCLE_H
  38 #define GMX_TIMING_WALLCYCLE_H
  39
  40 /* NOTE: None of the routines here are safe to call within an OpenMP
  41  * region */
  42
  43 #include <stdio.h>
  44
  45 #include "gromacs/utility/basedefinitions.h"
  46
  47 typedef struct gmx_wallcycle* gmx_wallcycle_t;
  48 struct t_commrec;
  49 static constexpr gmx_wallcycle* nullWallcycle = nullptr;
  50
  51 enum
  52 {
  53     ewcRUN,
  54     ewcSTEP,
  55     ewcPPDURINGPME,
  56     ewcDOMDEC,
  57     ewcDDCOMMLOAD,
  58     ewcDDCOMMBOUND,
  59     ewcVSITECONSTR,
  60     ewcPP_PMESENDX,
  61     ewcNS,
  62     ewcLAUNCH_GPU,
  63     ewcMOVEX,
  64     ewcFORCE,
  65     ewcMOVEF,
  66     ewcPMEMESH,
  67     ewcPME_REDISTXF,
  68     ewcPME_SPREAD,
  69     ewcPME_GATHER,
  70     ewcPME_FFT,
  71     ewcPME_FFTCOMM,
  72     ewcLJPME,
  73     ewcPME_SOLVE,
  74     ewcPMEWAITCOMM,
  75     ewcPP_PMEWAITRECVF,
  76     ewcWAIT_GPU_PME_SPREAD,
  77     ewcPME_FFT_MIXED_MODE,
  78     ewcPME_SOLVE_MIXED_MODE,
  79     ewcWAIT_GPU_PME_GATHER,
  80     ewcWAIT_GPU_BONDED,
  81     ewcPME_GPU_F_REDUCTION,
  82     ewcWAIT_GPU_NB_NL,
  83     ewcWAIT_GPU_NB_L,
  84     ewcNB_XF_BUF_OPS,
  85     ewcVSITESPREAD,
  86     ewcPULLPOT,
  87     ewcAWH,
  88     ewcTRAJ,
  89     ewcUPDATE,
  90     ewcCONSTR,
  91     ewcMoveE,
  92     ewcROT,
  93     ewcROTadd,
  94     ewcSWAP,
  95     ewcIMD,
  96     ewcTEST,
  97     ewcNR
  98 };
  99
 100 enum
 101 {
 102     ewcsDD_REDIST,
 103     ewcsDD_GRID,
 104     ewcsDD_SETUPCOMM,
 105     ewcsDD_MAKETOP,
 106     ewcsDD_MAKECONSTR,
 107     ewcsDD_TOPOTHER,
 108     ewcsNBS_GRID_LOCAL,
 109     ewcsNBS_GRID_NONLOCAL,
 110     ewcsNBS_SEARCH_LOCAL,
 111     ewcsNBS_SEARCH_NONLOCAL,
 112     ewcsLISTED,
 113     ewcsLISTED_FEP,
 114     ewcsRESTRAINTS,
 115     ewcsLISTED_BUF_OPS,
 116     ewcsNONBONDED_PRUNING,
 117     ewcsNONBONDED_KERNEL,
 118     ewcsNONBONDED_CLEAR,
 119     ewcsNONBONDED_FEP,
 120     ewcsLAUNCH_GPU_NONBONDED,
 121     ewcsLAUNCH_GPU_BONDED,
 122     ewcsLAUNCH_GPU_PME,
 123     ewcsEWALD_CORRECTION,
 124     ewcsNB_X_BUF_OPS,
 125     ewcsNB_F_BUF_OPS,
 126     ewcsCLEAR_FORCE_BUFFER,
 127     ewcsTEST,
 128     ewcsNR
 129 };
 130
 131 gmx_bool wallcycle_have_counter();
 132 /* Returns if cycle counting is supported */
 133
 134 gmx_wallcycle_t wallcycle_init(FILE* fplog, int resetstep, struct t_commrec* cr);
 135 /* Returns the wall cycle structure.
 136  * Returns NULL when cycle counting is not supported.
 137  */
 138
 139 /* cleans up wallcycle structure */
 140 void wallcycle_destroy(gmx_wallcycle_t wc);
 141
 142 void wallcycle_start(gmx_wallcycle_t wc, int ewc);
 143 /* Starts the cycle counter (and increases the call count) */
 144
 145 void wallcycle_start_nocount(gmx_wallcycle_t wc, int ewc);
 146 /* Starts the cycle counter without increasing the call count */
 147
 148 double wallcycle_stop(gmx_wallcycle_t wc, int ewc);
 149 /* Stop the cycle count for ewc, returns the last cycle count */
 150
 151 void wallcycle_increment_event_count(gmx_wallcycle_t wc, int ewc);
 152 /* Only increment call count for ewc by one */
 153
 154 void wallcycle_get(gmx_wallcycle_t wc, int ewc, int* n, double* c);
 155 /* Returns the cumulative count and cycle count for ewc */
 156
 157 void wallcycle_reset_all(gmx_wallcycle_t wc);
 158 /* Resets all cycle counters to zero */
 159
 160 void wallcycle_scale_by_num_threads(gmx_wallcycle_t wc, bool isPmeRank, int nthreads_pp, int nthreads_pme);
 161 /* Scale the cycle counts to reflect how many threads run for that number of cycles */
 162
 163 int64_t wcycle_get_reset_counters(gmx_wallcycle_t wc);
 164 /* Return reset_counters from wc struct */
 165
 166 void wcycle_set_reset_counters(gmx_wallcycle_t wc, int64_t reset_counters);
 167 /* Set reset_counters */
 168
 169 void wallcycle_sub_start(gmx_wallcycle_t wc, int ewcs);
 170 /* Set the start sub cycle count for ewcs */
 171
 172 void wallcycle_sub_start_nocount(gmx_wallcycle_t wc, int ewcs);
 173 /* Set the start sub cycle count for ewcs without increasing the call count */
 174
 175 void wallcycle_sub_stop(gmx_wallcycle_t wc, int ewcs);
 176 /* Stop the sub cycle count for ewcs */
 177
 178 #endif