sion_common.h

/****************************************************************************
**  SIONLIB     http://www.fz-juelich.de/jsc/sionlib                       **
*****************************************************************************
**  Copyright (c) 2008-2019                                                **
**  Forschungszentrum Juelich, Juelich Supercomputing Centre               **
**                                                                         **
**  See the file COPYRIGHT in the package base directory for details       **
****************************************************************************/

#ifndef SION_SION_COMMON_H
#define SION_SION_COMMON_H

#include <stdint.h>
#include <stdio.h>

#include "sion_enums.h"

struct _sion_io_stat_struct;

/* default mode */
#define SION_SERIAL_MASTER

#define SION_MAX_FSBLOCKSIZE 32 * 1024 * 1024
#define SION_DEFAULT_FSBLOCKSIZE 2 * 1024 * 1024

#define SION_FILENAME_LENGTH 1024

#define MAXCHUNKS 100 
#define WFLARGEMETABLOCK_none /* for BENCHMARKING only */

#ifdef __cplusplus
extern "C" {
#endif

/* I/O */
size_t sion_write(const void *data, size_t size, size_t nitems, int sid);

size_t sion_fwrite(const void *data, size_t size, size_t nitems, int sid);

size_t sion_read(void *data, size_t size, size_t nitems, int sid);

size_t sion_fread(void *data, size_t size, size_t nitems, int sid);

/* helper functions */
int sion_eof(int sid);

int sion_feof(int sid);

int sion_ensure_free_space(int sid, int64_t bytes);

int sion_flush(int sid);

/* get size of internal data structure */
int sion_get_sizeof(int sid, int *numbytes, int *numfds);

/* duplicate fd (only parallel read-mode) */
int sion_dup(int sid, int mode, int rank, uint64_t key);

int sion_dedup(int sid);

/* special helper functions, for used with szlib */
int sion_optimize_fp_buffer(int sid);

/* get information (with sion datatypes) */
int sion_get_file_endianness(int sid);

int sion_endianness_swap_needed(int sid);
int64_t sion_get_bytes_written(int sid);
int64_t sion_get_bytes_read(int sid);

int64_t sion_bytes_avail_in_block(int sid);

int64_t sion_bytes_avail_in_chunk(int sid);

int64_t sion_get_position(int sid);

int sion_get_mapping(int sid, int *mapping_size, int32_t **mapping, int *numfiles);

int sion_get_locations(int sid, int *ntasks, int *maxchunks, int64_t *globalskip, int64_t *start_of_varheader,
  int64_t **sion_chunksizes, int64_t **sion_globalranks, int64_t **sion_blockcount, int64_t **sion_blocksizes);

/* parallel mode */
int sion_get_current_location(int sid, int *currentchunknr, int64_t *currentpos, int *maxchunks, int64_t **chunksizes);

/* serial mode */
int sion_get_current_locations(int sid, int *ntasks, int64_t **sion_currentpos, int64_t **sion_currentblocknr);
int sion_get_number_of_files(int sid);
int sion_get_filenumber(int sid);

int sion_get_number_of_logical_files(int sid);

int64_t *sion_get_chunksizes(int sid);

int32_t sion_get_fsblksize(int sid);

/* 1 is opened with sion_open or sion_open_rank */
int sion_is_serial_opened(int sid);

/* 1 if using GPFS or Linux hints */
int sion_using_hints(int sid);

/*   return current endianness (1-> big endian, 0 ->little endian) */
int sion_get_endianness(void);

/*   return if SIONlib supports PTHREADS (Thread-safe) 1 -> yes, 0 -> no  */
int sion_is_thread_safe(void);

/*   return version numbers */
int sion_get_version(int *main_version, int *sub_version, int *patch_level, int *fileformat_version);

typedef struct _sion_io_stat_struct sion_io_stat_t;
struct _sion_io_stat_struct {
  int nfiles;
  const char **names;
  size_t *sizes;
  int *roles;
};

/* return info about accessed (local) files on this task  */
sion_io_stat_t *sion_get_io_info(int sid);

/* return info about accessed (local) files on this task */
sion_io_stat_t *sion_get_io_info_by_spec(int sid, int roles, int flag);
int sion_free_io_info(sion_io_stat_t *info);

/* Seeking */
int sion_seek(int sid, int64_t offset, sion_seek_mode whence);

//
int sion_seek_chunk(int sid, int32_t offset, sion_seek_mode whence);

int sion_switch_logical_file(int sid, int file_number);

int64_t sion_tell(int sid);

/* register user defined lock and unlock routines, which are needed to access shared data structures internally  */
int sion_lock_register_lock_callbacks(int lock(void *), int unlock(void *), void *lock_data);

int sion_lock_user_callbacks_defined(void);

/* Utilities */
void sion_swap(void *target, void *source, int size, int n, int do_swap);

char *sion_get_fname(int sid);
int64_t sion_get_chunksize(int sid);
int32_t sion_get_globalrank(int sid);


struct _sion_key_stat_struct;

size_t sion_write_key(const void *data, uint64_t key, size_t size, size_t nitems, int sid);

size_t sion_fwrite_key(const void *data, uint64_t key, size_t size, size_t nitems, int sid);

size_t sion_read_key(void *data, uint64_t key, size_t size, size_t nitems, int sid);

size_t sion_fread_key(void *data, uint64_t key, size_t size, size_t nitems, int sid);

/* iterator for key-value pairs */
int sion_read_key_iterator_reset(int sid);

int sion_fread_key_iterator_reset(int sid);

int sion_read_key_iterator_next(int sid, uint64_t *key, size_t *size);

int sion_fread_key_iterator_next(int sid, uint64_t *key, size_t *size);

int sion_seek_key(int sid, uint64_t key, int entrynum, int64_t posinentry);

int sion_key_full_scan(int sid);

int sion_key_list_iterator_reset(int sid);

int sion_key_list_iterator_next(int sid, uint64_t *keyptr);

typedef struct _sion_key_stat_struct sion_key_stat_t;
struct _sion_key_stat_struct {
  uint64_t key;
  int64_t num_blocks;
  int64_t total_size;
};

int sion_key_get_stat(int sid, uint64_t key, sion_key_stat_t *stat);

int sion_get_keyval_mode(int sid);

char *sion_keyval_type_to_str(int type);


#ifdef __cplusplus
}
#endif

/* Debugging  */
#ifndef DPRINTF
#define DPRINTF(A)
#define DPRINTFP(A)
#define DPRINTTS(A, B)
#define DPRINTFTS2(A, B)
#endif


#endif