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
17 #include "lldb/Core/ModuleList.h"
18 #include "lldb/Target/Process.h"
19 #include "lldb/Target/QueueItem.h"
20 #include "lldb/Target/SystemRuntime.h"
21 #include "lldb/Utility/ConstString.h"
22 #include "lldb/Utility/FileSpec.h"
23 #include "lldb/Utility/StructuredData.h"
24 #include "lldb/Utility/UUID.h"
25 
26 #include "AppleGetItemInfoHandler.h"
27 #include "AppleGetPendingItemsHandler.h"
28 #include "AppleGetQueuesHandler.h"
29 #include "AppleGetThreadItemInfoHandler.h"
30 
31 class SystemRuntimeMacOSX : public lldb_private::SystemRuntime {
32 public:
33   SystemRuntimeMacOSX(lldb_private::Process *process);
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 
46   static lldb_private::SystemRuntime *
47   CreateInstance(lldb_private::Process *process);
48 
49   // instance methods
50 
51   void Clear(bool clear_process);
52 
53   void Detach() override;
54 
55   const std::vector<lldb_private::ConstString> &
56   GetExtendedBacktraceTypes() override;
57 
58   lldb::ThreadSP
59   GetExtendedBacktraceThread(lldb::ThreadSP thread,
60                              lldb_private::ConstString type) override;
61 
62   lldb::ThreadSP
63   GetExtendedBacktraceForQueueItem(lldb::QueueItemSP queue_item_sp,
64                                    lldb_private::ConstString type) override;
65 
66   lldb::ThreadSP GetExtendedBacktraceFromItemRef(lldb::addr_t item_ref);
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 
74   void PopulatePendingQueuesUsingLibBTR(lldb::addr_t items_buffer,
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 
82   lldb::queue_id_t
83   GetQueueIDFromThreadQAddress(lldb::addr_t dispatch_qaddr) override;
84 
85   lldb::addr_t GetLibdispatchQueueAddressFromThreadQAddress(
86       lldb::addr_t dispatch_qaddr) override;
87 
88   void PopulatePendingItemsForQueue(lldb_private::Queue *queue) override;
89 
90   void CompleteQueueItem(lldb_private::QueueItem *queue_item,
91                          lldb::addr_t item_ref) override;
92 
93   lldb::QueueKind GetQueueKind(lldb::addr_t dispatch_queue_addr) override;
94 
95   void AddThreadExtendedInfoPacketHints(
96       lldb_private::StructuredData::ObjectSP dict) override;
97 
98   bool SafeToCallFunctionsOnThisThread(lldb::ThreadSP thread_sp) override;
99 
100   // PluginInterface protocol
101   llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
102 
103 protected:
104   lldb::user_id_t m_break_id;
105   mutable std::recursive_mutex m_mutex;
106 
107 private:
108   struct libBacktraceRecording_info {
109     uint16_t queue_info_version = 0;
110     uint16_t queue_info_data_offset = 0;
111     uint16_t item_info_version = 0;
112     uint16_t item_info_data_offset = 0;
113 
114     libBacktraceRecording_info() = default;
115   };
116 
117   // A structure which reflects the data recorded in the
118   // libBacktraceRecording introspection_dispatch_item_info_s.
119   struct ItemInfo {
120     lldb::addr_t item_that_enqueued_this;
121     lldb::addr_t function_or_block;
122     uint64_t enqueuing_thread_id;
123     uint64_t enqueuing_queue_serialnum;
124     uint64_t target_queue_serialnum;
125     uint32_t enqueuing_callstack_frame_count;
126     uint32_t stop_id;
127     std::vector<lldb::addr_t> enqueuing_callstack;
128     std::string enqueuing_thread_label;
129     std::string enqueuing_queue_label;
130     std::string target_queue_label;
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.
140   struct LibdispatchOffsets {
141     uint16_t dqo_version;
142     uint16_t dqo_label;
143     uint16_t dqo_label_size;
144     uint16_t dqo_flags;
145     uint16_t dqo_flags_size;
146     uint16_t dqo_serialnum;
147     uint16_t dqo_serialnum_size;
148     uint16_t dqo_width;
149     uint16_t dqo_width_size;
150     uint16_t dqo_running;
151     uint16_t dqo_running_size;
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 
166     LibdispatchOffsets() {
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     }
178 
179     bool IsValid() { return dqo_version != UINT16_MAX; }
180 
181     bool LabelIsValid() { return dqo_label != UINT16_MAX; }
182   };
183 
184   struct LibdispatchVoucherOffsets {
185     uint16_t vo_version = UINT16_MAX;
186     uint16_t vo_activity_ids_count = UINT16_MAX;
187     uint16_t vo_activity_ids_count_size = UINT16_MAX;
188     uint16_t vo_activity_ids_array = UINT16_MAX;
189     uint16_t vo_activity_ids_array_entry_size = UINT16_MAX;
190 
191     LibdispatchVoucherOffsets() = default;
192 
193     bool IsValid() { return vo_version != UINT16_MAX; }
194   };
195 
196   struct LibdispatchTSDIndexes {
197     uint16_t dti_version = UINT16_MAX;
198     uint64_t dti_queue_index = UINT64_MAX;
199     uint64_t dti_voucher_index = UINT64_MAX;
200     uint64_t dti_qos_class_index = UINT64_MAX;
201 
202     LibdispatchTSDIndexes() = default;
203 
204     bool IsValid() { return dti_version != UINT16_MAX; }
205   };
206 
207   struct LibpthreadOffsets {
208     uint16_t plo_version = UINT16_MAX;
209     uint16_t plo_pthread_tsd_base_offset = UINT16_MAX;
210     uint16_t plo_pthread_tsd_base_address_offset = UINT16_MAX;
211     uint16_t plo_pthread_tsd_entry_size = UINT16_MAX;
212 
213     LibpthreadOffsets() = default;
214 
215     bool IsValid() { return plo_version != UINT16_MAX; }
216   };
217 
218   // The libBacktraceRecording function
219   // __introspection_dispatch_queue_get_pending_items has
220   // two forms.  It can either return a simple array of item_refs (void *) size
221   // or it can return
222   // a header with uint32_t version, a uint32_t size of item, and then an array
223   // of item_refs (void*)
224   // and code addresses (void*) for all the pending blocks.
225 
226   struct ItemRefAndCodeAddress {
227     lldb::addr_t item_ref;
228     lldb::addr_t code_address;
229   };
230 
231   struct PendingItemsForQueue {
232     bool new_style; // new-style means both item_refs and code_addresses avail
233                     // old-style means only item_refs is filled in
234     std::vector<ItemRefAndCodeAddress> item_refs_and_code_addresses;
235   };
236 
237   bool BacktraceRecordingHeadersInitialized();
238 
239   void ReadLibdispatchOffsetsAddress();
240 
241   void ReadLibdispatchOffsets();
242 
243   void ReadLibpthreadOffsetsAddress();
244 
245   void ReadLibpthreadOffsets();
246 
247   void ReadLibdispatchTSDIndexesAddress();
248 
249   void ReadLibdispatchTSDIndexes();
250 
251   PendingItemsForQueue GetPendingItemRefsForQueue(lldb::addr_t queue);
252 
253   ItemInfo ExtractItemInfoFromBuffer(lldb_private::DataExtractor &extractor);
254 
255   lldb_private::AppleGetQueuesHandler m_get_queues_handler;
256   lldb_private::AppleGetPendingItemsHandler m_get_pending_items_handler;
257   lldb_private::AppleGetItemInfoHandler m_get_item_info_handler;
258   lldb_private::AppleGetThreadItemInfoHandler m_get_thread_item_info_handler;
259 
260   lldb::addr_t m_page_to_free;
261   uint64_t m_page_to_free_size;
262   libBacktraceRecording_info m_lib_backtrace_recording_info;
263 
264   lldb::addr_t m_dispatch_queue_offsets_addr;
265   struct LibdispatchOffsets m_libdispatch_offsets;
266 
267   lldb::addr_t m_libpthread_layout_offsets_addr;
268   struct LibpthreadOffsets m_libpthread_offsets;
269 
270   lldb::addr_t m_dispatch_tsd_indexes_addr;
271   struct LibdispatchTSDIndexes m_libdispatch_tsd_indexes;
272 
273   lldb::addr_t m_dispatch_voucher_offsets_addr;
274   struct LibdispatchVoucherOffsets m_libdispatch_voucher_offsets;
275 
276   SystemRuntimeMacOSX(const SystemRuntimeMacOSX &) = delete;
277   const SystemRuntimeMacOSX &operator=(const SystemRuntimeMacOSX &) = delete;
278 };
279 
280 #endif // LLDB_SOURCE_PLUGINS_SYSTEMRUNTIME_MACOSX_SYSTEMRUNTIMEMACOSX_H
281