sc_scda.h

Go to the documentation of this file.

/*
  This file is part of the SC Library.
  The SC Library provides support for parallel scientific applications.
 
  Copyright (C) 2010 The University of Texas System
  Additional copyright (C) 2011 individual authors
 
  The SC Library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  The SC Library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with the SC Library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  02110-1301, USA.
*/
 
#ifndef SC_SCDA_H
#define SC_SCDA_H
 
#include <sc_containers.h>
#include <sc_random.h>
 
SC_EXTERN_C_BEGIN;
 
#define SC_SCDA_HEADER_BYTES 128 
#define SC_SCDA_USER_STRING_BYTES 58 
#define SC_SCDA_INLINE_FIELD 32 
typedef struct sc_scda_fcontext sc_scda_fcontext_t;
 
typedef uint64_t    sc_scda_ulong;
 
typedef enum sc_scda_ret
{
  SC_SCDA_FERR_SUCCESS = 0, 
  SC_SCDA_FERR_FORMAT = 15000, 
  SC_SCDA_FERR_USAGE,   
  SC_SCDA_FERR_DECODE,  
  SC_SCDA_FERR_ARG, 
  SC_SCDA_FERR_COUNT, 
  SC_SCDA_FERR_MPI,   
  SC_SCDA_FERR_LASTCODE 
}
sc_scda_ret_t;
 
typedef struct sc_scda_ferror
{
  /* *INDENT-OFF* */
  int mpiret;            
  sc_scda_ret_t scdaret; 
  /* *INDENT-ON* */
}
sc_scda_ferror_t;
 
typedef struct sc_scda_params
{
  sc_MPI_Info         info; 
  unsigned            fuzzy_everyn; 
  sc_rand_state_t     fuzzy_seed; 
  int                 log_level;  
}
sc_scda_params_t; 
void sc_scda_params_init (sc_scda_params_t *params);
 
sc_scda_fcontext_t *sc_scda_fopen_write (sc_MPI_Comm mpicomm,
                                         const char *filename,
                                         const char *user_string, size_t *len,
                                         sc_scda_params_t * params,
                                         sc_scda_ferror_t * errcode);
 
sc_scda_fcontext_t *sc_scda_fwrite_inline (sc_scda_fcontext_t * fc,
                                           const char *user_string,
                                           size_t *len,
                                           sc_array_t * inline_data, int root,
                                           sc_scda_ferror_t * errcode);
 
sc_scda_fcontext_t *sc_scda_fwrite_block (sc_scda_fcontext_t * fc,
                                          const char *user_string,
                                          size_t *len,
                                          sc_array_t * block_data,
                                          size_t block_size, int root,
                                          int encode,
                                          sc_scda_ferror_t * errcode);
 
sc_scda_fcontext_t *sc_scda_fwrite_array (sc_scda_fcontext_t * fc,
                                          const char *user_string,
                                          size_t *len,
                                          sc_array_t * array_data,
                                          sc_array_t * elem_counts,
                                          size_t elem_size, int indirect,
                                          int encode,
                                          sc_scda_ferror_t * errcode);
 
int                 sc_scda_proc_sizes (sc_array_t * elem_sizes,
                                        sc_array_t * elem_counts,
                                        sc_array_t * proc_sizes,
                                        sc_scda_ferror_t * errcode);
 
sc_scda_fcontext_t *sc_scda_fwrite_varray (sc_scda_fcontext_t * fc,
                                           const char *user_string,
                                           size_t *len,
                                           sc_array_t * array_data,
                                           sc_array_t * elem_counts,
                                           sc_array_t * elem_sizes,
                                           sc_array_t * proc_sizes,
                                           int indirect, int encode,
                                           sc_scda_ferror_t * errcode);
 
sc_scda_fcontext_t *sc_scda_fopen_read (sc_MPI_Comm mpicomm,
                                        const char *filename,
                                        char *user_string, size_t *len,
                                        sc_scda_params_t * params,
                                        sc_scda_ferror_t * errcode);
 
sc_scda_fcontext_t *sc_scda_fread_section_header (sc_scda_fcontext_t * fc,
                                                  char *user_string,
                                                  size_t *len, char *type,
                                                  size_t *elem_count,
                                                  size_t *elem_size,
                                                  int *decode,
                                                  sc_scda_ferror_t * errcode);
 
sc_scda_fcontext_t *sc_scda_fread_inline_data (sc_scda_fcontext_t * fc,
                                               sc_array_t * data, int root,
                                               sc_scda_ferror_t * errcode);
 
sc_scda_fcontext_t *sc_scda_fread_block_data (sc_scda_fcontext_t * fc,
                                              sc_array_t * block_data,
                                              size_t block_size, int root,
                                              sc_scda_ferror_t * errcode);
 
sc_scda_fcontext_t *sc_scda_fread_array_data (sc_scda_fcontext_t * fc,
                                              sc_array_t * array_data,
                                              sc_array_t * elem_counts,
                                              size_t elem_size,
                                              int indirect,
                                              sc_scda_ferror_t * errcode);
 
sc_scda_fcontext_t *sc_scda_fread_varray_sizes (sc_scda_fcontext_t * fc,
                                                sc_array_t * elem_sizes,
                                                sc_array_t * elem_counts,
                                                sc_scda_ferror_t * errcode);
 
sc_scda_fcontext_t *sc_scda_fread_varray_data (sc_scda_fcontext_t * fc,
                                               sc_array_t * array_data,
                                               sc_array_t * elem_counts,
                                               sc_array_t * elem_sizes,
                                               sc_array_t * proc_sizes,
                                               int indirect,
                                               sc_scda_ferror_t * errcode);
 
int                 sc_scda_ferror_class (sc_scda_ferror_t errcode,
                                          sc_scda_ferror_t * errclass);
 
int                 sc_scda_ferror_is_success (sc_scda_ferror_t errorcode);
 
int                 sc_scda_ferror_string (sc_scda_ferror_t errcode,
                                           char *str, int *len);
 
int                 sc_scda_fclose (sc_scda_fcontext_t * fc,
                                    sc_scda_ferror_t * errcode);
 
SC_EXTERN_C_END;
 
#endif /* SC_SCDA_H */