MachProcess.h revision 61468e816e879874ee8499ce5a1b4f1d6759b026
1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver//===-- MachProcess.h -------------------------------------------*- C++ -*-===// 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// The LLVM Compiler Infrastructure 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// This file is distributed under the University of Illinois Open Source 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// License. See LICENSE.TXT for details. 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver//===----------------------------------------------------------------------===// 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// Created by Greg Clayton on 6/15/07. 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver// 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver//===----------------------------------------------------------------------===// 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#ifndef __MachProcess_h__ 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#define __MachProcess_h__ 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include "DNBDefs.h" 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include "DNBBreakpoint.h" 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include "DNBError.h" 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include "DNBThreadResumeActions.h" 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver//#include "MachDYLD.h" 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include "MachException.h" 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include "MachVMMemory.h" 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include "MachTask.h" 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include "MachThreadList.h" 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include "PThreadCondition.h" 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include "PThreadEvent.h" 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include "PThreadMutex.h" 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include <mach/mach.h> 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include <sys/signal.h> 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include <pthread.h> 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#include <vector> 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverclass DNBThreadResumeActions; 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverclass MachProcess 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver{ 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic: 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver //---------------------------------------------------------------------- 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // Constructors and Destructors 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver //---------------------------------------------------------------------- 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver MachProcess (); 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ~MachProcess (); 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver //---------------------------------------------------------------------- 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // Child process control 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver //---------------------------------------------------------------------- 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver pid_t AttachForDebug (pid_t pid, char *err_str, size_t err_len); 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver pid_t LaunchForDebug (const char *path, char const *argv[], char const *envp[], const char *stdio_path, bool no_stdio, nub_launch_flavor_t launch_flavor, int disable_aslr, DNBError &err); 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver static pid_t ForkChildForPTraceDebugging (const char *path, char const *argv[], char const *envp[], MachProcess* process, DNBError &err); 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver static pid_t PosixSpawnChildForPTraceDebugging (const char *path, cpu_type_t cpu_type, char const *argv[], char const *envp[], const char *stdio_path, bool no_stdio, MachProcess* process, int disable_aslr, DNBError& err); 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver nub_addr_t GetDYLDAllImageInfosAddress (); 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver static const void * PrepareForAttach (const char *path, nub_launch_flavor_t launch_flavor, bool waitfor, DNBError &err_str); 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver static void CleanupAfterAttach (const void *attach_token, bool success, DNBError &err_str); 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver static nub_process_t CheckForProcess (const void *attach_token); 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#if defined (__arm__) 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver pid_t SBLaunchForDebug (const char *app_bundle_path, char const *argv[], char const *envp[], bool no_stdio, DNBError &launch_err); 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver static pid_t SBForkChildForPTraceDebugging (const char *path, char const *argv[], char const *envp[], bool no_stdio, MachProcess* process, DNBError &launch_err); 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#endif 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver nub_addr_t LookupSymbol (const char *name, const char *shlib); 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void SetNameToAddressCallback (DNBCallbackNameToAddress callback, void *baton) 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver m_name_to_addr_callback = callback; 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver m_name_to_addr_baton = baton; 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void SetSharedLibraryInfoCallback (DNBCallbackCopyExecutableImageInfos callback, void *baton) 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver m_image_infos_callback = callback; 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver m_image_infos_baton = baton; 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver bool Resume (const DNBThreadResumeActions& thread_actions); 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver bool Signal (int signal, const struct timespec *timeout_abstime = NULL); 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver bool Kill (const struct timespec *timeout_abstime = NULL); 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver bool Detach (); 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver nub_size_t ReadMemory (nub_addr_t addr, nub_size_t size, void *buf); 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver nub_size_t WriteMemory (nub_addr_t addr, nub_size_t size, const void *buf); 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver //---------------------------------------------------------------------- 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // Path and arg accessors 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver //---------------------------------------------------------------------- 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver const char * Path () const { return m_path.c_str(); } 84 size_t ArgumentCount () const { return m_args.size(); } 85 const char * ArgumentAtIndex (size_t arg_idx) const 86 { 87 if (arg_idx < m_args.size()) 88 return m_args[arg_idx].c_str(); 89 return NULL; 90 } 91 92 //---------------------------------------------------------------------- 93 // Breakpoint functions 94 //---------------------------------------------------------------------- 95 nub_break_t CreateBreakpoint (nub_addr_t addr, nub_size_t length, bool hardware, thread_t thread); 96 bool DisableBreakpoint (nub_break_t breakID, bool remove); 97 nub_size_t DisableAllBreakpoints (bool remove); 98 bool EnableBreakpoint (nub_break_t breakID); 99 void DumpBreakpoint(nub_break_t breakID) const; 100 DNBBreakpointList& Breakpoints() { return m_breakpoints; } 101 const DNBBreakpointList& Breakpoints() const { return m_breakpoints; } 102 103 //---------------------------------------------------------------------- 104 // Watchpoint functions 105 //---------------------------------------------------------------------- 106 nub_watch_t CreateWatchpoint (nub_addr_t addr, nub_size_t length, uint32_t watch_type, bool hardware, thread_t thread); 107 bool DisableWatchpoint (nub_watch_t watchID, bool remove); 108 nub_size_t DisableAllWatchpoints (bool remove); 109 bool EnableWatchpoint (nub_watch_t watchID); 110 void DumpWatchpoint(nub_watch_t watchID) const; 111 DNBBreakpointList& Watchpoints() { return m_watchpoints; } 112 const DNBBreakpointList& Watchpoints() const { return m_watchpoints; } 113 114 //---------------------------------------------------------------------- 115 // Exception thread functions 116 //---------------------------------------------------------------------- 117 bool StartSTDIOThread (); 118 static void * STDIOThread (void *arg); 119 void ExceptionMessageReceived (const MachException::Message& exceptionMessage); 120 void ExceptionMessageBundleComplete (); 121 void SharedLibrariesUpdated (); 122 nub_size_t CopyImageInfos (struct DNBExecutableImageInfo **image_infos, bool only_changed); 123 124 //---------------------------------------------------------------------- 125 // Accessors 126 //---------------------------------------------------------------------- 127 pid_t ProcessID () const { return m_pid; } 128 bool ProcessIDIsValid () const { return m_pid > 0; } 129 pid_t SetProcessID (pid_t pid); 130 MachTask& Task() { return m_task; } 131 const MachTask& Task() const { return m_task; } 132 133 PThreadEvent& Events() { return m_events; } 134 const DNBRegisterSetInfo * 135 GetRegisterSetInfo (nub_thread_t tid, nub_size_t *num_reg_sets) const; 136 bool GetRegisterValue (nub_thread_t tid, uint32_t set, uint32_t reg, DNBRegisterValue *reg_value) const; 137 bool SetRegisterValue (nub_thread_t tid, uint32_t set, uint32_t reg, const DNBRegisterValue *value) const; 138 const char * ThreadGetName (nub_thread_t tid); 139 nub_state_t ThreadGetState (nub_thread_t tid); 140 nub_size_t GetNumThreads () const; 141 nub_thread_t GetThreadAtIndex (nub_size_t thread_idx) const; 142 nub_thread_t GetCurrentThread (); 143 nub_thread_t SetCurrentThread (nub_thread_t tid); 144 MachThreadList & GetThreadList() { return m_thread_list; } 145 bool GetThreadStoppedReason(nub_thread_t tid, struct DNBThreadStopInfo *stop_info) const; 146 void DumpThreadStoppedReason(nub_thread_t tid) const; 147 const char * GetThreadInfo (nub_thread_t tid) const; 148 149 nub_state_t GetState (); 150 void SetState (nub_state_t state); 151 bool IsRunning (nub_state_t state) 152 { 153 return state == eStateRunning || IsStepping(state); 154 } 155 bool IsStepping (nub_state_t state) 156 { 157 return state == eStateStepping; 158 } 159 bool CanResume (nub_state_t state) 160 { 161 return state == eStateStopped; 162 } 163 164 bool GetExitStatus(int* status) 165 { 166 if (GetState() == eStateExited) 167 { 168 if (status) 169 *status = m_exit_status; 170 return true; 171 } 172 return false; 173 } 174 void SetExitStatus(int status) 175 { 176 m_exit_status = status; 177 SetState(eStateExited); 178 } 179 180 uint32_t StopCount() const { return m_stop_count; } 181 void SetChildFileDescriptors (int stdin_fileno, int stdout_fileno, int stderr_fileno) 182 { 183 m_child_stdin = stdin_fileno; 184 m_child_stdout = stdout_fileno; 185 m_child_stderr = stderr_fileno; 186 } 187 188 int GetStdinFileDescriptor () const { return m_child_stdin; } 189 int GetStdoutFileDescriptor () const { return m_child_stdout; } 190 int GetStderrFileDescriptor () const { return m_child_stderr; } 191 void AppendSTDOUT (char* s, size_t len); 192 size_t GetAvailableSTDOUT (char *buf, size_t buf_size); 193 size_t GetAvailableSTDERR (char *buf, size_t buf_size); 194 void CloseChildFileDescriptors () 195 { 196 if (m_child_stdin >= 0) 197 { 198 ::close (m_child_stdin); 199 m_child_stdin = -1; 200 } 201 if (m_child_stdout >= 0) 202 { 203 ::close (m_child_stdout); 204 m_child_stdout = -1; 205 } 206 if (m_child_stderr >= 0) 207 { 208 ::close (m_child_stderr); 209 m_child_stderr = -1; 210 } 211 } 212 213 bool ProcessUsingSpringBoard() const { return (m_flags & eMachProcessFlagsUsingSBS) != 0; } 214private: 215 enum 216 { 217 eMachProcessFlagsNone = 0, 218 eMachProcessFlagsAttached = (1 << 0), 219 eMachProcessFlagsUsingSBS = (1 << 1) 220 }; 221 void Clear (); 222 void ReplyToAllExceptions (); 223 void PrivateResume (); 224 nub_size_t RemoveTrapsFromBuffer (nub_addr_t addr, nub_size_t size, uint8_t *buf) const; 225 226 uint32_t Flags () const { return m_flags; } 227 nub_state_t DoSIGSTOP (bool clear_bps_and_wps, uint32_t *thread_idx_ptr = NULL); 228 229 pid_t m_pid; // Process ID of child process 230 int m_child_stdin; 231 int m_child_stdout; 232 int m_child_stderr; 233 std::string m_path; // A path to the executable if we have one 234 std::vector<std::string> m_args; // The arguments with which the process was lauched 235 int m_exit_status; // The exit status for the process 236 MachTask m_task; // The mach task for this process 237 uint32_t m_flags; // Process specific flags (see eMachProcessFlags enums) 238 uint32_t m_stop_count; // A count of many times have we stopped 239 pthread_t m_stdio_thread; // Thread ID for the thread that watches for child process stdio 240 PThreadMutex m_stdio_mutex; // Multithreaded protection for stdio 241 std::string m_stdout_data; 242 DNBThreadResumeActions m_thread_actions; // The thread actions for the current MachProcess::Resume() call 243 MachException::Message::collection 244 m_exception_messages; // A collection of exception messages caught when listening to the exception port 245 PThreadMutex m_exception_messages_mutex; // Multithreaded protection for m_exception_messages 246 247 MachThreadList m_thread_list; // A list of threads that is maintained/updated after each stop 248 nub_state_t m_state; // The state of our process 249 PThreadMutex m_state_mutex; // Multithreaded protection for m_state 250 PThreadEvent m_events; // Process related events in the child processes lifetime can be waited upon 251 DNBBreakpointList m_breakpoints; // Breakpoint list for this process 252 DNBBreakpointList m_watchpoints; // Watchpoint list for this process 253 DNBCallbackNameToAddress m_name_to_addr_callback; 254 void * m_name_to_addr_baton; 255 DNBCallbackCopyExecutableImageInfos 256 m_image_infos_callback; 257 void * m_image_infos_baton; 258}; 259 260 261#endif // __MachProcess_h__ 262