mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2024-11-21 01:04:10 +08:00
Code Issues Packages Projects Releases Wiki Activity
ce99ebcc99
hdf5/test/swmr_reader.c
Dana Robinson a99d620172
Clean up random number generator code (#4338) 
* Clean up random number generator code

Depending on the platform, we use a mix of random, rand, and rand_r
to generate pseudo-random numbers, along with a messy set of ifdefs
in H5private.h. We are not a cryptographic library, only use random
numbers in our test code, and have no need for anything more than the
C standard's (s)rand(). There's no point dithering about using rand()
vs random() when we're also doing bad things like using mod to
restrict the range, which introduces bias.

Also removes CMake/configure checks for rand_r and random

* Remove random/rand_r checks from build system

* Fix missed HDrandom after GitHub merge
2024-04-07 15:15:25 -07:00

546 lines
19 KiB
C
Raw Blame History

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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: swmr_reader.c
*
* Purpose: Reads data from a randomly selected subset of the datasets
* in the SWMR test file.
*
* This program is intended to run concurrently with the
* swmr_writer program.
*
*-------------------------------------------------------------------------
*/
/***********/
/* Headers */
/***********/
#include "h5test.h"
#include "swmr_common.h"
/********************/
/* Local Prototypes */
/********************/
static int check_dataset(hid_t fid, bool verbose, FILE *verbose_file, const char *sym_name, symbol_t *record,
hid_t rec_sid);
static int read_records(const char *filename, bool verbose, FILE *verbose_file, unsigned random_seed,
unsigned long nseconds, unsigned poll_time, unsigned ncommon, unsigned nrandom);
/*******************/
/* Local Variables */
/*******************/
static hid_t symbol_tid = H5I_INVALID_HID; /* The type ID for the SWMR datasets */
/*-------------------------------------------------------------------------
* Function: check_dataset
*
* Purpose: For a given dataset, checks to make sure that the stated
* and actual sizes are the same. If they are not, then
* we have an inconsistent dataset due to a SWMR error.
*
* Parameters: hid_t fid
* The SWMR test file's ID.
*
* bool verbose
* Whether verbose console output is desired.
*
* FILE *verbose_file
* File handle for verbose output
*
* const char *sym_name
* The name of the dataset from which to read.
*
* symbol_t *record
* Memory for the record. Must be pre-allocated.
*
* hid_t rec_sid
* The memory dataspace for access. It's always the same so
* there is no need to re-create it every time this function
* is called.
*
* Return: Success: 0
* Failure: -1
*
*-------------------------------------------------------------------------
*/
static int
check_dataset(hid_t fid, bool verbose, FILE *verbose_file, const char *sym_name, symbol_t *record,
hid_t rec_sid)
{
hid_t dsid; /* Dataset ID */
hid_t file_sid; /* Dataset's space ID */
hssize_t snpoints; /* Number of elements in dataset */
hsize_t start[2] = {0, 0}, count[2] = {1, 1}; /* Hyperslab selection values */
assert(fid >= 0);
assert(sym_name);
assert(record);
assert(rec_sid >= 0);
/* Open dataset for symbol */
if ((dsid = H5Dopen2(fid, sym_name, H5P_DEFAULT)) < 0)
return -1;
/* Get the dataset's dataspace */
if ((file_sid = H5Dget_space(dsid)) < 0)
return -1;
/* Get the number of elements (= records, for 1-D datasets) */
if ((snpoints = H5Sget_simple_extent_npoints(file_sid)) < 0)
return -1;
/* Emit informational message */
if (verbose)
fprintf(verbose_file, "Symbol = '%s', # of records = %lld\n", sym_name, (long long)snpoints);
/* Check if there are records for symbol */
if (snpoints > 0) {
/* Choose the last record in the dataset */
start[1] = (hsize_t)(snpoints - 1);
if (H5Sselect_hyperslab(file_sid, H5S_SELECT_SET, start, NULL, count, NULL) < 0)
return -1;
/* Read record from dataset */
record->rec_id = (uint64_t)ULLONG_MAX;
if (H5Dread(dsid, symbol_tid, rec_sid, file_sid, H5P_DEFAULT, record) < 0)
return -1;
/* Verify record value */
if (record->rec_id != start[1]) {
struct timeval tv;
HDgettimeofday(&tv, NULL);
if (verbose) {
fprintf(verbose_file, "*** ERROR ***\n");
fprintf(verbose_file, "Incorrect record value!\n");
fprintf(verbose_file,
"Time = %llu.%llu, Symbol = '%s', # of records = %lld, record->rec_id = %llu\n",
(unsigned long long)tv.tv_sec, (unsigned long long)tv.tv_usec, sym_name,
(long long)snpoints, (unsigned long long)record->rec_id);
} /* end if */
return -1;
} /* end if */
} /* end if */
/* Close the dataset's dataspace */
if (H5Sclose(file_sid) < 0)
return -1;
/* Close dataset for symbol */
if (H5Dclose(dsid) < 0)
return -1;
return 0;
} /* end check_dataset() */
/*-------------------------------------------------------------------------
* Function: read_records
*
* Purpose: For a given dataset, checks to make sure that the stated
* and actual sizes are the same. If they are not, then
* we have an inconsistent dataset due to a SWMR error.
*
* The "common" datasets are a random selection from among
* the level 0 datasets. The "random" datasets are a random
* selection from among all the file's datasets. This scheme
* ensures that the level 0 datasets are interrogated vigorously.
*
* Parameters: const char *filename
* The SWMR test file's name.
*
* bool verbose
* Whether verbose console output is desired.
*
* FILE *verbose_file
* File handle for verbose output
*
* unsigned random_seed
* Random seed for the file (used for verbose logging)
*
* unsigned long nseconds
* The amount of time to read records (ns).
*
* unsigned poll_time
* The amount of time to sleep (s).
*
* unsigned ncommon
* The number of common/non-random datasets that will be opened.
*
* unsigned nrandom
* The number of random datasets that will be opened.
*
* Return: Success: 0
* Failure: -1
*
*-------------------------------------------------------------------------
*/
static int
read_records(const char *filename, bool verbose, FILE *verbose_file, unsigned random_seed,
unsigned long nseconds, unsigned poll_time, unsigned ncommon, unsigned nrandom)
{
time_t start_time; /* Starting time */
time_t curr_time; /* Current time */
symbol_info_t **sym_com = NULL; /* Pointers to array of common dataset IDs */
symbol_info_t **sym_rand = NULL; /* Pointers to array of random dataset IDs */
hid_t mem_sid; /* Memory dataspace ID */
hid_t fid; /* SWMR test file ID */
hid_t fapl; /* file access property list */
symbol_t record; /* The record to read from the dataset */
unsigned v; /* Local index variable */
bool use_log_vfd = false; /* Use the log VFD (set this manually) */
assert(filename);
assert(nseconds != 0);
assert(poll_time != 0);
/* Reset the record */
/* (record's 'info' field might need to change for each record read, also) */
memset(&record, 0, sizeof(record));
/* Emit informational message */
if (verbose)
fprintf(verbose_file, "Choosing datasets\n");
/* Allocate space for 'common' datasets, if any */
if (ncommon > 0) {
/* Allocate array to hold pointers to symbols for common datasets */
if (NULL == (sym_com = (symbol_info_t **)malloc(sizeof(symbol_info_t *) * ncommon)))
return -1;
/* Open the common datasets */
for (v = 0; v < ncommon; v++) {
unsigned offset; /* Offset of symbol to use */
/* Determine the offset of the symbol, within level 0 symbols */
/* (level 0 symbols are the most common symbols) */
offset = (unsigned)((unsigned)rand() % symbol_count[0]);
sym_com[v] = &symbol_info[0][offset];
/* Emit informational message */
if (verbose)
fprintf(verbose_file, "Common symbol #%u = '%s'\n", v, symbol_info[0][offset].name);
} /* end for */
} /* end if */
/* Allocate space for 'random' datasets, if any */
if (nrandom > 0) {
/* Allocate array to hold pointers to symbols for random datasets */
if (NULL == (sym_rand = (symbol_info_t **)malloc(sizeof(symbol_info_t *) * nrandom)))
return -1;
/* Determine the random datasets */
for (v = 0; v < nrandom; v++) {
symbol_info_t *sym; /* Symbol to use */
/* Determine the symbol, within all symbols */
if (NULL == (sym = choose_dataset()))
return -1;
sym_rand[v] = sym;
/* Emit informational message */
if (verbose)
fprintf(verbose_file, "Random symbol #%u = '%s'\n", v, sym->name);
} /* end for */
} /* end if */
/* Create a dataspace for the record to read */
if ((mem_sid = H5Screate(H5S_SCALAR)) < 0)
return -1;
/* Emit informational message */
if (verbose)
fprintf(verbose_file, "Reading records\n");
/* Get the starting time */
start_time = time(NULL);
curr_time = start_time;
/* Create file access property list */
if ((fapl = h5_fileaccess()) < 0)
return -1;
/* Log I/O when verbose output it enabled */
if (use_log_vfd) {
char verbose_name[1024];
snprintf(verbose_name, sizeof(verbose_name), "swmr_reader.log.%u", random_seed);
H5Pset_fapl_log(fapl, verbose_name, H5FD_LOG_ALL, (size_t)(512 * 1024 * 1024));
} /* end if */
/* Loop over reading records until [at least] the correct # of seconds have passed */
while (curr_time < (time_t)(start_time + (time_t)nseconds)) {
/* Emit informational message */
if (verbose)
fprintf(verbose_file, "Opening file: %s\n", filename);
/* Open the file */
if ((fid = H5Fopen(filename, H5F_ACC_RDONLY | H5F_ACC_SWMR_READ, fapl)) < 0)
return -1;
/* Check 'common' datasets, if any */
if (ncommon > 0) {
/* Emit informational message */
if (verbose)
fprintf(verbose_file, "Checking common symbols\n");
/* Iterate over common datasets */
for (v = 0; v < ncommon; v++) {
/* Check common dataset */
if (check_dataset(fid, verbose, verbose_file, sym_com[v]->name, &record, mem_sid) < 0)
return -1;
memset(&record, 0, sizeof(record));
} /* end for */
} /* end if */
/* Check 'random' datasets, if any */
if (nrandom > 0) {
/* Emit informational message */
if (verbose)
fprintf(verbose_file, "Checking random symbols\n");
/* Iterate over random datasets */
for (v = 0; v < nrandom; v++) {
/* Check random dataset */
if (check_dataset(fid, verbose, verbose_file, sym_rand[v]->name, &record, mem_sid) < 0)
return -1;
memset(&record, 0, sizeof(record));
} /* end for */
} /* end if */
/* Emit informational message */
if (verbose)
fprintf(verbose_file, "Closing file\n");
/* Close the file */
if (H5Fclose(fid) < 0)
return -1;
/* Sleep for the appropriate # of seconds */
HDsleep(poll_time);
/* Retrieve the current time */
curr_time = time(NULL);
} /* end while */
/* Close the memory dataspace */
if (H5Sclose(mem_sid) < 0)
return -1;
/* Close the fapl */
if (H5Pclose(fapl) < 0)
return -1;
/* Emit informational message */
if (verbose)
fprintf(verbose_file, "Closing datasets\n");
/* Close 'random' datasets, if any */
if (nrandom > 0) {
/* Release array holding dataset ID's for random datasets */
free(sym_rand);
} /* end if */
/* Close 'common' datasets, if any */
if (ncommon > 0) {
/* Release array holding dataset ID's for common datasets */
free(sym_com);
} /* end if */
return 0;
} /* end read_records() */
static void
usage(void)
{
printf("\n");
printf("Usage error!\n");
printf("\n");
printf("Usage: swmr_reader [-q] [-s <# of seconds to sleep between polling>]\n");
printf(" [-h <# of common symbols to poll>] [-l <# of random symbols to poll>]\n");
printf(" [-r <random seed>] <# of seconds to test>\n");
printf("\n");
printf("<# of seconds to test> must be specified.\n");
printf("\n");
printf("Defaults to verbose (no '-q' given), 1 second between polling ('-s 1'),\n");
printf("5 common symbols to poll ('-h 5'), 10 random symbols to poll ('-l 10'),\n");
printf("and will generate a random seed (no -r given).\n");
printf("\n");
exit(EXIT_FAILURE);
}
int
main(int argc, char *argv[])
{
long nseconds = 0; /* # of seconds to test */
int poll_time = 1; /* # of seconds between polling */
int ncommon = 5; /* # of common symbols to poll */
int nrandom = 10; /* # of random symbols to poll */
bool verbose = true; /* Whether to emit some informational messages */
FILE *verbose_file = NULL; /* File handle for verbose output */
bool use_seed = false; /* Set to 1 if a seed was set on the command line */
unsigned random_seed = 0; /* Random # seed */
unsigned u; /* Local index variables */
int temp;
/* Parse command line options */
if (argc < 2)
usage();
if (argc > 1) {
u = 1;
while (u < (unsigned)argc) {
if (argv[u][0] == '-') {
switch (argv[u][1]) {
/* # of common symbols to poll */
case 'h':
ncommon = atoi(argv[u + 1]);
if (ncommon < 0)
usage();
u += 2;
break;
/* # of random symbols to poll */
case 'l':
nrandom = atoi(argv[u + 1]);
if (nrandom < 0)
usage();
u += 2;
break;
/* Be quiet */
case 'q':
verbose = false;
u++;
break;
/* Random # seed */
case 'r':
use_seed = true;
temp = atoi(argv[u + 1]);
if (temp < 0)
usage();
else
random_seed = (unsigned)temp;
u += 2;
break;
/* # of seconds between polling */
case 's':
poll_time = atoi(argv[u + 1]);
if (poll_time < 0)
usage();
u += 2;
break;
default:
usage();
break;
} /* end switch */
} /* end if */
else {
/* Get the number of records to append */
nseconds = atol(argv[u]);
if (nseconds <= 0)
usage();
u++;
} /* end else */
} /* end while */
} /* end if */
if (nseconds <= 0)
usage();
if (poll_time >= nseconds)
usage();
/* Set the random seed */
if (!use_seed) {
struct timeval t;
HDgettimeofday(&t, NULL);
random_seed = (unsigned)(t.tv_usec);
} /* end if */
srand(random_seed);
/* Open output file */
if (verbose) {
char verbose_name[1024];
snprintf(verbose_name, sizeof(verbose_name), "swmr_reader.out.%u", random_seed);
if (NULL == (verbose_file = fopen(verbose_name, "w"))) {
fprintf(stderr, "Can't open verbose output file!\n");
exit(EXIT_FAILURE);
}
} /* end if */
/* Emit informational message */
if (verbose) {
fprintf(verbose_file, "Parameters:\n");
fprintf(verbose_file, "\t# of seconds between polling = %d\n", poll_time);
fprintf(verbose_file, "\t# of common symbols to poll = %d\n", ncommon);
fprintf(verbose_file, "\t# of random symbols to poll = %d\n", nrandom);
fprintf(verbose_file, "\t# of seconds to test = %ld\n", nseconds);
} /* end if */
/* ALWAYS emit the random seed for possible debugging */
fprintf(stdout, "Using reader random seed: %u\n", random_seed);
/* Emit informational message */
if (verbose)
fprintf(verbose_file, "Generating symbol names\n");
/* Generate dataset names */
if (generate_symbols() < 0) {
fprintf(stderr, "Error generating symbol names!\n");
exit(EXIT_FAILURE);
} /* end if */
/* Create datatype for creating datasets */
if ((symbol_tid = create_symbol_datatype()) < 0)
return -1;
/* Reading records from datasets */
if (read_records(FILENAME, verbose, verbose_file, random_seed, (unsigned long)nseconds,
(unsigned)poll_time, (unsigned)ncommon, (unsigned)nrandom) < 0) {
fprintf(stderr, "Error reading records from datasets (random_seed = %u)!\n", random_seed);
exit(EXIT_FAILURE);
} /* end if */
/* Emit informational message */
if (verbose)
fprintf(verbose_file, "Releasing symbols\n");
/* Clean up the symbols */
if (shutdown_symbols() < 0) {
fprintf(stderr, "Error releasing symbols!\n");
exit(EXIT_FAILURE);
} /* end if */
/* Emit informational message */
if (verbose)
fprintf(verbose_file, "Closing objects\n");
/* Close objects created */
if (H5Tclose(symbol_tid) < 0) {
fprintf(stderr, "Error closing symbol datatype!\n");
exit(EXIT_FAILURE);
} /* end if */
return 0;
}
Reference in New Issue View Git Blame Copy Permalink