sion_filedesc.h

Go to the documentation of this file.

/****************************************************************************
**  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_FILEDESC_H
#define SION_SION_FILEDESC_H
 
#include "sion_const.h"
#include "sion_datatypes.h"
#include "sion_file.h"
 
#define _SION_FLAG1_NONE      0                 
#define _SION_FLAG2_NONE      0                 
#define _SION_FLAG1_USECACHE         2          
#define SION_FILESTATE_UNKNOWN       -1         
#define SION_FILESTATE_PAROPEN       0          
#define SION_FILESTATE_SEROPEN       1          
#define SION_FILESTATE_SEROPENRANK   2          
#define SION_FILESTATE_SEROPENMASTER 3          
#define SION_FILESTATE_PAROPENMAPPEDMASTER  4   
#define SION_FILESTATE_PAROPENMAPPEDMANAGED 5   
#define SION_FILESTATE_PAROPENMAPPED        6   
#define SION_FILESTATE_CLOSE        10          
#define SION_FILEMODE_UNKNOWN       -20         
#define SION_FILEMODE_READ          20          
#define SION_FILEMODE_WRITE         30          
#define SION_CACHE_TODISK           40          
#define SION_CACHE_TOMEM            41          
#define SION_CACHE_UNKNOWN          42          
#define SION_CACHE_FNLEN            16          
#define SION_DESCSTATE_ORIG         200         
#define SION_DESCSTATE_DUP          201         
#define SION_DESCSTATE_DUP_SEL_RANK 202         
#define SION_DESCSTATE_DUP_SEL_RANK_KEY 203     
#define SION_HINTS_TYPE_UNKNOWN     160         
#define SION_HINTS_TYPE_LINUX       161         
#define SION_HINTS_TYPE_GPFS        162         
#define SION_CAPABILITY_FULL        50          
#define SION_CAPABILITY_ONLY_SENDER 51          
#define SION_CAPABILITY_NONE        52          
#define _SION_DEBUG_PRINT_ALL       1
#define _SION_DEBUG_PRINT_RECURSIVE 2
 
typedef struct _sion_filedesc_struct _sion_filedesc;
 
struct _sion_filedesc_struct {
 
  /* file pointer and temporary data */
  _sion_fileptr *fileptr;         
  void*      dataptr;              
  void*      keyvalptr;            
  sion_int32 debug;                
  sion_int32 sid;                  
  char*      fpbuffer;             
  sion_int32 fpbuffer_size;        
  sion_int32 usebuffer;            
  char*      buffer;               
  sion_int32 buffer_size;          
  sion_int32 buffer_ptr;           
  /* current position in file */
  sion_int32 rank;                 
  sion_int64 currentpos;           
  sion_int32 currentblocknr;       
  /* data for one task  */
  sion_int64 *blocksizes;          
  sion_int32 lastchunknr;          
  sion_int64 startpos;             
  /* meta header data in file */
  char       *fname;               
  sion_int32 globalrank;           
  sion_int32 ntasks;               
  sion_int32 state;                
  sion_int32 mode;                 
  sion_int32 endianness;           
  sion_int32 swapbytes;            
  sion_int32 filesionversion;      
  sion_int32 filesionpatchlevel;   
  sion_int32 fileversion;          
  sion_int32 fsblksize;            
  sion_int32 maxchunks;            
  sion_int64 flag1;                
  sion_int64 flag2;                
  sion_int64 chunksize;            
  sion_int64 chunksize_req;        
  sion_int64 globalskip;           
  sion_int64 end_of_header;        
  sion_int64 start_of_varheader;   
  sion_int64 start_of_data;        
  sion_int32 nfiles;               
  sion_int32 filenumber;           
  sion_int32 maxusedchunks;        
  /* dupped filedesc */
  sion_int32 dup_mode;             
  sion_int32 dup_sel_rank;         
  sion_uint64 dup_sel_key;         
  /* mapped files */
  sion_int32 lrank;        
  sion_int32 ntotaltasksinfile;    
  sion_int32 nlocaltasksinfile;    
  sion_int32 filemanagedbytask;    
  /* all tasks */
  sion_int64 *all_chunksizes;      
  sion_int64 *all_globalranks;     
  sion_int64 *all_localranks;      
  sion_int64 *all_startpointers;   
  sion_int64 *all_currentpos;      
  sion_int64 *all_currentblocknr;  
  sion_int32 *all_coll_collector;  
  sion_int32 *all_coll_collsize;   
  sion_int32 *all_coll_capability; 
  void       **all_keyvalptr;      
  /* all tasks, all chunks */
  sion_int64 *all_blockcount;      
  sion_int64 *all_blocksizes;      
  /* multi-file */
  sion_int32 mapping_size;         
  sion_int32 *mapping;             
  char       *prefix;              
  _sion_filedesc **multifiles;     
  /* compression */
  sion_int32 compress;             
  /* Key-value */
  sion_int32 keyvalmode;           
  /* persistent cache */
  sion_int32 usecache;             
  sion_int32 cachesize;            
  sion_int32 cacheid;              
  char       cachefn[SION_CACHE_FNLEN];           
  sion_int32 cachemode;            
  char*      cacheptr;             
  /* collective I/O */
  sion_int32 usecoll;              
  sion_int32 collsize;             
  sion_int32 collector;            
  sion_int32 coll_capability;      
  sion_int32 colldebug;            
  sion_int32 collcmdused;          
  sion_int32 fileptr_exported;     
  sion_int32 collmergemode;        
  sion_int32 collmsa;              
  /* buddy */
  sion_int32 usebuddy;             
  sion_int32 buddylevel;           
  sion_int32 buddynr;              
  void      *buddies;              
  /* hints */
  sion_int32 usehints;             
  sion_int32 hinttype;             
};
 
_sion_filedesc * _sion_alloc_filedesc(void);
int _sion_init_filedesc(  _sion_filedesc *sion_filedesc );
int _sion_print_filedesc( _sion_filedesc *sion_filedesc, int level, char *desc, int all );
int _sion_free_filedesc(  _sion_filedesc *sion_filedesc );
int _sion_realloc_filedesc_blocklist(  _sion_filedesc *sion_filedesc, sion_int32 maxchunks );
 
int _sion_alloc_filedesc_all_chunksizes(_sion_filedesc *sion_filedesc);
int _sion_alloc_filedesc_all_startpointers(_sion_filedesc *sion_filedesc);
int _sion_alloc_filedesc_all_globalranks(_sion_filedesc *sion_filedesc);
int _sion_alloc_filedesc_all_localranks(_sion_filedesc *sion_filedesc);
int _sion_alloc_filedesc_arrays( _sion_filedesc *sion_filedesc );
int _sion_alloc_filedesc_all_keyvalptr(_sion_filedesc *sion_filedesc);
 
int _sion_free_filedesc_arrays( _sion_filedesc *sion_filedesc );
int _sion_free_filedesc_all_chunksizes(_sion_filedesc *sion_filedesc);
int _sion_free_filedesc_all_globalranks(_sion_filedesc *sion_filedesc);
int _sion_free_filedesc_all_startpointers(_sion_filedesc *sion_filedesc);
int _sion_free_filedesc_all_localranks(_sion_filedesc *sion_filedesc);
int _sion_free_filedesc_all_keyvalptr(_sion_filedesc *sion_filedesc);
 
 
 
int _sion_alloc_filedesc_block_arrays(_sion_filedesc *sion_filedesc);
int _sion_alloc_filedesc_block_arrays_only(_sion_filedesc *sion_filedesc);
 
int _sion_alloc_filedesc_coll_arrays(_sion_filedesc *sion_filedesc);
int _sion_free_filedesc_coll_arrays(_sion_filedesc *sion_filedesc);
 
int _sion_alloc_filedesc_arrays_mapped(_sion_filedesc *sion_filedesc);
int _sion_alloc_filedesc_block_arrays_mapped(_sion_filedesc *sion_filedesc);
 
char* _sion_fileptrflags_to_str (unsigned int flag);
int _sion_get_size_of_filedesc(_sion_filedesc *sion_filedesc, int *numbytes, int *numfds);
 
_sion_filedesc * _sion_dup_filedesc(_sion_filedesc *sion_filedesc);
 
 
#endif