service/log/LogConfig.hpp

/*
 (c) Copyright, Real-Time Innovations, 2017-
 All rights reserved.

 No duplications, whole or partial, manual or electronic, may be made without
 express written permission.  Any such copies, or revisions thereof, must
 display this notice unaltered.

 This code contains trade secrets of Real-Time Innovations, Inc.
*/

#ifndef HPP_SERVICE_LOG_CONFIG_HPP_
#define HPP_SERVICE_LOG_CONFIG_HPP_

#include <cstdio>
#include <cstdarg>

#include "log/log_common.h"

#include <rti/config/Logger.hpp>
#include <rti/service/ServiceException.hpp>

#define RTI_SUBMODULE_MASK_ALL (0xFFFF)

namespace rti { namespace service { namespace log {

class LogConfig {
public:

    static LogConfig& instance()
    {
        static LogConfig singleton;
        return singleton;
    }

    RTILogBitmap instrumentation_mask() const
    {
        return instrumentation_mask_;
    }

    LogConfig& instrumentation_mask(RTILogBitmap logmask)
    {
        instrumentation_mask_ = logmask;
        return *this;
    }

    rti::config::Verbosity verbosity()
    {
        return static_cast<rti::config::Verbosity::type>(instrumentation_mask_);
    }

    void verbosity(rti::config::Verbosity verbosity)
    {
        instrumentation_mask(
                static_cast<RTILogBitmap>(verbosity.underlying()));
    }

    ~LogConfig()
    {
    }

    static RTILogBitmap mask_all()
    {
        return RTI_SUBMODULE_MASK_ALL;
    }

    static RTILogBitmap mask_none()
    {
        return 0;
    }

protected:

    // Constructor is private: this class is a singleton
    LogConfig()
        : instrumentation_mask_(RTI_LOG_BIT_EXCEPTION)
    {
          RTILog_printMask |= RTI_LOG_PRINT_BIT_AT_METHOD;
    }

    RTILogBitmap instrumentation_mask_;
};

inline
rti::config::Verbosity dds_verbosity_from_level(int32_t level)
{
    switch (level) {
    case 6:
        return rti::config::Verbosity::STATUS_REMOTE;
    case 5:
        /* no break */
    case 4:
        return rti::config::Verbosity::WARNING;
    case 3:
        /* no break */
    case 2:
        /* no break */
    case 1:
        return rti::config::Verbosity::EXCEPTION;
    case 0:
        return rti::config::Verbosity::SILENT;
    default:
        return rti::config::Verbosity::EXCEPTION;
    }
}

inline
rti::config::Verbosity service_verbosity_from_level(int32_t level)
{
    RTILogBitmap native_verbosity = RTI_LOG_BIT_SILENCE;

    switch (level) {
        /* no break */
    case 6:
         native_verbosity |= RTI_LOG_BIT_CONTENT;
        /* no break */
    case 5:
        native_verbosity |= RTI_LOG_BIT_PERIODIC;
        /* no break */
    case 4:
        /* no break */
        native_verbosity |= RTI_LOG_BIT_REMOTE;
    case 3:
        native_verbosity |= RTI_LOG_BIT_LOCAL;
        /* no break */
    case 2:
        native_verbosity |= RTI_LOG_BIT_WARN;
        /* no break */
    case 1:
        native_verbosity |= RTI_LOG_BIT_EXCEPTION;
        break;
    case 0:
        break;
    default:
        native_verbosity = RTI_LOG_BIT_EXCEPTION;
        break;
    }

    return static_cast<rti::config::Verbosity::type>(native_verbosity);

}

/*
 * Example:
 * MyCatcherMethod: caught exception from:
 *     MyThrowerMethod:!init failure
 */
inline void log_service_exception(
        rti::service::log::LogConfig& log_config,
        const rti::service::ServiceException& exception,
        const char *catch_context)
{
    RTILogMessage log_message;

    log_message.format = "caught exception from:\n    %s";
    log_message.logNumber = exception.error_code();

    RTILog_logWithContext(
            DEFINE_MODULE_NUMBER(MODULE_NS),
            log_config.instrumentation_mask(),
            RTI_SUBMODULE_MASK_ALL,
            RTI_LOG_BIT_EXCEPTION,
            RTI_SUBMODULE_MASK_ALL,
            catch_context,
            &log_message,
            exception.what());
}


} } } /* namespace rti::service::log */



/*
 * --- C-like logger macros ---------------------------------------------------
 */
#define SERVICELog_fromException(SERVICE_EXCEPTION) \
        rti::service::log::log_service_exception(\
                (MODULE_LOG_CONFIG), \
                SERVICE_EXCEPTION, \
                RTI_FUNCTION_NAME)

#define SERVICELog_freeForm(INSTRUMENT_BIT, ...) \
        RTILog_logFreeForm(\
                (MODULE_LOG_CONFIG).instrumentation_mask(), \
                RTI_SUBMODULE_MASK_ALL, \
                (INSTRUMENT_BIT), \
                RTI_SUBMODULE_MASK_ALL, \
                __VA_ARGS__)

#define SERVICELog_logMessage(INSTRUMENT_BIT, ...) \
        if ((RTILog_setLogLevel != NULL) \
                && ((MODULE_LOG_CONFIG).instrumentation_mask() & (INSTRUMENT_BIT)) \
                && RTI_SUBMODULE_MASK_ALL) {  \
            RTILog_setLogLevel((INSTRUMENT_BIT));  \
        } \
        if (((MODULE_LOG_CONFIG).instrumentation_mask() & ((INSTRUMENT_BIT))) \
                && RTI_SUBMODULE_MASK_ALL) \
            RTILog_printContextAndMsg(NULL, __VA_ARGS__)

#define SERVICELog_logWithMethodName(INSTRUMENT_BIT, ...) \
        RTILog_logWithContext(\
                DEFINE_MODULE_NUMBER(MODULE_NS), \
                (MODULE_LOG_CONFIG).instrumentation_mask(), \
                RTI_SUBMODULE_MASK_ALL, \
                (INSTRUMENT_BIT), \
                RTI_SUBMODULE_MASK_ALL, \
                __VA_ARGS__)

#define SERVICELog_exception( ...) \
        RTILog_log(\
                DEFINE_MODULE_NUMBER(MODULE_NS), \
                (MODULE_LOG_CONFIG).instrumentation_mask(), \
                RTI_SUBMODULE_MASK_ALL, \
                RTI_LOG_BIT_EXCEPTION, \
                RTI_SUBMODULE_MASK_ALL, \
                __VA_ARGS__)

#define SERVICELog_warn( ...) \
        RTILog_log(\
                DEFINE_MODULE_NUMBER(MODULE_NS), \
                (MODULE_LOG_CONFIG).instrumentation_mask(), \
                RTI_SUBMODULE_MASK_ALL, \
                RTI_LOG_BIT_WARN, \
                RTI_SUBMODULE_MASK_ALL, \
                __VA_ARGS__)

#define SERVICELog_local( ...) \
        RTILog_log(\
                DEFINE_MODULE_NUMBER(MODULE_NS), \
                (MODULE_LOG_CONFIG).instrumentation_mask(), \
                RTI_SUBMODULE_MASK_ALL, \
                RTI_LOG_BIT_LOCAL, \
                RTI_SUBMODULE_MASK_ALL, \
                __VA_ARGS__)

#define SERVICELog_content( ...) \
        RTILog_log(\
                DEFINE_MODULE_NUMBER(MODULE_NS), \
                (MODULE_LOG_CONFIG).instrumentation_mask(), \
                RTI_SUBMODULE_MASK_ALL, \
                RTI_LOG_BIT_CONTENT, \
                RTI_SUBMODULE_MASK_ALL, \
                __VA_ARGS__)

#define SERVICELog_remote( ...) \
        RTILog_log(\
                DEFINE_MODULE_NUMBER(MODULE_NS), \
                (MODULE_LOG_CONFIG).instrumentation_mask(), \
                RTI_SUBMODULE_MASK_ALL, \
                RTI_LOG_BIT_REMOTE, \
                RTI_SUBMODULE_MASK_ALL, \
                __VA_ARGS__)


#define SERVICELog_any(INSTRUMENT_BIT, ...) \
    if ((RTILog_setLogLevel != NULL) \
                && (((MODULE_LOG_CONFIG).instrumentation_mask()) & (INSTRUMENT_BIT)) \
                && ((RTI_SUBMODULE_MASK_ALL) & (RTI_SUBMODULE_MASK_ALL))) {  \
            RTILog_setLogLevel((INSTRUMENT_BIT)); \
        } \
    if ((((MODULE_LOG_CONFIG).instrumentation_mask()) & (INSTRUMENT_BIT)) \
            && ((RTI_SUBMODULE_MASK_ALL) & (RTI_SUBMODULE_MASK_ALL)))

#define SERVICELog_flushActivityContextWithAction(INSTRUMENT_BIT, ACTION) \
        if ((RTILog_setLogLevel != NULL) \
                && ((MODULE_LOG_CONFIG).instrumentation_mask() & (INSTRUMENT_BIT)) \
                && RTI_SUBMODULE_MASK_ALL) {  \
            RTILog_setLogLevel((INSTRUMENT_BIT));  \
        } \
        if (((MODULE_LOG_CONFIG).instrumentation_mask() & ((INSTRUMENT_BIT))) \
                && RTI_SUBMODULE_MASK_ALL) \
            RTILog_printContextAndMsg("", &RTI_LOG_ANY_s, (ACTION));

#define SERVICELog_flushActivityContext(INSTRUMENT_BIT) \
        SERVICELog_logMessage((INSTRUMENT_BIT), &RTI_LOG_ANY_s, "");

#endif /* HPP_SERVICE_LOG_CONFIG_HPP_ */