src/gromacs/legacyheaders/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 {
  48     ewcRUN, ewcSTEP, ewcPPDURINGPME, ewcDOMDEC, ewcDDCOMMLOAD,
  49     ewcDDCOMMBOUND, ewcVSITECONSTR, ewcPP_PMESENDX, ewcNS, ewcLAUNCH_GPU_NB,
  50     ewcMOVEX, ewcGB, ewcFORCE, ewcMOVEF, ewcPMEMESH,
  51     ewcPME_REDISTXF, ewcPME_SPREADGATHER, ewcPME_FFT, ewcPME_FFTCOMM, ewcPME_SOLVE,
  52     ewcPMEWAITCOMM, ewcPP_PMEWAITRECVF, ewcWAIT_GPU_NB_NL, ewcWAIT_GPU_NB_L, ewcNB_XF_BUF_OPS,
  53     ewcVSITESPREAD, ewcTRAJ, ewcUPDATE, ewcCONSTR, ewcMoveE, ewcROT, ewcROTadd,
  54     ewcTEST, ewcNR
  55 };
  56
  57 enum {
  58     ewcsDD_REDIST, ewcsDD_GRID, ewcsDD_SETUPCOMM,
  59     ewcsDD_MAKETOP, ewcsDD_MAKECONSTR, ewcsDD_TOPOTHER,
  60     ewcsNBS_GRID_LOCAL, ewcsNBS_GRID_NONLOCAL,
  61     ewcsNBS_SEARCH_LOCAL, ewcsNBS_SEARCH_NONLOCAL,
  62     ewcsBONDED, ewcsNONBONDED, ewcsEWALD_CORRECTION,
  63     ewcsNB_X_BUF_OPS, ewcsNB_F_BUF_OPS,
  64     ewcsNR
  65 };
  66
  67 gmx_bool wallcycle_have_counter(void);
  68 /* Returns if cycle counting is supported */
  69
  70 gmx_wallcycle_t wallcycle_init(FILE *fplog, int resetstep, t_commrec *cr,
  71                                int nthreads_pp, int nthreads_pme);
  72 /* Returns the wall cycle structure.
  73  * Returns NULL when cycle counting is not supported.
  74  */
  75
  76 void wallcycle_start(gmx_wallcycle_t wc, int ewc);
  77 /* Starts the cycle counter (and increases the call count) */
  78
  79 void wallcycle_start_nocount(gmx_wallcycle_t wc, int ewc);
  80 /* Starts the cycle counter without increasing the call count */
  81
  82 double wallcycle_stop(gmx_wallcycle_t wc, int ewc);
  83 /* Stop the cycle count for ewc, returns the last cycle count */
  84
  85 void wallcycle_reset_all(gmx_wallcycle_t wc);
  86 /* Resets all cycle counters to zero */
  87
  88 void wallcycle_sum(t_commrec *cr, gmx_wallcycle_t wc);
  89 /* Sum the cycles over the nodes in cr->mpi_comm_mysim */
  90
  91 void wallcycle_print(FILE *fplog, int nnodes, int npme, double realtime,
  92                      gmx_wallcycle_t wc, wallclock_gpu_t *gpu_t);
  93 /* Print the cycle and time accounting */
  94
  95 gmx_large_int_t wcycle_get_reset_counters(gmx_wallcycle_t wc);
  96 /* Return reset_counters from wc struct */
  97
  98 void wcycle_set_reset_counters(gmx_wallcycle_t wc, gmx_large_int_t reset_counters);
  99 /* Set reset_counters */
 100
 101 /* Uncomment the next line to get extra cycle counters of sub parts */
 102 /* #define GMX_CYCLE_SUBCOUNTERS */
 103
 104 #ifdef GMX_CYCLE_SUBCOUNTERS
 105
 106 void wallcycle_sub_start(gmx_wallcycle_t wc, int ewcs);
 107 /* Set the start sub cycle count for ewcs */
 108
 109 void wallcycle_sub_stop(gmx_wallcycle_t wc, int ewcs);
 110 /* Stop the sub cycle count for ewcs */
 111
 112 #else
 113 /* Define the counter call to nothing to avoid any effect on performance */
 114 #define wallcycle_sub_start(wc, ewcs)
 115 #define wallcycle_sub_stop(wc, ewcs)
 116 #endif
 117
 118 #ifdef __cplusplus
 119 }
 120 #endif
 121
 122 #endif /* _gmx_wallcycle_h */