1 //===-- MachProcess.h -------------------------------------------*- C++ -*-===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // Created by Greg Clayton on 6/15/07. 10 // 11 //===----------------------------------------------------------------------===// 12 13 #ifndef LLDB_TOOLS_DEBUGSERVER_SOURCE_MACOSX_MACHPROCESS_H 14 #define LLDB_TOOLS_DEBUGSERVER_SOURCE_MACOSX_MACHPROCESS_H 15 16 #include <CoreFoundation/CoreFoundation.h> 17 #include <mach-o/loader.h> 18 #include <mach/mach.h> 19 #include <pthread.h> 20 #include <sys/signal.h> 21 #include <uuid/uuid.h> 22 #include <vector> 23 24 #include "DNBBreakpoint.h" 25 #include "DNBDefs.h" 26 #include "DNBError.h" 27 #include "DNBThreadResumeActions.h" 28 #include "Genealogy.h" 29 #include "JSONGenerator.h" 30 #include "MachException.h" 31 #include "MachTask.h" 32 #include "MachThreadList.h" 33 #include "MachVMMemory.h" 34 #include "PThreadCondition.h" 35 #include "PThreadEvent.h" 36 #include "PThreadMutex.h" 37 #include "ThreadInfo.h" 38 39 class DNBThreadResumeActions; 40 41 class MachProcess { 42 public: 43 // Constructors and Destructors 44 MachProcess(); 45 ~MachProcess(); 46 47 // A structure that can hold everything debugserver needs to know from 48 // a binary's Mach-O header / load commands. 49 50 struct mach_o_segment { 51 std::string name; 52 uint64_t vmaddr; 53 uint64_t vmsize; 54 uint64_t fileoff; 55 uint64_t filesize; 56 uint64_t maxprot; 57 uint64_t initprot; 58 uint64_t nsects; 59 uint64_t flags; 60 }; 61 62 struct mach_o_information { 63 struct mach_header_64 mach_header; 64 std::vector<struct mach_o_segment> segments; 65 uuid_t uuid; 66 std::string min_version_os_name; 67 std::string min_version_os_version; 68 }; 69 70 struct binary_image_information { 71 std::string filename; 72 uint64_t load_address; 73 uint64_t mod_date; // may not be available - 0 if so 74 struct mach_o_information macho_info; 75 binary_image_informationbinary_image_information76 binary_image_information() 77 : filename(), load_address(INVALID_NUB_ADDRESS), mod_date(0) {} 78 }; 79 80 // Child process control 81 pid_t AttachForDebug(pid_t pid, bool unmask_signals, char *err_str, 82 size_t err_len); 83 pid_t LaunchForDebug(const char *path, char const *argv[], char const *envp[], 84 const char *working_directory, const char *stdin_path, 85 const char *stdout_path, const char *stderr_path, 86 bool no_stdio, nub_launch_flavor_t launch_flavor, 87 int disable_aslr, const char *event_data, 88 bool unmask_signals, DNBError &err); 89 90 static uint32_t GetCPUTypeForLocalProcess(pid_t pid); 91 static pid_t ForkChildForPTraceDebugging(const char *path, char const *argv[], 92 char const *envp[], 93 MachProcess *process, DNBError &err); 94 static pid_t PosixSpawnChildForPTraceDebugging( 95 const char *path, cpu_type_t cpu_type, cpu_subtype_t cpu_subtype, 96 char const *argv[], char const *envp[], const char *working_directory, 97 const char *stdin_path, const char *stdout_path, const char *stderr_path, 98 bool no_stdio, MachProcess *process, int disable_aslr, DNBError &err); 99 nub_addr_t GetDYLDAllImageInfosAddress(); 100 static const void *PrepareForAttach(const char *path, 101 nub_launch_flavor_t launch_flavor, 102 bool waitfor, DNBError &err_str); 103 static void CleanupAfterAttach(const void *attach_token, 104 nub_launch_flavor_t launch_flavor, 105 bool success, DNBError &err_str); 106 static nub_process_t CheckForProcess(const void *attach_token, 107 nub_launch_flavor_t launch_flavor); 108 #if defined(WITH_BKS) || defined(WITH_FBS) 109 pid_t BoardServiceLaunchForDebug(const char *app_bundle_path, 110 char const *argv[], char const *envp[], 111 bool no_stdio, bool disable_aslr, 112 const char *event_data, bool unmask_signals, 113 DNBError &launch_err); 114 pid_t BoardServiceForkChildForPTraceDebugging( 115 const char *path, char const *argv[], char const *envp[], bool no_stdio, 116 bool disable_aslr, const char *event_data, DNBError &launch_err); 117 bool BoardServiceSendEvent(const char *event, DNBError &error); 118 #endif 119 static bool GetOSVersionNumbers(uint64_t *major, uint64_t *minor, 120 uint64_t *patch); 121 static std::string GetMacCatalystVersionString(); 122 #ifdef WITH_BKS 123 static void BKSCleanupAfterAttach(const void *attach_token, 124 DNBError &err_str); 125 #endif // WITH_BKS 126 #ifdef WITH_FBS 127 static void FBSCleanupAfterAttach(const void *attach_token, 128 DNBError &err_str); 129 #endif // WITH_FBS 130 #ifdef WITH_SPRINGBOARD 131 pid_t SBLaunchForDebug(const char *app_bundle_path, char const *argv[], 132 char const *envp[], bool no_stdio, bool disable_aslr, 133 bool unmask_signals, DNBError &launch_err); 134 static pid_t SBForkChildForPTraceDebugging(const char *path, 135 char const *argv[], 136 char const *envp[], bool no_stdio, 137 MachProcess *process, 138 DNBError &launch_err); 139 #endif // WITH_SPRINGBOARD 140 nub_addr_t LookupSymbol(const char *name, const char *shlib); SetNameToAddressCallback(DNBCallbackNameToAddress callback,void * baton)141 void SetNameToAddressCallback(DNBCallbackNameToAddress callback, 142 void *baton) { 143 m_name_to_addr_callback = callback; 144 m_name_to_addr_baton = baton; 145 } 146 void SetSharedLibraryInfoCallback(DNBCallbackCopyExecutableImageInfos callback,void * baton)147 SetSharedLibraryInfoCallback(DNBCallbackCopyExecutableImageInfos callback, 148 void *baton) { 149 m_image_infos_callback = callback; 150 m_image_infos_baton = baton; 151 } 152 153 bool Resume(const DNBThreadResumeActions &thread_actions); 154 bool Signal(int signal, const struct timespec *timeout_abstime = NULL); 155 bool Interrupt(); 156 bool SendEvent(const char *event, DNBError &send_err); 157 bool Kill(const struct timespec *timeout_abstime = NULL); 158 bool Detach(); 159 nub_size_t ReadMemory(nub_addr_t addr, nub_size_t size, void *buf); 160 nub_size_t WriteMemory(nub_addr_t addr, nub_size_t size, const void *buf); 161 162 // Path and arg accessors Path()163 const char *Path() const { return m_path.c_str(); } ArgumentCount()164 size_t ArgumentCount() const { return m_args.size(); } ArgumentAtIndex(size_t arg_idx)165 const char *ArgumentAtIndex(size_t arg_idx) const { 166 if (arg_idx < m_args.size()) 167 return m_args[arg_idx].c_str(); 168 return NULL; 169 } 170 171 // Breakpoint functions 172 DNBBreakpoint *CreateBreakpoint(nub_addr_t addr, nub_size_t length, 173 bool hardware); 174 bool DisableBreakpoint(nub_addr_t addr, bool remove); 175 void DisableAllBreakpoints(bool remove); 176 bool EnableBreakpoint(nub_addr_t addr); Breakpoints()177 DNBBreakpointList &Breakpoints() { return m_breakpoints; } Breakpoints()178 const DNBBreakpointList &Breakpoints() const { return m_breakpoints; } 179 180 // Watchpoint functions 181 DNBBreakpoint *CreateWatchpoint(nub_addr_t addr, nub_size_t length, 182 uint32_t watch_type, bool hardware); 183 bool DisableWatchpoint(nub_addr_t addr, bool remove); 184 void DisableAllWatchpoints(bool remove); 185 bool EnableWatchpoint(nub_addr_t addr); 186 uint32_t GetNumSupportedHardwareWatchpoints() const; Watchpoints()187 DNBBreakpointList &Watchpoints() { return m_watchpoints; } Watchpoints()188 const DNBBreakpointList &Watchpoints() const { return m_watchpoints; } 189 190 // Exception thread functions 191 bool StartSTDIOThread(); 192 static void *STDIOThread(void *arg); 193 void ExceptionMessageReceived(const MachException::Message &exceptionMessage); 194 task_t ExceptionMessageBundleComplete(); 195 void SharedLibrariesUpdated(); 196 nub_size_t CopyImageInfos(struct DNBExecutableImageInfo **image_infos, 197 bool only_changed); 198 199 // Profile functions 200 void SetEnableAsyncProfiling(bool enable, uint64_t internal_usec, 201 DNBProfileDataScanType scan_type); IsProfilingEnabled()202 bool IsProfilingEnabled() { return m_profile_enabled; } ProfileInterval()203 useconds_t ProfileInterval() { return m_profile_interval_usec; } 204 bool StartProfileThread(); 205 static void *ProfileThread(void *arg); 206 void SignalAsyncProfileData(const char *info); 207 size_t GetAsyncProfileData(char *buf, size_t buf_size); 208 209 // Accessors ProcessID()210 pid_t ProcessID() const { return m_pid; } ProcessIDIsValid()211 bool ProcessIDIsValid() const { return m_pid > 0; } 212 pid_t SetProcessID(pid_t pid); Task()213 MachTask &Task() { return m_task; } Task()214 const MachTask &Task() const { return m_task; } 215 Events()216 PThreadEvent &Events() { return m_events; } 217 const DNBRegisterSetInfo *GetRegisterSetInfo(nub_thread_t tid, 218 nub_size_t *num_reg_sets) const; 219 bool GetRegisterValue(nub_thread_t tid, uint32_t set, uint32_t reg, 220 DNBRegisterValue *reg_value) const; 221 bool SetRegisterValue(nub_thread_t tid, uint32_t set, uint32_t reg, 222 const DNBRegisterValue *value) const; 223 nub_bool_t SyncThreadState(nub_thread_t tid); 224 const char *ThreadGetName(nub_thread_t tid); 225 nub_state_t ThreadGetState(nub_thread_t tid); 226 ThreadInfo::QoS GetRequestedQoS(nub_thread_t tid, nub_addr_t tsd, 227 uint64_t dti_qos_class_index); 228 nub_addr_t GetPThreadT(nub_thread_t tid); 229 nub_addr_t GetDispatchQueueT(nub_thread_t tid); 230 nub_addr_t 231 GetTSDAddressForThread(nub_thread_t tid, 232 uint64_t plo_pthread_tsd_base_address_offset, 233 uint64_t plo_pthread_tsd_base_offset, 234 uint64_t plo_pthread_tsd_entry_size); 235 236 struct DeploymentInfo { 237 DeploymentInfo() = default; 238 operator bool() { return platform > 0; } 239 /// The Mach-O platform type; 240 unsigned char platform = 0; 241 uint32_t major_version = 0; 242 uint32_t minor_version = 0; 243 uint32_t patch_version = 0; 244 }; 245 DeploymentInfo GetDeploymentInfo(const struct load_command &, 246 uint64_t load_command_address, 247 bool is_executable); 248 static const char *GetPlatformString(unsigned char platform); 249 bool GetMachOInformationFromMemory(uint32_t platform, 250 nub_addr_t mach_o_header_addr, 251 int wordsize, 252 struct mach_o_information &inf); 253 JSONGenerator::ObjectSP FormatDynamicLibrariesIntoJSON( 254 const std::vector<struct binary_image_information> &image_infos); 255 /// Get the runtime platform from DYLD via SPI. 256 uint32_t GetProcessPlatformViaDYLDSPI(); 257 /// Use the dyld SPI present in macOS 10.12, iOS 10, tvOS 10, 258 /// watchOS 3 and newer to get the load address, uuid, and filenames 259 /// of all the libraries. This only fills in those three fields in 260 /// the 'struct binary_image_information' - call 261 /// GetMachOInformationFromMemory to fill in the mach-o header/load 262 /// command details. 263 void GetAllLoadedBinariesViaDYLDSPI( 264 std::vector<struct binary_image_information> &image_infos); 265 JSONGenerator::ObjectSP GetLoadedDynamicLibrariesInfos( 266 nub_process_t pid, nub_addr_t image_list_address, nub_addr_t image_count); 267 JSONGenerator::ObjectSP 268 GetLibrariesInfoForAddresses(nub_process_t pid, 269 std::vector<uint64_t> &macho_addresses); 270 JSONGenerator::ObjectSP GetAllLoadedLibrariesInfos(nub_process_t pid); 271 JSONGenerator::ObjectSP GetSharedCacheInfo(nub_process_t pid); 272 273 nub_size_t GetNumThreads() const; 274 nub_thread_t GetThreadAtIndex(nub_size_t thread_idx) const; 275 nub_thread_t GetCurrentThread(); 276 nub_thread_t GetCurrentThreadMachPort(); 277 nub_thread_t SetCurrentThread(nub_thread_t tid); GetThreadList()278 MachThreadList &GetThreadList() { return m_thread_list; } 279 bool GetThreadStoppedReason(nub_thread_t tid, 280 struct DNBThreadStopInfo *stop_info); 281 void DumpThreadStoppedReason(nub_thread_t tid) const; 282 const char *GetThreadInfo(nub_thread_t tid) const; 283 284 nub_thread_t GetThreadIDForMachPortNumber(thread_t mach_port_number) const; 285 286 uint32_t GetCPUType(); 287 nub_state_t GetState(); 288 void SetState(nub_state_t state); IsRunning(nub_state_t state)289 bool IsRunning(nub_state_t state) { 290 return state == eStateRunning || IsStepping(state); 291 } IsStepping(nub_state_t state)292 bool IsStepping(nub_state_t state) { return state == eStateStepping; } CanResume(nub_state_t state)293 bool CanResume(nub_state_t state) { return state == eStateStopped; } 294 GetExitStatus(int * status)295 bool GetExitStatus(int *status) { 296 if (GetState() == eStateExited) { 297 if (status) 298 *status = m_exit_status; 299 return true; 300 } 301 return false; 302 } SetExitStatus(int status)303 void SetExitStatus(int status) { 304 m_exit_status = status; 305 SetState(eStateExited); 306 } GetExitInfo()307 const char *GetExitInfo() { return m_exit_info.c_str(); } 308 309 void SetExitInfo(const char *info); 310 StopCount()311 uint32_t StopCount() const { return m_stop_count; } SetChildFileDescriptors(int stdin_fileno,int stdout_fileno,int stderr_fileno)312 void SetChildFileDescriptors(int stdin_fileno, int stdout_fileno, 313 int stderr_fileno) { 314 m_child_stdin = stdin_fileno; 315 m_child_stdout = stdout_fileno; 316 m_child_stderr = stderr_fileno; 317 } 318 GetStdinFileDescriptor()319 int GetStdinFileDescriptor() const { return m_child_stdin; } GetStdoutFileDescriptor()320 int GetStdoutFileDescriptor() const { return m_child_stdout; } GetStderrFileDescriptor()321 int GetStderrFileDescriptor() const { return m_child_stderr; } 322 void AppendSTDOUT(char *s, size_t len); 323 size_t GetAvailableSTDOUT(char *buf, size_t buf_size); 324 size_t GetAvailableSTDERR(char *buf, size_t buf_size); CloseChildFileDescriptors()325 void CloseChildFileDescriptors() { 326 if (m_child_stdin >= 0) { 327 ::close(m_child_stdin); 328 m_child_stdin = -1; 329 } 330 if (m_child_stdout >= 0) { 331 ::close(m_child_stdout); 332 m_child_stdout = -1; 333 } 334 if (m_child_stderr >= 0) { 335 ::close(m_child_stderr); 336 m_child_stderr = -1; 337 } 338 } 339 340 void CalculateBoardStatus(); 341 342 bool ProcessUsingBackBoard(); 343 344 bool ProcessUsingFrontBoard(); 345 346 Genealogy::ThreadActivitySP GetGenealogyInfoForThread(nub_thread_t tid, 347 bool &timed_out); 348 349 Genealogy::ProcessExecutableInfoSP GetGenealogyImageInfo(size_t idx); 350 GetProfileScanType()351 DNBProfileDataScanType GetProfileScanType() { return m_profile_scan_type; } 352 353 private: 354 enum { 355 eMachProcessFlagsNone = 0, 356 eMachProcessFlagsAttached = (1 << 0), 357 eMachProcessFlagsUsingBKS = (1 << 2), // only read via ProcessUsingBackBoard() 358 eMachProcessFlagsUsingFBS = (1 << 3), // only read via ProcessUsingFrontBoard() 359 eMachProcessFlagsBoardCalculated = (1 << 4) 360 }; 361 362 enum { 363 eMachProcessProfileNone = 0, 364 eMachProcessProfileCancel = (1 << 0) 365 }; 366 367 void Clear(bool detaching = false); 368 void ReplyToAllExceptions(); 369 void PrivateResume(); 370 void StopProfileThread(); 371 Flags()372 uint32_t Flags() const { return m_flags; } 373 nub_state_t DoSIGSTOP(bool clear_bps_and_wps, bool allow_running, 374 uint32_t *thread_idx_ptr); 375 376 pid_t m_pid; // Process ID of child process 377 cpu_type_t m_cpu_type; // The CPU type of this process 378 int m_child_stdin; 379 int m_child_stdout; 380 int m_child_stderr; 381 std::string m_path; // A path to the executable if we have one 382 std::vector<std::string> 383 m_args; // The arguments with which the process was lauched 384 int m_exit_status; // The exit status for the process 385 std::string m_exit_info; // Any extra info that we may have about the exit 386 MachTask m_task; // The mach task for this process 387 uint32_t m_flags; // Process specific flags (see eMachProcessFlags enums) 388 uint32_t m_stop_count; // A count of many times have we stopped 389 pthread_t m_stdio_thread; // Thread ID for the thread that watches for child 390 // process stdio 391 PThreadMutex m_stdio_mutex; // Multithreaded protection for stdio 392 std::string m_stdout_data; 393 394 bool m_profile_enabled; // A flag to indicate if profiling is enabled 395 useconds_t m_profile_interval_usec; // If enable, the profiling interval in 396 // microseconds 397 DNBProfileDataScanType 398 m_profile_scan_type; // Indicates what needs to be profiled 399 pthread_t 400 m_profile_thread; // Thread ID for the thread that profiles the inferior 401 PThreadMutex 402 m_profile_data_mutex; // Multithreaded protection for profile info data 403 std::vector<std::string> 404 m_profile_data; // Profile data, must be protected by m_profile_data_mutex 405 PThreadEvent m_profile_events; // Used for the profile thread cancellable wait 406 DNBThreadResumeActions m_thread_actions; // The thread actions for the current 407 // MachProcess::Resume() call 408 MachException::Message::collection m_exception_messages; // A collection of 409 // exception messages 410 // caught when 411 // listening to the 412 // exception port 413 PThreadMutex m_exception_messages_mutex; // Multithreaded protection for 414 // m_exception_messages 415 416 MachThreadList m_thread_list; // A list of threads that is maintained/updated 417 // after each stop 418 Genealogy m_activities; // A list of activities that is updated after every 419 // stop lazily 420 nub_state_t m_state; // The state of our process 421 PThreadMutex m_state_mutex; // Multithreaded protection for m_state 422 PThreadEvent m_events; // Process related events in the child processes 423 // lifetime can be waited upon 424 PThreadEvent m_private_events; // Used to coordinate running and stopping the 425 // process without affecting m_events 426 DNBBreakpointList m_breakpoints; // Breakpoint list for this process 427 DNBBreakpointList m_watchpoints; // Watchpoint list for this process 428 DNBCallbackNameToAddress m_name_to_addr_callback; 429 void *m_name_to_addr_baton; 430 DNBCallbackCopyExecutableImageInfos m_image_infos_callback; 431 void *m_image_infos_baton; 432 std::string 433 m_bundle_id; // If we are a SB or BKS process, this will be our bundle ID. 434 int m_sent_interrupt_signo; // When we call MachProcess::Interrupt(), we want 435 // to send a single signal 436 // to the inferior and only send the signal if we aren't already stopped. 437 // If we end up sending a signal to stop the process we store it until we 438 // receive an exception with this signal. This helps us to verify we got 439 // the signal that interrupted the process. We might stop due to another 440 // reason after an interrupt signal is sent, so this helps us ensure that 441 // we don't report a spurious stop on the next resume. 442 int m_auto_resume_signo; // If we resume the process and still haven't 443 // received our interrupt signal 444 // acknowledgement, we will shortly after the next resume. We store the 445 // interrupt signal in this variable so when we get the interrupt signal 446 // as the sole reason for the process being stopped, we can auto resume 447 // the process. 448 bool m_did_exec; 449 450 void *(*m_dyld_process_info_create)(task_t task, uint64_t timestamp, 451 kern_return_t *kernelError); 452 void (*m_dyld_process_info_for_each_image)( 453 void *info, void (^callback)(uint64_t machHeaderAddress, 454 const uuid_t uuid, const char *path)); 455 void (*m_dyld_process_info_release)(void *info); 456 void (*m_dyld_process_info_get_cache)(void *info, void *cacheInfo); 457 uint32_t (*m_dyld_process_info_get_platform)(void *info); 458 }; 459 460 #endif // LLDB_TOOLS_DEBUGSERVER_SOURCE_MACOSX_MACHPROCESS_H 461