1 //===-- BreakpointOptions.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/Breakpoint/BreakpointOptions.h"
11 
12 // C Includes
13 // C++ Includes
14 // Other libraries and framework includes
15 // Project includes
16 #include "lldb/Core/Stream.h"
17 #include "lldb/Core/StringList.h"
18 #include "lldb/Core/Value.h"
19 #include "lldb/Breakpoint/StoppointCallbackContext.h"
20 #include "lldb/Target/Process.h"
21 #include "lldb/Target/Target.h"
22 #include "lldb/Target/ThreadSpec.h"
23 #include "lldb/Expression/ClangUserExpression.h"
24 
25 using namespace lldb;
26 using namespace lldb_private;
27 
28 bool
29 BreakpointOptions::NullCallback (void *baton, StoppointCallbackContext *context, lldb::user_id_t break_id, lldb::user_id_t break_loc_id)
30 {
31     return true;
32 }
33 
34 //----------------------------------------------------------------------
35 // BreakpointOptions constructor
36 //----------------------------------------------------------------------
37 BreakpointOptions::BreakpointOptions() :
38     m_callback (BreakpointOptions::NullCallback),
39     m_callback_baton_sp (),
40     m_callback_is_synchronous (false),
41     m_enabled (true),
42     m_ignore_count (0),
43     m_thread_spec_ap (NULL),
44     m_condition_ap()
45 {
46 }
47 
48 //----------------------------------------------------------------------
49 // BreakpointOptions copy constructor
50 //----------------------------------------------------------------------
51 BreakpointOptions::BreakpointOptions(const BreakpointOptions& rhs) :
52     m_callback (rhs.m_callback),
53     m_callback_baton_sp (rhs.m_callback_baton_sp),
54     m_callback_is_synchronous (rhs.m_callback_is_synchronous),
55     m_enabled (rhs.m_enabled),
56     m_ignore_count (rhs.m_ignore_count),
57     m_thread_spec_ap (NULL),
58     m_condition_ap (NULL)
59 {
60     if (rhs.m_thread_spec_ap.get() != NULL)
61         m_thread_spec_ap.reset (new ThreadSpec(*rhs.m_thread_spec_ap.get()));
62     if (rhs.m_condition_ap.get())
63         m_condition_ap.reset (new ClangUserExpression (rhs.m_condition_ap->GetUserText(), NULL, lldb::eLanguageTypeUnknown, ClangUserExpression::eResultTypeAny));
64 }
65 
66 //----------------------------------------------------------------------
67 // BreakpointOptions assignment operator
68 //----------------------------------------------------------------------
69 const BreakpointOptions&
70 BreakpointOptions::operator=(const BreakpointOptions& rhs)
71 {
72     m_callback = rhs.m_callback;
73     m_callback_baton_sp = rhs.m_callback_baton_sp;
74     m_callback_is_synchronous = rhs.m_callback_is_synchronous;
75     m_enabled = rhs.m_enabled;
76     m_ignore_count = rhs.m_ignore_count;
77     if (rhs.m_thread_spec_ap.get() != NULL)
78         m_thread_spec_ap.reset(new ThreadSpec(*rhs.m_thread_spec_ap.get()));
79     if (rhs.m_condition_ap.get())
80         m_condition_ap.reset (new ClangUserExpression (rhs.m_condition_ap->GetUserText(), NULL, lldb::eLanguageTypeUnknown, ClangUserExpression::eResultTypeAny));
81     return *this;
82 }
83 
84 BreakpointOptions *
85 BreakpointOptions::CopyOptionsNoCallback (BreakpointOptions &orig)
86 {
87     BreakpointHitCallback orig_callback = orig.m_callback;
88     lldb::BatonSP orig_callback_baton_sp = orig.m_callback_baton_sp;
89     bool orig_is_sync = orig.m_callback_is_synchronous;
90 
91     orig.ClearCallback();
92     BreakpointOptions *ret_val = new BreakpointOptions(orig);
93 
94     orig.SetCallback (orig_callback, orig_callback_baton_sp, orig_is_sync);
95 
96     return ret_val;
97 }
98 
99 //----------------------------------------------------------------------
100 // Destructor
101 //----------------------------------------------------------------------
102 BreakpointOptions::~BreakpointOptions()
103 {
104 }
105 
106 //------------------------------------------------------------------
107 // Callbacks
108 //------------------------------------------------------------------
109 void
110 BreakpointOptions::SetCallback (BreakpointHitCallback callback, const BatonSP &callback_baton_sp, bool callback_is_synchronous)
111 {
112     m_callback_is_synchronous = callback_is_synchronous;
113     m_callback = callback;
114     m_callback_baton_sp = callback_baton_sp;
115 }
116 
117 void
118 BreakpointOptions::ClearCallback ()
119 {
120     m_callback = BreakpointOptions::NullCallback;
121     m_callback_is_synchronous = false;
122     m_callback_baton_sp.reset();
123 }
124 
125 Baton *
126 BreakpointOptions::GetBaton ()
127 {
128     return m_callback_baton_sp.get();
129 }
130 
131 const Baton *
132 BreakpointOptions::GetBaton () const
133 {
134     return m_callback_baton_sp.get();
135 }
136 
137 bool
138 BreakpointOptions::InvokeCallback (StoppointCallbackContext *context,
139                                    lldb::user_id_t break_id,
140                                    lldb::user_id_t break_loc_id)
141 {
142     if (m_callback && context->is_synchronous == IsCallbackSynchronous())
143     {
144         return m_callback (m_callback_baton_sp ? m_callback_baton_sp->m_data : NULL,
145                            context,
146                            break_id,
147                            break_loc_id);
148     }
149     else
150         return true;
151 }
152 
153 bool
154 BreakpointOptions::HasCallback ()
155 {
156     return m_callback != BreakpointOptions::NullCallback;
157 }
158 
159 void
160 BreakpointOptions::SetCondition (const char *condition)
161 {
162     if (condition == NULL || condition[0] == '\0')
163     {
164         if (m_condition_ap.get())
165             m_condition_ap.reset();
166     }
167     else
168     {
169         m_condition_ap.reset(new ClangUserExpression (condition, NULL, lldb::eLanguageTypeUnknown, ClangUserExpression::eResultTypeAny));
170     }
171 }
172 
173 const char *
174 BreakpointOptions::GetConditionText () const
175 {
176     if (m_condition_ap.get())
177         return m_condition_ap->GetUserText();
178     else
179         return NULL;
180 }
181 
182 //------------------------------------------------------------------
183 // Enabled/Ignore Count
184 //------------------------------------------------------------------
185 bool
186 BreakpointOptions::IsEnabled () const
187 {
188     return m_enabled;
189 }
190 
191 void
192 BreakpointOptions::SetEnabled (bool enabled)
193 {
194     m_enabled = enabled;
195 }
196 
197 uint32_t
198 BreakpointOptions::GetIgnoreCount () const
199 {
200     return m_ignore_count;
201 }
202 
203 void
204 BreakpointOptions::SetIgnoreCount (uint32_t n)
205 {
206     m_ignore_count = n;
207 }
208 
209 const ThreadSpec *
210 BreakpointOptions::GetThreadSpecNoCreate () const
211 {
212     return m_thread_spec_ap.get();
213 }
214 
215 ThreadSpec *
216 BreakpointOptions::GetThreadSpec ()
217 {
218     if (m_thread_spec_ap.get() == NULL)
219         m_thread_spec_ap.reset (new ThreadSpec());
220 
221     return m_thread_spec_ap.get();
222 }
223 
224 void
225 BreakpointOptions::SetThreadID (lldb::tid_t thread_id)
226 {
227     GetThreadSpec()->SetTID(thread_id);
228 }
229 
230 void
231 BreakpointOptions::GetDescription (Stream *s, lldb::DescriptionLevel level) const
232 {
233 
234     // Figure out if there are any options not at their default value, and only print
235     // anything if there are:
236 
237     if (m_ignore_count != 0 || !m_enabled || (GetThreadSpecNoCreate() != NULL && GetThreadSpecNoCreate()->HasSpecification ()))
238     {
239         if (level == lldb::eDescriptionLevelVerbose)
240         {
241             s->EOL ();
242             s->IndentMore();
243             s->Indent();
244             s->PutCString("Breakpoint Options:\n");
245             s->IndentMore();
246             s->Indent();
247         }
248         else
249             s->PutCString(" Options: ");
250 
251         if (m_ignore_count > 0)
252             s->Printf("ignore: %d ", m_ignore_count);
253         s->Printf("%sabled ", m_enabled ? "en" : "dis");
254 
255         if (m_thread_spec_ap.get())
256             m_thread_spec_ap->GetDescription (s, level);
257         else if (level == eDescriptionLevelBrief)
258             s->PutCString ("thread spec: no ");
259         if (level == lldb::eDescriptionLevelFull)
260         {
261             s->IndentLess();
262             s->IndentMore();
263         }
264     }
265 
266     if (m_callback_baton_sp.get())
267     {
268         if (level != eDescriptionLevelBrief)
269         {
270             s->EOL();
271             m_callback_baton_sp->GetDescription (s, level);
272         }
273     }
274     if (m_condition_ap.get())
275     {
276        if (level != eDescriptionLevelBrief)
277        {
278             s->EOL();
279             s->Printf("Condition: %s\n", m_condition_ap->GetUserText());
280         }
281     }
282 }
283 
284 void
285 BreakpointOptions::CommandBaton::GetDescription (Stream *s, lldb::DescriptionLevel level) const
286 {
287     CommandData *data = (CommandData *)m_data;
288 
289     if (level == eDescriptionLevelBrief)
290     {
291         s->Printf (", commands = %s", (data && data->user_source.GetSize() > 0) ? "yes" : "no");
292         return;
293     }
294 
295     s->IndentMore ();
296     s->Indent("Breakpoint commands:\n");
297 
298     s->IndentMore ();
299     if (data && data->user_source.GetSize() > 0)
300     {
301         const size_t num_strings = data->user_source.GetSize();
302         for (size_t i = 0; i < num_strings; ++i)
303         {
304             s->Indent(data->user_source.GetStringAtIndex(i));
305             s->EOL();
306         }
307     }
308     else
309     {
310         s->PutCString ("No commands.\n");
311     }
312     s->IndentLess ();
313     s->IndentLess ();
314 }
315 
316