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 //------------------------------------------------------------------
78 ~SystemRuntime() override;
80 //------------------------------------------------------------------
81 /// Called after attaching to a process.
83 /// Allow the SystemRuntime plugin to execute some code after attaching
85 //------------------------------------------------------------------
89 //------------------------------------------------------------------
90 /// Called after launching a process.
92 /// Allow the SystemRuntime plugin to execute some code after launching
94 //------------------------------------------------------------------
98 //------------------------------------------------------------------
99 /// Called when modules have been loaded in the process.
101 /// Allow the SystemRuntime plugin to enable logging features in the
102 /// system runtime libraries.
103 //------------------------------------------------------------------
105 ModulesDidLoad(lldb_private::ModuleList &module_list);
107 //------------------------------------------------------------------
108 /// Called before detaching from a process.
110 /// This will give a SystemRuntime plugin a chance to free any resources
111 /// in the inferior process before we detach.
112 //------------------------------------------------------------------
116 //------------------------------------------------------------------
117 /// Return a list of thread origin extended backtraces that may
120 /// A System Runtime may be able to provide a backtrace of when this
121 /// thread was originally created. Furthermore, it may be able to
122 /// provide that extended backtrace for different styles of creation.
123 /// On a system with both pthreads and libdispatch, aka Grand Central
124 /// Dispatch, queues, the system runtime may be able to provide the
125 /// pthread creation of the thread and it may also be able to provide
126 /// the backtrace of when this GCD queue work block was enqueued.
127 /// The caller may request these different origins by name.
129 /// The names will be provided in the order that they are most likely
130 /// to be requested. For instance, a most natural order may be to
131 /// request the GCD libdispatch queue origin. If there is none, then
132 /// request the pthread origin.
135 /// A vector of ConstStrings with names like "pthread" or "libdispatch".
136 /// An empty vector may be returned if no thread origin extended
137 /// backtrace capabilities are available.
138 //------------------------------------------------------------------
139 virtual const std::vector<ConstString> &
140 GetExtendedBacktraceTypes ();
142 //------------------------------------------------------------------
143 /// Return a Thread which shows the origin of this thread's creation.
145 /// This likely returns a HistoryThread which shows how thread was
146 /// originally created (e.g. "pthread" type), or how the work that
147 /// is currently executing on it was originally enqueued (e.g.
148 /// "libdispatch" type).
150 /// There may be a chain of thread-origins; it may be informative to
151 /// the end user to query the returned ThreadSP for its origins as
154 /// @param [in] thread
155 /// The thread to examine.
158 /// The type of thread origin being requested. The types supported
159 /// are returned from SystemRuntime::GetExtendedBacktraceTypes.
162 /// A ThreadSP which will have a StackList of frames. This Thread will
163 /// not appear in the Process' list of current threads. Normal thread
164 /// operations like stepping will not be available. This is a historical
165 /// view thread and may be only useful for showing a backtrace.
167 /// An empty ThreadSP will be returned if no thread origin is available.
168 //------------------------------------------------------------------
169 virtual lldb::ThreadSP
170 GetExtendedBacktraceThread (lldb::ThreadSP thread, ConstString type);
172 //------------------------------------------------------------------
173 /// Get the extended backtrace thread for a QueueItem
175 /// A QueueItem represents a function/block that will be executed on
176 /// a libdispatch queue in the future, or it represents a function/block
177 /// that is currently executing on a thread.
179 /// This method will report a thread backtrace of the function that
180 /// enqueued it originally, if possible.
182 /// @param [in] queue_item_sp
183 /// The QueueItem that we are getting an extended backtrace for.
186 /// The type of extended backtrace to fetch. The types supported
187 /// are returned from SystemRuntime::GetExtendedBacktraceTypes.
190 /// If an extended backtrace is available, it is returned. Else
191 /// an empty ThreadSP is returned.
192 //------------------------------------------------------------------
193 virtual lldb::ThreadSP
194 GetExtendedBacktraceForQueueItem (lldb::QueueItemSP queue_item_sp, ConstString type)
196 return lldb::ThreadSP();
199 //------------------------------------------------------------------
200 /// Populate the Process' QueueList with libdispatch / GCD queues that exist.
202 /// When process execution is paused, the SystemRuntime may be called to fill
203 /// in the list of Queues that currently exist.
205 /// @param [out] queue_list
206 /// This QueueList will be cleared, and any queues that currently exist
207 /// will be added. An empty QueueList will be returned if no queues
208 /// exist or if this Systemruntime does not support libdispatch queues.
209 //------------------------------------------------------------------
211 PopulateQueueList (lldb_private::QueueList &queue_list)
215 //------------------------------------------------------------------
216 /// Get the queue name for a thread given a thread's dispatch_qaddr.
218 /// On systems using libdispatch queues, a thread may be associated with a queue.
219 /// There will be a call to get the thread's dispatch_qaddr. At the dispatch_qaddr
220 /// we will find the address of this thread's dispatch_queue_t structure.
221 /// Given the address of the dispatch_queue_t structure for a thread,
222 /// get the queue name and return it.
224 /// @param [in] dispatch_qaddr
225 /// The address of the dispatch_qaddr pointer for this thread.
228 /// The string of this queue's name. An empty string is returned if the
229 /// name could not be found.
230 //------------------------------------------------------------------
232 GetQueueNameFromThreadQAddress (lldb::addr_t dispatch_qaddr)
237 //------------------------------------------------------------------
238 /// Get the QueueID for the libdispatch queue given the thread's dispatch_qaddr.
240 /// On systems using libdispatch queues, a thread may be associated with a queue.
241 /// There will be a call to get the thread's dispatch_qaddr. At the dispatch_qaddr
242 /// we will find the address of this thread's dispatch_queue_t structure.
243 /// Given the address of the dispatch_queue_t structure for a thread,
244 /// get the queue ID and return it.
246 /// @param [in] dispatch_qaddr
247 /// The address of the dispatch_qaddr pointer for this thread.
250 /// The queue ID, or if it could not be retrieved, LLDB_INVALID_QUEUE_ID.
251 //------------------------------------------------------------------
252 virtual lldb::queue_id_t
253 GetQueueIDFromThreadQAddress (lldb::addr_t dispatch_qaddr)
255 return LLDB_INVALID_QUEUE_ID;
258 //------------------------------------------------------------------
259 /// Get the libdispatch_queue_t address for the queue given the thread's dispatch_qaddr.
261 /// On systems using libdispatch queues, a thread may be associated with a queue.
262 /// There will be a call to get the thread's dispatch_qaddr.
263 /// Given the thread's dispatch_qaddr, find the libdispatch_queue_t address and
266 /// @param [in] dispatch_qaddr
267 /// The address of the dispatch_qaddr pointer for this thread.
270 /// The libdispatch_queue_t address, or LLDB_INVALID_ADDRESS if unavailable/not found.
271 //------------------------------------------------------------------
273 GetLibdispatchQueueAddressFromThreadQAddress (lldb::addr_t dispatch_qaddr)
275 return LLDB_INVALID_ADDRESS;
279 //------------------------------------------------------------------
280 /// Retrieve the Queue kind for the queue at a thread's dispatch_qaddr.
282 /// Retrieve the Queue kind - either eQueueKindSerial or
283 /// eQueueKindConcurrent, indicating that this queue processes work
284 /// items serially or concurrently.
287 /// The Queue kind, if it could be read, else eQueueKindUnknown.
288 //------------------------------------------------------------------
289 virtual lldb::QueueKind
290 GetQueueKind (lldb::addr_t dispatch_qaddr)
292 return lldb::eQueueKindUnknown;
295 //------------------------------------------------------------------
296 /// Get the pending work items for a libdispatch Queue
298 /// If this system/process is using libdispatch and the runtime can do so,
299 /// retrieve the list of pending work items for the specified Queue and
300 /// add it to the Queue.
302 /// @param [in] queue
303 /// The queue of interest.
304 //------------------------------------------------------------------
306 PopulatePendingItemsForQueue (lldb_private::Queue *queue)
310 //------------------------------------------------------------------
311 /// Complete the fields in a QueueItem
313 /// PopulatePendingItemsForQueue() may not fill in all of the QueueItem
314 /// details; when the remaining fields are needed, they will be
315 /// fetched by call this method.
317 /// @param [in] queue_item
318 /// The QueueItem that we will be completing.
320 /// @param [in] item_ref
321 /// The item_ref token that is needed to retrieve the rest of the
322 /// information about the QueueItem.
323 //------------------------------------------------------------------
325 CompleteQueueItem (lldb_private::QueueItem *queue_item, lldb::addr_t item_ref)
329 //------------------------------------------------------------------
330 /// Add key-value pairs to the StructuredData dictionary object with
331 /// information debugserver may need when constructing the jThreadExtendedInfo
334 /// @param [out] dict
335 /// Dictionary to which key-value pairs should be added; they will
336 /// be sent to the remote gdb server stub as arguments in the
337 /// jThreadExtendedInfo request.
338 //------------------------------------------------------------------
340 AddThreadExtendedInfoPacketHints (lldb_private::StructuredData::ObjectSP dict)
344 /// Determine whether it is safe to run an expression on a given thread
346 /// If a system must not run functions on a thread in some particular state,
347 /// this method gives a way for it to flag that the expression should not be
350 /// @param [in] thread_sp
351 /// The thread we want to run the expression on.
354 /// True will be returned if there are no known problems with running an
355 /// expression on this thread. False means that the inferior function
356 /// call should not be made on this thread.
357 //------------------------------------------------------------------
359 SafeToCallFunctionsOnThisThread (lldb::ThreadSP thread_sp)
365 //------------------------------------------------------------------
367 //------------------------------------------------------------------
370 std::vector<ConstString> m_types;
374 DISALLOW_COPY_AND_ASSIGN (SystemRuntime);
377 } // namespace lldb_private
379 #endif // liblldb_SystemRuntime_h_