src/gromacs/timing/walltime_accounting.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-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014, 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
  38 #ifndef GMX_TIMING_WALLTIME_ACCOUNTING_H
  39 #define GMX_TIMING_WALLTIME_ACCOUNTING_H
  40
  41 #include "gromacs/utility/basedefinitions.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 #if 0
  48 }
  49 #endif
  50
  51 /*! \brief
  52  * Contains per-process and per-thread data about elapsed wall-clock
  53  * times and integration steps performed. */
  54 typedef struct gmx_walltime_accounting *gmx_walltime_accounting_t;
  55
  56 //! Constructor
  57 gmx_walltime_accounting_t
  58 walltime_accounting_init(int numOpenMPThreads);
  59
  60 //! Destructor
  61 void
  62 walltime_accounting_destroy(gmx_walltime_accounting_t walltime_accounting);
  63
  64 /*! \brief
  65  * Record initial time stamps, e.g. at run end or counter re-initalization time
  66  */
  67 void
  68 walltime_accounting_start(gmx_walltime_accounting_t walltime_accounting);
  69
  70 /*! \brief
  71  * Measure and cache the elapsed wall-clock time since
  72  * walltime_accounting_start() */
  73 void
  74 walltime_accounting_end(gmx_walltime_accounting_t walltime_accounting);
  75
  76 /*! \brief
  77  * Measure and return the elapsed wall-clock time since
  78  * walltime_accounting_start() */
  79 double
  80 walltime_accounting_get_current_elapsed_time(gmx_walltime_accounting_t walltime_accounting);
  81
  82 //! Get the cached wall-clock time for this node
  83 double
  84 walltime_accounting_get_elapsed_time(gmx_walltime_accounting_t walltime_accounting);
  85
  86 //! Get the cached wall-clock time, multiplied by the number of OpenMP threads
  87 double
  88 walltime_accounting_get_elapsed_time_over_all_threads(gmx_walltime_accounting_t walltime_accounting);
  89
  90 //! Get the cached initial time stamp for this node
  91 double
  92 walltime_accounting_get_start_time_stamp(gmx_walltime_accounting_t walltime_accounting);
  93
  94 //! Get the number of integration steps done
  95 gmx_int64_t
  96 walltime_accounting_get_nsteps_done(gmx_walltime_accounting_t walltime_accounting);
  97
  98 /*! \brief Set the number of integration steps done
  99  *
 100  * TODO consider whether this should get done in walltime_accounting_end */
 101 void
 102 walltime_accounting_set_nsteps_done(gmx_walltime_accounting_t   walltime_accounting,
 103                                     gmx_int64_t                 nsteps_done);
 104
 105 /*! \brief
 106  * Calls system timing routines (e.g. clock_gettime) to get the (fractional)
 107  * number of seconds elapsed since the epoch.
 108  *
 109  * Resolution is implementation-dependent, but typically nanoseconds
 110  * or microseconds. */
 111 double gmx_gettime();
 112
 113 #ifdef __cplusplus
 114 }
 115 #endif
 116
 117 #endif  /* GMX_TIMING_WALLTIME_ACCOUNTING_H */