include/gmx_wallcycle.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2008, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  *
  31  * And Hey:
  32  * Gallium Rubidium Oxygen Manganese Argon Carbon Silicon
  33  */
  34
  35
  36 #ifndef _gmx_wallcycle_h
  37 #define _gmx_wallcycle_h
  38
  39 #include <stdio.h>
  40 #include "typedefs.h"
  41 #include "types/commrec.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 enum { ewcRUN, ewcSTEP, ewcPPDURINGPME, ewcDOMDEC, ewcDDCOMMLOAD,
  48        ewcDDCOMMBOUND, ewcVSITECONSTR, ewcPP_PMESENDX, ewcNS, ewcLAUNCH_GPU_NB,
  49        ewcMOVEX, ewcGB, ewcFORCE, ewcMOVEF, ewcPMEMESH,
  50        ewcPME_REDISTXF, ewcPME_SPREADGATHER, ewcPME_FFT, ewcPME_FFTCOMM, ewcPME_SOLVE,
  51        ewcPMEWAITCOMM, ewcPP_PMEWAITRECVF, ewcWAIT_GPU_NB_NL, ewcWAIT_GPU_NB_L, ewcNB_XF_BUF_OPS,
  52        ewcVSITESPREAD, ewcTRAJ, ewcUPDATE, ewcCONSTR, ewcMoveE, ewcROT, ewcROTadd,
  53        ewcTEST, ewcNR };
  54
  55 enum { ewcsDD_REDIST, ewcsDD_GRID, ewcsDD_SETUPCOMM,
  56        ewcsDD_MAKETOP, ewcsDD_MAKECONSTR, ewcsDD_TOPOTHER,
  57        ewcsNBS_GRID_LOCAL, ewcsNBS_GRID_NONLOCAL,
  58        ewcsNBS_SEARCH_LOCAL, ewcsNBS_SEARCH_NONLOCAL,
  59        ewcsBONDED, ewcsNONBONDED, ewcsEWALD_CORRECTION,
  60        ewcsNB_X_BUF_OPS, ewcsNB_F_BUF_OPS,
  61        ewcsNR };
  62
  63 gmx_bool wallcycle_have_counter(void);
  64 /* Returns if cycle counting is supported */
  65
  66 gmx_wallcycle_t wallcycle_init(FILE *fplog, int resetstep, t_commrec *cr,
  67                                int nthreads_pp, int nthreads_pme);
  68 /* Returns the wall cycle structure.
  69  * Returns NULL when cycle counting is not supported.
  70  */
  71
  72 void wallcycle_start(gmx_wallcycle_t wc, int ewc);
  73 /* Starts the cycle counter (and increases the call count) */
  74
  75 void wallcycle_start_nocount(gmx_wallcycle_t wc, int ewc);
  76 /* Starts the cycle counter without increasing the call count */
  77
  78 double wallcycle_stop(gmx_wallcycle_t wc, int ewc);
  79 /* Stop the cycle count for ewc, returns the last cycle count */
  80
  81 void wallcycle_reset_all(gmx_wallcycle_t wc);
  82 /* Resets all cycle counters to zero */
  83
  84 void wallcycle_sum(t_commrec *cr, gmx_wallcycle_t wc);
  85 /* Sum the cycles over the nodes in cr->mpi_comm_mysim */
  86
  87 void wallcycle_print(FILE *fplog, int nnodes, int npme, double realtime,
  88                             gmx_wallcycle_t wc, wallclock_gpu_t *gpu_t);
  89 /* Print the cycle and time accounting */
  90
  91 gmx_large_int_t wcycle_get_reset_counters(gmx_wallcycle_t wc);
  92 /* Return reset_counters from wc struct */
  93
  94 void wcycle_set_reset_counters(gmx_wallcycle_t wc, gmx_large_int_t reset_counters);
  95 /* Set reset_counters */
  96
  97 /* Uncomment the next line to get extra cycle counters of sub parts */
  98 /* #define GMX_CYCLE_SUBCOUNTERS */
  99
 100 #ifdef GMX_CYCLE_SUBCOUNTERS
 101
 102 void wallcycle_sub_start(gmx_wallcycle_t wc, int ewcs);
 103 /* Set the start sub cycle count for ewcs */
 104
 105 void wallcycle_sub_stop(gmx_wallcycle_t wc, int ewcs);
 106 /* Stop the sub cycle count for ewcs */
 107
 108 #else
 109 /* Define the counter call to nothing to avoid any effect on performance */
 110 #define wallcycle_sub_start(wc, ewcs)
 111 #define wallcycle_sub_stop(wc, ewcs)
 112 #endif
 113
 114 #ifdef __cplusplus
 115 }
 116 #endif
 117
 118 #endif /* _gmx_wallcycle_h */