Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 1 | //===-- lldb-log.cpp --------------------------------------------*- 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 | #include "lldb/lldb-private-log.h" |
| 11 | |
| 12 | // C Includes |
| 13 | // C++ Includes |
| 14 | // Other libraries and framework includes |
| 15 | // Project includes |
Jim Ingham | 84cdc15 | 2010-06-15 19:49:27 +0000 | [diff] [blame] | 16 | #include "lldb/Interpreter/Args.h" |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 17 | #include "lldb/Core/Log.h" |
| 18 | #include "lldb/Core/StreamFile.h" |
Eli Friedman | ce6fe88 | 2010-06-10 04:51:35 +0000 | [diff] [blame] | 19 | #include <string.h> |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 20 | |
| 21 | using namespace lldb; |
| 22 | using namespace lldb_private; |
| 23 | |
| 24 | |
Greg Clayton | e005f2c | 2010-11-06 01:53:30 +0000 | [diff] [blame] | 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 |
| 28 | // called. |
| 29 | static LogSP & |
| 30 | GetLog () |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 31 | { |
Greg Clayton | e005f2c | 2010-11-06 01:53:30 +0000 | [diff] [blame] | 32 | static LogSP g_log_sp; |
| 33 | return g_log_sp; |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 34 | } |
| 35 | |
| 36 | uint32_t |
| 37 | lldb_private::GetLogMask () |
| 38 | { |
Greg Clayton | e005f2c | 2010-11-06 01:53:30 +0000 | [diff] [blame] | 39 | LogSP log(GetLog ()); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 40 | if (log) |
Greg Clayton | f3d0b0c | 2010-10-27 03:32:59 +0000 | [diff] [blame] | 41 | return log->GetMask().Get(); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 42 | return 0; |
| 43 | } |
| 44 | |
| 45 | bool |
| 46 | lldb_private::IsLogVerbose () |
| 47 | { |
| 48 | uint32_t mask = GetLogMask(); |
| 49 | return (mask & LIBLLDB_LOG_VERBOSE); |
| 50 | } |
| 51 | |
Greg Clayton | e005f2c | 2010-11-06 01:53:30 +0000 | [diff] [blame] | 52 | LogSP |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 53 | lldb_private::GetLogIfAllCategoriesSet (uint32_t mask) |
| 54 | { |
Greg Clayton | e005f2c | 2010-11-06 01:53:30 +0000 | [diff] [blame] | 55 | LogSP log(GetLog ()); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 56 | if (log && mask) |
| 57 | { |
Greg Clayton | f3d0b0c | 2010-10-27 03:32:59 +0000 | [diff] [blame] | 58 | uint32_t log_mask = log->GetMask().Get(); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 59 | if ((log_mask & mask) != mask) |
Greg Clayton | e005f2c | 2010-11-06 01:53:30 +0000 | [diff] [blame] | 60 | return LogSP(); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 61 | } |
| 62 | return log; |
| 63 | } |
| 64 | |
| 65 | void |
| 66 | lldb_private::LogIfAllCategoriesSet (uint32_t mask, const char *format, ...) |
| 67 | { |
Greg Clayton | e005f2c | 2010-11-06 01:53:30 +0000 | [diff] [blame] | 68 | LogSP log(GetLogIfAllCategoriesSet (mask)); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 69 | if (log) |
| 70 | { |
| 71 | va_list args; |
| 72 | va_start (args, format); |
| 73 | log->VAPrintf (format, args); |
| 74 | va_end (args); |
| 75 | } |
| 76 | } |
| 77 | |
| 78 | void |
| 79 | lldb_private::LogIfAnyCategoriesSet (uint32_t mask, const char *format, ...) |
| 80 | { |
Greg Clayton | e005f2c | 2010-11-06 01:53:30 +0000 | [diff] [blame] | 81 | LogSP log(GetLogIfAnyCategoriesSet (mask)); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 82 | if (log) |
| 83 | { |
| 84 | va_list args; |
| 85 | va_start (args, format); |
| 86 | log->VAPrintf (format, args); |
| 87 | va_end (args); |
| 88 | } |
| 89 | } |
| 90 | |
Greg Clayton | e005f2c | 2010-11-06 01:53:30 +0000 | [diff] [blame] | 91 | LogSP |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 92 | lldb_private::GetLogIfAnyCategoriesSet (uint32_t mask) |
| 93 | { |
Greg Clayton | e005f2c | 2010-11-06 01:53:30 +0000 | [diff] [blame] | 94 | LogSP log(GetLog ()); |
Greg Clayton | f3d0b0c | 2010-10-27 03:32:59 +0000 | [diff] [blame] | 95 | if (log && mask && (mask & log->GetMask().Get())) |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 96 | return log; |
Greg Clayton | e005f2c | 2010-11-06 01:53:30 +0000 | [diff] [blame] | 97 | return LogSP(); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 98 | } |
| 99 | |
| 100 | void |
Jim Ingham | 6c530f2 | 2012-02-21 02:23:08 +0000 | [diff] [blame] | 101 | lldb_private::DisableLog (const char **categories, Stream *feedback_strm) |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 102 | { |
Greg Clayton | e005f2c | 2010-11-06 01:53:30 +0000 | [diff] [blame] | 103 | LogSP log(GetLog ()); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 104 | |
Caroline Tice | 926060e | 2010-10-29 21:48:37 +0000 | [diff] [blame] | 105 | if (log) |
| 106 | { |
Greg Clayton | 990de7b | 2010-11-18 23:32:35 +0000 | [diff] [blame] | 107 | uint32_t flag_bits = 0; |
Jim Ingham | 6c530f2 | 2012-02-21 02:23:08 +0000 | [diff] [blame] | 108 | if (categories[0] != NULL) |
Caroline Tice | 926060e | 2010-10-29 21:48:37 +0000 | [diff] [blame] | 109 | { |
Greg Clayton | 990de7b | 2010-11-18 23:32:35 +0000 | [diff] [blame] | 110 | flag_bits = log->GetMask().Get(); |
Jim Ingham | 6c530f2 | 2012-02-21 02:23:08 +0000 | [diff] [blame] | 111 | for (size_t i = 0; categories[i] != NULL; ++i) |
Caroline Tice | 926060e | 2010-10-29 21:48:37 +0000 | [diff] [blame] | 112 | { |
Jim Ingham | 6c530f2 | 2012-02-21 02:23:08 +0000 | [diff] [blame] | 113 | const char *arg = categories[i]; |
Greg Clayton | 990de7b | 2010-11-18 23:32:35 +0000 | [diff] [blame] | 114 | |
Greg Clayton | d5f76bb | 2011-02-04 18:55:41 +0000 | [diff] [blame] | 115 | if (0 == ::strcasecmp(arg, "all")) flag_bits &= ~LIBLLDB_LOG_ALL; |
| 116 | else if (0 == ::strcasecmp(arg, "api")) flag_bits &= ~LIBLLDB_LOG_API; |
| 117 | else if (0 == ::strncasecmp(arg, "break", 5)) flag_bits &= ~LIBLLDB_LOG_BREAKPOINTS; |
| 118 | else if (0 == ::strcasecmp(arg, "commands")) flag_bits &= ~LIBLLDB_LOG_COMMANDS; |
| 119 | else if (0 == ::strcasecmp(arg, "default")) flag_bits &= ~LIBLLDB_LOG_DEFAULT; |
| 120 | else if (0 == ::strcasecmp(arg, "dyld")) flag_bits &= ~LIBLLDB_LOG_DYNAMIC_LOADER; |
| 121 | else if (0 == ::strncasecmp(arg, "event", 5)) flag_bits &= ~LIBLLDB_LOG_EVENTS; |
| 122 | else if (0 == ::strncasecmp(arg, "expr", 4)) flag_bits &= ~LIBLLDB_LOG_EXPRESSIONS; |
| 123 | else if (0 == ::strncasecmp(arg, "object", 6)) flag_bits &= ~LIBLLDB_LOG_OBJECT; |
| 124 | else if (0 == ::strcasecmp(arg, "process")) flag_bits &= ~LIBLLDB_LOG_PROCESS; |
| 125 | else if (0 == ::strcasecmp(arg, "script")) flag_bits &= ~LIBLLDB_LOG_SCRIPT; |
| 126 | else if (0 == ::strcasecmp(arg, "state")) flag_bits &= ~LIBLLDB_LOG_STATE; |
| 127 | else if (0 == ::strcasecmp(arg, "step")) flag_bits &= ~LIBLLDB_LOG_STEP; |
| 128 | else if (0 == ::strcasecmp(arg, "thread")) flag_bits &= ~LIBLLDB_LOG_THREAD; |
Jason Molenda | 8c6cf43 | 2012-12-05 00:25:49 +0000 | [diff] [blame] | 129 | else if (0 == ::strcasecmp(arg, "target")) flag_bits &= ~LIBLLDB_LOG_TARGET; |
Greg Clayton | d5f76bb | 2011-02-04 18:55:41 +0000 | [diff] [blame] | 130 | else if (0 == ::strcasecmp(arg, "verbose")) flag_bits &= ~LIBLLDB_LOG_VERBOSE; |
| 131 | else if (0 == ::strncasecmp(arg, "watch", 5)) flag_bits &= ~LIBLLDB_LOG_WATCHPOINTS; |
| 132 | else if (0 == ::strncasecmp(arg, "temp", 4)) flag_bits &= ~LIBLLDB_LOG_TEMPORARY; |
| 133 | else if (0 == ::strncasecmp(arg, "comm", 4)) flag_bits &= ~LIBLLDB_LOG_COMMUNICATION; |
| 134 | else if (0 == ::strncasecmp(arg, "conn", 4)) flag_bits &= ~LIBLLDB_LOG_CONNECTION; |
| 135 | else if (0 == ::strncasecmp(arg, "host", 4)) flag_bits &= ~LIBLLDB_LOG_HOST; |
| 136 | else if (0 == ::strncasecmp(arg, "unwind", 6)) flag_bits &= ~LIBLLDB_LOG_UNWIND; |
Enrico Granata | de4059f | 2011-07-22 17:03:19 +0000 | [diff] [blame] | 137 | else if (0 == ::strncasecmp(arg, "types", 5)) flag_bits &= ~LIBLLDB_LOG_TYPES; |
Greg Clayton | ed11c1e | 2011-09-29 23:41:34 +0000 | [diff] [blame] | 138 | else if (0 == ::strncasecmp(arg, "symbol", 6)) flag_bits &= ~LIBLLDB_LOG_SYMBOLS; |
Greg Clayton | f737d37 | 2012-10-08 22:41:53 +0000 | [diff] [blame] | 139 | else if (0 == ::strncasecmp(arg, "module", 6)) flag_bits &= ~LIBLLDB_LOG_MODULES; |
Greg Clayton | 990de7b | 2010-11-18 23:32:35 +0000 | [diff] [blame] | 140 | else |
| 141 | { |
| 142 | feedback_strm->Printf ("error: unrecognized log category '%s'\n", arg); |
| 143 | ListLogCategories (feedback_strm); |
| 144 | return; |
| 145 | } |
| 146 | |
Caroline Tice | 926060e | 2010-10-29 21:48:37 +0000 | [diff] [blame] | 147 | } |
Caroline Tice | 926060e | 2010-10-29 21:48:37 +0000 | [diff] [blame] | 148 | } |
| 149 | if (flag_bits == 0) |
Greg Clayton | e005f2c | 2010-11-06 01:53:30 +0000 | [diff] [blame] | 150 | GetLog ().reset(); |
Caroline Tice | 926060e | 2010-10-29 21:48:37 +0000 | [diff] [blame] | 151 | else |
| 152 | log->GetMask().Reset (flag_bits); |
| 153 | } |
| 154 | |
| 155 | return; |
| 156 | } |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 157 | |
Greg Clayton | e005f2c | 2010-11-06 01:53:30 +0000 | [diff] [blame] | 158 | LogSP |
Jim Ingham | 6c530f2 | 2012-02-21 02:23:08 +0000 | [diff] [blame] | 159 | lldb_private::EnableLog (StreamSP &log_stream_sp, uint32_t log_options, const char **categories, Stream *feedback_strm) |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 160 | { |
| 161 | // Try see if there already is a log - that way we can reuse its settings. |
| 162 | // We could reuse the log in toto, but we don't know that the stream is the same. |
| 163 | uint32_t flag_bits; |
Greg Clayton | e005f2c | 2010-11-06 01:53:30 +0000 | [diff] [blame] | 164 | LogSP log(GetLog ()); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 165 | if (log) |
Greg Clayton | f3d0b0c | 2010-10-27 03:32:59 +0000 | [diff] [blame] | 166 | flag_bits = log->GetMask().Get(); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 167 | else |
| 168 | flag_bits = 0; |
| 169 | |
Greg Clayton | e005f2c | 2010-11-06 01:53:30 +0000 | [diff] [blame] | 170 | // Now make a new log with this stream if one was provided |
| 171 | if (log_stream_sp) |
| 172 | { |
Greg Clayton | 13d24fb | 2012-01-29 20:56:30 +0000 | [diff] [blame] | 173 | log.reset (new Log(log_stream_sp)); |
Greg Clayton | e005f2c | 2010-11-06 01:53:30 +0000 | [diff] [blame] | 174 | GetLog () = log; |
| 175 | } |
| 176 | |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 177 | if (log) |
| 178 | { |
Jim Ingham | 6c530f2 | 2012-02-21 02:23:08 +0000 | [diff] [blame] | 179 | for (size_t i=0; categories[i] != NULL; ++i) |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 180 | { |
Jim Ingham | 6c530f2 | 2012-02-21 02:23:08 +0000 | [diff] [blame] | 181 | const char *arg = categories[i]; |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 182 | |
Greg Clayton | d5f76bb | 2011-02-04 18:55:41 +0000 | [diff] [blame] | 183 | if (0 == ::strcasecmp(arg, "all")) flag_bits |= LIBLLDB_LOG_ALL; |
| 184 | else if (0 == ::strcasecmp(arg, "api")) flag_bits |= LIBLLDB_LOG_API; |
| 185 | else if (0 == ::strncasecmp(arg, "break", 5)) flag_bits |= LIBLLDB_LOG_BREAKPOINTS; |
| 186 | else if (0 == ::strcasecmp(arg, "commands")) flag_bits |= LIBLLDB_LOG_COMMANDS; |
| 187 | else if (0 == ::strcasecmp(arg, "default")) flag_bits |= LIBLLDB_LOG_DEFAULT; |
| 188 | else if (0 == ::strcasecmp(arg, "dyld")) flag_bits |= LIBLLDB_LOG_DYNAMIC_LOADER; |
| 189 | else if (0 == ::strncasecmp(arg, "event", 5)) flag_bits |= LIBLLDB_LOG_EVENTS; |
| 190 | else if (0 == ::strncasecmp(arg, "expr", 4)) flag_bits |= LIBLLDB_LOG_EXPRESSIONS; |
| 191 | else if (0 == ::strncasecmp(arg, "object", 6)) flag_bits |= LIBLLDB_LOG_OBJECT; |
| 192 | else if (0 == ::strcasecmp(arg, "process")) flag_bits |= LIBLLDB_LOG_PROCESS; |
| 193 | else if (0 == ::strcasecmp(arg, "script")) flag_bits |= LIBLLDB_LOG_SCRIPT; |
| 194 | else if (0 == ::strcasecmp(arg, "state")) flag_bits |= LIBLLDB_LOG_STATE; |
| 195 | else if (0 == ::strcasecmp(arg, "step")) flag_bits |= LIBLLDB_LOG_STEP; |
| 196 | else if (0 == ::strcasecmp(arg, "thread")) flag_bits |= LIBLLDB_LOG_THREAD; |
Jason Molenda | 8c6cf43 | 2012-12-05 00:25:49 +0000 | [diff] [blame] | 197 | else if (0 == ::strcasecmp(arg, "target")) flag_bits |= LIBLLDB_LOG_TARGET; |
Greg Clayton | d5f76bb | 2011-02-04 18:55:41 +0000 | [diff] [blame] | 198 | else if (0 == ::strcasecmp(arg, "verbose")) flag_bits |= LIBLLDB_LOG_VERBOSE; |
| 199 | else if (0 == ::strncasecmp(arg, "watch", 5)) flag_bits |= LIBLLDB_LOG_WATCHPOINTS; |
| 200 | else if (0 == ::strncasecmp(arg, "temp", 4)) flag_bits |= LIBLLDB_LOG_TEMPORARY; |
| 201 | else if (0 == ::strncasecmp(arg, "comm", 4)) flag_bits |= LIBLLDB_LOG_COMMUNICATION; |
| 202 | else if (0 == ::strncasecmp(arg, "conn", 4)) flag_bits |= LIBLLDB_LOG_CONNECTION; |
| 203 | else if (0 == ::strncasecmp(arg, "host", 4)) flag_bits |= LIBLLDB_LOG_HOST; |
| 204 | else if (0 == ::strncasecmp(arg, "unwind", 6)) flag_bits |= LIBLLDB_LOG_UNWIND; |
Enrico Granata | de4059f | 2011-07-22 17:03:19 +0000 | [diff] [blame] | 205 | else if (0 == ::strncasecmp(arg, "types", 5)) flag_bits |= LIBLLDB_LOG_TYPES; |
Greg Clayton | ed11c1e | 2011-09-29 23:41:34 +0000 | [diff] [blame] | 206 | else if (0 == ::strncasecmp(arg, "symbol", 6)) flag_bits |= LIBLLDB_LOG_SYMBOLS; |
Greg Clayton | f737d37 | 2012-10-08 22:41:53 +0000 | [diff] [blame] | 207 | else if (0 == ::strncasecmp(arg, "module", 6)) flag_bits |= LIBLLDB_LOG_MODULES; |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 208 | else |
| 209 | { |
| 210 | feedback_strm->Printf("error: unrecognized log category '%s'\n", arg); |
Greg Clayton | 7aeed48 | 2012-04-26 17:07:53 +0000 | [diff] [blame] | 211 | ListLogCategories (feedback_strm); |
| 212 | return log; |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 213 | } |
| 214 | } |
| 215 | |
Greg Clayton | f3d0b0c | 2010-10-27 03:32:59 +0000 | [diff] [blame] | 216 | log->GetMask().Reset(flag_bits); |
| 217 | log->GetOptions().Reset(log_options); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 218 | } |
| 219 | return log; |
| 220 | } |
| 221 | |
| 222 | |
| 223 | void |
| 224 | lldb_private::ListLogCategories (Stream *strm) |
| 225 | { |
| 226 | strm->Printf("Logging categories for 'lldb':\n" |
Greg Clayton | f737d37 | 2012-10-08 22:41:53 +0000 | [diff] [blame] | 227 | " all - turn on all available logging categories\n" |
| 228 | " api - enable logging of API calls and return values\n" |
| 229 | " break - log breakpoints\n" |
| 230 | " command - log command argument parsing\n" |
| 231 | " default - enable the default set of logging categories for liblldb\n" |
| 232 | " dyld - log shared library related activities\n" |
| 233 | " events - log broadcaster, listener and event queue activities\n" |
| 234 | " expr - log expressions\n" |
| 235 | " object - log object construction/destruction for important objects\n" |
| 236 | " module - log module activities such as when modules are created, detroyed, replaced, and more\n" |
| 237 | " process - log process events and activities\n" |
| 238 | " script - log events about the script interpreter\n" |
| 239 | " state - log private and public process state changes\n" |
| 240 | " step - log step related activities\n" |
| 241 | " symbol - log symbol related issues and warnings\n" |
Jason Molenda | 8c6cf43 | 2012-12-05 00:25:49 +0000 | [diff] [blame] | 242 | " target - log target events and activities\n" |
Greg Clayton | f737d37 | 2012-10-08 22:41:53 +0000 | [diff] [blame] | 243 | " thread - log thread events and activities\n" |
| 244 | " types - log type system related activities\n" |
| 245 | " unwind - log stack unwind activities\n" |
| 246 | " verbose - enable verbose logging\n" |
| 247 | " watch - log watchpoint related activities\n"); |
Chris Lattner | 24943d2 | 2010-06-08 16:52:24 +0000 | [diff] [blame] | 248 | } |