2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
37 #ifndef GMX_TIMING_WALLCYCLE_H
38 #define GMX_TIMING_WALLCYCLE_H
40 /* NOTE: None of the routines here are safe to call within an OpenMP
45 #include "gromacs/utility/basedefinitions.h"
47 typedef struct gmx_wallcycle* gmx_wallcycle_t;
49 static constexpr gmx_wallcycle* nullWallcycle = nullptr;
76 ewcWAIT_GPU_PME_SPREAD,
77 ewcPME_FFT_MIXED_MODE,
78 ewcPME_SOLVE_MIXED_MODE,
79 ewcWAIT_GPU_PME_GATHER,
81 ewcPME_GPU_F_REDUCTION,
109 ewcsNBS_GRID_NONLOCAL,
110 ewcsNBS_SEARCH_LOCAL,
111 ewcsNBS_SEARCH_NONLOCAL,
116 ewcsNONBONDED_PRUNING,
117 ewcsNONBONDED_KERNEL,
120 ewcsLAUNCH_GPU_NONBONDED,
121 ewcsLAUNCH_GPU_BONDED,
123 ewcsEWALD_CORRECTION,
126 ewcsCLEAR_FORCE_BUFFER,
131 gmx_bool wallcycle_have_counter();
132 /* Returns if cycle counting is supported */
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.
139 /* cleans up wallcycle structure */
140 void wallcycle_destroy(gmx_wallcycle_t wc);
142 void wallcycle_start(gmx_wallcycle_t wc, int ewc);
143 /* Starts the cycle counter (and increases the call count) */
145 void wallcycle_start_nocount(gmx_wallcycle_t wc, int ewc);
146 /* Starts the cycle counter without increasing the call count */
148 double wallcycle_stop(gmx_wallcycle_t wc, int ewc);
149 /* Stop the cycle count for ewc, returns the last cycle count */
151 void wallcycle_increment_event_count(gmx_wallcycle_t wc, int ewc);
152 /* Only increment call count for ewc by one */
154 void wallcycle_get(gmx_wallcycle_t wc, int ewc, int* n, double* c);
155 /* Returns the cumulative count and cycle count for ewc */
157 void wallcycle_reset_all(gmx_wallcycle_t wc);
158 /* Resets all cycle counters to zero */
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 */
163 int64_t wcycle_get_reset_counters(gmx_wallcycle_t wc);
164 /* Return reset_counters from wc struct */
166 void wcycle_set_reset_counters(gmx_wallcycle_t wc, int64_t reset_counters);
167 /* Set reset_counters */
169 void wallcycle_sub_start(gmx_wallcycle_t wc, int ewcs);
170 /* Set the start sub cycle count for ewcs */
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 */
175 void wallcycle_sub_stop(gmx_wallcycle_t wc, int ewcs);
176 /* Stop the sub cycle count for ewcs */