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
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* Copyright by the Board of Trustees of the University of Illinois. *
* 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://support.hdfgroup.org/ftp/HDF5/releases. *
* If you do not have access to either file, you may request a copy from *
* help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*-------------------------------------------------------------------------
*
* Created: vfd_swmr_sparse_writer.c
* (copied and modified from swmr_sparse_writer.c)
*
* Purpose: Writes data to a randomly selected subset of the datasets
* in the VFD_SWMR test file.
*
* This program is intended to run concurrently with the
* vfd_swmr_sparse_reader program.
*
*-------------------------------------------------------------------------
*/
/***********/
/* Headers */
/***********/
#include <err.h>
#include <signal.h>
#include "h5test.h"
#include "vfd_swmr_common.h"
/****************/
/* Local Macros */
/****************/
#ifdef OUT
#define BUSY_WAIT 100000
#endif /* OUT */
/********************/
/* Local Prototypes */
/********************/
static hid_t open_skeleton(const char *filename, unsigned verbose);
static int add_records(hid_t fid, unsigned verbose, unsigned long nrecords,
unsigned long flush_count);
static void usage(void);
/*-------------------------------------------------------------------------
* Function: open_skeleton
*
* Purpose: Opens the SWMR HDF5 file and datasets.
*
* Parameters: const char *filename
* The filename of the SWMR HDF5 file to open
*
* unsigned verbose
* Whether or not to emit verbose console messages
*
* Return: Success: The file ID of the opened SWMR file
* The dataset IDs are stored in a global array
*
* Failure: -1
*
*-------------------------------------------------------------------------
*/
static hid_t
open_skeleton(const char *filename, unsigned verbose)
{
hid_t fid = -1; /* File ID for new HDF5 file */
hid_t fapl = -1; /* File access property list */
hid_t aid = -1; /* Attribute ID */
unsigned seed; /* Seed for random number generator */
unsigned u, v; /* Local index variable */
H5F_vfd_swmr_config_t *config = NULL; /* Configuration for VFD SWMR */
HDassert(filename);
/* Create file access property list */
if((fapl = h5_fileaccess()) < 0)
goto error;
/* Set to use the latest library format */
if(H5Pset_libver_bounds(fapl, H5F_LIBVER_LATEST, H5F_LIBVER_LATEST) < 0)
goto error;
#ifdef QAK
H5Pset_fapl_log(fapl, "append.log", H5FD_LOG_ALL, (size_t)(512 * 1024 * 1024));
#endif /* QAK */
/*
* Set up to open the file with VFD SWMR configured.
*/
/* Enable page buffering */
if(H5Pset_page_buffer_size(fapl, 4096, 0, 0) < 0)
goto error;
/* Allocate memory for the configuration structure */
if((config = (H5F_vfd_swmr_config_t *)HDcalloc(1, sizeof(H5F_vfd_swmr_config_t))) == NULL)
goto error;
config->version = H5F__CURR_VFD_SWMR_CONFIG_VERSION;
config->tick_len = 4;
config->max_lag = 5;
config->writer = TRUE;
config->md_pages_reserved = 128;
HDstrcpy(config->md_file_path, "./my_md_file");
/* Enable VFD SWMR configuration */
if(H5Pset_vfd_swmr_config(fapl, config) < 0)
goto error;
/* Open the file */
if((fid = H5Fopen(filename, H5F_ACC_RDWR, fapl)) < 0)
goto error;
/* Close file access property list */
if(H5Pclose(fapl) < 0)
goto error;
if(config)
HDfree(config);
/* Emit informational message */
if(verbose)
fprintf(stderr, "WRITER: Opening datasets\n");
/* Seed the random number generator with the attribute in the file */
if((aid = H5Aopen(fid, "seed", H5P_DEFAULT)) < 0)
goto error;
if(H5Aread(aid, H5T_NATIVE_UINT, &seed) < 0)
goto error;
if(H5Aclose(aid) < 0)
goto error;
HDsrandom(seed);
/* Open the datasets */
for(u = 0; u < NLEVELS; u++)
for(v = 0; v < symbol_count[u]; v++) {
if((symbol_info[u][v].dsid = H5Dopen2(fid, symbol_info[u][v].name, H5P_DEFAULT)) < 0)
return(-1);
symbol_info[u][v].nrecords = 0;
} /* end for */
return fid;
error:
if(config)
HDfree(config);
H5E_BEGIN_TRY {
for(u = 0; u < NLEVELS; u++)
for(v = 0; v < symbol_count[u]; v++)
H5Dclose(symbol_info[u][v].dsid);
H5Aclose(aid);
H5Pclose(fapl);
H5Fclose(fid);
} H5E_END_TRY;
return -1;
} /* open_skeleton() */
/*-------------------------------------------------------------------------
* Function: add_records
*
* Purpose: Writes a specified number of records to random datasets in
* the SWMR test file.
*
* Parameters: hid_t fid
* The file ID of the SWMR HDF5 file
*
* unsigned verbose
* Whether or not to emit verbose console messages
*
* unsigned long nrecords
* # of records to write to the datasets
*
* unsigned long flush_count
* # of records to write before flushing the file to disk
*
* Return: Success: 0
* Failure: -1
*
*-------------------------------------------------------------------------
*/
static int
add_records(hid_t fid, unsigned verbose, unsigned long nrecords, unsigned long flush_count)
{
hid_t tid = -1; /* Datatype ID for records */
hid_t mem_sid = -1; /* Memory dataspace ID */
hid_t file_sid = -1; /* Dataset's space ID */
hid_t aid = -1; /* Attribute ID */
hsize_t start[2] = {0, 0}; /* Hyperslab selection values */
hsize_t count[2] = {1, 1}; /* Hyperslab selection values */
symbol_t record; /* The record to add to the dataset */
unsigned long rec_to_flush; /* # of records left to write before flush */
#ifdef OUT
volatile int dummy; /* Dummy varialbe for busy sleep */
#endif /* OUT */
hsize_t dim[2] = {1,0}; /* Dataspace dimensions */
unsigned long u, v; /* Local index variables */
HDassert(fid >= 0);
/* Reset the record */
/* (record's 'info' field might need to change for each record written, also) */
HDmemset(&record, 0, sizeof(record));
/* Create a dataspace for the record to add */
if((mem_sid = H5Screate(H5S_SCALAR)) < 0)
goto error;
/* Create datatype for appending records */
if((tid = create_symbol_datatype()) < 0)
goto error;
/* Add records to random datasets, according to frequency distribution */
rec_to_flush = flush_count;
for(u = 0; u < nrecords; u++) {
symbol_info_t *symbol; /* Symbol to write record to */
/* Get a random dataset, according to the symbol distribution */
symbol = choose_dataset(NULL, NULL);
/* If this is the first time the dataset has been opened, extend it and
* add the sequence attribute */
if(symbol->nrecords == 0) {
symbol->nrecords = nrecords / 5;
dim[1] = symbol->nrecords;
if(H5Dset_extent(symbol->dsid, dim) < 0)
goto error;
if((file_sid = H5Screate(H5S_SCALAR)) < 0)
goto error;
if((aid = H5Acreate2(symbol->dsid, "seq", H5T_NATIVE_ULONG, file_sid, H5P_DEFAULT, H5P_DEFAULT)) < 0)
goto error;
if(H5Sclose(file_sid) < 0)
goto error;
} else if ((aid = H5Aopen(symbol->dsid, "seq", H5P_DEFAULT)) < 0)
goto error;
/* Get the coordinate to write */
start[1] = (hsize_t)HDrandom() % symbol->nrecords;
/* Set the record's ID (equal to its position) */
record.rec_id = start[1];
/* Get the dataset's dataspace */
if((file_sid = H5Dget_space(symbol->dsid)) < 0)
goto error;
/* Choose a random record in the dataset */
if(H5Sselect_hyperslab(file_sid, H5S_SELECT_SET, start, NULL, count, NULL) < 0)
goto error;
/* Write record to the dataset */
if(H5Dwrite(symbol->dsid, tid, mem_sid, file_sid, H5P_DEFAULT, &record) < 0)
goto error;
/* Write the sequence number attribute. Since we synchronize the random
* number seed, the readers will always generate the same sequence of
* randomly chosen datasets and offsets. Therefore, and because of the
* flush dependencies on the object header, the reader will be
* guaranteed to see the written data if the sequence attribute is >=u.
*/
if(H5Awrite(aid, H5T_NATIVE_ULONG, &u) < 0)
goto error;
/* Close the attribute */
if(H5Aclose(aid) < 0)
goto error;
/* Close the dataset's dataspace */
if(H5Sclose(file_sid) < 0)
goto error;
/* Check for flushing file */
if(flush_count > 0) {
/* Decrement count of records to write before flushing */
rec_to_flush--;
/* Check for counter being reached */
if(0 == rec_to_flush) {
#ifdef TEMP_OUT
/* Flush contents of file */
if(H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
return -1;
#endif
/* Reset flush counter */
rec_to_flush = flush_count;
} /* end if */
} /* end if */
#ifdef OUT
/* Busy wait, to let readers catch up */
/* If this is removed, also remove the BUSY_WAIT symbol
* at the top of the file.
*/
dummy = 0;
for(v=0; v<BUSY_WAIT; v++)
dummy++;
if((unsigned long)dummy != v)
return -1;
#endif /* OUT */
} /* end for */
/* Close the memory dataspace */
if(H5Sclose(mem_sid) < 0)
goto error;
/* Close the datatype */
if(H5Tclose(tid) < 0)
goto error;
/* Emit informational message */
if(verbose)
fprintf(stderr, "WRITER: Closing datasets\n");
/* Close the datasets */
for(u = 0; u < NLEVELS; u++)
for(v = 0; v < symbol_count[u]; v++)
if(H5Dclose(symbol_info[u][v].dsid) < 0)
goto error;
return 0;
error:
H5E_BEGIN_TRY {
H5Sclose(mem_sid);
H5Sclose(file_sid);
H5Tclose(tid);
H5Aclose(aid);
for(u = 0; u < NLEVELS; u++)
for(v = 0; v < symbol_count[u]; v++)
H5Dclose(symbol_info[u][v].dsid);
} H5E_END_TRY;
return -1;
} /* add_records() */
static void
usage(void)
{
printf("\n");
printf("Usage error!\n");
printf("\n");
printf("Usage: vfd_swmr_sparse_writer [-q] [-f <# of records to write between\n");
printf(" flushing file contents>] <# of records>\n");
printf("\n");
printf("<# of records to write between flushing file contents> should be 0\n");
printf("(for no flushing) or between 1 and (<# of records> - 1)\n");
printf("\n");
printf("Defaults to verbose (no '-q' given) and flushing every 1000 records\n");
printf("('-f 1000')\n");
printf("\n");
HDexit(1);
} /* usage() */
int main(int argc, const char *argv[])
{
sigset_t oldset;
hid_t fid; /* File ID for file opened */
long nrecords = 0; /* # of records to append */
long flush_count = 1000; /* # of records to write between flushing file */
unsigned verbose = 1; /* Whether to emit some informational messages */
unsigned u; /* Local index variable */
block_signals(&oldset);
/* 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 records to write between flushing file */
case 'f':
flush_count = HDatol(argv[u + 1]);
if(flush_count < 0)
usage();
u += 2;
break;
/* Be quiet */
case 'q':
verbose = 0;
u++;
break;
default:
usage();
break;
} /* end switch */
} /* end if */
else {
/* Get the number of records to append */
nrecords = HDatol(argv[u]);
if(nrecords <= 0)
usage();
u++;
} /* end else */
} /* end while */
} /* end if */
if(nrecords <= 0)
usage();
if(flush_count >= nrecords)
usage();
/* Emit informational message */
if(verbose) {
HDfprintf(stderr, "WRITER: Parameters:\n");
HDfprintf(stderr, "\t# of records between flushes = %ld\n", flush_count);
HDfprintf(stderr, "\t# of records to write = %ld\n", nrecords);
} /* end if */
/* Emit informational message */
if(verbose)
HDfprintf(stderr, "WRITER: Generating symbol names\n");
/* Generate dataset names */
if(generate_symbols() < 0)
return -1;
/* Emit informational message */
if(verbose)
HDfprintf(stderr, "WRITER: Opening skeleton file: %s\n", FILENAME);
/* Open file skeleton */
if((fid = open_skeleton(FILENAME, verbose)) < 0) {
HDfprintf(stderr, "WRITER: Error opening skeleton file!\n");
HDexit(1);
} /* end if */
/* Send a message to indicate "H5Fopen" is complete--releasing the file lock */
h5_send_message(WRITER_MESSAGE, NULL, NULL);
/* Emit informational message */
if(verbose)
HDfprintf(stderr, "WRITER: Adding records\n");
/* Append records to datasets */
if(add_records(fid, verbose, (unsigned long)nrecords, (unsigned long)flush_count) < 0) {
HDfprintf(stderr, "WRITER: Error appending records to datasets!\n");
HDexit(1);
} /* end if */
/* Emit informational message */
if(verbose)
HDfprintf(stderr, "WRITER: Releasing symbols\n");
/* Clean up the symbols */
if(shutdown_symbols() < 0) {
HDfprintf(stderr, "WRITER: Error releasing symbols!\n");
HDexit(1);
} /* end if */
await_signal(fid);
restore_signals(&oldset);
/* Emit informational message */
if(verbose)
HDfprintf(stderr, "WRITER: Closing objects/file\n");
/* Close objects opened */
if(H5Fclose(fid) < 0) {
HDfprintf(stderr, "WRITER: Error closing file!\n");
HDexit(1);
} /* end if */
return 0;
} /* main() */
|