Cleanup: comments (long lines) in blenlib
[blender.git] / source / blender / blenlib / PIL_time_utildefines.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2013 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup bli
22  * \brief Utility defines for timing/benchmarks.
23  */
24
25 #ifndef __PIL_TIME_UTILDEFINES_H__
26 #define __PIL_TIME_UTILDEFINES_H__
27
28 #include "PIL_time.h"        /* for PIL_check_seconds_timer */
29 #include "BLI_utildefines.h" /* for AT */
30
31 #define TIMEIT_START(var) \
32   { \
33     double _timeit_##var = PIL_check_seconds_timer(); \
34     printf("time start (" #var "):  " AT "\n"); \
35     fflush(stdout); \
36     { \
37       (void)0
38
39 /**
40  * \return the time since TIMEIT_START was called.
41  */
42 #define TIMEIT_VALUE(var) (float)(PIL_check_seconds_timer() - _timeit_##var)
43
44 #define TIMEIT_VALUE_PRINT(var) \
45   { \
46     printf("time update   (" #var \
47            "): %.6f" \
48            "  " AT "\n", \
49            TIMEIT_VALUE(var)); \
50     fflush(stdout); \
51   } \
52   (void)0
53
54 #define TIMEIT_END(var) \
55   } \
56   printf("time end   (" #var \
57          "): %.6f" \
58          "  " AT "\n", \
59          TIMEIT_VALUE(var)); \
60   fflush(stdout); \
61   } \
62   (void)0
63
64 /**
65  * _AVERAGED variants do same thing as their basic counterpart,
66  * but additionally add elapsed time to an averaged static value,
67  * useful to get sensible timing of code running fast and often.
68  */
69 #define TIMEIT_START_AVERAGED(var) \
70   { \
71     static float _sum_##var = 0.0f; \
72     static float _num_##var = 0.0f; \
73     double _timeit_##var = PIL_check_seconds_timer(); \
74     printf("time start    (" #var "):  " AT "\n"); \
75     fflush(stdout); \
76     { \
77       (void)0
78
79 #define TIMEIT_AVERAGED_VALUE(var) (_num##var ? (_sum_##var / _num_##var) : 0.0f)
80
81 #define TIMEIT_END_AVERAGED(var) \
82   } \
83   const float _delta_##var = TIMEIT_VALUE(var); \
84   _sum_##var += _delta_##var; \
85   _num_##var++; \
86   printf("time end      (" #var \
87          "): %.6f" \
88          "  " AT "\n", \
89          _delta_##var); \
90   printf("time averaged (" #var "): %.6f (total: %.6f, in %d runs)\n", \
91          (_sum_##var / _num_##var), \
92          _sum_##var, \
93          (int)_num_##var); \
94   fflush(stdout); \
95   } \
96   (void)0
97
98 /**
99  * Given some function/expression:
100  *   TIMEIT_BENCH(some_function(), some_unique_description);
101  */
102 #define TIMEIT_BENCH(expr, id) \
103   { \
104     TIMEIT_START(id); \
105     (expr); \
106     TIMEIT_END(id); \
107   } \
108   (void)0
109
110 #define TIMEIT_BLOCK_INIT(id) double _timeit_var_##id = 0
111
112 #define TIMEIT_BLOCK_START(id) \
113   { \
114     double _timeit_block_start_##id = PIL_check_seconds_timer(); \
115     { \
116       (void)0
117
118 #define TIMEIT_BLOCK_END(id) \
119   } \
120   _timeit_var_##id += (PIL_check_seconds_timer() - _timeit_block_start_##id); \
121   } \
122   (void)0
123
124 #define TIMEIT_BLOCK_STATS(id) \
125   { \
126     printf("%s time (in seconds): %f\n", #id, _timeit_var_##id); \
127     fflush(stdout); \
128   } \
129   (void)0
130
131 #endif /* __PIL_TIME_UTILDEFINES_H__ */