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 "DNBDefs.h" 18 #include <mach/thread_info.h> 19 #include <string> 20 21 #define DNB_EXPORT __attribute__((visibility("default"))) 22 23 typedef bool (*DNBShouldCancelCallback) (void *); 24 25 void DNBInitialize (); 26 void DNBTerminate (); 27 28 nub_bool_t DNBSetArchitecture (const char *arch); 29 30 //---------------------------------------------------------------------- 31 // Process control 32 //---------------------------------------------------------------------- 33 nub_process_t DNBProcessLaunch (const char *path, 34 char const *argv[], 35 const char *envp[], 36 const char *working_directory, // NULL => dont' change, non-NULL => set working directory for inferior to this 37 const char *stdin_path, 38 const char *stdout_path, 39 const char *stderr_path, 40 bool no_stdio, 41 nub_launch_flavor_t launch_flavor, 42 int disable_aslr, 43 char *err_str, 44 size_t err_len) DNB_EXPORT; 45 46 nub_process_t DNBProcessAttach (nub_process_t pid, struct timespec *timeout, char *err_str, size_t err_len) DNB_EXPORT; 47 nub_process_t DNBProcessAttachByName (const char *name, struct timespec *timeout, char *err_str, size_t err_len) DNB_EXPORT; 48 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) DNB_EXPORT; 49 // Resume a process with exact instructions on what to do with each thread: 50 // - If no thread actions are supplied (actions is NULL or num_actions is zero), 51 // then all threads are continued. 52 // - If any thread actions are supplied, then each thread will do as it is told 53 // by the action. A default actions for any threads that don't have an 54 // explicit thread action can be made by making a thread action with a tid of 55 // INVALID_NUB_THREAD. If there is no default action, those threads will 56 // remain stopped. 57 nub_bool_t DNBProcessResume (nub_process_t pid, const DNBThreadResumeAction *actions, size_t num_actions) DNB_EXPORT; 58 nub_bool_t DNBProcessHalt (nub_process_t pid) DNB_EXPORT; 59 nub_bool_t DNBProcessDetach (nub_process_t pid) DNB_EXPORT; 60 nub_bool_t DNBProcessSignal (nub_process_t pid, int signal) DNB_EXPORT; 61 nub_bool_t DNBProcessKill (nub_process_t pid) DNB_EXPORT; 62 nub_size_t DNBProcessMemoryRead (nub_process_t pid, nub_addr_t addr, nub_size_t size, void *buf) DNB_EXPORT; 63 nub_size_t DNBProcessMemoryWrite (nub_process_t pid, nub_addr_t addr, nub_size_t size, const void *buf) DNB_EXPORT; 64 nub_addr_t DNBProcessMemoryAllocate (nub_process_t pid, nub_size_t size, uint32_t permissions) DNB_EXPORT; 65 nub_bool_t DNBProcessMemoryDeallocate (nub_process_t pid, nub_addr_t addr) DNB_EXPORT; 66 int DNBProcessMemoryRegionInfo (nub_process_t pid, nub_addr_t addr, DNBRegionInfo *region_info) DNB_EXPORT; 67 std::string DNBProcessGetProfileData (nub_process_t pid, DNBProfileDataScanType scanType) DNB_EXPORT; 68 nub_bool_t DNBProcessSetEnableAsyncProfiling (nub_process_t pid, nub_bool_t enable, uint64_t interval_usec, DNBProfileDataScanType scan_type) DNB_EXPORT; 69 70 //---------------------------------------------------------------------- 71 // Process status 72 //---------------------------------------------------------------------- 73 nub_bool_t DNBProcessIsAlive (nub_process_t pid) DNB_EXPORT; 74 nub_state_t DNBProcessGetState (nub_process_t pid) DNB_EXPORT; 75 nub_bool_t DNBProcessGetExitStatus (nub_process_t pid, int *status) DNB_EXPORT; 76 nub_bool_t DNBProcessSetExitStatus (nub_process_t pid, int status) DNB_EXPORT; 77 nub_size_t DNBProcessGetNumThreads (nub_process_t pid) DNB_EXPORT; 78 nub_thread_t DNBProcessGetCurrentThread (nub_process_t pid) DNB_EXPORT; 79 nub_thread_t DNBProcessGetCurrentThreadMachPort (nub_process_t pid) DNB_EXPORT; 80 nub_thread_t DNBProcessSetCurrentThread (nub_process_t pid, nub_thread_t tid) DNB_EXPORT; 81 nub_thread_t DNBProcessGetThreadAtIndex (nub_process_t pid, nub_size_t thread_idx) DNB_EXPORT; 82 nub_bool_t DNBProcessSyncThreadState (nub_process_t pid, nub_thread_t tid) DNB_EXPORT; 83 nub_addr_t DNBProcessGetSharedLibraryInfoAddress (nub_process_t pid) DNB_EXPORT; 84 nub_bool_t DNBProcessSharedLibrariesUpdated (nub_process_t pid) DNB_EXPORT; 85 nub_size_t DNBProcessGetSharedLibraryInfo (nub_process_t pid, nub_bool_t only_changed, DNBExecutableImageInfo **image_infos) DNB_EXPORT; 86 nub_bool_t DNBProcessSetNameToAddressCallback (nub_process_t pid, DNBCallbackNameToAddress callback, void *baton) DNB_EXPORT; 87 nub_bool_t DNBProcessSetSharedLibraryInfoCallback (nub_process_t pid, DNBCallbackCopyExecutableImageInfos callback, void *baton) DNB_EXPORT; 88 nub_addr_t DNBProcessLookupAddress (nub_process_t pid, const char *name, const char *shlib) DNB_EXPORT; 89 nub_size_t DNBProcessGetAvailableSTDOUT (nub_process_t pid, char *buf, nub_size_t buf_size) DNB_EXPORT; 90 nub_size_t DNBProcessGetAvailableSTDERR (nub_process_t pid, char *buf, nub_size_t buf_size) DNB_EXPORT; 91 nub_size_t DNBProcessGetAvailableProfileData (nub_process_t pid, char *buf, nub_size_t buf_size) DNB_EXPORT; 92 nub_size_t DNBProcessGetStopCount (nub_process_t pid) DNB_EXPORT; 93 uint32_t DNBProcessGetCPUType (nub_process_t pid) DNB_EXPORT; 94 95 //---------------------------------------------------------------------- 96 // Process executable and arguments 97 //---------------------------------------------------------------------- 98 const char * DNBProcessGetExecutablePath (nub_process_t pid) DNB_EXPORT; 99 const char * DNBProcessGetArgumentAtIndex (nub_process_t pid, nub_size_t idx) DNB_EXPORT; 100 nub_size_t DNBProcessGetArgumentCount (nub_process_t pid) DNB_EXPORT; 101 102 //---------------------------------------------------------------------- 103 // Process events 104 //---------------------------------------------------------------------- 105 nub_event_t DNBProcessWaitForEvents (nub_process_t pid, nub_event_t event_mask, bool wait_for_set, struct timespec* timeout) DNB_EXPORT; 106 void DNBProcessResetEvents (nub_process_t pid, nub_event_t event_mask) DNB_EXPORT; 107 108 //---------------------------------------------------------------------- 109 // Thread functions 110 //---------------------------------------------------------------------- 111 const char * DNBThreadGetName (nub_process_t pid, nub_thread_t tid) DNB_EXPORT; 112 nub_bool_t DNBThreadGetIdentifierInfo (nub_process_t pid, nub_thread_t tid, thread_identifier_info_data_t *ident_info) DNB_EXPORT; 113 nub_state_t DNBThreadGetState (nub_process_t pid, nub_thread_t tid) DNB_EXPORT; 114 nub_bool_t DNBThreadGetRegisterValueByID (nub_process_t pid, nub_thread_t tid, uint32_t set, uint32_t reg, DNBRegisterValue *value) DNB_EXPORT; 115 nub_bool_t DNBThreadSetRegisterValueByID (nub_process_t pid, nub_thread_t tid, uint32_t set, uint32_t reg, const DNBRegisterValue *value) DNB_EXPORT; 116 nub_size_t DNBThreadGetRegisterContext (nub_process_t pid, nub_thread_t tid, void *buf, size_t buf_len) DNB_EXPORT; 117 nub_size_t DNBThreadSetRegisterContext (nub_process_t pid, nub_thread_t tid, const void *buf, size_t buf_len) DNB_EXPORT; 118 nub_bool_t DNBThreadGetRegisterValueByName (nub_process_t pid, nub_thread_t tid, uint32_t set, const char *name, DNBRegisterValue *value) DNB_EXPORT; 119 nub_bool_t DNBThreadGetStopReason (nub_process_t pid, nub_thread_t tid, DNBThreadStopInfo *stop_info) DNB_EXPORT; 120 const char * DNBThreadGetInfo (nub_process_t pid, nub_thread_t tid) DNB_EXPORT; 121 //---------------------------------------------------------------------- 122 // Breakpoint functions 123 //---------------------------------------------------------------------- 124 nub_bool_t DNBBreakpointSet (nub_process_t pid, nub_addr_t addr, nub_size_t size, nub_bool_t hardware) DNB_EXPORT; 125 nub_bool_t DNBBreakpointClear (nub_process_t pid, nub_addr_t addr) DNB_EXPORT; 126 127 //---------------------------------------------------------------------- 128 // Watchpoint functions 129 //---------------------------------------------------------------------- 130 nub_bool_t DNBWatchpointSet (nub_process_t pid, nub_addr_t addr, nub_size_t size, uint32_t watch_flags, nub_bool_t hardware) DNB_EXPORT; 131 nub_bool_t DNBWatchpointClear (nub_process_t pid, nub_addr_t addr) DNB_EXPORT; 132 uint32_t DNBWatchpointGetNumSupportedHWP (nub_process_t pid) DNB_EXPORT; 133 134 const DNBRegisterSetInfo * 135 DNBGetRegisterSetInfo (nub_size_t *num_reg_sets) DNB_EXPORT; 136 nub_bool_t DNBGetRegisterInfoByName (const char *reg_name, DNBRegisterInfo* info) DNB_EXPORT; 137 138 //---------------------------------------------------------------------- 139 // Printf style formatting for printing values in the inferior memory 140 // space and registers. 141 //---------------------------------------------------------------------- 142 nub_size_t DNBPrintf (nub_process_t pid, nub_thread_t tid, nub_addr_t addr, FILE *file, const char *format) DNB_EXPORT; 143 144 //---------------------------------------------------------------------- 145 // Other static nub information calls. 146 //---------------------------------------------------------------------- 147 const char * DNBStateAsString (nub_state_t state) DNB_EXPORT; 148 nub_bool_t DNBResolveExecutablePath (const char *path, char *resolved_path, size_t resolved_path_size) DNB_EXPORT; 149 150 #endif 151
