0f08db66db
This patch makes use of c++ type checking and scoped enums to make logging statements shorter and harder to misuse. Defines like LIBLLDB_LOG_PROCESS are replaces with LLDBLog::Process. Because it now carries type information we do not need to worry about matching a specific enum value with the right getter function -- the compiler will now do that for us. The main entry point for the logging machinery becomes the GetLog (template) function, which will obtain the correct Log object based on the enum type. It achieves this through another template function (LogChannelFor<T>), which must be specialized for each type, and should return the appropriate channel object. This patch also removes the ability to log a message if multiple categories are enabled simultaneously as it was unused and confusing. This patch does not actually remove any of the existing interfaces. The defines and log retrieval functions are left around as wrappers around the new interfaces. They will be removed in follow-up patch. Differential Revision: https://reviews.llvm.org/D117490
63 lines
2.6 KiB
C++
63 lines
2.6 KiB
C++
//===-- ProcessGDBRemoteLog.h -----------------------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLDB_SOURCE_PLUGINS_PROCESS_GDB_REMOTE_PROCESSGDBREMOTELOG_H
|
|
#define LLDB_SOURCE_PLUGINS_PROCESS_GDB_REMOTE_PROCESSGDBREMOTELOG_H
|
|
|
|
#include "lldb/Utility/Log.h"
|
|
|
|
namespace lldb_private {
|
|
namespace process_gdb_remote {
|
|
|
|
enum class GDBRLog : Log::MaskType {
|
|
Async = Log::ChannelFlag<0>,
|
|
Breakpoints = Log::ChannelFlag<1>,
|
|
Comm = Log::ChannelFlag<2>,
|
|
Memory = Log::ChannelFlag<3>, // Log memory reads/writes calls
|
|
MemoryDataLong = Log::ChannelFlag<4>, // Log all memory reads/writes bytes
|
|
MemoryDataShort = Log::ChannelFlag<5>, // Log short memory reads/writes bytes
|
|
Packets = Log::ChannelFlag<6>,
|
|
Process = Log::ChannelFlag<7>,
|
|
Step = Log::ChannelFlag<8>,
|
|
Thread = Log::ChannelFlag<9>,
|
|
Watchpoints = Log::ChannelFlag<10>,
|
|
LLVM_MARK_AS_BITMASK_ENUM(Watchpoints)
|
|
};
|
|
|
|
#define GDBR_LOG_PROCESS ::lldb_private::process_gdb_remote::GDBRLog::Process
|
|
#define GDBR_LOG_THREAD ::lldb_private::process_gdb_remote::GDBRLog::Thread
|
|
#define GDBR_LOG_PACKETS ::lldb_private::process_gdb_remote::GDBRLog::Packets
|
|
#define GDBR_LOG_MEMORY ::lldb_private::process_gdb_remote::GDBRLog::Memory
|
|
#define GDBR_LOG_MEMORY_DATA_SHORT \
|
|
::lldb_private::process_gdb_remote::GDBRLog::MemoryDataShort
|
|
#define GDBR_LOG_MEMORY_DATA_LONG \
|
|
::lldb_private::process_gdb_remote::GDBRLog::MemoryDataLong
|
|
#define GDBR_LOG_BREAKPOINTS \
|
|
::lldb_private::process_gdb_remote::GDBRLog::Breakpoints
|
|
#define GDBR_LOG_WATCHPOINTS \
|
|
::lldb_private::process_gdb_remote::GDBRLog::Watchpoints
|
|
#define GDBR_LOG_STEP ::lldb_private::process_gdb_remote::GDBRLog::Step
|
|
#define GDBR_LOG_COMM ::lldb_private::process_gdb_remote::GDBRLog::Comm
|
|
#define GDBR_LOG_ASYNC ::lldb_private::process_gdb_remote::GDBRLog::Async
|
|
|
|
class ProcessGDBRemoteLog {
|
|
public:
|
|
static void Initialize();
|
|
|
|
static Log *GetLogIfAllCategoriesSet(GDBRLog mask) { return GetLog(mask); }
|
|
static Log *GetLogIfAnyCategoryIsSet(GDBRLog mask) { return GetLog(mask); }
|
|
};
|
|
|
|
} // namespace process_gdb_remote
|
|
|
|
template <> Log::Channel &LogChannelFor<process_gdb_remote::GDBRLog>();
|
|
|
|
} // namespace lldb_private
|
|
|
|
#endif // LLDB_SOURCE_PLUGINS_PROCESS_GDB_REMOTE_PROCESSGDBREMOTELOG_H
|