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 #ifdef LISP_FEATURE_X86_64
353 static void print_unknown(lispobj obj)
355 printf("unknown object: %p", (void *)obj);
359 static void print_list(lispobj obj)
361 if (!is_valid_lisp_addr((os_vm_address_t)native_pointer(obj))) {
362 printf("(invalid address)");
363 } else if (obj == NIL) {
366 struct cons *cons = (struct cons *)native_pointer(obj);
368 print_obj("car: ", cons->car);
369 print_obj("cdr: ", cons->cdr);
373 static void brief_struct(lispobj obj)
375 printf("#<ptr to 0x%08lx instance>",
376 (unsigned long) ((struct instance *)native_pointer(obj))->slots[0]);
379 static void print_struct(lispobj obj)
381 struct instance *instance = (struct instance *)native_pointer(obj);
384 print_obj("type: ", ((struct instance *)native_pointer(obj))->slots[0]);
385 for (i = 1; i < HeaderValue(instance->header); i++) {
386 sprintf(buffer, "slot %d: ", i);
387 print_obj(buffer, instance->slots[i]);
391 static void brief_otherptr(lispobj obj)
393 lispobj *ptr, header;
395 struct symbol *symbol;
396 struct vector *vector;
399 ptr = (lispobj *) native_pointer(obj);
401 if (!is_valid_lisp_addr((os_vm_address_t)obj)) {
402 printf("(invalid address)");
407 type = widetag_of(header);
409 case SYMBOL_HEADER_WIDETAG:
410 symbol = (struct symbol *)ptr;
411 vector = (struct vector *)native_pointer(symbol->name);
412 for (charptr = (char *)vector->data; *charptr != '\0'; charptr++) {
419 case SIMPLE_BASE_STRING_WIDETAG:
420 vector = (struct vector *)ptr;
422 for (charptr = (char *)vector->data; *charptr != '\0'; charptr++) {
432 brief_otherimm(header);
437 static void print_slots(char **slots, int count, lispobj *ptr)
439 while (count-- > 0) {
441 print_obj(*slots++, *ptr++);
443 print_obj("???: ", *ptr++);
448 /* FIXME: Yikes again! This, like subtype_Names[], needs to depend
449 * on the values in sbcl.h (or perhaps be generated automatically
450 * by GENESIS as part of sbcl.h). */
451 static char *symbol_slots[] = {"value: ", "hash: ",
452 "plist: ", "name: ", "package: ",
453 #ifdef LISP_FEATURE_SB_THREAD
457 static char *ratio_slots[] = {"numer: ", "denom: ", NULL};
458 static char *complex_slots[] = {"real: ", "imag: ", NULL};
459 static char *code_slots[] = {"words: ", "entry: ", "debug: ", NULL};
460 static char *fn_slots[] = {
461 "self: ", "next: ", "name: ", "arglist: ", "type: ", NULL};
462 static char *closure_slots[] = {"fn: ", NULL};
463 static char *funcallable_instance_slots[] = {"fn: ", "lexenv: ", "layout: ", NULL};
464 static char *weak_pointer_slots[] = {"value: ", NULL};
465 static char *fdefn_slots[] = {"name: ", "function: ", "raw_addr: ", NULL};
466 static char *value_cell_slots[] = {"value: ", NULL};
468 static void print_otherptr(lispobj obj)
470 if (!is_valid_lisp_addr((os_vm_address_t)obj)) {
471 printf("(invalid address)");
473 #ifndef LISP_FEATURE_ALPHA
475 unsigned long header;
476 unsigned long length;
482 int count, type, index;
483 char *cptr, buffer[16];
485 ptr = (lispobj*) native_pointer(obj);
487 printf(" (NULL Pointer)");
492 length = (*ptr) >> 2;
494 type = widetag_of(header);
496 print_obj("header: ", header);
497 if (lowtag_of(header) != OTHER_IMMEDIATE_0_LOWTAG &&
498 lowtag_of(header) != OTHER_IMMEDIATE_1_LOWTAG) {
500 printf("(invalid header object)");
510 printf("%08lx", (unsigned long) *--ptr);
514 print_slots(ratio_slots, count, ptr);
517 case COMPLEX_WIDETAG:
518 print_slots(complex_slots, count, ptr);
521 case SYMBOL_HEADER_WIDETAG:
522 print_slots(symbol_slots, count, ptr);
525 #if N_WORD_BITS == 32
526 case SINGLE_FLOAT_WIDETAG:
528 printf("%g", ((struct single_float *)native_pointer(obj))->value);
531 case DOUBLE_FLOAT_WIDETAG:
533 printf("%g", ((struct double_float *)native_pointer(obj))->value);
536 #ifdef LONG_FLOAT_WIDETAG
537 case LONG_FLOAT_WIDETAG:
539 printf("%Lg", ((struct long_float *)native_pointer(obj))->value);
543 #ifdef COMPLEX_SINGLE_FLOAT_WIDETAG
544 case COMPLEX_SINGLE_FLOAT_WIDETAG:
546 printf("%g", ((struct complex_single_float *)native_pointer(obj))->real);
548 printf("%g", ((struct complex_single_float *)native_pointer(obj))->imag);
552 #ifdef COMPLEX_DOUBLE_FLOAT_WIDETAG
553 case COMPLEX_DOUBLE_FLOAT_WIDETAG:
555 printf("%g", ((struct complex_double_float *)native_pointer(obj))->real);
557 printf("%g", ((struct complex_double_float *)native_pointer(obj))->imag);
561 #ifdef COMPLEX_LONG_FLOAT_WIDETAG
562 case COMPLEX_LONG_FLOAT_WIDETAG:
564 printf("%Lg", ((struct complex_long_float *)native_pointer(obj))->real);
566 printf("%Lg", ((struct complex_long_float *)native_pointer(obj))->imag);
570 case SIMPLE_BASE_STRING_WIDETAG:
571 #ifdef SIMPLE_CHARACTER_STRING_WIDETAG
572 case SIMPLE_CHARACTER_STRING_WIDETAG: /* FIXME */
575 cptr = (char *)(ptr+1);
582 case SIMPLE_VECTOR_WIDETAG:
584 printf("length = %ld", length);
587 while (length-- > 0) {
588 sprintf(buffer, "%d: ", index++);
589 print_obj(buffer, *ptr++);
593 case INSTANCE_HEADER_WIDETAG:
595 printf("length = %ld", (long) count);
597 while (count-- > 0) {
598 sprintf(buffer, "%d: ", index++);
599 print_obj(buffer, *ptr++);
603 case SIMPLE_ARRAY_WIDETAG:
604 case SIMPLE_BIT_VECTOR_WIDETAG:
605 case SIMPLE_ARRAY_UNSIGNED_BYTE_2_WIDETAG:
606 case SIMPLE_ARRAY_UNSIGNED_BYTE_4_WIDETAG:
607 case SIMPLE_ARRAY_UNSIGNED_BYTE_8_WIDETAG:
608 case SIMPLE_ARRAY_UNSIGNED_BYTE_16_WIDETAG:
609 case SIMPLE_ARRAY_UNSIGNED_BYTE_32_WIDETAG:
610 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG
611 case SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG:
613 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG
614 case SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG:
616 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG
617 case SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG:
619 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG
620 case SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG:
622 case SIMPLE_ARRAY_SINGLE_FLOAT_WIDETAG:
623 case SIMPLE_ARRAY_DOUBLE_FLOAT_WIDETAG:
624 #ifdef SIMPLE_ARRAY_LONG_FLOAT_WIDETAG
625 case SIMPLE_ARRAY_LONG_FLOAT_WIDETAG:
627 #ifdef SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG
628 case SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG:
630 #ifdef SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG
631 case SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG:
633 #ifdef SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG
634 case SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG:
636 case COMPLEX_BASE_STRING_WIDETAG:
637 #ifdef COMPLEX_CHARACTER_STRING_WIDETAG
638 case COMPLEX_CHARACTER_STRING_WIDETAG:
640 case COMPLEX_VECTOR_NIL_WIDETAG:
641 case COMPLEX_BIT_VECTOR_WIDETAG:
642 case COMPLEX_VECTOR_WIDETAG:
643 case COMPLEX_ARRAY_WIDETAG:
646 case CODE_HEADER_WIDETAG:
647 print_slots(code_slots, count-1, ptr);
650 case SIMPLE_FUN_HEADER_WIDETAG:
651 print_slots(fn_slots, 5, ptr);
654 case RETURN_PC_HEADER_WIDETAG:
655 print_obj("code: ", obj - (count * 4));
658 case CLOSURE_HEADER_WIDETAG:
659 print_slots(closure_slots, count, ptr);
662 case FUNCALLABLE_INSTANCE_HEADER_WIDETAG:
663 print_slots(funcallable_instance_slots, count, ptr);
666 case VALUE_CELL_HEADER_WIDETAG:
667 print_slots(value_cell_slots, 1, ptr);
672 #ifndef LISP_FEATURE_ALPHA
673 printf("0x%08lx", (unsigned long) *ptr);
675 printf("0x%016lx", *(lispobj*)(ptr+1));
679 case WEAK_POINTER_WIDETAG:
680 print_slots(weak_pointer_slots, 1, ptr);
683 case CHARACTER_WIDETAG:
684 case UNBOUND_MARKER_WIDETAG:
686 printf("pointer to an immediate?");
690 print_slots(fdefn_slots, count, ptr);
695 printf("Unknown header object?");
701 static void print_obj(char *prefix, lispobj obj)
703 #ifdef LISP_FEATURE_X86_64
704 static void (*verbose_fns[])(lispobj obj)
705 = {print_fixnum, print_struct, print_otherimm, print_unknown,
706 print_unknown, print_unknown, print_otherimm, print_list,
707 print_fixnum, print_otherptr, print_otherimm, print_unknown,
708 print_unknown, print_unknown, print_otherimm, print_otherptr};
709 static void (*brief_fns[])(lispobj obj)
710 = {brief_fixnum, brief_struct, brief_otherimm, print_unknown,
711 print_unknown, print_unknown, brief_otherimm, brief_list,
712 brief_fixnum, brief_otherptr, brief_otherimm, print_unknown,
713 print_unknown, print_unknown,brief_otherimm, brief_otherptr};
715 static void (*verbose_fns[])(lispobj obj)
716 = {print_fixnum, print_struct, print_otherimm, print_list,
717 print_fixnum, print_otherptr, print_otherimm, print_otherptr};
718 static void (*brief_fns[])(lispobj obj)
719 = {brief_fixnum, brief_struct, brief_otherimm, brief_list,
720 brief_fixnum, brief_otherptr, brief_otherimm, brief_otherptr};
722 int type = lowtag_of(obj);
723 struct var *var = lookup_by_obj(obj);
725 boolean verbose = cur_depth < brief_depth;
727 if (!continue_p(verbose))
730 if (var != NULL && var_clock(var) == cur_clock)
734 /* FIXME: What does this "x & y & z & .." expression mean? */
735 (obj & FUN_POINTER_LOWTAG & LIST_POINTER_LOWTAG & INSTANCE_POINTER_LOWTAG & OTHER_POINTER_LOWTAG) != 0)
736 var = define_var(NULL, obj, 0);
739 var_setclock(var, cur_clock);
744 sprintf(buffer, "$%s=", var_name(var));
749 printf("%s0x%08lx: ", prefix, (unsigned long) obj);
750 if (cur_depth < brief_depth) {
751 fputs(lowtag_Names[type], stdout);
752 (*verbose_fns[type])(obj);
755 (*brief_fns[type])(obj);
759 printf("$%s", var_name(var));
762 printf("$%s=", var_name(var));
763 (*brief_fns[type])(obj);
777 void print(lispobj obj)
789 void brief_print(lispobj obj)
803 brief_print(lispobj obj)
805 printf("lispobj 0x%lx\n", (unsigned long)obj);
808 #endif /* defined(LISP_FEATURE_SB_LDB) */