1 //===-- lldb-log.cpp --------------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "lldb/lldb-private-log.h"
14 // Other libraries and framework includes
16 #include "lldb/Interpreter/Args.h"
17 #include "lldb/Core/Log.h"
18 #include "lldb/Core/StreamFile.h"
22 using namespace lldb_private;
25 // We want to avoid global constructors where code needs to be run so here we
26 // control access to our static g_log_sp by hiding it in a singleton function
27 // that will construct the static g_lob_sp the first time this function is
30 static bool g_log_enabled = false;
31 static Log * g_log = NULL;
41 lldb_private::GetLogMask ()
45 return log->GetMask().Get();
50 lldb_private::IsLogVerbose ()
52 uint32_t mask = GetLogMask();
53 return (mask & LIBLLDB_LOG_VERBOSE);
57 lldb_private::GetLogIfAllCategoriesSet (uint32_t mask)
62 uint32_t log_mask = log->GetMask().Get();
63 if ((log_mask & mask) != mask)
70 lldb_private::LogIfAllCategoriesSet (uint32_t mask, const char *format, ...)
72 Log *log(GetLogIfAllCategoriesSet (mask));
76 va_start (args, format);
77 log->VAPrintf (format, args);
83 lldb_private::LogIfAnyCategoriesSet (uint32_t mask, const char *format, ...)
85 Log *log(GetLogIfAnyCategoriesSet (mask));
89 va_start (args, format);
90 log->VAPrintf (format, args);
96 lldb_private::GetLogIfAnyCategoriesSet (uint32_t mask)
99 if (log && mask && (mask & log->GetMask().Get()))
105 lldb_private::DisableLog (const char **categories, Stream *feedback_strm)
111 uint32_t flag_bits = 0;
112 if (categories[0] != NULL)
114 flag_bits = log->GetMask().Get();
115 for (size_t i = 0; categories[i] != NULL; ++i)
117 const char *arg = categories[i];
119 if (0 == ::strcasecmp(arg, "all")) flag_bits &= ~LIBLLDB_LOG_ALL;
120 else if (0 == ::strcasecmp(arg, "api")) flag_bits &= ~LIBLLDB_LOG_API;
121 else if (0 == ::strncasecmp(arg, "break", 5)) flag_bits &= ~LIBLLDB_LOG_BREAKPOINTS;
122 else if (0 == ::strcasecmp(arg, "commands")) flag_bits &= ~LIBLLDB_LOG_COMMANDS;
123 else if (0 == ::strcasecmp(arg, "default")) flag_bits &= ~LIBLLDB_LOG_DEFAULT;
124 else if (0 == ::strcasecmp(arg, "dyld")) flag_bits &= ~LIBLLDB_LOG_DYNAMIC_LOADER;
125 else if (0 == ::strncasecmp(arg, "event", 5)) flag_bits &= ~LIBLLDB_LOG_EVENTS;
126 else if (0 == ::strncasecmp(arg, "expr", 4)) flag_bits &= ~LIBLLDB_LOG_EXPRESSIONS;
127 else if (0 == ::strncasecmp(arg, "object", 6)) flag_bits &= ~LIBLLDB_LOG_OBJECT;
128 else if (0 == ::strcasecmp(arg, "process")) flag_bits &= ~LIBLLDB_LOG_PROCESS;
129 else if (0 == ::strcasecmp(arg, "platform")) flag_bits &= ~LIBLLDB_LOG_PLATFORM;
130 else if (0 == ::strcasecmp(arg, "script")) flag_bits &= ~LIBLLDB_LOG_SCRIPT;
131 else if (0 == ::strcasecmp(arg, "state")) flag_bits &= ~LIBLLDB_LOG_STATE;
132 else if (0 == ::strcasecmp(arg, "step")) flag_bits &= ~LIBLLDB_LOG_STEP;
133 else if (0 == ::strcasecmp(arg, "thread")) flag_bits &= ~LIBLLDB_LOG_THREAD;
134 else if (0 == ::strcasecmp(arg, "target")) flag_bits &= ~LIBLLDB_LOG_TARGET;
135 else if (0 == ::strcasecmp(arg, "verbose")) flag_bits &= ~LIBLLDB_LOG_VERBOSE;
136 else if (0 == ::strncasecmp(arg, "watch", 5)) flag_bits &= ~LIBLLDB_LOG_WATCHPOINTS;
137 else if (0 == ::strncasecmp(arg, "temp", 4)) flag_bits &= ~LIBLLDB_LOG_TEMPORARY;
138 else if (0 == ::strncasecmp(arg, "comm", 4)) flag_bits &= ~LIBLLDB_LOG_COMMUNICATION;
139 else if (0 == ::strncasecmp(arg, "conn", 4)) flag_bits &= ~LIBLLDB_LOG_CONNECTION;
140 else if (0 == ::strncasecmp(arg, "host", 4)) flag_bits &= ~LIBLLDB_LOG_HOST;
141 else if (0 == ::strncasecmp(arg, "unwind", 6)) flag_bits &= ~LIBLLDB_LOG_UNWIND;
142 else if (0 == ::strncasecmp(arg, "types", 5)) flag_bits &= ~LIBLLDB_LOG_TYPES;
143 else if (0 == ::strncasecmp(arg, "symbol", 6)) flag_bits &= ~LIBLLDB_LOG_SYMBOLS;
144 else if (0 == ::strcasecmp(arg, "system-runtime")) flag_bits &= ~LIBLLDB_LOG_SYSTEM_RUNTIME;
145 else if (0 == ::strncasecmp(arg, "module", 6)) flag_bits &= ~LIBLLDB_LOG_MODULES;
146 else if (0 == ::strncasecmp(arg, "mmap", 4)) flag_bits &= ~LIBLLDB_LOG_MMAP;
147 else if (0 == ::strcasecmp(arg, "os")) flag_bits &= ~LIBLLDB_LOG_OS;
148 else if (0 == ::strcasecmp(arg, "jit")) flag_bits &= ~LIBLLDB_LOG_JIT_LOADER;
151 feedback_strm->Printf ("error: unrecognized log category '%s'\n", arg);
152 ListLogCategories (feedback_strm);
158 log->GetMask().Reset (flag_bits);
161 log->SetStream(lldb::StreamSP());
162 g_log_enabled = false;
170 lldb_private::EnableLog (StreamSP &log_stream_sp, uint32_t log_options, const char **categories, Stream *feedback_strm)
172 // Try see if there already is a log - that way we can reuse its settings.
173 // We could reuse the log in toto, but we don't know that the stream is the same.
176 flag_bits = g_log->GetMask().Get();
180 // Now make a new log with this stream if one was provided
184 g_log->SetStream(log_stream_sp);
186 g_log = new Log(log_stream_sp);
191 for (size_t i=0; categories[i] != NULL; ++i)
193 const char *arg = categories[i];
195 if (0 == ::strcasecmp(arg, "all")) flag_bits |= LIBLLDB_LOG_ALL;
196 else if (0 == ::strcasecmp(arg, "api")) flag_bits |= LIBLLDB_LOG_API;
197 else if (0 == ::strncasecmp(arg, "break", 5)) flag_bits |= LIBLLDB_LOG_BREAKPOINTS;
198 else if (0 == ::strcasecmp(arg, "commands")) flag_bits |= LIBLLDB_LOG_COMMANDS;
199 else if (0 == ::strncasecmp(arg, "commu", 5)) flag_bits |= LIBLLDB_LOG_COMMUNICATION;
200 else if (0 == ::strncasecmp(arg, "conn", 4)) flag_bits |= LIBLLDB_LOG_CONNECTION;
201 else if (0 == ::strcasecmp(arg, "default")) flag_bits |= LIBLLDB_LOG_DEFAULT;
202 else if (0 == ::strcasecmp(arg, "dyld")) flag_bits |= LIBLLDB_LOG_DYNAMIC_LOADER;
203 else if (0 == ::strncasecmp(arg, "event", 5)) flag_bits |= LIBLLDB_LOG_EVENTS;
204 else if (0 == ::strncasecmp(arg, "expr", 4)) flag_bits |= LIBLLDB_LOG_EXPRESSIONS;
205 else if (0 == ::strncasecmp(arg, "host", 4)) flag_bits |= LIBLLDB_LOG_HOST;
206 else if (0 == ::strncasecmp(arg, "mmap", 4)) flag_bits |= LIBLLDB_LOG_MMAP;
207 else if (0 == ::strncasecmp(arg, "module", 6)) flag_bits |= LIBLLDB_LOG_MODULES;
208 else if (0 == ::strncasecmp(arg, "object", 6)) flag_bits |= LIBLLDB_LOG_OBJECT;
209 else if (0 == ::strcasecmp(arg, "os")) flag_bits |= LIBLLDB_LOG_OS;
210 else if (0 == ::strcasecmp(arg, "platform")) flag_bits |= LIBLLDB_LOG_PLATFORM;
211 else if (0 == ::strcasecmp(arg, "process")) flag_bits |= LIBLLDB_LOG_PROCESS;
212 else if (0 == ::strcasecmp(arg, "script")) flag_bits |= LIBLLDB_LOG_SCRIPT;
213 else if (0 == ::strcasecmp(arg, "state")) flag_bits |= LIBLLDB_LOG_STATE;
214 else if (0 == ::strcasecmp(arg, "step")) flag_bits |= LIBLLDB_LOG_STEP;
215 else if (0 == ::strncasecmp(arg, "symbol", 6)) flag_bits |= LIBLLDB_LOG_SYMBOLS;
216 else if (0 == ::strcasecmp(arg, "system-runtime")) flag_bits |= LIBLLDB_LOG_SYSTEM_RUNTIME;
217 else if (0 == ::strcasecmp(arg, "target")) flag_bits |= LIBLLDB_LOG_TARGET;
218 else if (0 == ::strncasecmp(arg, "temp", 4)) flag_bits |= LIBLLDB_LOG_TEMPORARY;
219 else if (0 == ::strcasecmp(arg, "thread")) flag_bits |= LIBLLDB_LOG_THREAD;
220 else if (0 == ::strncasecmp(arg, "types", 5)) flag_bits |= LIBLLDB_LOG_TYPES;
221 else if (0 == ::strncasecmp(arg, "unwind", 6)) flag_bits |= LIBLLDB_LOG_UNWIND;
222 else if (0 == ::strcasecmp(arg, "verbose")) flag_bits |= LIBLLDB_LOG_VERBOSE;
223 else if (0 == ::strncasecmp(arg, "watch", 5)) flag_bits |= LIBLLDB_LOG_WATCHPOINTS;
224 else if (0 == ::strcasecmp(arg, "jit")) flag_bits |= LIBLLDB_LOG_JIT_LOADER;
227 feedback_strm->Printf("error: unrecognized log category '%s'\n", arg);
228 ListLogCategories (feedback_strm);
233 g_log->GetMask().Reset(flag_bits);
234 g_log->GetOptions().Reset(log_options);
236 g_log_enabled = true;
242 lldb_private::ListLogCategories (Stream *strm)
244 strm->Printf("Logging categories for 'lldb':\n"
245 " all - turn on all available logging categories\n"
246 " api - enable logging of API calls and return values\n"
247 " break - log breakpoints\n"
248 " commands - log command argument parsing\n"
249 " communication - log communication activities\n"
250 " connection - log connection details\n"
251 " default - enable the default set of logging categories for liblldb\n"
252 " dyld - log shared library related activities\n"
253 " events - log broadcaster, listener and event queue activities\n"
254 " expr - log expressions\n"
255 " host - log host activities\n"
256 " jit - log JIT events in the target\n"
257 " mmap - log mmap related activities\n"
258 " module - log module activities such as when modules are created, destroyed, replaced, and more\n"
259 " object - log object construction/destruction for important objects\n"
260 " os - log OperatingSystem plugin related activities\n"
261 " platform - log platform events and activities\n"
262 " process - log process events and activities\n"
263 " script - log events about the script interpreter\n"
264 " state - log private and public process state changes\n"
265 " step - log step related activities\n"
266 " symbol - log symbol related issues and warnings\n"
267 " system-runtime - log system runtime events\n"
268 " target - log target events and activities\n"
269 " thread - log thread events and activities\n"
270 " types - log type system related activities\n"
271 " unwind - log stack unwind activities\n"
272 " verbose - enable verbose logging\n"
273 " watch - log watchpoint related activities\n");