hdf5/test/timer.c
Larry Knox 11dfa25910
Update copyright headers (#2184)
* Updated source file copyright headers to remove "Copyright by the Board of Trustees
of the University of Illinois", which is kept in the top-level COPYING file.
2022-11-01 16:02:27 -05:00

400 lines
10 KiB
C

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
* Programmer: Dana Robinson
* May, 2011
*
* Purpose: Tests the operation of the platform-independent timers.
*/
#include "h5test.h"
/*-------------------------------------------------------------------------
* Function: test_time_formatting
*
* Purpose: Tests time string creation.
*
* Return: Success: 0
* Failure: -1
*
* Programmer: Dana Robinson
* May 2011
*
*-------------------------------------------------------------------------
*/
static herr_t
test_time_formatting(void)
{
char *s = NULL;
TESTING("Time string formats");
/* < 0, N/A */
s = H5_timer_get_time_string(-1.0);
if (NULL == s || HDstrcmp(s, "N/A") != 0)
TEST_ERROR;
HDfree(s);
/* 0 0 */
s = H5_timer_get_time_string(0.0);
if (NULL == s || HDstrcmp(s, "0.0 s") != 0)
TEST_ERROR;
HDfree(s);
/* < 1 us nanoseconds */
s = H5_timer_get_time_string(123.0E-9);
if (NULL == s || HDstrcmp(s, "123 ns") != 0)
TEST_ERROR;
HDfree(s);
/* < 1 ms microseconds */
s = H5_timer_get_time_string(23.456E-6);
if (NULL == s || HDstrcmp(s, "23.5 us") != 0)
TEST_ERROR;
HDfree(s);
/* < 1 s milliseconds */
s = H5_timer_get_time_string(4.56789E-3);
if (NULL == s || HDstrcmp(s, "4.6 ms") != 0)
TEST_ERROR;
HDfree(s);
/* < 1 min seconds */
s = H5_timer_get_time_string(3.14);
if (NULL == s || HDstrcmp(s, "3.14 s") != 0)
TEST_ERROR;
HDfree(s);
/* < 1 hr mins, secs */
s = H5_timer_get_time_string(2521.0);
if (NULL == s || HDstrcmp(s, "42 m 1 s") != 0)
TEST_ERROR;
HDfree(s);
/* < 1 d hrs, mins, secs */
s = H5_timer_get_time_string(9756.0);
if (NULL == s || HDstrcmp(s, "2 h 42 m 36 s") != 0)
TEST_ERROR;
HDfree(s);
/* > 1 d days, hrs, mins, secs */
s = H5_timer_get_time_string(280802.0);
if (NULL == s || HDstrcmp(s, "3 d 6 h 0 m 2 s") != 0)
TEST_ERROR;
HDfree(s);
PASSED();
return 0;
error:
if (s)
HDfree(s);
return -1;
}
/*-------------------------------------------------------------------------
* Function: test_timer_system_user
*
* Purpose: Tests the ability to get system and user times from the
* timers.
* Some platforms may require special code to get system and
* user times. If we do not support that particular platform
* dependent functionality, this test is skipped.
*
* Return: Success: 0
* Failure: -1
*
* Programmer: Dana Robinson
* May 2011
*
*-------------------------------------------------------------------------
*/
static herr_t
test_timer_system_user(void)
{
int i;
char *buf = NULL;
H5_timer_t timer;
H5_timevals_t times;
herr_t err;
TESTING("system/user times");
err = H5_timer_init(&timer);
if (err < 0)
TEST_ERROR;
err = H5_timer_start(&timer);
if (err < 0)
TEST_ERROR;
/* The system and user times may not be present on some systems. They
* will be -1.0 if they are not.
*/
if (timer.initial.system < 0.0 || timer.initial.user < 0.0) {
SKIPPED();
HDprintf("NOTE: No suitable way to get system/user times on this platform.\n");
return 0;
}
/* Do some fake work */
for (i = 0; i < 1024; i++) {
buf = (char *)HDmalloc(1024 * (size_t)i);
HDfree(buf);
}
err = H5_timer_stop(&timer);
if (err < 0)
TEST_ERROR;
err = H5_timer_get_times(timer, &times);
if (err < 0)
TEST_ERROR;
/* System and user times should be non-negative. */
if (times.system < 0.0 || times.user < 0.0)
TEST_ERROR;
PASSED();
return 0;
error:
return -1;
}
/*-------------------------------------------------------------------------
* Function: test_timer_elapsed
*
* Purpose: Tests the ability to get elapsed times from the timers.
* We should always be able to get an elapsed time,
* regardless of the time libraries or platform.
*
* Return: Success: 0
* Failure: -1
*
* Programmer: Dana Robinson
* May 2011
*
*-------------------------------------------------------------------------
*/
static herr_t
test_timer_elapsed(void)
{
int i;
char *buf = NULL;
H5_timer_t timer;
H5_timevals_t times;
herr_t err;
TESTING("elapsed times");
err = H5_timer_init(&timer);
if (err < 0)
TEST_ERROR;
err = H5_timer_start(&timer);
if (err < 0)
TEST_ERROR;
/* Do some fake work */
for (i = 0; i < 1024; i++) {
buf = (char *)HDmalloc(1024 * (size_t)i);
HDfree(buf);
}
err = H5_timer_stop(&timer);
if (err < 0)
TEST_ERROR;
err = H5_timer_get_times(timer, &times);
if (err < 0)
TEST_ERROR;
/* Elapsed time should be non-negative. */
if (times.elapsed < 0.0)
TEST_ERROR;
PASSED();
return 0;
error:
return -1;
}
static herr_t
test_timer_functionality(void)
{
int i;
char *buf = NULL;
H5_timer_t timer;
H5_timevals_t times;
double prev_etime;
double prev_total_etime;
herr_t err;
TESTING("timer functionality");
/*****************
* CHECK STARTUP *
*****************/
/* Timer should be running after start */
err = H5_timer_init(&timer);
if (err < 0 || timer.is_running)
TEST_ERROR;
/* Times should be initialized to zero */
err = H5_timer_get_times(timer, &times);
if (err < 0 || !H5_DBL_ABS_EQUAL(times.elapsed, 0.0))
TEST_ERROR;
err = H5_timer_get_total_times(timer, &times);
if (err < 0 || !H5_DBL_ABS_EQUAL(times.elapsed, 0.0))
TEST_ERROR;
/********************
* CHECK START/STOP *
********************/
/* Running state should change after start */
err = H5_timer_start(&timer);
if (err < 0 || !timer.is_running)
TEST_ERROR;
/* Do some fake work */
for (i = 0; i < 1024; i++) {
buf = (char *)HDmalloc(1024 * (size_t)i);
HDfree(buf);
}
/* Running state should change after stop */
err = H5_timer_stop(&timer);
if (err < 0 || timer.is_running)
TEST_ERROR;
/* Times should be positive and non-negative */
err = H5_timer_get_times(timer, &times);
if (err < 0 || times.elapsed < 0.0)
TEST_ERROR;
err = H5_timer_get_total_times(timer, &times);
if (err < 0 || times.elapsed < 0.0)
TEST_ERROR;
/**********************
* CHECK INTERRUPTING *
**********************/
/* Timer should change stat and refresh to 0s */
err = H5_timer_init(&timer);
if (err < 0 || timer.is_running)
TEST_ERROR;
err = H5_timer_get_times(timer, &times);
if (err < 0 || !H5_DBL_ABS_EQUAL(times.elapsed, 0.0))
TEST_ERROR;
err = H5_timer_get_total_times(timer, &times);
if (err < 0 || !H5_DBL_ABS_EQUAL(times.elapsed, 0.0))
TEST_ERROR;
/* Timer state should flip */
err = H5_timer_start(&timer);
if (err < 0 || !timer.is_running)
TEST_ERROR;
/* Do some fake work */
for (i = 0; i < 1024; i++) {
buf = (char *)HDmalloc(1024 * (size_t)i);
HDfree(buf);
}
/* Times should be non-negative */
err = H5_timer_get_times(timer, &times);
if (err < 0 || times.elapsed < 0.0)
TEST_ERROR;
prev_etime = times.elapsed;
err = H5_timer_get_total_times(timer, &times);
if (err < 0 || times.elapsed < 0.0)
TEST_ERROR;
prev_total_etime = times.elapsed;
/* Do some fake work */
for (i = 0; i < 1024; i++) {
buf = (char *)HDmalloc(1024 * (size_t)i);
HDfree(buf);
}
/* State should flip on stop */
err = H5_timer_stop(&timer);
if (err < 0 || timer.is_running)
TEST_ERROR;
/* Times should be >= than the cached intermediate times */
err = H5_timer_get_times(timer, &times);
if (err < 0 || times.elapsed < prev_etime)
TEST_ERROR;
err = H5_timer_get_total_times(timer, &times);
if (err < 0 || times.elapsed < prev_total_etime)
TEST_ERROR;
PASSED();
return 0;
error:
return -1;
}
/*-------------------------------------------------------------------------
* Function: main
*
* Purpose: Tests the basic functionality of the platform-independent
* timers
*
* Return: Success: 0
* Failure: 1
*
* Programmer: Dana Robinson
* May, 2011
*
*-------------------------------------------------------------------------
*/
int
main(void)
{
int nerrors = 0;
h5_reset();
HDprintf("Testing platform-independent timer functionality.\n");
nerrors += test_time_formatting() < 0 ? 1 : 0;
nerrors += test_timer_system_user() < 0 ? 1 : 0;
nerrors += test_timer_elapsed() < 0 ? 1 : 0;
nerrors += test_timer_functionality() < 0 ? 1 : 0;
if (nerrors) {
HDprintf("***** %d platform-independent timer TEST%s FAILED! *****\n", nerrors,
nerrors > 1 ? "S" : "");
return 1;
}
else {
HDprintf("All platform-independent timer tests passed.\n");
return 0;
}
}