src/gromacs/timing/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 #ifndef GMX_TIMING_WALLCYCLE_H
  35 #define GMX_TIMING_WALLCYCLE_H
  36
  37 #include <stdio.h>
  38 #include "gromacs/legacyheaders/typedefs.h"
  39 #include "gromacs/legacyheaders/types/commrec.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 enum {
  46     ewcRUN, ewcSTEP, ewcPPDURINGPME, ewcDOMDEC, ewcDDCOMMLOAD,
  47     ewcDDCOMMBOUND, ewcVSITECONSTR, ewcPP_PMESENDX, ewcNS, ewcLAUNCH_GPU_NB,
  48     ewcMOVEX, ewcGB, ewcFORCE, ewcMOVEF, ewcPMEMESH,
  49     ewcPME_REDISTXF, ewcPME_SPREADGATHER, ewcPME_FFT, ewcPME_FFTCOMM, ewcPME_SOLVE,
  50     ewcPMEWAITCOMM, ewcPP_PMEWAITRECVF, ewcWAIT_GPU_NB_NL, ewcWAIT_GPU_NB_L, ewcNB_XF_BUF_OPS,
  51     ewcVSITESPREAD, ewcTRAJ, ewcUPDATE, ewcCONSTR, ewcMoveE, ewcROT, ewcROTadd,
  52     ewcTEST, ewcNR
  53 };
  54
  55 enum {
  56     ewcsDD_REDIST, ewcsDD_GRID, ewcsDD_SETUPCOMM,
  57     ewcsDD_MAKETOP, ewcsDD_MAKECONSTR, ewcsDD_TOPOTHER,
  58     ewcsNBS_GRID_LOCAL, ewcsNBS_GRID_NONLOCAL,
  59     ewcsNBS_SEARCH_LOCAL, ewcsNBS_SEARCH_NONLOCAL,
  60     ewcsBONDED, ewcsNONBONDED, ewcsEWALD_CORRECTION,
  61     ewcsNB_X_BUF_OPS, ewcsNB_F_BUF_OPS,
  62     ewcsNR
  63 };
  64
  65 gmx_bool wallcycle_have_counter(void);
  66 /* Returns if cycle counting is supported */
  67
  68 gmx_wallcycle_t wallcycle_init(FILE *fplog, int resetstep, t_commrec *cr,
  69                                int nthreads_pp, int nthreads_pme);
  70 /* Returns the wall cycle structure.
  71  * Returns NULL when cycle counting is not supported.
  72  */
  73
  74 void wallcycle_start(gmx_wallcycle_t wc, int ewc);
  75 /* Starts the cycle counter (and increases the call count) */
  76
  77 void wallcycle_start_nocount(gmx_wallcycle_t wc, int ewc);
  78 /* Starts the cycle counter without increasing the call count */
  79
  80 double wallcycle_stop(gmx_wallcycle_t wc, int ewc);
  81 /* Stop the cycle count for ewc, returns the last cycle count */
  82
  83 void wallcycle_reset_all(gmx_wallcycle_t wc);
  84 /* Resets all cycle counters to zero */
  85
  86 void wallcycle_sum(t_commrec *cr, gmx_wallcycle_t wc);
  87 /* Sum the cycles over the nodes in cr->mpi_comm_mysim */
  88
  89 void wallcycle_print(FILE *fplog, int nnodes, int npme, double realtime,
  90                      gmx_wallcycle_t wc, wallclock_gpu_t *gpu_t);
  91 /* Print the cycle and time accounting */
  92
  93 gmx_large_int_t wcycle_get_reset_counters(gmx_wallcycle_t wc);
  94 /* Return reset_counters from wc struct */
  95
  96 void wcycle_set_reset_counters(gmx_wallcycle_t wc, gmx_large_int_t reset_counters);
  97 /* Set reset_counters */
  98
  99 void wallcycle_sub_start(gmx_wallcycle_t wc, int ewcs);
 100 /* Set the start sub cycle count for ewcs */
 101
 102 void wallcycle_sub_stop(gmx_wallcycle_t wc, int ewcs);
 103 /* Stop the sub cycle count for ewcs */
 104
 105 #ifdef __cplusplus
 106 }
 107 #endif
 108
 109 #endif