sion_serial.h File Reference

#include <stdio.h>
#include "sion_const.h"
#include "sion_datatypes.h"

Include dependency graph for sion_serial.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
int	sion_open (char *fname, const char *file_mode, int *ntasks, int *nfiles, sion_int64 **chunksizes, sion_int32 *fsblksize, int **globalranks, FILE **fileptr)
	Open a sion file in serial mode. More...
int	sion_open_rank (char *fname, const char *file_mode, sion_int64 *chunksize, sion_int32 *fsblksize, int *rank, FILE **fileptr)
	Open a sion file for a specific rank. More...
int	sion_close (int sid)
	Close a sion file. More...

Detailed Description

Serial interface API Overview

Definition in file sion_serial.h.

Function Documentation

sion_close()

int sion_close

(

int

sid

)

Close a sion file.

See sion_close_description .

Parameters

[in]

sid

sion file handle

Returns

SION_SUCCESS if close is ok

Definition at line 106 of file sion_serial.c.

Referenced by fsion_close_c().

sion_open()

int sion_open	(	char *	fname,
		const char *	file_mode,
		int *	ntasks,
		int *	nfiles,
		sion_int64 **	chunksizes,
		sion_int32 *	fsblksize,
		int **	globalranks,
		FILE **	fileptr
	)

Open a sion file in serial mode.

See sion_open_description.

Parameters

[in]	fname	name of file, should be equal on all tasks
[in]	file_mode	like the type parameter of fopen. See file_mode_description .
[in,out]	ntasks	number of tasks used to write this file
[in,out]	nfiles	number of physical files
[in,out]	chunksizes	chunksize for each task
[in,out]	fsblksize	blocksize of filesystem, must be equal on all processors
[in]	globalranks	rank numbers for which the file should be opened; will be stored in sion file, useful if comm is not MPI_COMM_WORLD typical: globalrank = rank in MPI_COMM_WORLD
[out]	fileptr	file pointer for this task

Return values

sid	sion file handle or -1 if error occured

Definition at line 54 of file sion_serial.c.

sion_open_rank()

int sion_open_rank	(	char *	fname,
		const char *	file_mode,
		sion_int64 *	chunksize,
		sion_int32 *	fsblksize,
		int *	rank,
		FILE **	fileptr
	)

Open a sion file for a specific rank.

See sion_open_rank_description

Parameters

[in]	fname	name of file, should be equal on all tasks
[in,out]	file_mode	like the type parameter of fopen (currently recognized options: "rb", "wb")
[in,out]	chunksize	chunksize for this task
[in,out]	fsblksize	blocksize of filesystem, must be equal on all processors
[in]	rank	rank number for which the file should be open; will be stored in sion file, usefull if comm is not MPI_COMM_WORLD typical: globalrank= rank in MPI_COMM_WORLD
[out]	fileptr	file pointer for this task

Return values

sid	sion file handle or -1 if error occured

Definition at line 83 of file sion_serial.c.

Referenced by fsion_open_rank_c().