Archives/lokinet
2
0
Fork 0
mirror of https://github.com/oxen-io/lokinet.git synced 2024-10-31 09:20:21 +00:00
Code Issues Projects Releases Wiki Activity

refactor logging to use std::source_location

Browse Source 
* use std::source_location instead of godawful macros in logging
* remove unused/absolutely haram af json logstream
* fix bug in android logger where it doesn't respect eLogNone
This commit is contained in:
Jeff Becker 2021-05-11 07:22:36 -04:00
parent e32f7faf55
commit 5c457ff486
No known key found for this signature in database
GPG Key ID: F357B3B42F6F9B05
28 changed files with 146 additions and 160 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
cmake/add_log_tag.cmake
View File

@ -2,7 +2,6 @@ function(add_log_tag target)
get_target_property(TARGET_SRCS ${target} SOURCES)
foreach(F ${TARGET_SRCS})
get_filename_component(fpath "${F}" ABSOLUTE)
string(REPLACE "${PROJECT_SOURCE_DIR}/" "" logtag "${fpath}")
set_property(SOURCE ${F} APPEND PROPERTY COMPILE_DEFINITIONS LOG_TAG=\"${logtag}\")
set_property(SOURCE ${F} APPEND PROPERTY COMPILE_DEFINITIONS SOURCE_ROOT=\"${PROJECT_SOURCE_DIR}\")
endforeach()
endfunction()

6
daemon/lokinet.cpp
View File

@ -496,7 +496,7 @@ lokinet_main(int argc, char* argv[])
}
catch (std::exception& ex)
{
LogError("cannot generate config at ", *configFile, ": ", ex.what());
llarp::LogError("cannot generate config at ", *configFile, ": ", ex.what());
return 1;
}
}
@ -512,7 +512,7 @@ lokinet_main(int argc, char* argv[])
}
catch (std::exception& ex)
{
LogError("cannot check if ", *configFile, " exists: ", ex.what());
llarp::LogError("cannot check if ", *configFile, " exists: ", ex.what());
return 1;
}
}
@ -574,7 +574,7 @@ lokinet_main(int argc, char* argv[])
"file a bug report now or be cursed with this "
"annoying image in your syslog for all time."})
{
LogError(wtf);
llarp::LogError{wtf};
llarp::LogContext::Instance().ImmediateFlush();
}
#ifdef _WIN32

1
llarp/CMakeLists.txt
View File

@ -10,7 +10,6 @@ add_library(lokinet-util
util/logging/android_logger.cpp
util/logging/buffer.cpp
util/logging/file_logger.cpp
util/logging/json_logger.cpp
util/logging/logger.cpp
util/logging/logger_internal.cpp
util/logging/loglevel.cpp

1
llarp/config/config.cpp
View File

@ -1048,7 +1048,6 @@ namespace llarp
Comment{
"Log type (format). Valid options are:",
" file - plaintext formatting",
" json - json-formatted log statements",
" syslog - logs directed to syslog",
});

6
llarp/dns/message.cpp
View File

@ -117,16 +117,16 @@ namespace llarp
{
if (!qd.Decode(buf))
{
llarp::LogError("failed to decode question");
LogError("failed to decode question");
return false;
}
llarp::LogDebug(qd);
LogDebug("dns question: ", qd);
}
for (auto& an : answers)
{
if (not an.Decode(buf))
{
llarp::LogDebug("failed to decode answer");
LogDebug("failed to decode answer");
return false;
}
}

1
llarp/router/router.cpp
View File

@ -15,7 +15,6 @@
#include <stdexcept>
#include <llarp/util/buffer.hpp>
#include <llarp/util/logging/file_logger.hpp>
#include <llarp/util/logging/json_logger.hpp>
#include <llarp/util/logging/logger_syslog.hpp>
#include <llarp/util/logging/logger.hpp>
#include <llarp/util/meta/memfn.hpp>

7
llarp/util/bencode.hpp
View File

@ -75,7 +75,7 @@ namespace llarp
{
if (!item.BDecode(buf))
{
llarp::LogWarnTag("llarp/bencode.hpp", "failed to decode key ", k, " for entry in dict");
llarp::LogWarn("failed to decode key ", k, " for entry in dict");
return false;
}
@ -94,7 +94,7 @@ namespace llarp
uint64_t read_i;
if (!bencode_read_integer(buf, &read_i))
{
llarp::LogWarnTag("llarp/BEncode.hpp", "failed to decode key ", k, " for integer in dict");
llarp::LogWarn("failed to decode key ", k, " for integer in dict");
return false;
}
@ -210,8 +210,7 @@ namespace llarp
return true;
if (sink.DecodeKey(*key, buffer))
return true;
llarp::LogWarnTag(
"llarp/bencode.hpp", "undefined key '", *key->cur, "' for entry in dict");
llarp::LogWarn("undefined key '", *key->cur, "' for entry in dict");
return false;
},

7
llarp/util/logging/android_logger.cpp
View File

@ -8,7 +8,8 @@ namespace llarp
{
void
AndroidLogStream::PreLog(
std::stringstream& ss, LogLevel lvl, const char* fname, int lineno, const std::string&) const
std::stringstream& ss, LogLevel lvl, std::string_view fname, int lineno, const std::string&)
const
{
switch (lvl)
{
@ -43,7 +44,7 @@ namespace llarp
{}
void
AndroidLogStream::Print(LogLevel lvl, const char* tag, const std::string& msg)
AndroidLogStream::Print(LogLevel lvl, std::string_view tag, const std::string& msg)
{
std::string str("lokinet|");
str += tag;
@ -62,6 +63,8 @@ namespace llarp
case eLogError:
__android_log_write(ANDROID_LOG_ERROR, str.c_str(), msg.c_str());
return;
default:
return;
}
} // namespace llarp

4
llarp/util/logging/android_logger.hpp
View File

@ -12,12 +12,12 @@ namespace llarp
PreLog(
std::stringstream& s,
LogLevel lvl,
const char* fname,
std::string_view filename,
int lineno,
const std::string& nodename) const override;
void
Print(LogLevel lvl, const char* filename, const std::string& msg) override;
Print(LogLevel lvl, std::string_view filename, const std::string& msg) override;
void
PostLog(std::stringstream&) const override;

10
llarp/util/logging/file_logger.cpp
View File

@ -65,18 +65,18 @@ namespace llarp
FileLogStream::PreLog(
std::stringstream& ss,
LogLevel lvl,
const char* fname,
std::string_view filename,
int lineno,
const std::string& nodename) const
{
ss << "[" << LogLevelToString(lvl) << "] ";
ss << "[" << nodename << "]"
<< "(" << thread_id_string() << ") " << log_timestamp() << " " << fname << ":" << lineno
<< "(" << thread_id_string() << ") " << log_timestamp() << " " << filename << ":" << lineno
<< "\t";
}
void
FileLogStream::Print(LogLevel, const char*, const std::string& msg)
FileLogStream::Print(LogLevel, std::string_view, const std::string& msg)
{
m_Lines.pushBack(msg);
}
@ -84,12 +84,12 @@ namespace llarp
void
FileLogStream::AppendLog(
LogLevel lvl,
const char* fname,
std::string_view filename,
int lineno,
const std::string& nodename,
const std::string msg)
{
ILogStream::AppendLog(lvl, fname, lineno, nodename, msg);
ILogStream::AppendLog(lvl, filename, lineno, nodename, msg);
Tick(llarp::time_now_ms());
}

6
llarp/util/logging/file_logger.hpp
View File

@ -23,12 +23,12 @@ namespace llarp
PreLog(
std::stringstream& out,
LogLevel lvl,
const char* fname,
std::string_view filename,
int lineno,
const std::string& nodename) const override;
void
Print(LogLevel, const char*, const std::string& msg) override;
Print(LogLevel, std::string_view filename, const std::string& msg) override;
void
Tick(llarp_time_t now) override;
@ -39,7 +39,7 @@ namespace llarp
void
AppendLog(
LogLevel lvl,
const char* fname,
std::string_view filename,
int lineno,
const std::string& nodename,
const std::string msg) override;

24
llarp/util/logging/json_logger.cpp
View File

@ -1,24 +0,0 @@
#include "json_logger.hpp"
#include <llarp/util/json.hpp>
namespace llarp
{
void
JSONLogStream::AppendLog(
LogLevel lvl,
const char* fname,
int lineno,
const std::string& nodename,
const std::string msg)
{
json::Object obj;
obj["time"] = to_json(llarp::time_now_ms());
obj["nickname"] = nodename;
obj["file"] = std::string(fname);
obj["line"] = lineno;
obj["level"] = LogLevelToString(lvl);
obj["message"] = msg;
m_Lines.pushBack(obj.dump());
}
} // namespace llarp

28
llarp/util/logging/json_logger.hpp
View File

@ -1,28 +0,0 @@
#ifndef LLARP_UTIL_JSON_LOGGER
#define LLARP_UTIL_JSON_LOGGER
#include "file_logger.hpp"
namespace llarp
{
struct JSONLogStream : public FileLogStream
{
JSONLogStream(
std::function<void(FileLogStream::Work_t)> disk,
FILE* f,
llarp_time_t flushInterval,
bool closeFile)
: FileLogStream(std::move(disk), f, flushInterval, closeFile)
{}
void
AppendLog(
LogLevel lvl,
const char* fname,
int lineno,
const std::string& nodename,
const std::string msg) override;
};
} // namespace llarp
#endif

21
llarp/util/logging/logger.cpp
View File

@ -2,7 +2,6 @@
#include "ostream_logger.hpp"
#include "logger_syslog.hpp"
#include "file_logger.hpp"
#include "json_logger.hpp"
#if defined(_WIN32)
#include "win32_logger.hpp"
#endif
@ -36,8 +35,6 @@ namespace llarp
return LogType::Unknown;
else if (str == "file")
return LogType::File;
else if (str == "json")
return LogType::Json;
else if (str == "syslog")
return LogType::Syslog;
@ -111,7 +108,7 @@ namespace llarp
{
logfile = stdout;
}
else
else if (type != LogType::Syslog)
{
logfile = ::fopen(file.c_str(), "a");
if (not logfile)
@ -141,26 +138,10 @@ namespace llarp
}
break;
case LogType::Json:
LogInfo("Switching logger to JSON with file: ", file);
std::cout << std::flush;
LogContext::Instance().logStream =
std::make_unique<JSONLogStream>(io, logfile, 100ms, logfile != stdout);
break;
case LogType::Syslog:
if (logfile)
{
// TODO: this logic should be handled in Config
// TODO: this won't even work because of default value for 'file' (== "stdout")
::fclose(logfile);
throw std::invalid_argument("Cannot mix log type=syslog and file=*");
}
#if defined(_WIN32)
throw std::runtime_error("syslog not supported on win32");
#else
LogInfo("Switching logger to syslog");
std::cout << std::flush;
LogContext::Instance().logStream = std::make_unique<SysLogStream>();
#endif
break;

112
llarp/util/logging/logger.hpp
View File

@ -1,9 +1,11 @@
#pragma once
#include <memory>
#include <llarp/util/str.hpp>
#include <llarp/util/time.hpp>
#include "logstream.hpp"
#include "logger_internal.hpp"
#include "source_location.hpp"
namespace llarp
{
@ -11,7 +13,6 @@ namespace llarp
{
Unknown = 0,
File,
Json,
Syslog,
};
LogType
@ -80,7 +81,7 @@ namespace llarp
/** internal */
template <typename... TArgs>
inline static void
_log(LogLevel lvl, const char* fname, int lineno, TArgs&&... args) noexcept
_log(LogLevel lvl, const slns::source_location& location, TArgs&&... args) noexcept
{
auto& log = LogContext::Instance();
if (log.curLevel > lvl || log.logStream == nullptr)
@ -88,41 +89,80 @@ namespace llarp
std::ostringstream ss;
if constexpr (sizeof...(args) > 0)
LogAppend(ss, std::forward<TArgs>(args)...);
log.logStream->AppendLog(lvl, fname, lineno, log.nodeName, ss.str());
log.logStream->AppendLog(
lvl,
strip_prefix(location.file_name(), SOURCE_ROOT),
location.line(),
log.nodeName,
ss.str());
}
inline void
_log_noop() noexcept
{}
template <typename... T>
struct LogTrace
{
LogTrace(
[[maybe_unused]] T... args,
[[maybe_unused]] const slns::source_location& location = slns::source_location::current())
{
#ifndef NDEBUG
_log(eLogTrace, location, std::forward<T>(args)...);
#endif
}
};
template <typename... T>
LogTrace(T&&...) -> LogTrace<T...>;
template <typename... T>
struct LogDebug
{
LogDebug(
[[maybe_unused]] T... args,
[[maybe_unused]] const slns::source_location& location = slns::source_location::current())
{
#ifndef NDEBUG
_log(eLogDebug, location, std::forward<T>(args)...);
#endif
}
};
template <typename... T>
LogDebug(T&&...) -> LogDebug<T...>;
template <typename... T>
struct LogInfo
{
LogInfo(T... args, const slns::source_location& location = slns::source_location::current())
{
_log(eLogInfo, location, std::forward<T>(args)...);
}
};
template <typename... T>
LogInfo(T&&...) -> LogInfo<T...>;
template <typename... T>
struct LogWarn
{
LogWarn(T... args, const slns::source_location& location = slns::source_location::current())
{
_log(eLogWarn, location, std::forward<T>(args)...);
}
};
template <typename... T>
LogWarn(T&&...) -> LogWarn<T...>;
template <typename... T>
struct LogError
{
LogError(T... args, const slns::source_location& location = slns::source_location::current())
{
_log(eLogError, location, std::forward<T>(args)...);
}
};
template <typename... T>
LogError(T&&...) -> LogError<T...>;
} // namespace llarp
#define LogDebug(...) _log(llarp::eLogDebug, LOG_TAG, __LINE__, __VA_ARGS__)
#define LogInfo(...) _log(llarp::eLogInfo, LOG_TAG, __LINE__, __VA_ARGS__)
#define LogWarn(...) _log(llarp::eLogWarn, LOG_TAG, __LINE__, __VA_ARGS__)
#define LogError(...) _log(llarp::eLogError, LOG_TAG, __LINE__, __VA_ARGS__)
#define LogDebugTag(tag, ...) _log(llarp::eLogDebug, tag, __LINE__, __VA_ARGS__)
#define LogInfoTag(tag, ...) _log(llarp::eLogInfo, tag, __LINE__, __VA_ARGS__)
#define LogWarnTag(tag, ...) _log(llarp::eLogWarn, tag, __LINE__, __VA_ARGS__)
#define LogErrorTag(tag, ...) _log(llarp::eLogError, tag, __LINE__, __VA_ARGS__)
#define LogDebugExplicit(tag, line, ...) _log(llarp::eLogDebug, tag, line, __VA_ARGS__)
#define LogInfoExplicit(tag, line, ...) _log(llarp::eLogInfo, tag, line __VA_ARGS__)
#define LogWarnExplicit(tag, line, ...) _log(llarp::eLogWarn, tag, line, __VA_ARGS__)
#define LogErrorExplicit(tag, line, ...) _log(llarp::eLogError, tag, line, __VA_ARGS__)
// null-op Trace logging if this is a release build
#ifdef NDEBUG
#define LogTrace(...) _log_noop()
#define LogTraceTag(tag, ...) _log_noop()
#define LogTraceExplicit(tag, line, ...) _log_noop()
#else
#define LogTrace(...) _log(llarp::eLogTrace, LOG_TAG, __LINE__, __VA_ARGS__)
#define LogTraceTag(tag, ...) _log(llarp::eLogTrace, tag, __LINE__, __VA_ARGS__)
#define LogTraceExplicit(tag, line, ...) _log(llarp::eLogTrace, tag, line, __VA_ARGS__)
#endif
#ifndef LOG_TAG
#define LOG_TAG "default"
#endif

4
llarp/util/logging/logger_syslog.hpp
View File

@ -11,12 +11,12 @@ namespace llarp
PreLog(
std::stringstream& s,
LogLevel lvl,
const char* fname,
std::string_view filename,
int lineno,
const std::string& nodename) const override;
void
Print(LogLevel lvl, const char* tag, const std::string& msg) override;
Print(LogLevel lvl, std::string_view tag, const std::string& msg) override;
void
PostLog(std::stringstream& ss) const override;

11
llarp/util/logging/logstream.hpp
View File

@ -6,6 +6,7 @@
#include <memory>
#include <string>
#include <sstream>
#include <string_view>
namespace llarp
{
@ -18,12 +19,12 @@ namespace llarp
PreLog(
std::stringstream& out,
LogLevel lvl,
const char* fname,
std::string_view filename,
int lineno,
const std::string& nodename) const = 0;
virtual void
Print(LogLevel lvl, const char* filename, const std::string& msg) = 0;
Print(LogLevel lvl, std::string_view filename, const std::string& msg) = 0;
virtual void
PostLog(std::stringstream& out) const = 0;
@ -31,16 +32,16 @@ namespace llarp
virtual void
AppendLog(
LogLevel lvl,
const char* fname,
std::string_view filename,
int lineno,
const std::string& nodename,
const std::string msg)
{
std::stringstream ss;
PreLog(ss, lvl, fname, lineno, nodename);
PreLog(ss, lvl, filename, lineno, nodename);
ss << msg;
PostLog(ss);
Print(lvl, fname, ss.str());
Print(lvl, filename, ss.str());
}
/// A blocking call to flush to disk. Should only be called in rare circumstances.

6
llarp/util/logging/ostream_logger.cpp
View File

@ -11,7 +11,7 @@ namespace llarp
OStreamLogStream::PreLog(
std::stringstream& ss,
LogLevel lvl,
const char* fname,
std::string_view filename,
int lineno,
const std::string& nodename) const
{
@ -38,7 +38,7 @@ namespace llarp
}
ss << "[" << LogLevelToString(lvl) << "] ";
ss << "[" << nodename << "]"
<< "(" << thread_id_string() << ") " << log_timestamp() << " " << fname << ":" << lineno
<< "(" << thread_id_string() << ") " << log_timestamp() << " " << filename << ":" << lineno
<< "\t";
}
@ -51,7 +51,7 @@ namespace llarp
}
void
OStreamLogStream::Print(LogLevel, const char*, const std::string& msg)
OStreamLogStream::Print(LogLevel, std::string_view, const std::string& msg)
{
m_Out << msg << std::flush;
}

4
llarp/util/logging/ostream_logger.hpp
View File

@ -15,12 +15,12 @@ namespace llarp
PreLog(
std::stringstream& s,
LogLevel lvl,
const char* fname,
std::string_view filename,
int lineno,
const std::string& nodename) const override;
virtual void
Print(LogLevel lvl, const char* tag, const std::string& msg) override;
Print(LogLevel lvl, std::string_view tag, const std::string& msg) override;
void
PostLog(std::stringstream& ss) const override;

9
llarp/util/logging/source_location.hpp Normal file
View File

@ -0,0 +1,9 @@
#pragma once
#ifdef __cpp_lib_source_location
#include <source_location>
namespace slns = std;
#else
#include <experimental/source_location>
namespace slns = std::experimental;
#endif

6
llarp/util/logging/syslog_logger.cpp
View File

@ -10,18 +10,18 @@ namespace llarp
SysLogStream::PreLog(
std::stringstream& ss,
LogLevel lvl,
const char* fname,
std::string_view filename,
int lineno,
const std::string& nodename) const
{
ss << "[" << LogLevelToString(lvl) << "] ";
ss << "[" << nodename << "]"
<< "(" << thread_id_string() << ") " << log_timestamp() << " " << fname << ":" << lineno
<< "(" << thread_id_string() << ") " << log_timestamp() << " " << filename << ":" << lineno
<< "\t";
}
void
SysLogStream::Print(LogLevel lvl, const char*, const std::string& msg)
SysLogStream::Print(LogLevel lvl, std::string_view, const std::string& msg)
{
switch (lvl)
{

8
llarp/util/logging/win32_logger.cpp
View File

@ -27,7 +27,7 @@ namespace llarp
Win32LogStream::PreLog(
std::stringstream& ss,
LogLevel lvl,
const char* fname,
std::string_view filename,
int lineno,
const std::string& nodename) const
{
@ -54,11 +54,11 @@ namespace llarp
break;
}
ss << "[" << nodename << "]"
<< "(" << thread_id_string() << ") " << log_timestamp() << " " << fname << ":" << lineno
<< "(" << thread_id_string() << ") " << log_timestamp() << " " << filename << ":" << lineno
<< "\t";
}
else
OStreamLogStream::PreLog(ss, lvl, fname, lineno, nodename);
OStreamLogStream::PreLog(ss, lvl, filename, lineno, nodename);
}
void
@ -71,7 +71,7 @@ namespace llarp
}
void
Win32LogStream::Print(LogLevel lvl, const char*, const std::string& msg)
Win32LogStream::Print(LogLevel lvl, std::string_view, const std::string& msg)
{
if (!isConsoleModern)
{

4
llarp/util/logging/win32_logger.hpp
View File

@ -14,7 +14,7 @@ namespace llarp
PreLog(
std::stringstream& s,
LogLevel lvl,
const char* fname,
std::string_view filename,
int lineno,
const std::string& nodename) const override;
@ -24,7 +24,7 @@ namespace llarp
void Tick(llarp_time_t) override{};
void
Print(LogLevel lvl, const char*, const std::string& msg) override;
Print(LogLevel lvl, std::string_view, const std::string& msg) override;
private:
std::ostream& m_Out;

9
llarp/util/str.hpp
View File

@ -70,6 +70,15 @@ namespace llarp
return str.size() >= suffix.size() && str.substr(str.size() - suffix.size()) == suffix;
}
/// removes a prefix from a string if it exists
inline std::string_view
strip_prefix(std::string_view str, std::string_view prefix)
{
if (starts_with(str, prefix))
return str.substr(prefix.size());
return str;
}
/// Splits a string on some delimiter string and returns a vector of string_view's pointing into
/// the pieces of the original string. The pieces are valid only as long as the original string
/// remains valid. Leading and trailing empty substrings are not removed. If delim is empty you

2
llarp/vpn/win32.hpp
View File

@ -205,7 +205,7 @@ namespace llarp::vpn
NetSH(std::string commands)
{
commands = NetSHCommand() + " interface IPv6 " + commands;
LogInfo(commands);
LogInfo("exec: ", commands);
::system(commands.c_str());
}

2
pybind/CMakeLists.txt
View File

@ -18,4 +18,4 @@ pybind11_add_module(pyllarp MODULE
)
target_link_libraries(pyllarp PUBLIC liblokinet)
target_include_directories(pyllarp PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
add_log_tag(pyllarp)

2
test/CMakeLists.txt
View File

@ -53,7 +53,7 @@ add_executable(testAll
target_link_libraries(testAll PUBLIC liblokinet Catch2::Catch2)
target_include_directories(testAll PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
add_log_tag(testAll)
if(WIN32)
target_sources(testAll PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/win32/test.rc")
target_link_libraries(testAll PUBLIC ws2_32 iphlpapi shlwapi)

2
test/router/test_llarp_router_version.cpp
View File

@ -57,7 +57,7 @@ TEST_CASE("BEncode", "[RouterVersion]")
CHECK(v1235.BEncode(&buf));
std::string s((const char*)buf.begin(), (buf.end() - buf.begin()));
LogInfo("bencoded: ", buf.begin());
llarp::LogInfo("bencoded: ", buf.begin());
CHECK_THAT((const char*)buf.begin(), Equals("li5ei1ei2ei3ee"));
}