1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
#ifndef __ECS_TIMER_H__
#define __ECS_TIMER_H__
/*============================================================================
* Program timing information
*============================================================================*/
/*
This file is part of Code_Saturne, a general-purpose CFD tool.
Copyright (C) 1998-2018 EDF S.A.
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
* Local headers
*----------------------------------------------------------------------------*/
#include "ecs_def.h"
BEGIN_C_DECLS
/*============================================================================
* Public types
*============================================================================*/
/*============================================================================
* Public function prototypes
*============================================================================*/
/*
* Return Wall clock time
*
* returns:
* elapsed time from first call of a function of the ecs_timer_...()
* series, or -1 if unable to compute.
*/
double
ecs_timer_wtime(void);
/*
* Return CPU time.
*
* Note that in the rare case that only the minimal C library clock()
* method is available (see ecs_timer_cpu_time_method()), at least one of
* the ecs_timer_...() functions (possibly this one) must be called
* upon program start for this function to be used. In addition,
* in this case, time may "loop" back to 0 every multiple of
* 2^size_t / CLOCKS_PER_SEC seconds.
*
* returns:
* current CPU time usage, or -1 if unable to compute.
*/
double
ecs_timer_cpu_time(void);
/*
* Return separate user and system CPU times.
*
* parameters:
* user_time --> current user CPU usage.
* system_time --> current system CPU usage.
*/
void
ecs_timer_cpu_times(double *user_time,
double *system_time);
/*----------------------------------------------------------------------------*/
END_C_DECLS
#endif /* __ECS_TIMER_H__ */
|
