ReturnCode.h

Go to the documentation of this file.

// SPDX-License-Identifier: BSD-3-Clause
//
// This file is part of ETISS. It is licensed under the BSD 3-Clause License; you may not use this file except in
// compliance with the License. You should have received a copy of the license along with this project. If not, see the
// LICENSE file.
#ifndef ETISS_INCLUDE_RETURNCODE_H_
#define ETISS_INCLUDE_RETURNCODE_H_
 
#include "etiss/jit/types.h"
 
#ifdef __cplusplus
 
#include "etiss/Misc.h" // etiss::log(2)
#include <map>
 
namespace etiss
{
 
namespace RETURNCODE
{
extern std::map<etiss::int32, const char *> &getErrorMessages();
extern std::map<etiss::int32, const char *> &getErrorNames();
 
extern int32_t setTemporary(const std::string &msg);
 
} // namespace RETURNCODE
 
} // namespace etiss
 
#endif
 
extern int32_t etiss_returncode_setTemporary(const char *msg);
 
#ifndef etiss_toString
#define etiss__toString_(X) #X
#define etiss_toString(X) etiss__toString_(X)
#endif
#ifndef etiss_merge2
#define etiss__merge2_(X, Y) X##Y
#define etiss_merge2(X, Y) etiss__merge2_(X, Y)
#endif
 
#ifdef __cplusplus
#ifdef ETISS_RETURNCODE_REGISTRATION_BODY
 
#define defineReturnCodeClass_(UNIQUENUMBER, NAME, VALUE, MSG)                                                   \
    static class ReturnCodeRegistration_##UNIQUENUMBER                                                           \
    {                                                                                                            \
      public:                                                                                                    \
        ReturnCodeRegistration_##UNIQUENUMBER()                                                                  \
        {                                                                                                        \
            auto entry = etiss::RETURNCODE::getErrorNames().find(VALUE);                                         \
            if (entry != etiss::RETURNCODE::getErrorNames().end())                                               \
            {                                                                                                    \
                if (std::string(entry->second) != etiss_toString(NAME))                                          \
                {                                                                                                \
                    std::stringstream ss;                                                                        \
                    ss << "Duplicated RETURNCODE " << VALUE << ": ";                                             \
                    ss << etiss::RETURNCODE::getErrorNames().find(VALUE)->second << "," << etiss_toString(NAME); \
                    etiss::log(etiss::ERROR, ss.str());                                                          \
                }                                                                                                \
            }                                                                                                    \
            etiss::RETURNCODE::getErrorMessages()[VALUE] = MSG;                                                  \
            etiss::RETURNCODE::getErrorNames()[VALUE] = etiss_toString(NAME);                                    \
        }                                                                                                        \
    } returnCodeRegistration_##UNIQUENUMBER
 
#define defineReturnCodeClass(UNIQUENUMBER, NAME, VALUE, MSG) defineReturnCodeClass_(UNIQUENUMBER, NAME, VALUE, MSG)
 
#define defineReturnCode(NAME, VALUE, MSG)                                  \
    namespace etiss                                                         \
    {                                                                       \
    namespace RETURNCODE                                                    \
    {                                                                       \
    static const etiss::int32 NAME = VALUE;                                 \
    }                                                                       \
    }                                                                       \
    static const etiss_int32 etiss_merge2(ETISS_RETURNCODE_, NAME) = VALUE; \
    defineReturnCodeClass(__COUNTER__, NAME, VALUE, MSG)
#else
#define defineReturnCode(NAME, VALUE, MSG)  \
    namespace etiss                         \
    {                                       \
    namespace RETURNCODE                    \
    {                                       \
    static const etiss::int32 NAME = VALUE; \
    }                                       \
    }                                       \
    static const etiss_int32 ETISS_RETURNCODE_##NAME = VALUE
#endif
#else
#define defineReturnCode(NAME, VALUE, MSG) static const etiss_int32 ETISS_RETURNCODE_##NAME = VALUE
#endif
 
// winerror.h defines this.
#ifdef NOERROR
#undef NOERROR
#endif
 
 
defineReturnCode(NOERROR, 0, "No error.");
defineReturnCode(GENERALERROR, -1, "General error.");
defineReturnCode(RELOADBLOCKS, -2, "Clear cached translated blocks.");
defineReturnCode(RELOADCURRENTBLOCK, -3, "Clear the cached block that returned this code.");
// defineReturnCode(RELOADRANGE,-4,"clear cached translated blocks in a range")
defineReturnCode(DBUS_READ_ERROR, -5, "Data bus read error.");
defineReturnCode(DBUS_WRITE_ERROR, -6, "Data bus write error.");
defineReturnCode(IBUS_READ_ERROR, -7, "Instruction bus read error.");
defineReturnCode(IBUS_WRITE_ERROR, -8, "Instruction bus write error.");
defineReturnCode(INTERRUPT, -9, "Signal an interrupt.");
defineReturnCode(RESET, -10, "Reset signal.");
defineReturnCode(ILLEGALINSTRUCTION, -11, "Illegal instruction.");
defineReturnCode(ILLEGALJUMP, -12, "Illegal jump address.");
defineReturnCode(INSTR_PAGEFAULT, -13, "Instruction page fault.");
defineReturnCode(LOAD_PAGEFAULT, -14, "Load page fault.");
defineReturnCode(STORE_PAGEFAULT, -15, "Store page fault.");
defineReturnCode(GDBNOERROR, -16,
                 "Has the same effect as NOERROR but allows exiting a block where NOERROR "
                 "would have continued block execution.");
defineReturnCode(SYSCALL, -17, "System call");
defineReturnCode(PAGEFAULT, -18, "Virtual memory tranlation fault.");
defineReturnCode(BREAKPOINT, -19, "Break point.");
defineReturnCode(CPUFINISHED, 1 << 31,
                 "Finished cpu execution. This is the proper way to exit from "
                 "etiss::CPUCore::execute.");
defineReturnCode(CPUTERMINATED, 0x80000001,
                 "Terminates cpu execution. this is the proper way to force an "
                 "exit from etiss::CPUCore::execute (e.g. by a debugger).");
defineReturnCode(JITERROR, -32, "Error in JIT.");
defineReturnCode(JITCOMPILATIONERROR, -33, "Error in JIT compilation.");
defineReturnCode(ARCHERROR, -34, "Error in architecture.");
defineReturnCode(EMULATIONNOTSUPPORTED, -35, "Emulation is not supported.");
defineReturnCode(INVALIDSYSTEM, -36,
                 "An ETISS_System structure doesn't contain "
                 "the neccessary function pointers.");
defineReturnCode(TEMPORARY0, -128, "");
defineReturnCode(TEMPORARY1, -129, "");
defineReturnCode(TEMPORARY2, -130, "");
defineReturnCode(TEMPORARY3, -131, "");
defineReturnCode(TEMPORARY4, -132, "");
defineReturnCode(TEMPORARY5, -133, "");
defineReturnCode(TEMPORARY6, -134, "");
defineReturnCode(TEMPORARY7, -135, "");
#define ETISS_RETURNCODE_TEMPORARY_COUNT 8
 
#endif