edg-l/ddnet
1
0
Fork 0
mirror of https://github.com/ddnet/ddnet.git synced 2024-11-18 22:18:19 +00:00
Code Issues Packages Projects Releases Wiki Activity
ddnet/src/engine/shared/assertion_logger.cpp

86 lines
2.2 KiB
C++
Raw Normal View History

Write log to disk on assert
2022-03-02 13:28:37 +00:00
#include "assertion_logger.h"
Use `CLock` instead of `std::mutex`, add thread-safety annotations Use `CLock` and `CLockScope` instead of `std::mutex` and add clang thread-safety analysis annotations everywhere except for usages in engine graphics and video, as those usages also involve `std::condition_variable`. Fix lock not being unlocked on all code paths in `CFutureLogger::Log`, which is caught by the static analysis.
2023-11-10 20:49:42 +00:00
#include <base/lock.h>
Unify logging infrastructure between `IConsole` and `dbg_msg` This makes the "black console window" less important on Windows (or anywhere else, for that matter), lets you see logs from other threads in the f1 console, and removes the distinction between `IConsole::Print` and `dbg_msg`.
2022-04-22 23:04:48 +00:00
#include <base/logger.h>
Write log to disk on assert
2022-03-02 13:28:37 +00:00
#include <base/system.h>
Use `CLock` instead of `std::mutex`, add thread-safety annotations Use `CLock` and `CLockScope` instead of `std::mutex` and add clang thread-safety analysis annotations everywhere except for usages in engine graphics and video, as those usages also involve `std::condition_variable`. Fix lock not being unlocked on all code paths in `CFutureLogger::Log`, which is caught by the static analysis.
2023-11-10 20:49:42 +00:00
Unify logging infrastructure between `IConsole` and `dbg_msg` This makes the "black console window" less important on Windows (or anywhere else, for that matter), lets you see logs from other threads in the f1 console, and removes the distinction between `IConsole::Print` and `dbg_msg`.
2022-04-22 23:04:48 +00:00
#include <engine/shared/ringbuffer.h>
#include <engine/storage.h>
class CAssertionLogger : public ILogger
Write log to disk on assert
2022-03-02 13:28:37 +00:00
{
Unify logging infrastructure between `IConsole` and `dbg_msg` This makes the "black console window" less important on Windows (or anywhere else, for that matter), lets you see logs from other threads in the f1 console, and removes the distinction between `IConsole::Print` and `dbg_msg`.
2022-04-22 23:04:48 +00:00
struct SDebugMessageItem
{
char m_aMessage[1024];
};
Use `CLock` instead of `std::mutex`, add thread-safety annotations Use `CLock` and `CLockScope` instead of `std::mutex` and add clang thread-safety analysis annotations everywhere except for usages in engine graphics and video, as those usages also involve `std::condition_variable`. Fix lock not being unlocked on all code paths in `CFutureLogger::Log`, which is caught by the static analysis.
2023-11-10 20:49:42 +00:00
CLock m_DbgMessageMutex;
Unify logging infrastructure between `IConsole` and `dbg_msg` This makes the "black console window" less important on Windows (or anywhere else, for that matter), lets you see logs from other threads in the f1 console, and removes the distinction between `IConsole::Print` and `dbg_msg`.
2022-04-22 23:04:48 +00:00
CStaticRingBuffer<SDebugMessageItem, sizeof(SDebugMessageItem) * 64, CRingBufferBase::FLAG_RECYCLE> m_DbgMessages;
char m_aAssertLogPath[IO_MAX_PATH_LENGTH];
char m_aGameName[256];
Use `CLock` instead of `std::mutex`, add thread-safety annotations Use `CLock` and `CLockScope` instead of `std::mutex` and add clang thread-safety analysis annotations everywhere except for usages in engine graphics and video, as those usages also involve `std::condition_variable`. Fix lock not being unlocked on all code paths in `CFutureLogger::Log`, which is caught by the static analysis.
2023-11-10 20:49:42 +00:00
void Dump() REQUIRES(!m_DbgMessageMutex);
Unify logging infrastructure between `IConsole` and `dbg_msg` This makes the "black console window" less important on Windows (or anywhere else, for that matter), lets you see logs from other threads in the f1 console, and removes the distinction between `IConsole::Print` and `dbg_msg`.
2022-04-22 23:04:48 +00:00
public:
CAssertionLogger(const char *pAssertLogPath, const char *pGameName);
Use `CLock` instead of `std::mutex`, add thread-safety annotations Use `CLock` and `CLockScope` instead of `std::mutex` and add clang thread-safety analysis annotations everywhere except for usages in engine graphics and video, as those usages also involve `std::condition_variable`. Fix lock not being unlocked on all code paths in `CFutureLogger::Log`, which is caught by the static analysis.
2023-11-10 20:49:42 +00:00
void Log(const CLogMessage *pMessage) override REQUIRES(!m_DbgMessageMutex);
void GlobalFinish() override REQUIRES(!m_DbgMessageMutex);
Unify logging infrastructure between `IConsole` and `dbg_msg` This makes the "black console window" less important on Windows (or anywhere else, for that matter), lets you see logs from other threads in the f1 console, and removes the distinction between `IConsole::Print` and `dbg_msg`.
2022-04-22 23:04:48 +00:00
};
Write log to disk on assert
2022-03-02 13:28:37 +00:00
Unify logging infrastructure between `IConsole` and `dbg_msg` This makes the "black console window" less important on Windows (or anywhere else, for that matter), lets you see logs from other threads in the f1 console, and removes the distinction between `IConsole::Print` and `dbg_msg`.
2022-04-22 23:04:48 +00:00
void CAssertionLogger::Log(const CLogMessage *pMessage)
Write log to disk on assert
2022-03-02 13:28:37 +00:00
{
Add separate log levels for each output `stdout_output_level` for printing to stdout, `console_output_level` for printing to local console and remote console and `loglevel` for the log file. Keep the old log level filters 0 for info and more severe, 1 for debug and more severe and 2 for trace and more severe, introducing -1 for warn, and -2 for error. -3 will show no log messages at all.
2022-06-13 19:43:05 +00:00
if(m_Filter.Filters(pMessage))
{
return;
}
Use `CLock` instead of `std::mutex`, add thread-safety annotations Use `CLock` and `CLockScope` instead of `std::mutex` and add clang thread-safety analysis annotations everywhere except for usages in engine graphics and video, as those usages also involve `std::condition_variable`. Fix lock not being unlocked on all code paths in `CFutureLogger::Log`, which is caught by the static analysis.
2023-11-10 20:49:42 +00:00
const CLockScope LockScope(m_DbgMessageMutex);
Write log to disk on assert
2022-03-02 13:28:37 +00:00
SDebugMessageItem *pMsgItem = (SDebugMessageItem *)m_DbgMessages.Allocate(sizeof(SDebugMessageItem));
Port some code to str_copy() template
2022-07-09 16:14:56 +00:00
str_copy(pMsgItem->m_aMessage, pMessage->m_aLine);
Unify logging infrastructure between `IConsole` and `dbg_msg` This makes the "black console window" less important on Windows (or anywhere else, for that matter), lets you see logs from other threads in the f1 console, and removes the distinction between `IConsole::Print` and `dbg_msg`.
2022-04-22 23:04:48 +00:00
}
void CAssertionLogger::GlobalFinish()
{
if(dbg_assert_has_failed())
{
Dump();
}
Write log to disk on assert
2022-03-02 13:28:37 +00:00
}
Unify logging infrastructure between `IConsole` and `dbg_msg` This makes the "black console window" less important on Windows (or anywhere else, for that matter), lets you see logs from other threads in the f1 console, and removes the distinction between `IConsole::Print` and `dbg_msg`.
2022-04-22 23:04:48 +00:00
void CAssertionLogger::Dump()
Write log to disk on assert
2022-03-02 13:28:37 +00:00
{
char aAssertLogFile[IO_MAX_PATH_LENGTH];
char aDate[64];
str_timestamp(aDate, sizeof(aDate));
Add the DDNet git hash and "is steam" to the crash file Also put the date before pid for assert logs
2023-04-28 18:40:28 +00:00
str_format(aAssertLogFile, std::size(aAssertLogFile), "%s%s_assert_log_%s_%d.txt", m_aAssertLogPath, m_aGameName, aDate, pid());
Use `CLock` instead of `std::mutex`, add thread-safety annotations Use `CLock` and `CLockScope` instead of `std::mutex` and add clang thread-safety analysis annotations everywhere except for usages in engine graphics and video, as those usages also involve `std::condition_variable`. Fix lock not being unlocked on all code paths in `CFutureLogger::Log`, which is caught by the static analysis.
2023-11-10 20:49:42 +00:00
const CLockScope LockScope(m_DbgMessageMutex);
Write log to disk on assert
2022-03-02 13:28:37 +00:00
IOHANDLE FileHandle = io_open(aAssertLogFile, IOFLAG_WRITE);
if(FileHandle)
{
auto *pIt = m_DbgMessages.First();
while(pIt)
{
io_write(FileHandle, pIt->m_aMessage, str_length(pIt->m_aMessage));
io_write(FileHandle, "\n", 1);
pIt = m_DbgMessages.Next(pIt);
}
io_sync(FileHandle);
io_close(FileHandle);
}
}
Unify logging infrastructure between `IConsole` and `dbg_msg` This makes the "black console window" less important on Windows (or anywhere else, for that matter), lets you see logs from other threads in the f1 console, and removes the distinction between `IConsole::Print` and `dbg_msg`.
2022-04-22 23:04:48 +00:00
CAssertionLogger::CAssertionLogger(const char *pAssertLogPath, const char *pGameName)
Write log to disk on assert
2022-03-02 13:28:37 +00:00
{
Port some code to str_copy() template
2022-07-09 16:14:56 +00:00
str_copy(m_aAssertLogPath, pAssertLogPath);
str_copy(m_aGameName, pGameName);
Unify logging infrastructure between `IConsole` and `dbg_msg` This makes the "black console window" less important on Windows (or anywhere else, for that matter), lets you see logs from other threads in the f1 console, and removes the distinction between `IConsole::Print` and `dbg_msg`.
2022-04-22 23:04:48 +00:00
}
Write log to disk on assert
2022-03-02 13:28:37 +00:00
Unify logging infrastructure between `IConsole` and `dbg_msg` This makes the "black console window" less important on Windows (or anywhere else, for that matter), lets you see logs from other threads in the f1 console, and removes the distinction between `IConsole::Print` and `dbg_msg`.
2022-04-22 23:04:48 +00:00
std::unique_ptr<ILogger> CreateAssertionLogger(IStorage *pStorage, const char *pGameName)
{
char aAssertLogPath[IO_MAX_PATH_LENGTH];
pStorage->GetCompletePath(IStorage::TYPE_SAVE, "dumps/", aAssertLogPath, sizeof(aAssertLogPath));
Use std::make_unique (fixes #5166) No idea why clang-tidy's modernize-... didn't work
2022-05-28 12:46:53 +00:00
return std::make_unique<CAssertionLogger>(aAssertLogPath, pGameName);
Write log to disk on assert
2022-03-02 13:28:37 +00:00
}
Reference in a new issue Copy permalink