1 //===-- SystemRuntime.h -----------------------------------------*- 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 #ifndef liblldb_SystemRuntime_h_
11 #define liblldb_SystemRuntime_h_
15 // Other libraries and framework includes
19 #include "lldb/lldb-public.h"
20 #include "lldb/Core/ConstString.h"
21 #include "lldb/Core/ModuleList.h"
22 #include "lldb/Core/PluginInterface.h"
23 #include "lldb/Core/StructuredData.h"
24 #include "lldb/Target/QueueList.h"
25 #include "lldb/Target/QueueItem.h"
26 #include "lldb/lldb-private.h"
28 namespace lldb_private {
30 //----------------------------------------------------------------------
31 /// @class SystemRuntime SystemRuntime.h "lldb/Target/SystemRuntime.h"
32 /// @brief A plug-in interface definition class for system runtimes.
34 /// The system runtime plugins can collect information from the system
35 /// libraries during a Process' lifetime and provide information about
36 /// how objects/threads were originated.
38 /// For instance, a system runtime plugin use a breakpoint when threads
39 /// are created to record the backtrace of where that thread was created.
40 /// Later, when backtracing the created thread, it could extend the backtrace
41 /// to show where it was originally created from.
43 /// The plugin will insert its own breakpoint when Created and start collecting
44 /// information. Later when it comes time to augment a Thread, it can be
45 /// asked to provide that information.
47 //----------------------------------------------------------------------
50 public PluginInterface
53 //------------------------------------------------------------------
54 /// Find a system runtime plugin for a given process.
56 /// Scans the installed SystemRuntime plugins and tries to find
57 /// an instance that can be used to track image changes in \a
60 /// @param[in] process
61 /// The process for which to try and locate a system runtime
63 //------------------------------------------------------------------
65 FindPlugin (Process *process);
67 //------------------------------------------------------------------
68 /// Construct with a process.
69 // -----------------------------------------------------------------
70 SystemRuntime(lldb_private::Process *process);
72 //------------------------------------------------------------------
75 /// The destructor is virtual since this class is designed to be
76 /// inherited by the plug-in instance.
77 //------------------------------------------------------------------
81 //------------------------------------------------------------------
82 /// Called after attaching to a process.
84 /// Allow the SystemRuntime plugin to execute some code after attaching
86 //------------------------------------------------------------------
90 //------------------------------------------------------------------
91 /// Called after launching a process.
93 /// Allow the SystemRuntime plugin to execute some code after launching
95 //------------------------------------------------------------------
99 //------------------------------------------------------------------
100 /// Called when modules have been loaded in the process.
102 /// Allow the SystemRuntime plugin to enable logging features in the
103 /// system runtime libraries.
104 //------------------------------------------------------------------
106 ModulesDidLoad(lldb_private::ModuleList &module_list);
108 //------------------------------------------------------------------
109 /// Called before detaching from a process.
111 /// This will give a SystemRuntime plugin a chance to free any resources
112 /// in the inferior process before we detach.
113 //------------------------------------------------------------------
117 //------------------------------------------------------------------
118 /// Return a list of thread origin extended backtraces that may
121 /// A System Runtime may be able to provide a backtrace of when this
122 /// thread was originally created. Furthermore, it may be able to
123 /// provide that extended backtrace for different styles of creation.
124 /// On a system with both pthreads and libdispatch, aka Grand Central
125 /// Dispatch, queues, the system runtime may be able to provide the
126 /// pthread creation of the thread and it may also be able to provide
127 /// the backtrace of when this GCD queue work block was enqueued.
128 /// The caller may request these different origins by name.
130 /// The names will be provided in the order that they are most likely
131 /// to be requested. For instance, a most natural order may be to
132 /// request the GCD libdispatch queue origin. If there is none, then
133 /// request the pthread origin.
136 /// A vector of ConstStrings with names like "pthread" or "libdispatch".
137 /// An empty vector may be returned if no thread origin extended
138 /// backtrace capabilities are available.
139 //------------------------------------------------------------------
140 virtual const std::vector<ConstString> &
141 GetExtendedBacktraceTypes ();
143 //------------------------------------------------------------------
144 /// Return a Thread which shows the origin of this thread's creation.
146 /// This likely returns a HistoryThread which shows how thread was
147 /// originally created (e.g. "pthread" type), or how the work that
148 /// is currently executing on it was originally enqueued (e.g.
149 /// "libdispatch" type).
151 /// There may be a chain of thread-origins; it may be informative to
152 /// the end user to query the returned ThreadSP for its origins as
155 /// @param [in] thread
156 /// The thread to examine.
159 /// The type of thread origin being requested. The types supported
160 /// are returned from SystemRuntime::GetExtendedBacktraceTypes.
163 /// A ThreadSP which will have a StackList of frames. This Thread will
164 /// not appear in the Process' list of current threads. Normal thread
165 /// operations like stepping will not be available. This is a historical
166 /// view thread and may be only useful for showing a backtrace.
168 /// An empty ThreadSP will be returned if no thread origin is available.
169 //------------------------------------------------------------------
170 virtual lldb::ThreadSP
171 GetExtendedBacktraceThread (lldb::ThreadSP thread, ConstString type);
173 //------------------------------------------------------------------
174 /// Get the extended backtrace thread for a QueueItem
176 /// A QueueItem represents a function/block that will be executed on
177 /// a libdispatch queue in the future, or it represents a function/block
178 /// that is currently executing on a thread.
180 /// This method will report a thread backtrace of the function that
181 /// enqueued it originally, if possible.
183 /// @param [in] queue_item_sp
184 /// The QueueItem that we are getting an extended backtrace for.
187 /// The type of extended backtrace to fetch. The types supported
188 /// are returned from SystemRuntime::GetExtendedBacktraceTypes.
191 /// If an extended backtrace is available, it is returned. Else
192 /// an empty ThreadSP is returned.
193 //------------------------------------------------------------------
194 virtual lldb::ThreadSP
195 GetExtendedBacktraceForQueueItem (lldb::QueueItemSP queue_item_sp, ConstString type)
197 return lldb::ThreadSP();
200 //------------------------------------------------------------------
201 /// Populate the Process' QueueList with libdispatch / GCD queues that exist.
203 /// When process execution is paused, the SystemRuntime may be called to fill
204 /// in the list of Queues that currently exist.
206 /// @param [out] queue_list
207 /// This QueueList will be cleared, and any queues that currently exist
208 /// will be added. An empty QueueList will be returned if no queues
209 /// exist or if this Systemruntime does not support libdispatch queues.
210 //------------------------------------------------------------------
212 PopulateQueueList (lldb_private::QueueList &queue_list)
216 //------------------------------------------------------------------
217 /// Get the queue name for a thread given a thread's dispatch_qaddr.
219 /// On systems using libdispatch queues, a thread may be associated with a queue.
220 /// There will be a call to get the thread's dispatch_qaddr. At the dispatch_qaddr
221 /// we will find the address of this thread's dispatch_queue_t structure.
222 /// Given the address of the dispatch_queue_t structure for a thread,
223 /// get the queue name and return it.
225 /// @param [in] dispatch_qaddr
226 /// The address of the dispatch_qaddr pointer for this thread.
229 /// The string of this queue's name. An empty string is returned if the
230 /// name could not be found.
231 //------------------------------------------------------------------
233 GetQueueNameFromThreadQAddress (lldb::addr_t dispatch_qaddr)
238 //------------------------------------------------------------------
239 /// Get the QueueID for the libdispatch queue given the thread's dispatch_qaddr.
241 /// On systems using libdispatch queues, a thread may be associated with a queue.
242 /// There will be a call to get the thread's dispatch_qaddr. At the dispatch_qaddr
243 /// we will find the address of this thread's dispatch_queue_t structure.
244 /// Given the address of the dispatch_queue_t structure for a thread,
245 /// get the queue ID and return it.
247 /// @param [in] dispatch_qaddr
248 /// The address of the dispatch_qaddr pointer for this thread.
251 /// The queue ID, or if it could not be retrieved, LLDB_INVALID_QUEUE_ID.
252 //------------------------------------------------------------------
253 virtual lldb::queue_id_t
254 GetQueueIDFromThreadQAddress (lldb::addr_t dispatch_qaddr)
256 return LLDB_INVALID_QUEUE_ID;
259 //------------------------------------------------------------------
260 /// Get the libdispatch_queue_t address for the queue given the thread's dispatch_qaddr.
262 /// On systems using libdispatch queues, a thread may be associated with a queue.
263 /// There will be a call to get the thread's dispatch_qaddr.
264 /// Given the thread's dispatch_qaddr, find the libdispatch_queue_t address and
267 /// @param [in] dispatch_qaddr
268 /// The address of the dispatch_qaddr pointer for this thread.
271 /// The libdispatch_queue_t address, or LLDB_INVALID_ADDRESS if unavailable/not found.
272 //------------------------------------------------------------------
274 GetLibdispatchQueueAddressFromThreadQAddress (lldb::addr_t dispatch_qaddr)
276 return LLDB_INVALID_ADDRESS;
279 //------------------------------------------------------------------
280 /// Get the pending work items for a libdispatch Queue
282 /// If this system/process is using libdispatch and the runtime can do so,
283 /// retrieve the list of pending work items for the specified Queue and
284 /// add it to the Queue.
286 /// @param [in] queue
287 /// The queue of interest.
288 //------------------------------------------------------------------
290 PopulatePendingItemsForQueue (lldb_private::Queue *queue)
294 //------------------------------------------------------------------
295 /// Complete the fields in a QueueItem
297 /// PopulatePendingItemsForQueue() may not fill in all of the QueueItem
298 /// details; when the remaining fields are needed, they will be
299 /// fetched by call this method.
301 /// @param [in] queue_item
302 /// The QueueItem that we will be completing.
304 /// @param [in] item_ref
305 /// The item_ref token that is needed to retrieve the rest of the
306 /// information about the QueueItem.
307 //------------------------------------------------------------------
309 CompleteQueueItem (lldb_private::QueueItem *queue_item, lldb::addr_t item_ref)
313 //------------------------------------------------------------------
314 /// Add key-value pairs to the StructuredData dictionary object with
315 /// information debugserver may need when constructing the jThreadExtendedInfo
318 /// @param [out] dict
319 /// Dictionary to which key-value pairs should be added; they will
320 /// be sent to the remote gdb server stub as arguments in the
321 /// jThreadExtendedInfo request.
322 //------------------------------------------------------------------
324 AddThreadExtendedInfoPacketHints (lldb_private::StructuredData::ObjectSP dict)
328 /// Determine whether it is safe to run an expression on a given thread
330 /// If a system must not run functions on a thread in some particular state,
331 /// this method gives a way for it to flag that the expression should not be
334 /// @param [in] thread_sp
335 /// The thread we want to run the expression on.
338 /// True will be returned if there are no known problems with running an
339 /// expression on this thread. False means that the inferior function
340 /// call should not be made on this thread.
341 //------------------------------------------------------------------
343 SafeToCallFunctionsOnThisThread (lldb::ThreadSP thread_sp)
349 //------------------------------------------------------------------
351 //------------------------------------------------------------------
354 std::vector<ConstString> m_types;
357 DISALLOW_COPY_AND_ASSIGN (SystemRuntime);
360 } // namespace lldb_private
362 #endif // liblldb_SystemRuntime_h_