H5Part.c 89.8 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
		/* optional lustre optimizations */
198 199
		if ( flags & H5PART_FS_LUSTRE )
		{
200
			/* extend the btree size so that metadata pieces are
Marc Howison's avatar
Marc Howison committed
201
		 	* close to the alignment value */
202
			if ( align > 16384 )
Marc Howison's avatar
Marc Howison committed
203 204 205 206 207 208 209 210
			{
				unsigned int btree_ik = (align - 4096) / 96;
				unsigned int btree_bytes = 64 + 96*btree_ik;
				if ( btree_bytes > align ) {
					HANDLE_H5PART_INVALID_ERR(
						"btree_ik", btree_ik );
					goto error_cleanup;
				}
211

Marc Howison's avatar
Marc Howison committed
212 213 214 215 216 217
				_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 );
218

Marc Howison's avatar
Marc Howison committed
219 220 221 222 223
				f->fcreate_prop = H5Pcreate(H5P_FILE_CREATE);
				if ( f->fcreate_prop < 0 ) {
					HANDLE_H5P_CREATE_ERR;
					goto error_cleanup;
				}
224

Marc Howison's avatar
Marc Howison committed
225 226
				H5Pset_istore_k (f->fcreate_prop, btree_ik);
			}
227

228
#ifdef H5PART_HAVE_HDF5_18
229 230 231
			/* defer metadata cache flushing until file close */
			H5AC_cache_config_t cache_config;
			cache_config.version = H5AC__CURR_CACHE_CONFIG_VERSION;
232
			H5Pget_mdc_config (f->access_prop, &cache_config);
233 234 235 236 237 238
			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;
239
			H5Pset_mdc_config (f->access_prop, &cache_config);
240
#else // H5_USE_16_API
241 242
			_H5Part_print_warn (
				"Unable to defer metadata write: need HDF5 1.8");
243
#endif // H5_USE_16_API
244
		}
245

Marc Howison's avatar
Marc Howison committed
246 247 248 249 250 251 252
		/* select the HDF5 VFD */
		if (flags & H5PART_VFD_MPIPOSIX) {
			_H5Part_print_info ( "Selecting MPI-POSIX VFD" );
			if (H5Pset_fapl_mpiposix ( f->access_prop, comm, 0 ) < 0) {
				HANDLE_H5P_SET_FAPL_ERR;
				goto error_cleanup;
			}
253 254
		} else if (flags & H5PART_VFD_CORE) {
			_H5Part_print_info ( "Selecting CORE VFD" );
255
			if (H5Pset_fapl_core ( f->access_prop, align, 1 ) < 0) {
256 257 258 259
				HANDLE_H5P_SET_FAPL_ERR;
				goto error_cleanup;
			}
		} else {
Marc Howison's avatar
Marc Howison committed
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
			_H5Part_print_info ( "Selecting MPI-IO VFD" );
			if (H5Pset_fapl_mpio ( f->access_prop, comm, info ) < 0) {
				HANDLE_H5P_SET_FAPL_ERR;
				goto error_cleanup;
			}
			if (flags & H5PART_VFD_MPIIO_IND) {
				_H5Part_print_info ( "Using independent mode" );
			} else {
				_H5Part_print_info ( "Using collective mode" );
				f->xfer_prop = H5Pcreate (H5P_DATASET_XFER);
				if (f->xfer_prop < 0) {
					HANDLE_H5P_CREATE_ERR;
					goto error_cleanup;
				}
				if (H5Pset_dxpl_mpio ( f->xfer_prop, H5FD_MPIO_COLLECTIVE ) < 0) {
					HANDLE_H5P_SET_DXPL_MPIO_ERR;
					goto error_cleanup;
				}
			}
		}

281
		f->comm = comm;
282
#endif // PARALLEL_IO
gsell's avatar
gsell committed
283
	} else {
284
		_is_root_proc = 1;
gsell's avatar
gsell committed
285
		f->comm = 0;
gsell's avatar
gsell committed
286 287
		f->nprocs = 1;
		f->myproc = 0;
gsell's avatar
gsell committed
288 289
		f->pnparticles = 
			(h5part_int64_t*) malloc (f->nprocs * sizeof (h5part_int64_t));
gsell's avatar
gsell committed
290
	}
291 292

	if ( align != 0 ) {
293 294 295
		_H5Part_print_info (
			"Setting HDF5 alignment to %ld bytes",
			align );
296
		if (H5Pset_alignment ( f->access_prop, 0, align ) < 0) {
297 298 299
			HANDLE_H5P_SET_FAPL_ERR;
			goto error_cleanup;
		}
300 301 302
		_H5Part_print_info (
			"Setting HDF5 meta block to %ld bytes",
			align );
303
		if (H5Pset_meta_block_size ( f->access_prop, align ) < 0) {
304 305 306 307 308 309
			HANDLE_H5P_SET_FAPL_ERR;
			goto error_cleanup;
		}
	}

	if ( flags & H5PART_READ ) {
310
		f->file = H5Fopen(filename, H5F_ACC_RDONLY, f->access_prop);
gsell's avatar
gsell committed
311
	}
312
	else if ( flags & H5PART_WRITE ){
313
		f->file = H5Fcreate (filename, H5F_ACC_TRUNC, f->fcreate_prop,
314
				f->access_prop);
gsell's avatar
gsell committed
315
		f->empty = 1;
gsell's avatar
gsell committed
316
	}
317
	else if ( flags & H5PART_APPEND ) {
318
		int fd = open(filename, O_RDONLY, 0);
gsell's avatar
gsell committed
319 320
		if ( (fd == -1) && (errno == ENOENT) ) {
			f->file = H5Fcreate(filename, H5F_ACC_TRUNC,
321
					f->fcreate_prop, f->access_prop);
gsell's avatar
gsell committed
322
			f->empty = 1;
gsell's avatar
gsell committed
323 324 325
		}
		else if (fd != -1) {
			close (fd);
326
			f->file = H5Fopen(
327
				filename, H5F_ACC_RDWR, f->access_prop);
gsell's avatar
gsell committed
328 329 330 331 332
			/*
			  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
333
				f->file, "/", H5G_GROUP, f->groupname_step );
gsell's avatar
gsell committed
334 335 336 337 338 339 340 341 342 343 344 345
			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;
	}
346
	f->nparticles = 0;
gsell's avatar
gsell committed
347
	f->timegroup = -1;
348
	f->shape = H5S_ALL;
gsell's avatar
gsell committed
349 350 351 352
	f->diskshape = H5S_ALL;
	f->memshape = H5S_ALL;
	f->viewstart = -1;
	f->viewend = -1;
353
	f->viewindexed = 0;
354
	f->throttle = 0;
gsell's avatar
gsell committed
355

gsell's avatar
gsell committed
356 357 358 359 360 361
	_H5Part_print_debug (
		"Proc[%d]: Opened file \"%s\" val=%lld",
		f->myproc,
		filename,
		(long long)(size_t)f );

gsell's avatar
gsell committed
362 363 364 365 366 367 368 369 370 371 372 373
	return f;

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

gsell's avatar
gsell committed
374
#ifdef PARALLEL_IO
gsell's avatar
gsell committed
375
/*!
376
  \ingroup h5part_open
gsell's avatar
gsell committed
377

gsell's avatar
gsell committed
378 379
  Opens file with specified filename. 

380 381
  Flags are bit values that can be combined with the bit operator \c |
  and include:
gsell's avatar
gsell committed
382

383 384 385 386 387 388 389 390
  - \c H5PART_WRITE - truncate file and open for writing
  - \c H5PART_APPEND - open file for writing without truncating
  - \c H5PART_READ - open file read-only
  - \c H5PART_FS_LUSTRE - enable optimizations for the Lustre file system
  - \c H5PART_VFD_MPIPOSIX - use the HDF5 MPI-POSIX virtual file driver
  - \c H5PART_VFD_MPIO_IND - use MPI-IO in indepedent mode

  The typical file extension is \c .h5.
gsell's avatar
gsell committed
391 392 393 394 395 396 397 398 399
  
  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
400
H5PartOpenFileParallel (
gsell's avatar
gsell committed
401
	const char *filename,	/*!< [in] The name of the data file to open. */
402
	const char flags,	/*!< [in] The access mode for the file. */
gsell's avatar
gsell committed
403
	MPI_Comm comm		/*!< [in] MPI communicator */
404
	) {
405
	INIT
406 407 408
	SET_FNAME ( "H5PartOpenFileParallel" );

	int f_parallel = 1;	/* parallel i/o */
409
	h5part_int64_t align = 0; /* no alignment tuning */
410 411 412 413 414

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

/*!
415
  \ingroup h5part_open
416 417 418 419

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

420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
  Flags are bit values that can be combined with the bit operator \c |
  and include:

  - \c H5PART_WRITE - truncate file and open for writing
  - \c H5PART_APPEND - open file for writing without truncating
  - \c H5PART_READ - open file read-only
  - \c H5PART_FS_LUSTRE - enable optimizations for the Lustre file system
  - \c H5PART_VFD_MPIPOSIX - use the HDF5 MPI-POSIX virtual file driver
  - \c H5PART_VFD_MPIO_IND - use MPI-IO in indepedent mode

  The typical file extension 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.

437 438 439 440 441
  \return	File handle or \c NULL
 */
H5PartFile*
H5PartOpenFileParallelAlign (
	const char *filename,	/*!< [in] The name of the data file to open. */
442
	const char flags,	/*!< [in] The access mode for the file. */
443 444 445
	MPI_Comm comm,		/*!< [in] MPI communicator */
	h5part_int64_t align	/*!< [in] Alignment size in bytes. */
	) {
446
	INIT
447
	SET_FNAME ( "H5PartOpenFileParallelAlign" );
448

gsell's avatar
gsell committed
449
	int f_parallel = 1;	/* parallel i/o */
gsell's avatar
gsell committed
450

451
	return _H5Part_open_file ( filename, flags, comm, f_parallel, align );
gsell's avatar
gsell committed
452 453
}
#endif
gsell's avatar
gsell committed
454

gsell's avatar
gsell committed
455
/*!
456
  \ingroup  h5part_open
gsell's avatar
gsell committed
457

gsell's avatar
gsell committed
458
  Opens file with specified filename. 
gsell's avatar
gsell committed
459

460 461 462 463 464 465
  Flags are bit values that can be combined with the bit operator \c |
  and include:

  - \c H5PART_WRITE - truncate file and open for writing
  - \c H5PART_APPEND - open file for writing without truncating
  - \c H5PART_READ - open file read-only
gsell's avatar
gsell committed
466

467
  The typical file extension is \c .h5.
gsell's avatar
gsell committed
468 469 470 471 472
  
  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
473

gsell's avatar
gsell committed
474 475 476 477 478
  \return	File handle or \c NULL
 */
H5PartFile*
H5PartOpenFile (
	const char *filename,	/*!< [in] The name of the data file to open. */
479
	const char flags	/*!< [in] The access mode for the file. */
gsell's avatar
gsell committed
480
	) {
481
	INIT
gsell's avatar
gsell committed
482
	SET_FNAME ( "H5PartOpenFile" );
gsell's avatar
gsell committed
483

gsell's avatar
gsell committed
484 485
	MPI_Comm comm = 0;	/* dummy */
	int f_parallel = 0;	/* serial open */
486
	int align = 0;		/* no tuning parameters */
gsell's avatar
gsell committed
487

488 489 490 491
	return _H5Part_open_file ( filename, flags, comm, f_parallel, align );
}

/*!
492
  \ingroup h5part_open
493 494 495 496

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

497 498 499 500 501 502 503 504 505 506 507 508 509 510
  Flags are bit values that can be combined with the bit operator \c |
  and include:

  - \c H5PART_WRITE - truncate file and open for writing
  - \c H5PART_APPEND - open file for writing without truncating
  - \c H5PART_READ - open file read-only

  The typical file extension 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.

511 512 513 514 515
  \return	File handle or \c NULL
 */
H5PartFile*
H5PartOpenFileAlign (
	const char *filename,	/*!< [in] The name of the data file to open. */
516
	const char flags,	/*!< [in] The access mode for the file. */
517 518
	h5part_int64_t align	/*!< [in] Alignment size in bytes. */
) {
519 520
	INIT
	SET_FNAME ( "H5PartOpenFileAlign" );
521 522 523 524 525

	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
526 527 528 529 530 531 532
}

/*!
  Checks if a file was successfully opened.

  \return	\c H5PART_SUCCESS or error code
 */
533 534
h5part_int64_t
_H5Part_file_is_valid (
gsell's avatar
gsell committed
535 536 537 538 539 540 541 542 543 544 545
	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;
}

546 547 548 549 550 551 552
/*!
  \ingroup h5part_open

  Closes an open file.

  \return	\c H5PART_SUCCESS or error code
*/
gsell's avatar
gsell committed
553
h5part_int64_t
554
H5PartCloseFile (
gsell's avatar
gsell committed
555 556 557
	H5PartFile *f		/*!< [in] filehandle of the file to close */
	) {

558
	SET_FNAME ( "H5PartCloseFile" );
gsell's avatar
gsell committed
559
	herr_t r = 0;
560 561 562
	_h5part_errno = H5PART_SUCCESS;

	CHECK_FILEHANDLE ( f );
gsell's avatar
gsell committed
563 564 565 566 567 568 569

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

570 571 572 573 574 575 576 577
#ifdef PARALLEL_IO
	if ( f->multiblock && f->close_multiblock ) {
		(*f->close_multiblock) ( f );
		f->multiblock = NULL;
		f->close_multiblock = NULL;
	}
#endif

578
	if( f->shape != H5S_ALL ) {
gsell's avatar
gsell committed
579 580 581 582
		r = H5Sclose( f->shape );
		if ( r < 0 ) HANDLE_H5S_CLOSE_ERR;
		f->shape = 0;
	}
gsell's avatar
gsell committed
583
	if( f->timegroup >= 0 ) {
gsell's avatar
gsell committed
584 585
		r = H5Gclose( f->timegroup );
		if ( r < 0 ) HANDLE_H5G_CLOSE_ERR;
gsell's avatar
gsell committed
586
		f->timegroup = -1;
gsell's avatar
gsell committed
587 588 589 590 591 592
	}
	if( f->diskshape != H5S_ALL ) {
		r = H5Sclose( f->diskshape );
		if ( r < 0 ) HANDLE_H5S_CLOSE_ERR;
		f->diskshape = 0;
	}
593 594 595 596 597
	if( f->memshape != H5S_ALL ) {
		r = H5Sclose( f->memshape );
		if ( r < 0 ) HANDLE_H5S_CLOSE_ERR;
		f->memshape = 0;
	}
598 599 600 601
	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
602
	}
603 604 605 606
	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
607
	}
608 609


gsell's avatar
gsell committed
610 611 612 613 614
	if ( f->file ) {
		r = H5Fclose( f->file );
		if ( r < 0 ) HANDLE_H5F_CLOSE_ERR;
		f->file = 0;
	}
615 616 617 618
	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;
619 620 621 622 623 624
	}  
	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;
	}
625 626

	/* free memory from H5PartFile struct */
gsell's avatar
gsell committed
627 628 629 630 631
	if( f->pnparticles ) {
		free( f->pnparticles );
	}
	free( f );

gsell's avatar
gsell committed
632
	return _h5part_errno;
gsell's avatar
gsell committed
633 634
}

635 636 637 638 639 640 641
h5part_int64_t
H5PartFileIsValid (
	H5PartFile *f
	) {
	return _H5Part_file_is_valid(f);
}

gsell's avatar
gsell committed
642
/*============== File Writing Functions ==================== */
gsell's avatar
gsell committed
643

644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
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
668 669 670 671 672 673
h5part_int64_t
H5PartDefineStepName (
	H5PartFile *f,
	const char *name,
	const h5part_int64_t width
	) {
674 675 676 677 678 679 680 681

	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
682
	}
683 684

	strncpy ( f->groupname_step, name, len );
gsell's avatar
gsell committed
685
	f->stepno_width = (int)width;
686 687

	_H5Part_print_debug ( "Step name defined as '%s'", f->groupname_step );
gsell's avatar
gsell committed
688 689 690 691
	
	return H5PART_SUCCESS;
}

692 693 694 695 696
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
697 698
	) {

699 700 701 702
	int ret;
	h5part_int64_t herr;

	hsize_t count;
gsell's avatar
gsell committed
703
#ifdef HDF5V160
704
	hssize_t start;
gsell's avatar
gsell committed
705
#else
706
	hsize_t start;
gsell's avatar
gsell committed
707
#endif
708 709
	hsize_t stride;
	hsize_t dmax = H5S_UNLIMITED;
gsell's avatar
gsell committed
710

711
#ifdef PARALLEL_IO
gsell's avatar
gsell committed
712 713 714 715
	hsize_t total;
	register int i;
#endif

716 717 718
#ifdef PARALLEL_IO
	if ( nparticles < 0 )
#else
719
	if ( nparticles <= 0 )
720
#endif
721 722 723 724 725 726 727 728 729 730 731
		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
732

733 734
	if ( nparticles == 0 ) stride = 1;

gsell's avatar
gsell committed
735 736 737 738 739 740 741
#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
	*/
742 743 744
	if ( f->nparticles == nparticles && stride == 1 ) {
		_H5Part_print_debug (
			"Serial mode: skipping unnecessary view creation" );
gsell's avatar
gsell committed
745 746 747
		return H5PART_SUCCESS;
	}
#endif
748 749 750 751

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

752 753 754 755 756 757
	if ( f->shape != H5S_ALL ) {
		herr = H5Sclose ( f->shape );
		if ( herr < 0 ) return HANDLE_H5S_CLOSE_ERR;
		f->shape = H5S_ALL;
	}

758 759
	f->nparticles = (hsize_t) nparticles;

760 761 762 763 764 765 766 767
	if ( f->nparticles > 0 )
	{
		/* 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 );
	}
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782

	/* 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
783
	}
784

gsell's avatar
gsell committed
785
#ifndef PARALLEL_IO
786 787 788 789 790
	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
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
#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
	*/
806

807
	ret = MPI_Allgather (
808
		(void*)&nparticles, 1, MPI_LONG_LONG,
gsell's avatar
gsell committed
809
		f->pnparticles, 1, MPI_LONG_LONG,
810 811 812
		f->comm );
	if ( ret != MPI_SUCCESS) return HANDLE_MPI_ALLGATHER_ERR;

gsell's avatar
gsell committed
813
	if ( f->myproc == 0 ) {
814
		for ( i=0; i<f->nprocs; i++ ) 
815 816 817
			_H5Part_print_debug_detail (
				"[%d] np=%lld",
				i, (long long) f->pnparticles[i] );
gsell's avatar
gsell committed
818 819 820
	}

	/* compute start offsets */
821
	start = 0;
gsell's avatar
gsell committed
822
	for (i=0; i<f->myproc; i++) {
823
		start += f->pnparticles[i];
gsell's avatar
gsell committed
824
	}
825 826
	f->viewstart = start;
	f->viewend   = start + f->nparticles - 1; // view range is *inclusive*
gsell's avatar
gsell committed
827
	
828
	/* compute total nparticles */
gsell's avatar
gsell committed
829 830 831 832 833
	total = 0;
	for (i=0; i < f->nprocs; i++) {
		total += f->pnparticles[i];
	}

834
	/* declare overall datasize */
835
	count = total;
836 837
	f->shape = H5Screate_simple (1, &count, NULL);
	if ( f->shape < 0 ) return HANDLE_H5S_CREATE_SIMPLE_ERR ( count );
gsell's avatar
gsell committed
838 839

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

843 844
	count = nparticles;
	stride = 1;
845 846 847 848 849 850 851 852 853 854
	if ( count > 0 ) {
		herr = H5Sselect_hyperslab (
			f->diskshape,
			H5S_SELECT_SET,
			&start,
			&stride,
			&count, NULL );
	} else {
		herr = H5Sselect_none ( f->diskshape );
	}
855
	if ( herr < 0 ) return HANDLE_H5S_SELECT_HYPERSLAB_ERR;
gsell's avatar
gsell committed
856
#endif
857

gsell's avatar
gsell committed
858 859 860
	return H5PART_SUCCESS;
}

861 862 863 864 865 866 867
/*!
  \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.

868
  For the parallel library, the \c nparticles value is the number of
869 870 871 872 873 874 875 876 877 878
  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.
879
  For instance, the fields \e x and \e y for your particles are stored
880 881 882
  in separate arrays \c x[] and \c y[].
  
  If instead you store your particles as tuples, so that the values
883
  are arranged \f$ x_1,y_1,x_2,y_2\f$... than you need to setup striding
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
  (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.

913
  For the parallel library, the \c nparticles value is the number of
914 915 916 917 918 919 920 921 922
  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
923 924
  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
925 926 927 928 929 930 931
  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
932
*/
933 934 935 936
h5part_int64_t
H5PartSetNumParticlesStrided (
	H5PartFile *f,				/*!< [in] Handle to open file */
	const h5part_int64_t nparticles,	/*!< [in] Number of particles */
937
	const h5part_int64_t stride		/*!< [in] Stride value (e.g. number of fields in the particle array) */
938 939 940 941 942 943 944 945 946 947 948 949 950
	) {

	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;
}

951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
/*!
  \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 );

975 976 977
	_H5Part_print_info (
		"Setting chunk size to %lld elements",
		(long long)size );
978 979 980 981 982 983 984 985 986 987 988 989 990 991

	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;
}

992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
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
1010 1011 1012
static h5part_int64_t
_write_data (
	H5PartFile *f,		/*!< IN: Handle to open file */
gsell's avatar
gsell committed
1013 1014 1015
	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
1016
	) {
1017

gsell's avatar
gsell committed
1018 1019 1020
	herr_t herr;
	hid_t dataset_id;

1021 1022 1023 1024 1025
	char name2[H5PART_DATANAME_LEN];
	_normalize_dataset_name ( name, name2 );

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

1029 1030 1031 1032 1033 1034 1035
	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 );
	}

1036 1037
	H5E_BEGIN_TRY
	dataset_id = H5Dopen ( f->timegroup, name2
1038
#ifndef H5_USE_16_API
1039 1040 1041 1042
		, H5P_DEFAULT
#endif
		);
	H5E_END_TRY
1043

1044 1045 1046 1047 1048
	if ( dataset_id > 0 ) {
		_H5Part_print_warn (
			"Dataset[%s] at timestep %lld "
			"already exists", name2, (long long)f->timestep );
	} else {
1049
		dataset_id = H5Dcreate ( 
1050 1051 1052 1053
			f->timegroup,
			name2,
			type,
			f->shape,
1054
#ifndef H5_USE_16_API
1055
			H5P_DEFAULT,
1056 1057
			f->dcreate_prop,
			H5P_DEFAULT
1058
#else
1059
			f->dcreate_prop
1060
#endif
1061
                );
1062 1063 1064
		if ( dataset_id < 0 )
			return HANDLE_H5D_CREATE_ERR ( name2, f->timestep );
	}
gsell's avatar
gsell committed
1065

1066 1067 1068
#ifdef PARALLEL_IO
	herr = _H5Part_start_throttle ( f );
	if ( herr < 0 ) return herr;
1069
#endif
1070

1071 1072 1073 1074 1075
	herr = H5Dwrite (
		dataset_id,
		type,
		f->memshape,
		f->diskshape,
1076
		f->xfer_prop,
1077 1078
		array );

1079 1080 1081
#ifdef PARALLEL_IO
	herr = _H5Part_end_throttle ( f );
	if ( herr < 0 ) return herr;
1082
#endif
1083

1084
	if ( herr < 0 ) return HANDLE_H5D_WRITE_ERR ( name2, f->timestep );
gsell's avatar
gsell committed
1085 1086 1087 1088

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

gsell's avatar
gsell committed
1089 1090
	f->empty = 0;

gsell's avatar
gsell committed
1091 1092 1093 1094
	return H5PART_SUCCESS;
}

/*!
1095
  \ingroup h5part_data
gsell's avatar
gsell committed
1096

gsell's avatar
gsell committed
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
  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
1123 1124
	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
1125 1126 1127
	) {

	SET_FNAME ( "H5PartWriteDataFloat64" );
gsell's avatar
gsell committed
1128
	h5part_int64_t herr;
gsell's avatar
gsell committed
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139

	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;
}

1140
/*!
1141
  \ingroup h5part_data
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185

  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
1186
/*!
1187
  \ingroup h5part_data
gsell's avatar
gsell committed
1188

gsell's avatar
gsell committed
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
  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
1215 1216
	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
1217 1218
	) {

1219
	SET_FNAME ( "H5PartWriteDataInt64" );
gsell's avatar
gsell committed
1220

gsell's avatar
gsell committed
1221
	h5part_int64_t herr;
gsell's avatar
gsell committed
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232

	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;
}

1233
/*!
1234
  \ingroup h5part_data
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279

  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
1280 1281 1282
/********************** reading and writing attribute ************************/

/********************** private functions to handle attributes ***************/
gsell's avatar
gsell committed
1283 1284 1285 1286 1287 1288

/*!
  \ingroup h5partkernel
  @{
*/

1289
h5part_int64_t
1290
_H5Part_make_string_type(
1291
	hid_t *stype,
1292 1293
	int size
	) {
1294 1295 1296 1297 1298
	*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;
1299 1300
}

gsell's avatar
gsell committed
1301 1302 1303
/*!
   Normalize HDF5 type
*/
1304
h5part_int64_t
gsell's avatar
gsell committed
1305 1306 1307
_H5Part_normalize_h5_type (
	hid_t type
	) {
1308

gsell's avatar
gsell committed
1309 1310 1311
	H5T_class_t tclass = H5Tget_class ( type );
	int size = H5Tget_size ( type );

1312
	switch ( tclass ) {
gsell's avatar
gsell committed
1313
	case H5T_INTEGER:
1314 1315 1316 1317 1318 1319 1320
		if ( size==8 ) {
			return H5PART_INT64;
		}
	  	else if ( size==1 ) {
			return H5PART_CHAR;
		}
		break;
gsell's avatar
gsell committed
1321
	case H5T_FLOAT:
1322 1323 1324 1325 1326 1327 1328
		if ( size==8 ) {
			return H5PART_FLOAT64;
		}
		else if ( size==4 ) {
			return H5PART_FLOAT32;
		}
		break;
1329
	case H5T_STRING:
1330
		return H5PART_STRING;
gsell's avatar
gsell committed
1331
	default:
1332
		;/* NOP */
gsell's avatar
gsell committed
1333
	}
1334
	
1335
	return HANDLE_H5PART_TYPE_ERR;
gsell's avatar
gsell committed
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345
}

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

	herr_t herr;
1346
	h5part_int64_t h5err;
gsell's avatar
gsell committed
1347 1348 1349 1350
	hid_t attrib_id;
	hid_t space_id;
	hid_t type_id;

1351
#ifdef H5PART_HAVE_HDF5_18
1352
	if (! H5Aexists ( id, attrib_name )) {
1353
		_H5Part_print_warn ( "Attribute '%s' does not exist!", attrib_name );
1354 1355 1356
	}
	attrib_id = H5Aopen ( id, attrib_name, H5P_DEFAULT );
#else
gsell's avatar
gsell committed
1357
	attrib_id = H5Aopen_name ( id, attrib_name );
1358
#endif
gsell's avatar
gsell committed
1359 1360
	if ( attrib_id <= 0 ) return HANDLE_H5A_OPEN_NAME_ERR( attrib_name );

1361
	type_id = H5Aget_type ( attrib_id );
1362
	if ( type_id < 0 ) return HANDLE_H5A_GET_TYPE_ERR;
gsell's avatar
gsell committed
1363 1364 1365 1366

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

1367
	herr = H5Aread ( attrib_id, type_id, attrib_value );
gsell's avatar
gsell committed
1368 1369 1370 1371 1372
	if ( herr < 0 ) return HANDLE_H5A_READ_ERR;

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

1373
	herr = H5Tclose ( type_id );
gsell's avatar
gsell committed
1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
	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
	) {

1391
	h5part_int64_t herr;
gsell's avatar
gsell committed
1392 1393
	hid_t space_id;
	hid_t attrib_id;
1394 1395
	hid_t type = attrib_type;

1396 1397 1398 1399 1400
	if ( attrib_type == H5PART_STRING )
	{
		herr = _H5Part_make_string_type ( &type, attrib_nelem );
		if ( herr < 0 ) return herr;

1401 1402 1403 1404 1405
		space_id = H5Screate (H5S_SCALAR);
		if ( space_id < 0 )
			return HANDLE_H5S_CREATE_SCALAR_ERR;
	}
	else {
1406
		space_id = H5Screate_simple ( 1, &attrib_nelem, NULL );
1407 1408 1409
		if ( space_id < 0 )
			return HANDLE_H5S_CREATE_SIMPLE_ERR ( attrib_nelem );
	}
gsell's avatar
gsell committed
1410

1411 1412 1413 1414 1415 1416
	attrib_id = H5Acreate(
		id,
		attrib_name,
		type,
		space_id,
		H5P_DEFAULT
1417
#ifndef H5_USE_16_API
1418
		, H5P_DEFAULT
1419
#endif
1420
		);
1421

gsell's avatar
gsell committed
1422 1423
	if ( attrib_id < 0 ) return HANDLE_H5A_CREATE_ERR ( attrib_name );

1424
	herr = H5Awrite ( attrib_id, type, attrib_value);
gsell's avatar
gsell committed
1425 1426 1427 1428 1429 1430 1431 1432
	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;

1433
	if ( attrib_type == H5PART_STRING ) {
1434 1435 1436 1437
		herr = H5Tclose ( type );
		if ( herr < 0 ) return HANDLE_H5T_CLOSE_ERR;
	}

gsell's avatar
gsell committed
1438 1439 1440
	return H5PART_SUCCESS;
}

1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
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