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