logger.h

Go to the documentation of this file.

/* Copyright 2013-present Barefoot Networks, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
/*
 * Antonin Bas (antonin@barefootnetworks.com)
 *
 */
 
 
#ifndef BM_BM_SIM_LOGGER_H_
#define BM_BM_SIM_LOGGER_H_
 
#include <bm/config.h>
#include <bm/spdlog/spdlog.h>
 
#include <iosfwd>
#include <string>
 
namespace bm {
 
class Logger {
 public:
  enum class LogLevel {
    TRACE, DEBUG, INFO, NOTICE, WARN, ERROR, CRITICAL, ALERT, EMERG, OFF
  };
 
 public:
  static spdlog::logger *get() {
    static spdlog::logger *logger_ = init_logger();
    (void) logger_;
    return logger;
  }
 
  static void set_log_level(LogLevel level);
 
  static void set_logger_console();
 
  static void set_logger_file(const std::string &filename,
                              bool force_flush = false,
                              size_t max_size = 1024 * 1024 * 5,
                              size_t max_files = 3);
 
  // NOLINTNEXTLINE(runtime/references)
  static void set_logger_ostream(std::ostream &os);
 
  static void unset_logger();
 
 private:
  static spdlog::logger *init_logger();
 
  static spdlog::level::level_enum to_spd_level(LogLevel level);
 
  static void set_pattern();
 
 private:
  static spdlog::logger *logger;
};
 
}  // namespace bm
 
#ifdef BM_LOG_DEBUG_ON
#define BMLOG_DEBUG(...) bm::Logger::get()->debug(__VA_ARGS__);
#else
#define BMLOG_DEBUG(...)
#endif
 
#ifdef BM_LOG_TRACE_ON
#define BMLOG_TRACE(...) bm::Logger::get()->trace(__VA_ARGS__);
#else
#define BMLOG_TRACE(...)
#endif
 
#define BMLOG_DEBUG_PKT(pkt, s, ...)                     \
  BMLOG_DEBUG("[{}] [cxt {}] " s, (pkt).get_unique_id(), \
              (pkt).get_context(), ##__VA_ARGS__)
#define BMLOG_TRACE_PKT(pkt, s, ...)                     \
  BMLOG_TRACE("[{}] [cxt {}] " s, (pkt).get_unique_id(), \
              (pkt).get_context(), ##__VA_ARGS__)
#define BMLOG_TRACE_SI_PKT(pkt, source_info, s, ...)       \
  BMLOG_TRACE("[{}] [cxt {}] {}" s, (pkt).get_unique_id(), \
              (pkt).get_context(),                         \
              (source_info == nullptr) ? ""                \
                : (source_info->to_string() + " "),        \
              ##__VA_ARGS__)
 
#define BMLOG_ERROR(...) bm::Logger::get()->error(__VA_ARGS__)
 
#define BMLOG_ERROR_PKT(pkt, s, ...)                                    \
  bm::Logger::get()->error("[{}] [cxt {}] " s, (pkt).get_unique_id(),   \
                           (pkt).get_context(), ##__VA_ARGS__)
 
#endif  // BM_BM_SIM_LOGGER_H_