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
)
244 type
= widetag_of(obj
);
246 case CHARACTER_WIDETAG
:
253 printf("#\\Newline");
256 printf("#\\Backspace");
262 strcpy(buffer
, "#\\");
264 strcat(buffer
, "m-");
268 strcat(buffer
, "c-");
271 printf("%s%c", buffer
, c
);
276 case UNBOUND_MARKER_WIDETAG
:
277 printf("<unbound marker>");
282 if (idx
< (sizeof(lowtag_Names
) / sizeof(char *)))
283 printf("%s", lowtag_Names
[idx
]);
285 printf("unknown type (0x%0x)", type
);
290 static void print_otherimm(lispobj obj
)
296 type
= widetag_of(obj
);
299 if (idx
< (sizeof(lowtag_Names
) / sizeof(char *)))
300 printf(", %s", lowtag_Names
[idx
]);
302 printf(", unknown type (0x%0x)", type
);
304 switch (widetag_of(obj
)) {
305 case CHARACTER_WIDETAG
:
311 case UNBOUND_MARKER_WIDETAG
:
315 printf(": data=%ld", (long) (obj
>>8)&0xffffff);
320 static void brief_list(lispobj obj
)
325 if (!is_valid_lisp_addr((os_vm_address_t
)native_pointer(obj
)))
326 printf("(invalid Lisp-level address)");
331 while (lowtag_of(obj
) == LIST_POINTER_LOWTAG
) {
332 struct cons
*cons
= (struct cons
*)native_pointer(obj
);
336 if (++length
>= max_length
) {
341 print_obj("", cons
->car
);
355 #ifdef LISP_FEATURE_X86_64
356 static void print_unknown(lispobj obj
)
358 printf("unknown object: %p", (void *)obj
);
362 static void print_list(lispobj obj
)
364 if (!is_valid_lisp_addr((os_vm_address_t
)native_pointer(obj
))) {
365 printf("(invalid address)");
366 } else if (obj
== NIL
) {
369 struct cons
*cons
= (struct cons
*)native_pointer(obj
);
371 print_obj("car: ", cons
->car
);
372 print_obj("cdr: ", cons
->cdr
);
376 static void brief_struct(lispobj obj
)
378 printf("#<ptr to 0x%08lx instance>",
379 (unsigned long) ((struct instance
*)native_pointer(obj
))->slots
[0]);
382 static void print_struct(lispobj obj
)
384 struct instance
*instance
= (struct instance
*)native_pointer(obj
);
387 print_obj("type: ", ((struct instance
*)native_pointer(obj
))->slots
[0]);
388 for (i
= 1; i
< HeaderValue(instance
->header
); i
++) {
389 sprintf(buffer
, "slot %d: ", i
);
390 print_obj(buffer
, instance
->slots
[i
]);
394 static void brief_otherptr(lispobj obj
)
396 lispobj
*ptr
, header
;
398 struct symbol
*symbol
;
399 struct vector
*vector
;
402 ptr
= (lispobj
*) native_pointer(obj
);
404 if (!is_valid_lisp_addr((os_vm_address_t
)obj
)) {
405 printf("(invalid address)");
410 type
= widetag_of(header
);
412 case SYMBOL_HEADER_WIDETAG
:
413 symbol
= (struct symbol
*)ptr
;
414 vector
= (struct vector
*)native_pointer(symbol
->name
);
415 for (charptr
= (char *)vector
->data
; *charptr
!= '\0'; charptr
++) {
422 case SIMPLE_BASE_STRING_WIDETAG
:
423 vector
= (struct vector
*)ptr
;
425 for (charptr
= (char *)vector
->data
; *charptr
!= '\0'; charptr
++) {
435 brief_otherimm(header
);
440 static void print_slots(char **slots
, int count
, lispobj
*ptr
)
442 while (count
-- > 0) {
444 print_obj(*slots
++, *ptr
++);
446 print_obj("???: ", *ptr
++);
451 /* FIXME: Yikes again! This, like subtype_Names[], needs to depend
452 * on the values in sbcl.h (or perhaps be generated automatically
453 * by GENESIS as part of sbcl.h). */
454 static char *symbol_slots
[] = {"value: ", "hash: ",
455 "plist: ", "name: ", "package: ",
456 #ifdef LISP_FEATURE_SB_THREAD
460 static char *ratio_slots
[] = {"numer: ", "denom: ", NULL
};
461 static char *complex_slots
[] = {"real: ", "imag: ", NULL
};
462 static char *code_slots
[] = {"words: ", "entry: ", "debug: ", NULL
};
463 static char *fn_slots
[] = {
464 "self: ", "next: ", "name: ", "arglist: ", "type: ", NULL
};
465 static char *closure_slots
[] = {"fn: ", NULL
};
466 static char *funcallable_instance_slots
[] = {"fn: ", "lexenv: ", "layout: ", NULL
};
467 static char *weak_pointer_slots
[] = {"value: ", NULL
};
468 static char *fdefn_slots
[] = {"name: ", "function: ", "raw_addr: ", NULL
};
469 static char *value_cell_slots
[] = {"value: ", NULL
};
471 static void print_otherptr(lispobj obj
)
473 if (!is_valid_lisp_addr((os_vm_address_t
)obj
)) {
474 printf("(invalid address)");
476 #ifndef LISP_FEATURE_ALPHA
478 unsigned long header
;
479 unsigned long length
;
485 int count
, type
, index
;
486 char *cptr
, buffer
[16];
488 ptr
= (lispobj
*) native_pointer(obj
);
490 printf(" (NULL Pointer)");
495 length
= (*ptr
) >> 2;
497 type
= widetag_of(header
);
499 print_obj("header: ", header
);
500 if (lowtag_of(header
) != OTHER_IMMEDIATE_0_LOWTAG
&&
501 lowtag_of(header
) != OTHER_IMMEDIATE_1_LOWTAG
) {
503 printf("(invalid header object)");
513 printf("%08lx", (unsigned long) *--ptr
);
517 print_slots(ratio_slots
, count
, ptr
);
520 case COMPLEX_WIDETAG
:
521 print_slots(complex_slots
, count
, ptr
);
524 case SYMBOL_HEADER_WIDETAG
:
525 print_slots(symbol_slots
, count
, ptr
);
528 #if N_WORD_BITS == 32
529 case SINGLE_FLOAT_WIDETAG
:
531 printf("%g", ((struct single_float
*)native_pointer(obj
))->value
);
534 case DOUBLE_FLOAT_WIDETAG
:
536 printf("%g", ((struct double_float
*)native_pointer(obj
))->value
);
539 #ifdef LONG_FLOAT_WIDETAG
540 case LONG_FLOAT_WIDETAG
:
542 printf("%Lg", ((struct long_float
*)native_pointer(obj
))->value
);
546 #ifdef COMPLEX_SINGLE_FLOAT_WIDETAG
547 case COMPLEX_SINGLE_FLOAT_WIDETAG
:
549 printf("%g", ((struct complex_single_float
*)native_pointer(obj
))->real
);
551 printf("%g", ((struct complex_single_float
*)native_pointer(obj
))->imag
);
555 #ifdef COMPLEX_DOUBLE_FLOAT_WIDETAG
556 case COMPLEX_DOUBLE_FLOAT_WIDETAG
:
558 printf("%g", ((struct complex_double_float
*)native_pointer(obj
))->real
);
560 printf("%g", ((struct complex_double_float
*)native_pointer(obj
))->imag
);
564 #ifdef COMPLEX_LONG_FLOAT_WIDETAG
565 case COMPLEX_LONG_FLOAT_WIDETAG
:
567 printf("%Lg", ((struct complex_long_float
*)native_pointer(obj
))->real
);
569 printf("%Lg", ((struct complex_long_float
*)native_pointer(obj
))->imag
);
573 case SIMPLE_BASE_STRING_WIDETAG
:
574 #ifdef SIMPLE_CHARACTER_STRING_WIDETAG
575 case SIMPLE_CHARACTER_STRING_WIDETAG
: /* FIXME */
578 cptr
= (char *)(ptr
+1);
585 case SIMPLE_VECTOR_WIDETAG
:
587 printf("length = %ld", length
);
590 while (length
-- > 0) {
591 sprintf(buffer
, "%d: ", index
++);
592 print_obj(buffer
, *ptr
++);
596 case INSTANCE_HEADER_WIDETAG
:
598 printf("length = %ld", (long) count
);
600 while (count
-- > 0) {
601 sprintf(buffer
, "%d: ", index
++);
602 print_obj(buffer
, *ptr
++);
606 case SIMPLE_ARRAY_WIDETAG
:
607 case SIMPLE_BIT_VECTOR_WIDETAG
:
608 case SIMPLE_ARRAY_UNSIGNED_BYTE_2_WIDETAG
:
609 case SIMPLE_ARRAY_UNSIGNED_BYTE_4_WIDETAG
:
610 case SIMPLE_ARRAY_UNSIGNED_BYTE_8_WIDETAG
:
611 case SIMPLE_ARRAY_UNSIGNED_BYTE_16_WIDETAG
:
612 case SIMPLE_ARRAY_UNSIGNED_BYTE_32_WIDETAG
:
613 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG
614 case SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG
:
616 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG
617 case SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG
:
619 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG
620 case SIMPLE_ARRAY_SIGNED_BYTE_30_WIDETAG
:
622 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG
623 case SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG
:
625 case SIMPLE_ARRAY_SINGLE_FLOAT_WIDETAG
:
626 case SIMPLE_ARRAY_DOUBLE_FLOAT_WIDETAG
:
627 #ifdef SIMPLE_ARRAY_LONG_FLOAT_WIDETAG
628 case SIMPLE_ARRAY_LONG_FLOAT_WIDETAG
:
630 #ifdef SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG
631 case SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG
:
633 #ifdef SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG
634 case SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG
:
636 #ifdef SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG
637 case SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG
:
639 case COMPLEX_BASE_STRING_WIDETAG
:
640 #ifdef COMPLEX_CHARACTER_STRING_WIDETAG
641 case COMPLEX_CHARACTER_STRING_WIDETAG
:
643 case COMPLEX_VECTOR_NIL_WIDETAG
:
644 case COMPLEX_BIT_VECTOR_WIDETAG
:
645 case COMPLEX_VECTOR_WIDETAG
:
646 case COMPLEX_ARRAY_WIDETAG
:
649 case CODE_HEADER_WIDETAG
:
650 print_slots(code_slots
, count
-1, ptr
);
653 case SIMPLE_FUN_HEADER_WIDETAG
:
654 print_slots(fn_slots
, 5, ptr
);
657 case RETURN_PC_HEADER_WIDETAG
:
658 print_obj("code: ", obj
- (count
* 4));
661 case CLOSURE_HEADER_WIDETAG
:
662 print_slots(closure_slots
, count
, ptr
);
665 case FUNCALLABLE_INSTANCE_HEADER_WIDETAG
:
666 print_slots(funcallable_instance_slots
, count
, ptr
);
669 case VALUE_CELL_HEADER_WIDETAG
:
670 print_slots(value_cell_slots
, 1, ptr
);
675 #ifndef LISP_FEATURE_ALPHA
676 printf("0x%08lx", (unsigned long) *ptr
);
678 printf("0x%016lx", *(lispobj
*)(ptr
+1));
682 case WEAK_POINTER_WIDETAG
:
683 print_slots(weak_pointer_slots
, 1, ptr
);
686 case CHARACTER_WIDETAG
:
687 case UNBOUND_MARKER_WIDETAG
:
689 printf("pointer to an immediate?");
693 print_slots(fdefn_slots
, count
, ptr
);
698 printf("Unknown header object?");
704 static void print_obj(char *prefix
, lispobj obj
)
706 #ifdef LISP_FEATURE_X86_64
707 static void (*verbose_fns
[])(lispobj obj
)
708 = {print_fixnum
, print_struct
, print_otherimm
, print_unknown
,
709 print_unknown
, print_unknown
, print_otherimm
, print_list
,
710 print_fixnum
, print_otherptr
, print_otherimm
, print_unknown
,
711 print_unknown
, print_unknown
, print_otherimm
, print_otherptr
};
712 static void (*brief_fns
[])(lispobj obj
)
713 = {brief_fixnum
, brief_struct
, brief_otherimm
, print_unknown
,
714 print_unknown
, print_unknown
, brief_otherimm
, brief_list
,
715 brief_fixnum
, brief_otherptr
, brief_otherimm
, print_unknown
,
716 print_unknown
, print_unknown
,brief_otherimm
, brief_otherptr
};
718 static void (*verbose_fns
[])(lispobj obj
)
719 = {print_fixnum
, print_struct
, print_otherimm
, print_list
,
720 print_fixnum
, print_otherptr
, print_otherimm
, print_otherptr
};
721 static void (*brief_fns
[])(lispobj obj
)
722 = {brief_fixnum
, brief_struct
, brief_otherimm
, brief_list
,
723 brief_fixnum
, brief_otherptr
, brief_otherimm
, brief_otherptr
};
725 int type
= lowtag_of(obj
);
726 struct var
*var
= lookup_by_obj(obj
);
728 boolean verbose
= cur_depth
< brief_depth
;
730 if (!continue_p(verbose
))
733 if (var
!= NULL
&& var_clock(var
) == cur_clock
)
737 ((obj
& LOWTAG_MASK
) == FUN_POINTER_LOWTAG
||
738 (obj
& LOWTAG_MASK
) == LIST_POINTER_LOWTAG
||
739 (obj
& LOWTAG_MASK
) == INSTANCE_POINTER_LOWTAG
||
740 (obj
& LOWTAG_MASK
) == OTHER_POINTER_LOWTAG
))
741 var
= define_var(NULL
, obj
, 0);
744 var_setclock(var
, cur_clock
);
749 sprintf(buffer
, "$%s=", var_name(var
));
754 printf("%s0x%08lx: ", prefix
, (unsigned long) obj
);
755 if (cur_depth
< brief_depth
) {
756 fputs(lowtag_Names
[type
], stdout
);
757 (*verbose_fns
[type
])(obj
);
760 (*brief_fns
[type
])(obj
);
764 printf("$%s", var_name(var
));
767 printf("$%s=", var_name(var
));
768 (*brief_fns
[type
])(obj
);
782 void print(lispobj obj
)
794 void brief_print(lispobj obj
)
808 brief_print(lispobj obj
)
810 printf("lispobj 0x%lx\n", (unsigned long)obj
);
813 #endif /* defined(LISP_FEATURE_SB_LDB) */