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, 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;
51 ewcRUN, ewcSTEP, ewcPPDURINGPME, ewcDOMDEC, ewcDDCOMMLOAD,
52 ewcDDCOMMBOUND, ewcVSITECONSTR, ewcPP_PMESENDX, ewcNS, ewcLAUNCH_GPU_NB,
53 ewcMOVEX, ewcGB, ewcFORCE, ewcMOVEF, ewcPMEMESH,
54 ewcPME_REDISTXF, ewcPME_SPREADGATHER, ewcPME_FFT, ewcPME_FFTCOMM, ewcLJPME, ewcPME_SOLVE,
55 ewcPMEWAITCOMM, ewcPP_PMEWAITRECVF, ewcWAIT_GPU_NB_NL, ewcWAIT_GPU_NB_L, ewcNB_XF_BUF_OPS,
56 ewcVSITESPREAD, ewcPULLPOT,
57 ewcTRAJ, ewcUPDATE, ewcCONSTR, ewcMoveE, ewcROT, ewcROTadd, ewcSWAP, ewcIMD,
63 ewcsDD_REDIST, ewcsDD_GRID, ewcsDD_SETUPCOMM,
64 ewcsDD_MAKETOP, ewcsDD_MAKECONSTR, ewcsDD_TOPOTHER,
65 ewcsNBS_GRID_LOCAL, ewcsNBS_GRID_NONLOCAL,
66 ewcsNBS_SEARCH_LOCAL, ewcsNBS_SEARCH_NONLOCAL,
78 gmx_bool wallcycle_have_counter(void);
79 /* Returns if cycle counting is supported */
81 gmx_wallcycle_t wallcycle_init(FILE *fplog, int resetstep, struct t_commrec *cr);
82 /* Returns the wall cycle structure.
83 * Returns NULL when cycle counting is not supported.
86 void wallcycle_start(gmx_wallcycle_t wc, int ewc);
87 /* Starts the cycle counter (and increases the call count) */
89 void wallcycle_start_nocount(gmx_wallcycle_t wc, int ewc);
90 /* Starts the cycle counter without increasing the call count */
92 double wallcycle_stop(gmx_wallcycle_t wc, int ewc);
93 /* Stop the cycle count for ewc, returns the last cycle count */
95 void wallcycle_get(gmx_wallcycle_t wc, int ewc, int *n, double *c);
96 /* Returns the cumulative count and cycle count for ewc */
98 void wallcycle_reset_all(gmx_wallcycle_t wc);
99 /* Resets all cycle counters to zero */
101 void wallcycle_scale_by_num_threads(gmx_wallcycle_t wc, bool isPmeRank, int nthreads_pp, int nthreads_pme);
102 /* Scale the cycle counts to reflect how many threads run for that number of cycles */
104 gmx_int64_t wcycle_get_reset_counters(gmx_wallcycle_t wc);
105 /* Return reset_counters from wc struct */
107 void wcycle_set_reset_counters(gmx_wallcycle_t wc, gmx_int64_t reset_counters);
108 /* Set reset_counters */
110 void wallcycle_sub_start(gmx_wallcycle_t wc, int ewcs);
111 /* Set the start sub cycle count for ewcs */
113 void wallcycle_sub_start_nocount(gmx_wallcycle_t wc, int ewcs);
114 /* Set the start sub cycle count for ewcs without increasing the call count */
116 void wallcycle_sub_stop(gmx_wallcycle_t wc, int ewcs);
117 /* Stop the sub cycle count for ewcs */