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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the COPYING file, which can be found at the root of the source code *
* distribution tree, or in https://www.hdfgroup.org/licenses. *
* If you do not have access to either file, you may request a copy from *
* help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*-------------------------------------------------------------------------
* Created: H5timer.c
*
* Purpose: Internal, platform-independent 'timer' support routines.
*
*-------------------------------------------------------------------------
*/
/****************/
/* Module Setup */
/****************/
#include "H5module.h" /* This source code file is part of the H5 module */
/***********/
/* Headers */
/***********/
#include "H5private.h" /* Generic Functions */
/****************/
/* Local Macros */
/****************/
/* Size of a generated time string.
* Most time strings should be < 20 or so characters (max!) so this should be a
* safe size. Dynamically allocating the correct size would be painful.
*/
#define H5TIMER_TIME_STRING_LEN 1536
/* Conversion factors */
#define H5_SEC_PER_DAY (24.0 * 60.0 * 60.0)
#define H5_SEC_PER_HOUR (60.0 * 60.0)
#define H5_SEC_PER_MIN (60.0)
/******************/
/* Local Typedefs */
/******************/
/********************/
/* Package Typedefs */
/********************/
/********************/
/* Local Prototypes */
/********************/
/*********************/
/* Package Variables */
/*********************/
/*****************************/
/* Library Private Variables */
/*****************************/
/*******************/
/* Local Variables */
/*******************/
/*-------------------------------------------------------------------------
* Function: H5_bandwidth
*
* Purpose: Prints the bandwidth (bytes per second) in a field 10
* characters wide widh four digits of precision like this:
*
* NaN If <=0 seconds
* 1234. TB/s
* 123.4 TB/s
* 12.34 GB/s
* 1.234 MB/s
* 4.000 kB/s
* 1.000 B/s
* 0.000 B/s If NBYTES==0
* 1.2345e-10 For bandwidth less than 1
* 6.7893e+94 For exceptionally large values
* 6.678e+106 For really big values
*
* Return: void
*
*-------------------------------------------------------------------------
*/
void
H5_bandwidth(char *buf /*out*/, size_t bufsize, double nbytes, double nseconds)
{
double bw;
if (nseconds <= 0.0)
HDstrcpy(buf, " NaN");
else {
bw = nbytes / nseconds;
if (H5_DBL_ABS_EQUAL(bw, 0.0))
HDstrcpy(buf, "0.000 B/s");
else if (bw < 1.0)
HDsnprintf(buf, bufsize, "%10.4e", bw);
else if (bw < (double)H5_KB) {
HDsnprintf(buf, bufsize, "%05.4f", bw);
HDstrcpy(buf + 5, " B/s");
}
else if (bw < (double)H5_MB) {
HDsnprintf(buf, bufsize, "%05.4f", bw / (double)H5_KB);
HDstrcpy(buf + 5, " kB/s");
}
else if (bw < (double)H5_GB) {
HDsnprintf(buf, bufsize, "%05.4f", bw / (double)H5_MB);
HDstrcpy(buf + 5, " MB/s");
}
else if (bw < (double)H5_TB) {
HDsnprintf(buf, bufsize, "%05.4f", bw / (double)H5_GB);
HDstrcpy(buf + 5, " GB/s");
}
else if (bw < (double)H5_PB) {
HDsnprintf(buf, bufsize, "%05.4f", bw / (double)H5_TB);
HDstrcpy(buf + 5, " TB/s");
}
else if (bw < (double)H5_EB) {
HDsnprintf(buf, bufsize, "%05.4f", bw / (double)H5_PB);
HDstrcpy(buf + 5, " PB/s");
}
else {
HDsnprintf(buf, bufsize, "%10.4e", bw);
if (HDstrlen(buf) > 10)
HDsnprintf(buf, bufsize, "%10.3e", bw);
} /* end else-if */
} /* end else */
} /* end H5_bandwidth() */
/*-------------------------------------------------------------------------
* Function: H5_now
*
* Purpose: Retrieves the current time, as seconds after the UNIX epoch.
*
* Return: # of seconds from the epoch (can't fail)
*
*-------------------------------------------------------------------------
*/
time_t
H5_now(void)
{
time_t now; /* Current time */
#ifdef H5_HAVE_GETTIMEOFDAY
{
struct timeval now_tv;
HDgettimeofday(&now_tv, NULL);
now = now_tv.tv_sec;
}
#else /* H5_HAVE_GETTIMEOFDAY */
now = HDtime(NULL);
#endif /* H5_HAVE_GETTIMEOFDAY */
return (now);
} /* end H5_now() */
/*-------------------------------------------------------------------------
* Function: H5_now_usec
*
* Purpose: Retrieves the current time, as microseconds after the UNIX epoch.
*
* Return: # of microseconds from the epoch (can't fail)
*
*-------------------------------------------------------------------------
*/
uint64_t
H5_now_usec(void)
{
uint64_t now; /* Current time, in microseconds */
#if defined(H5_HAVE_CLOCK_GETTIME)
{
struct timespec ts;
clock_gettime(CLOCK_MONOTONIC, &ts);
/* Cast all values in this expression to uint64_t to ensure that all intermediate
* calculations are done in 64 bit, to prevent overflow */
now = ((uint64_t)ts.tv_sec * ((uint64_t)1000 * (uint64_t)1000)) +
((uint64_t)ts.tv_nsec / (uint64_t)1000);
}
#elif defined(H5_HAVE_GETTIMEOFDAY)
{
struct timeval now_tv;
HDgettimeofday(&now_tv, NULL);
/* Cast all values in this expression to uint64_t to ensure that all intermediate
* calculations are done in 64 bit, to prevent overflow */
now = ((uint64_t)now_tv.tv_sec * ((uint64_t)1000 * (uint64_t)1000)) + (uint64_t)now_tv.tv_usec;
}
#else /* H5_HAVE_GETTIMEOFDAY */
/* Cast all values in this expression to uint64_t to ensure that all intermediate calculations
* are done in 64 bit, to prevent overflow */
now = ((uint64_t)HDtime(NULL) * ((uint64_t)1000 * (uint64_t)1000));
#endif /* H5_HAVE_GETTIMEOFDAY */
return (now);
} /* end H5_now_usec() */
/*--------------------------------------------------------------------------
* Function: H5_get_time
*
* Purpose: Get the current time, as the time of seconds after the UNIX epoch
*
* Return: Success: A non-negative time value
* Failure: -1.0 (in theory, can't currently fail)
*
*--------------------------------------------------------------------------
*/
double
H5_get_time(void)
{
double ret_value = 0.0;
FUNC_ENTER_NOAPI_NOINIT_NOERR
#if defined(H5_HAVE_CLOCK_GETTIME)
{
struct timespec ts;
clock_gettime(CLOCK_MONOTONIC, &ts);
ret_value = (double)ts.tv_sec + ((double)ts.tv_nsec / 1000000000.0);
}
#elif defined(H5_HAVE_GETTIMEOFDAY)
{
struct timeval now_tv;
HDgettimeofday(&now_tv, NULL);
ret_value = (double)now_tv.tv_sec + ((double)now_tv.tv_usec / 1000000.0);
}
#else
ret_value = (double)HDtime(NULL);
#endif
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5_get_time() */
/*-------------------------------------------------------------------------
* Function: H5__timer_get_timevals
*
* Purpose: Internal platform-specific function to get time system,
* user and elapsed time values.
*
* Return: Success: 0
* Failure: -1
*
*-------------------------------------------------------------------------
*/
static herr_t
H5__timer_get_timevals(H5_timevals_t *times /*in,out*/)
{
/* Sanity check */
assert(times);
/* Windows call handles both system/user and elapsed times */
#ifdef H5_HAVE_WIN32_API
if (H5_get_win32_times(times) < 0) {
times->elapsed = -1.0;
times->system = -1.0;
times->user = -1.0;
return -1;
} /* end if */
#else /* H5_HAVE_WIN32_API */
/*************************
* System and user times *
*************************/
#if defined(H5_HAVE_GETRUSAGE)
{
struct rusage res;
if (getrusage(RUSAGE_SELF, &res) < 0)
return -1;
times->system = (double)res.ru_stime.tv_sec + ((double)res.ru_stime.tv_usec / 1.0E6);
times->user = (double)res.ru_utime.tv_sec + ((double)res.ru_utime.tv_usec / 1.0E6);
}
#else
/* No suitable way to get system/user times */
/* This is not an error condition, they just won't be available */
times->system = -1.0;
times->user = -1.0;
#endif
/****************
* Elapsed time *
****************/
times->elapsed = H5_get_time();
#endif /* H5_HAVE_WIN32_API */
return 0;
} /* end H5__timer_get_timevals() */
/*-------------------------------------------------------------------------
* Function: H5_timer_init
*
* Purpose: Initialize a platform-independent timer.
*
* Timer usage is as follows:
*
* 1) Call H5_timer_init(), passing in a timer struct, to set
* up the timer.
*
* 2) Wrap any code you'd like to time with calls to
* H5_timer_start/stop(). For accurate timing, place these
* calls as close to the code of interest as possible. You
* can call start/stop multiple times on the same timer -
* when you do this, H5_timer_get_times() will return time
* values for the current/last session and
* H5_timer_get_total_times() will return the summed times
* of all sessions (see #3 and #4, below).
*
* 3) Use H5_timer_get_times() to get the current system, user
* and elapsed times from a running timer. If called on a
* stopped timer, this will return the time recorded at the
* stop point.
*
* 4) Call H5_timer_get_total_times() to get the total system,
* user and elapsed times recorded across multiple start/stop
* sessions. If called on a running timer, it will return the
* time recorded up to that point. On a stopped timer, it
* will return the time recorded at the stop point.
*
* NOTE: Obtaining a time point is not free! Keep in mind that
* the time functions make system calls and can have
* non-trivial overhead. If you call one of the get_time
* functions on a running timer, that overhead will be
* added to the reported times.
*
* 5) All times recorded will be in seconds. These can be
* converted into human-readable strings with the
* H5_timer_get_time_string() function.
*
* 6) A timer can be reset using by calling H5_timer_init() on
* it. This will set its state to 'stopped' and reset all
* accumulated times to zero.
*
*
* Return: Success: 0
* Failure: -1
*
*-------------------------------------------------------------------------
*/
herr_t
H5_timer_init(H5_timer_t *timer /*in,out*/)
{
/* Sanity check */
assert(timer);
/* Initialize everything */
memset(timer, 0, sizeof(H5_timer_t));
return 0;
} /* end H5_timer_init() */
/*-------------------------------------------------------------------------
* Function: H5_timer_start
*
* Purpose: Start tracking time in a platform-independent timer.
*
* Return: Success: 0
* Failure: -1
*
*-------------------------------------------------------------------------
*/
herr_t
H5_timer_start(H5_timer_t *timer /*in,out*/)
{
/* Sanity check */
assert(timer);
/* Start the timer
* This sets the "initial" times to the system-defined start times.
*/
if (H5__timer_get_timevals(&(timer->initial)) < 0)
return -1;
timer->is_running = true;
return 0;
} /* end H5_timer_start() */
/*-------------------------------------------------------------------------
* Function: H5_timer_stop
*
* Purpose: Stop tracking time in a platform-independent timer.
*
* Return: Success: 0
* Failure: -1
*
*-------------------------------------------------------------------------
*/
herr_t
H5_timer_stop(H5_timer_t *timer /*in,out*/)
{
/* Sanity check */
assert(timer);
/* Stop the timer */
if (H5__timer_get_timevals(&(timer->final_interval)) < 0)
return -1;
/* The "final" times are stored as intervals (final - initial)
* for more useful reporting to the user.
*/
timer->final_interval.elapsed = timer->final_interval.elapsed - timer->initial.elapsed;
timer->final_interval.system = timer->final_interval.system - timer->initial.system;
timer->final_interval.user = timer->final_interval.user - timer->initial.user;
/* Add the intervals to the elapsed time */
timer->total.elapsed += timer->final_interval.elapsed;
timer->total.system += timer->final_interval.system;
timer->total.user += timer->final_interval.user;
timer->is_running = false;
return 0;
} /* end H5_timer_stop() */
/*-------------------------------------------------------------------------
* Function: H5_timer_get_times
*
* Purpose: Get the system, user and elapsed times from a timer. These
* are the times since the timer was last started and will be
* 0.0 in a timer that has not been started since it was
* initialized.
*
* This function can be called either before or after
* H5_timer_stop() has been called. If it is called before the
* stop function, the timer will continue to run.
*
* The system and user times will be -1.0 if those times cannot
* be computed on a particular platform. The elapsed time will
* always be present.
*
* Return: Success: 0
* Failure: -1
*
*-------------------------------------------------------------------------
*/
herr_t
H5_timer_get_times(H5_timer_t timer, H5_timevals_t *times /*in,out*/)
{
/* Sanity check */
assert(times);
if (timer.is_running) {
H5_timevals_t now;
/* Get the current times and report the current intervals without
* stopping the timer.
*/
if (H5__timer_get_timevals(&now) < 0)
return -1;
times->elapsed = now.elapsed - timer.initial.elapsed;
times->system = now.system - timer.initial.system;
times->user = now.user - timer.initial.user;
} /* end if */
else {
times->elapsed = timer.final_interval.elapsed;
times->system = timer.final_interval.system;
times->user = timer.final_interval.user;
} /* end else */
return 0;
} /* end H5_timer_get_times() */
/*-------------------------------------------------------------------------
* Function: H5_timer_get_total_times
*
* Purpose: Get the TOTAL system, user and elapsed times recorded by
* the timer since its initialization. This is the sum of all
* times recorded while the timer was running.
*
* These will be 0.0 in a timer that has not been started
* since it was initialized. Calling H5_timer_init() on a
* timer will reset these values to 0.0.
*
* This function can be called either before or after
* H5_timer_stop() has been called. If it is called before the
* stop function, the timer will continue to run.
*
* The system and user times will be -1.0 if those times cannot
* be computed on a particular platform. The elapsed time will
* always be present.
*
* Return: Success: 0
* Failure: -1
*
*-------------------------------------------------------------------------
*/
herr_t
H5_timer_get_total_times(H5_timer_t timer, H5_timevals_t *times /*in,out*/)
{
/* Sanity check */
assert(times);
if (timer.is_running) {
H5_timevals_t now;
/* Get the current times and report the current totals without
* stopping the timer.
*/
if (H5__timer_get_timevals(&now) < 0)
return -1;
times->elapsed = timer.total.elapsed + (now.elapsed - timer.initial.elapsed);
times->system = timer.total.system + (now.system - timer.initial.system);
times->user = timer.total.user + (now.user - timer.initial.user);
} /* end if */
else {
times->elapsed = timer.total.elapsed;
times->system = timer.total.system;
times->user = timer.total.user;
} /* end else */
return 0;
} /* end H5_timer_get_total_times() */
/*-------------------------------------------------------------------------
* Function: H5_timer_get_time_string
*
* Purpose: Converts a time (in seconds) into a human-readable string
* suitable for log messages.
*
* Return: Success: The time string.
*
* The general format of the time string is:
*
* "N/A" time < 0 (invalid time)
* "%.f ns" time < 1 microsecond
* "%.1f us" time < 1 millisecond
* "%.1f ms" time < 1 second
* "%.2f s" time < 1 minute
* "%.f m %.f s" time < 1 hour
* "%.f h %.f m %.f s" longer times
*
* Failure: NULL
*
*-------------------------------------------------------------------------
*/
char *
H5_timer_get_time_string(double seconds)
{
char *s; /* output string */
/* Used when the time is greater than 59 seconds */
double days = 0.0;
double hours = 0.0;
double minutes = 0.0;
double remainder_sec = 0.0;
/* Extract larger time units from count of seconds */
if (seconds > 60.0) {
/* Set initial # of seconds */
remainder_sec = seconds;
/* Extract days */
days = floor(remainder_sec / H5_SEC_PER_DAY);
remainder_sec -= (days * H5_SEC_PER_DAY);
/* Extract hours */
hours = floor(remainder_sec / H5_SEC_PER_HOUR);
remainder_sec -= (hours * H5_SEC_PER_HOUR);
/* Extract minutes */
minutes = floor(remainder_sec / H5_SEC_PER_MIN);
remainder_sec -= (minutes * H5_SEC_PER_MIN);
/* The # of seconds left is in remainder_sec */
} /* end if */
/* Allocate */
if (NULL == (s = (char *)calloc(H5TIMER_TIME_STRING_LEN, sizeof(char))))
return NULL;
/* Do we need a format string? Some people might like a certain
* number of milliseconds or s before spilling to the next highest
* time unit. Perhaps this could be passed as an integer.
* (name? round_up_size? ?)
*/
if (seconds < 0.0)
HDsnprintf(s, H5TIMER_TIME_STRING_LEN, "N/A");
else if (H5_DBL_ABS_EQUAL(0.0, seconds))
HDsnprintf(s, H5TIMER_TIME_STRING_LEN, "0.0 s");
else if (seconds < 1.0E-6)
/* t < 1 us, Print time in ns */
HDsnprintf(s, H5TIMER_TIME_STRING_LEN, "%.f ns", seconds * 1.0E9);
else if (seconds < 1.0E-3)
/* t < 1 ms, Print time in us */
HDsnprintf(s, H5TIMER_TIME_STRING_LEN, "%.1f us", seconds * 1.0E6);
else if (seconds < 1.0)
/* t < 1 s, Print time in ms */
HDsnprintf(s, H5TIMER_TIME_STRING_LEN, "%.1f ms", seconds * 1.0E3);
else if (seconds < H5_SEC_PER_MIN)
/* t < 1 m, Print time in s */
HDsnprintf(s, H5TIMER_TIME_STRING_LEN, "%.2f s", seconds);
else if (seconds < H5_SEC_PER_HOUR)
/* t < 1 h, Print time in m and s */
HDsnprintf(s, H5TIMER_TIME_STRING_LEN, "%.f m %.f s", minutes, remainder_sec);
else if (seconds < H5_SEC_PER_DAY)
/* t < 1 d, Print time in h, m and s */
HDsnprintf(s, H5TIMER_TIME_STRING_LEN, "%.f h %.f m %.f s", hours, minutes, remainder_sec);
else
/* Print time in d, h, m and s */
HDsnprintf(s, H5TIMER_TIME_STRING_LEN, "%.f d %.f h %.f m %.f s", days, hours, minutes,
remainder_sec);
return s;
} /* end H5_timer_get_time_string() */
|