src/runtime/monitor.c

   1 /*
   2  * This software is part of the SBCL system. See the README file for
   3  * more information.
   4  *
   5  * This software is derived from the CMU CL system, which was
   6  * written at Carnegie Mellon University and released into the
   7  * public domain. The software is in the public domain and is
   8  * provided with absolutely no warranty. See the COPYING and CREDITS
   9  * files for more information.
  10  */
  11
  12 #include <stdio.h>
  13 #include <sys/types.h>
  14 #include <stdlib.h>
  15 #include <setjmp.h>
  16 #include <sys/time.h>
  17 #include <sys/resource.h>
  18 #include <signal.h>
  19 #include <unistd.h>
  20
  21 #include "runtime.h"
  22 #include "sbcl.h"
  23
  24 /* Almost all of this file can be skipped if we're not supporting LDB. */
  25 #if defined(LISP_FEATURE_SB_LDB)
  26
  27 #include "print.h"
  28 #include "arch.h"
  29 #include "interr.h"
  30 #include "gc.h"
  31 #include "search.h"
  32 #include "purify.h"
  33
  34 /* When we need to do command input, we use this stream, which is not
  35  * in general stdin, so that things will "work" (as well as being
  36  * thrown into ldb can be considered "working":-) even in a process
  37  * where standard input has been redirected to a file or pipe.
  38  *
  39  * (We could set up output to go to a special ldb_out stream for the
  40  * same reason, but there's been no pressure for that so far.)
  41  *
  42  * The enter-the-ldb-monitor function is responsible for setting up
  43  * this stream. */
  44 static FILE *ldb_in = 0;
  45 static int ldb_in_fd = -1;
  46
  47 typedef void cmd(char **ptr);
  48
  49 static cmd call_cmd, dump_cmd, print_cmd, quit_cmd, help_cmd;
  50 static cmd flush_cmd, search_cmd, regs_cmd, exit_cmd;
  51 static cmd print_context_cmd;
  52 static cmd backtrace_cmd, purify_cmd, catchers_cmd;
  53 static cmd grab_sigs_cmd;
  54 static cmd kill_cmd;
  55
  56 static struct cmd {
  57     char *cmd, *help;
  58     void (*fn)(char **ptr);
  59 } supported_cmds[] = {
  60     {"help", "Display this help information.", help_cmd},
  61     {"?", "(an alias for help)", help_cmd},
  62     {"backtrace", "Backtrace up to N frames.", backtrace_cmd},
  63     {"call", "Call FUNCTION with ARG1, ARG2, ...", call_cmd},
  64     {"catchers", "Print a list of all the active catchers.", catchers_cmd},
  65     {"context", "Print interrupt context number I.", print_context_cmd},
  66     {"dump", "Dump memory starting at ADDRESS for COUNT words.", dump_cmd},
  67     {"d", "(an alias for dump)", dump_cmd},
  68     {"exit", "Exit this instance of the monitor.", exit_cmd},
  69     {"flush", "Flush all temp variables.", flush_cmd},
  70     /* (Classic CMU CL had a "gc" command here, which seems like a
  71      * reasonable idea, but the code was stale (incompatible with
  72      * gencgc) so I just flushed it. -- WHN 20000814 */
  73     {"grab-signals", "Set the signal handlers to call LDB.", grab_sigs_cmd},
  74     {"kill", "Kill ourself with signal number N (useful if running under gdb)",
  75      kill_cmd},
  76     {"purify", "Purify. (Caveat purifier!)", purify_cmd},
  77     {"print", "Print object at ADDRESS.", print_cmd},
  78     {"p", "(an alias for print)", print_cmd},
  79     {"quit", "Quit.", quit_cmd},
  80     {"regs", "Display current Lisp registers.", regs_cmd},
  81     {"search", "Search for TYPE starting at ADDRESS for a max of COUNT words.", search_cmd},
  82     {"s", "(an alias for search)", search_cmd},
  83     {NULL, NULL, NULL}
  84 };
  85
  86 static jmp_buf curbuf;
  87
  88 static int
  89 visible(unsigned char c)
  90 {
  91     if (c < ' ' || c > '~')
  92         return ' ';
  93     else
  94         return c;
  95 }
  96
  97 static void
  98 dump_cmd(char **ptr)
  99 {
 100     static char *lastaddr = 0;
 101     static int lastcount = 20;
 102
 103     char *addr = lastaddr;
 104     int count = lastcount, displacement;
 105
 106     if (more_p(ptr)) {
 107         addr = parse_addr(ptr);
 108
 109         if (more_p(ptr))
 110             count = parse_number(ptr);
 111     }
 112
 113     if (count == 0) {
 114         printf("COUNT must be non-zero.\n");
 115         return;
 116     }
 117
 118     lastcount = count;
 119
 120     if (count > 0)
 121         displacement = 4;
 122     else {
 123         displacement = -4;
 124         count = -count;
 125     }
 126
 127     while (count-- > 0) {
 128 #ifndef alpha
 129         printf("0x%08lX: ", (unsigned long) addr);
 130 #else
 131         printf("0x%08X: ", (u32) addr);
 132 #endif
 133         if (is_valid_lisp_addr((os_vm_address_t)addr)) {
 134 #ifndef alpha
 135             unsigned long *lptr = (unsigned long *)addr;
 136 #else
 137             u32 *lptr = (u32 *)addr;
 138 #endif
 139             unsigned short *sptr = (unsigned short *)addr;
 140             unsigned char *cptr = (unsigned char *)addr;
 141
 142             printf("0x%08lx   0x%04x 0x%04x   0x%02x 0x%02x 0x%02x 0x%02x    %c%c%c%c\n", lptr[0], sptr[0], sptr[1], cptr[0], cptr[1], cptr[2], cptr[3], visible(cptr[0]), visible(cptr[1]), visible(cptr[2]), visible(cptr[3]));
 143         }
 144         else
 145             printf("invalid Lisp-level address\n");
 146
 147         addr += displacement;
 148     }
 149
 150     lastaddr = addr;
 151 }
 152
 153 static void
 154 print_cmd(char **ptr)
 155 {
 156     lispobj obj = parse_lispobj(ptr);
 157
 158     print(obj);
 159 }
 160
 161 static void
 162 kill_cmd(char **ptr)
 163 {
 164     kill(getpid(), parse_number(ptr));
 165 }
 166
 167 static void
 168 regs_cmd(char **ptr)
 169 {
 170     printf("CSP\t=\t0x%08lX\n", (unsigned long)current_control_stack_pointer);
 171     printf("FP\t=\t0x%08lX\n", (unsigned long)current_control_frame_pointer);
 172 #if !defined(__i386__)
 173     printf("BSP\t=\t0x%08X\n", (unsigned long)current_binding_stack_pointer);
 174 #endif
 175 #ifdef __i386__
 176     printf("BSP\t=\t0x%08lx\n",
 177            (unsigned long)SymbolValue(BINDING_STACK_POINTER));
 178 #endif
 179
 180     printf("DYNAMIC\t=\t0x%08lx\n", (unsigned long)DYNAMIC_SPACE_START);
 181 #if defined(__i386__)
 182     printf("ALLOC\t=\t0x%08lx\n",
 183            (unsigned long)SymbolValue(ALLOCATION_POINTER));
 184     printf("TRIGGER\t=\t0x%08lx\n",
 185            (unsigned long)SymbolValue(INTERNAL_GC_TRIGGER));
 186 #else
 187     printf("ALLOC\t=\t0x%08X\n",
 188            (unsigned long)dynamic_space_free_pointer);
 189     printf("TRIGGER\t=\t0x%08lx\n", (unsigned long)current_auto_gc_trigger);
 190 #endif
 191     printf("STATIC\t=\t0x%08lx\n",
 192            (unsigned long)SymbolValue(STATIC_SPACE_FREE_POINTER));
 193     printf("RDONLY\t=\t0x%08lx\n",
 194            (unsigned long)SymbolValue(READ_ONLY_SPACE_FREE_POINTER));
 195
 196 #ifdef MIPS
 197     printf("FLAGS\t=\t0x%08x\n", current_flags_register);
 198 #endif
 199 }
 200
 201 static void
 202 search_cmd(char **ptr)
 203 {
 204     static int lastval = 0, lastcount = 0;
 205     static lispobj *start = 0, *end = 0;
 206     int val, count;
 207     lispobj *addr, obj;
 208
 209     if (more_p(ptr)) {
 210         val = parse_number(ptr);
 211         if (val < 0 || val > 0xff) {
 212             printf("can only search for single bytes\n");
 213             return;
 214         }
 215         if (more_p(ptr)) {
 216             addr = (lispobj *)native_pointer((long)parse_addr(ptr));
 217             if (more_p(ptr)) {
 218                 count = parse_number(ptr);
 219             }
 220             else {
 221                 /* Specified value and address, but no count. Only one. */
 222                 count = -1;
 223             }
 224         }
 225         else {
 226             /* Specified a value, but no address, so search same range. */
 227             addr = start;
 228             count = lastcount;
 229         }
 230     }
 231     else {
 232         /* Specified nothing, search again for val. */
 233         val = lastval;
 234         addr = end;
 235         count = lastcount;
 236     }
 237
 238     lastval = val;
 239     start = end = addr;
 240     lastcount = count;
 241
 242     printf("searching for 0x%x at 0x%08lX\n", val, (unsigned long)end);
 243
 244     while (search_for_type(val, &end, &count)) {
 245         printf("found 0x%x at 0x%08lX:\n", val, (unsigned long)end);
 246         obj = *end;
 247         addr = end;
 248         end += 2;
 249         if (TypeOf(obj) == type_FunctionHeader)
 250             print((long)addr | type_FunctionPointer);
 251         else if (LowtagOf(obj) == type_OtherImmediate0 || LowtagOf(obj) == type_OtherImmediate1)
 252             print((lispobj)addr | type_OtherPointer);
 253         else
 254             print((lispobj)addr);
 255         if (count == -1)
 256             return;
 257     }
 258 }
 259
 260 static void
 261 call_cmd(char **ptr)
 262 {
 263     lispobj thing = parse_lispobj(ptr), function, result = 0, cons, args[3];
 264     int numargs;
 265
 266     if (LowtagOf(thing) == type_OtherPointer) {
 267         switch (TypeOf(*(lispobj *)(thing-type_OtherPointer))) {
 268           case type_SymbolHeader:
 269             for (cons = SymbolValue(INITIAL_FDEFN_OBJECTS);
 270                  cons != NIL;
 271                  cons = CONS(cons)->cdr) {
 272                 if (FDEFN(CONS(cons)->car)->name == thing) {
 273                     thing = CONS(cons)->car;
 274                     goto fdefn;
 275                 }
 276             }
 277             printf("Symbol 0x%08lx is undefined.\n", (long unsigned)thing);
 278             return;
 279
 280           case type_Fdefn:
 281           fdefn:
 282             function = FDEFN(thing)->function;
 283             if (function == NIL) {
 284                 printf("Fdefn 0x%08lx is undefined.\n", (long unsigned)thing);
 285                 return;
 286             }
 287             break;
 288           default:
 289             printf("0x%08lx is not a function pointer, symbol, "
 290                    "or fdefn object.\n",
 291                    (long unsigned)thing);
 292             return;
 293         }
 294     }
 295     else if (LowtagOf(thing) != type_FunctionPointer) {
 296         printf("0x%08lx is not a function pointer, symbol, or fdefn object.\n",
 297                (long unsigned)thing);
 298         return;
 299     }
 300     else
 301         function = thing;
 302
 303     numargs = 0;
 304     while (more_p(ptr)) {
 305         if (numargs >= 3) {
 306             printf("too many arguments (no more than 3 supported)\n");
 307             return;
 308         }
 309         args[numargs++] = parse_lispobj(ptr);
 310     }
 311
 312     switch (numargs) {
 313     case 0:
 314         result = funcall0(function);
 315         break;
 316     case 1:
 317         result = funcall1(function, args[0]);
 318         break;
 319     case 2:
 320         result = funcall2(function, args[0], args[1]);
 321         break;
 322     case 3:
 323         result = funcall3(function, args[0], args[1], args[2]);
 324         break;
 325     default:
 326         lose("unsupported arg count made it past validity check?!");
 327     }
 328
 329     print(result);
 330 }
 331
 332 static void
 333 flush_cmd(char **ptr)
 334 {
 335     flush_vars();
 336 }
 337
 338 static void
 339 quit_cmd(char **ptr)
 340 {
 341     char buf[10];
 342
 343     printf("Really quit? [y] ");
 344     fflush(stdout);
 345     fgets(buf, sizeof(buf), ldb_in);
 346     if (buf[0] == 'y' || buf[0] == 'Y' || buf[0] == '\n')
 347         exit(0);
 348 }
 349
 350 static void
 351 help_cmd(char **ptr)
 352 {
 353     struct cmd *cmd;
 354
 355     for (cmd = supported_cmds; cmd->cmd != NULL; cmd++)
 356         if (cmd->help != NULL)
 357             printf("%s\t%s\n", cmd->cmd, cmd->help);
 358 }
 359
 360 static int done;
 361
 362 static void
 363 exit_cmd(char **ptr)
 364 {
 365     done = 1;
 366 }
 367
 368 static void
 369 purify_cmd(char **ptr)
 370 {
 371     purify(NIL, NIL);
 372 }
 373
 374 static void
 375 print_context(os_context_t *context)
 376 {
 377         int i;
 378
 379         for (i = 0; i < NREGS; i++) {
 380                 printf("%s:\t", lisp_register_names[i]);
 381 #ifdef __i386__
 382                 brief_print((lispobj)(*os_context_register_addr(context,
 383                                                                 i*2)));
 384 #else
 385                 brief_print((lispobj)(*os_context_register_addr(context,i)));
 386 #endif
 387         }
 388         printf("PC:\t\t  0x%08lx\n",
 389                (unsigned long)(*os_context_pc_addr(context)));
 390 }
 391
 392 static void
 393 print_context_cmd(char **ptr)
 394 {
 395         int free;
 396
 397         free = SymbolValue(FREE_INTERRUPT_CONTEXT_INDEX)>>2;
 398
 399         if (more_p(ptr)) {
 400                 int index;
 401
 402                 index = parse_number(ptr);
 403
 404                 if ((index >= 0) && (index < free)) {
 405                         printf("There are %d interrupt contexts.\n", free);
 406                         printf("printing context %d\n", index);
 407                         print_context(lisp_interrupt_contexts[index]);
 408                 } else {
 409                         printf("There aren't that many/few contexts.\n");
 410                         printf("There are %d interrupt contexts.\n", free);
 411                 }
 412         } else {
 413                 if (free == 0)
 414                         printf("There are no interrupt contexts!\n");
 415                 else {
 416                         printf("There are %d interrupt contexts.\n", free);
 417                         printf("printing context %d\n", free - 1);
 418                         print_context(lisp_interrupt_contexts[free - 1]);
 419                 }
 420         }
 421 }
 422
 423 static void
 424 backtrace_cmd(char **ptr)
 425 {
 426     void backtrace(int frames);
 427     int n;
 428
 429     if (more_p(ptr))
 430         n = parse_number(ptr);
 431     else
 432         n = 100;
 433
 434     printf("Backtrace:\n");
 435     backtrace(n);
 436 }
 437
 438 static void
 439 catchers_cmd(char **ptr)
 440 {
 441     struct catch_block *catch;
 442
 443     catch = (struct catch_block *)SymbolValue(CURRENT_CATCH_BLOCK);
 444
 445     if (catch == NULL)
 446         printf("There are no active catchers!\n");
 447     else {
 448         while (catch != NULL) {
 449 #ifndef __i386__
 450             printf("0x%08lX:\n\tuwp: 0x%08lX\n\tfp: 0x%08lX\n\tcode: 0x%08lx\n\tentry: 0x%08lx\n\ttag: ",
 451                    (unsigned long)catch, (unsigned long)(catch->current_uwp),
 452                    (unsigned long)(catch->current_cont),
 453                    catch->current_code,
 454                    catch->entry_pc);
 455 #else
 456             printf("0x%08lX:\n\tuwp: 0x%08lX\n\tfp: 0x%08lX\n\tcode: 0x%08lx\n\tentry: 0x%08lx\n\ttag: ",
 457                    (unsigned long)catch, (unsigned long)(catch->current_uwp),
 458                    (unsigned long)(catch->current_cont),
 459                    (unsigned long)component_ptr_from_pc((void*)catch->entry_pc) +
 460                    type_OtherPointer,
 461                    (unsigned long)catch->entry_pc);
 462 #endif
 463             brief_print((lispobj)catch->tag);
 464             catch = catch->previous_catch;
 465         }
 466     }
 467 }
 468
 469 static void
 470 grab_sigs_cmd(char **ptr)
 471 {
 472     extern void sigint_init(void);
 473
 474     printf("Grabbing signals.\n");
 475     sigint_init();
 476 }
 477
 478 static void
 479 sub_monitor(void)
 480 {
 481     struct cmd *cmd, *found;
 482     char buf[256];
 483     char *line, *ptr, *token;
 484     int ambig;
 485
 486     if (!ldb_in) {
 487         ldb_in = fopen("/dev/tty","r+");
 488         ldb_in_fd = fileno(ldb_in);
 489     }
 490
 491     while (!done) {
 492         printf("ldb> ");
 493         fflush(stdout);
 494         line = fgets(buf, sizeof(buf), ldb_in);
 495         if (line == NULL) {
 496             if (isatty(ldb_in_fd)) {
 497                 putchar('\n');
 498                 continue;
 499             }
 500             else {
 501                 fprintf(stderr, "\nEOF on something other than a tty.\n");
 502                 exit(0);
 503             }
 504         }
 505         ptr = line;
 506         if ((token = parse_token(&ptr)) == NULL)
 507             continue;
 508         ambig = 0;
 509         found = NULL;
 510         for (cmd = supported_cmds; cmd->cmd != NULL; cmd++) {
 511             if (strcmp(token, cmd->cmd) == 0) {
 512                 found = cmd;
 513                 ambig = 0;
 514                 break;
 515             }
 516             else if (strncmp(token, cmd->cmd, strlen(token)) == 0) {
 517                 if (found)
 518                     ambig = 1;
 519                 else
 520                     found = cmd;
 521             }
 522         }
 523         if (ambig)
 524             printf("``%s'' is ambiguous.\n", token);
 525         else if (found == NULL)
 526             printf("unknown command: ``%s''\n", token);
 527         else {
 528             reset_printer();
 529             (*found->fn)(&ptr);
 530         }
 531     }
 532 }
 533
 534 void
 535 ldb_monitor()
 536 {
 537     jmp_buf oldbuf;
 538
 539     bcopy(curbuf, oldbuf, sizeof(oldbuf));
 540
 541     printf("LDB monitor\n");
 542
 543     setjmp(curbuf);
 544
 545     sub_monitor();
 546
 547     done = 0;
 548
 549     bcopy(oldbuf, curbuf, sizeof(curbuf));
 550 }
 551
 552 void
 553 throw_to_monitor()
 554 {
 555     longjmp(curbuf, 1);
 556 }
 557
 558 #endif /* defined(LISP_FEATURE_SB_LDB) */
 559
 560 /* what we do when things go badly wrong at a low level */
 561 void
 562 monitor_or_something()
 563 {
 564 #if defined(LISP_FEATURE_SB_LDB)
 565     ldb_monitor();
 566 #else
 567     fprintf(stderr, "There's no LDB in this build; exiting.\n");
 568     exit(1);
 569 #endif
 570 }