MachProcess.h revision cec43ab7f30085ac7f65a26a58b956a69e363a3b
1//===-- MachProcess.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 6/15/07. 11// 12//===----------------------------------------------------------------------===// 13 14#ifndef __MachProcess_h__ 15#define __MachProcess_h__ 16 17#include "DNBDefs.h" 18#include "DNBBreakpoint.h" 19#include "DNBError.h" 20#include "DNBThreadResumeActions.h" 21//#include "MachDYLD.h" 22#include "MachException.h" 23#include "MachVMMemory.h" 24#include "MachTask.h" 25#include "MachThreadList.h" 26#include "PThreadCondition.h" 27#include "PThreadEvent.h" 28#include "PThreadMutex.h" 29 30#include <mach/mach.h> 31#include <sys/signal.h> 32#include <pthread.h> 33#include <vector> 34 35class DNBThreadResumeActions; 36 37class MachProcess 38{ 39public: 40 //---------------------------------------------------------------------- 41 // Constructors and Destructors 42 //---------------------------------------------------------------------- 43 MachProcess (); 44 ~MachProcess (); 45 46 //---------------------------------------------------------------------- 47 // Child process control 48 //---------------------------------------------------------------------- 49 pid_t AttachForDebug (pid_t pid, char *err_str, size_t err_len); 50 pid_t LaunchForDebug (const char *path, 51 char const *argv[], 52 char const *envp[], 53 const char *working_directory, 54 const char *stdin_path, 55 const char *stdout_path, 56 const char *stderr_path, 57 bool no_stdio, 58 nub_launch_flavor_t launch_flavor, 59 int disable_aslr, 60 DNBError &err); 61 62 static uint32_t GetCPUTypeForLocalProcess (pid_t pid); 63 static pid_t ForkChildForPTraceDebugging (const char *path, char const *argv[], char const *envp[], MachProcess* process, DNBError &err); 64 static pid_t PosixSpawnChildForPTraceDebugging (const char *path, 65 cpu_type_t cpu_type, 66 char const *argv[], 67 char const *envp[], 68 const char *working_directory, 69 const char *stdin_path, 70 const char *stdout_path, 71 const char *stderr_path, 72 bool no_stdio, 73 MachProcess* process, 74 int disable_aslr, 75 DNBError& err); 76 nub_addr_t GetDYLDAllImageInfosAddress (); 77 static const void * PrepareForAttach (const char *path, nub_launch_flavor_t launch_flavor, bool waitfor, DNBError &err_str); 78 static void CleanupAfterAttach (const void *attach_token, bool success, DNBError &err_str); 79 static nub_process_t CheckForProcess (const void *attach_token); 80#ifdef WITH_SPRINGBOARD 81 pid_t SBLaunchForDebug (const char *app_bundle_path, char const *argv[], char const *envp[], bool no_stdio, DNBError &launch_err); 82 static pid_t SBForkChildForPTraceDebugging (const char *path, char const *argv[], char const *envp[], bool no_stdio, MachProcess* process, DNBError &launch_err); 83#endif 84 nub_addr_t LookupSymbol (const char *name, const char *shlib); 85 void SetNameToAddressCallback (DNBCallbackNameToAddress callback, void *baton) 86 { 87 m_name_to_addr_callback = callback; 88 m_name_to_addr_baton = baton; 89 } 90 void SetSharedLibraryInfoCallback (DNBCallbackCopyExecutableImageInfos callback, void *baton) 91 { 92 m_image_infos_callback = callback; 93 m_image_infos_baton = baton; 94 } 95 96 bool Resume (const DNBThreadResumeActions& thread_actions); 97 bool Signal (int signal, const struct timespec *timeout_abstime = NULL); 98 bool Kill (const struct timespec *timeout_abstime = NULL); 99 bool Detach (); 100 nub_size_t ReadMemory (nub_addr_t addr, nub_size_t size, void *buf); 101 nub_size_t WriteMemory (nub_addr_t addr, nub_size_t size, const void *buf); 102 103 //---------------------------------------------------------------------- 104 // Path and arg accessors 105 //---------------------------------------------------------------------- 106 const char * Path () const { return m_path.c_str(); } 107 size_t ArgumentCount () const { return m_args.size(); } 108 const char * ArgumentAtIndex (size_t arg_idx) const 109 { 110 if (arg_idx < m_args.size()) 111 return m_args[arg_idx].c_str(); 112 return NULL; 113 } 114 115 //---------------------------------------------------------------------- 116 // Breakpoint functions 117 //---------------------------------------------------------------------- 118 nub_break_t CreateBreakpoint (nub_addr_t addr, nub_size_t length, bool hardware, thread_t thread); 119 bool DisableBreakpoint (nub_break_t breakID, bool remove); 120 nub_size_t DisableAllBreakpoints (bool remove); 121 bool EnableBreakpoint (nub_break_t breakID); 122 void DumpBreakpoint(nub_break_t breakID) const; 123 DNBBreakpointList& Breakpoints() { return m_breakpoints; } 124 const DNBBreakpointList& Breakpoints() const { return m_breakpoints; } 125 126 //---------------------------------------------------------------------- 127 // Watchpoint functions 128 //---------------------------------------------------------------------- 129 nub_watch_t CreateWatchpoint (nub_addr_t addr, nub_size_t length, uint32_t watch_type, bool hardware, thread_t thread); 130 bool DisableWatchpoint (nub_watch_t watchID, bool remove); 131 nub_size_t DisableAllWatchpoints (bool remove); 132 bool EnableWatchpoint (nub_watch_t watchID); 133 void DumpWatchpoint(nub_watch_t watchID) const; 134 uint32_t GetNumSupportedHardwareWatchpoints () const; 135 DNBBreakpointList& Watchpoints() { return m_watchpoints; } 136 const DNBBreakpointList& Watchpoints() const { return m_watchpoints; } 137 138 //---------------------------------------------------------------------- 139 // Exception thread functions 140 //---------------------------------------------------------------------- 141 bool StartSTDIOThread (); 142 static void * STDIOThread (void *arg); 143 void ExceptionMessageReceived (const MachException::Message& exceptionMessage); 144 void ExceptionMessageBundleComplete (); 145 void SharedLibrariesUpdated (); 146 nub_size_t CopyImageInfos (struct DNBExecutableImageInfo **image_infos, bool only_changed); 147 148 //---------------------------------------------------------------------- 149 // Profile functions 150 //---------------------------------------------------------------------- 151 void SetEnableAsyncProfiling (bool enable, uint64_t internal_usec, DNBProfileDataScanType scan_type); 152 bool IsProfilingEnabled () { return m_profile_enabled; } 153 uint64_t ProfileInterval () { return m_profile_interval_usec; } 154 bool StartProfileThread (); 155 static void * ProfileThread (void *arg); 156 void SignalAsyncProfileData (const char *info); 157 size_t GetAsyncProfileData (char *buf, size_t buf_size); 158 159 //---------------------------------------------------------------------- 160 // Accessors 161 //---------------------------------------------------------------------- 162 pid_t ProcessID () const { return m_pid; } 163 bool ProcessIDIsValid () const { return m_pid > 0; } 164 pid_t SetProcessID (pid_t pid); 165 MachTask& Task() { return m_task; } 166 const MachTask& Task() const { return m_task; } 167 168 PThreadEvent& Events() { return m_events; } 169 const DNBRegisterSetInfo * 170 GetRegisterSetInfo (nub_thread_t tid, nub_size_t *num_reg_sets) const; 171 bool GetRegisterValue (nub_thread_t tid, uint32_t set, uint32_t reg, DNBRegisterValue *reg_value) const; 172 bool SetRegisterValue (nub_thread_t tid, uint32_t set, uint32_t reg, const DNBRegisterValue *value) const; 173 nub_bool_t SyncThreadState (nub_thread_t tid); 174 const char * ThreadGetName (nub_thread_t tid); 175 nub_state_t ThreadGetState (nub_thread_t tid); 176 nub_size_t GetNumThreads () const; 177 nub_thread_t GetThreadAtIndex (nub_size_t thread_idx) const; 178 nub_thread_t GetCurrentThread (); 179 nub_thread_t SetCurrentThread (nub_thread_t tid); 180 MachThreadList & GetThreadList() { return m_thread_list; } 181 bool GetThreadStoppedReason(nub_thread_t tid, struct DNBThreadStopInfo *stop_info) const; 182 void DumpThreadStoppedReason(nub_thread_t tid) const; 183 const char * GetThreadInfo (nub_thread_t tid) const; 184 185 nub_thread_t GetThreadIDForMachPortNumber (thread_t mach_port_number) const; 186 187 uint32_t GetCPUType (); 188 nub_state_t GetState (); 189 void SetState (nub_state_t state); 190 bool IsRunning (nub_state_t state) 191 { 192 return state == eStateRunning || IsStepping(state); 193 } 194 bool IsStepping (nub_state_t state) 195 { 196 return state == eStateStepping; 197 } 198 bool CanResume (nub_state_t state) 199 { 200 return state == eStateStopped; 201 } 202 203 bool GetExitStatus(int* status) 204 { 205 if (GetState() == eStateExited) 206 { 207 if (status) 208 *status = m_exit_status; 209 return true; 210 } 211 return false; 212 } 213 void SetExitStatus(int status) 214 { 215 m_exit_status = status; 216 SetState(eStateExited); 217 } 218 219 uint32_t StopCount() const { return m_stop_count; } 220 void SetChildFileDescriptors (int stdin_fileno, int stdout_fileno, int stderr_fileno) 221 { 222 m_child_stdin = stdin_fileno; 223 m_child_stdout = stdout_fileno; 224 m_child_stderr = stderr_fileno; 225 } 226 227 int GetStdinFileDescriptor () const { return m_child_stdin; } 228 int GetStdoutFileDescriptor () const { return m_child_stdout; } 229 int GetStderrFileDescriptor () const { return m_child_stderr; } 230 void AppendSTDOUT (char* s, size_t len); 231 size_t GetAvailableSTDOUT (char *buf, size_t buf_size); 232 size_t GetAvailableSTDERR (char *buf, size_t buf_size); 233 void CloseChildFileDescriptors () 234 { 235 if (m_child_stdin >= 0) 236 { 237 ::close (m_child_stdin); 238 m_child_stdin = -1; 239 } 240 if (m_child_stdout >= 0) 241 { 242 ::close (m_child_stdout); 243 m_child_stdout = -1; 244 } 245 if (m_child_stderr >= 0) 246 { 247 ::close (m_child_stderr); 248 m_child_stderr = -1; 249 } 250 } 251 252 bool ProcessUsingSpringBoard() const { return (m_flags & eMachProcessFlagsUsingSBS) != 0; } 253 254 DNBProfileDataScanType GetProfileScanType () { return m_profile_scan_type; } 255 256private: 257 enum 258 { 259 eMachProcessFlagsNone = 0, 260 eMachProcessFlagsAttached = (1 << 0), 261 eMachProcessFlagsUsingSBS = (1 << 1) 262 }; 263 void Clear (); 264 void ReplyToAllExceptions (); 265 void PrivateResume (); 266 nub_size_t RemoveTrapsFromBuffer (nub_addr_t addr, nub_size_t size, uint8_t *buf) const; 267 268 uint32_t Flags () const { return m_flags; } 269 nub_state_t DoSIGSTOP (bool clear_bps_and_wps, bool allow_running, uint32_t *thread_idx_ptr); 270 271 pid_t m_pid; // Process ID of child process 272 cpu_type_t m_cpu_type; // The CPU type of this process 273 int m_child_stdin; 274 int m_child_stdout; 275 int m_child_stderr; 276 std::string m_path; // A path to the executable if we have one 277 std::vector<std::string> m_args; // The arguments with which the process was lauched 278 int m_exit_status; // The exit status for the process 279 MachTask m_task; // The mach task for this process 280 uint32_t m_flags; // Process specific flags (see eMachProcessFlags enums) 281 uint32_t m_stop_count; // A count of many times have we stopped 282 pthread_t m_stdio_thread; // Thread ID for the thread that watches for child process stdio 283 PThreadMutex m_stdio_mutex; // Multithreaded protection for stdio 284 std::string m_stdout_data; 285 286 bool m_profile_enabled; // A flag to indicate if profiling is enabled 287 uint64_t m_profile_interval_usec; // If enable, the profiling interval in microseconds 288 DNBProfileDataScanType m_profile_scan_type; // Indicates what needs to be profiled 289 pthread_t m_profile_thread; // Thread ID for the thread that profiles the inferior 290 PThreadMutex m_profile_data_mutex; // Multithreaded protection for profile info data 291 std::vector<std::string> m_profile_data; // Profile data, must be protected by m_profile_data_mutex 292 293 DNBThreadResumeActions m_thread_actions; // The thread actions for the current MachProcess::Resume() call 294 MachException::Message::collection 295 m_exception_messages; // A collection of exception messages caught when listening to the exception port 296 PThreadMutex m_exception_messages_mutex; // Multithreaded protection for m_exception_messages 297 298 MachThreadList m_thread_list; // A list of threads that is maintained/updated after each stop 299 nub_state_t m_state; // The state of our process 300 PThreadMutex m_state_mutex; // Multithreaded protection for m_state 301 PThreadEvent m_events; // Process related events in the child processes lifetime can be waited upon 302 DNBBreakpointList m_breakpoints; // Breakpoint list for this process 303 DNBBreakpointList m_watchpoints; // Watchpoint list for this process 304 DNBCallbackNameToAddress m_name_to_addr_callback; 305 void * m_name_to_addr_baton; 306 DNBCallbackCopyExecutableImageInfos 307 m_image_infos_callback; 308 void * m_image_infos_baton; 309}; 310 311 312#endif // __MachProcess_h__ 313