1 /* 2 * Copyright 2005-2011, Ingo Weinhold, ingo_weinhold@gmx.de. 3 * Copyright 2013, Rene Gollent, rene@gollent.com. 4 * Copyright 2015, Axel Dörfler, axeld@pinc-software.de. 5 * Distributed under the terms of the MIT License. 6 */ 7 8 9 #include <ctype.h> 10 #include <stdio.h> 11 #include <stdlib.h> 12 #include <string.h> 13 #include <strings.h> 14 #include <errno.h> 15 #include <signal.h> 16 17 #include <algorithm> 18 #include <map> 19 #include <string> 20 #include <vector> 21 22 #include <debugger.h> 23 #include <image.h> 24 #include <syscalls.h> 25 26 #include "debug_utils.h" 27 28 #include "signals.h" 29 #include "Context.h" 30 #include "MemoryReader.h" 31 #include "Syscall.h" 32 #include "TypeHandler.h" 33 34 35 using std::map; 36 using std::string; 37 using std::vector; 38 39 40 struct syscall_stats { 41 bigtime_t time; 42 uint32 count; 43 }; 44 45 46 extern void get_syscalls0(vector<Syscall*> &syscalls); 47 extern void get_syscalls1(vector<Syscall*> &syscalls); 48 extern void get_syscalls2(vector<Syscall*> &syscalls); 49 extern void get_syscalls3(vector<Syscall*> &syscalls); 50 extern void get_syscalls4(vector<Syscall*> &syscalls); 51 extern void get_syscalls5(vector<Syscall*> &syscalls); 52 extern void get_syscalls6(vector<Syscall*> &syscalls); 53 extern void get_syscalls7(vector<Syscall*> &syscalls); 54 extern void get_syscalls8(vector<Syscall*> &syscalls); 55 extern void get_syscalls9(vector<Syscall*> &syscalls); 56 extern void get_syscalls10(vector<Syscall*> &syscalls); 57 extern void get_syscalls11(vector<Syscall*> &syscalls); 58 extern void get_syscalls12(vector<Syscall*> &syscalls); 59 extern void get_syscalls13(vector<Syscall*> &syscalls); 60 extern void get_syscalls14(vector<Syscall*> &syscalls); 61 extern void get_syscalls15(vector<Syscall*> &syscalls); 62 extern void get_syscalls16(vector<Syscall*> &syscalls); 63 extern void get_syscalls17(vector<Syscall*> &syscalls); 64 extern void get_syscalls18(vector<Syscall*> &syscalls); 65 extern void get_syscalls19(vector<Syscall*> &syscalls); 66 67 68 extern const char *__progname; 69 static const char *kCommandName = __progname; 70 71 72 // usage 73 static const char *kUsage = 74 "Usage: %s [ <options> ] [ <thread or team ID> | <executable with args> ]\n" 75 "\n" 76 "Traces the syscalls of a thread or a team. If an executable with\n" 77 "arguments is supplied, it is loaded and it's main thread traced.\n" 78 "\n" 79 "Options:\n" 80 " -a - Don't print syscall arguments.\n" 81 " -c - Record and dump syscall usage statistics.\n" 82 " -C - Same as -c, but also print syscalls as usual.\n" 83 " -d <name> - Filter the types that have their contents retrieved.\n" 84 " <name> is one of: strings, enums, simple, complex or\n" 85 " pointer_values\n" 86 " -e <names> - Filter the syscalls.\n" 87 " <names> is a comma-separated list of names which can be:\n" 88 " * a syscall name\n" 89 " * %%memory for memory mapping related syscalls\n" 90 " * %%network or %%net for network related syscalls\n" 91 " -f - Fast mode. Syscall arguments contents aren't retrieved.\n" 92 " -h, --help - Print this text.\n" 93 " -i - Print integers in decimal format instead of hexadecimal.\n" 94 " -l - Also trace loading the executable. Only considered when\n" 95 " an executable is provided.\n" 96 " --no-color - Don't colorize output.\n" 97 " -r - Don't print syscall return values.\n" 98 " -s - Also trace all threads spawned by the supplied thread,\n" 99 " respectively the loaded executable's main thread.\n" 100 " -t - Also recursively trace all teams created by a traced\n" 101 " thread or team.\n" 102 " -T - Trace all threads of the supplied or loaded executable's\n" 103 " team. If an ID is supplied, it is interpreted as a team\n" 104 " ID.\n" 105 " -o <file> - directs output into the specified file.\n" 106 " -S - prints output to serial debug line.\n" 107 " -g - turns off signal tracing.\n" 108 ; 109 110 111 // terminal color escape sequences 112 // (http://www.dee.ufcg.edu.br/~rrbrandt/tools/ansi.html) 113 static const char *kTerminalTextNormal = "\33[0m"; 114 static const char *kTerminalTextRed = "\33[31m"; 115 static const char *kTerminalTextMagenta = "\33[35m"; 116 static const char *kTerminalTextBlue = "\33[34m"; 117 118 119 // command line args 120 static int sArgc; 121 static const char *const *sArgv; 122 123 // syscalls 124 static vector<Syscall*> sSyscallVector; 125 static map<string, Syscall*> sSyscallMap; 126 127 // statistics 128 typedef map<string, syscall_stats> StatsMap; 129 static StatsMap sSyscallStats; 130 static bigtime_t sSyscallTime; 131 132 133 struct Team { 134 Team(team_id id) 135 : 136 fID(id), 137 fNubPort(-1) 138 { 139 } 140 141 team_id ID() const 142 { 143 return fID; 144 } 145 146 port_id NubPort() const 147 { 148 return fNubPort; 149 } 150 151 MemoryReader& GetMemoryReader() 152 { 153 return fMemoryReader; 154 } 155 156 status_t InstallDebugger(port_id debuggerPort, bool traceTeam, 157 bool traceChildTeams, bool traceSignal) 158 { 159 fNubPort = install_team_debugger(fID, debuggerPort); 160 if (fNubPort < 0) { 161 fprintf(stderr, "%s: Failed to install team debugger: %s\n", 162 kCommandName, strerror(fNubPort)); 163 return fNubPort; 164 } 165 166 // set team debugging flags 167 int32 teamDebugFlags = 168 (traceTeam ? B_TEAM_DEBUG_PRE_SYSCALL | B_TEAM_DEBUG_POST_SYSCALL : 0) 169 | (traceChildTeams ? B_TEAM_DEBUG_TEAM_CREATION : 0) 170 | (traceSignal ? B_TEAM_DEBUG_SIGNALS : 0); 171 if (set_team_debugging_flags(fNubPort, teamDebugFlags) != B_OK) 172 exit(1); 173 174 return fMemoryReader.Init(fNubPort); 175 } 176 177 private: 178 team_id fID; 179 port_id fNubPort; 180 MemoryReader fMemoryReader; 181 }; 182 183 184 static void 185 print_usage(bool error) 186 { 187 // print usage 188 fprintf((error ? stderr : stdout), kUsage, kCommandName); 189 } 190 191 192 static void 193 print_usage_and_exit(bool error) 194 { 195 print_usage(error); 196 exit(error ? 1 : 0); 197 } 198 199 200 static bool 201 get_id(const char *str, int32 &id) 202 { 203 int32 len = strlen(str); 204 for (int32 i = 0; i < len; i++) { 205 if (!isdigit(str[i])) 206 return false; 207 } 208 209 id = atol(str); 210 return true; 211 } 212 213 214 Syscall * 215 get_syscall(const char *name) 216 { 217 map<string, Syscall *>::const_iterator i = sSyscallMap.find(name); 218 if (i == sSyscallMap.end()) 219 return NULL; 220 221 return i->second; 222 } 223 224 225 static void 226 patch_syscalls() 227 { 228 // instead of having this done here manually we should either add the 229 // patching step to gensyscalls also manually or add metadata to 230 // kernel/syscalls.h and have it parsed automatically 231 232 extern void patch_area(); 233 extern void patch_fcntl(); 234 extern void patch_ioctl(); 235 extern void patch_network(); 236 237 for (size_t i = 0; i < sSyscallVector.size(); i++) { 238 Syscall *syscall = sSyscallVector[i]; 239 240 // patch return type handlers 241 const string returnTypeName = syscall->ReturnType()->TypeName(); 242 if (returnTypeName == "status_t" || returnTypeName == "ssize_t" 243 || returnTypeName == "int") { 244 syscall->ReturnType()->SetHandler(create_status_t_type_handler()); 245 } 246 } 247 248 patch_area(); 249 patch_fcntl(); 250 patch_ioctl(); 251 patch_network(); 252 } 253 254 255 static void 256 init_syscalls() 257 { 258 // init the syscall vector 259 get_syscalls0(sSyscallVector); 260 get_syscalls1(sSyscallVector); 261 get_syscalls2(sSyscallVector); 262 get_syscalls3(sSyscallVector); 263 get_syscalls4(sSyscallVector); 264 get_syscalls5(sSyscallVector); 265 get_syscalls6(sSyscallVector); 266 get_syscalls7(sSyscallVector); 267 get_syscalls8(sSyscallVector); 268 get_syscalls9(sSyscallVector); 269 get_syscalls10(sSyscallVector); 270 get_syscalls11(sSyscallVector); 271 get_syscalls12(sSyscallVector); 272 get_syscalls13(sSyscallVector); 273 get_syscalls14(sSyscallVector); 274 get_syscalls15(sSyscallVector); 275 get_syscalls16(sSyscallVector); 276 get_syscalls17(sSyscallVector); 277 get_syscalls18(sSyscallVector); 278 get_syscalls19(sSyscallVector); 279 280 // init the syscall map 281 int32 count = sSyscallVector.size(); 282 for (int32 i = 0; i < count; i++) { 283 Syscall *syscall = sSyscallVector[i]; 284 sSyscallMap[syscall->Name()] = syscall; 285 } 286 287 patch_syscalls(); 288 } 289 290 291 static void 292 record_syscall_stats(const Syscall& syscall, debug_post_syscall& message) 293 { 294 syscall_stats& stats = sSyscallStats[syscall.Name()]; 295 stats.count++; 296 297 bigtime_t time = message.end_time - message.start_time; 298 stats.time += time; 299 sSyscallTime += time; 300 } 301 302 303 static void 304 print_buffer(FILE *outputFile, char* buffer, int32 length) 305 { 306 // output either to file or serial debug line 307 if (outputFile != NULL) 308 fwrite(buffer, length, 1, outputFile); 309 else 310 _kern_debug_output(buffer); 311 } 312 313 314 static void 315 print_to_string(char **_buffer, int32 *_length, const char *format, ...) 316 { 317 va_list list; 318 va_start(list, format); 319 ssize_t length = vsnprintf(*_buffer, *_length, format, list); 320 va_end(list); 321 322 *_buffer += length; 323 *_length -= length; 324 } 325 326 327 static void 328 print_syscall(FILE *outputFile, Syscall* syscall, debug_pre_syscall &message, 329 MemoryReader &memoryReader, bool printArguments, uint32 contentsFlags, 330 bool colorize, bool decimal, thread_id ¤tThreadID) 331 { 332 char buffer[4096], *string = buffer; 333 int32 length = (int32)sizeof(buffer); 334 335 Context ctx(syscall, (char *)message.args, memoryReader, 336 contentsFlags | Context::INPUT_VALUES, decimal); 337 338 if (currentThreadID != message.origin.thread) { 339 if (currentThreadID != -1) 340 print_to_string(&string, &length, " <unfinished ...>\n"); 341 currentThreadID = message.origin.thread; 342 } 343 344 // print syscall name, without the "_kern_" 345 if (colorize) { 346 print_to_string(&string, &length, "[%6" B_PRId32 "] %s%s%s", 347 message.origin.thread, kTerminalTextBlue, 348 syscall->Name().c_str() + 6, kTerminalTextNormal); 349 } else { 350 print_to_string(&string, &length, "[%6" B_PRId32 "] %s", 351 message.origin.thread, syscall->Name().c_str() + 6); 352 } 353 354 // print arguments 355 if (printArguments) { 356 print_to_string(&string, &length, "("); 357 358 int32 count = syscall->CountParameters(); 359 for (int32 i = 0; i < count; i++) { 360 // get the value 361 Parameter *parameter = syscall->ParameterAt(i); 362 if (parameter->Out()) 363 continue; 364 TypeHandler *handler = parameter->Handler(); 365 ::string value = 366 handler->GetParameterValue(ctx, parameter, 367 ctx.GetValue(parameter)); 368 369 print_to_string(&string, &length, (i > 0 ? ", %s" : "%s"), 370 value.c_str()); 371 } 372 373 print_to_string(&string, &length, ")"); 374 } 375 376 print_buffer(outputFile, buffer, sizeof(buffer) - length); 377 } 378 379 380 static void 381 print_syscall(FILE *outputFile, Syscall* syscall, debug_post_syscall &message, 382 MemoryReader &memoryReader, bool printArguments, uint32 contentsFlags, 383 bool printReturnValue, bool colorize, bool decimal, 384 thread_id ¤tThreadID) 385 { 386 char buffer[4096], *string = buffer; 387 int32 length = (int32)sizeof(buffer); 388 bool threadChanged = false; 389 390 Context ctx(syscall, (char *)message.args, memoryReader, 391 contentsFlags | Context::OUTPUT_VALUES, decimal, message.return_value); 392 393 if (currentThreadID != message.origin.thread) { 394 if (currentThreadID != -1) { 395 print_to_string(&string, &length, " <unfinished ...>\n"); 396 } 397 threadChanged = true; 398 } 399 currentThreadID = -1; 400 401 // print return value 402 if (printReturnValue) { 403 if (threadChanged) { 404 // print syscall name, without the "_kern_" 405 if (colorize) { 406 print_to_string(&string, &length, "[%6" B_PRId32 "] <... " 407 "%s%s%s resumed> ", message.origin.thread, kTerminalTextBlue, 408 syscall->Name().c_str() + 6, kTerminalTextNormal); 409 } else { 410 print_to_string(&string, &length, "[%6" B_PRId32 "] <... %s" 411 " resumed> ", message.origin.thread, 412 syscall->Name().c_str() + 6); 413 } 414 } 415 416 Type *returnType = syscall->ReturnType(); 417 TypeHandler *handler = returnType->Handler(); 418 ::string value = handler->GetReturnValue(ctx, message.return_value); 419 if (value.length() > 0) 420 print_to_string(&string, &length, " = %s", value.c_str()); 421 } 422 423 // print arguments 424 if (printArguments) { 425 int32 count = syscall->CountParameters(); 426 int added = 0; 427 bool printedParen = false; 428 for (int32 i = 0; i < count; i++) { 429 // get the value 430 Parameter *parameter = syscall->ParameterAt(i); 431 if (!parameter->InOut() && !parameter->Out()) 432 continue; 433 434 TypeHandler *handler = parameter->Handler(); 435 ::string value = 436 handler->GetParameterValue(ctx, parameter, 437 ctx.GetValue(parameter)); 438 439 if (!printedParen) { 440 print_to_string(&string, &length, " ("); 441 printedParen = true; 442 } 443 print_to_string(&string, &length, (added > 0 ? ", %s" : "%s"), 444 value.c_str()); 445 added++; 446 } 447 if (printedParen) 448 print_to_string(&string, &length, ")"); 449 } 450 451 if (colorize) { 452 print_to_string(&string, &length, " %s(%lld us)%s\n", kTerminalTextMagenta, 453 message.end_time - message.start_time, kTerminalTextNormal); 454 } else { 455 print_to_string(&string, &length, " (%lld us)\n", 456 message.end_time - message.start_time); 457 } 458 459 //for (int32 i = 0; i < 16; i++) { 460 // if (i % 4 == 0) { 461 // if (i > 0) 462 // printf("\n"); 463 // printf(" "); 464 // } else 465 // printf(" "); 466 // printf("%08lx", message.args[i]); 467 //} 468 //printf("\n"); 469 print_buffer(outputFile, buffer, sizeof(buffer) - length); 470 } 471 472 473 static void 474 print_signal(FILE *outputFile, debug_signal_received &message, 475 bool colorize) 476 { 477 char buffer[4096], *string = buffer; 478 int32 length = (int32)sizeof(buffer); 479 int signalNumber = message.signal; 480 481 // print signal name 482 if (colorize) { 483 print_to_string(&string, &length, "[%6" B_PRId32 "] --- %s%s (%s)%s %s ---\n", 484 message.origin.thread, kTerminalTextRed, 485 signal_name(signalNumber).c_str(), strsignal(signalNumber), 486 kTerminalTextNormal, signal_info(message.info).c_str()); 487 } else { 488 print_to_string(&string, &length, "[%6" B_PRId32 "] --- %s (%s) %s ---\n", 489 message.origin.thread, signal_name(signalNumber).c_str(), 490 strsignal(signalNumber), signal_info(message.info).c_str()); 491 } 492 493 print_buffer(outputFile, buffer, sizeof(buffer) - length); 494 } 495 496 497 static bool 498 compare_stats_by_time( 499 const std::pair<const std::string*, const syscall_stats*>& a, 500 const std::pair<const std::string*, const syscall_stats*>& b) 501 { 502 return a.second->time > b.second->time; 503 } 504 505 506 static void 507 print_stats(FILE* outputFile) 508 { 509 char buffer[4096], *string = buffer; 510 int32 length = (int32)sizeof(buffer); 511 512 typedef std::vector<std::pair<const std::string*, const syscall_stats*> > 513 StatsRefVector; 514 StatsRefVector calls; 515 StatsMap::const_iterator iterator = sSyscallStats.begin(); 516 for (; iterator != sSyscallStats.end(); iterator++) 517 calls.push_back(std::make_pair(&iterator->first, &iterator->second)); 518 519 // Sort calls by time spent 520 std::sort(calls.begin(), calls.end(), compare_stats_by_time); 521 522 print_to_string(&string, &length, "\n%-6s %-10s %-7s %-10s Syscall\n", 523 "Time %", "Usecs", "Calls", "Usecs/call"); 524 print_to_string(&string, &length, "------ ---------- ------- ---------- " 525 "--------------------\n"); 526 527 StatsRefVector::const_iterator callIterator = calls.begin(); 528 for (; callIterator != calls.end(); callIterator++) { 529 const syscall_stats& stats = *callIterator->second; 530 double percent = stats.time * 100.0 / sSyscallTime; 531 bigtime_t perCall = stats.time / stats.count; 532 533 print_to_string(&string, &length, "%6.2f %10" B_PRIu64 " %7" B_PRIu32 534 " %10" B_PRIu64 " %s\n", percent, stats.time, stats.count, perCall, 535 callIterator->first->c_str()); 536 } 537 538 print_buffer(outputFile, buffer, sizeof(buffer) - length); 539 } 540 541 542 int 543 main(int argc, const char *const *argv) 544 { 545 sArgc = argc; 546 sArgv = argv; 547 548 // parameters 549 const char *const *programArgs = NULL; 550 int32 programArgCount = 0; 551 bool printArguments = true; 552 bool colorize = true; 553 bool stats = false; 554 bool trace = true; 555 uint32 contentsFlags = 0; 556 bool decimalFormat = false; 557 bool fastMode = false; 558 bool traceLoading = false; 559 bool printReturnValues = true; 560 bool traceChildThreads = false; 561 bool traceTeam = false; 562 bool traceChildTeams = false; 563 bool traceSignal = true; 564 bool traceFilter = false; 565 FILE *outputFile = stdout; 566 567 // initialize our syscalls vector and map 568 init_syscalls(); 569 570 // parse arguments 571 for (int argi = 1; argi < argc; argi++) { 572 const char *arg = argv[argi]; 573 if (arg[0] == '-') { 574 // ToDo: improve option parsing so that ie. "-rsf" would also work 575 if (strcmp(arg, "-h") == 0 || strcmp(arg, "--help") == 0) { 576 print_usage_and_exit(false); 577 } else if (strcmp(arg, "-a") == 0) { 578 printArguments = false; 579 } else if (strcmp(arg, "-c") == 0) { 580 stats = true; 581 trace = false; 582 } else if (strcmp(arg, "-C") == 0) { 583 stats = true; 584 } else if (strcmp(arg, "--no-color") == 0) { 585 colorize = false; 586 } else if (strcmp(arg, "-d") == 0) { 587 const char *what = NULL; 588 589 if (arg[2] == '\0' 590 && argi + 1 < argc && argv[argi + 1][0] != '-') { 591 // next arg is what 592 what = argv[++argi]; 593 } else 594 print_usage_and_exit(true); 595 596 if (strcasecmp(what, "strings") == 0) 597 contentsFlags |= Context::STRINGS; 598 else if (strcasecmp(what, "enums") == 0) 599 contentsFlags |= Context::ENUMERATIONS; 600 else if (strcasecmp(what, "simple") == 0) 601 contentsFlags |= Context::SIMPLE_STRUCTS; 602 else if (strcasecmp(what, "complex") == 0) 603 contentsFlags |= Context::COMPLEX_STRUCTS; 604 else if (strcasecmp(what, "pointer_values") == 0) 605 contentsFlags |= Context::POINTER_VALUES; 606 else { 607 fprintf(stderr, "%s: Unknown content filter `%s'\n", 608 kCommandName, what); 609 exit(1); 610 } 611 } else if (strcmp(arg, "-e") == 0) { 612 traceFilter = true; 613 // read filter string 614 const char *filterString = NULL; 615 if (arg[2] == '=') { 616 // string follows 617 filterString = arg + 3; 618 } else if (arg[2] == '\0' 619 && argi + 1 < argc && argv[argi + 1][0] != '-') { 620 // next arg is string 621 filterString = argv[++argi]; 622 } else 623 print_usage_and_exit(true); 624 if (filterString != NULL) { 625 char* copy = strdup(filterString); 626 char *tok = strtok(copy, ","); 627 while (tok != NULL) { 628 if (tok[0] == '%') { 629 tok++; 630 // the following should be metadata in kernel/syscalls.h 631 if (strcmp(tok, "memory") == 0) { 632 sSyscallMap["_kern_clone_area"]->EnableTracing(true); 633 sSyscallMap["_kern_create_area"]->EnableTracing(true); 634 sSyscallMap["_kern_delete_area"]->EnableTracing(true); 635 sSyscallMap["_kern_find_area"]->EnableTracing(true); 636 sSyscallMap["_kern_resize_area"]->EnableTracing(true); 637 sSyscallMap["_kern_transfer_area"]->EnableTracing(true); 638 sSyscallMap["_kern_mlock"]->EnableTracing(true); 639 sSyscallMap["_kern_munlock"]->EnableTracing(true); 640 sSyscallMap["_kern_set_memory_protection"]->EnableTracing(true); 641 sSyscallMap["_kern_get_memory_properties"]->EnableTracing(true); 642 sSyscallMap["_kern_sync_memory"]->EnableTracing(true); 643 sSyscallMap["_kern_unmap_memory"]->EnableTracing(true); 644 sSyscallMap["_kern_memory_advice"]->EnableTracing(true); 645 sSyscallMap["_kern_reserve_address_range"]->EnableTracing(true); 646 sSyscallMap["_kern_unreserve_address_range"]->EnableTracing(true); 647 sSyscallMap["_kern_set_area_protection"]->EnableTracing(true); 648 sSyscallMap["_kern_map_file"]->EnableTracing(true); 649 } else if (strcmp(tok, "network") == 0 || strcmp(tok, "net") == 0) { 650 sSyscallMap["_kern_socket"]->EnableTracing(true); 651 sSyscallMap["_kern_bind"]->EnableTracing(true); 652 sSyscallMap["_kern_shutdown_socket"]->EnableTracing(true); 653 sSyscallMap["_kern_connect"]->EnableTracing(true); 654 sSyscallMap["_kern_listen"]->EnableTracing(true); 655 sSyscallMap["_kern_accept"]->EnableTracing(true); 656 sSyscallMap["_kern_recv"]->EnableTracing(true); 657 sSyscallMap["_kern_recvfrom"]->EnableTracing(true); 658 sSyscallMap["_kern_recvmsg"]->EnableTracing(true); 659 sSyscallMap["_kern_send"]->EnableTracing(true); 660 sSyscallMap["_kern_sendto"]->EnableTracing(true); 661 sSyscallMap["_kern_sendmsg"]->EnableTracing(true); 662 sSyscallMap["_kern_getsockopt"]->EnableTracing(true); 663 sSyscallMap["_kern_setsockopt"]->EnableTracing(true); 664 sSyscallMap["_kern_getpeername"]->EnableTracing(true); 665 sSyscallMap["_kern_getsockname"]->EnableTracing(true); 666 sSyscallMap["_kern_sockatmark"]->EnableTracing(true); 667 sSyscallMap["_kern_socketpair"]->EnableTracing(true); 668 sSyscallMap["_kern_get_next_socket_stat"]->EnableTracing(true); 669 } else 670 print_usage_and_exit(true); 671 } else { 672 char buffer[64]; 673 snprintf(buffer, sizeof(buffer), "_kern_%s", tok); 674 Syscall* syscall = get_syscall(buffer); 675 if (syscall == NULL) 676 print_usage_and_exit(true); 677 syscall->EnableTracing(true); 678 } 679 tok = strtok(NULL, ","); 680 } 681 free(copy); 682 } 683 } else if (strcmp(arg, "-f") == 0) { 684 fastMode = true; 685 } else if (strcmp(arg, "-i") == 0) { 686 decimalFormat = true; 687 } else if (strcmp(arg, "-l") == 0) { 688 traceLoading = true; 689 } else if (strcmp(arg, "-r") == 0) { 690 printReturnValues = false; 691 } else if (strcmp(arg, "-s") == 0) { 692 traceChildThreads = true; 693 } else if (strcmp(arg, "-t") == 0) { 694 traceChildTeams = true; 695 } else if (strcmp(arg, "-T") == 0) { 696 traceTeam = true; 697 } else if (strcmp(arg, "-g") == 0) { 698 traceSignal = false; 699 } else if (strcmp(arg, "-S") == 0) { 700 outputFile = NULL; 701 } else if (strncmp(arg, "-o", 2) == 0) { 702 // read filename 703 const char *filename = NULL; 704 if (arg[2] == '=') { 705 // name follows 706 filename = arg + 3; 707 } else if (arg[2] == '\0' 708 && argi + 1 < argc && argv[argi + 1][0] != '-') { 709 // next arg is name 710 filename = argv[++argi]; 711 } else 712 print_usage_and_exit(true); 713 714 outputFile = fopen(filename, "w+"); 715 if (outputFile == NULL) { 716 fprintf(stderr, "%s: Could not open `%s': %s\n", 717 kCommandName, filename, strerror(errno)); 718 exit(1); 719 } 720 } else { 721 print_usage_and_exit(true); 722 } 723 } else { 724 programArgs = argv + argi; 725 programArgCount = argc - argi; 726 break; 727 } 728 } 729 730 // check parameters 731 if (!programArgs) 732 print_usage_and_exit(true); 733 734 if (fastMode) 735 contentsFlags = 0; 736 else if (contentsFlags == 0) 737 contentsFlags = Context::ALL; 738 739 // don't colorize the output, if we don't have a terminal 740 if (outputFile == stdout) 741 colorize = colorize && isatty(STDOUT_FILENO); 742 else if (outputFile) 743 colorize = false; 744 745 // get thread/team to be debugged 746 thread_id threadID = -1; 747 team_id teamID = -1; 748 if (programArgCount > 1 749 || !get_id(*programArgs, (traceTeam ? teamID : threadID))) { 750 // we've been given an executable and need to load it 751 threadID = load_program(programArgs, programArgCount, traceLoading); 752 if (threadID < 0) { 753 fprintf(stderr, "%s: Failed to start `%s': %s\n", kCommandName, 754 programArgs[0], strerror(threadID)); 755 exit(1); 756 } 757 } 758 759 // get the team ID, if we have none yet 760 if (teamID < 0) { 761 thread_info threadInfo; 762 status_t error = get_thread_info(threadID, &threadInfo); 763 if (error != B_OK) { 764 fprintf(stderr, "%s: Failed to get info for thread %" B_PRId32 765 ": %s\n", kCommandName, threadID, strerror(error)); 766 exit(1); 767 } 768 teamID = threadInfo.team; 769 } 770 771 // create a debugger port 772 port_id debuggerPort = create_port(10, "debugger port"); 773 if (debuggerPort < 0) { 774 fprintf(stderr, "%s: Failed to create debugger port: %s\n", 775 kCommandName, strerror(debuggerPort)); 776 exit(1); 777 } 778 779 // install ourselves as the team debugger 780 typedef map<team_id, Team*> TeamMap; 781 TeamMap debuggedTeams; 782 port_id nubPort; 783 784 { 785 Team* team = new Team(teamID); 786 status_t error = team->InstallDebugger(debuggerPort, traceTeam, 787 traceChildTeams, traceSignal); 788 if (error != B_OK) 789 exit(1); 790 791 debuggedTeams[team->ID()] = team; 792 793 nubPort = team->NubPort(); 794 } 795 796 // set thread debugging flags 797 if (threadID >= 0) { 798 int32 threadDebugFlags = 0; 799 if (!traceTeam) { 800 threadDebugFlags = B_THREAD_DEBUG_PRE_SYSCALL | B_THREAD_DEBUG_POST_SYSCALL 801 | (traceChildThreads 802 ? B_THREAD_DEBUG_SYSCALL_TRACE_CHILD_THREADS : 0); 803 } 804 if (set_thread_debugging_flags(nubPort, threadID, threadDebugFlags) 805 != B_OK) { 806 exit(1); 807 } 808 809 // resume the target thread to be sure, it's running 810 resume_thread(threadID); 811 } 812 813 thread_id currentThreadID = -1; 814 815 // debug loop 816 while (true) { 817 bool quitLoop = false; 818 int32 code; 819 debug_debugger_message_data message; 820 ssize_t messageSize = read_port(debuggerPort, &code, &message, 821 sizeof(message)); 822 823 if (messageSize < 0) { 824 if (messageSize == B_INTERRUPTED) 825 continue; 826 827 fprintf(stderr, "%s: Reading from debugger port failed: %s\n", 828 kCommandName, strerror(messageSize)); 829 exit(1); 830 } 831 832 switch (code) { 833 case B_DEBUGGER_MESSAGE_PRE_SYSCALL: 834 { 835 TeamMap::iterator it = debuggedTeams.find(message.origin.team); 836 if (it == debuggedTeams.end()) 837 break; 838 839 Team* team = it->second; 840 MemoryReader& memoryReader = team->GetMemoryReader(); 841 842 uint32 syscallNumber = message.pre_syscall.syscall; 843 if (syscallNumber >= sSyscallVector.size()) { 844 fprintf(stderr, "%s: invalid syscall %" B_PRIu32 " attempted\n", 845 kCommandName, syscallNumber); 846 break; 847 } 848 Syscall* syscall = sSyscallVector[syscallNumber]; 849 850 if (trace) { 851 if (traceFilter && !syscall->TracingEnabled()) 852 break; 853 print_syscall(outputFile, syscall, message.pre_syscall, 854 memoryReader, printArguments, contentsFlags, 855 colorize, decimalFormat, currentThreadID); 856 } 857 break; 858 } 859 860 case B_DEBUGGER_MESSAGE_POST_SYSCALL: 861 { 862 TeamMap::iterator it = debuggedTeams.find(message.origin.team); 863 if (it == debuggedTeams.end()) 864 break; 865 866 Team* team = it->second; 867 MemoryReader& memoryReader = team->GetMemoryReader(); 868 869 uint32 syscallNumber = message.post_syscall.syscall; 870 if (syscallNumber >= sSyscallVector.size()) { 871 fprintf(stderr, "%s: invalid syscall %" B_PRIu32 " attempted\n", 872 kCommandName, syscallNumber); 873 break; 874 } 875 Syscall* syscall = sSyscallVector[syscallNumber]; 876 877 if (stats) 878 record_syscall_stats(*syscall, message.post_syscall); 879 880 if (trace) { 881 if (traceFilter && !syscall->TracingEnabled()) 882 break; 883 print_syscall(outputFile, syscall, message.post_syscall, 884 memoryReader, printArguments, contentsFlags, 885 printReturnValues, colorize, decimalFormat, 886 currentThreadID); 887 } 888 break; 889 } 890 891 case B_DEBUGGER_MESSAGE_SIGNAL_RECEIVED: 892 { 893 if (traceSignal && trace) 894 print_signal(outputFile, message.signal_received, colorize); 895 break; 896 } 897 898 case B_DEBUGGER_MESSAGE_THREAD_DEBUGGED: 899 case B_DEBUGGER_MESSAGE_DEBUGGER_CALL: 900 case B_DEBUGGER_MESSAGE_BREAKPOINT_HIT: 901 case B_DEBUGGER_MESSAGE_WATCHPOINT_HIT: 902 case B_DEBUGGER_MESSAGE_SINGLE_STEP: 903 case B_DEBUGGER_MESSAGE_EXCEPTION_OCCURRED: 904 case B_DEBUGGER_MESSAGE_THREAD_CREATED: 905 case B_DEBUGGER_MESSAGE_THREAD_DELETED: 906 case B_DEBUGGER_MESSAGE_IMAGE_CREATED: 907 case B_DEBUGGER_MESSAGE_IMAGE_DELETED: 908 break; 909 910 case B_DEBUGGER_MESSAGE_TEAM_CREATED: 911 { 912 if (!traceChildTeams) 913 break; 914 915 Team* team = new(std::nothrow) Team( 916 message.team_created.new_team); 917 if (team == NULL) { 918 fprintf(stderr, "%s: Out of memory!\n", kCommandName); 919 break; 920 } 921 922 status_t error = team->InstallDebugger(debuggerPort, true, true, 923 traceSignal); 924 if (error != B_OK) { 925 delete team; 926 break; 927 } 928 929 debuggedTeams[team->ID()] = team; 930 break; 931 } 932 933 case B_DEBUGGER_MESSAGE_TEAM_DELETED: 934 { 935 // a debugged team is gone 936 TeamMap::iterator it = debuggedTeams.find(message.origin.team); 937 if (it == debuggedTeams.end()) 938 break; 939 940 Team* team = it->second; 941 debuggedTeams.erase(it); 942 delete team; 943 944 // if all debugged teams are gone, we're done 945 quitLoop = debuggedTeams.empty(); 946 break; 947 } 948 } 949 950 if (quitLoop) 951 break; 952 953 // tell the thread to continue (only when there is a thread and the 954 // message was synchronous) 955 if (message.origin.thread >= 0 && message.origin.nub_port >= 0) { 956 if (continue_thread(message.origin.nub_port, 957 message.origin.thread) != B_OK) { 958 // the team can already be gone 959 } 960 } 961 } 962 963 if (stats) { 964 // Dump recorded statistics 965 print_stats(outputFile); 966 } 967 968 if (outputFile != NULL && outputFile != stdout) 969 fclose(outputFile); 970 971 return 0; 972 } 973