From a5c50a4f262f0a880734623f79d4dc2f1aa8a0a2 Mon Sep 17 00:00:00 2001 From: "Matthias P. Braendli" Date: Tue, 13 Aug 2019 10:29:39 +0200 Subject: Pull in files from odr-mmbtools-common Replace ASIO by simpler implementation, meaning that the telnet RC now only supports a single connection. Move Log, RC to lib/ --- lib/Log.h | 204 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 204 insertions(+) create mode 100644 lib/Log.h (limited to 'lib/Log.h') diff --git a/lib/Log.h b/lib/Log.h new file mode 100644 index 0000000..d5c39e0 --- /dev/null +++ b/lib/Log.h @@ -0,0 +1,204 @@ +/* + Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 + Her Majesty the Queen in Right of Canada (Communications Research + Center Canada) + + Copyright (C) 2018 + Matthias P. Braendli, matthias.braendli@mpb.li + + http://www.opendigitalradio.org + */ +/* + This file is part of the ODR-mmbTools. + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + */ + +#pragma once + +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "ThreadsafeQueue.h" + +#define SYSLOG_IDENT PACKAGE_NAME +#define SYSLOG_FACILITY LOG_LOCAL0 + +enum log_level_t {debug = 0, info, warn, error, alert, emerg, trace, discard}; + +static const std::string levels_as_str[] = + { " ", " ", "WARN ", "ERROR", "ALERT", "EMERG", "TRACE", "-----"} ; + +/** Abstract class all backends must inherit from */ +class LogBackend { + public: + virtual ~LogBackend() {}; + virtual void log(log_level_t level, const std::string& message) = 0; + virtual std::string get_name() const = 0; +}; + +/** A Logging backend for Syslog */ +class LogToSyslog : public LogBackend { + public: + LogToSyslog() : name("SYSLOG") { + openlog(SYSLOG_IDENT, LOG_PID, SYSLOG_FACILITY); + } + + virtual ~LogToSyslog() { + closelog(); + } + + void log(log_level_t level, const std::string& message); + + std::string get_name() const { return name; } + + private: + const std::string name; + + LogToSyslog(const LogToSyslog& other) = delete; + const LogToSyslog& operator=(const LogToSyslog& other) = delete; +}; + +class LogToFile : public LogBackend { + public: + LogToFile(const std::string& filename); + void log(log_level_t level, const std::string& message); + std::string get_name() const { return name; } + + private: + const std::string name; + + struct FILEDeleter{ void operator()(FILE* fd){ if(fd) fclose(fd);}}; + std::unique_ptr log_file; + + LogToFile(const LogToFile& other) = delete; + const LogToFile& operator=(const LogToFile& other) = delete; +}; + +class LogTracer : public LogBackend { + public: + LogTracer(const std::string& filename); + void log(log_level_t level, const std::string& message); + std::string get_name() const { return name; } + private: + std::string name; + uint64_t m_trace_micros_startup = 0; + + struct FILEDeleter{ void operator()(FILE* fd){ if(fd) fclose(fd);}}; + std::unique_ptr m_trace_file; + + LogTracer(const LogTracer& other) = delete; + const LogTracer& operator=(const LogTracer& other) = delete; +}; + +class LogLine; + +struct log_message_t { + log_message_t(log_level_t _level, std::string&& _message) : + level(_level), + message(move(_message)) {} + + log_message_t() : + level(debug), + message("") {} + + log_level_t level; + std::string message; +}; + +class Logger { + public: + Logger() { + m_io_thread = std::thread(&Logger::io_process, this); + } + + Logger(const Logger& other) = delete; + const Logger& operator=(const Logger& other) = delete; + ~Logger() { + m_message_queue.trigger_wakeup(); + m_io_thread.join(); + } + + void register_backend(std::shared_ptr backend); + + /* Log the message to all backends */ + void log(log_level_t level, const char* fmt, ...); + + void logstr(log_level_t level, std::string&& message); + + /* All logging IO is done in another thread */ + void io_process(void); + + /* Return a LogLine for the given level + * so that you can write etiLog.level(info) << "stuff = " << 21 */ + LogLine level(log_level_t level); + + private: + std::list > backends; + + ThreadsafeQueue m_message_queue; + std::thread m_io_thread; + std::mutex m_cerr_mutex; +}; + +extern Logger etiLog; + +// Accumulate a line of logs, using same syntax as stringstream +// The line is logged when the LogLine gets destroyed +class LogLine { + public: + LogLine(const LogLine& logline); + const LogLine& operator=(const LogLine& other) = delete; + LogLine(Logger* logger, log_level_t level) : + logger_(logger) + { + level_ = level; + } + + // Push the new element into the stringstream + template + LogLine& operator<<(T s) { + if (level_ != discard) { + os << s; + } + return *this; + } + + ~LogLine() + { + if (level_ != discard) { + logger_->logstr(level_, os.str()); + } + } + + private: + std::ostringstream os; + log_level_t level_; + Logger* logger_; +}; + -- cgit v1.2.3 From cb8cd168a26477b5c01e73e53b727bf8f5b225db Mon Sep 17 00:00:00 2001 From: "Matthias P. Braendli" Date: Mon, 2 Sep 2019 14:23:12 +0200 Subject: Apply b1fc144 from common --- Makefile.am | 1 + lib/Globals.cpp | 36 ++++++++++++++++++++++++++++++++++++ lib/Log.cpp | 33 +++++++++++++++++++++++---------- lib/Log.h | 14 +++++--------- lib/RemoteControl.cpp | 2 -- lib/RemoteControl.h | 2 ++ 6 files changed, 67 insertions(+), 21 deletions(-) create mode 100644 lib/Globals.cpp (limited to 'lib/Log.h') diff --git a/Makefile.am b/Makefile.am index 6691137..34d2d91 100644 --- a/Makefile.am +++ b/Makefile.am @@ -99,6 +99,7 @@ odr_dabmod_SOURCES = src/DabMod.cpp \ lib/RemoteControl.h \ lib/Log.cpp \ lib/Log.h \ + lib/Globals.cpp \ lib/INIReader.h \ lib/crc.h \ lib/crc.c \ diff --git a/lib/Globals.cpp b/lib/Globals.cpp new file mode 100644 index 0000000..6be26ec --- /dev/null +++ b/lib/Globals.cpp @@ -0,0 +1,36 @@ +/* + Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 + Her Majesty the Queen in Right of Canada (Communications Research + Center Canada) + + Copyright (C) 2019 + Matthias P. Braendli, matthias.braendli@mpb.li + + http://www.opendigitalradio.org + */ +/* + This file is part of the ODR-mmbTools. + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + */ + +/* Ensure construction and destruction of static globals in the right order */ + +#include "Log.h" +#include "RemoteControl.h" + +// the RC needs logging, and needs to be initialised later. +Logger etiLog; +RemoteControllers rcs; + diff --git a/lib/Log.cpp b/lib/Log.cpp index 2417f3a..abbd69a 100644 --- a/lib/Log.cpp +++ b/lib/Log.cpp @@ -34,12 +34,23 @@ using namespace std; -/* etiLog is a singleton used in all parts of the program to output log messages. - */ -Logger etiLog; + +Logger::Logger() +{ + m_io_thread = std::thread(&Logger::io_process, this); +} + +Logger::~Logger() { + m_message_queue.trigger_wakeup(); + m_io_thread.join(); + + std::lock_guard guard(m_backend_mutex); + backends.clear(); +} void Logger::register_backend(std::shared_ptr backend) { + std::lock_guard guard(m_backend_mutex); backends.push_back(backend); } @@ -75,7 +86,7 @@ void Logger::logstr(log_level_t level, std::string&& message) { if (level == discard) { return; - } + } log_message_t m(level, move(message)); m_message_queue.push(move(m)); @@ -101,13 +112,15 @@ void Logger::io_process() message.resize(message.length()-1); } - for (auto &backend : backends) { - backend->log(m.level, message); - } + { + std::lock_guard guard(m_backend_mutex); + for (auto &backend : backends) { + backend->log(m.level, message); + } - if (m.level != log_level_t::trace) { - std::lock_guard guard(m_cerr_mutex); - std::cerr << levels_as_str[m.level] << " " << message << std::endl; + if (m.level != log_level_t::trace) { + std::cerr << levels_as_str[m.level] << " " << message << std::endl; + } } } } diff --git a/lib/Log.h b/lib/Log.h index d5c39e0..f20e698 100644 --- a/lib/Log.h +++ b/lib/Log.h @@ -133,16 +133,10 @@ struct log_message_t { class Logger { public: - Logger() { - m_io_thread = std::thread(&Logger::io_process, this); - } - + Logger(); Logger(const Logger& other) = delete; const Logger& operator=(const Logger& other) = delete; - ~Logger() { - m_message_queue.trigger_wakeup(); - m_io_thread.join(); - } + ~Logger(); void register_backend(std::shared_ptr backend); @@ -163,9 +157,11 @@ class Logger { ThreadsafeQueue m_message_queue; std::thread m_io_thread; - std::mutex m_cerr_mutex; + std::mutex m_backend_mutex; }; +/* etiLog is a singleton used in all parts of the program to output log messages. + * It is constructed in Globals.cpp */ extern Logger etiLog; // Accumulate a line of logs, using same syntax as stringstream diff --git a/lib/RemoteControl.cpp b/lib/RemoteControl.cpp index 878af59..4adb90c 100644 --- a/lib/RemoteControl.cpp +++ b/lib/RemoteControl.cpp @@ -32,8 +32,6 @@ using namespace std; -RemoteControllers rcs; - RemoteControllerTelnet::~RemoteControllerTelnet() { m_active = false; diff --git a/lib/RemoteControl.h b/lib/RemoteControl.h index bd88f82..2358b3a 100644 --- a/lib/RemoteControl.h +++ b/lib/RemoteControl.h @@ -149,6 +149,8 @@ class RemoteControllers { std::list > m_controllers; }; +/* rcs is a singleton used in all parts of the program to interact with the RC. + * It is constructed in Globals.cpp */ extern RemoteControllers rcs; /* Implements a Remote controller based on a simple telnet CLI -- cgit v1.2.3