error.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// ExaScale IO library for turbulence simulation restart files
// http://github.com/RhysU/ESIO
//
// Copyright (C) 2010-2017, 2022, 2026 Rhys Ulerich
// Copyright (C) 2010-2017 The PECOS Development Team
//
// This file is part of ESIO.
//
// ESIO 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 3.0 of the License, or
// (at your option) any later version.
//
// ESIO 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 ESIO.  If not, see <http://www.gnu.org/licenses/>.
//
//-----------------------------------------------------------------------el-
 
#ifndef ESIO_ERROR_H
#define ESIO_ERROR_H
 
#include <stdio.h>
#include <esio/visibility.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum esio_status {
    ESIO_SUCCESS  =  0, 
    ESIO_EFAULT   =  3, 
    ESIO_EINVAL   =  4, 
    ESIO_EFAILED  =  5, 
    ESIO_ESANITY  =  7, 
    ESIO_ENOMEM   =  8, 
    ESIO_NOTFOUND =  9  
};
 
void
esio_error(const char * reason,
           const char * file,
           int line,
           int esio_errno) ESIO_API;
 
void
esio_stream_printf(const char *label,
                   const char *file,
                   int line,
                   const char *reason) ESIO_API;
 
const char *
esio_strerror(const int esio_errno) ESIO_API;
 
typedef void esio_error_handler_t(const char * reason,
                                  const char * file,
                                  int line,
                                  int esio_errno);
 
typedef void esio_stream_handler_t(const char * label,
                                   const char * file,
                                   int line,
                                   const char * reason);
 
esio_error_handler_t *
esio_set_error_handler(esio_error_handler_t * new_handler) ESIO_API;
 
esio_error_handler_t *
esio_set_error_handler_off(void) ESIO_API;
 
esio_stream_handler_t *
esio_set_stream_handler(esio_stream_handler_t * new_handler) ESIO_API;
 
FILE *
esio_set_stream(FILE * new_stream) ESIO_API;
 
#define ESIO_ERROR(reason, esio_errno) \
       do { \
       esio_error (reason, __FILE__, __LINE__, esio_errno) ; \
       return esio_errno ; \
       } while (0)
 
#define ESIO_ERROR_VAL(reason, esio_errno, value) \
       do { \
       esio_error (reason, __FILE__, __LINE__, esio_errno) ; \
       return value ; \
       } while (0)
 
#define ESIO_ERROR_VOID(reason, esio_errno) \
       do { \
       esio_error (reason, __FILE__, __LINE__, esio_errno) ; \
       return ; \
       } while (0)
 
#define ESIO_ERROR_NULL(reason, esio_errno) \
        ESIO_ERROR_VAL(reason, esio_errno, 0)
 
#define ESIO_ERROR_REPORT(reason, esio_errno) \
       do { \
       esio_error (reason, __FILE__, __LINE__, esio_errno) ; \
       } while (0)
 
/* Internal helper macro for implementing ESIO_MPICHKx macros */
#define ESIO_MPICHKx_TEMPLATE(esio_error_macro,stmt) \
    do { \
        const int _chk_stat = (stmt); \
        if (_chk_stat != MPI_SUCCESS) { \
            char _chk_reason[384]; \
            char _chk_mpistring[MPI_MAX_ERROR_STRING]; \
            int _chk_len; \
            const int _chk_string_stat \
                = MPI_Error_string(_chk_stat,_chk_mpistring,&_chk_len); \
            snprintf(_chk_reason, sizeof(_chk_reason)/sizeof(_chk_reason[0]), \
                    "Encountered MPI error code %d: %s", _chk_stat, \
                    (_chk_string_stat == MPI_SUCCESS) \
                    ? _chk_mpistring : "UNKNOWN"); \
            esio_error_macro(_chk_reason, ESIO_EFAILED); \
        } \
    } while(0)
 
#define ESIO_MPICHKQ(stmt) \
    ESIO_MPICHKx_TEMPLATE(ESIO_ERROR,stmt)
 
#define ESIO_MPICHKN(stmt) \
    ESIO_MPICHKx_TEMPLATE(ESIO_ERROR_NULL,stmt)
 
#define ESIO_MPICHKV(stmt) \
    ESIO_MPICHKx_TEMPLATE(ESIO_ERROR_VOID,stmt)
 
#define ESIO_MPICHKR(stmt) \
    ESIO_MPICHKx_TEMPLATE(ESIO_ERROR_REPORT,stmt)
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* ESIO_ERROR_H */