tools/debugserver/source/DNB.h

   1 //===-- DNB.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 //  Created by Greg Clayton on 3/23/07.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef __DNB_h__
  15 #define __DNB_h__
  16
  17 #include "MacOSX/Genealogy.h"
  18 #include "MacOSX/ThreadInfo.h"
  19 #include "JSONGenerator.h"
  20 #include "DNBDefs.h"
  21 #include <mach/thread_info.h>
  22 #include <string>
  23
  24 #define DNB_EXPORT __attribute__((visibility("default")))
  25
  26 #ifndef CPU_TYPE_ARM64
  27 #define CPU_TYPE_ARM64 ((cpu_type_t) 12 | 0x01000000)
  28 #endif
  29
  30 typedef bool (*DNBShouldCancelCallback) (void *);
  31
  32 void            DNBInitialize ();
  33 void            DNBTerminate ();
  34
  35 nub_bool_t      DNBSetArchitecture      (const char *arch);
  36
  37 //----------------------------------------------------------------------
  38 // Process control
  39 //----------------------------------------------------------------------
  40 nub_process_t   DNBProcessLaunch        (const char *path,
  41                                          char const *argv[],
  42                                          const char *envp[],
  43                                          const char *working_directory, // NULL => don't change, non-NULL => set working directory for inferior to this
  44                                          const char *stdin_path,
  45                                          const char *stdout_path,
  46                                          const char *stderr_path,
  47                                          bool no_stdio,
  48                                          nub_launch_flavor_t launch_flavor,
  49                                          int disable_aslr,
  50                                          const char *event_data,
  51                                          char *err_str,
  52                                          size_t err_len);
  53
  54 nub_process_t   DNBProcessGetPIDByName  (const char *name);
  55 nub_process_t   DNBProcessAttach        (nub_process_t pid, struct timespec *timeout, char *err_str, size_t err_len);
  56 nub_process_t   DNBProcessAttachByName  (const char *name, struct timespec *timeout, char *err_str, size_t err_len);
  57 nub_process_t   DNBProcessAttachWait    (const char *wait_name, nub_launch_flavor_t launch_flavor, bool ignore_existing, struct timespec *timeout, useconds_t interval, char *err_str, size_t err_len, DNBShouldCancelCallback should_cancel = NULL, void *callback_data = NULL);
  58 // Resume a process with exact instructions on what to do with each thread:
  59 // - If no thread actions are supplied (actions is NULL or num_actions is zero),
  60 //   then all threads are continued.
  61 // - If any thread actions are supplied, then each thread will do as it is told
  62 //   by the action. A default actions for any threads that don't have an
  63 //   explicit thread action can be made by making a thread action with a tid of
  64 //   INVALID_NUB_THREAD. If there is no default action, those threads will
  65 //   remain stopped.
  66 nub_bool_t      DNBProcessResume        (nub_process_t pid, const DNBThreadResumeAction *actions, size_t num_actions) DNB_EXPORT;
  67 nub_bool_t      DNBProcessHalt          (nub_process_t pid) DNB_EXPORT;
  68 nub_bool_t      DNBProcessDetach        (nub_process_t pid) DNB_EXPORT;
  69 nub_bool_t      DNBProcessSignal        (nub_process_t pid, int signal) DNB_EXPORT;
  70 nub_bool_t      DNBProcessInterrupt     (nub_process_t pid) DNB_EXPORT;
  71 nub_bool_t      DNBProcessKill          (nub_process_t pid) DNB_EXPORT;
  72 nub_bool_t      DNBProcessSendEvent     (nub_process_t pid, const char *event) DNB_EXPORT;
  73 nub_size_t      DNBProcessMemoryRead    (nub_process_t pid, nub_addr_t addr, nub_size_t size, void *buf) DNB_EXPORT;
  74 uint64_t        DNBProcessMemoryReadInteger (nub_process_t pid, nub_addr_t addr, nub_size_t integer_size, uint64_t fail_value) DNB_EXPORT;
  75 nub_addr_t      DNBProcessMemoryReadPointer (nub_process_t pid, nub_addr_t addr) DNB_EXPORT;
  76 std::string     DNBProcessMemoryReadCString (nub_process_t pid, nub_addr_t addr) DNB_EXPORT;
  77 std::string     DNBProcessMemoryReadCStringFixed (nub_process_t pid, nub_addr_t addr, nub_size_t fixed_length) DNB_EXPORT;
  78 nub_size_t      DNBProcessMemoryWrite   (nub_process_t pid, nub_addr_t addr, nub_size_t size, const void *buf) DNB_EXPORT;
  79 nub_addr_t      DNBProcessMemoryAllocate    (nub_process_t pid, nub_size_t size, uint32_t permissions) DNB_EXPORT;
  80 nub_bool_t      DNBProcessMemoryDeallocate  (nub_process_t pid, nub_addr_t addr) DNB_EXPORT;
  81 int             DNBProcessMemoryRegionInfo  (nub_process_t pid, nub_addr_t addr, DNBRegionInfo *region_info) DNB_EXPORT;
  82 std::string     DNBProcessGetProfileData (nub_process_t pid, DNBProfileDataScanType scanType) DNB_EXPORT;
  83 nub_bool_t      DNBProcessSetEnableAsyncProfiling   (nub_process_t pid, nub_bool_t enable, uint64_t interval_usec, DNBProfileDataScanType scan_type) DNB_EXPORT;
  84
  85 //----------------------------------------------------------------------
  86 // Process status
  87 //----------------------------------------------------------------------
  88 nub_bool_t      DNBProcessIsAlive                       (nub_process_t pid) DNB_EXPORT;
  89 nub_state_t     DNBProcessGetState                      (nub_process_t pid) DNB_EXPORT;
  90 nub_bool_t      DNBProcessGetExitStatus                 (nub_process_t pid, int *status) DNB_EXPORT;
  91 nub_bool_t      DNBProcessSetExitStatus                 (nub_process_t pid, int status) DNB_EXPORT;
  92 const char *    DNBProcessGetExitInfo                   (nub_process_t pid) DNB_EXPORT;
  93 nub_bool_t      DNBProcessSetExitInfo                   (nub_process_t pid, const char *info) DNB_EXPORT;
  94 nub_size_t      DNBProcessGetNumThreads                 (nub_process_t pid) DNB_EXPORT;
  95 nub_thread_t    DNBProcessGetCurrentThread              (nub_process_t pid) DNB_EXPORT;
  96 nub_thread_t    DNBProcessGetCurrentThreadMachPort      (nub_process_t pid) DNB_EXPORT;
  97 nub_thread_t    DNBProcessSetCurrentThread              (nub_process_t pid, nub_thread_t tid) DNB_EXPORT;
  98 nub_thread_t    DNBProcessGetThreadAtIndex              (nub_process_t pid, nub_size_t thread_idx) DNB_EXPORT;
  99 nub_bool_t      DNBProcessSyncThreadState               (nub_process_t pid, nub_thread_t tid) DNB_EXPORT;
 100 nub_addr_t      DNBProcessGetSharedLibraryInfoAddress   (nub_process_t pid) DNB_EXPORT;
 101 nub_bool_t      DNBProcessSharedLibrariesUpdated        (nub_process_t pid) DNB_EXPORT;
 102 nub_size_t      DNBProcessGetSharedLibraryInfo          (nub_process_t pid, nub_bool_t only_changed, DNBExecutableImageInfo **image_infos) DNB_EXPORT;
 103 nub_bool_t      DNBProcessSetNameToAddressCallback      (nub_process_t pid, DNBCallbackNameToAddress callback, void *baton) DNB_EXPORT;
 104 nub_bool_t      DNBProcessSetSharedLibraryInfoCallback  (nub_process_t pid, DNBCallbackCopyExecutableImageInfos callback, void *baton) DNB_EXPORT;
 105 nub_addr_t      DNBProcessLookupAddress                 (nub_process_t pid, const char *name, const char *shlib) DNB_EXPORT;
 106 nub_size_t      DNBProcessGetAvailableSTDOUT            (nub_process_t pid, char *buf, nub_size_t buf_size) DNB_EXPORT;
 107 nub_size_t      DNBProcessGetAvailableSTDERR            (nub_process_t pid, char *buf, nub_size_t buf_size) DNB_EXPORT;
 108 nub_size_t      DNBProcessGetAvailableProfileData       (nub_process_t pid, char *buf, nub_size_t buf_size) DNB_EXPORT;
 109 nub_size_t      DNBProcessGetStopCount                  (nub_process_t pid) DNB_EXPORT;
 110 uint32_t        DNBProcessGetCPUType                    (nub_process_t pid) DNB_EXPORT;
 111
 112 //----------------------------------------------------------------------
 113 // Process executable and arguments
 114 //----------------------------------------------------------------------
 115 const char *    DNBProcessGetExecutablePath     (nub_process_t pid);
 116 const char *    DNBProcessGetArgumentAtIndex    (nub_process_t pid, nub_size_t idx);
 117 nub_size_t      DNBProcessGetArgumentCount      (nub_process_t pid);
 118
 119 //----------------------------------------------------------------------
 120 // Process events
 121 //----------------------------------------------------------------------
 122 nub_event_t     DNBProcessWaitForEvents         (nub_process_t pid, nub_event_t event_mask, bool wait_for_set, struct timespec* timeout);
 123 void            DNBProcessResetEvents           (nub_process_t pid, nub_event_t event_mask);
 124
 125 //----------------------------------------------------------------------
 126 // Thread functions
 127 //----------------------------------------------------------------------
 128 const char *    DNBThreadGetName                (nub_process_t pid, nub_thread_t tid);
 129 nub_bool_t      DNBThreadGetIdentifierInfo      (nub_process_t pid, nub_thread_t tid, thread_identifier_info_data_t *ident_info);
 130 nub_state_t     DNBThreadGetState               (nub_process_t pid, nub_thread_t tid);
 131 nub_bool_t      DNBThreadGetRegisterValueByID   (nub_process_t pid, nub_thread_t tid, uint32_t set, uint32_t reg, DNBRegisterValue *value);
 132 nub_bool_t      DNBThreadSetRegisterValueByID   (nub_process_t pid, nub_thread_t tid, uint32_t set, uint32_t reg, const DNBRegisterValue *value);
 133 nub_size_t      DNBThreadGetRegisterContext     (nub_process_t pid, nub_thread_t tid, void *buf, size_t buf_len);
 134 nub_size_t      DNBThreadSetRegisterContext     (nub_process_t pid, nub_thread_t tid, const void *buf, size_t buf_len);
 135 uint32_t        DNBThreadSaveRegisterState      (nub_process_t pid, nub_thread_t tid);
 136 nub_bool_t      DNBThreadRestoreRegisterState   (nub_process_t pid, nub_thread_t tid, uint32_t save_id);
 137 nub_bool_t      DNBThreadGetRegisterValueByName (nub_process_t pid, nub_thread_t tid, uint32_t set, const char *name, DNBRegisterValue *value);
 138 nub_bool_t      DNBThreadGetStopReason          (nub_process_t pid, nub_thread_t tid, DNBThreadStopInfo *stop_info);
 139 const char *    DNBThreadGetInfo                (nub_process_t pid, nub_thread_t tid);
 140 Genealogy::ThreadActivitySP DNBGetGenealogyInfoForThread (nub_process_t pid, nub_thread_t tid, bool &timed_out);
 141 Genealogy::ProcessExecutableInfoSP DNBGetGenealogyImageInfo (nub_process_t pid, size_t idx);
 142 ThreadInfo::QoS DNBGetRequestedQoSForThread     (nub_process_t pid, nub_thread_t tid, nub_addr_t tsd, uint64_t dti_qos_class_index);
 143 nub_addr_t      DNBGetPThreadT                  (nub_process_t pid, nub_thread_t tid);
 144 nub_addr_t      DNBGetDispatchQueueT            (nub_process_t pid, nub_thread_t tid);
 145 nub_addr_t      DNBGetTSDAddressForThread       (nub_process_t pid, nub_thread_t tid, uint64_t plo_pthread_tsd_base_address_offset, uint64_t plo_pthread_tsd_base_offset, uint64_t plo_pthread_tsd_entry_size);
 146 JSONGenerator::ObjectSP DNBGetLoadedDynamicLibrariesInfos (nub_process_t pid, nub_addr_t image_list_address, nub_addr_t image_count);
 147 JSONGenerator::ObjectSP DNBGetAllLoadedLibrariesInfos (nub_process_t pid);
 148 JSONGenerator::ObjectSP DNBGetLibrariesInfoForAddresses (nub_process_t pid, std::vector<uint64_t> &macho_addresses);
 149 JSONGenerator::ObjectSP DNBGetSharedCacheInfo (nub_process_t pid);
 150
 151 //
 152 //----------------------------------------------------------------------
 153 // Breakpoint functions
 154 //----------------------------------------------------------------------
 155 nub_bool_t      DNBBreakpointSet                (nub_process_t pid, nub_addr_t addr, nub_size_t size, nub_bool_t hardware);
 156 nub_bool_t      DNBBreakpointClear              (nub_process_t pid, nub_addr_t addr);
 157
 158 //----------------------------------------------------------------------
 159 // Watchpoint functions
 160 //----------------------------------------------------------------------
 161 nub_bool_t      DNBWatchpointSet                (nub_process_t pid, nub_addr_t addr, nub_size_t size, uint32_t watch_flags, nub_bool_t hardware);
 162 nub_bool_t      DNBWatchpointClear              (nub_process_t pid, nub_addr_t addr);
 163 uint32_t        DNBWatchpointGetNumSupportedHWP (nub_process_t pid);
 164
 165 uint32_t        DNBGetRegisterCPUType           ();
 166 const DNBRegisterSetInfo *
 167                 DNBGetRegisterSetInfo           (nub_size_t *num_reg_sets);
 168 nub_bool_t      DNBGetRegisterInfoByName        (const char *reg_name, DNBRegisterInfo* info);
 169
 170 //----------------------------------------------------------------------
 171 // Other static nub information calls.
 172 //----------------------------------------------------------------------
 173 const char *    DNBStateAsString (nub_state_t state);
 174 nub_bool_t      DNBResolveExecutablePath (const char *path, char *resolved_path, size_t resolved_path_size);
 175 bool            DNBGetOSVersionNumbers (uint64_t *major, uint64_t *minor, uint64_t *patch);
 176
 177 #endif