xref: /llvm-project/lldb/source/Plugins/Process/gdb-remote/ProcessGDBRemoteLog.h (revision 5f4b6c7c9e1f8d1fbda62ea3729284e7c3db27f1)
1 //===-- ProcessGDBRemoteLog.h -----------------------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #ifndef liblldb_ProcessGDBRemoteLog_h_
11 #define liblldb_ProcessGDBRemoteLog_h_
12 
13 // C Includes
14 // C++ Includes
15 // Other libraries and framework includes
16 
17 // Project includes
18 #include "lldb/Core/Log.h"
19 
20 #define GDBR_LOG_VERBOSE                  (1u << 0)
21 #define GDBR_LOG_PROCESS                  (1u << 1)
22 #define GDBR_LOG_THREAD                   (1u << 2)
23 #define GDBR_LOG_PACKETS                  (1u << 3)
24 #define GDBR_LOG_MEMORY                   (1u << 4)    // Log memory reads/writes calls
25 #define GDBR_LOG_MEMORY_DATA_SHORT        (1u << 5)    // Log short memory reads/writes bytes
26 #define GDBR_LOG_MEMORY_DATA_LONG         (1u << 6)    // Log all memory reads/writes bytes
27 #define GDBR_LOG_BREAKPOINTS              (1u << 7)
28 #define GDBR_LOG_WATCHPOINTS              (1u << 8)
29 #define GDBR_LOG_STEP                     (1u << 9)
30 #define GDBR_LOG_COMM                     (1u << 10)
31 #define GDBR_LOG_ASYNC                    (1u << 11)
32 #define GDBR_LOG_ALL                      (UINT32_MAX)
33 #define GDBR_LOG_DEFAULT                  GDBR_LOG_PACKETS
34 
35 class ProcessGDBRemoteLog
36 {
37 public:
38     static void
39     Initialize();
40 
41     static lldb_private::Log *
42     GetLogIfAllCategoriesSet(uint32_t mask = 0);
43 
44     static lldb_private::Log *
45     GetLogIfAnyCategoryIsSet (uint32_t mask);
46 
47     static void
48     DisableLog (const char **categories, lldb_private::Stream *feedback_strm);
49 
50     static lldb_private::Log *
51     EnableLog (lldb::StreamSP &log_stream_sp, uint32_t log_options, const char **categories, lldb_private::Stream *feedback_strm);
52 
53     static void
54     ListLogCategories (lldb_private::Stream *strm);
55 
56     static void
57     LogIf (uint32_t mask, const char *format, ...);
58 };
59 
60 #endif  // liblldb_ProcessGDBRemoteLog_h_
61