1 //===-- debugserver.cpp -----------------------------------------*- 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 #include <arpa/inet.h> 10 #include <asl.h> 11 #include <crt_externs.h> 12 #include <errno.h> 13 #include <getopt.h> 14 #include <netdb.h> 15 #include <netinet/in.h> 16 #include <netinet/tcp.h> 17 #include <string> 18 #include <sys/select.h> 19 #include <sys/socket.h> 20 #include <sys/sysctl.h> 21 #include <sys/types.h> 22 #include <sys/un.h> 23 24 #include <memory> 25 #include <vector> 26 27 #if defined(__APPLE__) 28 #include <sched.h> 29 extern "C" int proc_set_wakemon_params(pid_t, int, 30 int); // <libproc_internal.h> SPI 31 #endif 32 33 #include "CFString.h" 34 #include "DNB.h" 35 #include "DNBLog.h" 36 #include "DNBTimer.h" 37 #include "OsLogger.h" 38 #include "PseudoTerminal.h" 39 #include "RNBContext.h" 40 #include "RNBRemote.h" 41 #include "RNBServices.h" 42 #include "RNBSocket.h" 43 #include "SysSignal.h" 44 45 // Global PID in case we get a signal and need to stop the process... 46 nub_process_t g_pid = INVALID_NUB_PROCESS; 47 48 // Run loop modes which determine which run loop function will be called 49 enum RNBRunLoopMode { 50 eRNBRunLoopModeInvalid = 0, 51 eRNBRunLoopModeGetStartModeFromRemoteProtocol, 52 eRNBRunLoopModeInferiorAttaching, 53 eRNBRunLoopModeInferiorLaunching, 54 eRNBRunLoopModeInferiorExecuting, 55 eRNBRunLoopModePlatformMode, 56 eRNBRunLoopModeExit 57 }; 58 59 // Global Variables 60 RNBRemoteSP g_remoteSP; 61 static int g_lockdown_opt = 0; 62 static int g_applist_opt = 0; 63 static nub_launch_flavor_t g_launch_flavor = eLaunchFlavorDefault; 64 int g_disable_aslr = 0; 65 66 int g_isatty = 0; 67 bool g_detach_on_error = true; 68 69 #define RNBLogSTDOUT(fmt, ...) \ 70 do { \ 71 if (g_isatty) { \ 72 fprintf(stdout, fmt, ##__VA_ARGS__); \ 73 } else { \ 74 _DNBLog(0, fmt, ##__VA_ARGS__); \ 75 } \ 76 } while (0) 77 #define RNBLogSTDERR(fmt, ...) \ 78 do { \ 79 if (g_isatty) { \ 80 fprintf(stderr, fmt, ##__VA_ARGS__); \ 81 } else { \ 82 _DNBLog(0, fmt, ##__VA_ARGS__); \ 83 } \ 84 } while (0) 85 86 // Get our program path and arguments from the remote connection. 87 // We will need to start up the remote connection without a PID, get the 88 // arguments, wait for the new process to finish launching and hit its 89 // entry point, and then return the run loop mode that should come next. 90 RNBRunLoopMode RNBRunLoopGetStartModeFromRemote(RNBRemote *remote) { 91 std::string packet; 92 93 if (remote) { 94 RNBContext &ctx = remote->Context(); 95 uint32_t event_mask = RNBContext::event_read_packet_available | 96 RNBContext::event_read_thread_exiting; 97 98 // Spin waiting to get the A packet. 99 while (true) { 100 DNBLogThreadedIf(LOG_RNB_MAX, 101 "%s ctx.Events().WaitForSetEvents( 0x%08x ) ...", 102 __FUNCTION__, event_mask); 103 nub_event_t set_events = ctx.Events().WaitForSetEvents(event_mask); 104 DNBLogThreadedIf(LOG_RNB_MAX, 105 "%s ctx.Events().WaitForSetEvents( 0x%08x ) => 0x%08x", 106 __FUNCTION__, event_mask, set_events); 107 108 if (set_events & RNBContext::event_read_thread_exiting) { 109 RNBLogSTDERR("error: packet read thread exited.\n"); 110 return eRNBRunLoopModeExit; 111 } 112 113 if (set_events & RNBContext::event_read_packet_available) { 114 rnb_err_t err = rnb_err; 115 RNBRemote::PacketEnum type; 116 117 err = remote->HandleReceivedPacket(&type); 118 119 // check if we tried to attach to a process 120 if (type == RNBRemote::vattach || type == RNBRemote::vattachwait || 121 type == RNBRemote::vattachorwait) { 122 if (err == rnb_success) { 123 RNBLogSTDOUT("Attach succeeded, ready to debug.\n"); 124 return eRNBRunLoopModeInferiorExecuting; 125 } else { 126 RNBLogSTDERR("error: attach failed.\n"); 127 return eRNBRunLoopModeExit; 128 } 129 } 130 131 if (err == rnb_success) { 132 // If we got our arguments we are ready to launch using the arguments 133 // and any environment variables we received. 134 if (type == RNBRemote::set_argv) { 135 return eRNBRunLoopModeInferiorLaunching; 136 } 137 } else if (err == rnb_not_connected) { 138 RNBLogSTDERR("error: connection lost.\n"); 139 return eRNBRunLoopModeExit; 140 } else { 141 // a catch all for any other gdb remote packets that failed 142 DNBLogThreadedIf(LOG_RNB_MINIMAL, "%s Error getting packet.", 143 __FUNCTION__); 144 continue; 145 } 146 147 DNBLogThreadedIf(LOG_RNB_MINIMAL, "#### %s", __FUNCTION__); 148 } else { 149 DNBLogThreadedIf(LOG_RNB_MINIMAL, 150 "%s Connection closed before getting \"A\" packet.", 151 __FUNCTION__); 152 return eRNBRunLoopModeExit; 153 } 154 } 155 } 156 return eRNBRunLoopModeExit; 157 } 158 159 static nub_launch_flavor_t default_launch_flavor(const char *app_name) { 160 #if defined(WITH_FBS) || defined(WITH_BKS) || defined(WITH_SPRINGBOARD) 161 // Check the name to see if it ends with .app 162 auto is_dot_app = [](const char *app_name) { 163 size_t len = strlen(app_name); 164 if (len < 4) 165 return false; 166 167 if (app_name[len - 4] == '.' && app_name[len - 3] == 'a' && 168 app_name[len - 2] == 'p' && app_name[len - 1] == 'p') 169 return true; 170 return false; 171 }; 172 173 if (is_dot_app(app_name)) { 174 #if defined WITH_FBS 175 // Check if we have an app bundle, if so launch using FrontBoard Services. 176 return eLaunchFlavorFBS; 177 #elif defined WITH_BKS 178 // Check if we have an app bundle, if so launch using BackBoard Services. 179 return eLaunchFlavorBKS; 180 #elif defined WITH_SPRINGBOARD 181 // Check if we have an app bundle, if so launch using SpringBoard. 182 return eLaunchFlavorSpringBoard; 183 #endif 184 } 185 #endif 186 187 // Our default launch method is posix spawn 188 return eLaunchFlavorPosixSpawn; 189 } 190 191 // This run loop mode will wait for the process to launch and hit its 192 // entry point. It will currently ignore all events except for the 193 // process state changed event, where it watches for the process stopped 194 // or crash process state. 195 RNBRunLoopMode RNBRunLoopLaunchInferior(RNBRemote *remote, 196 const char *stdin_path, 197 const char *stdout_path, 198 const char *stderr_path, 199 bool no_stdio) { 200 RNBContext &ctx = remote->Context(); 201 202 // The Process stuff takes a c array, the RNBContext has a vector... 203 // So make up a c array. 204 205 DNBLogThreadedIf(LOG_RNB_MINIMAL, "%s Launching '%s'...", __FUNCTION__, 206 ctx.ArgumentAtIndex(0)); 207 208 size_t inferior_argc = ctx.ArgumentCount(); 209 // Initialize inferior_argv with inferior_argc + 1 NULLs 210 std::vector<const char *> inferior_argv(inferior_argc + 1, NULL); 211 212 size_t i; 213 for (i = 0; i < inferior_argc; i++) 214 inferior_argv[i] = ctx.ArgumentAtIndex(i); 215 216 // Pass the environment array the same way: 217 218 size_t inferior_envc = ctx.EnvironmentCount(); 219 // Initialize inferior_argv with inferior_argc + 1 NULLs 220 std::vector<const char *> inferior_envp(inferior_envc + 1, NULL); 221 222 for (i = 0; i < inferior_envc; i++) 223 inferior_envp[i] = ctx.EnvironmentAtIndex(i); 224 225 // Our launch type hasn't been set to anything concrete, so we need to 226 // figure our how we are going to launch automatically. 227 228 nub_launch_flavor_t launch_flavor = g_launch_flavor; 229 if (launch_flavor == eLaunchFlavorDefault) 230 launch_flavor = default_launch_flavor(inferior_argv[0]); 231 232 ctx.SetLaunchFlavor(launch_flavor); 233 char resolved_path[PATH_MAX]; 234 235 // If we fail to resolve the path to our executable, then just use what we 236 // were given and hope for the best 237 if (!DNBResolveExecutablePath(inferior_argv[0], resolved_path, 238 sizeof(resolved_path))) 239 ::strlcpy(resolved_path, inferior_argv[0], sizeof(resolved_path)); 240 241 char launch_err_str[PATH_MAX]; 242 launch_err_str[0] = '\0'; 243 const char *cwd = 244 (ctx.GetWorkingDirPath() != NULL ? ctx.GetWorkingDirPath() 245 : ctx.GetWorkingDirectory()); 246 const char *process_event = ctx.GetProcessEvent(); 247 nub_process_t pid = DNBProcessLaunch( 248 &ctx, resolved_path, &inferior_argv[0], &inferior_envp[0], cwd, 249 stdin_path, stdout_path, stderr_path, no_stdio, g_disable_aslr, 250 process_event, launch_err_str, sizeof(launch_err_str)); 251 252 g_pid = pid; 253 254 if (pid == INVALID_NUB_PROCESS && strlen(launch_err_str) > 0) { 255 DNBLogThreaded("%s DNBProcessLaunch() returned error: '%s'", __FUNCTION__, 256 launch_err_str); 257 ctx.LaunchStatus().SetError(-1, DNBError::Generic); 258 ctx.LaunchStatus().SetErrorString(launch_err_str); 259 } else if (pid == INVALID_NUB_PROCESS) { 260 DNBLogThreaded( 261 "%s DNBProcessLaunch() failed to launch process, unknown failure", 262 __FUNCTION__); 263 ctx.LaunchStatus().SetError(-1, DNBError::Generic); 264 ctx.LaunchStatus().SetErrorString("<unknown failure>"); 265 } else { 266 ctx.LaunchStatus().Clear(); 267 } 268 269 if (remote->Comm().IsConnected()) { 270 // It we are connected already, the next thing gdb will do is ask 271 // whether the launch succeeded, and if not, whether there is an 272 // error code. So we need to fetch one packet from gdb before we wait 273 // on the stop from the target. 274 275 uint32_t event_mask = RNBContext::event_read_packet_available; 276 nub_event_t set_events = ctx.Events().WaitForSetEvents(event_mask); 277 278 if (set_events & RNBContext::event_read_packet_available) { 279 rnb_err_t err = rnb_err; 280 RNBRemote::PacketEnum type; 281 282 err = remote->HandleReceivedPacket(&type); 283 284 if (err != rnb_success) { 285 DNBLogThreadedIf(LOG_RNB_MINIMAL, "%s Error getting packet.", 286 __FUNCTION__); 287 return eRNBRunLoopModeExit; 288 } 289 if (type != RNBRemote::query_launch_success) { 290 DNBLogThreadedIf(LOG_RNB_MINIMAL, 291 "%s Didn't get the expected qLaunchSuccess packet.", 292 __FUNCTION__); 293 } 294 } 295 } 296 297 while (pid != INVALID_NUB_PROCESS) { 298 // Wait for process to start up and hit entry point 299 DNBLogThreadedIf(LOG_RNB_EVENTS, "%s DNBProcessWaitForEvent (%4.4x, " 300 "eEventProcessRunningStateChanged | " 301 "eEventProcessStoppedStateChanged, true, " 302 "INFINITE)...", 303 __FUNCTION__, pid); 304 nub_event_t set_events = 305 DNBProcessWaitForEvents(pid, eEventProcessRunningStateChanged | 306 eEventProcessStoppedStateChanged, 307 true, NULL); 308 DNBLogThreadedIf(LOG_RNB_EVENTS, "%s DNBProcessWaitForEvent (%4.4x, " 309 "eEventProcessRunningStateChanged | " 310 "eEventProcessStoppedStateChanged, true, " 311 "INFINITE) => 0x%8.8x", 312 __FUNCTION__, pid, set_events); 313 314 if (set_events == 0) { 315 pid = INVALID_NUB_PROCESS; 316 g_pid = pid; 317 } else { 318 if (set_events & (eEventProcessRunningStateChanged | 319 eEventProcessStoppedStateChanged)) { 320 nub_state_t pid_state = DNBProcessGetState(pid); 321 DNBLogThreadedIf( 322 LOG_RNB_EVENTS, 323 "%s process %4.4x state changed (eEventProcessStateChanged): %s", 324 __FUNCTION__, pid, DNBStateAsString(pid_state)); 325 326 switch (pid_state) { 327 case eStateInvalid: 328 case eStateUnloaded: 329 case eStateAttaching: 330 case eStateLaunching: 331 case eStateSuspended: 332 break; // Ignore 333 334 case eStateRunning: 335 case eStateStepping: 336 // Still waiting to stop at entry point... 337 break; 338 339 case eStateStopped: 340 case eStateCrashed: 341 ctx.SetProcessID(pid); 342 return eRNBRunLoopModeInferiorExecuting; 343 344 case eStateDetached: 345 case eStateExited: 346 pid = INVALID_NUB_PROCESS; 347 g_pid = pid; 348 return eRNBRunLoopModeExit; 349 } 350 } 351 352 DNBProcessResetEvents(pid, set_events); 353 } 354 } 355 356 return eRNBRunLoopModeExit; 357 } 358 359 // This run loop mode will wait for the process to launch and hit its 360 // entry point. It will currently ignore all events except for the 361 // process state changed event, where it watches for the process stopped 362 // or crash process state. 363 RNBRunLoopMode RNBRunLoopLaunchAttaching(RNBRemote *remote, 364 nub_process_t attach_pid, 365 nub_process_t &pid) { 366 RNBContext &ctx = remote->Context(); 367 368 DNBLogThreadedIf(LOG_RNB_MINIMAL, "%s Attaching to pid %i...", __FUNCTION__, 369 attach_pid); 370 char err_str[1024]; 371 pid = DNBProcessAttach(attach_pid, NULL, ctx.GetUnmaskSignals(), err_str, 372 sizeof(err_str)); 373 g_pid = pid; 374 375 if (pid == INVALID_NUB_PROCESS) { 376 ctx.LaunchStatus().SetError(-1, DNBError::Generic); 377 if (err_str[0]) 378 ctx.LaunchStatus().SetErrorString(err_str); 379 return eRNBRunLoopModeExit; 380 } else { 381 ctx.SetProcessID(pid); 382 return eRNBRunLoopModeInferiorExecuting; 383 } 384 } 385 386 // Watch for signals: 387 // SIGINT: so we can halt our inferior. (disabled for now) 388 // SIGPIPE: in case our child process dies 389 int g_sigint_received = 0; 390 int g_sigpipe_received = 0; 391 void signal_handler(int signo) { 392 DNBLogThreadedIf(LOG_RNB_MINIMAL, "%s (%s)", __FUNCTION__, 393 SysSignal::Name(signo)); 394 395 switch (signo) { 396 case SIGINT: 397 g_sigint_received++; 398 if (g_pid != INVALID_NUB_PROCESS) { 399 // Only send a SIGINT once... 400 if (g_sigint_received == 1) { 401 switch (DNBProcessGetState(g_pid)) { 402 case eStateRunning: 403 case eStateStepping: 404 DNBProcessSignal(g_pid, SIGSTOP); 405 return; 406 default: 407 break; 408 } 409 } 410 } 411 exit(SIGINT); 412 break; 413 414 case SIGPIPE: 415 g_sigpipe_received = 1; 416 break; 417 } 418 } 419 420 // Return the new run loop mode based off of the current process state 421 RNBRunLoopMode HandleProcessStateChange(RNBRemote *remote, bool initialize) { 422 RNBContext &ctx = remote->Context(); 423 nub_process_t pid = ctx.ProcessID(); 424 425 if (pid == INVALID_NUB_PROCESS) { 426 DNBLogThreadedIf(LOG_RNB_MINIMAL, "#### %s error: pid invalid, exiting...", 427 __FUNCTION__); 428 return eRNBRunLoopModeExit; 429 } 430 nub_state_t pid_state = DNBProcessGetState(pid); 431 432 DNBLogThreadedIf(LOG_RNB_MINIMAL, 433 "%s (&remote, initialize=%i) pid_state = %s", __FUNCTION__, 434 (int)initialize, DNBStateAsString(pid_state)); 435 436 switch (pid_state) { 437 case eStateInvalid: 438 case eStateUnloaded: 439 // Something bad happened 440 return eRNBRunLoopModeExit; 441 break; 442 443 case eStateAttaching: 444 case eStateLaunching: 445 return eRNBRunLoopModeInferiorExecuting; 446 447 case eStateSuspended: 448 case eStateCrashed: 449 case eStateStopped: 450 // If we stop due to a signal, so clear the fact that we got a SIGINT 451 // so we can stop ourselves again (but only while our inferior 452 // process is running..) 453 g_sigint_received = 0; 454 if (initialize == false) { 455 // Compare the last stop count to our current notion of a stop count 456 // to make sure we don't notify more than once for a given stop. 457 nub_size_t prev_pid_stop_count = ctx.GetProcessStopCount(); 458 bool pid_stop_count_changed = 459 ctx.SetProcessStopCount(DNBProcessGetStopCount(pid)); 460 if (pid_stop_count_changed) { 461 remote->FlushSTDIO(); 462 463 if (ctx.GetProcessStopCount() == 1) { 464 DNBLogThreadedIf( 465 LOG_RNB_MINIMAL, "%s (&remote, initialize=%i) pid_state = %s " 466 "pid_stop_count %llu (old %llu)) Notify??? no, " 467 "first stop...", 468 __FUNCTION__, (int)initialize, DNBStateAsString(pid_state), 469 (uint64_t)ctx.GetProcessStopCount(), 470 (uint64_t)prev_pid_stop_count); 471 } else { 472 473 DNBLogThreadedIf(LOG_RNB_MINIMAL, "%s (&remote, initialize=%i) " 474 "pid_state = %s pid_stop_count " 475 "%llu (old %llu)) Notify??? YES!!!", 476 __FUNCTION__, (int)initialize, 477 DNBStateAsString(pid_state), 478 (uint64_t)ctx.GetProcessStopCount(), 479 (uint64_t)prev_pid_stop_count); 480 remote->NotifyThatProcessStopped(); 481 } 482 } else { 483 DNBLogThreadedIf( 484 LOG_RNB_MINIMAL, "%s (&remote, initialize=%i) pid_state = %s " 485 "pid_stop_count %llu (old %llu)) Notify??? " 486 "skipping...", 487 __FUNCTION__, (int)initialize, DNBStateAsString(pid_state), 488 (uint64_t)ctx.GetProcessStopCount(), (uint64_t)prev_pid_stop_count); 489 } 490 } 491 return eRNBRunLoopModeInferiorExecuting; 492 493 case eStateStepping: 494 case eStateRunning: 495 return eRNBRunLoopModeInferiorExecuting; 496 497 case eStateExited: 498 remote->HandlePacket_last_signal(NULL); 499 return eRNBRunLoopModeExit; 500 case eStateDetached: 501 return eRNBRunLoopModeExit; 502 } 503 504 // Catch all... 505 return eRNBRunLoopModeExit; 506 } 507 508 // This function handles the case where our inferior program is stopped and 509 // we are waiting for gdb remote protocol packets. When a packet occurs that 510 // makes the inferior run, we need to leave this function with a new state 511 // as the return code. 512 RNBRunLoopMode RNBRunLoopInferiorExecuting(RNBRemote *remote) { 513 DNBLogThreadedIf(LOG_RNB_MINIMAL, "#### %s", __FUNCTION__); 514 RNBContext &ctx = remote->Context(); 515 516 // Init our mode and set 'is_running' based on the current process state 517 RNBRunLoopMode mode = HandleProcessStateChange(remote, true); 518 519 while (ctx.ProcessID() != INVALID_NUB_PROCESS) { 520 521 std::string set_events_str; 522 uint32_t event_mask = ctx.NormalEventBits(); 523 524 if (!ctx.ProcessStateRunning()) { 525 // Clear some bits if we are not running so we don't send any async 526 // packets 527 event_mask &= ~RNBContext::event_proc_stdio_available; 528 event_mask &= ~RNBContext::event_proc_profile_data; 529 // When we enable async structured data packets over another logical 530 // channel, 531 // this can be relaxed. 532 event_mask &= ~RNBContext::event_darwin_log_data_available; 533 } 534 535 // We want to make sure we consume all process state changes and have 536 // whomever is notifying us to wait for us to reset the event bit before 537 // continuing. 538 // ctx.Events().SetResetAckMask (RNBContext::event_proc_state_changed); 539 540 DNBLogThreadedIf(LOG_RNB_EVENTS, 541 "%s ctx.Events().WaitForSetEvents(0x%08x) ...", 542 __FUNCTION__, event_mask); 543 nub_event_t set_events = ctx.Events().WaitForSetEvents(event_mask); 544 DNBLogThreadedIf(LOG_RNB_EVENTS, 545 "%s ctx.Events().WaitForSetEvents(0x%08x) => 0x%08x (%s)", 546 __FUNCTION__, event_mask, set_events, 547 ctx.EventsAsString(set_events, set_events_str)); 548 549 if (set_events) { 550 if ((set_events & RNBContext::event_proc_thread_exiting) || 551 (set_events & RNBContext::event_proc_stdio_available)) { 552 remote->FlushSTDIO(); 553 } 554 555 if (set_events & RNBContext::event_proc_profile_data) { 556 remote->SendAsyncProfileData(); 557 } 558 559 if (set_events & RNBContext::event_darwin_log_data_available) { 560 remote->SendAsyncDarwinLogData(); 561 } 562 563 if (set_events & RNBContext::event_read_packet_available) { 564 // handleReceivedPacket will take care of resetting the 565 // event_read_packet_available events when there are no more... 566 set_events ^= RNBContext::event_read_packet_available; 567 568 if (ctx.ProcessStateRunning()) { 569 if (remote->HandleAsyncPacket() == rnb_not_connected) { 570 // TODO: connect again? Exit? 571 } 572 } else { 573 if (remote->HandleReceivedPacket() == rnb_not_connected) { 574 // TODO: connect again? Exit? 575 } 576 } 577 } 578 579 if (set_events & RNBContext::event_proc_state_changed) { 580 mode = HandleProcessStateChange(remote, false); 581 ctx.Events().ResetEvents(RNBContext::event_proc_state_changed); 582 set_events ^= RNBContext::event_proc_state_changed; 583 } 584 585 if (set_events & RNBContext::event_proc_thread_exiting) { 586 DNBLog("debugserver's process monitoring thread has exited."); 587 mode = eRNBRunLoopModeExit; 588 } 589 590 if (set_events & RNBContext::event_read_thread_exiting) { 591 // Out remote packet receiving thread exited, exit for now. 592 DNBLog( 593 "debugserver's packet communication to lldb has been shut down."); 594 if (ctx.HasValidProcessID()) { 595 nub_process_t pid = ctx.ProcessID(); 596 // TODO: We should add code that will leave the current process 597 // in its current state and listen for another connection... 598 if (ctx.ProcessStateRunning()) { 599 if (ctx.GetDetachOnError()) { 600 DNBLog("debugserver has a valid PID %d, it is still running. " 601 "detaching from the inferior process.", 602 pid); 603 DNBProcessDetach(pid); 604 } else { 605 DNBLog("debugserver killing the inferior process, pid %d.", pid); 606 DNBProcessKill(pid); 607 } 608 } else { 609 if (ctx.GetDetachOnError()) { 610 DNBLog("debugserver has a valid PID %d but it may no longer " 611 "be running, detaching from the inferior process.", 612 pid); 613 DNBProcessDetach(pid); 614 } 615 } 616 } 617 mode = eRNBRunLoopModeExit; 618 } 619 } 620 621 // Reset all event bits that weren't reset for now... 622 if (set_events != 0) 623 ctx.Events().ResetEvents(set_events); 624 625 if (mode != eRNBRunLoopModeInferiorExecuting) 626 break; 627 } 628 629 return mode; 630 } 631 632 RNBRunLoopMode RNBRunLoopPlatform(RNBRemote *remote) { 633 RNBRunLoopMode mode = eRNBRunLoopModePlatformMode; 634 RNBContext &ctx = remote->Context(); 635 636 while (mode == eRNBRunLoopModePlatformMode) { 637 std::string set_events_str; 638 const uint32_t event_mask = RNBContext::event_read_packet_available | 639 RNBContext::event_read_thread_exiting; 640 641 DNBLogThreadedIf(LOG_RNB_EVENTS, 642 "%s ctx.Events().WaitForSetEvents(0x%08x) ...", 643 __FUNCTION__, event_mask); 644 nub_event_t set_events = ctx.Events().WaitForSetEvents(event_mask); 645 DNBLogThreadedIf(LOG_RNB_EVENTS, 646 "%s ctx.Events().WaitForSetEvents(0x%08x) => 0x%08x (%s)", 647 __FUNCTION__, event_mask, set_events, 648 ctx.EventsAsString(set_events, set_events_str)); 649 650 if (set_events) { 651 if (set_events & RNBContext::event_read_packet_available) { 652 if (remote->HandleReceivedPacket() == rnb_not_connected) 653 mode = eRNBRunLoopModeExit; 654 } 655 656 if (set_events & RNBContext::event_read_thread_exiting) { 657 mode = eRNBRunLoopModeExit; 658 } 659 ctx.Events().ResetEvents(set_events); 660 } 661 } 662 return eRNBRunLoopModeExit; 663 } 664 665 // Convenience function to set up the remote listening port 666 // Returns 1 for success 0 for failure. 667 668 static void PortWasBoundCallbackUnixSocket(const void *baton, in_port_t port) { 669 //::printf ("PortWasBoundCallbackUnixSocket (baton = %p, port = %u)\n", baton, 670 //port); 671 672 const char *unix_socket_name = (const char *)baton; 673 674 if (unix_socket_name && unix_socket_name[0]) { 675 // We were given a unix socket name to use to communicate the port 676 // that we ended up binding to back to our parent process 677 struct sockaddr_un saddr_un; 678 int s = ::socket(AF_UNIX, SOCK_STREAM, 0); 679 if (s < 0) { 680 perror("error: socket (AF_UNIX, SOCK_STREAM, 0)"); 681 exit(1); 682 } 683 684 saddr_un.sun_family = AF_UNIX; 685 ::strlcpy(saddr_un.sun_path, unix_socket_name, 686 sizeof(saddr_un.sun_path) - 1); 687 saddr_un.sun_path[sizeof(saddr_un.sun_path) - 1] = '\0'; 688 saddr_un.sun_len = SUN_LEN(&saddr_un); 689 690 if (::connect(s, (struct sockaddr *)&saddr_un, 691 static_cast<socklen_t>(SUN_LEN(&saddr_un))) < 0) { 692 perror("error: connect (socket, &saddr_un, saddr_un_len)"); 693 exit(1); 694 } 695 696 //::printf ("connect () sucess!!\n"); 697 698 // We were able to connect to the socket, now write our PID so whomever 699 // launched us will know this process's ID 700 RNBLogSTDOUT("Listening to port %i...\n", port); 701 702 char pid_str[64]; 703 const int pid_str_len = ::snprintf(pid_str, sizeof(pid_str), "%u", port); 704 const ssize_t bytes_sent = ::send(s, pid_str, pid_str_len, 0); 705 706 if (pid_str_len != bytes_sent) { 707 perror("error: send (s, pid_str, pid_str_len, 0)"); 708 exit(1); 709 } 710 711 //::printf ("send () sucess!!\n"); 712 713 // We are done with the socket 714 close(s); 715 } 716 } 717 718 static void PortWasBoundCallbackNamedPipe(const void *baton, uint16_t port) { 719 const char *named_pipe = (const char *)baton; 720 if (named_pipe && named_pipe[0]) { 721 int fd = ::open(named_pipe, O_WRONLY); 722 if (fd > -1) { 723 char port_str[64]; 724 const ssize_t port_str_len = 725 ::snprintf(port_str, sizeof(port_str), "%u", port); 726 // Write the port number as a C string with the NULL terminator 727 ::write(fd, port_str, port_str_len + 1); 728 close(fd); 729 } 730 } 731 } 732 733 static int ConnectRemote(RNBRemote *remote, const char *host, int port, 734 bool reverse_connect, const char *named_pipe_path, 735 const char *unix_socket_name) { 736 if (!remote->Comm().IsConnected()) { 737 if (reverse_connect) { 738 if (port == 0) { 739 DNBLogThreaded( 740 "error: invalid port supplied for reverse connection: %i.\n", port); 741 return 0; 742 } 743 if (remote->Comm().Connect(host, port) != rnb_success) { 744 DNBLogThreaded("Failed to reverse connect to %s:%i.\n", host, port); 745 return 0; 746 } 747 } else { 748 if (port != 0) 749 RNBLogSTDOUT("Listening to port %i for a connection from %s...\n", port, 750 host ? host : "127.0.0.1"); 751 if (unix_socket_name && unix_socket_name[0]) { 752 if (remote->Comm().Listen(host, port, PortWasBoundCallbackUnixSocket, 753 unix_socket_name) != rnb_success) { 754 RNBLogSTDERR("Failed to get connection from a remote gdb process.\n"); 755 return 0; 756 } 757 } else { 758 if (remote->Comm().Listen(host, port, PortWasBoundCallbackNamedPipe, 759 named_pipe_path) != rnb_success) { 760 RNBLogSTDERR("Failed to get connection from a remote gdb process.\n"); 761 return 0; 762 } 763 } 764 } 765 remote->StartReadRemoteDataThread(); 766 } 767 return 1; 768 } 769 770 // ASL Logging callback that can be registered with DNBLogSetLogCallback 771 void ASLLogCallback(void *baton, uint32_t flags, const char *format, 772 va_list args) { 773 if (format == NULL) 774 return; 775 static aslmsg g_aslmsg = NULL; 776 if (g_aslmsg == NULL) { 777 g_aslmsg = ::asl_new(ASL_TYPE_MSG); 778 char asl_key_sender[PATH_MAX]; 779 snprintf(asl_key_sender, sizeof(asl_key_sender), "com.apple.%s-%s", 780 DEBUGSERVER_PROGRAM_NAME, DEBUGSERVER_VERSION_STR); 781 ::asl_set(g_aslmsg, ASL_KEY_SENDER, asl_key_sender); 782 } 783 784 int asl_level; 785 if (flags & DNBLOG_FLAG_FATAL) 786 asl_level = ASL_LEVEL_CRIT; 787 else if (flags & DNBLOG_FLAG_ERROR) 788 asl_level = ASL_LEVEL_ERR; 789 else if (flags & DNBLOG_FLAG_WARNING) 790 asl_level = ASL_LEVEL_WARNING; 791 else if (flags & DNBLOG_FLAG_VERBOSE) 792 asl_level = ASL_LEVEL_WARNING; // ASL_LEVEL_INFO; 793 else 794 asl_level = ASL_LEVEL_WARNING; // ASL_LEVEL_DEBUG; 795 796 ::asl_vlog(NULL, g_aslmsg, asl_level, format, args); 797 } 798 799 // FILE based Logging callback that can be registered with 800 // DNBLogSetLogCallback 801 void FileLogCallback(void *baton, uint32_t flags, const char *format, 802 va_list args) { 803 if (baton == NULL || format == NULL) 804 return; 805 806 ::vfprintf((FILE *)baton, format, args); 807 ::fprintf((FILE *)baton, "\n"); 808 ::fflush((FILE *)baton); 809 } 810 811 void show_version_and_exit(int exit_code) { 812 printf("%s-%s for %s.\n", DEBUGSERVER_PROGRAM_NAME, DEBUGSERVER_VERSION_STR, 813 RNB_ARCH); 814 exit(exit_code); 815 } 816 817 void show_usage_and_exit(int exit_code) { 818 RNBLogSTDERR( 819 "Usage:\n %s host:port [program-name program-arg1 program-arg2 ...]\n", 820 DEBUGSERVER_PROGRAM_NAME); 821 RNBLogSTDERR(" %s /path/file [program-name program-arg1 program-arg2 ...]\n", 822 DEBUGSERVER_PROGRAM_NAME); 823 RNBLogSTDERR(" %s host:port --attach=<pid>\n", DEBUGSERVER_PROGRAM_NAME); 824 RNBLogSTDERR(" %s /path/file --attach=<pid>\n", DEBUGSERVER_PROGRAM_NAME); 825 RNBLogSTDERR(" %s host:port --attach=<process_name>\n", 826 DEBUGSERVER_PROGRAM_NAME); 827 RNBLogSTDERR(" %s /path/file --attach=<process_name>\n", 828 DEBUGSERVER_PROGRAM_NAME); 829 exit(exit_code); 830 } 831 832 // option descriptors for getopt_long_only() 833 static struct option g_long_options[] = { 834 {"attach", required_argument, NULL, 'a'}, 835 {"arch", required_argument, NULL, 'A'}, 836 {"debug", no_argument, NULL, 'g'}, 837 {"kill-on-error", no_argument, NULL, 'K'}, 838 {"verbose", no_argument, NULL, 'v'}, 839 {"version", no_argument, NULL, 'V'}, 840 {"lockdown", no_argument, &g_lockdown_opt, 1}, // short option "-k" 841 {"applist", no_argument, &g_applist_opt, 1}, // short option "-t" 842 {"log-file", required_argument, NULL, 'l'}, 843 {"log-flags", required_argument, NULL, 'f'}, 844 {"launch", required_argument, NULL, 'x'}, // Valid values are "auto", 845 // "posix-spawn", "fork-exec", 846 // "springboard" (arm only) 847 {"waitfor", required_argument, NULL, 848 'w'}, // Wait for a process whose name starts with ARG 849 {"waitfor-interval", required_argument, NULL, 850 'i'}, // Time in usecs to wait between sampling the pid list when waiting 851 // for a process by name 852 {"waitfor-duration", required_argument, NULL, 853 'd'}, // The time in seconds to wait for a process to show up by name 854 {"native-regs", no_argument, NULL, 'r'}, // Specify to use the native 855 // registers instead of the gdb 856 // defaults for the architecture. 857 {"stdio-path", required_argument, NULL, 858 's'}, // Set the STDIO path to be used when launching applications (STDIN, 859 // STDOUT and STDERR) (only if debugserver launches the process) 860 {"stdin-path", required_argument, NULL, 861 'I'}, // Set the STDIN path to be used when launching applications (only if 862 // debugserver launches the process) 863 {"stdout-path", required_argument, NULL, 864 'O'}, // Set the STDOUT path to be used when launching applications (only 865 // if debugserver launches the process) 866 {"stderr-path", required_argument, NULL, 867 'E'}, // Set the STDERR path to be used when launching applications (only 868 // if debugserver launches the process) 869 {"no-stdio", no_argument, NULL, 870 'n'}, // Do not set up any stdio (perhaps the program is a GUI program) 871 // (only if debugserver launches the process) 872 {"setsid", no_argument, NULL, 873 'S'}, // call setsid() to make debugserver run in its own session 874 {"disable-aslr", no_argument, NULL, 'D'}, // Use _POSIX_SPAWN_DISABLE_ASLR 875 // to avoid shared library 876 // randomization 877 {"working-dir", required_argument, NULL, 878 'W'}, // The working directory that the inferior process should have (only 879 // if debugserver launches the process) 880 {"platform", required_argument, NULL, 881 'p'}, // Put this executable into a remote platform mode 882 {"unix-socket", required_argument, NULL, 883 'u'}, // If we need to handshake with our parent process, an option will be 884 // passed down that specifies a unix socket name to use 885 {"fd", required_argument, NULL, 886 '2'}, // A file descriptor was passed to this process when spawned that 887 // is already open and ready for communication 888 {"named-pipe", required_argument, NULL, 'P'}, 889 {"reverse-connect", no_argument, NULL, 'R'}, 890 {"env", required_argument, NULL, 891 'e'}, // When debugserver launches the process, set a single environment 892 // entry as specified by the option value ("./debugserver -e FOO=1 -e 893 // BAR=2 localhost:1234 -- /bin/ls") 894 {"forward-env", no_argument, NULL, 895 'F'}, // When debugserver launches the process, forward debugserver's 896 // current environment variables to the child process ("./debugserver 897 // -F localhost:1234 -- /bin/ls" 898 {"unmask-signals", no_argument, NULL, 899 'U'}, // debugserver will ignore EXC_MASK_BAD_ACCESS, 900 // EXC_MASK_BAD_INSTRUCTION and EXC_MASK_ARITHMETIC, which results in 901 // SIGSEGV, SIGILL and SIGFPE being propagated to the target process. 902 {NULL, 0, NULL, 0}}; 903 904 int communication_fd = -1; 905 906 // main 907 int main(int argc, char *argv[]) { 908 // If debugserver is launched with DYLD_INSERT_LIBRARIES, unset it so we 909 // don't spawn child processes with this enabled. 910 unsetenv("DYLD_INSERT_LIBRARIES"); 911 912 const char *argv_sub_zero = 913 argv[0]; // save a copy of argv[0] for error reporting post-launch 914 915 #if defined(__APPLE__) 916 pthread_setname_np("main thread"); 917 #if defined(__arm__) || defined(__arm64__) || defined(__aarch64__) 918 struct sched_param thread_param; 919 int thread_sched_policy; 920 if (pthread_getschedparam(pthread_self(), &thread_sched_policy, 921 &thread_param) == 0) { 922 thread_param.sched_priority = 47; 923 pthread_setschedparam(pthread_self(), thread_sched_policy, &thread_param); 924 } 925 926 ::proc_set_wakemon_params( 927 getpid(), 500, 928 0); // Allow up to 500 wakeups/sec to avoid EXC_RESOURCE for normal use. 929 #endif 930 #endif 931 932 g_isatty = ::isatty(STDIN_FILENO); 933 934 // ::printf ("uid=%u euid=%u gid=%u egid=%u\n", 935 // getuid(), 936 // geteuid(), 937 // getgid(), 938 // getegid()); 939 940 // signal (SIGINT, signal_handler); 941 signal(SIGPIPE, signal_handler); 942 signal(SIGHUP, signal_handler); 943 944 // We're always sitting in waitpid or kevent waiting on our target process' 945 // death, 946 // we don't need no stinking SIGCHLD's... 947 948 sigset_t sigset; 949 sigemptyset(&sigset); 950 sigaddset(&sigset, SIGCHLD); 951 sigprocmask(SIG_BLOCK, &sigset, NULL); 952 953 g_remoteSP = std::make_shared<RNBRemote>(); 954 955 RNBRemote *remote = g_remoteSP.get(); 956 if (remote == NULL) { 957 RNBLogSTDERR("error: failed to create a remote connection class\n"); 958 return -1; 959 } 960 961 RNBContext &ctx = remote->Context(); 962 963 int i; 964 int attach_pid = INVALID_NUB_PROCESS; 965 966 FILE *log_file = NULL; 967 uint32_t log_flags = 0; 968 // Parse our options 969 int ch; 970 int long_option_index = 0; 971 int debug = 0; 972 std::string compile_options; 973 std::string waitfor_pid_name; // Wait for a process that starts with this name 974 std::string attach_pid_name; 975 std::string arch_name; 976 std::string working_dir; // The new working directory to use for the inferior 977 std::string unix_socket_name; // If we need to handshake with our parent 978 // process, an option will be passed down that 979 // specifies a unix socket name to use 980 std::string named_pipe_path; // If we need to handshake with our parent 981 // process, an option will be passed down that 982 // specifies a named pipe to use 983 useconds_t waitfor_interval = 1000; // Time in usecs between process lists 984 // polls when waiting for a process by 985 // name, default 1 msec. 986 useconds_t waitfor_duration = 987 0; // Time in seconds to wait for a process by name, 0 means wait forever. 988 bool no_stdio = false; 989 bool reverse_connect = false; // Set to true by an option to indicate we 990 // should reverse connect to the host:port 991 // supplied as the first debugserver argument 992 993 #if !defined(DNBLOG_ENABLED) 994 compile_options += "(no-logging) "; 995 #endif 996 997 RNBRunLoopMode start_mode = eRNBRunLoopModeExit; 998 999 char short_options[512]; 1000 uint32_t short_options_idx = 0; 1001 1002 // Handle the two case that don't have short options in g_long_options 1003 short_options[short_options_idx++] = 'k'; 1004 short_options[short_options_idx++] = 't'; 1005 1006 for (i = 0; g_long_options[i].name != NULL; ++i) { 1007 if (isalpha(g_long_options[i].val)) { 1008 short_options[short_options_idx++] = g_long_options[i].val; 1009 switch (g_long_options[i].has_arg) { 1010 default: 1011 case no_argument: 1012 break; 1013 1014 case optional_argument: 1015 short_options[short_options_idx++] = ':'; 1016 short_options[short_options_idx++] = ':'; 1017 break; 1018 case required_argument: 1019 short_options[short_options_idx++] = ':'; 1020 break; 1021 } 1022 } 1023 } 1024 // NULL terminate the short option string. 1025 short_options[short_options_idx++] = '\0'; 1026 1027 #if __GLIBC__ 1028 optind = 0; 1029 #else 1030 optreset = 1; 1031 optind = 1; 1032 #endif 1033 1034 bool forward_env = false; 1035 while ((ch = getopt_long_only(argc, argv, short_options, g_long_options, 1036 &long_option_index)) != -1) { 1037 DNBLogDebug("option: ch == %c (0x%2.2x) --%s%c%s\n", ch, (uint8_t)ch, 1038 g_long_options[long_option_index].name, 1039 g_long_options[long_option_index].has_arg ? '=' : ' ', 1040 optarg ? optarg : ""); 1041 switch (ch) { 1042 case 0: // Any optional that auto set themselves will return 0 1043 break; 1044 1045 case 'A': 1046 if (optarg && optarg[0]) 1047 arch_name.assign(optarg); 1048 break; 1049 1050 case 'a': 1051 if (optarg && optarg[0]) { 1052 if (isdigit(optarg[0])) { 1053 char *end = NULL; 1054 attach_pid = static_cast<int>(strtoul(optarg, &end, 0)); 1055 if (end == NULL || *end != '\0') { 1056 RNBLogSTDERR("error: invalid pid option '%s'\n", optarg); 1057 exit(4); 1058 } 1059 } else { 1060 attach_pid_name = optarg; 1061 } 1062 start_mode = eRNBRunLoopModeInferiorAttaching; 1063 } 1064 break; 1065 1066 // --waitfor=NAME 1067 case 'w': 1068 if (optarg && optarg[0]) { 1069 waitfor_pid_name = optarg; 1070 start_mode = eRNBRunLoopModeInferiorAttaching; 1071 } 1072 break; 1073 1074 // --waitfor-interval=USEC 1075 case 'i': 1076 if (optarg && optarg[0]) { 1077 char *end = NULL; 1078 waitfor_interval = static_cast<useconds_t>(strtoul(optarg, &end, 0)); 1079 if (end == NULL || *end != '\0') { 1080 RNBLogSTDERR("error: invalid waitfor-interval option value '%s'.\n", 1081 optarg); 1082 exit(6); 1083 } 1084 } 1085 break; 1086 1087 // --waitfor-duration=SEC 1088 case 'd': 1089 if (optarg && optarg[0]) { 1090 char *end = NULL; 1091 waitfor_duration = static_cast<useconds_t>(strtoul(optarg, &end, 0)); 1092 if (end == NULL || *end != '\0') { 1093 RNBLogSTDERR("error: invalid waitfor-duration option value '%s'.\n", 1094 optarg); 1095 exit(7); 1096 } 1097 } 1098 break; 1099 1100 case 'K': 1101 g_detach_on_error = false; 1102 break; 1103 case 'W': 1104 if (optarg && optarg[0]) 1105 working_dir.assign(optarg); 1106 break; 1107 1108 case 'x': 1109 if (optarg && optarg[0]) { 1110 if (strcasecmp(optarg, "auto") == 0) 1111 g_launch_flavor = eLaunchFlavorDefault; 1112 else if (strcasestr(optarg, "posix") == optarg) { 1113 DNBLog( 1114 "[LaunchAttach] launch flavor is posix_spawn via cmdline option"); 1115 g_launch_flavor = eLaunchFlavorPosixSpawn; 1116 } else if (strcasestr(optarg, "fork") == optarg) 1117 g_launch_flavor = eLaunchFlavorForkExec; 1118 #ifdef WITH_SPRINGBOARD 1119 else if (strcasestr(optarg, "spring") == optarg) { 1120 DNBLog( 1121 "[LaunchAttach] launch flavor is SpringBoard via cmdline option"); 1122 g_launch_flavor = eLaunchFlavorSpringBoard; 1123 } 1124 #endif 1125 #ifdef WITH_BKS 1126 else if (strcasestr(optarg, "backboard") == optarg) { 1127 DNBLog("[LaunchAttach] launch flavor is BKS via cmdline option"); 1128 g_launch_flavor = eLaunchFlavorBKS; 1129 } 1130 #endif 1131 #ifdef WITH_FBS 1132 else if (strcasestr(optarg, "frontboard") == optarg) { 1133 DNBLog("[LaunchAttach] launch flavor is FBS via cmdline option"); 1134 g_launch_flavor = eLaunchFlavorFBS; 1135 } 1136 #endif 1137 1138 else { 1139 RNBLogSTDERR("error: invalid TYPE for the --launch=TYPE (-x TYPE) " 1140 "option: '%s'\n", 1141 optarg); 1142 RNBLogSTDERR("Valid values TYPE are:\n"); 1143 RNBLogSTDERR( 1144 " auto Auto-detect the best launch method to use.\n"); 1145 RNBLogSTDERR( 1146 " posix Launch the executable using posix_spawn.\n"); 1147 RNBLogSTDERR( 1148 " fork Launch the executable using fork and exec.\n"); 1149 #ifdef WITH_SPRINGBOARD 1150 RNBLogSTDERR( 1151 " spring Launch the executable through Springboard.\n"); 1152 #endif 1153 #ifdef WITH_BKS 1154 RNBLogSTDERR(" backboard Launch the executable through BackBoard " 1155 "Services.\n"); 1156 #endif 1157 #ifdef WITH_FBS 1158 RNBLogSTDERR(" frontboard Launch the executable through FrontBoard " 1159 "Services.\n"); 1160 #endif 1161 exit(5); 1162 } 1163 } 1164 break; 1165 1166 case 'l': // Set Log File 1167 if (optarg && optarg[0]) { 1168 if (strcasecmp(optarg, "stdout") == 0) 1169 log_file = stdout; 1170 else if (strcasecmp(optarg, "stderr") == 0) 1171 log_file = stderr; 1172 else { 1173 log_file = fopen(optarg, "w"); 1174 if (log_file != NULL) 1175 setlinebuf(log_file); 1176 } 1177 1178 if (log_file == NULL) { 1179 const char *errno_str = strerror(errno); 1180 RNBLogSTDERR( 1181 "Failed to open log file '%s' for writing: errno = %i (%s)", 1182 optarg, errno, errno_str ? errno_str : "unknown error"); 1183 } 1184 } 1185 break; 1186 1187 case 'f': // Log Flags 1188 if (optarg && optarg[0]) 1189 log_flags = static_cast<uint32_t>(strtoul(optarg, NULL, 0)); 1190 break; 1191 1192 case 'g': 1193 debug = 1; 1194 DNBLogSetDebug(debug); 1195 break; 1196 1197 case 't': 1198 g_applist_opt = 1; 1199 break; 1200 1201 case 'k': 1202 g_lockdown_opt = 1; 1203 break; 1204 1205 case 'r': 1206 // Do nothing, native regs is the default these days 1207 break; 1208 1209 case 'R': 1210 reverse_connect = true; 1211 break; 1212 case 'v': 1213 DNBLogSetVerbose(1); 1214 break; 1215 1216 case 'V': 1217 show_version_and_exit(0); 1218 break; 1219 1220 case 's': 1221 ctx.GetSTDIN().assign(optarg); 1222 ctx.GetSTDOUT().assign(optarg); 1223 ctx.GetSTDERR().assign(optarg); 1224 break; 1225 1226 case 'I': 1227 ctx.GetSTDIN().assign(optarg); 1228 break; 1229 1230 case 'O': 1231 ctx.GetSTDOUT().assign(optarg); 1232 break; 1233 1234 case 'E': 1235 ctx.GetSTDERR().assign(optarg); 1236 break; 1237 1238 case 'n': 1239 no_stdio = true; 1240 break; 1241 1242 case 'S': 1243 // Put debugserver into a new session. Terminals group processes 1244 // into sessions and when a special terminal key sequences 1245 // (like control+c) are typed they can cause signals to go out to 1246 // all processes in a session. Using this --setsid (-S) option 1247 // will cause debugserver to run in its own sessions and be free 1248 // from such issues. 1249 // 1250 // This is useful when debugserver is spawned from a command 1251 // line application that uses debugserver to do the debugging, 1252 // yet that application doesn't want debugserver receiving the 1253 // signals sent to the session (i.e. dying when anyone hits ^C). 1254 setsid(); 1255 break; 1256 case 'D': 1257 g_disable_aslr = 1; 1258 break; 1259 1260 case 'p': 1261 start_mode = eRNBRunLoopModePlatformMode; 1262 break; 1263 1264 case 'u': 1265 unix_socket_name.assign(optarg); 1266 break; 1267 1268 case 'P': 1269 named_pipe_path.assign(optarg); 1270 break; 1271 1272 case 'e': 1273 // Pass a single specified environment variable down to the process that 1274 // gets launched 1275 remote->Context().PushEnvironment(optarg); 1276 break; 1277 1278 case 'F': 1279 forward_env = true; 1280 break; 1281 1282 case 'U': 1283 ctx.SetUnmaskSignals(true); 1284 break; 1285 1286 case '2': 1287 // File descriptor passed to this process during fork/exec and is already 1288 // open and ready for communication. 1289 communication_fd = atoi(optarg); 1290 break; 1291 } 1292 } 1293 1294 if (arch_name.empty()) { 1295 #if defined(__arm__) 1296 arch_name.assign("arm"); 1297 #endif 1298 } else { 1299 DNBSetArchitecture(arch_name.c_str()); 1300 } 1301 1302 // if (arch_name.empty()) 1303 // { 1304 // fprintf(stderr, "error: no architecture was specified\n"); 1305 // exit (8); 1306 // } 1307 // Skip any options we consumed with getopt_long_only 1308 argc -= optind; 1309 argv += optind; 1310 1311 if (!working_dir.empty()) { 1312 if (remote->Context().SetWorkingDirectory(working_dir.c_str()) == false) { 1313 RNBLogSTDERR("error: working directory doesn't exist '%s'.\n", 1314 working_dir.c_str()); 1315 exit(8); 1316 } 1317 } 1318 1319 remote->Context().SetDetachOnError(g_detach_on_error); 1320 1321 remote->Initialize(); 1322 1323 // It is ok for us to set NULL as the logfile (this will disable any logging) 1324 1325 if (log_file != NULL) { 1326 DNBLogSetLogCallback(FileLogCallback, log_file); 1327 // If our log file was set, yet we have no log flags, log everything! 1328 if (log_flags == 0) 1329 log_flags = LOG_ALL | LOG_RNB_ALL; 1330 1331 DNBLogSetLogMask(log_flags); 1332 } else { 1333 // Enable DNB logging 1334 1335 // if os_log() support is available, log through that. 1336 auto log_callback = OsLogger::GetLogFunction(); 1337 if (log_callback) { 1338 DNBLogSetLogCallback(log_callback, nullptr); 1339 DNBLog("debugserver will use os_log for internal logging."); 1340 } else { 1341 // Fall back to ASL support. 1342 DNBLogSetLogCallback(ASLLogCallback, NULL); 1343 DNBLog("debugserver will use ASL for internal logging."); 1344 } 1345 DNBLogSetLogMask(log_flags); 1346 } 1347 1348 if (DNBLogEnabled()) { 1349 for (i = 0; i < argc; i++) 1350 DNBLogDebug("argv[%i] = %s", i, argv[i]); 1351 } 1352 1353 // as long as we're dropping remotenub in as a replacement for gdbserver, 1354 // explicitly note that this is not gdbserver. 1355 1356 RNBLogSTDOUT("%s-%s %sfor %s.\n", DEBUGSERVER_PROGRAM_NAME, 1357 DEBUGSERVER_VERSION_STR, compile_options.c_str(), RNB_ARCH); 1358 1359 std::string host; 1360 int port = INT32_MAX; 1361 char str[PATH_MAX]; 1362 str[0] = '\0'; 1363 1364 if (g_lockdown_opt == 0 && g_applist_opt == 0 && communication_fd == -1) { 1365 // Make sure we at least have port 1366 if (argc < 1) { 1367 show_usage_and_exit(1); 1368 } 1369 // accept 'localhost:' prefix on port number 1370 std::string host_specifier = argv[0]; 1371 auto colon_location = host_specifier.rfind(':'); 1372 if (colon_location != std::string::npos) { 1373 host = host_specifier.substr(0, colon_location); 1374 std::string port_str = 1375 host_specifier.substr(colon_location + 1, std::string::npos); 1376 char *end_ptr; 1377 port = strtoul(port_str.c_str(), &end_ptr, 0); 1378 if (end_ptr < port_str.c_str() + port_str.size()) 1379 show_usage_and_exit(2); 1380 if (host.front() == '[' && host.back() == ']') 1381 host = host.substr(1, host.size() - 2); 1382 DNBLogDebug("host = '%s' port = %i", host.c_str(), port); 1383 } else { 1384 // No hostname means "localhost" 1385 int items_scanned = ::sscanf(argv[0], "%i", &port); 1386 if (items_scanned == 1) { 1387 host = "127.0.0.1"; 1388 DNBLogDebug("host = '%s' port = %i", host.c_str(), port); 1389 } else if (argv[0][0] == '/') { 1390 port = INT32_MAX; 1391 strlcpy(str, argv[0], sizeof(str)); 1392 } else { 1393 show_usage_and_exit(2); 1394 } 1395 } 1396 1397 // We just used the 'host:port' or the '/path/file' arg... 1398 argc--; 1399 argv++; 1400 } 1401 1402 // If we know we're waiting to attach, we don't need any of this other info. 1403 if (start_mode != eRNBRunLoopModeInferiorAttaching && 1404 start_mode != eRNBRunLoopModePlatformMode) { 1405 if (argc == 0 || g_lockdown_opt) { 1406 if (g_lockdown_opt != 0) { 1407 // Work around for SIGPIPE crashes due to posix_spawn issue. 1408 // We have to close STDOUT and STDERR, else the first time we 1409 // try and do any, we get SIGPIPE and die as posix_spawn is 1410 // doing bad things with our file descriptors at the moment. 1411 int null = open("/dev/null", O_RDWR); 1412 dup2(null, STDOUT_FILENO); 1413 dup2(null, STDERR_FILENO); 1414 } else if (g_applist_opt != 0) { 1415 DNBLog("debugserver running in --applist mode"); 1416 // List all applications we are able to see 1417 std::string applist_plist; 1418 int err = ListApplications(applist_plist, false, false); 1419 if (err == 0) { 1420 fputs(applist_plist.c_str(), stdout); 1421 } else { 1422 RNBLogSTDERR("error: ListApplications returned error %i\n", err); 1423 } 1424 // Exit with appropriate error if we were asked to list the applications 1425 // with no other args were given (and we weren't trying to do this over 1426 // lockdown) 1427 return err; 1428 } 1429 1430 DNBLogDebug("Get args from remote protocol..."); 1431 start_mode = eRNBRunLoopModeGetStartModeFromRemoteProtocol; 1432 } else { 1433 start_mode = eRNBRunLoopModeInferiorLaunching; 1434 // Fill in the argv array in the context from the rest of our args. 1435 // Skip the name of this executable and the port number 1436 for (int i = 0; i < argc; i++) { 1437 DNBLogDebug("inferior_argv[%i] = '%s'", i, argv[i]); 1438 ctx.PushArgument(argv[i]); 1439 } 1440 } 1441 } 1442 1443 if (start_mode == eRNBRunLoopModeExit) 1444 return -1; 1445 1446 if (forward_env || start_mode == eRNBRunLoopModeInferiorLaunching) { 1447 // Pass the current environment down to the process that gets launched 1448 // This happens automatically in the "launching" mode. For the rest, we 1449 // only do that if the user explicitly requested this via --forward-env 1450 // argument. 1451 char **host_env = *_NSGetEnviron(); 1452 char *env_entry; 1453 size_t i; 1454 for (i = 0; (env_entry = host_env[i]) != NULL; ++i) 1455 remote->Context().PushEnvironmentIfNeeded(env_entry); 1456 } 1457 1458 RNBRunLoopMode mode = start_mode; 1459 char err_str[1024] = {'\0'}; 1460 1461 while (mode != eRNBRunLoopModeExit) { 1462 switch (mode) { 1463 case eRNBRunLoopModeGetStartModeFromRemoteProtocol: 1464 #ifdef WITH_LOCKDOWN 1465 if (g_lockdown_opt) { 1466 if (!remote->Comm().IsConnected()) { 1467 if (remote->Comm().ConnectToService() != rnb_success) { 1468 RNBLogSTDERR( 1469 "Failed to get connection from a remote gdb process.\n"); 1470 mode = eRNBRunLoopModeExit; 1471 } else if (g_applist_opt != 0) { 1472 // List all applications we are able to see 1473 DNBLog("debugserver running in applist mode under lockdown"); 1474 std::string applist_plist; 1475 if (ListApplications(applist_plist, false, false) == 0) { 1476 DNBLogDebug("Task list: %s", applist_plist.c_str()); 1477 1478 remote->Comm().Write(applist_plist.c_str(), applist_plist.size()); 1479 // Issue a read that will never yield any data until the other 1480 // side 1481 // closes the socket so this process doesn't just exit and cause 1482 // the 1483 // socket to close prematurely on the other end and cause data 1484 // loss. 1485 std::string buf; 1486 remote->Comm().Read(buf); 1487 } 1488 remote->Comm().Disconnect(false); 1489 mode = eRNBRunLoopModeExit; 1490 break; 1491 } else { 1492 // Start watching for remote packets 1493 remote->StartReadRemoteDataThread(); 1494 } 1495 } 1496 } else 1497 #endif 1498 if (port != INT32_MAX) { 1499 if (!ConnectRemote(remote, host.c_str(), port, reverse_connect, 1500 named_pipe_path.c_str(), unix_socket_name.c_str())) 1501 mode = eRNBRunLoopModeExit; 1502 } else if (str[0] == '/') { 1503 if (remote->Comm().OpenFile(str)) 1504 mode = eRNBRunLoopModeExit; 1505 } else if (communication_fd >= 0) { 1506 // We were passed a file descriptor to use during fork/exec that is 1507 // already open 1508 // in our process, so lets just use it! 1509 if (remote->Comm().useFD(communication_fd)) 1510 mode = eRNBRunLoopModeExit; 1511 else 1512 remote->StartReadRemoteDataThread(); 1513 } 1514 1515 if (mode != eRNBRunLoopModeExit) { 1516 RNBLogSTDOUT("Got a connection, waiting for process information for " 1517 "launching or attaching.\n"); 1518 1519 mode = RNBRunLoopGetStartModeFromRemote(remote); 1520 } 1521 break; 1522 1523 case eRNBRunLoopModeInferiorAttaching: 1524 if (!waitfor_pid_name.empty()) { 1525 // Set our end wait time if we are using a waitfor-duration 1526 // option that may have been specified 1527 struct timespec attach_timeout_abstime, *timeout_ptr = NULL; 1528 if (waitfor_duration != 0) { 1529 DNBTimer::OffsetTimeOfDay(&attach_timeout_abstime, waitfor_duration, 1530 0); 1531 timeout_ptr = &attach_timeout_abstime; 1532 } 1533 nub_launch_flavor_t launch_flavor = g_launch_flavor; 1534 if (launch_flavor == eLaunchFlavorDefault) 1535 launch_flavor = default_launch_flavor(waitfor_pid_name.c_str()); 1536 1537 ctx.SetLaunchFlavor(launch_flavor); 1538 bool ignore_existing = false; 1539 RNBLogSTDOUT("Waiting to attach to process %s...\n", 1540 waitfor_pid_name.c_str()); 1541 nub_process_t pid = DNBProcessAttachWait( 1542 &ctx, waitfor_pid_name.c_str(), ignore_existing, timeout_ptr, 1543 waitfor_interval, err_str, sizeof(err_str)); 1544 g_pid = pid; 1545 1546 if (pid == INVALID_NUB_PROCESS) { 1547 ctx.LaunchStatus().SetError(-1, DNBError::Generic); 1548 if (err_str[0]) 1549 ctx.LaunchStatus().SetErrorString(err_str); 1550 RNBLogSTDERR("error: failed to attach to process named: \"%s\" %s\n", 1551 waitfor_pid_name.c_str(), err_str); 1552 mode = eRNBRunLoopModeExit; 1553 } else { 1554 ctx.SetProcessID(pid); 1555 mode = eRNBRunLoopModeInferiorExecuting; 1556 } 1557 } else if (attach_pid != INVALID_NUB_PROCESS) { 1558 1559 RNBLogSTDOUT("Attaching to process %i...\n", attach_pid); 1560 nub_process_t attached_pid; 1561 mode = RNBRunLoopLaunchAttaching(remote, attach_pid, attached_pid); 1562 if (mode != eRNBRunLoopModeInferiorExecuting) { 1563 const char *error_str = remote->Context().LaunchStatus().AsString(); 1564 RNBLogSTDERR("error: failed to attach process %i: %s\n", attach_pid, 1565 error_str ? error_str : "unknown error."); 1566 mode = eRNBRunLoopModeExit; 1567 } 1568 } else if (!attach_pid_name.empty()) { 1569 struct timespec attach_timeout_abstime, *timeout_ptr = NULL; 1570 if (waitfor_duration != 0) { 1571 DNBTimer::OffsetTimeOfDay(&attach_timeout_abstime, waitfor_duration, 1572 0); 1573 timeout_ptr = &attach_timeout_abstime; 1574 } 1575 1576 RNBLogSTDOUT("Attaching to process %s...\n", attach_pid_name.c_str()); 1577 nub_process_t pid = DNBProcessAttachByName( 1578 attach_pid_name.c_str(), timeout_ptr, ctx.GetUnmaskSignals(), 1579 err_str, sizeof(err_str)); 1580 g_pid = pid; 1581 if (pid == INVALID_NUB_PROCESS) { 1582 ctx.LaunchStatus().SetError(-1, DNBError::Generic); 1583 if (err_str[0]) 1584 ctx.LaunchStatus().SetErrorString(err_str); 1585 RNBLogSTDERR("error: failed to attach to process named: \"%s\" %s\n", 1586 waitfor_pid_name.c_str(), err_str); 1587 mode = eRNBRunLoopModeExit; 1588 } else { 1589 ctx.SetProcessID(pid); 1590 mode = eRNBRunLoopModeInferiorExecuting; 1591 } 1592 1593 } else { 1594 RNBLogSTDERR( 1595 "error: asked to attach with empty name and invalid PID.\n"); 1596 mode = eRNBRunLoopModeExit; 1597 } 1598 1599 if (mode != eRNBRunLoopModeExit) { 1600 if (port != INT32_MAX) { 1601 if (!ConnectRemote(remote, host.c_str(), port, reverse_connect, 1602 named_pipe_path.c_str(), unix_socket_name.c_str())) 1603 mode = eRNBRunLoopModeExit; 1604 } else if (str[0] == '/') { 1605 if (remote->Comm().OpenFile(str)) 1606 mode = eRNBRunLoopModeExit; 1607 } else if (communication_fd >= 0) { 1608 // We were passed a file descriptor to use during fork/exec that is 1609 // already open 1610 // in our process, so lets just use it! 1611 if (remote->Comm().useFD(communication_fd)) 1612 mode = eRNBRunLoopModeExit; 1613 else 1614 remote->StartReadRemoteDataThread(); 1615 } 1616 1617 if (mode != eRNBRunLoopModeExit) 1618 RNBLogSTDOUT("Waiting for debugger instructions for process %d.\n", 1619 attach_pid); 1620 } 1621 break; 1622 1623 case eRNBRunLoopModeInferiorLaunching: { 1624 mode = RNBRunLoopLaunchInferior(remote, ctx.GetSTDINPath(), 1625 ctx.GetSTDOUTPath(), ctx.GetSTDERRPath(), 1626 no_stdio); 1627 1628 if (mode == eRNBRunLoopModeInferiorExecuting) { 1629 if (port != INT32_MAX) { 1630 if (!ConnectRemote(remote, host.c_str(), port, reverse_connect, 1631 named_pipe_path.c_str(), unix_socket_name.c_str())) 1632 mode = eRNBRunLoopModeExit; 1633 } else if (str[0] == '/') { 1634 if (remote->Comm().OpenFile(str)) 1635 mode = eRNBRunLoopModeExit; 1636 } else if (communication_fd >= 0) { 1637 // We were passed a file descriptor to use during fork/exec that is 1638 // already open 1639 // in our process, so lets just use it! 1640 if (remote->Comm().useFD(communication_fd)) 1641 mode = eRNBRunLoopModeExit; 1642 else 1643 remote->StartReadRemoteDataThread(); 1644 } 1645 1646 if (mode != eRNBRunLoopModeExit) { 1647 const char *proc_name = "<unknown>"; 1648 if (ctx.ArgumentCount() > 0) 1649 proc_name = ctx.ArgumentAtIndex(0); 1650 DNBLog("[LaunchAttach] Successfully launched %s (pid = %d).\n", 1651 proc_name, ctx.ProcessID()); 1652 RNBLogSTDOUT("Got a connection, launched process %s (pid = %d).\n", 1653 proc_name, ctx.ProcessID()); 1654 } 1655 } else { 1656 const char *error_str = remote->Context().LaunchStatus().AsString(); 1657 RNBLogSTDERR("error: failed to launch process %s: %s\n", argv_sub_zero, 1658 error_str ? error_str : "unknown error."); 1659 } 1660 } break; 1661 1662 case eRNBRunLoopModeInferiorExecuting: 1663 mode = RNBRunLoopInferiorExecuting(remote); 1664 break; 1665 1666 case eRNBRunLoopModePlatformMode: 1667 if (port != INT32_MAX) { 1668 if (!ConnectRemote(remote, host.c_str(), port, reverse_connect, 1669 named_pipe_path.c_str(), unix_socket_name.c_str())) 1670 mode = eRNBRunLoopModeExit; 1671 } else if (str[0] == '/') { 1672 if (remote->Comm().OpenFile(str)) 1673 mode = eRNBRunLoopModeExit; 1674 } else if (communication_fd >= 0) { 1675 // We were passed a file descriptor to use during fork/exec that is 1676 // already open 1677 // in our process, so lets just use it! 1678 if (remote->Comm().useFD(communication_fd)) 1679 mode = eRNBRunLoopModeExit; 1680 else 1681 remote->StartReadRemoteDataThread(); 1682 } 1683 1684 if (mode != eRNBRunLoopModeExit) 1685 mode = RNBRunLoopPlatform(remote); 1686 break; 1687 1688 default: 1689 mode = eRNBRunLoopModeExit; 1690 break; 1691 case eRNBRunLoopModeExit: 1692 break; 1693 } 1694 } 1695 1696 remote->StopReadRemoteDataThread(); 1697 remote->Context().SetProcessID(INVALID_NUB_PROCESS); 1698 RNBLogSTDOUT("Exiting.\n"); 1699 1700 return 0; 1701 } 1702