1 //===-- LogChannelDWARF.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 "LogChannelDWARF.h"
11 
12 #include "lldb/Interpreter/Args.h"
13 #include "lldb/Core/PluginManager.h"
14 #include "lldb/Core/StreamFile.h"
15 #include "SymbolFileDWARF.h"
16 
17 using namespace lldb;
18 using namespace lldb_private;
19 
20 
21 // when the one and only logging channel is abled, then this will be non NULL.
22 static LogChannelDWARF* g_log_channel = NULL;
23 
24 LogChannelDWARF::LogChannelDWARF () :
25     LogChannel ()
26 {
27 }
28 
29 LogChannelDWARF::~LogChannelDWARF ()
30 {
31 }
32 
33 
34 void
35 LogChannelDWARF::Initialize()
36 {
37     PluginManager::RegisterPlugin (GetPluginNameStatic(),
38                                    GetPluginDescriptionStatic(),
39                                    LogChannelDWARF::CreateInstance);
40 }
41 
42 void
43 LogChannelDWARF::Terminate()
44 {
45     PluginManager::UnregisterPlugin (LogChannelDWARF::CreateInstance);
46 }
47 
48 LogChannel*
49 LogChannelDWARF::CreateInstance ()
50 {
51     return new LogChannelDWARF ();
52 }
53 
54 const char *
55 LogChannelDWARF::GetPluginNameStatic()
56 {
57     return SymbolFileDWARF::GetPluginNameStatic();
58 }
59 
60 const char *
61 LogChannelDWARF::GetPluginDescriptionStatic()
62 {
63     return "DWARF log channel for debugging plug-in issues.";
64 }
65 
66 const char *
67 LogChannelDWARF::GetPluginName()
68 {
69     return GetPluginDescriptionStatic();
70 }
71 
72 const char *
73 LogChannelDWARF::GetShortPluginName()
74 {
75     return GetPluginNameStatic();
76 }
77 
78 uint32_t
79 LogChannelDWARF::GetPluginVersion()
80 {
81     return 1;
82 }
83 
84 
85 void
86 LogChannelDWARF::Delete ()
87 {
88     g_log_channel = NULL;
89     m_log_sp.reset();
90 }
91 
92 
93 void
94 LogChannelDWARF::Disable (const char **categories, Stream *feedback_strm)
95 {
96     if (!m_log_sp)
97         return;
98 
99     g_log_channel = this;
100     uint32_t flag_bits = m_log_sp->GetMask().Get();
101     for (size_t i = 0; categories[i] != NULL; ++i)
102     {
103          const char *arg = categories[i];
104 
105         if      (::strcasecmp (arg, "all")        == 0) flag_bits &= ~DWARF_LOG_ALL;
106         else if (::strcasecmp (arg, "info")       == 0) flag_bits &= ~DWARF_LOG_DEBUG_INFO;
107         else if (::strcasecmp (arg, "line")       == 0) flag_bits &= ~DWARF_LOG_DEBUG_LINE;
108         else if (::strcasecmp (arg, "pubnames")   == 0) flag_bits &= ~DWARF_LOG_DEBUG_PUBNAMES;
109         else if (::strcasecmp (arg, "pubtypes")   == 0) flag_bits &= ~DWARF_LOG_DEBUG_PUBTYPES;
110         else if (::strcasecmp (arg, "aranges")    == 0) flag_bits &= ~DWARF_LOG_DEBUG_ARANGES;
111         else if (::strcasecmp (arg, "lookups")    == 0) flag_bits &= ~DWARF_LOG_LOOKUPS;
112         else if (::strcasecmp (arg, "map")        == 0) flag_bits &= ~DWARF_LOG_DEBUG_MAP;
113         else if (::strcasecmp (arg, "default")    == 0) flag_bits &= ~DWARF_LOG_DEFAULT;
114         else if (::strncasecmp(arg, "comp", 4)    == 0) flag_bits &= ~DWARF_LOG_TYPE_COMPLETION;
115         else
116         {
117             feedback_strm->Printf("error: unrecognized log category '%s'\n", arg);
118             ListCategories (feedback_strm);
119         }
120    }
121 
122     if (flag_bits == 0)
123         Delete ();
124     else
125         m_log_sp->GetMask().Reset (flag_bits);
126 
127     return;
128 }
129 
130 bool
131 LogChannelDWARF::Enable
132 (
133     StreamSP &log_stream_sp,
134     uint32_t log_options,
135     Stream *feedback_strm,  // Feedback stream for argument errors etc
136     const char **categories  // The categories to enable within this logging stream, if empty, enable default set
137 )
138 {
139     Delete ();
140 
141     m_log_sp.reset(new Log (log_stream_sp));
142     g_log_channel = this;
143     uint32_t flag_bits = 0;
144     bool got_unknown_category = false;
145     for (size_t i = 0; categories[i] != NULL; ++i)
146     {
147         const char *arg = categories[i];
148 
149         if      (::strcasecmp (arg, "all")        == 0) flag_bits |= DWARF_LOG_ALL;
150         else if (::strcasecmp (arg, "info")       == 0) flag_bits |= DWARF_LOG_DEBUG_INFO;
151         else if (::strcasecmp (arg, "line")       == 0) flag_bits |= DWARF_LOG_DEBUG_LINE;
152         else if (::strcasecmp (arg, "pubnames")   == 0) flag_bits |= DWARF_LOG_DEBUG_PUBNAMES;
153         else if (::strcasecmp (arg, "pubtypes")   == 0) flag_bits |= DWARF_LOG_DEBUG_PUBTYPES;
154         else if (::strcasecmp (arg, "aranges")    == 0) flag_bits |= DWARF_LOG_DEBUG_ARANGES;
155         else if (::strcasecmp (arg, "lookups")    == 0) flag_bits |= DWARF_LOG_LOOKUPS;
156         else if (::strcasecmp (arg, "map")        == 0) flag_bits |= DWARF_LOG_DEBUG_MAP;
157         else if (::strcasecmp (arg, "default")    == 0) flag_bits |= DWARF_LOG_DEFAULT;
158         else if (::strncasecmp(arg, "comp", 4)    == 0) flag_bits |= DWARF_LOG_TYPE_COMPLETION;
159         else
160         {
161             feedback_strm->Printf("error: unrecognized log category '%s'\n", arg);
162             if (got_unknown_category == false)
163             {
164                 got_unknown_category = true;
165                 ListCategories (feedback_strm);
166             }
167         }
168     }
169     if (flag_bits == 0)
170         flag_bits = DWARF_LOG_DEFAULT;
171     m_log_sp->GetMask().Reset(flag_bits);
172     m_log_sp->GetOptions().Reset(log_options);
173     return m_log_sp.get() != NULL;
174 }
175 
176 void
177 LogChannelDWARF::ListCategories (Stream *strm)
178 {
179     strm->Printf ("Logging categories for '%s':\n"
180                   "  all - turn on all available logging categories\n"
181                   "  info - log the parsing if .debug_info\n"
182                   "  line - log the parsing if .debug_line\n"
183                   "  pubnames - log the parsing if .debug_pubnames\n"
184                   "  pubtypes - log the parsing if .debug_pubtypes\n"
185                   "  lookups - log any lookups that happen by name, regex, or address\n\n"
186                   "  completion - log struct/unions/class type completions\n\n"
187                   "  map - log insertions of object files into DWARF debug maps\n\n",
188                   SymbolFileDWARF::GetPluginNameStatic());
189 }
190 
191 LogSP
192 LogChannelDWARF::GetLog ()
193 {
194     if (g_log_channel)
195         return g_log_channel->m_log_sp;
196 
197     return LogSP();
198 }
199 
200 LogSP
201 LogChannelDWARF::GetLogIfAll (uint32_t mask)
202 {
203     if (g_log_channel && g_log_channel->m_log_sp)
204     {
205         if (g_log_channel->m_log_sp->GetMask().AllSet(mask))
206             return g_log_channel->m_log_sp;
207     }
208     return LogSP();
209 }
210 
211 LogSP
212 LogChannelDWARF::GetLogIfAny (uint32_t mask)
213 {
214     if (g_log_channel && g_log_channel->m_log_sp)
215     {
216         if (g_log_channel->m_log_sp->GetMask().AnySet(mask))
217             return g_log_channel->m_log_sp;
218     }
219     return LogSP();
220 }
221 
222 void
223 LogChannelDWARF::LogIf (uint32_t mask, const char *format, ...)
224 {
225     if (g_log_channel)
226     {
227         LogSP log_sp(g_log_channel->m_log_sp);
228         va_list args;
229         va_start (args, format);
230         log_sp->VAPrintf (format, args);
231         va_end (args);
232     }
233 }
234