LLDB mainline
SystemRuntimeMacOSX.h
Go to the documentation of this file.
1//===-- SystemRuntimeMacOSX.h -----------------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLDB_SOURCE_PLUGINS_SYSTEMRUNTIME_MACOSX_SYSTEMRUNTIMEMACOSX_H
10#define LLDB_SOURCE_PLUGINS_SYSTEMRUNTIME_MACOSX_SYSTEMRUNTIMEMACOSX_H
11
12#include <mutex>
13#include <string>
14#include <vector>
15
16// Other libraries and framework include
18#include "lldb/Target/Process.h"
24#include "lldb/Utility/UUID.h"
25
30
32public:
34
35 ~SystemRuntimeMacOSX() override;
36
37 // Static Functions
38 static void Initialize();
39
40 static void Terminate();
41
42 static llvm::StringRef GetPluginNameStatic() {
43 return "systemruntime-macosx";
44 }
45
48
49 // instance methods
50
51 void Clear(bool clear_process);
52
53 void Detach() override;
54
55 const std::vector<lldb_private::ConstString> &
57
60 lldb_private::ConstString type) override;
61
64 lldb_private::ConstString type) override;
65
67
68 void PopulateQueueList(lldb_private::QueueList &queue_list) override;
69
70 void PopulateQueuesUsingLibBTR(lldb::addr_t queues_buffer,
71 uint64_t queues_buffer_size, uint64_t count,
72 lldb_private::QueueList &queue_list);
73
75 uint64_t items_buffer_size,
76 uint64_t count,
77 lldb_private::Queue *queue);
78
79 std::string
80 GetQueueNameFromThreadQAddress(lldb::addr_t dispatch_qaddr) override;
81
83 GetQueueIDFromThreadQAddress(lldb::addr_t dispatch_qaddr) override;
84
86 lldb::addr_t dispatch_qaddr) override;
87
89
91 lldb::addr_t item_ref) override;
92
93 lldb::QueueKind GetQueueKind(lldb::addr_t dispatch_queue_addr) override;
94
97
98 bool SafeToCallFunctionsOnThisThread(lldb::ThreadSP thread_sp) override;
99
100 // PluginInterface protocol
101 llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
102
103protected:
105 mutable std::recursive_mutex m_mutex;
106
107private:
109 uint16_t queue_info_version = 0;
111 uint16_t item_info_version = 0;
113
115 };
116
117 // A structure which reflects the data recorded in the
118 // libBacktraceRecording introspection_dispatch_item_info_s.
119 struct ItemInfo {
126 uint32_t stop_id;
127 std::vector<lldb::addr_t> enqueuing_callstack;
131 };
132
133 // The offsets of different fields of the dispatch_queue_t structure in
134 // a thread/queue process.
135 // Based on libdispatch src/queue_private.h, struct dispatch_queue_offsets_s
136 // With dqo_version 1-3, the dqo_label field is a per-queue value and cannot
137 // be cached.
138 // With dqo_version 4 (Mac OS X 10.9 / iOS 7), dqo_label is a constant value
139 // that can be cached.
141 uint16_t dqo_version;
142 uint16_t dqo_label;
144 uint16_t dqo_flags;
148 uint16_t dqo_width;
150 uint16_t dqo_running;
152
153 uint16_t dqo_suspend_cnt; // version 5 and later, starting with Mac OS X
154 // 10.10/iOS 8
155 uint16_t dqo_suspend_cnt_size; // version 5 and later, starting with Mac OS
156 // X 10.10/iOS 8
157 uint16_t dqo_target_queue; // version 5 and later, starting with Mac OS X
158 // 10.10/iOS 8
159 uint16_t dqo_target_queue_size; // version 5 and later, starting with Mac OS
160 // X 10.10/iOS 8
161 uint16_t
162 dqo_priority; // version 5 and later, starting with Mac OS X 10.10/iOS 8
163 uint16_t dqo_priority_size; // version 5 and later, starting with Mac OS X
164 // 10.10/iOS 8
165
167 dqo_version = UINT16_MAX;
168 dqo_flags = UINT16_MAX;
169 dqo_serialnum = UINT16_MAX;
170 dqo_label = UINT16_MAX;
171 dqo_width = UINT16_MAX;
172 dqo_running = UINT16_MAX;
173 dqo_suspend_cnt = UINT16_MAX;
174 dqo_target_queue = UINT16_MAX;
175 dqo_target_queue = UINT16_MAX;
176 dqo_priority = UINT16_MAX;
177 dqo_label_size = 0;
178 dqo_flags_size = 0;
180 dqo_width_size = 0;
185 }
186
187 bool IsValid() { return dqo_version != UINT16_MAX; }
188
189 bool LabelIsValid() { return dqo_label != UINT16_MAX; }
190 };
191
193 uint16_t vo_version = UINT16_MAX;
194 uint16_t vo_activity_ids_count = UINT16_MAX;
195 uint16_t vo_activity_ids_count_size = UINT16_MAX;
196 uint16_t vo_activity_ids_array = UINT16_MAX;
197 uint16_t vo_activity_ids_array_entry_size = UINT16_MAX;
198
200
201 bool IsValid() { return vo_version != UINT16_MAX; }
202 };
203
205 uint16_t dti_version = UINT16_MAX;
209
211
212 bool IsValid() { return dti_version != UINT16_MAX; }
213 };
214
216 uint16_t plo_version = UINT16_MAX;
217 uint16_t plo_pthread_tsd_base_offset = UINT16_MAX;
219 uint16_t plo_pthread_tsd_entry_size = UINT16_MAX;
220
221 LibpthreadOffsets() = default;
222
223 bool IsValid() { return plo_version != UINT16_MAX; }
224 };
225
226 // The libBacktraceRecording function
227 // __introspection_dispatch_queue_get_pending_items has
228 // two forms. It can either return a simple array of item_refs (void *) size
229 // or it can return
230 // a header with uint32_t version, a uint32_t size of item, and then an array
231 // of item_refs (void*)
232 // and code addresses (void*) for all the pending blocks.
233
237 };
238
240 bool new_style; // new-style means both item_refs and code_addresses avail
241 // old-style means only item_refs is filled in
242 std::vector<ItemRefAndCodeAddress> item_refs_and_code_addresses;
243 };
244
246
248
250
252
254
256
258
260
262
267
271
274
277
280
283
286};
287
288#endif // LLDB_SOURCE_PLUGINS_SYSTEMRUNTIME_MACOSX_SYSTEMRUNTIMEMACOSX_H
lldb::addr_t m_dispatch_tsd_indexes_addr
lldb::ThreadSP GetExtendedBacktraceThread(lldb::ThreadSP thread, lldb_private::ConstString type) override
Return a Thread which shows the origin of this thread's creation.
PendingItemsForQueue GetPendingItemRefsForQueue(lldb::addr_t queue)
lldb::queue_id_t GetQueueIDFromThreadQAddress(lldb::addr_t dispatch_qaddr) override
Get the QueueID for the libdispatch queue given the thread's dispatch_qaddr.
lldb_private::AppleGetPendingItemsHandler m_get_pending_items_handler
lldb_private::AppleGetQueuesHandler m_get_queues_handler
struct LibdispatchTSDIndexes m_libdispatch_tsd_indexes
const SystemRuntimeMacOSX & operator=(const SystemRuntimeMacOSX &)=delete
libBacktraceRecording_info m_lib_backtrace_recording_info
lldb_private::AppleGetItemInfoHandler m_get_item_info_handler
llvm::StringRef GetPluginName() override
lldb::addr_t m_dispatch_queue_offsets_addr
std::string GetQueueNameFromThreadQAddress(lldb::addr_t dispatch_qaddr) override
Get the queue name for a thread given a thread's dispatch_qaddr.
void PopulateQueuesUsingLibBTR(lldb::addr_t queues_buffer, uint64_t queues_buffer_size, uint64_t count, lldb_private::QueueList &queue_list)
void Detach() override
Called before detaching from a process.
struct LibdispatchOffsets m_libdispatch_offsets
std::recursive_mutex m_mutex
void PopulatePendingItemsForQueue(lldb_private::Queue *queue) override
Get the pending work items for a libdispatch Queue.
const std::vector< lldb_private::ConstString > & GetExtendedBacktraceTypes() override
Return a list of thread origin extended backtraces that may be available.
lldb_private::AppleGetThreadItemInfoHandler m_get_thread_item_info_handler
lldb::addr_t GetLibdispatchQueueAddressFromThreadQAddress(lldb::addr_t dispatch_qaddr) override
Get the libdispatch_queue_t address for the queue given the thread's dispatch_qaddr.
struct LibdispatchVoucherOffsets m_libdispatch_voucher_offsets
lldb::QueueKind GetQueueKind(lldb::addr_t dispatch_queue_addr) override
Retrieve the Queue kind for the queue at a thread's dispatch_qaddr.
ItemInfo ExtractItemInfoFromBuffer(lldb_private::DataExtractor &extractor)
lldb::addr_t m_libpthread_layout_offsets_addr
lldb::addr_t m_dispatch_voucher_offsets_addr
bool SafeToCallFunctionsOnThisThread(lldb::ThreadSP thread_sp) override
Determine whether it is safe to run an expression on a given thread.
void CompleteQueueItem(lldb_private::QueueItem *queue_item, lldb::addr_t item_ref) override
Complete the fields in a QueueItem.
void PopulatePendingQueuesUsingLibBTR(lldb::addr_t items_buffer, uint64_t items_buffer_size, uint64_t count, lldb_private::Queue *queue)
static lldb_private::SystemRuntime * CreateInstance(lldb_private::Process *process)
void AddThreadExtendedInfoPacketHints(lldb_private::StructuredData::ObjectSP dict) override
Add key-value pairs to the StructuredData dictionary object with information debugserver may need whe...
lldb::ThreadSP GetExtendedBacktraceFromItemRef(lldb::addr_t item_ref)
struct LibpthreadOffsets m_libpthread_offsets
lldb::ThreadSP GetExtendedBacktraceForQueueItem(lldb::QueueItemSP queue_item_sp, lldb_private::ConstString type) override
Get the extended backtrace thread for a QueueItem.
void Clear(bool clear_process)
lldb::user_id_t m_break_id
void PopulateQueueList(lldb_private::QueueList &queue_list) override
Populate the Process' QueueList with libdispatch / GCD queues that exist.
SystemRuntimeMacOSX(const SystemRuntimeMacOSX &)=delete
static llvm::StringRef GetPluginNameStatic()
A uniqued constant string class.
Definition: ConstString.h:40
An data extractor class.
Definition: DataExtractor.h:48
A plug-in interface definition class for debugging a process.
Definition: Process.h:341
std::shared_ptr< Object > ObjectSP
A plug-in interface definition class for system runtimes.
Definition: SystemRuntime.h:43
#define UINT64_MAX
Definition: lldb-defines.h:23
std::shared_ptr< lldb_private::Thread > ThreadSP
Definition: lldb-forward.h:438
QueueKind
Queue type.
uint64_t user_id_t
Definition: lldb-types.h:82
uint64_t addr_t
Definition: lldb-types.h:80
uint64_t queue_id_t
Definition: lldb-types.h:90
std::shared_ptr< lldb_private::QueueItem > QueueItemSP
Definition: lldb-forward.h:392
std::vector< lldb::addr_t > enqueuing_callstack
std::vector< ItemRefAndCodeAddress > item_refs_and_code_addresses