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, 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 <array>
  46
  47 #include "gromacs/utility/basedefinitions.h"
  48
  49 typedef struct gmx_wallcycle *gmx_wallcycle_t;
  50 typedef struct gmx_wallclock_gpu_t gmx_wallclock_gpu_t;
  51 struct t_commrec;
  52
  53 enum {
  54     ewcRUN, ewcSTEP, ewcPPDURINGPME, ewcDOMDEC, ewcDDCOMMLOAD,
  55     ewcDDCOMMBOUND, ewcVSITECONSTR, ewcPP_PMESENDX, ewcNS, ewcLAUNCH_GPU_NB,
  56     ewcMOVEX, ewcGB, ewcFORCE, ewcMOVEF, ewcPMEMESH,
  57     ewcPME_REDISTXF, ewcPME_SPREADGATHER, ewcPME_FFT, ewcPME_FFTCOMM, ewcLJPME, ewcPME_SOLVE,
  58     ewcPMEWAITCOMM, ewcPP_PMEWAITRECVF, ewcWAIT_GPU_NB_NL, ewcWAIT_GPU_NB_L, ewcWAIT_GPU_NB_L_EST, ewcNB_XF_BUF_OPS,
  59     ewcVSITESPREAD, ewcPULLPOT,
  60     ewcTRAJ, ewcUPDATE, ewcCONSTR, ewcMoveE, ewcROT, ewcROTadd, ewcSWAP, ewcIMD,
  61     ewcTEST, ewcNR
  62 };
  63
  64
  65 enum {
  66     ewcsDD_REDIST, ewcsDD_GRID, ewcsDD_SETUPCOMM,
  67     ewcsDD_MAKETOP, ewcsDD_MAKECONSTR, ewcsDD_TOPOTHER,
  68     ewcsNBS_GRID_LOCAL, ewcsNBS_GRID_NONLOCAL,
  69     ewcsNBS_SEARCH_LOCAL, ewcsNBS_SEARCH_NONLOCAL,
  70     ewcsLISTED,
  71     ewcsLISTED_FEP,
  72     ewcsRESTRAINTS,
  73     ewcsLISTED_BUF_OPS,
  74     ewcsNONBONDED,
  75     ewcsEWALD_CORRECTION,
  76     ewcsNB_X_BUF_OPS,
  77     ewcsNB_F_BUF_OPS,
  78     ewcsNR
  79 };
  80
  81 gmx_bool wallcycle_have_counter(void);
  82 /* Returns if cycle counting is supported */
  83
  84 gmx_wallcycle_t wallcycle_init(FILE *fplog, int resetstep, struct t_commrec *cr);
  85 /* Returns the wall cycle structure.
  86  * Returns NULL when cycle counting is not supported.
  87  */
  88
  89 void wallcycle_start(gmx_wallcycle_t wc, int ewc);
  90 /* Starts the cycle counter (and increases the call count) */
  91
  92 void wallcycle_start_nocount(gmx_wallcycle_t wc, int ewc);
  93 /* Starts the cycle counter without increasing the call count */
  94
  95 double wallcycle_stop(gmx_wallcycle_t wc, int ewc);
  96 /* Stop the cycle count for ewc, returns the last cycle count */
  97
  98 void wallcycle_get(gmx_wallcycle_t wc, int ewc, int *n, double *c);
  99 /* Returns the cumulative count and cycle count for ewc */
 100
 101 void wallcycle_reset_all(gmx_wallcycle_t wc);
 102 /* Resets all cycle counters to zero */
 103
 104 void wallcycle_scale_by_num_threads(gmx_wallcycle_t wc, bool isPmeRank, int nthreads_pp, int nthreads_pme);
 105 /* Scale the cycle counts to reflect how many threads run for that number of cycles */
 106
 107 typedef std::array<double, ewcNR+ewcsNR> WallcycleCounts;
 108 /* Convenience typedef */
 109
 110 WallcycleCounts wallcycle_sum(struct t_commrec *cr, gmx_wallcycle_t wc);
 111 /* Return a vector of the sum of cycle counts over the nodes in
 112    cr->mpi_comm_mysim. */
 113
 114 void wallcycle_print(FILE *fplog, int nnodes, int npme,
 115                      int nth_pp, int nth_pme, double realtime,
 116                      gmx_wallcycle_t wc, const WallcycleCounts &cyc_sum,
 117                      struct gmx_wallclock_gpu_t *gpu_t);
 118 /* Print the cycle and time accounting */
 119
 120 gmx_int64_t wcycle_get_reset_counters(gmx_wallcycle_t wc);
 121 /* Return reset_counters from wc struct */
 122
 123 void wcycle_set_reset_counters(gmx_wallcycle_t wc, gmx_int64_t reset_counters);
 124 /* Set reset_counters */
 125
 126 void wallcycle_sub_start(gmx_wallcycle_t wc, int ewcs);
 127 /* Set the start sub cycle count for ewcs */
 128
 129 void wallcycle_sub_start_nocount(gmx_wallcycle_t wc, int ewcs);
 130 /* Set the start sub cycle count for ewcs without increasing the call count */
 131
 132 void wallcycle_sub_stop(gmx_wallcycle_t wc, int ewcs);
 133 /* Stop the sub cycle count for ewcs */
 134
 135 #endif