1 /* code for low-level debugging/diagnostic output */
4 * This software is part of the SBCL system. See the README file for
7 * This software is derived from the CMU CL system, which was
8 * written at Carnegie Mellon University and released into the
9 * public domain. The software is in the public domain and is
10 * provided with absolutely no warranty. See the COPYING and CREDITS
11 * files for more information.
16 * Some of the code in here (the various
17 * foo_slots[], at least) is deeply broken, depending on guessing
18 * already out-of-date values instead of getting them from sbcl.h.
28 /* This file can be skipped if we're not supporting LDB. */
29 #if defined(LISP_FEATURE_SB_LDB)
34 #include "gencgc-alloc-region.h" /* genesis/thread.h needs this */
35 #include "genesis/static-symbols.h"
36 #include "genesis/primitive-objects.h"
38 #include "genesis/static-symbols.h"
42 static int max_lines = 20, cur_lines = 0;
43 static int max_depth = 5, brief_depth = 2, cur_depth = 0;
44 static int max_length = 5;
45 static boolean dont_descend = 0, skip_newline = 0;
46 static int cur_clock = 0;
48 static void print_obj(char *prefix, lispobj obj);
50 #define NEWLINE_OR_RETURN if (continue_p(1)) newline(NULL); else return;
52 /* FIXME: This should be auto-generated by whatever generates
53 constants.h so we don't have to maintain this twice! */
54 #ifdef LISP_FEATURE_X86_64
55 char *lowtag_Names[] = {
58 "other immediate [0]",
62 "other immediate [1]",
66 "other immediate [2]",
70 "other immediate [3]",
74 char *lowtag_Names[] = {
77 "other immediate [0]",
81 "other immediate [1]",
86 /* FIXME: Yikes! This table implicitly depends on the values in sbcl.h,
87 * but doesn't actually depend on them, so if they change, it gets
88 * all broken. We should either get rid of it or
89 * rewrite the code so that it's cleanly initialized by gc_init_tables[]
90 * in a way which varies correctly with the values in sbcl.h. */
91 char *subtype_Names[] = {
98 #ifdef LONG_FLOAT_WIDETAG
102 #ifdef COMPLEX_SINGLE_FLOAT_WIDETAG
103 "complex single float",
105 #ifdef COMPLEX_DOUBLE_FLOAT_WIDETAG
106 "complex double float",
108 #ifdef COMPLEX_LONG_FLOAT_WIDETAG
109 "complex long float",
115 "(simple-array (unsigned-byte 2) (*))",
116 "(simple-array (unsigned-byte 4) (*))",
117 "(simple-array (unsigned-byte 8) (*))",
118 "(simple-array (unsigned-byte 16) (*))",
119 "(simple-array (unsigned-byte 32) (*))",
120 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG
121 "(simple-array (signed-byte 8) (*))",
123 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG
124 "(simple-array (signed-byte 16) (*))",
126 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG
127 "(simple-array fixnum (*))",
129 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG
130 "(simple-array (signed-byte 32) (*))",
132 "(simple-array single-float (*))",
133 "(simple-array double-float (*))",
134 #ifdef SIMPLE_ARRAY_LONG_FLOAT_WIDETAG
135 "(simple-array long-float (*))",
137 #ifdef SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG
138 "(simple-array (complex single-float) (*))",
140 #ifdef SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG
141 "(simple-array (complex double-float) (*))",
143 #ifdef SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG
144 "(simple-array (complex long-float) (*))",
147 "complex-bit-vector",
153 "funcallable-instance header",
154 "unused function header 1",
155 "unused function header 2",
156 "unused function header 3",
157 "closure function header",
169 static void indent(int in)
171 static char *spaces = " ";
174 fputs(spaces, stdout);
178 fputs(spaces + 64 - in, stdout);
181 static boolean continue_p(boolean newline)
185 if (cur_depth >= max_depth || dont_descend)
194 if (cur_lines >= max_lines) {
195 printf("More? [y] ");
198 fgets(buffer, sizeof(buffer), stdin);
200 if (buffer[0] == 'n' || buffer[0] == 'N')
210 static void newline(char *label)
214 fputs(label, stdout);
216 indent(cur_depth * 2);
220 static void brief_fixnum(lispobj obj)
222 #ifndef LISP_FEATURE_ALPHA
223 printf("%ld", ((long)obj)>>2);
225 printf("%d", ((s32)obj)>>2);
229 static void print_fixnum(lispobj obj)
231 #ifndef LISP_FEATURE_ALPHA
232 printf(": %ld", ((long)obj)>>2);
234 printf(": %d", ((s32)obj)>>2);
238 static void brief_otherimm(lispobj obj)
243 type = widetag_of(obj);
245 case CHARACTER_WIDETAG:
252 printf("#\\Newline");
255 printf("#\\Backspace");
261 strcpy(buffer, "#\\");
263 strcat(buffer, "m-");
267 strcat(buffer, "c-");
270 printf("%s%c", buffer, c);
275 case UNBOUND_MARKER_WIDETAG:
276 printf("<unbound marker>");
281 if (idx < (sizeof(lowtag_Names) / sizeof(char *)))
282 printf("%s", lowtag_Names[idx]);
284 printf("unknown type (0x%0x)", type);
289 static void print_otherimm(lispobj obj)
293 type = widetag_of(obj);
296 if (idx < (sizeof(lowtag_Names) / sizeof(char *)))
297 printf(", %s", lowtag_Names[idx]);
299 printf(", unknown type (0x%0x)", type);
301 switch (widetag_of(obj)) {
302 case CHARACTER_WIDETAG:
308 case UNBOUND_MARKER_WIDETAG:
312 printf(": data=%ld", (long) (obj>>8)&0xffffff);
317 static void brief_list(lispobj obj)
322 if (!is_valid_lisp_addr((os_vm_address_t)native_pointer(obj)))
323 printf("(invalid Lisp-level address)");
328 while (lowtag_of(obj) == LIST_POINTER_LOWTAG) {
329 struct cons *cons = (struct cons *)native_pointer(obj);
333 if (++length >= max_length) {
338 print_obj(NULL, cons->car);
346 print_obj(NULL, obj);
352 static void print_unknown(lispobj obj)
354 printf("unknown object: %p", (void *)obj);
357 static void print_list(lispobj obj)
359 if (!is_valid_lisp_addr((os_vm_address_t)native_pointer(obj))) {
360 printf("(invalid address)");
361 } else if (obj == NIL) {
364 struct cons *cons = (struct cons *)native_pointer(obj);
366 print_obj("car: ", cons->car);
367 print_obj("cdr: ", cons->cdr);
371 static void brief_struct(lispobj obj)
373 printf("#<ptr to 0x%08lx instance>",
374 (unsigned long) ((struct instance *)native_pointer(obj))->slots[0]);
377 static void print_struct(lispobj obj)
379 struct instance *instance = (struct instance *)native_pointer(obj);
382 print_obj("type: ", ((struct instance *)native_pointer(obj))->slots[0]);
383 for (i = 1; i < HeaderValue(instance->header); i++) {
384 sprintf(buffer, "slot %d: ", i);
385 print_obj(buffer, instance->slots[i]);
389 static void brief_otherptr(lispobj obj)
391 lispobj *ptr, header;
393 struct symbol *symbol;
394 struct vector *vector;
397 ptr = (lispobj *) native_pointer(obj);
399 if (!is_valid_lisp_addr((os_vm_address_t)obj)) {
400 printf("(invalid address)");
405 type = widetag_of(header);
407 case SYMBOL_HEADER_WIDETAG:
408 symbol = (struct symbol *)ptr;
409 vector = (struct vector *)native_pointer(symbol->name);
410 for (charptr = (char *)vector->data; *charptr != '\0'; charptr++) {
417 case SIMPLE_BASE_STRING_WIDETAG:
418 vector = (struct vector *)ptr;
420 for (charptr = (char *)vector->data; *charptr != '\0'; charptr++) {
430 brief_otherimm(header);
435 static void print_slots(char **slots, int count, lispobj *ptr)
437 while (count-- > 0) {
439 print_obj(*slots++, *ptr++);
441 print_obj("???: ", *ptr++);
446 /* FIXME: Yikes again! This, like subtype_Names[], needs to depend
447 * on the values in sbcl.h (or perhaps be generated automatically
448 * by GENESIS as part of sbcl.h). */
449 static char *symbol_slots[] = {"value: ", "hash: ",
450 "plist: ", "name: ", "package: ",
451 #ifdef LISP_FEATURE_SB_THREAD
455 static char *ratio_slots[] = {"numer: ", "denom: ", NULL};
456 static char *complex_slots[] = {"real: ", "imag: ", NULL};
457 static char *code_slots[] = {"words: ", "entry: ", "debug: ", NULL};
458 static char *fn_slots[] = {
459 "self: ", "next: ", "name: ", "arglist: ", "type: ", NULL};
460 static char *closure_slots[] = {"fn: ", NULL};
461 static char *funcallable_instance_slots[] = {"fn: ", "lexenv: ", "layout: ", NULL};
462 static char *weak_pointer_slots[] = {"value: ", NULL};
463 static char *fdefn_slots[] = {"name: ", "function: ", "raw_addr: ", NULL};
464 static char *value_cell_slots[] = {"value: ", NULL};
466 static void print_otherptr(lispobj obj)
468 if (!is_valid_lisp_addr((os_vm_address_t)obj)) {
469 printf("(invalid address)");
471 #ifndef LISP_FEATURE_ALPHA
473 unsigned long header;
474 unsigned long length;
480 int count, type, index;
481 char *cptr, buffer[16];
483 ptr = (lispobj*) native_pointer(obj);
485 printf(" (NULL Pointer)");
490 length = (*ptr) >> 2;
492 type = widetag_of(header);
494 print_obj("header: ", header);
495 if (lowtag_of(header) != OTHER_IMMEDIATE_0_LOWTAG &&
496 lowtag_of(header) != OTHER_IMMEDIATE_1_LOWTAG) {
498 printf("(invalid header object)");
508 printf("%08lx", (unsigned long) *--ptr);
512 print_slots(ratio_slots, count, ptr);
515 case COMPLEX_WIDETAG:
516 print_slots(complex_slots, count, ptr);
519 case SYMBOL_HEADER_WIDETAG:
520 print_slots(symbol_slots, count, ptr);
523 #if N_WORD_BITS == 32
524 case SINGLE_FLOAT_WIDETAG:
526 printf("%g", ((struct single_float *)native_pointer(obj))->value);
529 case DOUBLE_FLOAT_WIDETAG:
531 printf("%g", ((struct double_float *)native_pointer(obj))->value);
534 #ifdef LONG_FLOAT_WIDETAG
535 case LONG_FLOAT_WIDETAG:
537 printf("%Lg", ((struct long_float *)native_pointer(obj))->value);
541 #ifdef COMPLEX_SINGLE_FLOAT_WIDETAG
542 case COMPLEX_SINGLE_FLOAT_WIDETAG:
544 printf("%g", ((struct complex_single_float *)native_pointer(obj))->real);
546 printf("%g", ((struct complex_single_float *)native_pointer(obj))->imag);
550 #ifdef COMPLEX_DOUBLE_FLOAT_WIDETAG
551 case COMPLEX_DOUBLE_FLOAT_WIDETAG:
553 printf("%g", ((struct complex_double_float *)native_pointer(obj))->real);
555 printf("%g", ((struct complex_double_float *)native_pointer(obj))->imag);
559 #ifdef COMPLEX_LONG_FLOAT_WIDETAG
560 case COMPLEX_LONG_FLOAT_WIDETAG:
562 printf("%Lg", ((struct complex_long_float *)native_pointer(obj))->real);
564 printf("%Lg", ((struct complex_long_float *)native_pointer(obj))->imag);
568 case SIMPLE_BASE_STRING_WIDETAG:
569 #ifdef SIMPLE_CHARACTER_STRING_WIDETAG
570 case SIMPLE_CHARACTER_STRING_WIDETAG: /* FIXME */
573 cptr = (char *)(ptr+1);
580 case SIMPLE_VECTOR_WIDETAG:
582 printf("length = %ld", length);
585 while (length-- > 0) {
586 sprintf(buffer, "%d: ", index++);
587 print_obj(buffer, *ptr++);
591 case INSTANCE_HEADER_WIDETAG:
593 printf("length = %ld", (long) count);
595 while (count-- > 0) {
596 sprintf(buffer, "%d: ", index++);
597 print_obj(buffer, *ptr++);
601 case SIMPLE_ARRAY_WIDETAG:
602 case SIMPLE_BIT_VECTOR_WIDETAG:
603 case SIMPLE_ARRAY_UNSIGNED_BYTE_2_WIDETAG:
604 case SIMPLE_ARRAY_UNSIGNED_BYTE_4_WIDETAG:
605 case SIMPLE_ARRAY_UNSIGNED_BYTE_8_WIDETAG:
606 case SIMPLE_ARRAY_UNSIGNED_BYTE_16_WIDETAG:
607 case SIMPLE_ARRAY_UNSIGNED_BYTE_32_WIDETAG:
608 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG
609 case SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG:
611 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG
612 case SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG:
614 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG
615 case SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG:
617 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG
618 case SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG:
620 case SIMPLE_ARRAY_SINGLE_FLOAT_WIDETAG:
621 case SIMPLE_ARRAY_DOUBLE_FLOAT_WIDETAG:
622 #ifdef SIMPLE_ARRAY_LONG_FLOAT_WIDETAG
623 case SIMPLE_ARRAY_LONG_FLOAT_WIDETAG:
625 #ifdef SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG
626 case SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG:
628 #ifdef SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG
629 case SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG:
631 #ifdef SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG
632 case SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG:
634 case COMPLEX_BASE_STRING_WIDETAG:
635 #ifdef COMPLEX_CHARACTER_STRING_WIDETAG
636 case COMPLEX_CHARACTER_STRING_WIDETAG:
638 case COMPLEX_VECTOR_NIL_WIDETAG:
639 case COMPLEX_BIT_VECTOR_WIDETAG:
640 case COMPLEX_VECTOR_WIDETAG:
641 case COMPLEX_ARRAY_WIDETAG:
644 case CODE_HEADER_WIDETAG:
645 print_slots(code_slots, count-1, ptr);
648 case SIMPLE_FUN_HEADER_WIDETAG:
649 print_slots(fn_slots, 5, ptr);
652 case RETURN_PC_HEADER_WIDETAG:
653 print_obj("code: ", obj - (count * 4));
656 case CLOSURE_HEADER_WIDETAG:
657 print_slots(closure_slots, count, ptr);
660 case FUNCALLABLE_INSTANCE_HEADER_WIDETAG:
661 print_slots(funcallable_instance_slots, count, ptr);
664 case VALUE_CELL_HEADER_WIDETAG:
665 print_slots(value_cell_slots, 1, ptr);
670 #ifndef LISP_FEATURE_ALPHA
671 printf("0x%08lx", (unsigned long) *ptr);
673 printf("0x%016lx", *(lispobj*)(ptr+1));
677 case WEAK_POINTER_WIDETAG:
678 print_slots(weak_pointer_slots, 1, ptr);
681 case CHARACTER_WIDETAG:
682 case UNBOUND_MARKER_WIDETAG:
684 printf("pointer to an immediate?");
688 print_slots(fdefn_slots, count, ptr);
693 printf("Unknown header object?");
699 static void print_obj(char *prefix, lispobj obj)
701 #ifdef LISP_FEATURE_X86_64
702 static void (*verbose_fns[])(lispobj obj)
703 = {print_fixnum, print_struct, print_otherimm, print_unknown,
704 print_unknown, print_unknown, print_otherimm, print_list,
705 print_fixnum, print_otherptr, print_otherimm, print_unknown,
706 print_unknown, print_unknown, print_otherimm, print_otherptr};
707 static void (*brief_fns[])(lispobj obj)
708 = {brief_fixnum, brief_struct, brief_otherimm, print_unknown,
709 print_unknown, print_unknown, brief_otherimm, brief_list,
710 brief_fixnum, brief_otherptr, brief_otherimm, print_unknown,
711 print_unknown, print_unknown,brief_otherimm, brief_otherptr};
713 static void (*verbose_fns[])(lispobj obj)
714 = {print_fixnum, print_struct, print_otherimm, print_list,
715 print_fixnum, print_otherptr, print_otherimm, print_otherptr};
716 static void (*brief_fns[])(lispobj obj)
717 = {brief_fixnum, brief_struct, brief_otherimm, brief_list,
718 brief_fixnum, brief_otherptr, brief_otherimm, brief_otherptr};
720 int type = lowtag_of(obj);
721 struct var *var = lookup_by_obj(obj);
723 boolean verbose = cur_depth < brief_depth;
725 if (!continue_p(verbose))
728 if (var != NULL && var_clock(var) == cur_clock)
732 /* FIXME: What does this "x & y & z & .." expression mean? */
733 (obj & FUN_POINTER_LOWTAG & LIST_POINTER_LOWTAG & INSTANCE_POINTER_LOWTAG & OTHER_POINTER_LOWTAG) != 0)
734 var = define_var(NULL, obj, 0);
737 var_setclock(var, cur_clock);
742 sprintf(buffer, "$%s=", var_name(var));
747 printf("%s0x%08lx: ", prefix, (unsigned long) obj);
748 if (cur_depth < brief_depth) {
749 fputs(lowtag_Names[type], stdout);
750 (*verbose_fns[type])(obj);
753 (*brief_fns[type])(obj);
757 printf("$%s", var_name(var));
760 printf("$%s=", var_name(var));
761 (*brief_fns[type])(obj);
775 void print(lispobj obj)
787 void brief_print(lispobj obj)
801 brief_print(lispobj obj)
803 printf("lispobj 0x%lx\n", (unsigned long)obj);
806 #endif /* defined(LISP_FEATURE_SB_LDB) */