source/Plugins/SystemRuntime/MacOSX/AppleGetItemInfoHandler.h

   1 //===-- AppleGetItemInfoHandler.h ----------------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef lldb_AppleGetItemInfoHandler_h_
  11 #define lldb_AppleGetItemInfoHandler_h_
  12
  13 // C Includes
  14 // C++ Includes
  15 #include <map>
  16 #include <mutex>
  17 #include <vector>
  18
  19 // Other libraries and framework includes
  20 // Project includes
  21 #include "lldb/lldb-public.h"
  22 #include "lldb/Core/Error.h"
  23 #include "lldb/Expression/UtilityFunction.h"
  24 #include "lldb/Symbol/CompilerType.h"
  25
  26 // This class will insert a UtilityFunction into the inferior process for
  27 // calling libBacktraceRecording's __introspection_dispatch_queue_item_get_info()
  28 // function.  The function in the inferior will return a struct by value
  29 // with these members:
  30 //
  31 //     struct get_item_info_return_values
  32 //     {
  33 //         introspection_dispatch_item_info_ref *item_buffer;
  34 //         uint64_t item_buffer_size;
  35 //     };
  36 //
  37 // The item_buffer pointer is an address in the inferior program's address
  38 // space (item_buffer_size in size) which must be mach_vm_deallocate'd by
  39 // lldb.
  40 //
  41 // The AppleGetItemInfoHandler object should persist so that the UtilityFunction
  42 // can be reused multiple times.
  43
  44 namespace lldb_private
  45 {
  46
  47 class AppleGetItemInfoHandler {
  48 public:
  49
  50     AppleGetItemInfoHandler (lldb_private::Process *process);
  51
  52     ~AppleGetItemInfoHandler();
  53
  54     struct GetItemInfoReturnInfo
  55     {
  56         lldb::addr_t    item_buffer_ptr;  /* the address of the item buffer from libBacktraceRecording */
  57         lldb::addr_t    item_buffer_size; /* the size of the item buffer from libBacktraceRecording */
  58
  59         GetItemInfoReturnInfo() :
  60             item_buffer_ptr(LLDB_INVALID_ADDRESS),
  61             item_buffer_size(0)
  62         {}
  63     };
  64
  65     //----------------------------------------------------------
  66     /// Get the information about a work item by calling
  67     /// __introspection_dispatch_queue_item_get_info.  If there's a page of
  68     /// memory that needs to be freed, pass in the address and size and it will
  69     /// be freed before getting the list of queues.
  70     ///
  71     /// @param [in] thread
  72     ///     The thread to run this plan on.
  73     ///
  74     /// @param [in] item
  75     ///     The introspection_dispatch_item_info_ref value for the item of interest.
  76     ///
  77     /// @param [in] page_to_free
  78     ///     An address of an inferior process vm page that needs to be deallocated,
  79     ///     LLDB_INVALID_ADDRESS if this is not needed.
  80     ///
  81     /// @param [in] page_to_free_size
  82     ///     The size of the vm page that needs to be deallocated if an address was
  83     ///     passed in to page_to_free.
  84     ///
  85     /// @param [out] error
  86     ///     This object will be updated with the error status / error string from any failures encountered.
  87     ///
  88     /// @returns
  89     ///     The result of the inferior function call execution.  If there was a failure of any kind while getting
  90     ///     the information, the item_buffer_ptr value will be LLDB_INVALID_ADDRESS.
  91     //----------------------------------------------------------
  92     GetItemInfoReturnInfo
  93     GetItemInfo (Thread &thread, lldb::addr_t item, lldb::addr_t page_to_free, uint64_t page_to_free_size, lldb_private::Error &error);
  94
  95
  96     void
  97     Detach ();
  98
  99 private:
 100
 101     lldb::addr_t
 102     SetupGetItemInfoFunction (Thread &thread, ValueList &get_item_info_arglist);
 103
 104     static const char *g_get_item_info_function_name;
 105     static const char *g_get_item_info_function_code;
 106
 107     lldb_private::Process *m_process;
 108     std::unique_ptr<UtilityFunction> m_get_item_info_impl_code;
 109     std::mutex m_get_item_info_function_mutex;
 110
 111     lldb::addr_t m_get_item_info_return_buffer_addr;
 112     std::mutex m_get_item_info_retbuffer_mutex;
 113 };
 114
 115 }  // using namespace lldb_private
 116
 117 #endif  // lldb_AppleGetItemInfoHandler_h_