src/runtime/backtrace.c

   1 /*
   2  * simple backtrace facility
   3  */
   4
   5 /*
   6  * This software is part of the SBCL system. See the README file for
   7  * more information.
   8  *
   9  * This software is derived from the CMU CL system, which was
  10  * written at Carnegie Mellon University and released into the
  11  * public domain. The software is in the public domain and is
  12  * provided with absolutely no warranty. See the COPYING and CREDITS
  13  * files for more information.
  14  */
  15
  16 #include <stdio.h>
  17 #include <signal.h>
  18 #include "sbcl.h"
  19 #include "runtime.h"
  20 #include "globals.h"
  21 #include "os.h"
  22 #include "interrupt.h"
  23 #include "lispregs.h"
  24 #ifdef LISP_FEATURE_GENCGC
  25 #include <wchar.h>
  26 #include "arch.h"
  27 #include "gencgc-alloc-region.h"
  28 #include "genesis/compiled-debug-fun.h"
  29 #include "genesis/compiled-debug-info.h"
  30 #include "genesis/package.h"
  31 #endif
  32 #include "genesis/static-symbols.h"
  33 #include "genesis/primitive-objects.h"
  34 #include "thread.h"
  35
  36 #ifdef LISP_FEATURE_OS_PROVIDES_DLADDR
  37 /* __USE_GNU needed if we want dladdr() and Dl_Info from glibc. */
  38 #define __USE_GNU
  39 #include "dlfcn.h"
  40 #endif
  41
  42 #if !(defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64))
  43
  44 /* KLUDGE: Sigh ... I know what the call frame looks like and it had
  45  * better not change. */
  46
  47 struct call_frame {
  48 #ifndef LISP_FEATURE_ALPHA
  49         struct call_frame *old_cont;
  50 #else
  51         u32 old_cont;
  52 #endif
  53         lispobj saved_lra;
  54         lispobj code;
  55         lispobj other_state[5];
  56 };
  57
  58 struct call_info {
  59 #ifndef LISP_FEATURE_ALPHA
  60     struct call_frame *frame;
  61 #else
  62     u32 frame;
  63 #endif
  64     int interrupted;
  65 #ifndef LISP_FEATURE_ALPHA
  66     struct code *code;
  67 #else
  68     u32 code;
  69 #endif
  70     lispobj lra;
  71     int pc; /* Note: this is the trace file offset, not the actual pc. */
  72 };
  73
  74 #define HEADER_LENGTH(header) ((header)>>8)
  75
  76 static int previous_info(struct call_info *info);
  77
  78 static struct code *
  79 code_pointer(lispobj object)
  80 {
  81     lispobj *headerp, header;
  82     int type, len;
  83
  84     headerp = (lispobj *) native_pointer(object);
  85     header = *headerp;
  86     type = widetag_of(header);
  87
  88     switch (type) {
  89         case CODE_HEADER_WIDETAG:
  90             break;
  91         case RETURN_PC_HEADER_WIDETAG:
  92         case SIMPLE_FUN_HEADER_WIDETAG:
  93             len = HEADER_LENGTH(header);
  94             if (len == 0)
  95                 headerp = NULL;
  96             else
  97                 headerp -= len;
  98             break;
  99         default:
 100             headerp = NULL;
 101     }
 102
 103     return (struct code *) headerp;
 104 }
 105
 106 static boolean
 107 cs_valid_pointer_p(struct call_frame *pointer)
 108 {
 109     struct thread *thread=arch_os_get_current_thread();
 110     return (((char *) thread->control_stack_start <= (char *) pointer) &&
 111             ((char *) pointer < (char *) current_control_stack_pointer));
 112 }
 113
 114 static void
 115 call_info_from_lisp_state(struct call_info *info)
 116 {
 117     info->frame = (struct call_frame *)current_control_frame_pointer;
 118     info->interrupted = 0;
 119     info->code = NULL;
 120     info->lra = 0;
 121     info->pc = 0;
 122
 123     previous_info(info);
 124 }
 125
 126 static void
 127 call_info_from_context(struct call_info *info, os_context_t *context)
 128 {
 129     unsigned long pc;
 130
 131     info->interrupted = 1;
 132     if (lowtag_of(*os_context_register_addr(context, reg_CODE))
 133         == FUN_POINTER_LOWTAG) {
 134         /* We tried to call a function, but crapped out before $CODE could
 135          * be fixed up. Probably an undefined function. */
 136         info->frame =
 137             (struct call_frame *)(unsigned long)
 138                 (*os_context_register_addr(context, reg_OCFP));
 139         info->lra = (lispobj)(*os_context_register_addr(context, reg_LRA));
 140         info->code = code_pointer(info->lra);
 141         pc = (unsigned long)native_pointer(info->lra);
 142     }
 143     else {
 144         info->frame =
 145             (struct call_frame *)(unsigned long)
 146                 (*os_context_register_addr(context, reg_CFP));
 147         info->code =
 148             code_pointer(*os_context_register_addr(context, reg_CODE));
 149         info->lra = NIL;
 150         pc = *os_context_pc_addr(context);
 151     }
 152     if (info->code != NULL)
 153         info->pc = pc - (unsigned long) info->code -
 154 #ifndef LISP_FEATURE_ALPHA
 155             (HEADER_LENGTH(info->code->header) * sizeof(lispobj));
 156 #else
 157             (HEADER_LENGTH(((struct code *)info->code)->header) * sizeof(lispobj));
 158 #endif
 159     else
 160         info->pc = 0;
 161 }
 162
 163 static int
 164 previous_info(struct call_info *info)
 165 {
 166     struct call_frame *this_frame;
 167     struct thread *thread=arch_os_get_current_thread();
 168     int free_ici;
 169
 170     if (!cs_valid_pointer_p(info->frame)) {
 171         printf("Bogus callee value (0x%08lx).\n", (unsigned long)info->frame);
 172         return 0;
 173     }
 174
 175     this_frame = info->frame;
 176     info->lra = this_frame->saved_lra;
 177     info->frame = this_frame->old_cont;
 178     info->interrupted = 0;
 179
 180     if (info->frame == NULL || info->frame == this_frame)
 181         return 0;
 182
 183     if (info->lra == NIL) {
 184         /* We were interrupted. Find the correct signal context. */
 185         free_ici = fixnum_value(SymbolValue(FREE_INTERRUPT_CONTEXT_INDEX,thread));
 186         while (free_ici-- > 0) {
 187             os_context_t *context =
 188                 thread->interrupt_contexts[free_ici];
 189             if ((struct call_frame *)(unsigned long)
 190                     (*os_context_register_addr(context, reg_CFP))
 191                 == info->frame) {
 192                 call_info_from_context(info, context);
 193                 break;
 194             }
 195         }
 196     }
 197     else {
 198         info->code = code_pointer(info->lra);
 199         if (info->code != NULL)
 200             info->pc = (unsigned long)native_pointer(info->lra) -
 201                 (unsigned long)info->code -
 202 #ifndef LISP_FEATURE_ALPHA
 203                 (HEADER_LENGTH(info->code->header) * sizeof(lispobj));
 204 #else
 205                 (HEADER_LENGTH(((struct code *)info->code)->header) * sizeof(lispobj));
 206 #endif
 207         else
 208             info->pc = 0;
 209     }
 210
 211     return 1;
 212 }
 213
 214 void
 215 backtrace(int nframes)
 216 {
 217     struct call_info info;
 218
 219     call_info_from_lisp_state(&info);
 220
 221     do {
 222         printf("<Frame 0x%08lx%s, ", (unsigned long) info.frame,
 223                 info.interrupted ? " [interrupted]" : "");
 224
 225         if (info.code != (struct code *) 0) {
 226             lispobj function;
 227
 228             printf("CODE: 0x%08lX, ", (unsigned long) info.code | OTHER_POINTER_LOWTAG);
 229
 230 #ifndef LISP_FEATURE_ALPHA
 231             function = info.code->entry_points;
 232 #else
 233             function = ((struct code *)info.code)->entry_points;
 234 #endif
 235             while (function != NIL) {
 236                 struct simple_fun *header;
 237                 lispobj name;
 238
 239                 header = (struct simple_fun *) native_pointer(function);
 240                 name = header->name;
 241
 242                 if (lowtag_of(name) == OTHER_POINTER_LOWTAG) {
 243                     lispobj *object;
 244
 245                     object = (lispobj *) native_pointer(name);
 246
 247                     if (widetag_of(*object) == SYMBOL_HEADER_WIDETAG) {
 248                         struct symbol *symbol;
 249
 250                         symbol = (struct symbol *) object;
 251                         object = (lispobj *) native_pointer(symbol->name);
 252                     }
 253                     if (widetag_of(*object) == SIMPLE_BASE_STRING_WIDETAG) {
 254                         struct vector *string;
 255
 256                         string = (struct vector *) object;
 257                         printf("%s, ", (char *) string->data);
 258                     } else
 259                         /* FIXME: broken from (VECTOR NIL) */
 260                         printf("(Not simple string??\?), ");
 261                 } else
 262                     printf("(Not other pointer??\?), ");
 263
 264
 265                 function = header->next;
 266             }
 267         }
 268         else
 269             printf("CODE: ???, ");
 270
 271         if (info.lra != NIL)
 272             printf("LRA: 0x%08lx, ", (unsigned long)info.lra);
 273         else
 274             printf("<no LRA>, ");
 275
 276         if (info.pc)
 277             printf("PC: 0x%x>\n", info.pc);
 278         else
 279             printf("PC: ??\?>\n");
 280
 281     } while (--nframes > 0 && previous_info(&info));
 282 }
 283
 284 #else
 285
 286 static int
 287 altstack_pointer_p (void *p) {
 288 #ifndef LISP_FEATURE_WIN32
 289     void* stack_start = arch_os_get_current_thread() + dynamic_values_bytes;
 290     void* stack_end = stack_start + 32*SIGSTKSZ;
 291
 292     return (p > stack_start && p <= stack_end);
 293 #else
 294     /* Win32 doesn't do altstack */
 295     return 0;
 296 #endif
 297 }
 298
 299 static int
 300 stack_pointer_p (void *p)
 301 {
 302   /* we are using sizeof(long) here, because that is the right value on both
 303    * x86 and x86-64.  (But note that false positives would not cause much harm
 304    * given the heuristical nature of x86_call_context.) */
 305   unsigned long stack_alignment = sizeof(long);
 306
 307   return (altstack_pointer_p(p)
 308           || (p < (void *) arch_os_get_current_thread()->control_stack_end
 309               && (p > (void *) &p || altstack_pointer_p(&p))
 310               && (((unsigned long) p) & (stack_alignment-1)) == 0));
 311 }
 312
 313 static int
 314 ra_pointer_p (void *ra)
 315 {
 316   /* the check against 4096 is still a mystery to everyone interviewed about
 317    * it, but recent changes to sb-sprof seem to suggest that such values
 318    * do occur sometimes. */
 319   return ((unsigned long) ra) > 4096 && !stack_pointer_p (ra);
 320 }
 321
 322 static int
 323 x86_call_context (void *fp, void **ra, void **ocfp)
 324 {
 325   void *lisp_ocfp;
 326   void *lisp_ra;
 327   void *c_ocfp;
 328   void *c_ra;
 329   int lisp_valid_p, c_valid_p;
 330
 331   if (!stack_pointer_p(fp))
 332     return 0;
 333
 334   c_ocfp    = *((void **) fp);
 335   c_ra      = *((void **) fp + 1);
 336   lisp_ocfp = *((void **) fp - 1);
 337   lisp_ra   = *((void **) fp - 2);
 338
 339   lisp_valid_p = (lisp_ocfp > fp
 340                   && stack_pointer_p(lisp_ocfp)
 341                   && ra_pointer_p(lisp_ra));
 342   c_valid_p = (c_ocfp > fp
 343                && stack_pointer_p(c_ocfp)
 344                && ra_pointer_p(c_ra));
 345
 346   if (lisp_valid_p && c_valid_p) {
 347     void *lisp_path_fp;
 348     void *c_path_fp;
 349     void *dummy;
 350
 351     int lisp_path_p = x86_call_context(lisp_ocfp, &lisp_path_fp, &dummy);
 352     int c_path_p = x86_call_context(c_ocfp, &c_path_fp, &dummy);
 353
 354     if (lisp_path_p && c_path_p) {
 355 #if defined __FreeBSD__ && __FreeBSD_version > 400000
 356       if (lisp_ocfp > c_ocfp)
 357         *ra = lisp_ra, *ocfp = lisp_ocfp;
 358       else
 359         *ra = c_ra, *ocfp = c_ocfp;
 360 #else
 361       *ra = lisp_ra, *ocfp = lisp_ocfp;
 362 #endif
 363     }
 364     else if (lisp_path_p)
 365       *ra = lisp_ra, *ocfp = lisp_ocfp;
 366     else if (c_path_p)
 367       *ra = c_ra, *ocfp = c_ocfp;
 368     else
 369       return 0;
 370   }
 371   else if (lisp_valid_p)
 372     *ra = lisp_ra, *ocfp = lisp_ocfp;
 373   else if (c_valid_p)
 374     *ra = c_ra, *ocfp = c_ocfp;
 375   else
 376     return 0;
 377
 378   return 1;
 379 }
 380
 381 struct compiled_debug_fun *
 382 debug_function_from_pc (struct code* code, void *pc)
 383 {
 384   unsigned long code_header_len = sizeof(lispobj) * HeaderValue(code->header);
 385   unsigned long offset
 386     = (unsigned long) pc - (unsigned long) code - code_header_len;
 387   struct compiled_debug_fun *df;
 388   struct compiled_debug_info *di;
 389   struct vector *v;
 390   int i, len;
 391
 392   if (lowtag_of(code->debug_info) != INSTANCE_POINTER_LOWTAG)
 393     return 0;
 394
 395   di = (struct compiled_debug_info *) native_pointer(code->debug_info);
 396   v = (struct vector *) native_pointer(di->fun_map);
 397   len = fixnum_value(v->length);
 398   df = (struct compiled_debug_fun *) native_pointer(v->data[0]);
 399
 400   if (len == 1)
 401     return df;
 402
 403   for (i = 1;; i += 2) {
 404     unsigned next_pc;
 405
 406     if (i == len)
 407       return ((struct compiled_debug_fun *) native_pointer(v->data[i - 1]));
 408
 409     if (offset >= fixnum_value(df->elsewhere_pc)) {
 410       struct compiled_debug_fun *p
 411         = ((struct compiled_debug_fun *) native_pointer(v->data[i + 1]));
 412       next_pc = fixnum_value(p->elsewhere_pc);
 413     } else
 414       next_pc = fixnum_value(v->data[i]);
 415
 416     if (offset < next_pc)
 417       return ((struct compiled_debug_fun *) native_pointer(v->data[i - 1]));
 418   }
 419
 420   return NULL;
 421 }
 422
 423 static void
 424 sbcl_putwc(wchar_t c, FILE *file)
 425 {
 426 #ifdef LISP_FEATURE_OS_PROVIDES_PUTWC
 427     putwc(c, file);
 428 #else
 429     if (c < 256) {
 430         fputc(c, file);
 431     } else {
 432         fputc('?', file);
 433     }
 434 #endif
 435 }
 436
 437 static void
 438 print_string (lispobj *object)
 439 {
 440   int tag = widetag_of(*object);
 441   struct vector *vector = (struct vector *) object;
 442
 443 #define doit(TYPE)                              \
 444   do {                                          \
 445     int i;                                      \
 446     int n = fixnum_value(vector->length);       \
 447     TYPE *data = (TYPE *) vector->data;         \
 448     for (i = 0; i < n; i++) {                   \
 449       wchar_t c = (wchar_t) data[i];            \
 450       if (c == '\\' || c == '"')                \
 451         putchar('\\');                          \
 452       sbcl_putwc(c, stdout);                    \
 453     }                                           \
 454   } while (0)
 455
 456   switch (tag) {
 457   case SIMPLE_BASE_STRING_WIDETAG:
 458     doit(unsigned char);
 459     break;
 460 #ifdef SIMPLE_CHARACTER_STRING_WIDETAG
 461   case SIMPLE_CHARACTER_STRING_WIDETAG:
 462     doit(unsigned int);
 463     break;
 464 #endif
 465   default:
 466     printf("<??? type %d>", tag);
 467   }
 468 #undef doit
 469 }
 470
 471 static void
 472 print_entry_name (lispobj name)
 473 {
 474   if (lowtag_of (name) == LIST_POINTER_LOWTAG) {
 475     putchar('(');
 476     while (name != NIL) {
 477       struct cons *cons = (struct cons *) native_pointer(name);
 478       print_entry_name(cons->car);
 479       name = cons->cdr;
 480       if (name != NIL)
 481         putchar(' ');
 482     }
 483     putchar(')');
 484   } else if (lowtag_of(name) == OTHER_POINTER_LOWTAG) {
 485     lispobj *object = (lispobj *) native_pointer(name);
 486     if (widetag_of(*object) == SYMBOL_HEADER_WIDETAG) {
 487       struct symbol *symbol = (struct symbol *) object;
 488       if (symbol->package != NIL) {
 489         struct package *pkg
 490           = (struct package *) native_pointer(symbol->package);
 491         lispobj pkg_name = pkg->_name;
 492         print_string(native_pointer(pkg_name));
 493         fputs("::", stdout);
 494       }
 495       print_string(native_pointer(symbol->name));
 496     } else if (widetag_of(*object) == SIMPLE_BASE_STRING_WIDETAG) {
 497          putchar('"');
 498          print_string(object);
 499          putchar('"');
 500 #ifdef SIMPLE_CHARACTER_STRING_WIDETAG
 501       } else if (widetag_of(*object) == SIMPLE_CHARACTER_STRING_WIDETAG) {
 502          putchar('"');
 503          print_string(object);
 504          putchar('"');
 505 #endif
 506     } else {
 507       printf("<??? type %d>", (int) widetag_of(*object));
 508     }
 509   } else {
 510     printf("<??? lowtag %d>", (int) lowtag_of(name));
 511   }
 512 }
 513
 514 static void
 515 print_entry_points (struct code *code)
 516 {
 517   lispobj function = code->entry_points;
 518
 519   while (function != NIL) {
 520     struct simple_fun *header = (struct simple_fun *) native_pointer(function);
 521     print_entry_name(header->name);
 522
 523     function = header->next;
 524     if (function != NIL)
 525       printf (", ");
 526   }
 527 }
 528
 529 /* This function has been split from backtrace() to enable Lisp
 530  * backtraces from gdb with call backtrace_from_fp(...). Useful for
 531  * example when debugging threading deadlocks.
 532  */
 533 void
 534 backtrace_from_fp(void *fp, int nframes)
 535 {
 536   int i;
 537
 538   for (i = 0; i < nframes; ++i) {
 539     lispobj *p;
 540     void *ra;
 541     void *next_fp;
 542
 543     if (!x86_call_context(fp, &ra, &next_fp))
 544       break;
 545
 546     printf("%4d: ", i);
 547
 548     p = (lispobj *) component_ptr_from_pc((lispobj *) ra);
 549     if (p) {
 550       struct code *cp = (struct code *) p;
 551       struct compiled_debug_fun *df = debug_function_from_pc(cp, ra);
 552       if (df)
 553         print_entry_name(df->name);
 554       else
 555         print_entry_points(cp);
 556     } else {
 557 #ifdef LISP_FEATURE_OS_PROVIDES_DLADDR
 558         Dl_info info;
 559         if (dladdr(ra, &info)) {
 560             printf("Foreign function %s, fp = 0x%lx, ra = 0x%lx",
 561                    info.dli_sname,
 562                    (unsigned long) next_fp,
 563                    (unsigned long) ra);
 564         } else
 565 #endif
 566         printf("Foreign fp = 0x%lx, ra = 0x%lx",
 567                (unsigned long) next_fp,
 568                (unsigned long) ra);
 569     }
 570
 571     putchar('\n');
 572     fp = next_fp;
 573   }
 574 }
 575
 576 void
 577 backtrace(int nframes)
 578 {
 579   void *fp;
 580
 581 #if defined(LISP_FEATURE_X86)
 582   asm("movl %%ebp,%0" : "=g" (fp));
 583 #elif defined (LISP_FEATURE_X86_64)
 584   asm("movq %%rbp,%0" : "=g" (fp));
 585 #else
 586 #error "How did we get here?"
 587 #endif
 588
 589   backtrace_from_fp(fp, nframes);
 590 }
 591
 592 #endif