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