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