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, 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
  50 enum {
  51     ewcRUN, ewcSTEP, ewcPPDURINGPME, ewcDOMDEC, ewcDDCOMMLOAD,
  52     ewcDDCOMMBOUND, ewcVSITECONSTR, ewcPP_PMESENDX, ewcNS, ewcLAUNCH_GPU,
  53     ewcMOVEX, ewcGB, ewcFORCE, ewcMOVEF, ewcPMEMESH,
  54     ewcPME_REDISTXF, ewcPME_SPREAD, ewcPME_GATHER, ewcPME_FFT, ewcPME_FFTCOMM, ewcLJPME, ewcPME_SOLVE,
  55     ewcPMEWAITCOMM, ewcPP_PMEWAITRECVF, ewcWAIT_GPU_PME_SPREAD, ewcWAIT_GPU_PME_GATHER, ewcWAIT_GPU_NB_NL, ewcWAIT_GPU_NB_L, ewcNB_XF_BUF_OPS,
  56     ewcVSITESPREAD, ewcPULLPOT,
  57     ewcTRAJ, ewcUPDATE, ewcCONSTR, ewcMoveE, ewcROT, ewcROTadd, ewcSWAP, ewcIMD,
  58     ewcTEST, ewcNR
  59 };
  60
  61 enum {
  62     ewcsDD_REDIST, ewcsDD_GRID, ewcsDD_SETUPCOMM,
  63     ewcsDD_MAKETOP, ewcsDD_MAKECONSTR, ewcsDD_TOPOTHER,
  64     ewcsNBS_GRID_LOCAL, ewcsNBS_GRID_NONLOCAL,
  65     ewcsNBS_SEARCH_LOCAL, ewcsNBS_SEARCH_NONLOCAL,
  66     ewcsLISTED,
  67     ewcsLISTED_FEP,
  68     ewcsRESTRAINTS,
  69     ewcsLISTED_BUF_OPS,
  70     ewcsNONBONDED_PRUNING,
  71     ewcsNONBONDED,
  72     ewcsLAUNCH_GPU_NONBONDED,
  73     ewcsLAUNCH_GPU_PME,
  74     ewcsEWALD_CORRECTION,
  75     ewcsNB_X_BUF_OPS,
  76     ewcsNB_F_BUF_OPS,
  77     ewcsNR
  78 };
  79
  80 gmx_bool wallcycle_have_counter(void);
  81 /* Returns if cycle counting is supported */
  82
  83 gmx_wallcycle_t wallcycle_init(FILE *fplog, int resetstep, struct t_commrec *cr);
  84 /* Returns the wall cycle structure.
  85  * Returns NULL when cycle counting is not supported.
  86  */
  87
  88 void wallcycle_start(gmx_wallcycle_t wc, int ewc);
  89 /* Starts the cycle counter (and increases the call count) */
  90
  91 void wallcycle_start_nocount(gmx_wallcycle_t wc, int ewc);
  92 /* Starts the cycle counter without increasing the call count */
  93
  94 double wallcycle_stop(gmx_wallcycle_t wc, int ewc);
  95 /* Stop the cycle count for ewc, returns the last cycle count */
  96
  97 void wallcycle_get(gmx_wallcycle_t wc, int ewc, int *n, double *c);
  98 /* Returns the cumulative count and cycle count for ewc */
  99
 100 void wallcycle_reset_all(gmx_wallcycle_t wc);
 101 /* Resets all cycle counters to zero */
 102
 103 void wallcycle_scale_by_num_threads(gmx_wallcycle_t wc, bool isPmeRank, int nthreads_pp, int nthreads_pme);
 104 /* Scale the cycle counts to reflect how many threads run for that number of cycles */
 105
 106 gmx_int64_t wcycle_get_reset_counters(gmx_wallcycle_t wc);
 107 /* Return reset_counters from wc struct */
 108
 109 void wcycle_set_reset_counters(gmx_wallcycle_t wc, gmx_int64_t reset_counters);
 110 /* Set reset_counters */
 111
 112 void wallcycle_sub_start(gmx_wallcycle_t wc, int ewcs);
 113 /* Set the start sub cycle count for ewcs */
 114
 115 void wallcycle_sub_start_nocount(gmx_wallcycle_t wc, int ewcs);
 116 /* Set the start sub cycle count for ewcs without increasing the call count */
 117
 118 void wallcycle_sub_stop(gmx_wallcycle_t wc, int ewcs);
 119 /* Stop the sub cycle count for ewcs */
 120
 121 #endif