llvm-project/lldb/source/Plugins/Process/Linux/ProcessLinuxLog.h

99 lines
3.1 KiB
C++

//===-- ProcessLinuxLog.h -----------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#ifndef liblldb_ProcessLinuxLog_h_
#define liblldb_ProcessLinuxLog_h_
// C Includes
// C++ Includes
// Other libraries and framework includes
// Project includes
#include "lldb/Core/Log.h"
#define LINUX_LOG_VERBOSE (1u << 0)
#define LINUX_LOG_PROCESS (1u << 1)
#define LINUX_LOG_THREAD (1u << 2)
#define LINUX_LOG_PACKETS (1u << 3)
#define LINUX_LOG_MEMORY (1u << 4) // Log memory reads/writes calls
#define LINUX_LOG_MEMORY_DATA_SHORT (1u << 5) // Log short memory reads/writes bytes
#define LINUX_LOG_MEMORY_DATA_LONG (1u << 6) // Log all memory reads/writes bytes
#define LINUX_LOG_BREAKPOINTS (1u << 7)
#define LINUX_LOG_WATCHPOINTS (1u << 8)
#define LINUX_LOG_STEP (1u << 9)
#define LINUX_LOG_COMM (1u << 10)
#define LINUX_LOG_ASYNC (1u << 11)
#define LINUX_LOG_PTRACE (1u << 12)
#define LINUX_LOG_REGISTERS (1u << 13)
#define LINUX_LOG_ALL (UINT32_MAX)
#define LINUX_LOG_DEFAULT LINUX_LOG_PACKETS
// The size which determines "short memory reads/writes".
#define LINUX_LOG_MEMORY_SHORT_BYTES (4 * sizeof(ptrdiff_t))
class ProcessLinuxLog
{
static int m_nestinglevel;
public:
static lldb::LogSP
GetLogIfAllCategoriesSet(uint32_t mask = 0);
static void
DisableLog (lldb_private::Args &args, lldb_private::Stream *feedback_strm);
static lldb::LogSP
EnableLog (lldb::StreamSP &log_stream_sp, uint32_t log_options,
lldb_private::Args &args, lldb_private::Stream *feedback_strm);
static void
ListLogCategories (lldb_private::Stream *strm);
static void
LogIf (uint32_t mask, const char *format, ...);
// The following functions can be used to enable the client to limit
// logging to only the top level function calls. This is useful for
// recursive functions. FIXME: not thread safe!
// Example:
// void NestingFunc() {
// LogSP log (ProcessLinuxLog::GetLogIfAllCategoriesSet(LINUX_LOG_ALL));
// if (log)
// {
// ProcessLinuxLog::IncNestLevel();
// if (ProcessLinuxLog::AtTopNestLevel())
// log->Print(msg);
// }
// NestingFunc();
// if (log)
// ProcessLinuxLog::DecNestLevel();
// }
static bool
AtTopNestLevel()
{
return m_nestinglevel == 1;
}
static void
IncNestLevel()
{
++m_nestinglevel;
}
static void
DecNestLevel()
{
--m_nestinglevel;
assert(m_nestinglevel >= 0);
}
};
#endif // liblldb_ProcessLinuxLog_h_