Switch GDBRemoteLog to the new registration mechanism

llvm-svn: 295455
This commit is contained in:
Pavel Labath 2017-02-17 16:09:06 +00:00
parent 4cd7352c4f
commit 39addef292
3 changed files with 32 additions and 213 deletions

View File

@ -8,207 +8,37 @@
//===----------------------------------------------------------------------===//
#include "ProcessGDBRemoteLog.h"
#include <mutex>
#include "lldb/Core/StreamFile.h"
#include "lldb/Interpreter/Args.h"
#include "llvm/Support/Threading.h"
#include "ProcessGDBRemote.h"
#include "llvm/Support/Threading.h"
using namespace lldb;
using namespace lldb_private;
using namespace lldb_private::process_gdb_remote;
// We want to avoid global constructors where code needs to be run so here we
// control access to our static g_log_sp by hiding it in a singleton function
// that will construct the static g_lob_sp the first time this function is
// called.
static bool g_log_enabled = false;
static Log *g_log = NULL;
static Log *GetLog() {
if (!g_log_enabled)
return NULL;
return g_log;
}
static constexpr Log::Category g_categories[] = {
{{"async"}, {"log asynchronous activity"}, GDBR_LOG_ASYNC},
{{"break"}, {"log breakpoints"}, GDBR_LOG_BREAKPOINTS},
{{"comm"}, {"log communication activity"}, GDBR_LOG_COMM},
{{"packets"}, {"log gdb remote packets"}, GDBR_LOG_PACKETS},
{{"memory"}, {"log memory reads and writes"}, GDBR_LOG_MEMORY},
{{"data-short"},
{"log memory bytes for memory reads and writes for short transactions "
"only"},
GDBR_LOG_MEMORY_DATA_SHORT},
{{"data-long"},
{"log memory bytes for memory reads and writes for all transactions"},
GDBR_LOG_MEMORY_DATA_LONG},
{{"process"}, {"log process events and activities"}, GDBR_LOG_PROCESS},
{{"step"}, {"log step related activities"}, GDBR_LOG_STEP},
{{"thread"}, {"log thread events and activities"}, GDBR_LOG_THREAD},
{{"watch"}, {"log watchpoint related activities"}, GDBR_LOG_WATCHPOINTS},
};
Log::Channel ProcessGDBRemoteLog::g_channel(g_categories, GDBR_LOG_DEFAULT);
void ProcessGDBRemoteLog::Initialize() {
static ConstString g_name("gdb-remote");
static llvm::once_flag g_once_flag;
llvm::call_once(g_once_flag, []() {
Log::Callbacks log_callbacks = {DisableLog, EnableLog, ListLogCategories};
Log::RegisterLogChannel(g_name, log_callbacks);
Log::Register("gdb-remote", g_channel);
});
}
Log *ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(uint32_t mask) {
Log *log(GetLog());
if (log && mask) {
uint32_t log_mask = log->GetMask().Get();
if ((log_mask & mask) != mask)
return NULL;
}
return log;
}
Log *ProcessGDBRemoteLog::GetLogIfAnyCategoryIsSet(uint32_t mask) {
Log *log(GetLog());
if (log && log->GetMask().Get() & mask)
return log;
return NULL;
}
void ProcessGDBRemoteLog::DisableLog(const char **categories,
Stream *feedback_strm) {
Log *log(GetLog());
if (log) {
uint32_t flag_bits = 0;
if (categories && categories[0]) {
flag_bits = log->GetMask().Get();
for (size_t i = 0; categories[i] != NULL; ++i) {
const char *arg = categories[i];
if (::strcasecmp(arg, "all") == 0)
flag_bits &= ~GDBR_LOG_ALL;
else if (::strcasecmp(arg, "async") == 0)
flag_bits &= ~GDBR_LOG_ASYNC;
else if (::strncasecmp(arg, "break", 5) == 0)
flag_bits &= ~GDBR_LOG_BREAKPOINTS;
else if (::strncasecmp(arg, "comm", 4) == 0)
flag_bits &= ~GDBR_LOG_COMM;
else if (::strcasecmp(arg, "default") == 0)
flag_bits &= ~GDBR_LOG_DEFAULT;
else if (::strcasecmp(arg, "packets") == 0)
flag_bits &= ~GDBR_LOG_PACKETS;
else if (::strcasecmp(arg, "memory") == 0)
flag_bits &= ~GDBR_LOG_MEMORY;
else if (::strcasecmp(arg, "data-short") == 0)
flag_bits &= ~GDBR_LOG_MEMORY_DATA_SHORT;
else if (::strcasecmp(arg, "data-long") == 0)
flag_bits &= ~GDBR_LOG_MEMORY_DATA_LONG;
else if (::strcasecmp(arg, "process") == 0)
flag_bits &= ~GDBR_LOG_PROCESS;
else if (::strcasecmp(arg, "step") == 0)
flag_bits &= ~GDBR_LOG_STEP;
else if (::strcasecmp(arg, "thread") == 0)
flag_bits &= ~GDBR_LOG_THREAD;
else if (::strncasecmp(arg, "watch", 5) == 0)
flag_bits &= ~GDBR_LOG_WATCHPOINTS;
else {
feedback_strm->Printf("error: unrecognized log category '%s'\n", arg);
ListLogCategories(feedback_strm);
}
}
}
if (flag_bits == 0)
g_log_enabled = false;
else
log->GetMask().Reset(flag_bits);
}
return;
}
Log *ProcessGDBRemoteLog::EnableLog(
const std::shared_ptr<llvm::raw_ostream> &log_stream_sp,
uint32_t log_options, const char **categories, Stream *feedback_strm) {
// Try see if there already is a log - that way we can reuse its settings.
// We could reuse the log in toto, but we don't know that the stream is the
// same.
uint32_t flag_bits = 0;
if (g_log)
flag_bits = g_log->GetMask().Get();
// Now make a new log with this stream if one was provided
if (log_stream_sp) {
if (g_log)
g_log->SetStream(log_stream_sp);
else
g_log = new Log(log_stream_sp);
}
if (g_log) {
bool got_unknown_category = false;
for (size_t i = 0; categories[i] != NULL; ++i) {
const char *arg = categories[i];
if (::strcasecmp(arg, "all") == 0)
flag_bits |= GDBR_LOG_ALL;
else if (::strcasecmp(arg, "async") == 0)
flag_bits |= GDBR_LOG_ASYNC;
else if (::strncasecmp(arg, "break", 5) == 0)
flag_bits |= GDBR_LOG_BREAKPOINTS;
else if (::strncasecmp(arg, "comm", 4) == 0)
flag_bits |= GDBR_LOG_COMM;
else if (::strcasecmp(arg, "default") == 0)
flag_bits |= GDBR_LOG_DEFAULT;
else if (::strcasecmp(arg, "packets") == 0)
flag_bits |= GDBR_LOG_PACKETS;
else if (::strcasecmp(arg, "memory") == 0)
flag_bits |= GDBR_LOG_MEMORY;
else if (::strcasecmp(arg, "data-short") == 0)
flag_bits |= GDBR_LOG_MEMORY_DATA_SHORT;
else if (::strcasecmp(arg, "data-long") == 0)
flag_bits |= GDBR_LOG_MEMORY_DATA_LONG;
else if (::strcasecmp(arg, "process") == 0)
flag_bits |= GDBR_LOG_PROCESS;
else if (::strcasecmp(arg, "step") == 0)
flag_bits |= GDBR_LOG_STEP;
else if (::strcasecmp(arg, "thread") == 0)
flag_bits |= GDBR_LOG_THREAD;
else if (::strncasecmp(arg, "watch", 5) == 0)
flag_bits |= GDBR_LOG_WATCHPOINTS;
else {
feedback_strm->Printf("error: unrecognized log category '%s'\n", arg);
if (got_unknown_category == false) {
got_unknown_category = true;
ListLogCategories(feedback_strm);
}
}
}
if (flag_bits == 0)
flag_bits = GDBR_LOG_DEFAULT;
g_log->GetMask().Reset(flag_bits);
g_log->GetOptions().Reset(log_options);
}
g_log_enabled = true;
return g_log;
}
void ProcessGDBRemoteLog::ListLogCategories(Stream *strm) {
strm->Printf(
"Logging categories for '%s':\n"
" all - turn on all available logging categories\n"
" async - log asynchronous activity\n"
" break - log breakpoints\n"
" communication - log communication activity\n"
" default - enable the default set of logging categories for liblldb\n"
" packets - log gdb remote packets\n"
" memory - log memory reads and writes\n"
" data-short - log memory bytes for memory reads and writes for short "
"transactions only\n"
" data-long - log memory bytes for memory reads and writes for all "
"transactions\n"
" process - log process events and activities\n"
" thread - log thread events and activities\n"
" step - log step related activities\n"
" verbose - enable verbose logging\n"
" watch - log watchpoint related activities\n",
ProcessGDBRemote::GetPluginNameStatic().GetCString());
}
void ProcessGDBRemoteLog::LogIf(uint32_t mask, const char *format, ...) {
Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(mask));
if (log) {
va_list args;
va_start(args, format);
log->VAPrintf(format, args);
va_end(args);
}
}

View File

@ -36,22 +36,13 @@ namespace lldb_private {
namespace process_gdb_remote {
class ProcessGDBRemoteLog {
static Log::Channel g_channel;
public:
static void Initialize();
static Log *GetLogIfAllCategoriesSet(uint32_t mask = 0);
static Log *GetLogIfAnyCategoryIsSet(uint32_t mask);
static void DisableLog(const char **categories, Stream *feedback_strm);
static Log *EnableLog(const std::shared_ptr<llvm::raw_ostream> &log_stream_sp,
uint32_t log_options, const char **categories,
Stream *feedback_strm);
static void ListLogCategories(Stream *strm);
static void LogIf(uint32_t mask, const char *format, ...);
static Log *GetLogIfAllCategoriesSet(uint32_t mask) { return g_channel.GetLogIfAll(mask); }
static Log *GetLogIfAnyCategoryIsSet(uint32_t mask) { return g_channel.GetLogIfAny(mask); }
};
} // namespace process_gdb_remote

View File

@ -41,18 +41,16 @@ ThreadGDBRemote::ThreadGDBRemote(Process &process, lldb::tid_t tid)
m_dispatch_queue_t(LLDB_INVALID_ADDRESS), m_queue_kind(eQueueKindUnknown),
m_queue_serial_number(LLDB_INVALID_QUEUE_ID),
m_associated_with_libdispatch_queue(eLazyBoolCalculate) {
ProcessGDBRemoteLog::LogIf(
GDBR_LOG_THREAD,
"%p: ThreadGDBRemote::ThreadGDBRemote (pid = %i, tid = 0x%4.4x)", this,
process.GetID(), GetID());
Log *log(GetLogIfAnyCategoriesSet(GDBR_LOG_THREAD));
LLDB_LOG(log, "this = {0}, pid = {1}, tid = {2}", this, process.GetID(),
GetID());
}
ThreadGDBRemote::~ThreadGDBRemote() {
ProcessSP process_sp(GetProcess());
ProcessGDBRemoteLog::LogIf(
GDBR_LOG_THREAD,
"%p: ThreadGDBRemote::~ThreadGDBRemote (pid = %i, tid = 0x%4.4x)", this,
process_sp ? process_sp->GetID() : LLDB_INVALID_PROCESS_ID, GetID());
Log *log(GetLogIfAnyCategoriesSet(GDBR_LOG_THREAD));
LLDB_LOG(log, "this = {0}, pid = {1}, tid = {2}", this,
process_sp ? process_sp->GetID() : LLDB_INVALID_PROCESS_ID, GetID());
DestroyThread();
}