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