H5Part.c 88.2 KB
Newer Older
gsell's avatar
gsell committed
1 2 3 4 5 6 7 8 9
/*! \mainpage H5Part: A Portable High Performance Parallel Data Interface to HDF5

Particle based simulations of accelerator beam-lines, especially in
six dimensional phase space, generate vast amounts of data. Even
though a subset of statistical information regarding phase space or
analysis needs to be preserved, reading and writing such enormous
restart files on massively parallel supercomputing systems remains
challenging. 

Kurt Stockinger's avatar
Kurt Stockinger committed
10
H5Part consists of Particles and Block structured Fields.
gsell's avatar
gsell committed
11

Kurt Stockinger's avatar
Kurt Stockinger committed
12
Developed by:
gsell's avatar
gsell committed
13

Kurt Stockinger's avatar
Kurt Stockinger committed
14 15 16 17 18 19 20 21
<UL>
<LI> Andreas Adelmann (PSI) </LI>
<LI> Achim Gsell (PSI) </LI>
<LI> Benedikt Oswald (PSI) </LI>

<LI> Wes Bethel (NERSC/LBNL)</LI>
<LI> John Shalf (NERSC/LBNL)</LI>
<LI> Cristina Siegerist (NERSC/LBNL)</LI>
22
<LI> Mark Howison (NERSC/LBNL)</LI>
Kurt Stockinger's avatar
Kurt Stockinger committed
23
</UL>
gsell's avatar
gsell committed
24 25 26 27


Papers: 

Kurt Stockinger's avatar
Kurt Stockinger committed
28 29 30 31 32 33 34
<UL>
<LI> A. Adelmann, R.D. Ryne, C. Siegerist, J. Shalf,"From Visualization to Data Mining with Large Data Sets," <i>
<a href="http://www.sns.gov/pac05">Particle Accelerator Conference (PAC05)</a></i>, Knoxville TN., May 16-20, 2005. (LBNL-57603)
<a href="http://vis.lbl.gov/Publications/2005/FPAT082.pdf">FPAT082.pdf</a>
</LI>


35
<LI> A. Adelmann, R.D. Ryne, J. Shalf, C. Siegerist, "H5Part: A Portable High Performance Parallel Data Interface for Particle Simulations," <i>
Kurt Stockinger's avatar
Kurt Stockinger committed
36 37 38 39 40 41 42
<a href="http://www.sns.gov/pac05">Particle Accelerator Conference (PAC05)</a></i>, Knoxville TN., May 16-20, 2005.
<a href="http://vis.lbl.gov/Publications/2005/FPAT083.pdf">FPAT083.pdf</a>
</LI>
</UL>

For further information contact: <a href="mailto:h5part@lists.psi.ch">h5part</a>

gsell's avatar
gsell committed
43 44
*/

gsell's avatar
gsell committed
45 46

/*!
gsell's avatar
gsell committed
47
  \defgroup h5part_c_api H5Part C API
gsell's avatar
gsell committed
48 49 50

*/
/*!
gsell's avatar
gsell committed
51
  \ingroup h5part_c_api
52
  \defgroup h5part_open 	File Opening and Closing
gsell's avatar
gsell committed
53 54
*/
/*!
gsell's avatar
gsell committed
55
  \ingroup h5part_c_api
56
  \defgroup h5part_model	Setting up the Data Model
gsell's avatar
gsell committed
57 58
*/  
/*!
gsell's avatar
gsell committed
59
  \ingroup h5part_c_api
60
  \defgroup h5part_data		Readind and Writing Datasets
gsell's avatar
gsell committed
61 62
*/  
/*!
gsell's avatar
gsell committed
63
  \ingroup h5part_c_api
gsell's avatar
gsell committed
64 65 66
  \defgroup h5part_attrib	Reading and Writing Attributes
*/
/*!
gsell's avatar
gsell committed
67
  \ingroup h5part_c_api
gsell's avatar
gsell committed
68 69 70 71 72 73 74 75
  \defgroup h5part_errhandle	Error Handling
*/
/*!
  \internal
  \defgroup h5partkernel H5Part private functions 
*/


gsell's avatar
gsell committed
76 77 78 79 80 81 82 83
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>	/* va_arg - System dependent ?! */
#include <string.h>
#include <errno.h>
#include <fcntl.h>
#include <hdf5.h>

gsell's avatar
gsell committed
84 85 86 87 88 89 90 91
#ifndef WIN32
#include <unistd.h>
#else /* WIN32 */
#include <io.h>
#define open  _open
#define close _close
#endif /* WIN32 */

gsell's avatar
gsell committed
92 93 94 95
#include "H5Part.h"
#include "H5PartPrivate.h"
#include "H5PartErrors.h"

96 97 98
/********* Global Variable Declarations *************/
h5part_error_handler	_err_handler = H5PartReportErrorHandler;

gsell's avatar
gsell committed
99 100
/********* Private Variable Declarations *************/

101
static unsigned			_is_root_proc = 0;
102
static unsigned			_debug = H5PART_VERB_ERROR;
gsell's avatar
gsell committed
103
static h5part_int64_t		_h5part_errno = H5PART_SUCCESS;
104
static char *__funcname;
gsell's avatar
gsell committed
105 106 107 108 109 110 111 112 113

/********** Declaration of private functions ******/

static h5part_int64_t
_init(
	void
	);

static h5part_int64_t
114 115
_reset_view (
	H5PartFile *f
gsell's avatar
gsell committed
116 117
	);

gsell's avatar
gsell committed
118 119 120
/*
  error handler for hdf5
*/
gsell's avatar
gsell committed
121 122
static herr_t
_h5_error_handler (
123
#ifndef H5_USE_16_API
124 125
	hid_t,
#endif
gsell's avatar
gsell committed
126 127 128
	void *
	);

129 130 131 132 133 134 135 136
static void
_vprint (
	FILE* f,
	const char *prefix,
	const char *fmt,
	va_list ap
	);

gsell's avatar
gsell committed
137 138
/*========== File Opening/Closing ===============*/

gsell's avatar
gsell committed
139 140
static H5PartFile*
_H5Part_open_file (
gsell's avatar
gsell committed
141
	const char *filename,	/*!< [in] The name of the data file to open. */
142
	const char flags,	/*!< [in] The access mode for the file. */
gsell's avatar
gsell committed
143
	MPI_Comm comm,		/*!< [in] MPI communicator */
144 145 146 147
	int f_parallel,		/*!< [in] 0 for serial io otherwise parallel */
	h5part_int64_t align	/*!< [in] Number of bytes for setting alignment,
					  metadata block size, etc.
					  Set to 0 to disable. */
gsell's avatar
gsell committed
148
	) {
149

gsell's avatar
gsell committed
150
	_h5part_errno = H5PART_SUCCESS;
gsell's avatar
gsell committed
151 152 153 154 155 156 157 158
	H5PartFile *f = NULL;

	f = (H5PartFile*) malloc( sizeof (H5PartFile) );
	if( f == NULL ) {
		HANDLE_H5PART_NOMEM_ERR;
		goto error_cleanup;
	}
	memset (f, 0, sizeof (H5PartFile));
gsell's avatar
gsell committed
159

160 161
	f->flags = flags;

162 163
	/* set default step name */
	strncpy ( f->groupname_step, H5PART_GROUPNAME_STEP, H5PART_STEPNAME_LEN );
gsell's avatar
gsell committed
164 165
	f->stepno_width = 0;

166
	f->xfer_prop = f->dcreate_prop = f->fcreate_prop = H5P_DEFAULT;
167

168 169
	f->access_prop = H5Pcreate (H5P_FILE_ACCESS);
	if (f->access_prop < 0) {
170 171 172
		HANDLE_H5P_CREATE_ERR;
		goto error_cleanup;
	}
gsell's avatar
gsell committed
173

gsell's avatar
gsell committed
174
	if ( f_parallel ) {
gsell's avatar
gsell committed
175
#ifdef PARALLEL_IO
gsell's avatar
gsell committed
176
		MPI_Info info = MPI_INFO_NULL;
177

gsell's avatar
gsell committed
178 179 180 181 182 183 184 185
		if (MPI_Comm_size (comm, &f->nprocs) != MPI_SUCCESS) {
			HANDLE_MPI_COMM_SIZE_ERR;
			goto error_cleanup;
		}
		if (MPI_Comm_rank (comm, &f->myproc) != MPI_SUCCESS) {
			HANDLE_MPI_COMM_RANK_ERR;
			goto error_cleanup;
		}
gsell's avatar
gsell committed
186

187 188 189
		if ( f-> myproc == 0 ) _is_root_proc = 1;
		else _is_root_proc = 0;

gsell's avatar
gsell committed
190 191
		f->pnparticles =
		  (h5part_int64_t*) malloc (f->nprocs * sizeof (h5part_int64_t));
gsell's avatar
gsell committed
192 193 194 195
		if (f->pnparticles == NULL) {
			HANDLE_H5PART_NOMEM_ERR;
			goto error_cleanup;
		}
gsell's avatar
gsell committed
196

197 198
		/* select the HDF5 VFD */
		if (flags & H5PART_VFD_MPIPOSIX) {
199
			_H5Part_print_info ( "Selecting MPI-POSIX VFD" );
200
			if (H5Pset_fapl_mpiposix ( f->access_prop, comm, 0 ) < 0) {
201 202 203
				HANDLE_H5P_SET_FAPL_ERR;
				goto error_cleanup;
			}
gsell's avatar
gsell committed
204
		}
205
		else {
206
			_H5Part_print_info ( "Selecting MPI-IO VFD" );
207
			if (H5Pset_fapl_mpio ( f->access_prop, comm, info ) < 0) {
208 209 210
				HANDLE_H5P_SET_FAPL_ERR;
				goto error_cleanup;
			}
211
			if (flags & H5PART_VFD_MPIIO_IND) {
212
				_H5Part_print_info ( "Using independent mode" );
213
			} else {
214
				_H5Part_print_info ( "Using collective mode" );
215 216
				f->xfer_prop = H5Pcreate (H5P_DATASET_XFER);
				if (f->xfer_prop < 0) {
217 218 219
					HANDLE_H5P_CREATE_ERR;
					goto error_cleanup;
				}
220
				if (H5Pset_dxpl_mpio ( f->xfer_prop, H5FD_MPIO_COLLECTIVE ) < 0) {
221 222 223
					HANDLE_H5P_SET_DXPL_MPIO_ERR;
					goto error_cleanup;
				}
224
			}
gsell's avatar
gsell committed
225
		}
gsell's avatar
gsell committed
226

227 228
		if ( flags & H5PART_FS_LUSTRE )
		{
229
			/* extend the btree size so that metadata pieces are
230 231 232 233 234 235 236 237 238
			 * close to the alignment value */
			unsigned int btree_ik = (align - 256) / 96;
			unsigned int btree_bytes = 64 + 96*btree_ik;
			if ( btree_bytes > align ) {
				HANDLE_H5PART_INVALID_ERR(
					"btree_ik", btree_ik );
				goto error_cleanup;
			}

239 240 241 242 243 244
			_H5Part_print_info (
				"Setting HDF5 btree parameter to %u",
				btree_ik );
			_H5Part_print_info (
				"Extending HDF5 btree size to %u bytes at rank 3",
				btree_bytes );
245

246 247 248 249 250 251 252
			f->fcreate_prop = H5Pcreate(H5P_FILE_CREATE);
			if ( f->fcreate_prop < 0 ) {
				HANDLE_H5P_CREATE_ERR;
				goto error_cleanup;
			}

			H5Pset_istore_k (f->fcreate_prop, btree_ik);
253

254
#ifdef H5PART_HAVE_HDF5_18
255 256 257
			/* defer metadata cache flushing until file close */
			H5AC_cache_config_t cache_config;
			cache_config.version = H5AC__CURR_CACHE_CONFIG_VERSION;
258
			H5Pget_mdc_config (f->access_prop, &cache_config);
259 260 261 262 263 264
			cache_config.set_initial_size = 1;
			cache_config.initial_size = 16 * 1024 * 1024;
			cache_config.evictions_enabled = 0;
			cache_config.incr_mode = H5C_incr__off;
			cache_config.flash_incr_mode = H5C_flash_incr__off;
			cache_config.decr_mode = H5C_decr__off;
265
			H5Pset_mdc_config (f->access_prop, &cache_config);
266
#else // H5_USE_16_API
267 268
			_H5Part_print_warn (
				"Unable to defer metadata write: need HDF5 1.8");
269
#endif // H5_USE_16_API
270
		}
271

272
		f->comm = comm;
273
#endif // PARALLEL_IO
gsell's avatar
gsell committed
274
	} else {
275
		_is_root_proc = 1;
gsell's avatar
gsell committed
276
		f->comm = 0;
gsell's avatar
gsell committed
277 278
		f->nprocs = 1;
		f->myproc = 0;
gsell's avatar
gsell committed
279 280
		f->pnparticles = 
			(h5part_int64_t*) malloc (f->nprocs * sizeof (h5part_int64_t));
gsell's avatar
gsell committed
281
	}
282 283

	if ( align != 0 ) {
284 285 286
		_H5Part_print_info (
			"Setting HDF5 alignment to %ld bytes",
			align );
287
		if (H5Pset_alignment ( f->access_prop, 0, align ) < 0) {
288 289 290
			HANDLE_H5P_SET_FAPL_ERR;
			goto error_cleanup;
		}
291 292 293
		_H5Part_print_info (
			"Setting HDF5 meta block to %ld bytes",
			align );
294
		if (H5Pset_meta_block_size ( f->access_prop, align ) < 0) {
295 296 297 298 299 300
			HANDLE_H5P_SET_FAPL_ERR;
			goto error_cleanup;
		}
	}

	if ( flags & H5PART_READ ) {
301
		f->file = H5Fopen(filename, H5F_ACC_RDONLY, f->access_prop);
gsell's avatar
gsell committed
302
	}
303
	else if ( flags & H5PART_WRITE ){
304
		f->file = H5Fcreate (filename, H5F_ACC_TRUNC, f->fcreate_prop,
305
				f->access_prop);
gsell's avatar
gsell committed
306
		f->empty = 1;
gsell's avatar
gsell committed
307
	}
308
	else if ( flags & H5PART_APPEND ) {
309
		int fd = open(filename, O_RDONLY, 0);
gsell's avatar
gsell committed
310 311
		if ( (fd == -1) && (errno == ENOENT) ) {
			f->file = H5Fcreate(filename, H5F_ACC_TRUNC,
312
					f->fcreate_prop, f->access_prop);
gsell's avatar
gsell committed
313
			f->empty = 1;
gsell's avatar
gsell committed
314 315 316
		}
		else if (fd != -1) {
			close (fd);
317
			f->file = H5Fopen(
318
				filename, H5F_ACC_RDWR, f->access_prop);
gsell's avatar
gsell committed
319 320 321 322 323
			/*
			  The following function call returns an error,
			  if f->file < 0. But we can safely ignore this.
			*/
			f->timestep = _H5Part_get_num_objects_matching_pattern(
gsell's avatar
gsell committed
324
				f->file, "/", H5G_GROUP, f->groupname_step );
gsell's avatar
gsell committed
325 326 327 328 329 330 331 332 333 334 335 336
			if ( f->timestep < 0 ) goto error_cleanup;
		}
	}
	else {
		HANDLE_H5PART_FILE_ACCESS_TYPE_ERR ( flags );
		goto error_cleanup;
	}

	if (f->file < 0) {
		HANDLE_H5F_OPEN_ERR ( filename, flags );
		goto error_cleanup;
	}
337
	f->nparticles = 0;
gsell's avatar
gsell committed
338
	f->timegroup = -1;
339
	f->shape = H5S_ALL;
gsell's avatar
gsell committed
340 341 342 343
	f->diskshape = H5S_ALL;
	f->memshape = H5S_ALL;
	f->viewstart = -1;
	f->viewend = -1;
344
	f->viewindexed = 0;
345
	f->throttle = 0;
gsell's avatar
gsell committed
346

gsell's avatar
gsell committed
347 348 349 350 351 352
	_H5Part_print_debug (
		"Proc[%d]: Opened file \"%s\" val=%lld",
		f->myproc,
		filename,
		(long long)(size_t)f );

gsell's avatar
gsell committed
353 354 355 356 357 358 359 360 361 362 363 364
	return f;

 error_cleanup:
	if (f != NULL ) {
		if (f->pnparticles != NULL) {
			free (f->pnparticles);
		}
		free (f);
	}
	return NULL;
}

gsell's avatar
gsell committed
365
#ifdef PARALLEL_IO
gsell's avatar
gsell committed
366
/*!
367
  \ingroup h5part_open
gsell's avatar
gsell committed
368

gsell's avatar
gsell committed
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
  Opens file with specified filename. 

  If you open with flag \c H5PART_WRITE, it will truncate any
  file with the specified filename and start writing to it. If 
  you open with \c H5PART_APPEND, then you can append new timesteps.
  If you open with \c H5PART_READ, then it will open the file
  readonly.

  The typical extension for these files is \c .h5.
  
  H5PartFile should be treated as an essentially opaque
  datastructure.  It acts as the file handle, but internally
  it maintains several key state variables associated with 
  the file.

  \return	File handle or \c NULL
 */
H5PartFile*
gsell's avatar
gsell committed
387
H5PartOpenFileParallel (
gsell's avatar
gsell committed
388
	const char *filename,	/*!< [in] The name of the data file to open. */
389
	const char flags,	/*!< [in] The access mode for the file. */
gsell's avatar
gsell committed
390
	MPI_Comm comm		/*!< [in] MPI communicator */
391
	) {
392
	INIT
393 394 395
	SET_FNAME ( "H5PartOpenFileParallel" );

	int f_parallel = 1;	/* parallel i/o */
396
	h5part_int64_t align = 0; /* no alignment tuning */
397 398 399 400 401

	return _H5Part_open_file ( filename, flags, comm, f_parallel, align );
}

/*!
402
  \ingroup h5part_open
403 404 405 406 407 408 409 410 411

  Opens file with specified filename, and also specifices an alignment
  value used for HDF5 tuning parameters.

  \return	File handle or \c NULL
 */
H5PartFile*
H5PartOpenFileParallelAlign (
	const char *filename,	/*!< [in] The name of the data file to open. */
412
	const char flags,	/*!< [in] The access mode for the file. */
413 414 415
	MPI_Comm comm,		/*!< [in] MPI communicator */
	h5part_int64_t align	/*!< [in] Alignment size in bytes. */
	) {
416
	INIT
417
	SET_FNAME ( "H5PartOpenFileParallelAlign" );
418

gsell's avatar
gsell committed
419
	int f_parallel = 1;	/* parallel i/o */
gsell's avatar
gsell committed
420

421
	return _H5Part_open_file ( filename, flags, comm, f_parallel, align );
gsell's avatar
gsell committed
422 423
}
#endif
gsell's avatar
gsell committed
424

gsell's avatar
gsell committed
425
/*!
426
  \ingroup  h5part_open
gsell's avatar
gsell committed
427

gsell's avatar
gsell committed
428
  Opens file with specified filename. 
gsell's avatar
gsell committed
429

gsell's avatar
gsell committed
430 431 432 433 434
  If you open with flag \c H5PART_WRITE, it will truncate any
  file with the specified filename and start writing to it. If 
  you open with \c H5PART_APPEND, then you can append new timesteps.
  If you open with \c H5PART_READ, then it will open the file
  readonly.
gsell's avatar
gsell committed
435

gsell's avatar
gsell committed
436 437 438 439 440 441
  The typical extension for these files is \c .h5.
  
  H5PartFile should be treated as an essentially opaque
  datastructure.  It acts as the file handle, but internally
  it maintains several key state variables associated with 
  the file.
gsell's avatar
gsell committed
442

gsell's avatar
gsell committed
443 444 445 446 447
  \return	File handle or \c NULL
 */
H5PartFile*
H5PartOpenFile (
	const char *filename,	/*!< [in] The name of the data file to open. */
448
	const char flags	/*!< [in] The access mode for the file. */
gsell's avatar
gsell committed
449
	) {
450
	INIT
gsell's avatar
gsell committed
451
	SET_FNAME ( "H5PartOpenFile" );
gsell's avatar
gsell committed
452

gsell's avatar
gsell committed
453 454
	MPI_Comm comm = 0;	/* dummy */
	int f_parallel = 0;	/* serial open */
455
	int align = 0;		/* no tuning parameters */
gsell's avatar
gsell committed
456

457 458 459 460
	return _H5Part_open_file ( filename, flags, comm, f_parallel, align );
}

/*!
461
  \ingroup h5part_open
462 463 464 465 466 467 468 469 470

  Opens file with specified filename, and also specifices an alignment
  value used for HDF5 tuning parameters.

  \return	File handle or \c NULL
 */
H5PartFile*
H5PartOpenFileAlign (
	const char *filename,	/*!< [in] The name of the data file to open. */
471
	const char flags,	/*!< [in] The access mode for the file. */
472 473
	h5part_int64_t align	/*!< [in] Alignment size in bytes. */
) {
474 475
	INIT
	SET_FNAME ( "H5PartOpenFileAlign" );
476 477 478 479 480

	MPI_Comm comm = 0;	/* dummy */
	int f_parallel = 0;	/* serial open */

	return _H5Part_open_file ( filename, flags, comm, f_parallel, align );
gsell's avatar
gsell committed
481 482 483 484 485 486 487
}

/*!
  Checks if a file was successfully opened.

  \return	\c H5PART_SUCCESS or error code
 */
488 489
h5part_int64_t
_H5Part_file_is_valid (
gsell's avatar
gsell committed
490 491 492 493 494 495 496 497 498 499 500
	const H5PartFile *f	/*!< filehandle  to check validity of */
	) {

	if( f == NULL )
		return H5PART_ERR_BADFD;
	else if(f->file > 0)
		return H5PART_SUCCESS;
	else
		return H5PART_ERR_BADFD;
}

501 502 503 504 505 506 507
/*!
  \ingroup h5part_open

  Closes an open file.

  \return	\c H5PART_SUCCESS or error code
*/
gsell's avatar
gsell committed
508
h5part_int64_t
509
H5PartCloseFile (
gsell's avatar
gsell committed
510 511 512
	H5PartFile *f		/*!< [in] filehandle of the file to close */
	) {

513
	SET_FNAME ( "H5PartCloseFile" );
gsell's avatar
gsell committed
514
	herr_t r = 0;
515 516 517
	_h5part_errno = H5PART_SUCCESS;

	CHECK_FILEHANDLE ( f );
gsell's avatar
gsell committed
518 519 520 521 522 523 524

	if ( f->block && f->close_block ) {
		(*f->close_block) ( f );
		f->block = NULL;
		f->close_block = NULL;
	}

525 526 527 528 529 530 531 532
#ifdef PARALLEL_IO
	if ( f->multiblock && f->close_multiblock ) {
		(*f->close_multiblock) ( f );
		f->multiblock = NULL;
		f->close_multiblock = NULL;
	}
#endif

533
	if( f->shape != H5S_ALL ) {
gsell's avatar
gsell committed
534 535 536 537
		r = H5Sclose( f->shape );
		if ( r < 0 ) HANDLE_H5S_CLOSE_ERR;
		f->shape = 0;
	}
gsell's avatar
gsell committed
538
	if( f->timegroup >= 0 ) {
gsell's avatar
gsell committed
539 540
		r = H5Gclose( f->timegroup );
		if ( r < 0 ) HANDLE_H5G_CLOSE_ERR;
gsell's avatar
gsell committed
541
		f->timegroup = -1;
gsell's avatar
gsell committed
542 543 544 545 546 547
	}
	if( f->diskshape != H5S_ALL ) {
		r = H5Sclose( f->diskshape );
		if ( r < 0 ) HANDLE_H5S_CLOSE_ERR;
		f->diskshape = 0;
	}
548 549 550 551 552
	if( f->memshape != H5S_ALL ) {
		r = H5Sclose( f->memshape );
		if ( r < 0 ) HANDLE_H5S_CLOSE_ERR;
		f->memshape = 0;
	}
553 554 555 556
	if( f->xfer_prop != H5P_DEFAULT ) {
		r = H5Pclose( f->xfer_prop );
		if ( r < 0 ) HANDLE_H5P_CLOSE_ERR ( "f->xfer_prop" );
		f->xfer_prop = H5P_DEFAULT;
gsell's avatar
gsell committed
557
	}
558 559 560 561
	if( f->dcreate_prop != H5P_DEFAULT ) {
		r = H5Pclose( f->dcreate_prop );
		if ( r < 0 ) HANDLE_H5P_CLOSE_ERR ( "f->dcreate_prop" );
		f->dcreate_prop = H5P_DEFAULT;
gsell's avatar
gsell committed
562
	}
563 564


gsell's avatar
gsell committed
565 566 567 568 569
	if ( f->file ) {
		r = H5Fclose( f->file );
		if ( r < 0 ) HANDLE_H5F_CLOSE_ERR;
		f->file = 0;
	}
570 571 572 573
	if( f->access_prop != H5P_DEFAULT ) {
		r = H5Pclose( f->access_prop );
		if ( r < 0 ) HANDLE_H5P_CLOSE_ERR ( "f->access_prop" );
		f->access_prop = H5P_DEFAULT;
574 575 576 577 578 579
	}  
	if( f->fcreate_prop != H5P_DEFAULT ) {
		r = H5Pclose( f->fcreate_prop );
		if ( r < 0 ) HANDLE_H5P_CLOSE_ERR ( "f->fcreate_prop" );
		f->fcreate_prop = H5P_DEFAULT;
	}
580 581

	/* free memory from H5PartFile struct */
gsell's avatar
gsell committed
582 583 584 585 586
	if( f->pnparticles ) {
		free( f->pnparticles );
	}
	free( f );

gsell's avatar
gsell committed
587
	return _h5part_errno;
gsell's avatar
gsell committed
588 589
}

590 591 592 593 594 595 596
h5part_int64_t
H5PartFileIsValid (
	H5PartFile *f
	) {
	return _H5Part_file_is_valid(f);
}

gsell's avatar
gsell committed
597
/*============== File Writing Functions ==================== */
gsell's avatar
gsell committed
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
h5part_int64_t
_H5Part_get_step_name(
	H5PartFile *f,
	const h5part_int64_t step,
	char *name
	) {

	/* Work around sprintf bug on older systems */
	if (f->stepno_width == 0 && step == 0) {
		sprintf (
			name,
			"%s#%0*lld",
			f->groupname_step, 1, (long long) step );
	}
	else {
		sprintf (
			name,
			"%s#%0*lld",
			f->groupname_step, f->stepno_width, (long long) step );
	}

	return H5PART_SUCCESS;
}

gsell's avatar
gsell committed
623 624 625 626 627 628
h5part_int64_t
H5PartDefineStepName (
	H5PartFile *f,
	const char *name,
	const h5part_int64_t width
	) {
629 630 631 632 633 634 635 636

	CHECK_FILEHANDLE ( f );

	h5part_int64_t len = H5PART_STEPNAME_LEN - width - 2;
	if ( strlen(name) > len ) {
		_H5Part_print_warn (
			"Step name has been truncated to fit within %d chars.",
			H5PART_STEPNAME_LEN );
gsell's avatar
gsell committed
637
	}
638 639

	strncpy ( f->groupname_step, name, len );
gsell's avatar
gsell committed
640
	f->stepno_width = (int)width;
641 642

	_H5Part_print_debug ( "Step name defined as '%s'", f->groupname_step );
gsell's avatar
gsell committed
643 644 645 646
	
	return H5PART_SUCCESS;
}

647 648 649 650 651
static h5part_int64_t
_set_num_particles (
	H5PartFile *f,				/*!< [in] Handle to open file */
	const h5part_int64_t nparticles,	/*!< [in] Number of particles */
	const h5part_int64_t _stride
gsell's avatar
gsell committed
652 653
	) {

654 655 656 657
	int ret;
	h5part_int64_t herr;

	hsize_t count;
gsell's avatar
gsell committed
658
#ifdef HDF5V160
659
	hssize_t start;
gsell's avatar
gsell committed
660
#else
661
	hsize_t start;
gsell's avatar
gsell committed
662
#endif
663 664
	hsize_t stride;
	hsize_t dmax = H5S_UNLIMITED;
gsell's avatar
gsell committed
665

666
#ifdef PARALLEL_IO
gsell's avatar
gsell committed
667 668 669 670
	hsize_t total;
	register int i;
#endif

671 672 673 674 675 676 677 678 679 680 681 682
	if ( nparticles <= 0 )
		return HANDLE_H5PART_INVALID_ERR ( "nparticles", nparticles );

	/* prevent invalid stride value */	
	if (_stride < 1)
	{
		_H5Part_print_warn (
			"Stride < 1 was specified: changing to 1." );
		stride = 1;
	} else {
		stride = (hsize_t) _stride;
	}
gsell's avatar
gsell committed
683 684 685 686 687 688 689 690

#ifndef PARALLEL_IO
	/*
	  if we are not using parallel-IO, there is enough information
	   to know that we can short circuit this routine.  However,
	   for parallel IO, this is going to cause problems because
	   we don't know if things have changed globally
	*/
691 692 693
	if ( f->nparticles == nparticles && stride == 1 ) {
		_H5Part_print_debug (
			"Serial mode: skipping unnecessary view creation" );
gsell's avatar
gsell committed
694 695 696
		return H5PART_SUCCESS;
	}
#endif
697 698 699 700

	herr = _reset_view ( f );
	if ( herr < 0 ) return herr;

701 702 703 704 705 706
	if ( f->shape != H5S_ALL ) {
		herr = H5Sclose ( f->shape );
		if ( herr < 0 ) return HANDLE_H5S_CLOSE_ERR;
		f->shape = H5S_ALL;
	}

707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
	f->nparticles = (hsize_t) nparticles;

	/* declare local memory datasize with striding */
	count = f->nparticles * stride;
	f->memshape = H5Screate_simple ( 1, &count, &dmax );
	if ( f->memshape < 0 )
		return HANDLE_H5S_CREATE_SIMPLE_ERR ( f->nparticles );

	/* we need a hyperslab selection if there is striding
	 * (otherwise, the default H5S_ALL selection is ok)
	 */
	if ( stride > 1 )
	{
		start = 0;
		count = f->nparticles;
		herr = H5Sselect_hyperslab (
			f->memshape,
			H5S_SELECT_SET,
			&start,
			&stride,
			&count, NULL );
		if ( herr < 0 ) return HANDLE_H5S_SELECT_HYPERSLAB_ERR;
gsell's avatar
gsell committed
729
	}
730

gsell's avatar
gsell committed
731
#ifndef PARALLEL_IO
732 733 734 735 736
	count = f->nparticles;
	f->shape = H5Screate_simple ( 1, &count, NULL );
	if ( f->shape < 0 ) HANDLE_H5S_CREATE_SIMPLE_ERR ( count );
	f->viewstart = 0;
	f->viewend   = nparticles - 1; // view range is *inclusive*
gsell's avatar
gsell committed
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
#else /* PARALLEL_IO */
	/*
	  The Gameplan here is to declare the overall size of the on-disk
	  data structure the same way we do for the serial case.  But
	  then we must have additional "DataSpace" structures to define
	  our in-memory layout of our domain-decomposed portion of the particle
	  list as well as a "selection" of a subset of the on-disk 
	  data layout that will be written in parallel to mutually exclusive
	  regions by all of the processors during a parallel I/O operation.
	  These are f->shape, f->memshape and f->diskshape respectively.
	*/

	/*
	  acquire the number of particles to be written from each MPI process
	*/
752

753
	ret = MPI_Allgather (
gsell's avatar
gsell committed
754 755
		&nparticles, 1, MPI_LONG_LONG,
		f->pnparticles, 1, MPI_LONG_LONG,
756 757 758
		f->comm );
	if ( ret != MPI_SUCCESS) return HANDLE_MPI_ALLGATHER_ERR;

gsell's avatar
gsell committed
759
	if ( f->myproc == 0 ) {
760
		for ( i=0; i<f->nprocs; i++ ) 
761 762 763
			_H5Part_print_debug_detail (
				"[%d] np=%lld",
				i, (long long) f->pnparticles[i] );
gsell's avatar
gsell committed
764 765 766
	}

	/* compute start offsets */
767
	start = 0;
gsell's avatar
gsell committed
768
	for (i=0; i<f->myproc; i++) {
769
		start += f->pnparticles[i];
gsell's avatar
gsell committed
770
	}
771 772
	f->viewstart = start;
	f->viewend   = start + f->nparticles - 1; // view range is *inclusive*
gsell's avatar
gsell committed
773
	
774
	/* compute total nparticles */
gsell's avatar
gsell committed
775 776 777 778 779
	total = 0;
	for (i=0; i < f->nprocs; i++) {
		total += f->pnparticles[i];
	}

780
	/* declare overall datasize */
781
	count = total;
782 783
	f->shape = H5Screate_simple (1, &count, NULL);
	if ( f->shape < 0 ) return HANDLE_H5S_CREATE_SIMPLE_ERR ( count );
gsell's avatar
gsell committed
784 785

	/* declare overall data size  but then will select a subset */
786 787
	f->diskshape = H5Screate_simple (1, &count, NULL);
	if ( f->diskshape < 0 ) return HANDLE_H5S_CREATE_SIMPLE_ERR ( count );
gsell's avatar
gsell committed
788

789 790 791
	count = nparticles;
	stride = 1;
	herr = H5Sselect_hyperslab (
gsell's avatar
gsell committed
792 793
		f->diskshape,
		H5S_SELECT_SET,
794 795 796 797
		&start,
		&stride,
		&count, NULL );
	if ( herr < 0 ) return HANDLE_H5S_SELECT_HYPERSLAB_ERR;
gsell's avatar
gsell committed
798
#endif
799

gsell's avatar
gsell committed
800 801 802
	return H5PART_SUCCESS;
}

803 804 805 806 807 808 809
/*!
  \ingroup h5part_model

  Set the number of particles for the current time-step.
  After you call this subroutine, all subsequent 
  operations will assume this number of particles will be written.

810
  For the parallel library, the \c nparticles value is the number of
811 812 813 814 815 816 817 818 819 820
  particles that the \e individual task will write. You can use
  a different value on different tasks.
  This function uses an \c MPI_Allgather
  call to aggregate each tasks number of particles and determine
  the appropiate offsets. Because of the use of this MPI collective,
  it is advisable to call this function as
  few times as possible when running at large concurrency.

  This function assumes that your particles' data fields are in stored in
  contiguous 1D arrays.
821
  For instance, the fields \e x and \e y for your particles are stored
822 823 824
  in separate arrays \c x[] and \c y[].
  
  If instead you store your particles as tuples, so that the values
825
  are arranged \f$ x_1,y_1,x_2,y_2\f$... than you need to setup striding
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
  (in this case with value 2) using \ref H5PartSetNumParticlesStrided.

  \return	\c H5PART_SUCCESS or error code
 */
h5part_int64_t
H5PartSetNumParticles (
	H5PartFile *f,			/*!< [in] Handle to open file */
	const h5part_int64_t nparticles	/*!< [in] Number of particles */
	) {

	SET_FNAME ( "H5PartSetNumParticles" );
	CHECK_FILEHANDLE( f );

	h5part_int64_t herr;
	h5part_int64_t stride = 1;

	herr = _set_num_particles ( f, nparticles, stride );
	if ( herr < 0 ) return herr;

	return H5PART_SUCCESS;
}

/*!
  \ingroup h5part_model

  Set the number of particles for the current time-step.
  After you call this subroutine, all subsequent 
  operations will assume this number of particles will be written.

855
  For the parallel library, the \c nparticles value is the number of
856 857 858 859 860 861 862 863 864
  particles that the \e individual task will write. You can use
  a different value on different tasks.
  This function uses an \c MPI_Allgather
  call to aggregate each tasks number of particles and determine
  the appropiate offsets. Because of the use of this MPI collective,
  it is advisable to call this function as
  few times as possible when running at large concurrency.

  This function assumes that your particles' data fields are
865 866
  stored tuples. For instance, the fields \e x and \e y of your
  particles are arranged \f$x_1,y_1,x_2,y_2\f$... in a single data
867 868 869 870 871 872 873
  array. In this example, the stride value would be 2.
  
  If you instead have a separate array for each fields,
  such as \c x[] and \c y[],
  use \ref H5PartSetNumParticles.

  \return	\c H5PART_SUCCESS or error code
874
*/
875 876 877 878
h5part_int64_t
H5PartSetNumParticlesStrided (
	H5PartFile *f,				/*!< [in] Handle to open file */
	const h5part_int64_t nparticles,	/*!< [in] Number of particles */
879
	const h5part_int64_t stride		/*!< [in] Stride value (e.g. number of fields in the particle array) */
880 881 882 883 884 885 886 887 888 889 890 891 892
	) {

	SET_FNAME ( "H5PartSetNumParticlesStrided" );
	CHECK_FILEHANDLE( f );

	h5part_int64_t herr;

	herr = _set_num_particles ( f, nparticles, stride );
	if ( herr < 0 ) return herr;

	return H5PART_SUCCESS;
}

893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
/*!
  \ingroup h5part_model

  Define the chunk \c size and enables chunking in the underlying
  HDF5 layer. When combined with the \c align value in the
  \ref H5PartOpenFileAlign or \ref H5PartOpenFileParallelAlign
  function, this causes each group of \c size particles to be
  padded on disk out to the nearest multiple of \c align bytes.

  Note that this policy wastes disk space, but can improve write
  bandwidth on parallel filesystems that are sensitive to alignment
  to stripe boundaries (e.g. lustre).

  \return	\c H5PART_SUCCESS or error code
*/
h5part_int64_t
H5PartSetChunkSize (
	H5PartFile *f,
	const h5part_int64_t size
	) {

	SET_FNAME ( "H5PartSetChunkSize" );
	CHECK_FILEHANDLE( f );

917 918 919
	_H5Part_print_info (
		"Setting chunk size to %lld elements",
		(long long)size );
920 921 922 923 924 925 926 927 928 929 930 931 932 933

	if ( f->dcreate_prop == H5P_DEFAULT ) {
		f->dcreate_prop = H5Pcreate (H5P_DATASET_CREATE);
		if ( f->dcreate_prop < 0 ) return HANDLE_H5P_CREATE_ERR;
	}

	hsize_t hsize = (hsize_t)size;

	herr_t herr = H5Pset_chunk ( f->dcreate_prop, 1, &hsize );
	if ( herr < 0 ) return HANDLE_H5P_SET_CHUNK_ERR;

	return H5PART_SUCCESS;
}

934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
static void
_normalize_dataset_name (
	const char *name,
	char *name2
	) {

	if ( strlen(name) > H5PART_DATANAME_LEN ) {
		strncpy ( name2, name, H5PART_DATANAME_LEN - 1 );
		name2[H5PART_DATANAME_LEN-1] = '\0';
		_H5Part_print_warn (
			"Dataset name '%s' is longer than maximum %d chars. "
			"Truncated to: '%s'",
			name, H5PART_DATANAME_LEN, name2 );
	} else {
		strcpy ( name2, name );
	}
}

gsell's avatar
gsell committed
952 953 954
static h5part_int64_t
_write_data (
	H5PartFile *f,		/*!< IN: Handle to open file */
gsell's avatar
gsell committed
955 956 957
	const char *name,	/*!< IN: Name to associate array with */
	const void *array,	/*!< IN: Array to commit to disk */
	const hid_t type	/*!< IN: Type of data */
gsell's avatar
gsell committed
958
	) {
959

gsell's avatar
gsell committed
960 961 962
	herr_t herr;
	hid_t dataset_id;

963 964 965 966 967
	char name2[H5PART_DATANAME_LEN];
	_normalize_dataset_name ( name, name2 );

	_H5Part_print_debug (
			"Create a dataset[%s] mounted on "
968
			"timestep %lld",
969
			name2, (long long)f->timestep );
gsell's avatar
gsell committed
970

971 972 973 974 975 976 977
	if ( f->shape == H5S_ALL ) {
		_H5Part_print_warn (
			"The view is unset or invalid: please "
			"set the view or specify a number of particles." );
		return HANDLE_H5PART_BAD_VIEW_ERR ( f->viewstart, f->viewend );
	}

978 979
	H5E_BEGIN_TRY
	dataset_id = H5Dopen ( f->timegroup, name2
980
#ifndef H5_USE_16_API
981 982 983 984
		, H5P_DEFAULT
#endif
		);
	H5E_END_TRY
985

986 987 988 989 990
	if ( dataset_id > 0 ) {
		_H5Part_print_warn (
			"Dataset[%s] at timestep %lld "
			"already exists", name2, (long long)f->timestep );
	} else {
991
		dataset_id = H5Dcreate ( 
992 993 994 995
			f->timegroup,
			name2,
			type,
			f->shape,
996
#ifndef H5_USE_16_API
997
			H5P_DEFAULT,
998 999
			f->dcreate_prop,
			H5P_DEFAULT
1000
#else
1001
			f->dcreate_prop
1002
#endif
1003
                );
1004 1005 1006
		if ( dataset_id < 0 )
			return HANDLE_H5D_CREATE_ERR ( name2, f->timestep );
	}
gsell's avatar
gsell committed
1007

1008 1009 1010
#ifdef PARALLEL_IO
	herr = _H5Part_start_throttle ( f );
	if ( herr < 0 ) return herr;
1011
#endif
1012

1013 1014 1015 1016 1017
	herr = H5Dwrite (
		dataset_id,
		type,
		f->memshape,
		f->diskshape,
1018
		f->xfer_prop,
1019 1020
		array );

1021 1022 1023
#ifdef PARALLEL_IO
	herr = _H5Part_end_throttle ( f );
	if ( herr < 0 ) return herr;
1024
#endif
1025

1026
	if ( herr < 0 ) return HANDLE_H5D_WRITE_ERR ( name2, f->timestep );
gsell's avatar
gsell committed
1027 1028 1029 1030

	herr = H5Dclose ( dataset_id );
	if ( herr < 0 ) return HANDLE_H5D_CLOSE_ERR;

gsell's avatar
gsell committed
1031 1032
	f->empty = 0;

gsell's avatar
gsell committed
1033 1034 1035 1036
	return H5PART_SUCCESS;
}

/*!
1037
  \ingroup h5part_data
gsell's avatar
gsell committed
1038

gsell's avatar
gsell committed
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
  Write array of 64 bit floating point data to file.

  After setting the number of particles with \c H5PartSetNumParticles() and
  the current timestep using \c H5PartSetStep(), you can start writing datasets
  into the file. Each dataset has a name associated with it (chosen by the
  user) in order to facilitate later retrieval. The name of the dataset is
  specified in the parameter \c name, which must be a null-terminated string.

  There are no restrictions on naming of datasets, but it is useful to arrive
  at some common naming convention when sharing data with other groups.

  The writing routines also implicitly store the datatype of the array so that
  the array can be reconstructed properly on other systems with incompatible
  type representations.

  All data that is written after setting the timestep is associated with that
  timestep. While the number of particles can change for each timestep, you
  cannot change the number of particles in the middle of a given timestep.

  The data is committed to disk before the routine returns.

  \return	\c H5PART_SUCCESS or error code
 */
h5part_int64_t
H5PartWriteDataFloat64 (
	H5PartFile *f,		/*!< [in] Handle to open file */
gsell's avatar
gsell committed
1065 1066
	const char *name,	/*!< [in] Name to associate array with */
	const h5part_float64_t *array	/*!< [in] Array to commit to disk */
gsell's avatar
gsell committed
1067 1068 1069
	) {

	SET_FNAME ( "H5PartWriteDataFloat64" );
gsell's avatar
gsell committed
1070
	h5part_int64_t herr;
gsell's avatar
gsell committed
1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081

	CHECK_FILEHANDLE ( f );
	CHECK_WRITABLE_MODE( f );
	CHECK_TIMEGROUP( f );

	herr = _write_data ( f, name, (void*)array, H5T_NATIVE_DOUBLE );
	if ( herr < 0 ) return herr;

	return H5PART_SUCCESS;
}

1082
/*!
1083
  \ingroup h5part_data
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127

  Write array of 32 bit floating point data to file.

  After setting the number of particles with \c H5PartSetNumParticles() and
  the current timestep using \c H5PartSetStep(), you can start writing datasets
  into the file. Each dataset has a name associated with it (chosen by the
  user) in order to facilitate later retrieval. The name of the dataset is
  specified in the parameter \c name, which must be a null-terminated string.

  There are no restrictions on naming of datasets, but it is useful to arrive
  at some common naming convention when sharing data with other groups.

  The writing routines also implicitly store the datatype of the array so that
  the array can be reconstructed properly on other systems with incompatible
  type representations.

  All data that is written after setting the timestep is associated with that
  timestep. While the number of particles can change for each timestep, you
  cannot change the number of particles in the middle of a given timestep.

  The data is committed to disk before the routine returns.

  \return	\c H5PART_SUCCESS or error code
 */
h5part_int64_t
H5PartWriteDataFloat32 (
	H5PartFile *f,		/*!< [in] Handle to open file */
	const char *name,	/*!< [in] Name to associate array with */
	const h5part_float32_t *array	/*!< [in] Array to commit to disk */
	) {

	SET_FNAME ( "H5PartWriteDataFloat32" );
	h5part_int64_t herr;

	CHECK_FILEHANDLE ( f );
	CHECK_WRITABLE_MODE( f );
	CHECK_TIMEGROUP( f );

	herr = _write_data ( f, name, (void*)array, H5T_NATIVE_FLOAT );
	if ( herr < 0 ) return herr;

	return H5PART_SUCCESS;
}

gsell's avatar
gsell committed
1128
/*!
1129
  \ingroup h5part_data
gsell's avatar
gsell committed
1130

gsell's avatar
gsell committed
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
  Write array of 64 bit integer data to file.

  After setting the number of particles with \c H5PartSetNumParticles() and
  the current timestep using \c H5PartSetStep(), you can start writing datasets
  into the file. Each dataset has a name associated with it (chosen by the
  user) in order to facilitate later retrieval. The name of the dataset is
  specified in the parameter \c name, which must be a null-terminated string.

  There are no restrictions on naming of datasets, but it is useful to arrive
  at some common naming convention when sharing data with other groups.

  The writing routines also implicitly store the datatype of the array so that
  the array can be reconstructed properly on other systems with incompatible
  type representations.

  All data that is written after setting the timestep is associated with that
  timestep. While the number of particles can change for each timestep, you
  cannot change the number of particles in the middle of a given timestep.

  The data is committed to disk before the routine returns.

  \return	\c H5PART_SUCCESS or error code
 */
h5part_int64_t
H5PartWriteDataInt64 (
	H5PartFile *f,		/*!< [in] Handle to open file */
gsell's avatar
gsell committed
1157 1158
	const char *name,	/*!< [in] Name to associate array with */
	const h5part_int64_t *array	/*!< [in] Array to commit to disk */
gsell's avatar
gsell committed
1159 1160
	) {

1161
	SET_FNAME ( "H5PartWriteDataInt64" );
gsell's avatar
gsell committed
1162

gsell's avatar
gsell committed
1163
	h5part_int64_t herr;
gsell's avatar
gsell committed
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174

	CHECK_FILEHANDLE ( f );
	CHECK_WRITABLE_MODE( f );
	CHECK_TIMEGROUP( f );

	herr = _write_data ( f, name, (void*)array, H5T_NATIVE_INT64 );
	if ( herr < 0 ) return herr;

	return H5PART_SUCCESS;
}

1175
/*!
1176
  \ingroup h5part_data
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221

  Write array of 32 bit integer data to file.

  After setting the number of particles with \c H5PartSetNumParticles() and
  the current timestep using \c H5PartSetStep(), you can start writing datasets
  into the file. Each dataset has a name associated with it (chosen by the
  user) in order to facilitate later retrieval. The name of the dataset is
  specified in the parameter \c name, which must be a null-terminated string.

  There are no restrictions on naming of datasets, but it is useful to arrive
  at some common naming convention when sharing data with other groups.

  The writing routines also implicitly store the datatype of the array so that
  the array can be reconstructed properly on other systems with incompatible
  type representations.

  All data that is written after setting the timestep is associated with that
  timestep. While the number of particles can change for each timestep, you
  cannot change the number of particles in the middle of a given timestep.

  The data is committed to disk before the routine returns.

  \return	\c H5PART_SUCCESS or error code
 */
h5part_int64_t
H5PartWriteDataInt32 (
	H5PartFile *f,		/*!< [in] Handle to open file */
	const char *name,	/*!< [in] Name to associate array with */
	const h5part_int32_t *array	/*!< [in] Array to commit to disk */
	) {

	SET_FNAME ( "H5PartWriteDataInt32" );

	h5part_int64_t herr;

	CHECK_FILEHANDLE ( f );
	CHECK_WRITABLE_MODE( f );
	CHECK_TIMEGROUP( f );

	herr = _write_data ( f, name, (void*)array, H5T_NATIVE_INT32 );
	if ( herr < 0 ) return herr;

	return H5PART_SUCCESS;
}

gsell's avatar
gsell committed
1222 1223 1224
/********************** reading and writing attribute ************************/

/********************** private functions to handle attributes ***************/
gsell's avatar
gsell committed
1225 1226 1227 1228 1229 1230

/*!
  \ingroup h5partkernel
  @{
*/

1231
h5part_int64_t
1232
_H5Part_make_string_type(
1233
	hid_t *stype,
1234 1235
	int size
	) {
1236 1237 1238 1239 1240
	*stype = H5Tcopy ( H5T_C_S1 );
	if ( *stype < 0 ) return HANDLE_H5T_STRING_ERR;
	herr_t herr = H5Tset_size ( *stype, size );
	if ( herr < 0 ) return HANDLE_H5T_STRING_ERR;
	return H5PART_SUCCESS;
1241 1242
}

gsell's avatar
gsell committed
1243 1244 1245
/*!
   Normalize HDF5 type
*/
1246
h5part_int64_t
gsell's avatar
gsell committed
1247 1248 1249
_H5Part_normalize_h5_type (
	hid_t type
	) {
1250

gsell's avatar
gsell committed
1251 1252 1253
	H5T_class_t tclass = H5Tget_class ( type );
	int size = H5Tget_size ( type );

1254
	switch ( tclass ) {
gsell's avatar
gsell committed
1255
	case H5T_INTEGER:
1256 1257 1258 1259 1260 1261 1262
		if ( size==8 ) {
			return H5PART_INT64;
		}
	  	else if ( size==1 ) {
			return H5PART_CHAR;
		}
		break;
gsell's avatar
gsell committed
1263
	case H5T_FLOAT:
1264 1265 1266 1267 1268 1269 1270
		if ( size==8 ) {
			return H5PART_FLOAT64;
		}
		else if ( size==4 ) {
			return H5PART_FLOAT32;
		}
		break;
1271
	case H5T_STRING:
1272
		return H5PART_STRING;
gsell's avatar
gsell committed
1273
	default:
1274
		;/* NOP */
gsell's avatar
gsell committed
1275
	}
1276
	
1277
	return HANDLE_H5PART_TYPE_ERR;
gsell's avatar
gsell committed
1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
}

h5part_int64_t
_H5Part_read_attrib (
	hid_t id,
	const char *attrib_name,
	void *attrib_value
	) {

	herr_t herr;
1288
	h5part_int64_t h5err;
gsell's avatar
gsell committed
1289 1290 1291 1292
	hid_t attrib_id;
	hid_t space_id;
	hid_t type_id;

1293
#ifdef H5PART_HAVE_HDF5_18
1294
	if (! H5Aexists ( id, attrib_name )) {
1295
		_H5Part_print_warn ( "Attribute '%s' does not exist!", attrib_name );
1296 1297 1298
	}
	attrib_id = H5Aopen ( id, attrib_name, H5P_DEFAULT );
#else
gsell's avatar
gsell committed
1299
	attrib_id = H5Aopen_name ( id, attrib_name );
1300
#endif
gsell's avatar
gsell committed
1301 1302
	if ( attrib_id <= 0 ) return HANDLE_H5A_OPEN_NAME_ERR( attrib_name );

1303
	type_id = H5Aget_type ( attrib_id );
1304
	if ( type_id < 0 ) return HANDLE_H5A_GET_TYPE_ERR;
gsell's avatar
gsell committed
1305 1306 1307 1308

	space_id = H5Aget_space ( attrib_id );
	if ( space_id < 0 ) return HANDLE_H5A_GET_SPACE_ERR;

1309
	herr = H5Aread ( attrib_id, type_id, attrib_value );
gsell's avatar
gsell committed
1310 1311 1312 1313 1314
	if ( herr < 0 ) return HANDLE_H5A_READ_ERR;

	herr = H5Sclose ( space_id );
	if ( herr < 0 ) return HANDLE_H5S_CLOSE_ERR;

1315
	herr = H5Tclose ( type_id );
gsell's avatar
gsell committed
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
	if ( herr < 0 ) return HANDLE_H5T_CLOSE_ERR;

	herr = H5Aclose ( attrib_id );
	if ( herr < 0 ) return HANDLE_H5A_CLOSE_ERR;

	return H5PART_SUCCESS;
}

h5part_int64_t
_H5Part_write_attrib (
	hid_t id,
	const char *attrib_name,
	const hid_t attrib_type,
	const void *attrib_value,
	const hsize_t attrib_nelem
	) {

1333
	h5part_int64_t herr;
gsell's avatar
gsell committed
1334 1335
	hid_t space_id;
	hid_t attrib_id;
1336 1337
	hid_t type = attrib_type;

1338 1339 1340 1341 1342
	if ( attrib_type == H5PART_STRING )
	{
		herr = _H5Part_make_string_type ( &type, attrib_nelem );
		if ( herr < 0 ) return herr;

1343 1344 1345 1346 1347
		space_id = H5Screate (H5S_SCALAR);
		if ( space_id < 0 )
			return HANDLE_H5S_CREATE_SCALAR_ERR;
	}
	else {
1348
		space_id = H5Screate_simple ( 1, &attrib_nelem, NULL );
1349 1350 1351
		if ( space_id < 0 )
			return HANDLE_H5S_CREATE_SIMPLE_ERR ( attrib_nelem );
	}
gsell's avatar
gsell committed
1352

1353 1354 1355 1356 1357 1358
	attrib_id = H5Acreate(
		id,
		attrib_name,
		type,
		space_id,
		H5P_DEFAULT
1359
#ifndef H5_USE_16_API
1360
		, H5P_DEFAULT
1361
#endif
1362
		);
1363

gsell's avatar
gsell committed
1364 1365
	if ( attrib_id < 0 ) return HANDLE_H5A_CREATE_ERR ( attrib_name );

1366
	herr = H5Awrite ( attrib_id, type, attrib_value);
gsell's avatar
gsell committed
1367 1368 1369 1370 1371 1372 1373 1374
	if ( herr < 0 ) return HANDLE_H5A_WRITE_ERR ( attrib_name );

	herr = H5Aclose ( attrib_id );
	if ( herr < 0 ) return HANDLE_H5A_CLOSE_ERR;

	herr = H5Sclose ( space_id );
	if ( herr < 0 ) return HANDLE_H5S_CLOSE_ERR;

1375
	if ( attrib_type == H5PART_STRING ) {
1376 1377 1378 1379
		herr = H5Tclose ( type );
		if ( herr < 0 ) return HANDLE_H5T_CLOSE_ERR;
	}

gsell's avatar
gsell committed
1380 1381 1382
	return H5PART_SUCCESS;
}

1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435
h5part_int64_t
_H5Part_write_file_attrib (
	H5PartFile *f,
	const char *name,
	const hid_t type,
	const void *value,
	const hsize_t nelem
	) {

	hid_t group_id = H5Gopen ( f->file, "/"
#ifndef H5_USE_16_API
				  , H5P_DEFAULT
#endif
				  );

	if ( group_id < 0 ) return HANDLE_H5G_OPEN_ERR( "/" );

	h5part_int64_t herr = _H5Part_write_attrib (
		group_id,
		name,
		type,
		value,
		nelem );
	if ( herr < 0 ) return herr;

	herr = H5Gclose ( group_id );
	if ( herr < 0 ) return HANDLE_H5G_CLOSE_ERR;

	return H5PART_SUCCESS;
}

h5part_int64_t
_H5Part_write_step_attrib (
	H5PartFile *f,
	const char *name,
	const hid_t type,
	const void *value,
	const hsize_t nelem
	) {

	CHECK_TIMEGROUP( f );

	h5part_int64_t herr = _H5Part_write_attrib (
		f->timegroup,
		name,
		type,
		value,
		nelem );
	if ( herr < 0 ) return herr;

	return H5PART_SUCCESS;
}

gsell's avatar
gsell committed
1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450
h5part_int64_t
_H5Part_get_attrib_info (
	hid_t id,
	const h5part_int64_t attrib_idx,
	char *attrib_name,
	const h5part_int64_t len_attrib_name,
	h5part_int64_t *attrib_type,
	h5part_int64_t *attrib_nelem
	) {

	herr_t herr;
	hid_t attrib_id;
	hid_t mytype;
	hid_t space_id;

gsell's avatar
gsell committed
1451
	attrib_id = H5Aopen_idx ( id, (unsigned int)attrib_idx );
gsell's avatar
gsell committed
1452 1453 1454
	if ( attrib_id < 0 ) return HANDLE_H5A_OPEN_IDX_ERR ( attrib_idx );

	if ( attrib_nelem ) {
gsell's avatar
gsell committed
1455 1456 1457
		space_id =  H5Aget_space ( attrib_id );
		if ( space_id < 0 ) return HANDLE_H5A_GET_SPACE_ERR;

gsell's avatar
gsell committed
1458 1459 1460
		*attrib_nelem = H5Sget_simple_extent_npoints ( space_id );
		if ( *attrib_nelem < 0 )
			return HANDLE_H5S_GET_SIMPLE_EXTENT_NPOINTS_ERR;
gsell's avatar
gsell committed
1461 1462 1463

		herr = H5Sclose ( space_id );
		if ( herr < 0 ) return HANDLE_H5S_CLOSE_ERR;
gsell's avatar
gsell committed
1464 1465 1466 1467
	}
	if ( attrib_name ) {
		herr = H5Aget_name (
			attrib_id,
gsell's avatar
gsell committed
1468
			(size_t)len_attrib_name,
gsell's avatar
gsell committed
1469 1470 1471 1472
			attrib_name );
		if ( herr < 0 ) return HANDLE_H5A_GET_NAME_ERR;
	}
	if ( attrib_type ) {
gsell's avatar
gsell committed
1473 1474
		mytype = H5Aget_type ( attrib_id );
		if ( mytype < 0 ) return HANDLE_H5A_GET_TYPE_ERR;
gsell's avatar
gsell committed
1475

gsell's avatar
gsell committed