1 //===-- DNB.cpp -------------------------------------------------*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // Created by Greg Clayton on 3/23/07. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #include "DNB.h" 15 #include <signal.h> 16 #include <stdio.h> 17 #include <stdlib.h> 18 #include <sys/resource.h> 19 #include <sys/stat.h> 20 #include <sys/types.h> 21 #include <sys/wait.h> 22 #include <unistd.h> 23 #include <sys/sysctl.h> 24 #include <map> 25 #include <vector> 26 27 #include "MacOSX/MachProcess.h" 28 #include "MacOSX/MachTask.h" 29 #include "CFString.h" 30 #include "DNBLog.h" 31 #include "DNBDataRef.h" 32 #include "DNBThreadResumeActions.h" 33 #include "DNBTimer.h" 34 35 typedef std::tr1::shared_ptr<MachProcess> MachProcessSP; 36 typedef std::map<nub_process_t, MachProcessSP> ProcessMap; 37 typedef ProcessMap::iterator ProcessMapIter; 38 typedef ProcessMap::const_iterator ProcessMapConstIter; 39 40 static size_t GetAllInfos (std::vector<struct kinfo_proc>& proc_infos); 41 static size_t GetAllInfosMatchingName (const char *process_name, std::vector<struct kinfo_proc>& matching_proc_infos); 42 43 //---------------------------------------------------------------------- 44 // A Thread safe singleton to get a process map pointer. 45 // 46 // Returns a pointer to the existing process map, or a pointer to a 47 // newly created process map if CAN_CREATE is non-zero. 48 //---------------------------------------------------------------------- 49 static ProcessMap* 50 GetProcessMap(bool can_create) 51 { 52 static ProcessMap* g_process_map_ptr = NULL; 53 54 if (can_create && g_process_map_ptr == NULL) 55 { 56 static pthread_mutex_t g_process_map_mutex = PTHREAD_MUTEX_INITIALIZER; 57 PTHREAD_MUTEX_LOCKER (locker, &g_process_map_mutex); 58 if (g_process_map_ptr == NULL) 59 g_process_map_ptr = new ProcessMap; 60 } 61 return g_process_map_ptr; 62 } 63 64 //---------------------------------------------------------------------- 65 // Add PID to the shared process pointer map. 66 // 67 // Return non-zero value if we succeed in adding the process to the map. 68 // The only time this should fail is if we run out of memory and can't 69 // allocate a ProcessMap. 70 //---------------------------------------------------------------------- 71 static nub_bool_t 72 AddProcessToMap (nub_process_t pid, MachProcessSP& procSP) 73 { 74 ProcessMap* process_map = GetProcessMap(true); 75 if (process_map) 76 { 77 process_map->insert(std::make_pair(pid, procSP)); 78 return true; 79 } 80 return false; 81 } 82 83 //---------------------------------------------------------------------- 84 // Remove the shared pointer for PID from the process map. 85 // 86 // Returns the number of items removed from the process map. 87 //---------------------------------------------------------------------- 88 static size_t 89 RemoveProcessFromMap (nub_process_t pid) 90 { 91 ProcessMap* process_map = GetProcessMap(false); 92 if (process_map) 93 { 94 return process_map->erase(pid); 95 } 96 return 0; 97 } 98 99 //---------------------------------------------------------------------- 100 // Get the shared pointer for PID from the existing process map. 101 // 102 // Returns true if we successfully find a shared pointer to a 103 // MachProcess object. 104 //---------------------------------------------------------------------- 105 static nub_bool_t 106 GetProcessSP (nub_process_t pid, MachProcessSP& procSP) 107 { 108 ProcessMap* process_map = GetProcessMap(false); 109 if (process_map != NULL) 110 { 111 ProcessMapIter pos = process_map->find(pid); 112 if (pos != process_map->end()) 113 { 114 procSP = pos->second; 115 return true; 116 } 117 } 118 procSP.reset(); 119 return false; 120 } 121 122 123 static void * 124 waitpid_thread (void *arg) 125 { 126 const pid_t pid = (pid_t)(intptr_t)arg; 127 int status; 128 while (1) 129 { 130 pid_t child_pid = waitpid(pid, &status, 0); 131 DNBLogThreadedIf(LOG_PROCESS, "waitpid_process_thread (): waitpid (pid = %i, &status, 0) => %i, status = %i, errno = %i", pid, child_pid, status, errno); 132 133 if (child_pid < 0) 134 { 135 if (errno == EINTR) 136 continue; 137 break; 138 } 139 else 140 { 141 if (WIFSTOPPED(status)) 142 { 143 continue; 144 } 145 else// if (WIFEXITED(status) || WIFSIGNALED(status)) 146 { 147 DNBLogThreadedIf(LOG_PROCESS, "waitpid_process_thread (): setting exit status for pid = %i to %i", child_pid, status); 148 DNBProcessSetExitStatus (child_pid, status); 149 return NULL; 150 } 151 } 152 } 153 154 // We should never exit as long as our child process is alive, so if we 155 // do something else went wrong and we should exit... 156 DNBLogThreadedIf(LOG_PROCESS, "waitpid_process_thread (): main loop exited, setting exit status to an invalid value (-1) for pid %i", pid); 157 DNBProcessSetExitStatus (pid, -1); 158 return NULL; 159 } 160 161 static bool 162 spawn_waitpid_thread (pid_t pid) 163 { 164 pthread_t thread = THREAD_NULL; 165 ::pthread_create (&thread, NULL, waitpid_thread, (void *)(intptr_t)pid); 166 if (thread != THREAD_NULL) 167 { 168 ::pthread_detach (thread); 169 return true; 170 } 171 return false; 172 } 173 174 nub_process_t 175 DNBProcessLaunch (const char *path, 176 char const *argv[], 177 const char *envp[], 178 const char *working_directory, // NULL => dont' change, non-NULL => set working directory for inferior to this 179 const char *stdin_path, 180 const char *stdout_path, 181 const char *stderr_path, 182 bool no_stdio, 183 nub_launch_flavor_t launch_flavor, 184 int disable_aslr, 185 char *err_str, 186 size_t err_len) 187 { 188 DNBLogThreadedIf(LOG_PROCESS, "%s ( path='%s', argv = %p, envp = %p, working_dir=%s, stdin=%s, stdout=%s, stderr=%s, no-stdio=%i, launch_flavor = %u, disable_aslr = %d, err = %p, err_len = %zu) called...", 189 __FUNCTION__, 190 path, 191 argv, 192 envp, 193 working_directory, 194 stdin_path, 195 stdout_path, 196 stderr_path, 197 no_stdio, 198 launch_flavor, 199 disable_aslr, 200 err_str, 201 err_len); 202 203 if (err_str && err_len > 0) 204 err_str[0] = '\0'; 205 struct stat path_stat; 206 if (::stat(path, &path_stat) == -1) 207 { 208 char stat_error[256]; 209 ::strerror_r (errno, stat_error, sizeof(stat_error)); 210 snprintf(err_str, err_len, "%s (%s)", stat_error, path); 211 return INVALID_NUB_PROCESS; 212 } 213 214 MachProcessSP processSP (new MachProcess); 215 if (processSP.get()) 216 { 217 DNBError launch_err; 218 pid_t pid = processSP->LaunchForDebug (path, 219 argv, 220 envp, 221 working_directory, 222 stdin_path, 223 stdout_path, 224 stderr_path, 225 no_stdio, 226 launch_flavor, 227 disable_aslr, 228 launch_err); 229 if (err_str) 230 { 231 *err_str = '\0'; 232 if (launch_err.Fail()) 233 { 234 const char *launch_err_str = launch_err.AsString(); 235 if (launch_err_str) 236 { 237 strncpy(err_str, launch_err_str, err_len-1); 238 err_str[err_len-1] = '\0'; // Make sure the error string is terminated 239 } 240 } 241 } 242 243 DNBLogThreadedIf(LOG_PROCESS, "(DebugNub) new pid is %d...", pid); 244 245 if (pid != INVALID_NUB_PROCESS) 246 { 247 // Spawn a thread to reap our child inferior process... 248 spawn_waitpid_thread (pid); 249 250 if (processSP->Task().TaskPortForProcessID (launch_err) == TASK_NULL) 251 { 252 // We failed to get the task for our process ID which is bad. 253 if (err_str && err_len > 0) 254 { 255 if (launch_err.AsString()) 256 { 257 ::snprintf (err_str, err_len, "failed to get the task for process %i (%s)", pid, launch_err.AsString()); 258 } 259 else 260 { 261 ::snprintf (err_str, err_len, "failed to get the task for process %i", pid); 262 } 263 } 264 } 265 else 266 { 267 assert(AddProcessToMap(pid, processSP)); 268 return pid; 269 } 270 } 271 } 272 return INVALID_NUB_PROCESS; 273 } 274 275 nub_process_t 276 DNBProcessAttachByName (const char *name, struct timespec *timeout, char *err_str, size_t err_len) 277 { 278 if (err_str && err_len > 0) 279 err_str[0] = '\0'; 280 std::vector<struct kinfo_proc> matching_proc_infos; 281 size_t num_matching_proc_infos = GetAllInfosMatchingName(name, matching_proc_infos); 282 if (num_matching_proc_infos == 0) 283 { 284 DNBLogError ("error: no processes match '%s'\n", name); 285 return INVALID_NUB_PROCESS; 286 } 287 else if (num_matching_proc_infos > 1) 288 { 289 DNBLogError ("error: %u processes match '%s':\n", num_matching_proc_infos, name); 290 size_t i; 291 for (i=0; i<num_matching_proc_infos; ++i) 292 DNBLogError ("%6u - %s\n", matching_proc_infos[i].kp_proc.p_pid, matching_proc_infos[i].kp_proc.p_comm); 293 return INVALID_NUB_PROCESS; 294 } 295 296 return DNBProcessAttach (matching_proc_infos[0].kp_proc.p_pid, timeout, err_str, err_len); 297 } 298 299 nub_process_t 300 DNBProcessAttach (nub_process_t attach_pid, struct timespec *timeout, char *err_str, size_t err_len) 301 { 302 if (err_str && err_len > 0) 303 err_str[0] = '\0'; 304 305 pid_t pid = INVALID_NUB_PROCESS; 306 MachProcessSP processSP(new MachProcess); 307 if (processSP.get()) 308 { 309 DNBLogThreadedIf(LOG_PROCESS, "(DebugNub) attaching to pid %d...", attach_pid); 310 pid = processSP->AttachForDebug (attach_pid, err_str, err_len); 311 312 if (pid != INVALID_NUB_PROCESS) 313 { 314 assert(AddProcessToMap(pid, processSP)); 315 spawn_waitpid_thread(pid); 316 } 317 } 318 319 while (pid != INVALID_NUB_PROCESS) 320 { 321 // Wait for process to start up and hit entry point 322 DNBLogThreadedIf (LOG_PROCESS, 323 "%s DNBProcessWaitForEvent (%4.4x, eEventProcessRunningStateChanged | eEventProcessStoppedStateChanged, true, INFINITE)...", 324 __FUNCTION__, 325 pid); 326 nub_event_t set_events = DNBProcessWaitForEvents (pid, 327 eEventProcessRunningStateChanged | eEventProcessStoppedStateChanged, 328 true, 329 timeout); 330 331 DNBLogThreadedIf (LOG_PROCESS, 332 "%s DNBProcessWaitForEvent (%4.4x, eEventProcessRunningStateChanged | eEventProcessStoppedStateChanged, true, INFINITE) => 0x%8.8x", 333 __FUNCTION__, 334 pid, 335 set_events); 336 337 if (set_events == 0) 338 { 339 if (err_str && err_len > 0) 340 snprintf(err_str, err_len, "operation timed out"); 341 pid = INVALID_NUB_PROCESS; 342 } 343 else 344 { 345 if (set_events & (eEventProcessRunningStateChanged | eEventProcessStoppedStateChanged)) 346 { 347 nub_state_t pid_state = DNBProcessGetState (pid); 348 DNBLogThreadedIf (LOG_PROCESS, "%s process %4.4x state changed (eEventProcessStateChanged): %s", 349 __FUNCTION__, pid, DNBStateAsString(pid_state)); 350 351 switch (pid_state) 352 { 353 default: 354 case eStateInvalid: 355 case eStateUnloaded: 356 case eStateAttaching: 357 case eStateLaunching: 358 case eStateSuspended: 359 break; // Ignore 360 361 case eStateRunning: 362 case eStateStepping: 363 // Still waiting to stop at entry point... 364 break; 365 366 case eStateStopped: 367 case eStateCrashed: 368 return pid; 369 370 case eStateDetached: 371 case eStateExited: 372 if (err_str && err_len > 0) 373 snprintf(err_str, err_len, "process exited"); 374 return INVALID_NUB_PROCESS; 375 } 376 } 377 378 DNBProcessResetEvents(pid, set_events); 379 } 380 } 381 382 return INVALID_NUB_PROCESS; 383 } 384 385 static size_t 386 GetAllInfos (std::vector<struct kinfo_proc>& proc_infos) 387 { 388 size_t size; 389 int name[] = { CTL_KERN, KERN_PROC, KERN_PROC_ALL }; 390 u_int namelen = sizeof(name)/sizeof(int); 391 int err; 392 393 // Try to find out how many processes are around so we can 394 // size the buffer appropriately. sysctl's man page specifically suggests 395 // this approach, and says it returns a bit larger size than needed to 396 // handle any new processes created between then and now. 397 398 err = ::sysctl (name, namelen, NULL, &size, NULL, 0); 399 400 if ((err < 0) && (err != ENOMEM)) 401 { 402 proc_infos.clear(); 403 perror("sysctl (mib, miblen, NULL, &num_processes, NULL, 0)"); 404 return 0; 405 } 406 407 408 // Increase the size of the buffer by a few processes in case more have 409 // been spawned 410 proc_infos.resize (size / sizeof(struct kinfo_proc)); 411 size = proc_infos.size() * sizeof(struct kinfo_proc); // Make sure we don't exceed our resize... 412 err = ::sysctl (name, namelen, &proc_infos[0], &size, NULL, 0); 413 if (err < 0) 414 { 415 proc_infos.clear(); 416 return 0; 417 } 418 419 // Trim down our array to fit what we actually got back 420 proc_infos.resize(size / sizeof(struct kinfo_proc)); 421 return proc_infos.size(); 422 } 423 424 425 static size_t 426 GetAllInfosMatchingName(const char *full_process_name, std::vector<struct kinfo_proc>& matching_proc_infos) 427 { 428 429 matching_proc_infos.clear(); 430 if (full_process_name && full_process_name[0]) 431 { 432 // We only get the process name, not the full path, from the proc_info. So just take the 433 // base name of the process name... 434 const char *process_name; 435 process_name = strrchr (full_process_name, '/'); 436 if (process_name == NULL) 437 process_name = full_process_name; 438 else 439 process_name++; 440 441 std::vector<struct kinfo_proc> proc_infos; 442 const size_t num_proc_infos = GetAllInfos(proc_infos); 443 if (num_proc_infos > 0) 444 { 445 uint32_t i; 446 for (i=0; i<num_proc_infos; i++) 447 { 448 // Skip zombie processes and processes with unset status 449 if (proc_infos[i].kp_proc.p_stat == 0 || proc_infos[i].kp_proc.p_stat == SZOMB) 450 continue; 451 452 // Check for process by name. We only check the first MAXCOMLEN 453 // chars as that is all that kp_proc.p_comm holds. 454 if (::strncasecmp(proc_infos[i].kp_proc.p_comm, process_name, MAXCOMLEN) == 0) 455 { 456 // We found a matching process, add it to our list 457 matching_proc_infos.push_back(proc_infos[i]); 458 } 459 } 460 } 461 } 462 // return the newly added matches. 463 return matching_proc_infos.size(); 464 } 465 466 nub_process_t 467 DNBProcessAttachWait (const char *waitfor_process_name, 468 nub_launch_flavor_t launch_flavor, 469 struct timespec *timeout_abstime, 470 useconds_t waitfor_interval, 471 char *err_str, 472 size_t err_len, 473 DNBShouldCancelCallback should_cancel_callback, 474 void *callback_data) 475 { 476 DNBError prepare_error; 477 std::vector<struct kinfo_proc> exclude_proc_infos; 478 size_t num_exclude_proc_infos; 479 480 // If the PrepareForAttach returns a valid token, use MachProcess to check 481 // for the process, otherwise scan the process table. 482 483 const void *attach_token = MachProcess::PrepareForAttach (waitfor_process_name, launch_flavor, true, prepare_error); 484 485 if (prepare_error.Fail()) 486 { 487 DNBLogError ("Error in PrepareForAttach: %s", prepare_error.AsString()); 488 return INVALID_NUB_PROCESS; 489 } 490 491 if (attach_token == NULL) 492 num_exclude_proc_infos = GetAllInfosMatchingName (waitfor_process_name, exclude_proc_infos); 493 494 DNBLogThreadedIf (LOG_PROCESS, "Waiting for '%s' to appear...\n", waitfor_process_name); 495 496 // Loop and try to find the process by name 497 nub_process_t waitfor_pid = INVALID_NUB_PROCESS; 498 499 while (waitfor_pid == INVALID_NUB_PROCESS) 500 { 501 if (attach_token != NULL) 502 { 503 nub_process_t pid; 504 pid = MachProcess::CheckForProcess(attach_token); 505 if (pid != INVALID_NUB_PROCESS) 506 { 507 waitfor_pid = pid; 508 break; 509 } 510 } 511 else 512 { 513 514 // Get the current process list, and check for matches that 515 // aren't in our original list. If anyone wants to attach 516 // to an existing process by name, they should do it with 517 // --attach=PROCNAME. Else we will wait for the first matching 518 // process that wasn't in our exclusion list. 519 std::vector<struct kinfo_proc> proc_infos; 520 const size_t num_proc_infos = GetAllInfosMatchingName (waitfor_process_name, proc_infos); 521 for (size_t i=0; i<num_proc_infos; i++) 522 { 523 nub_process_t curr_pid = proc_infos[i].kp_proc.p_pid; 524 for (size_t j=0; j<num_exclude_proc_infos; j++) 525 { 526 if (curr_pid == exclude_proc_infos[j].kp_proc.p_pid) 527 { 528 // This process was in our exclusion list, don't use it. 529 curr_pid = INVALID_NUB_PROCESS; 530 break; 531 } 532 } 533 534 // If we didn't find CURR_PID in our exclusion list, then use it. 535 if (curr_pid != INVALID_NUB_PROCESS) 536 { 537 // We found our process! 538 waitfor_pid = curr_pid; 539 break; 540 } 541 } 542 } 543 544 // If we haven't found our process yet, check for a timeout 545 // and then sleep for a bit until we poll again. 546 if (waitfor_pid == INVALID_NUB_PROCESS) 547 { 548 if (timeout_abstime != NULL) 549 { 550 // Check to see if we have a waitfor-duration option that 551 // has timed out? 552 if (DNBTimer::TimeOfDayLaterThan(*timeout_abstime)) 553 { 554 if (err_str && err_len > 0) 555 snprintf(err_str, err_len, "operation timed out"); 556 DNBLogError ("error: waiting for process '%s' timed out.\n", waitfor_process_name); 557 return INVALID_NUB_PROCESS; 558 } 559 } 560 561 // Call the should cancel callback as well... 562 563 if (should_cancel_callback != NULL 564 && should_cancel_callback (callback_data)) 565 { 566 DNBLogThreadedIf (LOG_PROCESS, "DNBProcessAttachWait cancelled by should_cancel callback."); 567 waitfor_pid = INVALID_NUB_PROCESS; 568 break; 569 } 570 571 ::usleep (waitfor_interval); // Sleep for WAITFOR_INTERVAL, then poll again 572 } 573 } 574 575 if (waitfor_pid != INVALID_NUB_PROCESS) 576 { 577 DNBLogThreadedIf (LOG_PROCESS, "Attaching to %s with pid %i...\n", waitfor_process_name, waitfor_pid); 578 waitfor_pid = DNBProcessAttach (waitfor_pid, timeout_abstime, err_str, err_len); 579 } 580 581 bool success = waitfor_pid != INVALID_NUB_PROCESS; 582 MachProcess::CleanupAfterAttach (attach_token, success, prepare_error); 583 584 return waitfor_pid; 585 } 586 587 nub_bool_t 588 DNBProcessDetach (nub_process_t pid) 589 { 590 MachProcessSP procSP; 591 if (GetProcessSP (pid, procSP)) 592 { 593 return procSP->Detach(); 594 } 595 return false; 596 } 597 598 nub_bool_t 599 DNBProcessKill (nub_process_t pid) 600 { 601 MachProcessSP procSP; 602 if (GetProcessSP (pid, procSP)) 603 { 604 return procSP->Kill (); 605 } 606 return false; 607 } 608 609 nub_bool_t 610 DNBProcessSignal (nub_process_t pid, int signal) 611 { 612 MachProcessSP procSP; 613 if (GetProcessSP (pid, procSP)) 614 { 615 return procSP->Signal (signal); 616 } 617 return false; 618 } 619 620 621 nub_bool_t 622 DNBProcessIsAlive (nub_process_t pid) 623 { 624 MachProcessSP procSP; 625 if (GetProcessSP (pid, procSP)) 626 { 627 return MachTask::IsValid (procSP->Task().TaskPort()); 628 } 629 return eStateInvalid; 630 } 631 632 //---------------------------------------------------------------------- 633 // Process and Thread state information 634 //---------------------------------------------------------------------- 635 nub_state_t 636 DNBProcessGetState (nub_process_t pid) 637 { 638 MachProcessSP procSP; 639 if (GetProcessSP (pid, procSP)) 640 { 641 return procSP->GetState(); 642 } 643 return eStateInvalid; 644 } 645 646 //---------------------------------------------------------------------- 647 // Process and Thread state information 648 //---------------------------------------------------------------------- 649 nub_bool_t 650 DNBProcessGetExitStatus (nub_process_t pid, int* status) 651 { 652 MachProcessSP procSP; 653 if (GetProcessSP (pid, procSP)) 654 { 655 return procSP->GetExitStatus(status); 656 } 657 return false; 658 } 659 660 nub_bool_t 661 DNBProcessSetExitStatus (nub_process_t pid, int status) 662 { 663 MachProcessSP procSP; 664 if (GetProcessSP (pid, procSP)) 665 { 666 procSP->SetExitStatus(status); 667 return true; 668 } 669 return false; 670 } 671 672 673 const char * 674 DNBThreadGetName (nub_process_t pid, nub_thread_t tid) 675 { 676 MachProcessSP procSP; 677 if (GetProcessSP (pid, procSP)) 678 return procSP->ThreadGetName(tid); 679 return NULL; 680 } 681 682 683 nub_bool_t 684 DNBThreadGetIdentifierInfo (nub_process_t pid, nub_thread_t tid, thread_identifier_info_data_t *ident_info) 685 { 686 MachProcessSP procSP; 687 if (GetProcessSP (pid, procSP)) 688 return procSP->GetThreadList().GetIdentifierInfo(tid, ident_info); 689 return false; 690 } 691 692 nub_state_t 693 DNBThreadGetState (nub_process_t pid, nub_thread_t tid) 694 { 695 MachProcessSP procSP; 696 if (GetProcessSP (pid, procSP)) 697 { 698 return procSP->ThreadGetState(tid); 699 } 700 return eStateInvalid; 701 } 702 703 const char * 704 DNBStateAsString(nub_state_t state) 705 { 706 switch (state) 707 { 708 case eStateInvalid: return "Invalid"; 709 case eStateUnloaded: return "Unloaded"; 710 case eStateAttaching: return "Attaching"; 711 case eStateLaunching: return "Launching"; 712 case eStateStopped: return "Stopped"; 713 case eStateRunning: return "Running"; 714 case eStateStepping: return "Stepping"; 715 case eStateCrashed: return "Crashed"; 716 case eStateDetached: return "Detached"; 717 case eStateExited: return "Exited"; 718 case eStateSuspended: return "Suspended"; 719 } 720 return "nub_state_t ???"; 721 } 722 723 const char * 724 DNBProcessGetExecutablePath (nub_process_t pid) 725 { 726 MachProcessSP procSP; 727 if (GetProcessSP (pid, procSP)) 728 { 729 return procSP->Path(); 730 } 731 return NULL; 732 } 733 734 nub_size_t 735 DNBProcessGetArgumentCount (nub_process_t pid) 736 { 737 MachProcessSP procSP; 738 if (GetProcessSP (pid, procSP)) 739 { 740 return procSP->ArgumentCount(); 741 } 742 return 0; 743 } 744 745 const char * 746 DNBProcessGetArgumentAtIndex (nub_process_t pid, nub_size_t idx) 747 { 748 MachProcessSP procSP; 749 if (GetProcessSP (pid, procSP)) 750 { 751 return procSP->ArgumentAtIndex (idx); 752 } 753 return NULL; 754 } 755 756 757 //---------------------------------------------------------------------- 758 // Execution control 759 //---------------------------------------------------------------------- 760 nub_bool_t 761 DNBProcessResume (nub_process_t pid, const DNBThreadResumeAction *actions, size_t num_actions) 762 { 763 DNBLogThreadedIf(LOG_PROCESS, "%s(pid = %4.4x)", __FUNCTION__, pid); 764 MachProcessSP procSP; 765 if (GetProcessSP (pid, procSP)) 766 { 767 DNBThreadResumeActions thread_actions (actions, num_actions); 768 769 // Below we add a default thread plan just in case one wasn't 770 // provided so all threads always know what they were supposed to do 771 if (thread_actions.IsEmpty()) 772 { 773 // No thread plans were given, so the default it to run all threads 774 thread_actions.SetDefaultThreadActionIfNeeded (eStateRunning, 0); 775 } 776 else 777 { 778 // Some thread plans were given which means anything that wasn't 779 // specified should remain stopped. 780 thread_actions.SetDefaultThreadActionIfNeeded (eStateStopped, 0); 781 } 782 return procSP->Resume (thread_actions); 783 } 784 return false; 785 } 786 787 nub_bool_t 788 DNBProcessHalt (nub_process_t pid) 789 { 790 DNBLogThreadedIf(LOG_PROCESS, "%s(pid = %4.4x)", __FUNCTION__, pid); 791 MachProcessSP procSP; 792 if (GetProcessSP (pid, procSP)) 793 return procSP->Signal (SIGSTOP); 794 return false; 795 } 796 // 797 //nub_bool_t 798 //DNBThreadResume (nub_process_t pid, nub_thread_t tid, nub_bool_t step) 799 //{ 800 // DNBLogThreadedIf(LOG_THREAD, "%s(pid = %4.4x, tid = %4.4x, step = %u)", __FUNCTION__, pid, tid, (uint32_t)step); 801 // MachProcessSP procSP; 802 // if (GetProcessSP (pid, procSP)) 803 // { 804 // return procSP->Resume(tid, step, 0); 805 // } 806 // return false; 807 //} 808 // 809 //nub_bool_t 810 //DNBThreadResumeWithSignal (nub_process_t pid, nub_thread_t tid, nub_bool_t step, int signal) 811 //{ 812 // DNBLogThreadedIf(LOG_THREAD, "%s(pid = %4.4x, tid = %4.4x, step = %u, signal = %i)", __FUNCTION__, pid, tid, (uint32_t)step, signal); 813 // MachProcessSP procSP; 814 // if (GetProcessSP (pid, procSP)) 815 // { 816 // return procSP->Resume(tid, step, signal); 817 // } 818 // return false; 819 //} 820 821 nub_event_t 822 DNBProcessWaitForEvents (nub_process_t pid, nub_event_t event_mask, bool wait_for_set, struct timespec* timeout) 823 { 824 nub_event_t result = 0; 825 MachProcessSP procSP; 826 if (GetProcessSP (pid, procSP)) 827 { 828 if (wait_for_set) 829 result = procSP->Events().WaitForSetEvents(event_mask, timeout); 830 else 831 result = procSP->Events().WaitForEventsToReset(event_mask, timeout); 832 } 833 return result; 834 } 835 836 void 837 DNBProcessResetEvents (nub_process_t pid, nub_event_t event_mask) 838 { 839 MachProcessSP procSP; 840 if (GetProcessSP (pid, procSP)) 841 procSP->Events().ResetEvents(event_mask); 842 } 843 844 void 845 DNBProcessInterruptEvents (nub_process_t pid) 846 { 847 MachProcessSP procSP; 848 if (GetProcessSP (pid, procSP)) 849 procSP->Events().SetEvents(eEventProcessAsyncInterrupt); 850 } 851 852 853 // Breakpoints 854 nub_break_t 855 DNBBreakpointSet (nub_process_t pid, nub_addr_t addr, nub_size_t size, nub_bool_t hardware) 856 { 857 MachProcessSP procSP; 858 if (GetProcessSP (pid, procSP)) 859 { 860 return procSP->CreateBreakpoint(addr, size, hardware, THREAD_NULL); 861 } 862 return INVALID_NUB_BREAK_ID; 863 } 864 865 nub_bool_t 866 DNBBreakpointClear (nub_process_t pid, nub_break_t breakID) 867 { 868 if (NUB_BREAK_ID_IS_VALID(breakID)) 869 { 870 MachProcessSP procSP; 871 if (GetProcessSP (pid, procSP)) 872 { 873 return procSP->DisableBreakpoint(breakID, true); 874 } 875 } 876 return false; // Failed 877 } 878 879 nub_ssize_t 880 DNBBreakpointGetHitCount (nub_process_t pid, nub_break_t breakID) 881 { 882 if (NUB_BREAK_ID_IS_VALID(breakID)) 883 { 884 MachProcessSP procSP; 885 if (GetProcessSP (pid, procSP)) 886 { 887 DNBBreakpoint *bp = procSP->Breakpoints().FindByID(breakID); 888 if (bp) 889 return bp->GetHitCount(); 890 } 891 } 892 return 0; 893 } 894 895 nub_ssize_t 896 DNBBreakpointGetIgnoreCount (nub_process_t pid, nub_break_t breakID) 897 { 898 if (NUB_BREAK_ID_IS_VALID(breakID)) 899 { 900 MachProcessSP procSP; 901 if (GetProcessSP (pid, procSP)) 902 { 903 DNBBreakpoint *bp = procSP->Breakpoints().FindByID(breakID); 904 if (bp) 905 return bp->GetIgnoreCount(); 906 } 907 } 908 return 0; 909 } 910 911 nub_bool_t 912 DNBBreakpointSetIgnoreCount (nub_process_t pid, nub_break_t breakID, nub_size_t ignore_count) 913 { 914 if (NUB_BREAK_ID_IS_VALID(breakID)) 915 { 916 MachProcessSP procSP; 917 if (GetProcessSP (pid, procSP)) 918 { 919 DNBBreakpoint *bp = procSP->Breakpoints().FindByID(breakID); 920 if (bp) 921 { 922 bp->SetIgnoreCount(ignore_count); 923 return true; 924 } 925 } 926 } 927 return false; 928 } 929 930 // Set the callback function for a given breakpoint. The callback function will 931 // get called as soon as the breakpoint is hit. The function will be called 932 // with the process ID, thread ID, breakpoint ID and the baton, and can return 933 // 934 nub_bool_t 935 DNBBreakpointSetCallback (nub_process_t pid, nub_break_t breakID, DNBCallbackBreakpointHit callback, void *baton) 936 { 937 if (NUB_BREAK_ID_IS_VALID(breakID)) 938 { 939 MachProcessSP procSP; 940 if (GetProcessSP (pid, procSP)) 941 { 942 DNBBreakpoint *bp = procSP->Breakpoints().FindByID(breakID); 943 if (bp) 944 { 945 bp->SetCallback(callback, baton); 946 return true; 947 } 948 } 949 } 950 return false; 951 } 952 953 //---------------------------------------------------------------------- 954 // Dump the breakpoints stats for process PID for a breakpoint by ID. 955 //---------------------------------------------------------------------- 956 void 957 DNBBreakpointPrint (nub_process_t pid, nub_break_t breakID) 958 { 959 MachProcessSP procSP; 960 if (GetProcessSP (pid, procSP)) 961 procSP->DumpBreakpoint(breakID); 962 } 963 964 //---------------------------------------------------------------------- 965 // Watchpoints 966 //---------------------------------------------------------------------- 967 nub_watch_t 968 DNBWatchpointSet (nub_process_t pid, nub_addr_t addr, nub_size_t size, uint32_t watch_flags, nub_bool_t hardware) 969 { 970 MachProcessSP procSP; 971 if (GetProcessSP (pid, procSP)) 972 { 973 return procSP->CreateWatchpoint(addr, size, watch_flags, hardware, THREAD_NULL); 974 } 975 return INVALID_NUB_WATCH_ID; 976 } 977 978 nub_bool_t 979 DNBWatchpointClear (nub_process_t pid, nub_watch_t watchID) 980 { 981 if (NUB_WATCH_ID_IS_VALID(watchID)) 982 { 983 MachProcessSP procSP; 984 if (GetProcessSP (pid, procSP)) 985 { 986 return procSP->DisableWatchpoint(watchID, true); 987 } 988 } 989 return false; // Failed 990 } 991 992 nub_ssize_t 993 DNBWatchpointGetHitCount (nub_process_t pid, nub_watch_t watchID) 994 { 995 if (NUB_WATCH_ID_IS_VALID(watchID)) 996 { 997 MachProcessSP procSP; 998 if (GetProcessSP (pid, procSP)) 999 { 1000 DNBBreakpoint *bp = procSP->Watchpoints().FindByID(watchID); 1001 if (bp) 1002 return bp->GetHitCount(); 1003 } 1004 } 1005 return 0; 1006 } 1007 1008 nub_ssize_t 1009 DNBWatchpointGetIgnoreCount (nub_process_t pid, nub_watch_t watchID) 1010 { 1011 if (NUB_WATCH_ID_IS_VALID(watchID)) 1012 { 1013 MachProcessSP procSP; 1014 if (GetProcessSP (pid, procSP)) 1015 { 1016 DNBBreakpoint *bp = procSP->Watchpoints().FindByID(watchID); 1017 if (bp) 1018 return bp->GetIgnoreCount(); 1019 } 1020 } 1021 return 0; 1022 } 1023 1024 nub_bool_t 1025 DNBWatchpointSetIgnoreCount (nub_process_t pid, nub_watch_t watchID, nub_size_t ignore_count) 1026 { 1027 if (NUB_WATCH_ID_IS_VALID(watchID)) 1028 { 1029 MachProcessSP procSP; 1030 if (GetProcessSP (pid, procSP)) 1031 { 1032 DNBBreakpoint *bp = procSP->Watchpoints().FindByID(watchID); 1033 if (bp) 1034 { 1035 bp->SetIgnoreCount(ignore_count); 1036 return true; 1037 } 1038 } 1039 } 1040 return false; 1041 } 1042 1043 // Set the callback function for a given watchpoint. The callback function will 1044 // get called as soon as the watchpoint is hit. The function will be called 1045 // with the process ID, thread ID, watchpoint ID and the baton, and can return 1046 // 1047 nub_bool_t 1048 DNBWatchpointSetCallback (nub_process_t pid, nub_watch_t watchID, DNBCallbackBreakpointHit callback, void *baton) 1049 { 1050 if (NUB_WATCH_ID_IS_VALID(watchID)) 1051 { 1052 MachProcessSP procSP; 1053 if (GetProcessSP (pid, procSP)) 1054 { 1055 DNBBreakpoint *bp = procSP->Watchpoints().FindByID(watchID); 1056 if (bp) 1057 { 1058 bp->SetCallback(callback, baton); 1059 return true; 1060 } 1061 } 1062 } 1063 return false; 1064 } 1065 1066 //---------------------------------------------------------------------- 1067 // Dump the watchpoints stats for process PID for a watchpoint by ID. 1068 //---------------------------------------------------------------------- 1069 void 1070 DNBWatchpointPrint (nub_process_t pid, nub_watch_t watchID) 1071 { 1072 MachProcessSP procSP; 1073 if (GetProcessSP (pid, procSP)) 1074 procSP->DumpWatchpoint(watchID); 1075 } 1076 1077 //---------------------------------------------------------------------- 1078 // Read memory in the address space of process PID. This call will take 1079 // care of setting and restoring permissions and breaking up the memory 1080 // read into multiple chunks as required. 1081 // 1082 // RETURNS: number of bytes actually read 1083 //---------------------------------------------------------------------- 1084 nub_size_t 1085 DNBProcessMemoryRead (nub_process_t pid, nub_addr_t addr, nub_size_t size, void *buf) 1086 { 1087 MachProcessSP procSP; 1088 if (GetProcessSP (pid, procSP)) 1089 return procSP->ReadMemory(addr, size, buf); 1090 return 0; 1091 } 1092 1093 //---------------------------------------------------------------------- 1094 // Write memory to the address space of process PID. This call will take 1095 // care of setting and restoring permissions and breaking up the memory 1096 // write into multiple chunks as required. 1097 // 1098 // RETURNS: number of bytes actually written 1099 //---------------------------------------------------------------------- 1100 nub_size_t 1101 DNBProcessMemoryWrite (nub_process_t pid, nub_addr_t addr, nub_size_t size, const void *buf) 1102 { 1103 MachProcessSP procSP; 1104 if (GetProcessSP (pid, procSP)) 1105 return procSP->WriteMemory(addr, size, buf); 1106 return 0; 1107 } 1108 1109 nub_addr_t 1110 DNBProcessMemoryAllocate (nub_process_t pid, nub_size_t size, uint32_t permissions) 1111 { 1112 MachProcessSP procSP; 1113 if (GetProcessSP (pid, procSP)) 1114 return procSP->Task().AllocateMemory (size, permissions); 1115 return 0; 1116 } 1117 1118 nub_bool_t 1119 DNBProcessMemoryDeallocate (nub_process_t pid, nub_addr_t addr) 1120 { 1121 MachProcessSP procSP; 1122 if (GetProcessSP (pid, procSP)) 1123 return procSP->Task().DeallocateMemory (addr); 1124 return 0; 1125 } 1126 1127 1128 //---------------------------------------------------------------------- 1129 // Formatted output that uses memory and registers from process and 1130 // thread in place of arguments. 1131 //---------------------------------------------------------------------- 1132 nub_size_t 1133 DNBPrintf (nub_process_t pid, nub_thread_t tid, nub_addr_t base_addr, FILE *file, const char *format) 1134 { 1135 if (file == NULL) 1136 return 0; 1137 enum printf_flags 1138 { 1139 alternate_form = (1 << 0), 1140 zero_padding = (1 << 1), 1141 negative_field_width = (1 << 2), 1142 blank_space = (1 << 3), 1143 show_sign = (1 << 4), 1144 show_thousands_separator= (1 << 5), 1145 }; 1146 1147 enum printf_length_modifiers 1148 { 1149 length_mod_h = (1 << 0), 1150 length_mod_hh = (1 << 1), 1151 length_mod_l = (1 << 2), 1152 length_mod_ll = (1 << 3), 1153 length_mod_L = (1 << 4), 1154 length_mod_j = (1 << 5), 1155 length_mod_t = (1 << 6), 1156 length_mod_z = (1 << 7), 1157 length_mod_q = (1 << 8), 1158 }; 1159 1160 nub_addr_t addr = base_addr; 1161 char *end_format = (char*)format + strlen(format); 1162 char *end = NULL; // For strtoXXXX calls; 1163 std::basic_string<uint8_t> buf; 1164 nub_size_t total_bytes_read = 0; 1165 DNBDataRef data; 1166 const char *f; 1167 for (f = format; *f != '\0' && f < end_format; f++) 1168 { 1169 char ch = *f; 1170 switch (ch) 1171 { 1172 case '%': 1173 { 1174 f++; // Skip the '%' character 1175 int min_field_width = 0; 1176 int precision = 0; 1177 uint32_t flags = 0; 1178 uint32_t length_modifiers = 0; 1179 uint32_t byte_size = 0; 1180 uint32_t actual_byte_size = 0; 1181 bool is_string = false; 1182 bool is_register = false; 1183 DNBRegisterValue register_value; 1184 int64_t register_offset = 0; 1185 nub_addr_t register_addr = INVALID_NUB_ADDRESS; 1186 1187 // Create the format string to use for this conversion specification 1188 // so we can remove and mprintf specific flags and formatters. 1189 std::string fprintf_format("%"); 1190 1191 // Decode any flags 1192 switch (*f) 1193 { 1194 case '#': fprintf_format += *f++; flags |= alternate_form; break; 1195 case '0': fprintf_format += *f++; flags |= zero_padding; break; 1196 case '-': fprintf_format += *f++; flags |= negative_field_width; break; 1197 case ' ': fprintf_format += *f++; flags |= blank_space; break; 1198 case '+': fprintf_format += *f++; flags |= show_sign; break; 1199 case ',': fprintf_format += *f++; flags |= show_thousands_separator;break; 1200 case '{': 1201 case '[': 1202 { 1203 // We have a register name specification that can take two forms: 1204 // ${regname} or ${regname+offset} 1205 // The action is to read the register value and add the signed offset 1206 // (if any) and use that as the value to format. 1207 // $[regname] or $[regname+offset] 1208 // The action is to read the register value and add the signed offset 1209 // (if any) and use the result as an address to dereference. The size 1210 // of what is dereferenced is specified by the actual byte size that 1211 // follows the minimum field width and precision (see comments below). 1212 switch (*f) 1213 { 1214 case '{': 1215 case '[': 1216 { 1217 char open_scope_ch = *f; 1218 f++; 1219 const char *reg_name = f; 1220 size_t reg_name_length = strcspn(f, "+-}]"); 1221 if (reg_name_length > 0) 1222 { 1223 std::string register_name(reg_name, reg_name_length); 1224 f += reg_name_length; 1225 register_offset = strtoll(f, &end, 0); 1226 if (f < end) 1227 f = end; 1228 if ((open_scope_ch == '{' && *f != '}') || (open_scope_ch == '[' && *f != ']')) 1229 { 1230 fprintf(file, "error: Invalid register format string. Valid formats are %%{regname} or %%{regname+offset}, %%[regname] or %%[regname+offset]\n"); 1231 return total_bytes_read; 1232 } 1233 else 1234 { 1235 f++; 1236 if (DNBThreadGetRegisterValueByName(pid, tid, REGISTER_SET_ALL, register_name.c_str(), ®ister_value)) 1237 { 1238 // Set the address to dereference using the register value plus the offset 1239 switch (register_value.info.size) 1240 { 1241 default: 1242 case 0: 1243 fprintf (file, "error: unsupported register size of %u.\n", register_value.info.size); 1244 return total_bytes_read; 1245 1246 case 1: register_addr = register_value.value.uint8 + register_offset; break; 1247 case 2: register_addr = register_value.value.uint16 + register_offset; break; 1248 case 4: register_addr = register_value.value.uint32 + register_offset; break; 1249 case 8: register_addr = register_value.value.uint64 + register_offset; break; 1250 case 16: 1251 if (open_scope_ch == '[') 1252 { 1253 fprintf (file, "error: register size (%u) too large for address.\n", register_value.info.size); 1254 return total_bytes_read; 1255 } 1256 break; 1257 } 1258 1259 if (open_scope_ch == '{') 1260 { 1261 byte_size = register_value.info.size; 1262 is_register = true; // value is in a register 1263 1264 } 1265 else 1266 { 1267 addr = register_addr; // Use register value and offset as the address 1268 } 1269 } 1270 else 1271 { 1272 fprintf(file, "error: unable to read register '%s' for process %#.4x and thread %#.4x\n", register_name.c_str(), pid, tid); 1273 return total_bytes_read; 1274 } 1275 } 1276 } 1277 } 1278 break; 1279 1280 default: 1281 fprintf(file, "error: %%$ must be followed by (regname + n) or [regname + n]\n"); 1282 return total_bytes_read; 1283 } 1284 } 1285 break; 1286 } 1287 1288 // Check for a minimum field width 1289 if (isdigit(*f)) 1290 { 1291 min_field_width = strtoul(f, &end, 10); 1292 if (end > f) 1293 { 1294 fprintf_format.append(f, end - f); 1295 f = end; 1296 } 1297 } 1298 1299 1300 // Check for a precision 1301 if (*f == '.') 1302 { 1303 f++; 1304 if (isdigit(*f)) 1305 { 1306 fprintf_format += '.'; 1307 precision = strtoul(f, &end, 10); 1308 if (end > f) 1309 { 1310 fprintf_format.append(f, end - f); 1311 f = end; 1312 } 1313 } 1314 } 1315 1316 1317 // mprintf specific: read the optional actual byte size (abs) 1318 // after the standard minimum field width (mfw) and precision (prec). 1319 // Standard printf calls you can have "mfw.prec" or ".prec", but 1320 // mprintf can have "mfw.prec.abs", ".prec.abs" or "..abs". This is nice 1321 // for strings that may be in a fixed size buffer, but may not use all bytes 1322 // in that buffer for printable characters. 1323 if (*f == '.') 1324 { 1325 f++; 1326 actual_byte_size = strtoul(f, &end, 10); 1327 if (end > f) 1328 { 1329 byte_size = actual_byte_size; 1330 f = end; 1331 } 1332 } 1333 1334 // Decode the length modifiers 1335 switch (*f) 1336 { 1337 case 'h': // h and hh length modifiers 1338 fprintf_format += *f++; 1339 length_modifiers |= length_mod_h; 1340 if (*f == 'h') 1341 { 1342 fprintf_format += *f++; 1343 length_modifiers |= length_mod_hh; 1344 } 1345 break; 1346 1347 case 'l': // l and ll length modifiers 1348 fprintf_format += *f++; 1349 length_modifiers |= length_mod_l; 1350 if (*f == 'h') 1351 { 1352 fprintf_format += *f++; 1353 length_modifiers |= length_mod_ll; 1354 } 1355 break; 1356 1357 case 'L': fprintf_format += *f++; length_modifiers |= length_mod_L; break; 1358 case 'j': fprintf_format += *f++; length_modifiers |= length_mod_j; break; 1359 case 't': fprintf_format += *f++; length_modifiers |= length_mod_t; break; 1360 case 'z': fprintf_format += *f++; length_modifiers |= length_mod_z; break; 1361 case 'q': fprintf_format += *f++; length_modifiers |= length_mod_q; break; 1362 } 1363 1364 // Decode the conversion specifier 1365 switch (*f) 1366 { 1367 case '_': 1368 // mprintf specific format items 1369 { 1370 ++f; // Skip the '_' character 1371 switch (*f) 1372 { 1373 case 'a': // Print the current address 1374 ++f; 1375 fprintf_format += "ll"; 1376 fprintf_format += *f; // actual format to show address with folows the 'a' ("%_ax") 1377 fprintf (file, fprintf_format.c_str(), addr); 1378 break; 1379 case 'o': // offset from base address 1380 ++f; 1381 fprintf_format += "ll"; 1382 fprintf_format += *f; // actual format to show address with folows the 'a' ("%_ox") 1383 fprintf(file, fprintf_format.c_str(), addr - base_addr); 1384 break; 1385 default: 1386 fprintf (file, "error: unsupported mprintf specific format character '%c'.\n", *f); 1387 break; 1388 } 1389 continue; 1390 } 1391 break; 1392 1393 case 'D': 1394 case 'O': 1395 case 'U': 1396 fprintf_format += *f; 1397 if (byte_size == 0) 1398 byte_size = sizeof(long int); 1399 break; 1400 1401 case 'd': 1402 case 'i': 1403 case 'o': 1404 case 'u': 1405 case 'x': 1406 case 'X': 1407 fprintf_format += *f; 1408 if (byte_size == 0) 1409 { 1410 if (length_modifiers & length_mod_hh) 1411 byte_size = sizeof(char); 1412 else if (length_modifiers & length_mod_h) 1413 byte_size = sizeof(short); 1414 if (length_modifiers & length_mod_ll) 1415 byte_size = sizeof(long long); 1416 else if (length_modifiers & length_mod_l) 1417 byte_size = sizeof(long); 1418 else 1419 byte_size = sizeof(int); 1420 } 1421 break; 1422 1423 case 'a': 1424 case 'A': 1425 case 'f': 1426 case 'F': 1427 case 'e': 1428 case 'E': 1429 case 'g': 1430 case 'G': 1431 fprintf_format += *f; 1432 if (byte_size == 0) 1433 { 1434 if (length_modifiers & length_mod_L) 1435 byte_size = sizeof(long double); 1436 else 1437 byte_size = sizeof(double); 1438 } 1439 break; 1440 1441 case 'c': 1442 if ((length_modifiers & length_mod_l) == 0) 1443 { 1444 fprintf_format += *f; 1445 if (byte_size == 0) 1446 byte_size = sizeof(char); 1447 break; 1448 } 1449 // Fall through to 'C' modifier below... 1450 1451 case 'C': 1452 fprintf_format += *f; 1453 if (byte_size == 0) 1454 byte_size = sizeof(wchar_t); 1455 break; 1456 1457 case 's': 1458 fprintf_format += *f; 1459 if (is_register || byte_size == 0) 1460 is_string = 1; 1461 break; 1462 1463 case 'p': 1464 fprintf_format += *f; 1465 if (byte_size == 0) 1466 byte_size = sizeof(void*); 1467 break; 1468 } 1469 1470 if (is_string) 1471 { 1472 std::string mem_string; 1473 const size_t string_buf_len = 4; 1474 char string_buf[string_buf_len+1]; 1475 char *string_buf_end = string_buf + string_buf_len; 1476 string_buf[string_buf_len] = '\0'; 1477 nub_size_t bytes_read; 1478 nub_addr_t str_addr = is_register ? register_addr : addr; 1479 while ((bytes_read = DNBProcessMemoryRead(pid, str_addr, string_buf_len, &string_buf[0])) > 0) 1480 { 1481 // Did we get a NULL termination character yet? 1482 if (strchr(string_buf, '\0') == string_buf_end) 1483 { 1484 // no NULL terminator yet, append as a std::string 1485 mem_string.append(string_buf, string_buf_len); 1486 str_addr += string_buf_len; 1487 } 1488 else 1489 { 1490 // yep 1491 break; 1492 } 1493 } 1494 // Append as a C-string so we don't get the extra NULL 1495 // characters in the temp buffer (since it was resized) 1496 mem_string += string_buf; 1497 size_t mem_string_len = mem_string.size() + 1; 1498 fprintf(file, fprintf_format.c_str(), mem_string.c_str()); 1499 if (mem_string_len > 0) 1500 { 1501 if (!is_register) 1502 { 1503 addr += mem_string_len; 1504 total_bytes_read += mem_string_len; 1505 } 1506 } 1507 else 1508 return total_bytes_read; 1509 } 1510 else 1511 if (byte_size > 0) 1512 { 1513 buf.resize(byte_size); 1514 nub_size_t bytes_read = 0; 1515 if (is_register) 1516 bytes_read = register_value.info.size; 1517 else 1518 bytes_read = DNBProcessMemoryRead(pid, addr, buf.size(), &buf[0]); 1519 if (bytes_read > 0) 1520 { 1521 if (!is_register) 1522 total_bytes_read += bytes_read; 1523 1524 if (bytes_read == byte_size) 1525 { 1526 switch (*f) 1527 { 1528 case 'd': 1529 case 'i': 1530 case 'o': 1531 case 'u': 1532 case 'X': 1533 case 'x': 1534 case 'a': 1535 case 'A': 1536 case 'f': 1537 case 'F': 1538 case 'e': 1539 case 'E': 1540 case 'g': 1541 case 'G': 1542 case 'p': 1543 case 'c': 1544 case 'C': 1545 { 1546 if (is_register) 1547 data.SetData(®ister_value.value.v_uint8[0], register_value.info.size); 1548 else 1549 data.SetData(&buf[0], bytes_read); 1550 DNBDataRef::offset_t data_offset = 0; 1551 if (byte_size <= 4) 1552 { 1553 uint32_t u32 = data.GetMax32(&data_offset, byte_size); 1554 // Show the actual byte width when displaying hex 1555 fprintf(file, fprintf_format.c_str(), u32); 1556 } 1557 else if (byte_size <= 8) 1558 { 1559 uint64_t u64 = data.GetMax64(&data_offset, byte_size); 1560 // Show the actual byte width when displaying hex 1561 fprintf(file, fprintf_format.c_str(), u64); 1562 } 1563 else 1564 { 1565 fprintf(file, "error: integer size not supported, must be 8 bytes or less (%u bytes).\n", byte_size); 1566 } 1567 if (!is_register) 1568 addr += byte_size; 1569 } 1570 break; 1571 1572 case 's': 1573 fprintf(file, fprintf_format.c_str(), buf.c_str()); 1574 addr += byte_size; 1575 break; 1576 1577 default: 1578 fprintf(file, "error: unsupported conversion specifier '%c'.\n", *f); 1579 break; 1580 } 1581 } 1582 } 1583 } 1584 else 1585 return total_bytes_read; 1586 } 1587 break; 1588 1589 case '\\': 1590 { 1591 f++; 1592 switch (*f) 1593 { 1594 case 'e': ch = '\e'; break; 1595 case 'a': ch = '\a'; break; 1596 case 'b': ch = '\b'; break; 1597 case 'f': ch = '\f'; break; 1598 case 'n': ch = '\n'; break; 1599 case 'r': ch = '\r'; break; 1600 case 't': ch = '\t'; break; 1601 case 'v': ch = '\v'; break; 1602 case '\'': ch = '\''; break; 1603 case '\\': ch = '\\'; break; 1604 case '0': 1605 case '1': 1606 case '2': 1607 case '3': 1608 case '4': 1609 case '5': 1610 case '6': 1611 case '7': 1612 ch = strtoul(f, &end, 8); 1613 f = end; 1614 break; 1615 default: 1616 ch = *f; 1617 break; 1618 } 1619 fputc(ch, file); 1620 } 1621 break; 1622 1623 default: 1624 fputc(ch, file); 1625 break; 1626 } 1627 } 1628 return total_bytes_read; 1629 } 1630 1631 1632 //---------------------------------------------------------------------- 1633 // Get the number of threads for the specified process. 1634 //---------------------------------------------------------------------- 1635 nub_size_t 1636 DNBProcessGetNumThreads (nub_process_t pid) 1637 { 1638 MachProcessSP procSP; 1639 if (GetProcessSP (pid, procSP)) 1640 return procSP->GetNumThreads(); 1641 return 0; 1642 } 1643 1644 //---------------------------------------------------------------------- 1645 // Get the thread ID of the current thread. 1646 //---------------------------------------------------------------------- 1647 nub_thread_t 1648 DNBProcessGetCurrentThread (nub_process_t pid) 1649 { 1650 MachProcessSP procSP; 1651 if (GetProcessSP (pid, procSP)) 1652 return procSP->GetCurrentThread(); 1653 return 0; 1654 } 1655 1656 //---------------------------------------------------------------------- 1657 // Change the current thread. 1658 //---------------------------------------------------------------------- 1659 nub_thread_t 1660 DNBProcessSetCurrentThread (nub_process_t pid, nub_thread_t tid) 1661 { 1662 MachProcessSP procSP; 1663 if (GetProcessSP (pid, procSP)) 1664 return procSP->SetCurrentThread (tid); 1665 return INVALID_NUB_THREAD; 1666 } 1667 1668 1669 //---------------------------------------------------------------------- 1670 // Dump a string describing a thread's stop reason to the specified file 1671 // handle 1672 //---------------------------------------------------------------------- 1673 nub_bool_t 1674 DNBThreadGetStopReason (nub_process_t pid, nub_thread_t tid, struct DNBThreadStopInfo *stop_info) 1675 { 1676 MachProcessSP procSP; 1677 if (GetProcessSP (pid, procSP)) 1678 return procSP->GetThreadStoppedReason (tid, stop_info); 1679 return false; 1680 } 1681 1682 //---------------------------------------------------------------------- 1683 // Return string description for the specified thread. 1684 // 1685 // RETURNS: NULL if the thread isn't valid, else a NULL terminated C 1686 // string from a static buffer that must be copied prior to subsequent 1687 // calls. 1688 //---------------------------------------------------------------------- 1689 const char * 1690 DNBThreadGetInfo (nub_process_t pid, nub_thread_t tid) 1691 { 1692 MachProcessSP procSP; 1693 if (GetProcessSP (pid, procSP)) 1694 return procSP->GetThreadInfo (tid); 1695 return NULL; 1696 } 1697 1698 //---------------------------------------------------------------------- 1699 // Get the thread ID given a thread index. 1700 //---------------------------------------------------------------------- 1701 nub_thread_t 1702 DNBProcessGetThreadAtIndex (nub_process_t pid, size_t thread_idx) 1703 { 1704 MachProcessSP procSP; 1705 if (GetProcessSP (pid, procSP)) 1706 return procSP->GetThreadAtIndex (thread_idx); 1707 return INVALID_NUB_THREAD; 1708 } 1709 1710 nub_addr_t 1711 DNBProcessGetSharedLibraryInfoAddress (nub_process_t pid) 1712 { 1713 MachProcessSP procSP; 1714 DNBError err; 1715 if (GetProcessSP (pid, procSP)) 1716 return procSP->Task().GetDYLDAllImageInfosAddress (err); 1717 return INVALID_NUB_ADDRESS; 1718 } 1719 1720 1721 nub_bool_t 1722 DNBProcessSharedLibrariesUpdated(nub_process_t pid) 1723 { 1724 MachProcessSP procSP; 1725 if (GetProcessSP (pid, procSP)) 1726 { 1727 procSP->SharedLibrariesUpdated (); 1728 return true; 1729 } 1730 return false; 1731 } 1732 1733 //---------------------------------------------------------------------- 1734 // Get the current shared library information for a process. Only return 1735 // the shared libraries that have changed since the last shared library 1736 // state changed event if only_changed is non-zero. 1737 //---------------------------------------------------------------------- 1738 nub_size_t 1739 DNBProcessGetSharedLibraryInfo (nub_process_t pid, nub_bool_t only_changed, struct DNBExecutableImageInfo **image_infos) 1740 { 1741 MachProcessSP procSP; 1742 if (GetProcessSP (pid, procSP)) 1743 return procSP->CopyImageInfos (image_infos, only_changed); 1744 1745 // If we have no process, then return NULL for the shared library info 1746 // and zero for shared library count 1747 *image_infos = NULL; 1748 return 0; 1749 } 1750 1751 //---------------------------------------------------------------------- 1752 // Get the register set information for a specific thread. 1753 //---------------------------------------------------------------------- 1754 const DNBRegisterSetInfo * 1755 DNBGetRegisterSetInfo (nub_size_t *num_reg_sets) 1756 { 1757 return DNBArchProtocol::GetRegisterSetInfo (num_reg_sets); 1758 } 1759 1760 1761 //---------------------------------------------------------------------- 1762 // Read a register value by register set and register index. 1763 //---------------------------------------------------------------------- 1764 nub_bool_t 1765 DNBThreadGetRegisterValueByID (nub_process_t pid, nub_thread_t tid, uint32_t set, uint32_t reg, DNBRegisterValue *value) 1766 { 1767 MachProcessSP procSP; 1768 ::bzero (value, sizeof(DNBRegisterValue)); 1769 if (GetProcessSP (pid, procSP)) 1770 { 1771 if (tid != INVALID_NUB_THREAD) 1772 return procSP->GetRegisterValue (tid, set, reg, value); 1773 } 1774 return false; 1775 } 1776 1777 nub_bool_t 1778 DNBThreadSetRegisterValueByID (nub_process_t pid, nub_thread_t tid, uint32_t set, uint32_t reg, const DNBRegisterValue *value) 1779 { 1780 if (tid != INVALID_NUB_THREAD) 1781 { 1782 MachProcessSP procSP; 1783 if (GetProcessSP (pid, procSP)) 1784 return procSP->SetRegisterValue (tid, set, reg, value); 1785 } 1786 return false; 1787 } 1788 1789 nub_size_t 1790 DNBThreadGetRegisterContext (nub_process_t pid, nub_thread_t tid, void *buf, size_t buf_len) 1791 { 1792 MachProcessSP procSP; 1793 if (GetProcessSP (pid, procSP)) 1794 { 1795 if (tid != INVALID_NUB_THREAD) 1796 return procSP->GetThreadList().GetRegisterContext (tid, buf, buf_len); 1797 } 1798 ::bzero (buf, buf_len); 1799 return 0; 1800 1801 } 1802 1803 nub_size_t 1804 DNBThreadSetRegisterContext (nub_process_t pid, nub_thread_t tid, const void *buf, size_t buf_len) 1805 { 1806 MachProcessSP procSP; 1807 if (GetProcessSP (pid, procSP)) 1808 { 1809 if (tid != INVALID_NUB_THREAD) 1810 return procSP->GetThreadList().SetRegisterContext (tid, buf, buf_len); 1811 } 1812 return 0; 1813 } 1814 1815 //---------------------------------------------------------------------- 1816 // Read a register value by name. 1817 //---------------------------------------------------------------------- 1818 nub_bool_t 1819 DNBThreadGetRegisterValueByName (nub_process_t pid, nub_thread_t tid, uint32_t reg_set, const char *reg_name, DNBRegisterValue *value) 1820 { 1821 MachProcessSP procSP; 1822 ::bzero (value, sizeof(DNBRegisterValue)); 1823 if (GetProcessSP (pid, procSP)) 1824 { 1825 const struct DNBRegisterSetInfo *set_info; 1826 nub_size_t num_reg_sets = 0; 1827 set_info = DNBGetRegisterSetInfo (&num_reg_sets); 1828 if (set_info) 1829 { 1830 uint32_t set = reg_set; 1831 uint32_t reg; 1832 if (set == REGISTER_SET_ALL) 1833 { 1834 for (set = 1; set < num_reg_sets; ++set) 1835 { 1836 for (reg = 0; reg < set_info[set].num_registers; ++reg) 1837 { 1838 if (strcasecmp(reg_name, set_info[set].registers[reg].name) == 0) 1839 return procSP->GetRegisterValue (tid, set, reg, value); 1840 } 1841 } 1842 } 1843 else 1844 { 1845 for (reg = 0; reg < set_info[set].num_registers; ++reg) 1846 { 1847 if (strcasecmp(reg_name, set_info[set].registers[reg].name) == 0) 1848 return procSP->GetRegisterValue (tid, set, reg, value); 1849 } 1850 } 1851 } 1852 } 1853 return false; 1854 } 1855 1856 1857 //---------------------------------------------------------------------- 1858 // Read a register set and register number from the register name. 1859 //---------------------------------------------------------------------- 1860 nub_bool_t 1861 DNBGetRegisterInfoByName (const char *reg_name, DNBRegisterInfo* info) 1862 { 1863 const struct DNBRegisterSetInfo *set_info; 1864 nub_size_t num_reg_sets = 0; 1865 set_info = DNBGetRegisterSetInfo (&num_reg_sets); 1866 if (set_info) 1867 { 1868 uint32_t set, reg; 1869 for (set = 1; set < num_reg_sets; ++set) 1870 { 1871 for (reg = 0; reg < set_info[set].num_registers; ++reg) 1872 { 1873 if (strcasecmp(reg_name, set_info[set].registers[reg].name) == 0) 1874 { 1875 *info = set_info[set].registers[reg]; 1876 return true; 1877 } 1878 } 1879 } 1880 1881 for (set = 1; set < num_reg_sets; ++set) 1882 { 1883 uint32_t reg; 1884 for (reg = 0; reg < set_info[set].num_registers; ++reg) 1885 { 1886 if (set_info[set].registers[reg].alt == NULL) 1887 continue; 1888 1889 if (strcasecmp(reg_name, set_info[set].registers[reg].alt) == 0) 1890 { 1891 *info = set_info[set].registers[reg]; 1892 return true; 1893 } 1894 } 1895 } 1896 } 1897 1898 ::bzero (info, sizeof(DNBRegisterInfo)); 1899 return false; 1900 } 1901 1902 1903 //---------------------------------------------------------------------- 1904 // Set the name to address callback function that this nub can use 1905 // for any name to address lookups that are needed. 1906 //---------------------------------------------------------------------- 1907 nub_bool_t 1908 DNBProcessSetNameToAddressCallback (nub_process_t pid, DNBCallbackNameToAddress callback, void *baton) 1909 { 1910 MachProcessSP procSP; 1911 if (GetProcessSP (pid, procSP)) 1912 { 1913 procSP->SetNameToAddressCallback (callback, baton); 1914 return true; 1915 } 1916 return false; 1917 } 1918 1919 1920 //---------------------------------------------------------------------- 1921 // Set the name to address callback function that this nub can use 1922 // for any name to address lookups that are needed. 1923 //---------------------------------------------------------------------- 1924 nub_bool_t 1925 DNBProcessSetSharedLibraryInfoCallback (nub_process_t pid, DNBCallbackCopyExecutableImageInfos callback, void *baton) 1926 { 1927 MachProcessSP procSP; 1928 if (GetProcessSP (pid, procSP)) 1929 { 1930 procSP->SetSharedLibraryInfoCallback (callback, baton); 1931 return true; 1932 } 1933 return false; 1934 } 1935 1936 nub_addr_t 1937 DNBProcessLookupAddress (nub_process_t pid, const char *name, const char *shlib) 1938 { 1939 MachProcessSP procSP; 1940 if (GetProcessSP (pid, procSP)) 1941 { 1942 return procSP->LookupSymbol (name, shlib); 1943 } 1944 return INVALID_NUB_ADDRESS; 1945 } 1946 1947 1948 nub_size_t 1949 DNBProcessGetAvailableSTDOUT (nub_process_t pid, char *buf, nub_size_t buf_size) 1950 { 1951 MachProcessSP procSP; 1952 if (GetProcessSP (pid, procSP)) 1953 return procSP->GetAvailableSTDOUT (buf, buf_size); 1954 return 0; 1955 } 1956 1957 nub_size_t 1958 DNBProcessGetAvailableSTDERR (nub_process_t pid, char *buf, nub_size_t buf_size) 1959 { 1960 MachProcessSP procSP; 1961 if (GetProcessSP (pid, procSP)) 1962 return procSP->GetAvailableSTDERR (buf, buf_size); 1963 return 0; 1964 } 1965 1966 nub_size_t 1967 DNBProcessGetStopCount (nub_process_t pid) 1968 { 1969 MachProcessSP procSP; 1970 if (GetProcessSP (pid, procSP)) 1971 return procSP->StopCount(); 1972 return 0; 1973 } 1974 1975 uint32_t 1976 DNBProcessGetCPUType (nub_process_t pid) 1977 { 1978 MachProcessSP procSP; 1979 if (GetProcessSP (pid, procSP)) 1980 return procSP->GetCPUType (); 1981 return 0; 1982 1983 } 1984 1985 nub_bool_t 1986 DNBResolveExecutablePath (const char *path, char *resolved_path, size_t resolved_path_size) 1987 { 1988 if (path == NULL || path[0] == '\0') 1989 return false; 1990 1991 char max_path[PATH_MAX]; 1992 std::string result; 1993 CFString::GlobPath(path, result); 1994 1995 if (result.empty()) 1996 result = path; 1997 1998 if (realpath(path, max_path)) 1999 { 2000 // Found the path relatively... 2001 ::strncpy(resolved_path, max_path, resolved_path_size); 2002 return strlen(resolved_path) + 1 < resolved_path_size; 2003 } 2004 else 2005 { 2006 // Not a relative path, check the PATH environment variable if the 2007 const char *PATH = getenv("PATH"); 2008 if (PATH) 2009 { 2010 const char *curr_path_start = PATH; 2011 const char *curr_path_end; 2012 while (curr_path_start && *curr_path_start) 2013 { 2014 curr_path_end = strchr(curr_path_start, ':'); 2015 if (curr_path_end == NULL) 2016 { 2017 result.assign(curr_path_start); 2018 curr_path_start = NULL; 2019 } 2020 else if (curr_path_end > curr_path_start) 2021 { 2022 size_t len = curr_path_end - curr_path_start; 2023 result.assign(curr_path_start, len); 2024 curr_path_start += len + 1; 2025 } 2026 else 2027 break; 2028 2029 result += '/'; 2030 result += path; 2031 struct stat s; 2032 if (stat(result.c_str(), &s) == 0) 2033 { 2034 ::strncpy(resolved_path, result.c_str(), resolved_path_size); 2035 return result.size() + 1 < resolved_path_size; 2036 } 2037 } 2038 } 2039 } 2040 return false; 2041 } 2042 2043 2044 void 2045 DNBInitialize() 2046 { 2047 DNBLogThreadedIf (LOG_PROCESS, "DNBInitialize ()"); 2048 #if defined (__i386__) || defined (__x86_64__) 2049 DNBArchImplI386::Initialize(); 2050 DNBArchImplX86_64::Initialize(); 2051 #elif defined (__arm__) 2052 DNBArchMachARM::Initialize(); 2053 #endif 2054 } 2055 2056 void 2057 DNBTerminate() 2058 { 2059 } 2060 2061 nub_bool_t 2062 DNBSetArchitecture (const char *arch) 2063 { 2064 if (arch && arch[0]) 2065 { 2066 if (strcasecmp (arch, "i386") == 0) 2067 return DNBArchProtocol::SetArchitecture (CPU_TYPE_I386); 2068 else if (strcasecmp (arch, "x86_64") == 0) 2069 return DNBArchProtocol::SetArchitecture (CPU_TYPE_X86_64); 2070 else if (strstr (arch, "arm") == arch) 2071 return DNBArchProtocol::SetArchitecture (CPU_TYPE_ARM); 2072 } 2073 return false; 2074 } 2075