logger.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2017 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
22 #ifndef NDN_UTIL_LOGGER_HPP
23 #define NDN_UTIL_LOGGER_HPP
24 
25 #include "../common.hpp"
26 
27 #ifdef HAVE_NDN_CXX_CUSTOM_LOGGER
28 #include "ndn-cxx-custom-logger.hpp"
29 #else
30 
31 #include <boost/log/common.hpp>
32 #include <boost/log/sources/logger.hpp>
33 #include <atomic>
34 
35 namespace ndn {
36 namespace util {
37 
40 enum class LogLevel {
41  FATAL = -1,
42  NONE = 0,
43  ERROR = 1,
44  WARN = 2,
45  INFO = 3,
46  DEBUG = 4,
47  TRACE = 5,
48  ALL = 255
49 };
50 
54 std::ostream&
55 operator<<(std::ostream& os, LogLevel level);
56 
61 parseLogLevel(const std::string& s);
62 
66 class Logger : public boost::log::sources::logger_mt
67 {
68 public:
69  explicit
70  Logger(const std::string& name);
71 
72  const std::string&
73  getModuleName() const
74  {
75  return m_moduleName;
76  }
77 
78  bool
79  isLevelEnabled(LogLevel level) const
80  {
81  return m_currentLevel.load(std::memory_order_relaxed) >= level;
82  }
83 
84  void
86  {
87  m_currentLevel.store(level, std::memory_order_relaxed);
88  }
89 
90 private:
91  const std::string m_moduleName;
92  std::atomic<LogLevel> m_currentLevel;
93 };
94 
101 #define NDN_LOG_INIT(name) \
102  namespace { \
103  inline ::ndn::util::Logger& getNdnCxxLogger() \
104  { \
105  static ::ndn::util::Logger logger(BOOST_STRINGIZE(name)); \
106  return logger; \
107  } \
108  } \
109  struct ndn_cxx__allow_trailing_semicolon
110 
117 {
118 };
119 
123 std::ostream&
124 operator<<(std::ostream& os, const LoggerTimestamp&);
125 
126 #if (BOOST_VERSION >= 105900) && (BOOST_VERSION < 106000)
127 // workaround Boost bug 11549
128 #define NDN_BOOST_LOG(x) BOOST_LOG(x) << ""
129 #else
130 #define NDN_BOOST_LOG(x) BOOST_LOG(x)
131 #endif
132 
133 #define NDN_LOG(lvl, lvlstr, expression) \
134  do { \
135  if (getNdnCxxLogger().isLevelEnabled(::ndn::util::LogLevel::lvl)) { \
136  NDN_BOOST_LOG(getNdnCxxLogger()) << ::ndn::util::LoggerTimestamp{} \
137  << " " BOOST_STRINGIZE(lvlstr) ": [" << getNdnCxxLogger().getModuleName() << "] " \
138  << expression; \
139  } \
140  } while (false)
141 
145 #define NDN_LOG_TRACE(expression) NDN_LOG(TRACE, TRACE, expression)
146 
150 #define NDN_LOG_DEBUG(expression) NDN_LOG(DEBUG, DEBUG, expression)
151 
155 #define NDN_LOG_INFO(expression) NDN_LOG(INFO, INFO, expression)
156 
160 #define NDN_LOG_WARN(expression) NDN_LOG(WARN, WARNING, expression)
161 
165 #define NDN_LOG_ERROR(expression) NDN_LOG(ERROR, ERROR, expression)
166 
170 #define NDN_LOG_FATAL(expression) NDN_LOG(FATAL, FATAL, expression)
171 
172 } // namespace util
173 } // namespace ndn
174 
175 #endif // HAVE_NDN_CXX_CUSTOM_LOGGER
176 
177 #endif // NDN_UTIL_LOGGER_HPP
Copyright (c) 2013-2017 Regents of the University of California.
Definition: common.hpp:66
trace messages (most verbose)
serious error messages
std::ostream & operator<<(std::ostream &os, LogLevel level)
output LogLevel as string
Definition: logger.cpp:34
a tag that writes a timestamp upon stream output
Definition: logger.hpp:116
informational messages
LogLevel
indicates the severity level of a log message
Definition: logger.hpp:40
LogLevel parseLogLevel(const std::string &s)
parse LogLevel from string
Definition: logger.cpp:59
warning messages
represents a logger in logging facility
Definition: logger.hpp:66
fatal (will be logged unconditionally)
const std::string & getModuleName() const
Definition: logger.hpp:73
void setLevel(LogLevel level)
Definition: logger.hpp:85
bool isLevelEnabled(LogLevel level) const
Definition: logger.hpp:79