Fixnum and unsigned-fixnum array cleanups.
[sbcl.git] / src / runtime / print.c
1 /* code for low-level debugging/diagnostic output */
2
3 /*
4  * This software is part of the SBCL system. See the README file for
5  * more information.
6  *
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.
12  */
13
14 /*
15  * FIXME:
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.
19  */
20
21 #include <stdio.h>
22 #include <string.h>
23
24 #include "sbcl.h"
25 #include "print.h"
26 #include "runtime.h"
27
28 /* This file can be skipped if we're not supporting LDB. */
29 #if defined(LISP_FEATURE_SB_LDB)
30
31 #include "monitor.h"
32 #include "vars.h"
33 #include "os.h"
34 #include "gencgc-alloc-region.h" /* genesis/thread.h needs this */
35 #include "genesis/static-symbols.h"
36 #include "genesis/primitive-objects.h"
37 #include "genesis/static-symbols.h"
38 #include "genesis/tagnames.h"
39
40 static int max_lines = 20, cur_lines = 0;
41 static int max_depth = 5, brief_depth = 2, cur_depth = 0;
42 static int max_length = 5;
43 static boolean dont_descend = 0, skip_newline = 0;
44 static int cur_clock = 0;
45
46 static void print_obj(char *prefix, lispobj obj);
47
48 #define NEWLINE_OR_RETURN if (continue_p(1)) newline(NULL); else return;
49
50 static void indent(int in)
51 {
52     static char *spaces = "                                                                ";
53
54     while (in > 64) {
55         fputs(spaces, stdout);
56         in -= 64;
57     }
58     if (in != 0)
59         fputs(spaces + 64 - in, stdout);
60 }
61
62 static boolean continue_p(boolean newline)
63 {
64     char buffer[256];
65
66     if (cur_depth >= max_depth || dont_descend)
67         return 0;
68
69     if (newline) {
70         if (skip_newline)
71             skip_newline = 0;
72         else
73             putchar('\n');
74
75         if (cur_lines >= max_lines) {
76             printf("More? [y] ");
77             fflush(stdout);
78
79             if (fgets(buffer, sizeof(buffer), stdin)) {
80                 if (buffer[0] == 'n' || buffer[0] == 'N')
81                     throw_to_monitor();
82                 else
83                     cur_lines = 0;
84             } else {
85                 printf("\nUnable to read response, assuming y.\n");
86                 cur_lines = 0;
87             }
88         }
89     }
90
91     return 1;
92 }
93
94 static void newline(char *label)
95 {
96     cur_lines++;
97     if (label != NULL)
98         fputs(label, stdout);
99     putchar('\t');
100     indent(cur_depth * 2);
101 }
102
103
104 static void brief_fixnum(lispobj obj)
105 {
106 #ifndef LISP_FEATURE_ALPHA
107     printf("%ld", ((long)obj)>>2);
108 #else
109     printf("%d", ((s32)obj)>>2);
110 #endif
111 }
112
113 static void print_fixnum(lispobj obj)
114 {
115 #ifndef LISP_FEATURE_ALPHA
116     printf(": %ld", ((long)obj)>>2);
117 #else
118     printf(": %d", ((s32)obj)>>2);
119 #endif
120 }
121
122 static void brief_otherimm(lispobj obj)
123 {
124     int type, c;
125     char buffer[10];
126
127     type = widetag_of(obj);
128     switch (type) {
129         case CHARACTER_WIDETAG:
130             c = (obj>>8)&0xff;
131             switch (c) {
132                 case '\0':
133                     printf("#\\Null");
134                     break;
135                 case '\n':
136                     printf("#\\Newline");
137                     break;
138                 case '\b':
139                     printf("#\\Backspace");
140                     break;
141                 case '\177':
142                     printf("#\\Delete");
143                     break;
144                 default:
145                     strcpy(buffer, "#\\");
146                     if (c >= 128) {
147                         strcat(buffer, "m-");
148                         c -= 128;
149                     }
150                     if (c < 32) {
151                         strcat(buffer, "c-");
152                         c += '@';
153                     }
154                     printf("%s%c", buffer, c);
155                     break;
156             }
157             break;
158
159         case UNBOUND_MARKER_WIDETAG:
160             printf("<unbound marker>");
161             break;
162
163         default:
164             printf("%s", widetag_names[type >> 2]);
165             break;
166     }
167 }
168
169 static void print_otherimm(lispobj obj)
170 {
171     printf(", %s", widetag_names[widetag_of(obj) >> 2]);
172
173     switch (widetag_of(obj)) {
174         case CHARACTER_WIDETAG:
175             printf(": ");
176             brief_otherimm(obj);
177             break;
178
179         case SAP_WIDETAG:
180         case UNBOUND_MARKER_WIDETAG:
181             break;
182
183         default:
184             printf(": data=%ld", (long) (obj>>8)&0xffffff);
185             break;
186     }
187 }
188
189 static void brief_list(lispobj obj)
190 {
191     int space = 0;
192     int length = 0;
193
194     if (!is_valid_lisp_addr((os_vm_address_t)native_pointer(obj)))
195         printf("(invalid Lisp-level address)");
196     else if (obj == NIL)
197         printf("NIL");
198     else {
199         putchar('(');
200         while (lowtag_of(obj) == LIST_POINTER_LOWTAG) {
201             struct cons *cons = (struct cons *)native_pointer(obj);
202
203             if (space)
204                 putchar(' ');
205             if (++length >= max_length) {
206                 printf("...");
207                 obj = NIL;
208                 break;
209             }
210             print_obj("", cons->car);
211             obj = cons->cdr;
212             space = 1;
213             if (obj == NIL)
214                 break;
215         }
216         if (obj != NIL) {
217             printf(" . ");
218             print_obj("", obj);
219         }
220         putchar(')');
221     }
222 }
223
224 #ifdef LISP_FEATURE_X86_64
225 static void print_unknown(lispobj obj)
226 {
227   printf("unknown object: %p", (void *)obj);
228 }
229 #endif
230
231 static void print_list(lispobj obj)
232 {
233     if (!is_valid_lisp_addr((os_vm_address_t)native_pointer(obj))) {
234         printf("(invalid address)");
235     } else if (obj == NIL) {
236         printf(" (NIL)");
237     } else {
238         struct cons *cons = (struct cons *)native_pointer(obj);
239
240         print_obj("car: ", cons->car);
241         print_obj("cdr: ", cons->cdr);
242     }
243 }
244
245 static void brief_struct(lispobj obj)
246 {
247     struct instance *instance = (struct instance *)native_pointer(obj);
248     if (!is_valid_lisp_addr((os_vm_address_t)instance)) {
249         printf("(invalid address)");
250     } else {
251         printf("#<ptr to 0x%08lx instance>",
252                (unsigned long) instance->slots[0]);
253     }
254 }
255
256 static void print_struct(lispobj obj)
257 {
258     struct instance *instance = (struct instance *)native_pointer(obj);
259     unsigned int i;
260     char buffer[16];
261     if (!is_valid_lisp_addr((os_vm_address_t)instance)) {
262         printf("(invalid address)");
263     } else {
264         print_obj("type: ", ((struct instance *)native_pointer(obj))->slots[0]);
265         for (i = 1; i < HeaderValue(instance->header); i++) {
266             sprintf(buffer, "slot %d: ", i);
267             print_obj(buffer, instance->slots[i]);
268         }
269     }
270 }
271
272 static void brief_otherptr(lispobj obj)
273 {
274     lispobj *ptr, header;
275     int type;
276     struct symbol *symbol;
277     struct vector *vector;
278     char *charptr;
279
280     ptr = (lispobj *) native_pointer(obj);
281
282     if (!is_valid_lisp_addr((os_vm_address_t)obj)) {
283             printf("(invalid address)");
284             return;
285     }
286
287     header = *ptr;
288     type = widetag_of(header);
289     switch (type) {
290         case SYMBOL_HEADER_WIDETAG:
291             symbol = (struct symbol *)ptr;
292             vector = (struct vector *)native_pointer(symbol->name);
293             for (charptr = (char *)vector->data; *charptr != '\0'; charptr++) {
294                 if (*charptr == '"')
295                     putchar('\\');
296                 putchar(*charptr);
297             }
298             break;
299
300         case SIMPLE_BASE_STRING_WIDETAG:
301             vector = (struct vector *)ptr;
302             putchar('"');
303             for (charptr = (char *)vector->data; *charptr != '\0'; charptr++) {
304                 if (*charptr == '"')
305                     putchar('\\');
306                 putchar(*charptr);
307             }
308             putchar('"');
309             break;
310
311         default:
312             printf("#<ptr to ");
313             brief_otherimm(header);
314             putchar('>');
315     }
316 }
317
318 static void print_slots(char **slots, int count, lispobj *ptr)
319 {
320     while (count-- > 0) {
321         if (*slots) {
322             print_obj(*slots++, *ptr++);
323         } else {
324             print_obj("???: ", *ptr++);
325         }
326     }
327 }
328
329 /* FIXME: Yikes! This needs to depend on the values in sbcl.h (or
330  * perhaps be generated automatically by GENESIS as part of
331  * sbcl.h). */
332 static char *symbol_slots[] = {"value: ", "hash: ",
333     "plist: ", "name: ", "package: ",
334 #ifdef LISP_FEATURE_SB_THREAD
335     "tls-index: " ,
336 #endif
337     NULL};
338 static char *ratio_slots[] = {"numer: ", "denom: ", NULL};
339 static char *complex_slots[] = {"real: ", "imag: ", NULL};
340 static char *code_slots[] = {"words: ", "entry: ", "debug: ", NULL};
341 static char *fn_slots[] = {
342     "self: ", "next: ", "name: ", "arglist: ", "type: ", NULL};
343 static char *closure_slots[] = {"fn: ", NULL};
344 static char *funcallable_instance_slots[] = {"fn: ", "lexenv: ", "layout: ", NULL};
345 static char *weak_pointer_slots[] = {"value: ", NULL};
346 static char *fdefn_slots[] = {"name: ", "function: ", "raw_addr: ", NULL};
347 static char *value_cell_slots[] = {"value: ", NULL};
348
349 static void print_otherptr(lispobj obj)
350 {
351     if (!is_valid_lisp_addr((os_vm_address_t)obj)) {
352         printf("(invalid address)");
353     } else {
354 #ifndef LISP_FEATURE_ALPHA
355         lispobj *ptr;
356         unsigned long header;
357         unsigned long length;
358 #else
359         u32 *ptr;
360         u32 header;
361         u32 length;
362 #endif
363         int count, type, index;
364         char *cptr, buffer[16];
365
366         ptr = (lispobj*) native_pointer(obj);
367         if (ptr == NULL) {
368                 printf(" (NULL Pointer)");
369                 return;
370         }
371
372         header = *ptr++;
373         length = fixnum_value(*ptr);
374         count = HeaderValue(header);
375         type = widetag_of(header);
376
377         print_obj("header: ", header);
378         if (!other_immediate_lowtag_p(header)) {
379             NEWLINE_OR_RETURN;
380             printf("(invalid header object)");
381             return;
382         }
383
384         switch (type) {
385             case BIGNUM_WIDETAG:
386                 ptr += count;
387                 NEWLINE_OR_RETURN;
388                 printf("0x");
389                 while (count-- > 0)
390                     printf("%08lx", (unsigned long) *--ptr);
391                 break;
392
393             case RATIO_WIDETAG:
394                 print_slots(ratio_slots, count, ptr);
395                 break;
396
397             case COMPLEX_WIDETAG:
398                 print_slots(complex_slots, count, ptr);
399                 break;
400
401             case SYMBOL_HEADER_WIDETAG:
402                 print_slots(symbol_slots, count, ptr);
403                 break;
404
405 #if N_WORD_BITS == 32
406             case SINGLE_FLOAT_WIDETAG:
407                 NEWLINE_OR_RETURN;
408                 printf("%g", ((struct single_float *)native_pointer(obj))->value);
409                 break;
410 #endif
411             case DOUBLE_FLOAT_WIDETAG:
412                 NEWLINE_OR_RETURN;
413                 printf("%g", ((struct double_float *)native_pointer(obj))->value);
414                 break;
415
416 #ifdef LONG_FLOAT_WIDETAG
417             case LONG_FLOAT_WIDETAG:
418                 NEWLINE_OR_RETURN;
419                 printf("%Lg", ((struct long_float *)native_pointer(obj))->value);
420                 break;
421 #endif
422
423 #ifdef COMPLEX_SINGLE_FLOAT_WIDETAG
424             case COMPLEX_SINGLE_FLOAT_WIDETAG:
425                 NEWLINE_OR_RETURN;
426 #ifdef LISP_FEATURE_X86_64
427                 printf("%g", ((struct complex_single_float *)native_pointer(obj))->data.data[0]);
428 #else
429                 printf("%g", ((struct complex_single_float *)native_pointer(obj))->real);
430 #endif
431                 NEWLINE_OR_RETURN;
432 #ifdef LISP_FEATURE_X86_64
433                 printf("%g", ((struct complex_single_float *)native_pointer(obj))->data.data[1]);
434 #else
435                 printf("%g", ((struct complex_single_float *)native_pointer(obj))->imag);
436 #endif
437                 break;
438 #endif
439
440 #ifdef COMPLEX_DOUBLE_FLOAT_WIDETAG
441             case COMPLEX_DOUBLE_FLOAT_WIDETAG:
442                 NEWLINE_OR_RETURN;
443                 printf("%g", ((struct complex_double_float *)native_pointer(obj))->real);
444                 NEWLINE_OR_RETURN;
445                 printf("%g", ((struct complex_double_float *)native_pointer(obj))->imag);
446                 break;
447 #endif
448
449 #ifdef COMPLEX_LONG_FLOAT_WIDETAG
450             case COMPLEX_LONG_FLOAT_WIDETAG:
451                 NEWLINE_OR_RETURN;
452                 printf("%Lg", ((struct complex_long_float *)native_pointer(obj))->real);
453                 NEWLINE_OR_RETURN;
454                 printf("%Lg", ((struct complex_long_float *)native_pointer(obj))->imag);
455                 break;
456 #endif
457
458             case SIMPLE_BASE_STRING_WIDETAG:
459 #ifdef SIMPLE_CHARACTER_STRING_WIDETAG
460         case SIMPLE_CHARACTER_STRING_WIDETAG: /* FIXME */
461 #endif
462                 NEWLINE_OR_RETURN;
463                 cptr = (char *)(ptr+1);
464                 putchar('"');
465                 while (length-- > 0)
466                     putchar(*cptr++);
467                 putchar('"');
468                 break;
469
470             case SIMPLE_VECTOR_WIDETAG:
471                 NEWLINE_OR_RETURN;
472                 printf("length = %ld", length);
473                 ptr++;
474                 index = 0;
475                 while (length-- > 0) {
476                     sprintf(buffer, "%d: ", index++);
477                     print_obj(buffer, *ptr++);
478                 }
479                 break;
480
481             case INSTANCE_HEADER_WIDETAG:
482                 NEWLINE_OR_RETURN;
483                 printf("length = %ld", (long) count);
484                 index = 0;
485                 while (count-- > 0) {
486                     sprintf(buffer, "%d: ", index++);
487                     print_obj(buffer, *ptr++);
488                 }
489                 break;
490
491             case SIMPLE_ARRAY_WIDETAG:
492             case SIMPLE_BIT_VECTOR_WIDETAG:
493             case SIMPLE_ARRAY_UNSIGNED_BYTE_2_WIDETAG:
494             case SIMPLE_ARRAY_UNSIGNED_BYTE_4_WIDETAG:
495             case SIMPLE_ARRAY_UNSIGNED_BYTE_7_WIDETAG:
496             case SIMPLE_ARRAY_UNSIGNED_BYTE_8_WIDETAG:
497             case SIMPLE_ARRAY_UNSIGNED_BYTE_15_WIDETAG:
498             case SIMPLE_ARRAY_UNSIGNED_BYTE_16_WIDETAG:
499
500             case SIMPLE_ARRAY_UNSIGNED_FIXNUM_WIDETAG:
501
502             case SIMPLE_ARRAY_UNSIGNED_BYTE_31_WIDETAG:
503             case SIMPLE_ARRAY_UNSIGNED_BYTE_32_WIDETAG:
504 #ifdef SIMPLE_ARRAY_UNSIGNED_BYTE_63_WIDETAG
505             case SIMPLE_ARRAY_UNSIGNED_BYTE_63_WIDETAG:
506 #endif
507 #ifdef SIMPLE_ARRAY_UNSIGNED_BYTE_64_WIDETAG
508             case SIMPLE_ARRAY_UNSIGNED_BYTE_64_WIDETAG:
509 #endif
510 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG
511             case SIMPLE_ARRAY_SIGNED_BYTE_8_WIDETAG:
512 #endif
513 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG
514             case SIMPLE_ARRAY_SIGNED_BYTE_16_WIDETAG:
515 #endif
516
517             case SIMPLE_ARRAY_FIXNUM_WIDETAG:
518
519 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG
520             case SIMPLE_ARRAY_SIGNED_BYTE_32_WIDETAG:
521 #endif
522 #ifdef SIMPLE_ARRAY_SIGNED_BYTE_64_WIDETAG
523             case SIMPLE_ARRAY_SIGNED_BYTE_64_WIDETAG:
524 #endif
525             case SIMPLE_ARRAY_SINGLE_FLOAT_WIDETAG:
526             case SIMPLE_ARRAY_DOUBLE_FLOAT_WIDETAG:
527 #ifdef SIMPLE_ARRAY_LONG_FLOAT_WIDETAG
528             case SIMPLE_ARRAY_LONG_FLOAT_WIDETAG:
529 #endif
530 #ifdef SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG
531             case SIMPLE_ARRAY_COMPLEX_SINGLE_FLOAT_WIDETAG:
532 #endif
533 #ifdef SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG
534             case SIMPLE_ARRAY_COMPLEX_DOUBLE_FLOAT_WIDETAG:
535 #endif
536 #ifdef SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG
537             case SIMPLE_ARRAY_COMPLEX_LONG_FLOAT_WIDETAG:
538 #endif
539             case COMPLEX_BASE_STRING_WIDETAG:
540 #ifdef COMPLEX_CHARACTER_STRING_WIDETAG
541         case COMPLEX_CHARACTER_STRING_WIDETAG:
542 #endif
543             case COMPLEX_VECTOR_NIL_WIDETAG:
544             case COMPLEX_BIT_VECTOR_WIDETAG:
545             case COMPLEX_VECTOR_WIDETAG:
546             case COMPLEX_ARRAY_WIDETAG:
547                 break;
548
549             case CODE_HEADER_WIDETAG:
550                 print_slots(code_slots, count-1, ptr);
551                 break;
552
553             case SIMPLE_FUN_HEADER_WIDETAG:
554                 print_slots(fn_slots, 5, ptr);
555                 break;
556
557             case RETURN_PC_HEADER_WIDETAG:
558                 print_obj("code: ", obj - (count * 4));
559                 break;
560
561             case CLOSURE_HEADER_WIDETAG:
562                 print_slots(closure_slots, count, ptr);
563                 break;
564
565             case FUNCALLABLE_INSTANCE_HEADER_WIDETAG:
566                 print_slots(funcallable_instance_slots, count, ptr);
567                 break;
568
569             case VALUE_CELL_HEADER_WIDETAG:
570                 print_slots(value_cell_slots, 1, ptr);
571                 break;
572
573             case SAP_WIDETAG:
574                 NEWLINE_OR_RETURN;
575 #ifndef LISP_FEATURE_ALPHA
576                 printf("0x%08lx", (unsigned long) *ptr);
577 #else
578                 printf("0x%016lx", *(lispobj*)(ptr+1));
579 #endif
580                 break;
581
582             case WEAK_POINTER_WIDETAG:
583                 print_slots(weak_pointer_slots, 1, ptr);
584                 break;
585
586             case CHARACTER_WIDETAG:
587             case UNBOUND_MARKER_WIDETAG:
588                 NEWLINE_OR_RETURN;
589                 printf("pointer to an immediate?");
590                 break;
591
592             case FDEFN_WIDETAG:
593                 print_slots(fdefn_slots, count, ptr);
594                 break;
595
596             default:
597                 NEWLINE_OR_RETURN;
598                 printf("Unknown header object?");
599                 break;
600         }
601     }
602 }
603
604 static void print_obj(char *prefix, lispobj obj)
605 {
606 #ifdef LISP_FEATURE_X86_64
607     static void (*verbose_fns[])(lispobj obj)
608         = {print_fixnum, print_struct, print_otherimm, print_unknown,
609            print_unknown, print_unknown, print_otherimm, print_list,
610            print_fixnum, print_otherptr, print_otherimm, print_unknown,
611            print_unknown, print_unknown, print_otherimm, print_otherptr};
612     static void (*brief_fns[])(lispobj obj)
613         = {brief_fixnum, brief_struct, brief_otherimm, print_unknown,
614            print_unknown,  print_unknown, brief_otherimm, brief_list,
615            brief_fixnum, brief_otherptr, brief_otherimm, print_unknown,
616            print_unknown,  print_unknown,brief_otherimm, brief_otherptr};
617 #else
618     static void (*verbose_fns[])(lispobj obj)
619         = {print_fixnum, print_struct, print_otherimm, print_list,
620            print_fixnum, print_otherptr, print_otherimm, print_otherptr};
621     static void (*brief_fns[])(lispobj obj)
622         = {brief_fixnum, brief_struct, brief_otherimm, brief_list,
623            brief_fixnum, brief_otherptr, brief_otherimm, brief_otherptr};
624 #endif
625     int type = lowtag_of(obj);
626     struct var *var = lookup_by_obj(obj);
627     char buffer[256];
628     boolean verbose = cur_depth < brief_depth;
629
630     if (!continue_p(verbose))
631         return;
632
633     if (var != NULL && var_clock(var) == cur_clock)
634         dont_descend = 1;
635
636     if (var == NULL && is_lisp_pointer(obj))
637         var = define_var(NULL, obj, 0);
638
639     if (var != NULL)
640         var_setclock(var, cur_clock);
641
642     cur_depth++;
643     if (verbose) {
644         if (var != NULL) {
645             sprintf(buffer, "$%s=", var_name(var));
646             newline(buffer);
647         }
648         else
649             newline(NULL);
650         printf("%s0x%08lx: ", prefix, (unsigned long) obj);
651         if (cur_depth < brief_depth) {
652             fputs(lowtag_names[type], stdout);
653             (*verbose_fns[type])(obj);
654         }
655         else
656             (*brief_fns[type])(obj);
657     }
658     else {
659         if (dont_descend)
660             printf("$%s", var_name(var));
661         else {
662             if (var != NULL)
663                 printf("$%s=", var_name(var));
664             (*brief_fns[type])(obj);
665         }
666     }
667     cur_depth--;
668     dont_descend = 0;
669 }
670
671 void reset_printer()
672 {
673     cur_clock++;
674     cur_lines = 0;
675     dont_descend = 0;
676 }
677
678 void print(lispobj obj)
679 {
680     skip_newline = 1;
681     cur_depth = 0;
682     max_depth = 5;
683     max_lines = 20;
684
685     print_obj("", obj);
686
687     putchar('\n');
688 }
689
690 void brief_print(lispobj obj)
691 {
692     skip_newline = 1;
693     cur_depth = 0;
694     max_depth = 1;
695     max_lines = 5000;
696
697     print_obj("", obj);
698     putchar('\n');
699 }
700
701 #else
702
703 void
704 brief_print(lispobj obj)
705 {
706     printf("lispobj 0x%lx\n", (unsigned long)obj);
707 }
708
709 #endif /* defined(LISP_FEATURE_SB_LDB) */