LLDB  mainline
AppleGetPendingItemsHandler.h
Go to the documentation of this file.
1 //===-- AppleGetPendingItemsHandler.h ----------------------------*- C++
2 //-*-===//
3 //
4 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5 // See https://llvm.org/LICENSE.txt for license information.
6 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #ifndef lldb_AppleGetPendingItemsHandler_h_
11 #define lldb_AppleGetPendingItemsHandler_h_
12 
13 #include <map>
14 #include <mutex>
15 #include <vector>
16 
18 #include "lldb/Utility/Status.h"
19 #include "lldb/lldb-public.h"
20 
21 // This class will insert a UtilityFunction into the inferior process for
22 // calling libBacktraceRecording's
23 // __introspection_dispatch_queue_get_pending_items()
24 // function. The function in the inferior will return a struct by value
25 // with these members:
26 //
27 // struct get_pending_items_return_values
28 // {
29 // introspection_dispatch_item_info_ref *items_buffer;
30 // uint64_t items_buffer_size;
31 // uint64_t count;
32 // };
33 //
34 // The items_buffer pointer is an address in the inferior program's address
35 // space (items_buffer_size in size) which must be mach_vm_deallocate'd by
36 // lldb. count is the number of items that were stored in the buffer.
37 //
38 // The AppleGetPendingItemsHandler object should persist so that the
39 // UtilityFunction
40 // can be reused multiple times.
41 
42 namespace lldb_private {
43 
45 public:
47 
49 
51  lldb::addr_t items_buffer_ptr; /* the address of the pending items buffer
52  from libBacktraceRecording */
54  items_buffer_size; /* the size of the pending items buffer from
55  libBacktraceRecording */
56  uint64_t count; /* the number of pending items included in the buffer */
57 
59  : items_buffer_ptr(LLDB_INVALID_ADDRESS), items_buffer_size(0),
60  count(0) {}
61  };
62 
63  /// Get the list of pending items for a given queue via a call to
64  /// __introspection_dispatch_queue_get_pending_items. If there's a page of
65  /// memory that needs to be freed, pass in the address and size and it will
66  /// be freed before getting the list of queues.
67  ///
68  /// \param [in] thread
69  /// The thread to run this plan on.
70  ///
71  /// \param [in] queue
72  /// The dispatch_queue_t value for the queue of interest.
73  ///
74  /// \param [in] page_to_free
75  /// An address of an inferior process vm page that needs to be
76  /// deallocated,
77  /// LLDB_INVALID_ADDRESS if this is not needed.
78  ///
79  /// \param [in] page_to_free_size
80  /// The size of the vm page that needs to be deallocated if an address was
81  /// passed in to page_to_free.
82  ///
83  /// \param [out] error
84  /// This object will be updated with the error status / error string from
85  /// any failures encountered.
86  ///
87  /// \returns
88  /// The result of the inferior function call execution. If there was a
89  /// failure of any kind while getting
90  /// the information, the items_buffer_ptr value will be
91  /// LLDB_INVALID_ADDRESS.
93  lldb::addr_t page_to_free,
94  uint64_t page_to_free_size,
95  lldb_private::Status &error);
96 
97  void Detach();
98 
99 private:
101  SetupGetPendingItemsFunction(Thread &thread,
102  ValueList &get_pending_items_arglist);
103 
104  static const char *g_get_pending_items_function_name;
105  static const char *g_get_pending_items_function_code;
106 
107  lldb_private::Process *m_process;
108  std::unique_ptr<UtilityFunction> m_get_pending_items_impl_code;
109  std::mutex m_get_pending_items_function_mutex;
110 
111  lldb::addr_t m_get_pending_items_return_buffer_addr;
112  std::mutex m_get_pending_items_retbuffer_mutex;
113 };
114 
115 } // using namespace lldb_private
116 
117 #endif // lldb_AppleGetPendingItemsHandler_h_
Enumerations for broadcasting.
Definition: SBLaunchInfo.h:14
AppleGetPendingItemsHandler(lldb_private::Process *process)
#define LLDB_INVALID_ADDRESS
Invalid value definitions.
Definition: lldb-defines.h:85
A plug-in interface definition class for debugging a process.
Definition: Process.h:353
uint64_t addr_t
Definition: lldb-types.h:83
GetPendingItemsReturnInfo GetPendingItems(Thread &thread, lldb::addr_t queue, lldb::addr_t page_to_free, uint64_t page_to_free_size, lldb_private::Status &error)
Get the list of pending items for a given queue via a call to __introspection_dispatch_queue_get_pend...
An error handling class.
Definition: Status.h:44