From 3da1f8352e337fb032bf7a58c2909d3ba918e237 Mon Sep 17 00:00:00 2001 From: Pau Espin Pedrol Date: Tue, 20 Feb 2018 20:01:10 +0100 Subject: [PATCH] Logger: Use libosmocore logging system We still need an intermediate class Logger due to osmo-trx being multi-threaded and requiring to have a lock to use libosmocore, which is not thread safe. Change-Id: I30baac89f53e927f8699d0586b43cccf88ecd493 --- CommonLibs/Logger.cpp | 73 ++---------------------------------- CommonLibs/Logger.h | 64 ++++++++++++------------------- CommonLibs/Makefile.am | 2 +- Transceiver52M/osmo-trx.cpp | 15 ++------ tests/CommonLibs/LogTest.cpp | 42 ++++++++++++++------- tests/CommonLibs/LogTest.err | 27 ++----------- tests/CommonLibs/LogTest.ok | 29 -------------- tests/CommonLibs/Makefile.am | 3 +- 8 files changed, 65 insertions(+), 190 deletions(-) diff --git a/CommonLibs/Logger.cpp b/CommonLibs/Logger.cpp index 4c2a2d37..ac3de42d 100644 --- a/CommonLibs/Logger.cpp +++ b/CommonLibs/Logger.cpp @@ -1,7 +1,5 @@ /* -* Copyright 2009, 2010 Free Software Foundation, Inc. -* Copyright 2010 Kestrel Signal Processing, Inc. -* Copyright 2011, 2012 Range Networks, Inc. +* Copyright (C) 2018 sysmocom - s.f.m.c. GmbH * * * This software is distributed under the terms of the GNU Affero Public License. @@ -39,55 +37,6 @@ using namespace std; Mutex gLogToLock; -// Global log level threshold: -int config_log_level; - -/** Names of the logging levels. */ -const char *levelNames[] = { - "EMERG", "ALERT", "CRIT", "ERR", "WARNING", "NOTICE", "INFO", "DEBUG" -}; -int numLevels = 8; - - -int levelStringToInt(const string& name) -{ - // Reverse search, since the numerically larger levels are more common. - for (int i=numLevels-1; i>=0; i--) { - if (name == levelNames[i]) return i; - } - - // Common substitutions. - if (name=="INFORMATION") return 6; - if (name=="WARN") return 4; - if (name=="ERROR") return 3; - if (name=="CRITICAL") return 2; - if (name=="EMERGENCY") return 0; - - // Unknown level. - return -1; -} - -static std::string format(const char *fmt, ...) -{ - va_list ap; - char buf[300]; - va_start(ap,fmt); - int n = vsnprintf(buf,300,fmt,ap); - va_end(ap); - if (n >= (300-4)) { strcpy(&buf[(300-4)],"..."); } - return std::string(buf); -} - -const std::string timestr() -{ - struct timeval tv; - struct tm tm; - gettimeofday(&tv,NULL); - localtime_r(&tv.tv_sec,&tm); - unsigned tenths = tv.tv_usec / 100000; // Rounding down is ok. - return format(" %02d:%02d:%02d.%1d",tm.tm_hour,tm.tm_min,tm.tm_sec,tenths); -} - std::ostream& operator<<(std::ostream& os, std::ostringstream& ss) { return os << ss.str(); @@ -95,34 +44,18 @@ std::ostream& operator<<(std::ostream& os, std::ostringstream& ss) Log::~Log() { - // Anything at or above LOG_CRIT is an "alarm". - if (mPriority <= LOG_ERR) { - cerr << mStream.str() << endl; - } - int mlen = mStream.str().size(); int neednl = (mlen==0 || mStream.str()[mlen-1] != '\n'); + const char *fmt = neednl ? "%s\n" : "%s"; ScopedLock lock(gLogToLock); // The COUT() macro prevents messages from stomping each other but adds uninteresting thread numbers, // so just use std::cout. - std::cout << mStream.str(); - if (neednl) std::cout<<"\n"; + LOGP(mCategory, mPriority, fmt, mStream.str().c_str()); } ostringstream& Log::get() { - assert(mPriority #include -extern int config_log_level; +extern "C" { +#include +#include "debug.h" +} -#define LOG_EMERG 0 /* system is unusable */ -#define LOG_ALERT 1 /* action must be taken immediately */ -#define LOG_CRIT 2 /* critical conditions */ -#define LOG_ERR 3 /* error conditions */ -#define LOG_WARNING 4 /* warning conditions */ -#define LOG_NOTICE 5 /* normal but significant condition */ -#define LOG_INFO 6 /* informational */ -#define LOG_DEBUG 7 /* debug-level messages */ - -#define _LOG(level) \ - Log(LOG_##level).get() << pthread_self() \ - << timestr() << " " __FILE__ ":" << __LINE__ << ":" << __FUNCTION__ << ": " - -#define IS_LOG_LEVEL(wLevel) (config_log_level>=LOG_##wLevel) - -#ifdef NDEBUG -#define LOG(wLevel) \ - if (LOG_##wLevel!=LOG_DEBUG && IS_LOG_LEVEL(wLevel)) _LOG(wLevel) -#else -#define LOG(wLevel) \ - if (IS_LOG_LEVEL(wLevel)) _LOG(wLevel) +/* Translation for old log statements */ +#ifndef LOGL_ALERT +#define LOGL_ALERT LOGL_FATAL #endif +#ifndef LOGL_ERR +#define LOGL_ERR LOGL_ERROR +#endif +#ifndef LOGL_WARNING +#define LOGL_WARNING LOGL_NOTICE +#endif + +#define LOG(level) \ + Log(DMAIN, LOGL_##level).get() << "[tid=" << pthread_self() << "] " + +#define LOGC(category, level) \ + Log(category, LOGL_##level).get() << "[tid=" << pthread_self() << "] " /** A C++ stream-based thread-safe logger. @@ -73,13 +64,14 @@ class Log { protected: - std::ostringstream mStream; ///< This is where we buffer up the log entry. - int mPriority; ///< Priority of current report. + std::ostringstream mStream; ///< This is where we buffer up the log entry. + int mCategory; ///< Priority of current report. + int mPriority; ///< Category of current report. public: - Log(int wPriority) - :mPriority(wPriority) + Log(int wCategory, int wPriority) + : mCategory(wCategory), mPriority(wPriority) { } // Most of the work is in the destructor. @@ -89,16 +81,8 @@ class Log { std::ostringstream& get(); }; -const std::string timestr(); // A timestamp to print in messages. std::ostream& operator<<(std::ostream& os, std::ostringstream& ss); -/**@ Global control and initialization of the logging system. */ -//@{ -/** Initialize the global logging system. */ -void gLogInit(const char* level=NULL, char* fn=NULL); -//@} - - #endif // vim: ts=4 sw=4 diff --git a/CommonLibs/Makefile.am b/CommonLibs/Makefile.am index 843bc383..5d116f96 100644 --- a/CommonLibs/Makefile.am +++ b/CommonLibs/Makefile.am @@ -22,7 +22,7 @@ include $(top_srcdir)/Makefile.common AM_CPPFLAGS = $(STD_DEFINES_AND_INCLUDES) -AM_CXXFLAGS = -Wall -O3 -g -lpthread +AM_CXXFLAGS = -Wall -O3 -g -lpthread $(LIBOSMOCORE_CFLAGS) $(LIBOSMOCTRL_CFLAGS) $(LIBOSMOVTY_CFLAGS) AM_CFLAGS = $(LIBOSMOCORE_CFLAGS) $(LIBOSMOCTRL_CFLAGS) $(LIBOSMOVTY_CFLAGS) EXTRA_DIST = \ diff --git a/Transceiver52M/osmo-trx.cpp b/Transceiver52M/osmo-trx.cpp index 8e2088d7..5f4e2867 100644 --- a/Transceiver52M/osmo-trx.cpp +++ b/Transceiver52M/osmo-trx.cpp @@ -79,7 +79,6 @@ extern "C" { #define DEFAULT_CONFIG_FILE "osmo-trx.cfg" struct trx_config { - std::string log_level; std::string local_addr; std::string remote_addr; std::string dev_args; @@ -156,7 +155,6 @@ bool trx_setup_config(struct trx_config *config) std::ostringstream ost(""); ost << "Config Settings" << std::endl; - ost << " Log Level............... " << config->log_level << std::endl; ost << " Device args............. " << config->dev_args << std::endl; ost << " TRX Base Port........... " << config->port << std::endl; ost << " TRX Address............. " << config->local_addr << std::endl; @@ -311,7 +309,6 @@ static void print_help() fprintf(stdout, "Options:\n" " -h This text\n" " -a UHD device args\n" - " -l Logging level (%s)\n" " -i IP address of GSM core\n" " -j IP address of osmo-trx\n" " -p Base port number\n" @@ -330,8 +327,8 @@ static void print_help() " -S Swap channels (UmTRX only)\n" " -t SCHED_RR real-time priority (1..32)\n" " -y comma-delimited list of Tx paths (num elements matches -c)\n" - " -z comma-delimited list of Rx paths (num elements matches -c)\n", - "EMERG, ALERT, CRT, ERR, WARNING, NOTICE, INFO, DEBUG"); + " -z comma-delimited list of Rx paths (num elements matches -c)\n" + ); } static void handle_options(int argc, char **argv, struct trx_config *config) @@ -339,7 +336,6 @@ static void handle_options(int argc, char **argv, struct trx_config *config) int option; bool tx_path_set = false, rx_path_set = false; - config->log_level = "NOTICE"; config->local_addr = DEFAULT_TRX_IP; config->remote_addr = DEFAULT_TRX_IP; config->config_file = (char *)DEFAULT_CONFIG_FILE; @@ -361,7 +357,7 @@ static void handle_options(int argc, char **argv, struct trx_config *config) config->tx_paths = std::vector(DEFAULT_CHANS, ""); config->rx_paths = std::vector(DEFAULT_CHANS, ""); - while ((option = getopt(argc, argv, "ha:l:i:j:p:c:dmxgfo:s:b:r:A:R:Set:y:z:C:")) != -1) { + while ((option = getopt(argc, argv, "ha:i:j:p:c:dmxgfo:s:b:r:A:R:Set:y:z:C:")) != -1) { switch (option) { case 'h': print_help(); @@ -370,9 +366,6 @@ static void handle_options(int argc, char **argv, struct trx_config *config) case 'a': config->dev_args = optarg; break; - case 'l': - config->log_level = optarg; - break; case 'i': config->remote_addr = optarg; break; @@ -594,8 +587,6 @@ int main(int argc, char *argv[]) return EXIT_FAILURE; } - gLogInit(config.log_level.c_str()); - srandom(time(NULL)); /* Create the low level device object */ diff --git a/tests/CommonLibs/LogTest.cpp b/tests/CommonLibs/LogTest.cpp index 707e26c2..b8677e6a 100644 --- a/tests/CommonLibs/LogTest.cpp +++ b/tests/CommonLibs/LogTest.cpp @@ -28,21 +28,37 @@ #include #include "Logger.h" +extern "C" { +#include +#include +#include "debug.h" +} + +#define MYCAT 0 int main(int argc, char *argv[]) { - gLogInit("NOTICE"); + struct log_info_cat categories[1]; + struct log_info linfo; + categories[MYCAT] = { + "MYCAT", + NULL, + "Whatever", + LOGL_NOTICE, + 1, + }; + linfo.cat = categories; + linfo.num_cat = ARRAY_SIZE(categories); - Log(LOG_EMERG).get() << " testing the logger."; - Log(LOG_ALERT).get() << " testing the logger."; - Log(LOG_CRIT).get() << " testing the logger."; - Log(LOG_ERR).get() << " testing the logger."; - Log(LOG_WARNING).get() << " testing the logger."; - Log(LOG_NOTICE).get() << " testing the logger."; - Log(LOG_INFO).get() << " testing the logger."; - Log(LOG_DEBUG).get() << " testing the logger."; - std::cout << "----------- generating 20 alarms ----------" << std::endl; - for (int i = 0 ; i < 20 ; ++i) { - Log(LOG_ALERT).get() << i; - } + osmo_init_logging(&linfo); + + log_set_use_color(osmo_stderr_target, 0); + log_set_print_filename(osmo_stderr_target, 0); + log_set_print_level(osmo_stderr_target, 1); + + Log(MYCAT, LOGL_FATAL).get() << "testing the logger."; + Log(MYCAT, LOGL_ERROR).get() << "testing the logger."; + Log(MYCAT, LOGL_NOTICE).get() << "testing the logger."; + Log(MYCAT, LOGL_INFO).get() << "testing the logger."; + Log(MYCAT, LOGL_DEBUG).get() << "testing the logger."; } diff --git a/tests/CommonLibs/LogTest.err b/tests/CommonLibs/LogTest.err index 718ff407..153e8504 100644 --- a/tests/CommonLibs/LogTest.err +++ b/tests/CommonLibs/LogTest.err @@ -1,24 +1,3 @@ -EMERG testing the logger. -ALERT testing the logger. -CRIT testing the logger. -ERR testing the logger. -ALERT 0 -ALERT 1 -ALERT 2 -ALERT 3 -ALERT 4 -ALERT 5 -ALERT 6 -ALERT 7 -ALERT 8 -ALERT 9 -ALERT 10 -ALERT 11 -ALERT 12 -ALERT 13 -ALERT 14 -ALERT 15 -ALERT 16 -ALERT 17 -ALERT 18 -ALERT 19 +FATAL testing the logger. +ERROR testing the logger. +NOTICE testing the logger. diff --git a/tests/CommonLibs/LogTest.ok b/tests/CommonLibs/LogTest.ok index ac60314e..e69de29b 100644 --- a/tests/CommonLibs/LogTest.ok +++ b/tests/CommonLibs/LogTest.ok @@ -1,29 +0,0 @@ -EMERG testing the logger. -ALERT testing the logger. -CRIT testing the logger. -ERR testing the logger. -WARNING testing the logger. -NOTICE testing the logger. -INFO testing the logger. -DEBUG testing the logger. ------------ generating 20 alarms ---------- -ALERT 0 -ALERT 1 -ALERT 2 -ALERT 3 -ALERT 4 -ALERT 5 -ALERT 6 -ALERT 7 -ALERT 8 -ALERT 9 -ALERT 10 -ALERT 11 -ALERT 12 -ALERT 13 -ALERT 14 -ALERT 15 -ALERT 16 -ALERT 17 -ALERT 18 -ALERT 19 diff --git a/tests/CommonLibs/Makefile.am b/tests/CommonLibs/Makefile.am index 6bd1852a..721c9a26 100644 --- a/tests/CommonLibs/Makefile.am +++ b/tests/CommonLibs/Makefile.am @@ -1,6 +1,7 @@ include $(top_srcdir)/Makefile.common -AM_CPPFLAGS = -Wall -I$(top_srcdir)/CommonLibs $(STD_DEFINES_AND_INCLUDES) -g +AM_CPPFLAGS = -Wall -I$(top_srcdir)/CommonLibs $(STD_DEFINES_AND_INCLUDES) $(LIBOSMOCORE_CFLAGS) $(LIBOSMOCTRL_CFLAGS) $(LIBOSMOVTY_CFLAGS) -g +AM_LDFLAGS = $(LIBOSMOCORE_LIBS) $(LIBOSMOCTRL_LIBS) $(LIBOSMOVTY_LIBS) EXTRA_DIST = BitVectorTest.ok \ PRBSTest.ok \