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