Last-Modified: Sun, 10 Nov 2024 08:09:55 GMT Expires: Wed, 08 Nov 2034 08:09:55 GMT hdf5.git - Mirror from: https://github.com/HDFGroup/hdf5.git
summaryrefslogtreecommitdiffstats
path: root/perform/overhead.c
blob: 5076103883e8bcaddf64803049b899b7b078c5ac (plain)
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
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * 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 files COPYING and Copyright.html.  COPYING can be found at the root   *
 * of the source code distribution tree; Copyright.html can be found at the  *
 * root level of an installed copy of the electronic HDF5 document set and   *
 * is linked from the top-level documents page.  It can also be found at     *
 * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
 * access to either file, you may request a copy from help@hdfgroup.org.     *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*
 * Programmer:  Robb Matzke <matzke@llnl.gov>
 *              Monday, September 28, 1998
 *
 * Purpose:	Creates a chunked dataset and measures the storage overhead.
 */

/* See H5private.h for how to include headers */
#undef NDEBUG
#include "hdf5.h"
#include "H5private.h"

#ifdef H5_STDC_HEADERS
#   include <ctype.h>
#   include <fcntl.h>
#   include <stdlib.h>
#   include <sys/stat.h>
#   include <string.h>
#endif

#ifdef H5_HAVE_IO_H
#   include <io.h>
#endif

#ifdef H5_HAVE_UNISTD_H
#   include <sys/types.h>
#   include <unistd.h>
#endif

#ifdef H5_HAVE_IO_H
#   include <io.h>
#endif

#ifndef H5_HAVE_ATTRIBUTE
#   undef __attribute__
#   define __attribute__(X) /*void*/
#   define UNUSED /*void*/
#else
#   define UNUSED __attribute__((unused))
#endif

#define FILE_NAME_1	"overhead.h5"
#ifndef FALSE
#define FALSE		0
#endif /* FALSE */
#ifndef TRUE
#define TRUE		1
#endif /* TRUE */

typedef enum fill_t {
    FILL_ALL,
    FILL_FORWARD,
    FILL_REVERSE,
    FILL_INWARD,
    FILL_OUTWARD,
    FILL_RANDOM
} fill_t;


/*-------------------------------------------------------------------------
 * Function:	usage
 *
 * Purpose:	Prints a usage message and exits.
 *
 * Return:	never returns
 *
 * Programmer:	Robb Matzke
 *              Wednesday, September 30, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static void
usage(const char *prog)
{
    fprintf(stderr, "usage: %s [STYLE|cache] [LEFT [MIDDLE [RIGHT]]]\n",
	    prog);
    fprintf(stderr, "\
    STYLE is the order that the dataset is filled and should be one of:\n\
        forward   --  Fill the dataset from lowest address to highest\n\
                      address. This style tests the right split ratio.\n\
        reverse   --  Fill the dataset from highest address to lowest\n\
                      address.  This is the reverse order of `forward' and\n\
                      tests the left split ratio.\n\
        inward    --  Fill beginning at both the lowest and highest\n\
                      addresses and work in toward the center of the\n\
                      dataset.  This tests the middle split ratio.\n\
        outward   --  Start at the center of the dataset and work outward\n\
                      toward the lowest and highest addresses.  This tests\n\
                      both left and right split ratios.\n\
        random    --  Write the chunks of the dataset in random order.  This\n\
                      tests all split ratios.\n\
    If no fill style is specified then all fill styles are tried and a\n\
    single value is printed for each one.\n\
\n\
    If the word `cache' is used instead of a fill style then the raw data\n\
    cache is enabled.  It is not possible to enable the raw data cache when\n\
    a specific fill style is used because H5Fflush() is called after each\n\
    chunk is written in order to calculate overhead during the test.  If\n\
    the cache is enabled then chunks are written to disk in different orders\n\
    than the actual H5Dwrite() calls in the test due to collisions and the\n\
    resulting B-tree will be split differently.\n\
\n\
    LEFT, MIDDLE, and RIGHT are the ratios to use for splitting and should\n\
    be values between zero and one, inclusive.\n");
    exit(1);
}


/*-------------------------------------------------------------------------
 * Function:	cleanup
 *
 * Purpose:	Removes test files
 *
 * Return:	void
 *
 * Programmer:	Robb Matzke
 *              Thursday, June  4, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static void
cleanup (void)
{
    if (!getenv ("HDF5_NOCLEANUP")) {
	remove (FILE_NAME_1);
    }
}


/*-------------------------------------------------------------------------
 * Function:	display_error_cb
 *
 * Purpose:	Displays the error stack after printing "*FAILED*".
 *
 * Return:	Success:	0
 *
 *		Failure:	-1
 *
 * Programmer:	Robb Matzke
 *		Wednesday, March  4, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static herr_t
display_error_cb (hid_t estack, void UNUSED *client_data)
{
    puts ("*FAILED*");
    H5Eprint2(estack, stdout);

    return 0;
}


/*-------------------------------------------------------------------------
 * Function:	test
 *
 * Purpose:	The guts of the test
 *
 * Return:	Success:	0
 *
 *		Failure:	number of errors
 *
 * Programmer:	Robb Matzke
 *              Wednesday, September 30, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static int
test(fill_t fill_style, const double splits[],
     hbool_t verbose, hbool_t use_rdcc)
{
    hid_t	file = (-1), fapl = (-1), dcpl = (-1), xfer = (-1), mspace = (-1), fspace = (-1), dset = (-1);
    hsize_t	ch_size[1] = {1};		/*chunk size		*/
    hsize_t	cur_size[1] = {1000};		/*current dataset size	*/
    hsize_t	max_size[1] = {H5S_UNLIMITED};	/*maximum dataset size	*/
    hsize_t	hs_start[1];			/*hyperslab start offset*/
    hsize_t	hs_count[1] = {1};		/*hyperslab nelmts	*/
    int		fd = (-1);			/*h5 file direct	*/
    static int	*had = NULL;			/*for random filling	*/
    const char	*sname=NULL;			/*fill style nam	*/
    int		mdc_nelmts;			/*num meta objs to cache*/
    hsize_t	i;
    int		j;
    h5_stat_t	sb;

    if(!had) had = calloc((size_t)cur_size[0], sizeof(int));
    if((fapl = H5Pcreate(H5P_FILE_ACCESS)) < 0) goto error;
    if(!use_rdcc) {
	if(H5Pget_cache(fapl, &mdc_nelmts, NULL, NULL, NULL) < 0) goto error;
	if(H5Pset_cache(fapl, mdc_nelmts, 0, 0, 0.0) < 0) goto error;
    }
    if((file = H5Fcreate(FILE_NAME_1, H5F_ACC_TRUNC, H5P_DEFAULT, fapl)) < 0) goto error;
    if((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0) goto error;
    if(H5Pset_chunk(dcpl, 1, ch_size) < 0) goto error;
    if((xfer = H5Pcreate(H5P_DATASET_XFER)) < 0) goto error;
    if(H5Pset_btree_ratios(xfer, splits[0], splits[1], splits[2]) < 0) goto error;
    if((fspace = H5Screate_simple(1, cur_size, max_size)) < 0) goto error;
    if((mspace = H5Screate_simple(1, ch_size, ch_size)) < 0) goto error;
    if((dset = H5Dcreate2(file, "chunked", H5T_NATIVE_INT,
			fspace, H5P_DEFAULT, dcpl, H5P_DEFAULT)) < 0) goto error;

#if !defined( __MWERKS__)

 /*
  workaround for a bug in the Metrowerks version 6.0 open function
  */
    if ((fd=HDopen(FILE_NAME_1, O_RDONLY, 0666)) < 0) goto error;
#endif

    for (i=1; i<=cur_size[0]; i++) {

	/* Decide which chunk to write to */
	switch (fill_style) {
	case FILL_FORWARD:
	    hs_start[0] = i-1;
	    break;
	case FILL_REVERSE:
	    hs_start[0] = cur_size[0]-i;
	    break;
	case FILL_INWARD:
	    hs_start[0] = i%2 ? i/2 : cur_size[0]-i/2;
	    break;
	case FILL_OUTWARD:
	    j = (int)(cur_size[0]-i)+1;
	    hs_start[0] = j%2 ? j/2 : (hssize_t)cur_size[0]-j/2;
	    break;
	case FILL_RANDOM:
	    for (j=HDrand()%(int)cur_size[0]; had[j]; j=(j+1)%(int)cur_size[0]) /*void*/;
	    hs_start[0] = j;
	    had[j] = 1;
	    break;
	case FILL_ALL:
	    abort();
	}

	/* Write the chunk */
	if (H5Sselect_hyperslab(fspace, H5S_SELECT_SET, hs_start, NULL,
				hs_count, NULL) < 0) goto error;
	if (H5Dwrite(dset, H5T_NATIVE_INT, mspace, fspace, xfer, &i) < 0) {
	    goto error;
	}


#if !defined( __MWERKS__)

	/* Determine overhead */
	if (verbose) {
	    if (H5Fflush(file, H5F_SCOPE_LOCAL) < 0) goto error;
	    if (HDfstat(fd, &sb) < 0) goto error;
	    /*
	     * The extra cast in the following statement is a bug workaround
	     * for the Win32 version 5.0 compiler.
	     * 1998-11-06 ptl
	     */
	    printf("%4lu %8.3f ***\n",
		   (unsigned long)i,
		   (double)(hssize_t)(sb.st_size-i*sizeof(int))/(hssize_t)i);
	}
#endif


    }

    H5Dclose(dset);
    H5Sclose(mspace);
    H5Sclose(fspace);
    H5Pclose(dcpl);
    H5Pclose(xfer);
    H5Fclose(file);

    if (!verbose) {
	switch (fill_style) {
	case FILL_FORWARD:
	    sname = "forward";
	    break;
	case FILL_REVERSE:
	    sname = "reverse";
	    break;
	case FILL_INWARD:
	    sname = "inward";
	    break;
	case FILL_OUTWARD:
	    sname = "outward";
	    break;
	case FILL_RANDOM:
	    sname = "random";
	    break;
	case FILL_ALL:
	    abort();
	}

#if !defined( __MWERKS__)

	if (HDfstat(fd, &sb) < 0) goto error;
		printf("%-7s %8.3f\n", sname,
	       (double)(hssize_t)(sb.st_size-cur_size[0]*sizeof(int))/
	           (hssize_t)cur_size[0]);
#endif

    }


#if !defined( __MWERKS__)
    HDclose(fd);
#endif

    return 0;

 error:
    H5Dclose(dset);
    H5Sclose(mspace);
    H5Sclose(fspace);
    H5Pclose(dcpl);
    H5Pclose(xfer);
    H5Fclose(file);
    free(had);
    HDclose(fd);
    return 1;
}


/*-------------------------------------------------------------------------
 * Function:	main
 *
 * Purpose:
 *
 * Return:	Success:        zero
 *
 *		Failure:	non-zero
 *
 * Programmer:	Robb Matzke
 *              Monday, September 28, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
int
main(int argc, char *argv[])
{
    hid_t	xfer;
    fill_t	fill_style = FILL_ALL;
    hbool_t	use_cache = FALSE;
    double	splits[3];
    int		i, j, nerrors=0;

    /* Default split ratios */
    H5Eset_auto2(H5E_DEFAULT, display_error_cb, NULL);

    if((xfer = H5Pcreate(H5P_DATASET_XFER)) < 0) goto error;
    if(H5Pget_btree_ratios(xfer, splits+0, splits+1, splits+2) < 0) goto error;
    if(H5Pclose(xfer) < 0) goto error;

    /* Parse command-line options */
    for(i = 1, j = 0; i < argc; i++) {
	if (!strcmp(argv[i], "forward")) {
	    fill_style = FILL_FORWARD;
	} else if (!strcmp(argv[i], "reverse")) {
	    fill_style = FILL_REVERSE;
	} else if (!strcmp(argv[i], "inward")) {
	    fill_style = FILL_INWARD;
	} else if (!strcmp(argv[i], "outward")) {
	    fill_style = FILL_OUTWARD;
	} else if (!strcmp(argv[i], "random")) {
	    fill_style = FILL_RANDOM;
	} else if (!strcmp(argv[i], "cache")) {
	    use_cache = TRUE;
	} else if (j<3 && (isdigit(argv[i][0]) || '.'==argv[i][0])) {
	    splits[j++] = strtod(argv[i], NULL);
	} else {
	    usage(argv[0]);
	}
    }

    if (FILL_ALL==fill_style) {
	printf("%-7s %8s\n", "Style", "Bytes/Chunk");
	printf("%-7s %8s\n", "-----", "-----------");
	nerrors += test(FILL_FORWARD, splits, FALSE, use_cache);
	nerrors += test(FILL_REVERSE, splits, FALSE, use_cache);
	nerrors += test(FILL_INWARD,  splits, FALSE, use_cache);
	nerrors += test(FILL_OUTWARD, splits, FALSE, use_cache);
	nerrors += test(FILL_RANDOM,  splits, FALSE, use_cache);
    } else {
	if (use_cache) usage(argv[0]);
	nerrors += test(fill_style,   splits, TRUE, FALSE);
    }
    if (nerrors>0) goto error;
    cleanup();
    return 0;

 error:
    fprintf(stderr, "*** ERRORS DETECTED ***\n");
    return 1;
}