aboutsummaryrefslogtreecommitdiff
path: root/source/Core/Logging.cpp
blob: 4d63b60eeccdd816ca1345af70f32b76c7d4675b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
//===-- Logging.cpp ---------------------------------------------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//

#include "lldb/Core/Logging.h"

// C Includes
// C++ Includes
#include <atomic>
#include <cstring>

// Other libraries and framework includes
// Project includes
#include "lldb/Core/Log.h"
#include "lldb/Core/StreamFile.h"
#include "lldb/Interpreter/Args.h"

using namespace lldb;
using namespace lldb_private;

// We want to avoid global constructors where code needs to be run so here we
// control access to our static g_log_sp by hiding it in a singleton function
// that will construct the static g_lob_sp the first time this function is
// called.

static std::atomic<bool> g_log_enabled{false};
static Log *g_log = nullptr;

static Log *GetLog() {
  if (!g_log_enabled)
    return nullptr;
  return g_log;
}

uint32_t lldb_private::GetLogMask() {
  Log *log(GetLog());
  if (log)
    return log->GetMask().Get();
  return 0;
}

bool lldb_private::IsLogVerbose() {
  uint32_t mask = GetLogMask();
  return (mask & LIBLLDB_LOG_VERBOSE);
}

Log *lldb_private::GetLogIfAllCategoriesSet(uint32_t mask) {
  Log *log(GetLog());
  if (log && mask) {
    uint32_t log_mask = log->GetMask().Get();
    if ((log_mask & mask) != mask)
      return nullptr;
  }
  return log;
}

void lldb_private::LogIfAllCategoriesSet(uint32_t mask, const char *format,
                                         ...) {
  Log *log(GetLogIfAllCategoriesSet(mask));
  if (log) {
    va_list args;
    va_start(args, format);
    log->VAPrintf(format, args);
    va_end(args);
  }
}

void lldb_private::LogIfAnyCategoriesSet(uint32_t mask, const char *format,
                                         ...) {
  Log *log(GetLogIfAnyCategoriesSet(mask));
  if (log != nullptr) {
    va_list args;
    va_start(args, format);
    log->VAPrintf(format, args);
    va_end(args);
  }
}

Log *lldb_private::GetLogIfAnyCategoriesSet(uint32_t mask) {
  Log *log(GetLog());
  if (log != nullptr && mask && (mask & log->GetMask().Get()))
    return log;
  return nullptr;
}

void lldb_private::DisableLog(const char **categories, Stream *feedback_strm) {
  Log *log(GetLog());

  if (log != nullptr) {
    uint32_t flag_bits = 0;
    if (categories && categories[0]) {
      flag_bits = log->GetMask().Get();
      for (size_t i = 0; categories[i] != nullptr; ++i) {
        const char *arg = categories[i];

        if (0 == ::strcasecmp(arg, "all"))
          flag_bits &= ~LIBLLDB_LOG_ALL;
        else if (0 == ::strcasecmp(arg, "api"))
          flag_bits &= ~LIBLLDB_LOG_API;
        else if (0 == ::strncasecmp(arg, "break", 5))
          flag_bits &= ~LIBLLDB_LOG_BREAKPOINTS;
        else if (0 == ::strcasecmp(arg, "commands"))
          flag_bits &= ~LIBLLDB_LOG_COMMANDS;
        else if (0 == ::strcasecmp(arg, "default"))
          flag_bits &= ~LIBLLDB_LOG_DEFAULT;
        else if (0 == ::strcasecmp(arg, "dyld"))
          flag_bits &= ~LIBLLDB_LOG_DYNAMIC_LOADER;
        else if (0 == ::strncasecmp(arg, "event", 5))
          flag_bits &= ~LIBLLDB_LOG_EVENTS;
        else if (0 == ::strncasecmp(arg, "expr", 4))
          flag_bits &= ~LIBLLDB_LOG_EXPRESSIONS;
        else if (0 == ::strncasecmp(arg, "object", 6))
          flag_bits &= ~LIBLLDB_LOG_OBJECT;
        else if (0 == ::strcasecmp(arg, "process"))
          flag_bits &= ~LIBLLDB_LOG_PROCESS;
        else if (0 == ::strcasecmp(arg, "platform"))
          flag_bits &= ~LIBLLDB_LOG_PLATFORM;
        else if (0 == ::strcasecmp(arg, "script"))
          flag_bits &= ~LIBLLDB_LOG_SCRIPT;
        else if (0 == ::strcasecmp(arg, "state"))
          flag_bits &= ~LIBLLDB_LOG_STATE;
        else if (0 == ::strcasecmp(arg, "step"))
          flag_bits &= ~LIBLLDB_LOG_STEP;
        else if (0 == ::strcasecmp(arg, "thread"))
          flag_bits &= ~LIBLLDB_LOG_THREAD;
        else if (0 == ::strcasecmp(arg, "target"))
          flag_bits &= ~LIBLLDB_LOG_TARGET;
        else if (0 == ::strcasecmp(arg, "verbose"))
          flag_bits &= ~LIBLLDB_LOG_VERBOSE;
        else if (0 == ::strncasecmp(arg, "watch", 5))
          flag_bits &= ~LIBLLDB_LOG_WATCHPOINTS;
        else if (0 == ::strncasecmp(arg, "temp", 4))
          flag_bits &= ~LIBLLDB_LOG_TEMPORARY;
        else if (0 == ::strncasecmp(arg, "comm", 4))
          flag_bits &= ~LIBLLDB_LOG_COMMUNICATION;
        else if (0 == ::strncasecmp(arg, "conn", 4))
          flag_bits &= ~LIBLLDB_LOG_CONNECTION;
        else if (0 == ::strncasecmp(arg, "host", 4))
          flag_bits &= ~LIBLLDB_LOG_HOST;
        else if (0 == ::strncasecmp(arg, "unwind", 6))
          flag_bits &= ~LIBLLDB_LOG_UNWIND;
        else if (0 == ::strncasecmp(arg, "types", 5))
          flag_bits &= ~LIBLLDB_LOG_TYPES;
        else if (0 == ::strncasecmp(arg, "symbol", 6))
          flag_bits &= ~LIBLLDB_LOG_SYMBOLS;
        else if (0 == ::strcasecmp(arg, "system-runtime"))
          flag_bits &= ~LIBLLDB_LOG_SYSTEM_RUNTIME;
        else if (0 == ::strncasecmp(arg, "module", 6))
          flag_bits &= ~LIBLLDB_LOG_MODULES;
        else if (0 == ::strncasecmp(arg, "mmap", 4))
          flag_bits &= ~LIBLLDB_LOG_MMAP;
        else if (0 == ::strcasecmp(arg, "os"))
          flag_bits &= ~LIBLLDB_LOG_OS;
        else if (0 == ::strcasecmp(arg, "jit"))
          flag_bits &= ~LIBLLDB_LOG_JIT_LOADER;
        else if (0 == ::strcasecmp(arg, "language"))
          flag_bits &= ~LIBLLDB_LOG_LANGUAGE;
        else if (0 == ::strncasecmp(arg, "formatters", 10))
          flag_bits &= ~LIBLLDB_LOG_DATAFORMATTERS;
        else if (0 == ::strncasecmp(arg, "demangle", 8))
          flag_bits &= ~LIBLLDB_LOG_DEMANGLE;
        else {
          feedback_strm->Printf("error:  unrecognized log category '%s'\n",
                                arg);
          ListLogCategories(feedback_strm);
          return;
        }
      }
    }
    log->GetMask().Reset(flag_bits);
    if (flag_bits == 0) {
      log->SetStream(lldb::StreamSP());
      g_log_enabled = false;
    }
  }
}

Log *lldb_private::EnableLog(StreamSP &log_stream_sp, uint32_t log_options,
                             const char **categories, Stream *feedback_strm) {
  // Try see if there already is a log - that way we can reuse its settings.
  // We could reuse the log in toto, but we don't know that the stream is the
  // same.
  uint32_t flag_bits;
  if (g_log != nullptr)
    flag_bits = g_log->GetMask().Get();
  else
    flag_bits = 0;

  // Now make a new log with this stream if one was provided
  if (log_stream_sp) {
    if (g_log != nullptr)
      g_log->SetStream(log_stream_sp);
    else
      g_log = new Log(log_stream_sp);
  }

  if (g_log != nullptr) {
    for (size_t i = 0; categories[i] != nullptr; ++i) {
      const char *arg = categories[i];

      if (0 == ::strcasecmp(arg, "all"))
        flag_bits |= LIBLLDB_LOG_ALL;
      else if (0 == ::strcasecmp(arg, "api"))
        flag_bits |= LIBLLDB_LOG_API;
      else if (0 == ::strncasecmp(arg, "break", 5))
        flag_bits |= LIBLLDB_LOG_BREAKPOINTS;
      else if (0 == ::strcasecmp(arg, "commands"))
        flag_bits |= LIBLLDB_LOG_COMMANDS;
      else if (0 == ::strncasecmp(arg, "commu", 5))
        flag_bits |= LIBLLDB_LOG_COMMUNICATION;
      else if (0 == ::strncasecmp(arg, "conn", 4))
        flag_bits |= LIBLLDB_LOG_CONNECTION;
      else if (0 == ::strcasecmp(arg, "default"))
        flag_bits |= LIBLLDB_LOG_DEFAULT;
      else if (0 == ::strcasecmp(arg, "dyld"))
        flag_bits |= LIBLLDB_LOG_DYNAMIC_LOADER;
      else if (0 == ::strncasecmp(arg, "event", 5))
        flag_bits |= LIBLLDB_LOG_EVENTS;
      else if (0 == ::strncasecmp(arg, "expr", 4))
        flag_bits |= LIBLLDB_LOG_EXPRESSIONS;
      else if (0 == ::strncasecmp(arg, "host", 4))
        flag_bits |= LIBLLDB_LOG_HOST;
      else if (0 == ::strncasecmp(arg, "mmap", 4))
        flag_bits |= LIBLLDB_LOG_MMAP;
      else if (0 == ::strncasecmp(arg, "module", 6))
        flag_bits |= LIBLLDB_LOG_MODULES;
      else if (0 == ::strncasecmp(arg, "object", 6))
        flag_bits |= LIBLLDB_LOG_OBJECT;
      else if (0 == ::strcasecmp(arg, "os"))
        flag_bits |= LIBLLDB_LOG_OS;
      else if (0 == ::strcasecmp(arg, "platform"))
        flag_bits |= LIBLLDB_LOG_PLATFORM;
      else if (0 == ::strcasecmp(arg, "process"))
        flag_bits |= LIBLLDB_LOG_PROCESS;
      else if (0 == ::strcasecmp(arg, "script"))
        flag_bits |= LIBLLDB_LOG_SCRIPT;
      else if (0 == ::strcasecmp(arg, "state"))
        flag_bits |= LIBLLDB_LOG_STATE;
      else if (0 == ::strcasecmp(arg, "step"))
        flag_bits |= LIBLLDB_LOG_STEP;
      else if (0 == ::strncasecmp(arg, "symbol", 6))
        flag_bits |= LIBLLDB_LOG_SYMBOLS;
      else if (0 == ::strcasecmp(arg, "system-runtime"))
        flag_bits |= LIBLLDB_LOG_SYSTEM_RUNTIME;
      else if (0 == ::strcasecmp(arg, "target"))
        flag_bits |= LIBLLDB_LOG_TARGET;
      else if (0 == ::strncasecmp(arg, "temp", 4))
        flag_bits |= LIBLLDB_LOG_TEMPORARY;
      else if (0 == ::strcasecmp(arg, "thread"))
        flag_bits |= LIBLLDB_LOG_THREAD;
      else if (0 == ::strncasecmp(arg, "types", 5))
        flag_bits |= LIBLLDB_LOG_TYPES;
      else if (0 == ::strncasecmp(arg, "unwind", 6))
        flag_bits |= LIBLLDB_LOG_UNWIND;
      else if (0 == ::strcasecmp(arg, "verbose"))
        flag_bits |= LIBLLDB_LOG_VERBOSE;
      else if (0 == ::strncasecmp(arg, "watch", 5))
        flag_bits |= LIBLLDB_LOG_WATCHPOINTS;
      else if (0 == ::strcasecmp(arg, "jit"))
        flag_bits |= LIBLLDB_LOG_JIT_LOADER;
      else if (0 == ::strcasecmp(arg, "language"))
        flag_bits |= LIBLLDB_LOG_LANGUAGE;
      else if (0 == ::strncasecmp(arg, "formatters", 10))
        flag_bits |= LIBLLDB_LOG_DATAFORMATTERS;
      else if (0 == ::strncasecmp(arg, "demangle", 8))
        flag_bits |= LIBLLDB_LOG_DEMANGLE;
      else {
        feedback_strm->Printf("error: unrecognized log category '%s'\n", arg);
        ListLogCategories(feedback_strm);
        return g_log;
      }
    }

    g_log->GetMask().Reset(flag_bits);
    g_log->GetOptions().Reset(log_options);
  }
  g_log_enabled = true;
  return g_log;
}

void lldb_private::ListLogCategories(Stream *strm) {
  strm->Printf(
      "Logging categories for 'lldb':\n"
      "  all - turn on all available logging categories\n"
      "  api - enable logging of API calls and return values\n"
      "  break - log breakpoints\n"
      "  commands - log command argument parsing\n"
      "  communication - log communication activities\n"
      "  connection - log connection details\n"
      "  default - enable the default set of logging categories for liblldb\n"
      "  demangle - log mangled names to catch demangler crashes\n"
      "  dyld - log shared library related activities\n"
      "  events - log broadcaster, listener and event queue activities\n"
      "  expr - log expressions\n"
      "  formatters - log data formatters related activities\n"
      "  host - log host activities\n"
      "  jit - log JIT events in the target\n"
      "  language - log language runtime events\n"
      "  mmap - log mmap related activities\n"
      "  module - log module activities such as when modules are created, "
      "destroyed, replaced, and more\n"
      "  object - log object construction/destruction for important objects\n"
      "  os - log OperatingSystem plugin related activities\n"
      "  platform - log platform events and activities\n"
      "  process - log process events and activities\n"
      "  script - log events about the script interpreter\n"
      "  state - log private and public process state changes\n"
      "  step - log step related activities\n"
      "  symbol - log symbol related issues and warnings\n"
      "  system-runtime - log system runtime events\n"
      "  target - log target events and activities\n"
      "  thread - log thread events and activities\n"
      "  types - log type system related activities\n"
      "  unwind - log stack unwind activities\n"
      "  verbose - enable verbose logging\n"
      "  watch - log watchpoint related activities\n");
}