summaryrefslogtreecommitdiff
path: root/src/components/include/utils/logger.h
blob: 50d194245cda638f018c3887b36a37021233912b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
/*
 * Copyright (c) 2014, Ford Motor Company
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the Ford Motor Company nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */



#ifndef SRC_COMPONENTS_UTILS_INCLUDE_UTILS_LOGGER_H_
#define SRC_COMPONENTS_UTILS_INCLUDE_UTILS_LOGGER_H_

#ifdef ENABLE_LOG
  #include <errno.h>
  #include <string.h>
  #include <sstream>
  #include <log4cxx/propertyconfigurator.h>
  #include <log4cxx/spi/loggingevent.h>
  #include "utils/push_log.h"
  #include "utils/logger_status.h"
  #include "utils/auto_trace.h"
#endif  // ENABLE_LOG

#ifdef ENABLE_LOG

    #define CREATE_LOGGERPTR_GLOBAL(logger_var, logger_name) \
      namespace { \
        CREATE_LOGGERPTR_LOCAL(logger_var, logger_name); \
      }

    #define CREATE_LOGGERPTR_LOCAL(logger_var, logger_name) \
      log4cxx::LoggerPtr logger_var = log4cxx::LoggerPtr(log4cxx::Logger::getLogger(logger_name));

    #define INIT_LOGGER(file_name) \
      log4cxx::PropertyConfigurator::configure(file_name);

    // Logger deinitilization function and macro, need to stop log4cxx writing
    // without this deinitilization log4cxx threads continue using some instances destroyed by exit()
    void deinit_logger ();
    #define DEINIT_LOGGER() deinit_logger()

    #define LOG4CXX_IS_TRACE_ENABLED(logger) logger->isTraceEnabled()

    log4cxx_time_t time_now();

    #define LOG_WITH_LEVEL(loggerPtr, logLevel, logEvent) \
    do { \
      if (logger::logger_status != logger::DeletingLoggerThread) { \
        if (loggerPtr->isEnabledFor(logLevel)) { \
          std::stringstream accumulator; \
          accumulator << logEvent; \
          logger::push_log(loggerPtr, logLevel, accumulator.str(), time_now(), \
                           LOG4CXX_LOCATION, ::log4cxx::spi::LoggingEvent::getCurrentThreadName()); \
        } \
      } \
    } while (false)

    #undef LOG4CXX_INFO
    #define LOG4CXX_INFO(loggerPtr, logEvent) LOG_WITH_LEVEL(loggerPtr, ::log4cxx::Level::getInfo(), logEvent)

    #define LOG4CXX_INFO_EXT(logger, logEvent) LOG4CXX_INFO(logger, __PRETTY_FUNCTION__ << ": " << logEvent)
    #define LOG4CXX_INFO_STR_EXT(logger, logEvent) LOG4CXX_INFO_STR(logger, __PRETTY_FUNCTION__ << ": " << logEvent)

    #define LOG4CXX_TRACE_EXT(logger, logEvent) LOG4CXX_TRACE(logger, __PRETTY_FUNCTION__ << ": " << logEvent)
    #define LOG4CXX_TRACE_STR_EXT(logger, logEvent) LOG4CXX_TRACE_STR(logger, __PRETTY_FUNCTION__ << ": " << logEvent)

    #undef LOG4CXX_DEBUG
    #define LOG4CXX_DEBUG(loggerPtr, logEvent) LOG_WITH_LEVEL(loggerPtr, ::log4cxx::Level::getDebug(), logEvent)

    #define LOG4CXX_DEBUG_EXT(logger, logEvent) LOG4CXX_DEBUG(logger, __PRETTY_FUNCTION__ << ": " << logEvent)
    #define LOG4CXX_DEBUG_STR_EXT(logger, logEvent) LOG4CXX_DEBUG_STR(logger, __PRETTY_FUNCTION__ << ": " << logEvent)

    #undef LOG4CXX_WARN
    #define LOG4CXX_WARN(loggerPtr, logEvent) LOG_WITH_LEVEL(loggerPtr, ::log4cxx::Level::getWarn(), logEvent)

    #define LOG4CXX_WARN_EXT(logger, logEvent) LOG4CXX_WARN(logger, __PRETTY_FUNCTION__ << ": " << logEvent)
    #define LOG4CXX_WARN_STR_EXT(logger, logEvent) LOG4CXX_WARN_STR(logger, __PRETTY_FUNCTION__ << ": " << logEvent)

    #undef LOG4CXX_ERROR
    #define LOG4CXX_ERROR(loggerPtr, logEvent) LOG_WITH_LEVEL(loggerPtr, ::log4cxx::Level::getError(), logEvent)

    #define LOG4CXX_ERROR_EXT(logger, logEvent) LOG4CXX_ERROR(logger, __PRETTY_FUNCTION__ << ": " << logEvent)
    #define LOG4CXX_ERROR_STR_EXT(logger, logEvent) LOG4CXX_ERROR_STR(logger, __PRETTY_FUNCTION__ << ": " << logEvent)

    #undef LOG4CXX_FATAL
    #define LOG4CXX_FATAL(loggerPtr, logEvent) LOG_WITH_LEVEL(loggerPtr, ::log4cxx::Level::getFatal(), logEvent)

    #define LOG4CXX_FATAL_EXT(logger, logEvent) LOG4CXX_FATAL(logger, __PRETTY_FUNCTION__ << ": " << logEvent)
    #define LOG4CXX_FATAL_STR_EXT(logger, logEvent) LOG4CXX_FATAL_STR(logger, __PRETTY_FUNCTION__ << ": " << logEvent)

    #undef LOG4CXX_TRACE
    #define LOG4CXX_TRACE(loggerPtr, logEvent) LOG_WITH_LEVEL(loggerPtr, ::log4cxx::Level::getTrace(), logEvent)

    #define LOG4CXX_AUTO_TRACE_WITH_NAME_SPECIFIED(loggerPtr, auto_trace) logger::AutoTrace auto_trace(loggerPtr, LOG4CXX_LOCATION)
    #define LOG4CXX_AUTO_TRACE(loggerPtr) LOG4CXX_AUTO_TRACE_WITH_NAME_SPECIFIED(loggerPtr, SDL_local_auto_trace_object)

    #define LOG4CXX_ERROR_WITH_ERRNO(logger, message) \
      LOG4CXX_ERROR(logger, message << ", error code " << errno << " (" << strerror(errno) << ")")

     #define LOG4CXX_WARN_WITH_ERRNO(logger, message) \
       LOG4CXX_WARN(logger, message << ", error code " << errno << " (" << strerror(errno) << ")")

#else // ENABLE_LOG is OFF

    #define CREATE_LOGGERPTR_GLOBAL(logger_var, logger_name)

    #define CREATE_LOGGERPTR_LOCAL(logger_var, logger_name)

    #define INIT_LOGGER(file_name)

    #define DEINIT_LOGGER(file_name)

    #define LOG4CXX_IS_TRACE_ENABLED(logger) false

    #undef LOG4CXX_INFO
    #define LOG4CXX_INFO(x,y)

    #undef LOG4CXX_WARN
    #define LOG4CXX_WARN(x,y)

    #undef LOG4CXX_ERROR
    #define LOG4CXX_ERROR(x,y)

    #undef LOG4CXX_ERROR_WITH_ERRNO
    #define LOG4CXX_ERROR_WITH_ERRNO(x,y)

    #undef LOG4CXX_WARN_WITH_ERRNO
    #define LOG4CXX_WARN_WITH_ERRNO(x,y)

    #undef LOG4CXX_TRACE
    #define LOG4CXX_TRACE(x,y)

    #undef LOG4CXX_DEBUG
    #define LOG4CXX_DEBUG(x,y)

    #undef LOG4CXX_FATAL
    #define LOG4CXX_FATAL(x,y)

    #define LOG4CXX_INFO_EXT(logger, logEvent)
    #define LOG4CXX_INFO_STR_EXT(logger, logEvent)

    #define LOG4CXX_TRACE_EXT(logger, logEvent)
    #define LOG4CXX_TRACE_STR_EXT(logger, logEvent)

    #define LOG4CXX_DEBUG_EXT(logger, logEvent)
    #define LOG4CXX_DEBUG_STR_EXT(logger, logEvent)

    #define LOG4CXX_WARN_EXT(logger, logEvent)
    #define LOG4CXX_WARN_STR_EXT(logger, logEvent)

    #define LOG4CXX_ERROR_EXT(logger, logEvent)
    #define LOG4CXX_ERROR_STR_EXT(logger, logEvent)

    #define LOG4CXX_FATAL_EXT(logger, logEvent)
    #define LOG4CXX_FATAL_STR_EXT(logger, logEvent)

    #define LOG4CXX_AUTO_TRACE_WITH_NAME_SPECIFIED(loggerPtr, auto_trace)
    #define LOG4CXX_AUTO_TRACE(loggerPtr)
#endif  // ENABLE_LOG

#endif  // SRC_COMPONENTS_UTILS_INCLUDE_UTILS_LOGGER_H_