Program Listing for File mlog.h

Program Listing for File mlog.h#

↰ Return to documentation for file (src/util/mlog.h)

#ifndef __MLOG_H__
#define __MLOG_H__
#include <stddef.h>
#include <stdlib.h>
#include<string>
#include<iostream>

//logging levels
typedef enum MLOG_LEVEL{
  MLOG_LEVEL_FAIL = 0,
  MLOG_LEVEL_FATAL,
  MLOG_LEVEL_ERROR,
  MLOG_LEVEL_WARN,
  MLOG_LEVEL_NONE,   //internal value 4, user verbose level 0 in --rose:verbose cmdline options
  MLOG_LEVEL_KEY,    //internal value 5, user verbose level 1
  MLOG_LEVEL_INFO,   //internal value 6, user verbose level 2
  MLOG_LEVEL_MARCH,  //internal value 7, user verbose level 3
  MLOG_LEVEL_TRACE,  //internal value 8, user verbose level 4
  MLOG_LEVEL_DEBUG,
  MLOG_LEVEL_UNDEFINED,
} MLOG_LEVEL_t;

//logging subjects, which are one word names
#define MLOG_INIT   "INIT"
#define MLOG_MISC   "MISC"
#define MLOG_DRIVER   "DRIVER"
#define MLOG_EDG      "EDG"
#define MLOG_EDG2SAGE   "EDG2SAGE"
#define MLOG_OFP      "OFP"
#define MLOG_OFP2SAGE   "OFP2SAGE"
#define MLOG_OMPPARSER    "OMPPARSER"
#define MLOG_OMP2SAGE   "OMP2SAGE"
#define MLOG_ROSETTA    "ROSETTA"
#define MLOG_FRONTEND   "FRONTEND"
#define MLOG_MIDEND   "MIDEND"
#define MLOG_BACKEND    "BACKEND"
#define MLOG_UNPARSER   "UNPARSER"
#define MLOG_SAGEINTERFACE  "sageInterface"

/* set the current log level */
#define DEFAULT_MLOG_LEVEL MLOG_LEVEL_NONE
extern int  mlogLevel; //The current mlog level setting to control which level (KEY/INFO/MARCH/TRACE) info is spit out
extern void mlog_C(MLOG_LEVEL_t level, const char * subject, const char * file, int line, const char * funcname, const char * format, ...);
#if __cplusplus >= 201103L
[[noreturn]]
#endif
extern void mlogAssertFail_C(const char * subject, const char * expr, const char * file, int line, const char * funcname, const char * format, ...);
extern void mlogMore_C(const char * format, ...);
extern const char * mlogLevelToString_C[];
extern std::string mlogLevelToString_CXX(MLOG_LEVEL_t level);

#define WHEREARG __FILE__,__LINE__, __func__

//C-style API for mandatory fatal/error/warning/debugging mlogging
#define MLOG_FATAL_C(SUBJECT, ...) mlog_C(MLOG_LEVEL_FATAL, SUBJECT, WHEREARG, __VA_ARGS__)
#define MLOG_ERROR_C(SUBJECT, ...) mlog_C(MLOG_LEVEL_ERROR, SUBJECT, WHEREARG, __VA_ARGS__)
#define MLOG_WARN_C(SUBJECT, ...)  mlog_C(MLOG_LEVEL_WARN,  SUBJECT, WHEREARG, __VA_ARGS__)
#define MLOG_DEBUG_C(SUBJECT,...)  mlog_C(MLOG_LEVEL_DEBUG, SUBJECT, WHEREARG, __VA_ARGS__)
#define MLOG_FATAL_MORE_C(...) mlogMore_C(__VA_ARGS__)
#define MLOG_ERROR_MORE_C(...) mlogMore_C(__VA_ARGS__)
#define MLOG_WARN_MORE_C(...)  mlogMore_C(__VA_ARGS__)
#define MLOG_DEBUG_MORE_C(...)  mlogMore_C(__VA_ARGS__)

#define MLOG_LEVEL_C(level, subject, ...) \
  (level > mlogLevel) ? static_cast<void>(0) : mlog_C(level, subject, WHEREARG, __VA_ARGS__)
#define MLOG_LEVEL_MORE_C(level, ...) \
  (level > mlogLevel) ? static_cast<void>(0) : mlogMore_C(__VA_ARGS__)

//C-style API, i.e. printf style for optional key/info/march/trace mlogging controlled by mlogLevel
#define MLOG_KEY_C(SUBJECT,...)   MLOG_LEVEL_C(MLOG_LEVEL_KEY,   SUBJECT, __VA_ARGS__)
#define MLOG_INFO_C(SUBJECT,...)  MLOG_LEVEL_C(MLOG_LEVEL_INFO,  SUBJECT, __VA_ARGS__)
#define MLOG_MARCH_C(SUBJECT,...) MLOG_LEVEL_C(MLOG_LEVEL_MARCH, SUBJECT, __VA_ARGS__)
#define MLOG_TRACE_C(SUBJECT,...) MLOG_LEVEL_C(MLOG_LEVEL_TRACE, SUBJECT, __VA_ARGS__)
#define MLOG_KEY_MORE_C(...)    MLOG_LEVEL_MORE_C(MLOG_LEVEL_KEY, __VA_ARGS__)
#define MLOG_INFO_MORE_C(...)     MLOG_LEVEL_MORE_C(MLOG_LEVEL_INFO, __VA_ARGS__)
#define MLOG_MARCH_MORE_C(...)    MLOG_LEVEL_MORE_C(MLOG_LEVEL_MARCH, __VA_ARGS__)
#define MLOG_TRACE_MORE_C(...)    MLOG_LEVEL_MORE_C(MLOG_LEVEL_TRACE, __VA_ARGS__)

//C-style API to use for fatal/error/warning that is conditioned by the provided expression
#define MLOG_CHECK_WARN_RETURN_C(cond, subject, ... ) \
  if (cond) {mlog_C(MLOG_LEVEL_WARN, subject, WHEREARG, __VA_ARGS__); return; }
#define MLOG_CHECK_ERROR_ABORT_C(cond, subject, ... ) \
  if (cond) {mlog_C(MLOG_LEVEL_ERROR, subject, WHEREARG, __VA_ARGS__); abort(); }
#define MLOG_CHECK_FATAL_ABORT_C(cond, subject, ... ) \
  if(cond) {mlog_C(MLOG_LEVEL_FATAL, subject, WHEREARG, __VA_ARGS__); abort(); }

/**************** for C++-style API, i.e. using cerr <<< ***************************************/
#define MLOG_LEVEL_HEADER_CXX(level, subject) std::cerr << mlogLevelToString_CXX(level) << ": " \
    << subject << " [" << __FILE__ << ":" << __LINE__<< "," << __func__ << "]\033[0m "
#define MLOG_LEVEL_CXX(level, subject) (level > mlogLevel) ? std::cerr : MLOG_LEVEL_HEADER_CXX(level, subject)

//*__MORE_CXX API is used to add more lines for the mlog msg that is already started by MLOG_*_CXX
#define MLOG_MORE_CXX() std::cerr << "\t"
#define MLOG_LEVEL_MORE_CXX(level) (level > mlogLevel) ? std::cerr : std::cerr << "\t"

//C++-style API for mandatory fatal/error/warning/debugging mlogging
#define MLOG_FATAL_CXX(SUBJECT) MLOG_LEVEL_HEADER_CXX(MLOG_LEVEL_FATAL, SUBJECT)
#define MLOG_ERROR_CXX(SUBJECT) MLOG_LEVEL_HEADER_CXX(MLOG_LEVEL_ERROR, SUBJECT)
#define MLOG_WARN_CXX(SUBJECT)  MLOG_LEVEL_HEADER_CXX(MLOG_LEVEL_WARN,  SUBJECT)
#define MLOG_DEBUG_CXX(SUBJECT) MLOG_LEVEL_HEADER_CXX(MLOG_LEVEL_DEBUG,  SUBJECT)
#define MLOG_FATAL_MORE_CXX()   MLOG_MORE_CXX()
#define MLOG_ERROR_MORE_CXX()   MLOG_MORE_CXX()
#define MLOG_WARN_MORE_CXX()    MLOG_MORE_CXX()
#define MLOG_DEBUG_MORE_CXX()   MLOG_MORE_CXX()

//C++-style API for optional key/info/march/trace mlogging controlled by mlogLevel
#define MLOG_KEY_CXX(SUBJECT)      MLOG_LEVEL_CXX(MLOG_LEVEL_KEY, SUBJECT)
#define MLOG_INFO_CXX(SUBJECT)     MLOG_LEVEL_CXX(MLOG_LEVEL_INFO, SUBJECT)
#define MLOG_MARCH_CXX(SUBJECT)    MLOG_LEVEL_CXX(MLOG_LEVEL_MARCH,  SUBJECT)
#define MLOG_TRACE_CXX(SUBJECT)    MLOG_LEVEL_CXX(MLOG_LEVEL_TRACE,  SUBJECT)
#define MLOG_KEY_MORE_CXX()        MLOG_LEVEL_MORE_CXX(MLOG_LEVEL_KEY)
#define MLOG_INFO_MORE_CXX()       MLOG_LEVEL_MORE_CXX(MLOG_LEVEL_INFO)
#define MLOG_MARCH_MORE_CXX()      MLOG_LEVEL_MORE_CXX(MLOG_LEVEL_MARCH)
#define MLOG_TRACE_MORE_CXX()      MLOG_LEVEL_MORE_CXX(MLOG_LEVEL_TRACE)

#define ASSERT_require(expr) ASSERT_require2(expr, "")
#define ASSERT_require2(expr, ...)         \
    (expr) ? static_cast<void>(0) : mlogAssertFail_C("ASSERTION:require:", #expr, WHEREARG, __VA_ARGS__)


#define ASSERT_forbid(expr) ASSERT_forbid2(expr, "")
#define ASSERT_forbid2(expr, ...)         \
    (!(expr)) ? static_cast<void>(0) : mlogAssertFail_C("ASSERTION:forbidden:", #expr, WHEREARG, __VA_ARGS__)

#define ASSERT_not_null(expr) ASSERT_not_null2(expr, "")
#define ASSERT_not_null2(expr, ...)        \
    ((expr) != NULL) ? static_cast<void>(0) : mlogAssertFail_C("ASSERTION:NULL pointer:", #expr, WHEREARG, __VA_ARGS__)

//A more informative approach for assert and abort than the standard assert/abort
#define ROSE_ASSERT ASSERT_require
#define ROSE_ABORT() mlogAssertFail_C("ABORT:", "", WHEREARG, "")

#define ASSERT_not_reachable(...)      mlogAssertFail_C("reached impossible state:", "", WHEREARG, __VA_ARGS__)
#define ASSERT_not_implemented(...)    mlogAssertFail_C("not implemented yet:", "", WHEREARG, __VA_ARGS__)

#endif /* __MLOGG_H__ */