mono/mini/unwind.c

   1 /*
   2  * unwind.c: Stack Unwinding Interface
   3  *
   4  * Authors:
   5  *   Zoltan Varga (vargaz@gmail.com)
   6  *
   7  * (C) 2008 Novell, Inc.
   8  */
   9
  10 #include "mini.h"
  11 #include "mini-unwind.h"
  12
  13 #include <mono/utils/mono-counters.h>
  14 #include <mono/utils/freebsd-dwarf.h>
  15 #include <mono/utils/hazard-pointer.h>
  16 #include <mono/metadata/threads-types.h>
  17 #include <mono/metadata/mono-endian.h>
  18
  19 typedef enum {
  20         LOC_SAME,
  21         LOC_OFFSET
  22 } LocType;
  23
  24 typedef struct {
  25         LocType loc_type;
  26         int offset;
  27 } Loc;
  28
  29 typedef struct {
  30         guint32 len;
  31         guint8 info [MONO_ZERO_LEN_ARRAY];
  32 } MonoUnwindInfo;
  33
  34 static CRITICAL_SECTION unwind_mutex;
  35
  36 static MonoUnwindInfo **cached_info;
  37 static int cached_info_next, cached_info_size;
  38 static GSList *cached_info_list;
  39 /* Statistics */
  40 static int unwind_info_size;
  41
  42 #define unwind_lock() EnterCriticalSection (&unwind_mutex)
  43 #define unwind_unlock() LeaveCriticalSection (&unwind_mutex)
  44
  45 #ifdef TARGET_AMD64
  46 static int map_hw_reg_to_dwarf_reg [] = { 0, 2, 1, 3, 7, 6, 4, 5, 8, 9, 10, 11, 12, 13, 14, 15, 16 };
  47 #define NUM_REGS AMD64_NREG
  48 #define DWARF_DATA_ALIGN (-8)
  49 #define DWARF_PC_REG (mono_hw_reg_to_dwarf_reg (AMD64_RIP))
  50 #elif defined(TARGET_ARM)
  51 // http://infocenter.arm.com/help/topic/com.arm.doc.ihi0040a/IHI0040A_aadwarf.pdf
  52 static int map_hw_reg_to_dwarf_reg [] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 };
  53 #define NUM_REGS 16
  54 #define DWARF_DATA_ALIGN (-4)
  55 #define DWARF_PC_REG (mono_hw_reg_to_dwarf_reg (ARMREG_LR))
  56 #elif defined (TARGET_X86)
  57 static int map_hw_reg_to_dwarf_reg [] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 };
  58 /* + 1 is for IP */
  59 #define NUM_REGS X86_NREG + 1
  60 #define DWARF_DATA_ALIGN (-4)
  61 #define DWARF_PC_REG (mono_hw_reg_to_dwarf_reg (X86_NREG))
  62 #elif defined (TARGET_POWERPC)
  63 // http://refspecs.linuxfoundation.org/ELF/ppc64/PPC-elf64abi-1.9.html
  64 static int map_hw_reg_to_dwarf_reg [] = { 0, 1, 2, 3, 4, 5, 6, 7, 8,
  65                                                                                   9, 10, 11, 12, 13, 14, 15, 16,
  66                                                                                   17, 18, 19, 20, 21, 22, 23, 24,
  67                                                                                   25, 26, 27, 28, 29, 30, 31 };
  68 #define NUM_REGS 110
  69 #define DWARF_DATA_ALIGN (-(gint32)sizeof (mgreg_t))
  70 #define DWARF_PC_REG 108
  71 #elif defined (TARGET_S390X)
  72 static int map_hw_reg_to_dwarf_reg [] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 };
  73 #define NUM_REGS 16
  74 #define DWARF_DATA_ALIGN (-8)
  75 #define DWARF_PC_REG (mono_hw_reg_to_dwarf_reg (14))
  76 #elif defined (TARGET_MIPS)
  77 /* FIXME: */
  78 static int map_hw_reg_to_dwarf_reg [32] = {
  79         0, 1, 2, 3, 4, 5, 6, 7,
  80         8, 9, 10, 11, 12, 13, 14, 15,
  81         16, 17, 18, 19, 20, 21, 22, 23,
  82         24, 25, 26, 27, 28, 29, 30, 31
  83 };
  84 #define NUM_REGS 32
  85 #define DWARF_DATA_ALIGN (-(gint32)sizeof (mgreg_t))
  86 #define DWARF_PC_REG (mono_hw_reg_to_dwarf_reg (mips_ra))
  87 #else
  88 static int map_hw_reg_to_dwarf_reg [16];
  89 #define NUM_REGS 16
  90 #define DWARF_DATA_ALIGN 0
  91 #define DWARF_PC_REG -1
  92 #endif
  93
  94 static gboolean dwarf_reg_to_hw_reg_inited;
  95
  96 static int map_dwarf_reg_to_hw_reg [NUM_REGS];
  97
  98 /*
  99  * mono_hw_reg_to_dwarf_reg:
 100  *
 101  *   Map the hardware register number REG to the register number used by DWARF.
 102  */
 103 int
 104 mono_hw_reg_to_dwarf_reg (int reg)
 105 {
 106 #ifdef TARGET_POWERPC
 107         if (reg == ppc_lr)
 108                 return 108;
 109         else
 110                 g_assert (reg < NUM_REGS);
 111 #endif
 112
 113         if (NUM_REGS == 0) {
 114                 g_assert_not_reached ();
 115                 return -1;
 116         } else {
 117                 return map_hw_reg_to_dwarf_reg [reg];
 118         }
 119 }
 120
 121 static void
 122 init_reg_map (void)
 123 {
 124         int i;
 125
 126         g_assert (NUM_REGS > 0);
 127         for (i = 0; i < sizeof (map_hw_reg_to_dwarf_reg) / sizeof (int); ++i) {
 128                 map_dwarf_reg_to_hw_reg [mono_hw_reg_to_dwarf_reg (i)] = i;
 129         }
 130
 131 #ifdef TARGET_POWERPC
 132         map_dwarf_reg_to_hw_reg [DWARF_PC_REG] = ppc_lr;
 133 #endif
 134
 135         mono_memory_barrier ();
 136         dwarf_reg_to_hw_reg_inited = TRUE;
 137 }
 138
 139 int
 140 mono_dwarf_reg_to_hw_reg (int reg)
 141 {
 142         if (!dwarf_reg_to_hw_reg_inited)
 143                 init_reg_map ();
 144
 145         return map_dwarf_reg_to_hw_reg [reg];
 146 }
 147
 148 static G_GNUC_UNUSED void
 149 encode_uleb128 (guint32 value, guint8 *buf, guint8 **endbuf)
 150 {
 151         guint8 *p = buf;
 152
 153         do {
 154                 guint8 b = value & 0x7f;
 155                 value >>= 7;
 156                 if (value != 0) /* more bytes to come */
 157                         b |= 0x80;
 158                 *p ++ = b;
 159         } while (value);
 160
 161         *endbuf = p;
 162 }
 163
 164 static G_GNUC_UNUSED void
 165 encode_sleb128 (gint32 value, guint8 *buf, guint8 **endbuf)
 166 {
 167         gboolean more = 1;
 168         gboolean negative = (value < 0);
 169         guint32 size = 32;
 170         guint8 byte;
 171         guint8 *p = buf;
 172
 173         while (more) {
 174                 byte = value & 0x7f;
 175                 value >>= 7;
 176                 /* the following is unnecessary if the
 177                  * implementation of >>= uses an arithmetic rather
 178                  * than logical shift for a signed left operand
 179                  */
 180                 if (negative)
 181                         /* sign extend */
 182                         value |= - (1 <<(size - 7));
 183                 /* sign bit of byte is second high order bit (0x40) */
 184                 if ((value == 0 && !(byte & 0x40)) ||
 185                         (value == -1 && (byte & 0x40)))
 186                         more = 0;
 187                 else
 188                         byte |= 0x80;
 189                 *p ++= byte;
 190         }
 191
 192         *endbuf = p;
 193 }
 194
 195 static inline guint32
 196 decode_uleb128 (guint8 *buf, guint8 **endbuf)
 197 {
 198         guint8 *p = buf;
 199         guint32 res = 0;
 200         int shift = 0;
 201
 202         while (TRUE) {
 203                 guint8 b = *p;
 204                 p ++;
 205
 206                 res = res | (((int)(b & 0x7f)) << shift);
 207                 if (!(b & 0x80))
 208                         break;
 209                 shift += 7;
 210         }
 211
 212         *endbuf = p;
 213
 214         return res;
 215 }
 216
 217 static inline gint32
 218 decode_sleb128 (guint8 *buf, guint8 **endbuf)
 219 {
 220         guint8 *p = buf;
 221         gint32 res = 0;
 222         int shift = 0;
 223
 224         while (TRUE) {
 225                 guint8 b = *p;
 226                 p ++;
 227
 228                 res = res | (((int)(b & 0x7f)) << shift);
 229                 shift += 7;
 230                 if (!(b & 0x80)) {
 231                         if (shift < 32 && (b & 0x40))
 232                                 res |= - (1 << shift);
 233                         break;
 234                 }
 235         }
 236
 237         *endbuf = p;
 238
 239         return res;
 240 }
 241
 242 /*
 243  * mono_unwind_ops_encode:
 244  *
 245  *   Encode the unwind ops in UNWIND_OPS into the compact DWARF encoding.
 246  * Return a pointer to malloc'ed memory.
 247  */
 248 guint8*
 249 mono_unwind_ops_encode (GSList *unwind_ops, guint32 *out_len)
 250 {
 251         GSList *l;
 252         MonoUnwindOp *op;
 253         int loc;
 254         guint8 *buf, *p, *res;
 255
 256         p = buf = g_malloc0 (4096);
 257
 258         loc = 0;
 259         l = unwind_ops;
 260         for (; l; l = l->next) {
 261                 int reg;
 262
 263                 op = l->data;
 264
 265                 /* Convert the register from the hw encoding to the dwarf encoding */
 266                 reg = mono_hw_reg_to_dwarf_reg (op->reg);
 267
 268                 /* Emit an advance_loc if neccesary */
 269                 while (op->when > loc) {
 270                         if (op->when - loc < 32) {
 271                                 *p ++ = DW_CFA_advance_loc | (op->when - loc);
 272                                 loc = op->when;
 273                         } else {
 274                                 *p ++ = DW_CFA_advance_loc | (30);
 275                                 loc += 30;
 276                         }
 277                 }
 278
 279                 switch (op->op) {
 280                 case DW_CFA_def_cfa:
 281                         *p ++ = op->op;
 282                         encode_uleb128 (reg, p, &p);
 283                         encode_uleb128 (op->val, p, &p);
 284                         break;
 285                 case DW_CFA_def_cfa_offset:
 286                         *p ++ = op->op;
 287                         encode_uleb128 (op->val, p, &p);
 288                         break;
 289                 case DW_CFA_def_cfa_register:
 290                         *p ++ = op->op;
 291                         encode_uleb128 (reg, p, &p);
 292                         break;
 293                 case DW_CFA_offset:
 294                         if (reg > 63) {
 295                                 *p ++ = DW_CFA_offset_extended_sf;
 296                                 encode_uleb128 (reg, p, &p);
 297                                 encode_sleb128 (op->val / DWARF_DATA_ALIGN, p, &p);
 298                         } else {
 299                                 *p ++ = DW_CFA_offset | reg;
 300                                 encode_uleb128 (op->val / DWARF_DATA_ALIGN, p, &p);
 301                         }
 302                         break;
 303                 default:
 304                         g_assert_not_reached ();
 305                         break;
 306                 }
 307         }
 308
 309         g_assert (p - buf < 4096);
 310         *out_len = p - buf;
 311         res = g_malloc (p - buf);
 312         memcpy (res, buf, p - buf);
 313         g_free (buf);
 314         return res;
 315 }
 316
 317 #if 0
 318 #define UNW_DEBUG(stmt) do { stmt; } while (0)
 319 #else
 320 #define UNW_DEBUG(stmt) do { } while (0)
 321 #endif
 322
 323 static G_GNUC_UNUSED void
 324 print_dwarf_state (int cfa_reg, int cfa_offset, int ip, int nregs, Loc *locations)
 325 {
 326         int i;
 327
 328         printf ("\t%x: cfa=r%d+%d ", ip, cfa_reg, cfa_offset);
 329
 330         for (i = 0; i < nregs; ++i)
 331                 if (locations [i].loc_type == LOC_OFFSET)
 332                         printf ("r%d@%d(cfa) ", i, locations [i].offset);
 333         printf ("\n");
 334 }
 335
 336 /*
 337  * Given the state of the current frame as stored in REGS, execute the unwind
 338  * operations in unwind_info until the location counter reaches POS. The result is
 339  * stored back into REGS. OUT_CFA will receive the value of the CFA.
 340  * If SAVE_LOCATIONS is non-NULL, it should point to an array of size SAVE_LOCATIONS_LEN.
 341  * On return, the nth entry will point to the address of the stack slot where register
 342  * N was saved, or NULL, if it was not saved by this frame.
 343  * This function is signal safe.
 344  */
 345 void
 346 mono_unwind_frame (guint8 *unwind_info, guint32 unwind_info_len,
 347                                    guint8 *start_ip, guint8 *end_ip, guint8 *ip, mgreg_t *regs, int nregs,
 348                                    mgreg_t **save_locations, int save_locations_len,
 349                                    guint8 **out_cfa)
 350 {
 351         Loc locations [NUM_REGS];
 352         int i, pos, reg, cfa_reg, cfa_offset;
 353         guint8 *p;
 354         guint8 *cfa_val;
 355
 356         for (i = 0; i < NUM_REGS; ++i)
 357                 locations [i].loc_type = LOC_SAME;
 358
 359         p = unwind_info;
 360         pos = 0;
 361         cfa_reg = -1;
 362         cfa_offset = -1;
 363         while (pos <= ip - start_ip && p < unwind_info + unwind_info_len) {
 364                 int op = *p & 0xc0;
 365
 366                 switch (op) {
 367                 case DW_CFA_advance_loc:
 368                         UNW_DEBUG (print_dwarf_state (cfa_reg, cfa_offset, pos, nregs, locations));
 369                         pos += *p & 0x3f;
 370                         p ++;
 371                         break;
 372                 case DW_CFA_offset:
 373                         reg = *p & 0x3f;
 374                         p ++;
 375                         locations [reg].loc_type = LOC_OFFSET;
 376                         locations [reg].offset = decode_uleb128 (p, &p) * DWARF_DATA_ALIGN;
 377                         break;
 378                 case 0: {
 379                         int ext_op = *p;
 380                         p ++;
 381                         switch (ext_op) {
 382                         case DW_CFA_def_cfa:
 383                                 cfa_reg = decode_uleb128 (p, &p);
 384                                 cfa_offset = decode_uleb128 (p, &p);
 385                                 break;
 386                         case DW_CFA_def_cfa_offset:
 387                                 cfa_offset = decode_uleb128 (p, &p);
 388                                 break;
 389                         case DW_CFA_def_cfa_register:
 390                                 cfa_reg = decode_uleb128 (p, &p);
 391                                 break;
 392                         case DW_CFA_offset_extended_sf:
 393                                 reg = decode_uleb128 (p, &p);
 394                                 locations [reg].loc_type = LOC_OFFSET;
 395                                 locations [reg].offset = decode_sleb128 (p, &p) * DWARF_DATA_ALIGN;
 396                                 break;
 397                         case DW_CFA_advance_loc4:
 398                                 pos += read32 (p);
 399                                 p += 4;
 400                                 break;
 401                         default:
 402                                 g_assert_not_reached ();
 403                         }
 404                         break;
 405                 }
 406                 default:
 407                         g_assert_not_reached ();
 408                 }
 409         }
 410
 411         if (save_locations)
 412                 memset (save_locations, 0, save_locations_len * sizeof (mgreg_t*));
 413
 414         cfa_val = (guint8*)regs [mono_dwarf_reg_to_hw_reg (cfa_reg)] + cfa_offset;
 415         for (i = 0; i < NUM_REGS; ++i) {
 416                 if (locations [i].loc_type == LOC_OFFSET) {
 417                         int hreg = mono_dwarf_reg_to_hw_reg (i);
 418                         g_assert (hreg < nregs);
 419                         regs [hreg] = *(mgreg_t*)(cfa_val + locations [i].offset);
 420                         if (save_locations && hreg < save_locations_len)
 421                                 save_locations [hreg] = (mgreg_t*)(cfa_val + locations [i].offset);
 422                 }
 423         }
 424
 425         *out_cfa = cfa_val;
 426 }
 427
 428 void
 429 mono_unwind_init (void)
 430 {
 431         InitializeCriticalSection (&unwind_mutex);
 432
 433         mono_counters_register ("Unwind info size", MONO_COUNTER_JIT | MONO_COUNTER_INT, &unwind_info_size);
 434 }
 435
 436 void
 437 mono_unwind_cleanup (void)
 438 {
 439         int i;
 440
 441         DeleteCriticalSection (&unwind_mutex);
 442
 443         if (!cached_info)
 444                 return;
 445
 446         for (i = 0; i < cached_info_next; ++i) {
 447                 MonoUnwindInfo *cached = cached_info [i];
 448
 449                 g_free (cached);
 450         }
 451
 452         g_free (cached_info);
 453 }
 454
 455 /*
 456  * mono_cache_unwind_info
 457  *
 458  *   Save UNWIND_INFO in the unwind info cache and return an id which can be passed
 459  * to mono_get_cached_unwind_info to get a cached copy of the info.
 460  * A copy is made of the unwind info.
 461  * This function is useful for two reasons:
 462  * - many methods have the same unwind info
 463  * - MonoJitInfo->used_regs is an int so it can't store the pointer to the unwind info
 464  */
 465 guint32
 466 mono_cache_unwind_info (guint8 *unwind_info, guint32 unwind_info_len)
 467 {
 468         int i;
 469         MonoUnwindInfo *info;
 470
 471         unwind_lock ();
 472
 473         if (cached_info == NULL) {
 474                 cached_info_size = 16;
 475                 cached_info = g_new0 (MonoUnwindInfo*, cached_info_size);
 476         }
 477
 478         for (i = 0; i < cached_info_next; ++i) {
 479                 MonoUnwindInfo *cached = cached_info [i];
 480
 481                 if (cached->len == unwind_info_len && memcmp (cached->info, unwind_info, unwind_info_len) == 0) {
 482                         unwind_unlock ();
 483                         return i;
 484                 }
 485         }
 486
 487         info = g_malloc (sizeof (MonoUnwindInfo) + unwind_info_len);
 488         info->len = unwind_info_len;
 489         memcpy (&info->info, unwind_info, unwind_info_len);
 490
 491         i = cached_info_next;
 492
 493         if (cached_info_next >= cached_info_size) {
 494                 MonoUnwindInfo **old_table, **new_table;
 495
 496                 /*
 497                  * Avoid freeing the old table so mono_get_cached_unwind_info ()
 498                  * doesn't need locks/hazard pointers.
 499                  */
 500
 501                 old_table = cached_info;
 502                 new_table = g_new0 (MonoUnwindInfo*, cached_info_size * 2);
 503
 504                 memcpy (new_table, cached_info, cached_info_size * sizeof (MonoUnwindInfo*));
 505
 506                 mono_memory_barrier ();
 507
 508                 cached_info = new_table;
 509
 510                 cached_info_list = g_slist_prepend (cached_info_list, cached_info);
 511
 512                 cached_info_size *= 2;
 513         }
 514
 515         cached_info [cached_info_next ++] = info;
 516
 517         unwind_info_size += sizeof (MonoUnwindInfo) + unwind_info_len;
 518
 519         unwind_unlock ();
 520         return i;
 521 }
 522
 523 /*
 524  * This function is signal safe.
 525  */
 526 guint8*
 527 mono_get_cached_unwind_info (guint32 index, guint32 *unwind_info_len)
 528 {
 529         MonoUnwindInfo **table;
 530         MonoUnwindInfo *info;
 531         guint8 *data;
 532
 533         /*
 534          * This doesn't need any locks/hazard pointers,
 535          * since new tables are copies of the old ones.
 536          */
 537         table = cached_info;
 538
 539         info = table [index];
 540
 541         *unwind_info_len = info->len;
 542         data = info->info;
 543
 544         return data;
 545 }
 546
 547 /*
 548  * mono_unwind_get_dwarf_data_align:
 549  *
 550  *   Return the data alignment used by the encoded unwind information.
 551  */
 552 int
 553 mono_unwind_get_dwarf_data_align (void)
 554 {
 555         return DWARF_DATA_ALIGN;
 556 }
 557
 558 /*
 559  * mono_unwind_get_dwarf_pc_reg:
 560  *
 561  *   Return the dwarf register number of the register holding the ip of the
 562  * previous frame.
 563  */
 564 int
 565 mono_unwind_get_dwarf_pc_reg (void)
 566 {
 567         return DWARF_PC_REG;
 568 }
 569
 570 static void
 571 decode_cie_op (guint8 *p, guint8 **endp)
 572 {
 573         int op = *p & 0xc0;
 574
 575         switch (op) {
 576         case DW_CFA_advance_loc:
 577                 p ++;
 578                 break;
 579         case DW_CFA_offset:
 580                 p ++;
 581                 decode_uleb128 (p, &p);
 582                 break;
 583         case 0: {
 584                 int ext_op = *p;
 585                 p ++;
 586                 switch (ext_op) {
 587                 case DW_CFA_def_cfa:
 588                         decode_uleb128 (p, &p);
 589                         decode_uleb128 (p, &p);
 590                         break;
 591                 case DW_CFA_def_cfa_offset:
 592                         decode_uleb128 (p, &p);
 593                         break;
 594                 case DW_CFA_def_cfa_register:
 595                         decode_uleb128 (p, &p);
 596                         break;
 597                 case DW_CFA_advance_loc4:
 598                         p += 4;
 599                         break;
 600                 case DW_CFA_offset_extended_sf:
 601                         decode_uleb128 (p, &p);
 602                         decode_uleb128 (p, &p);
 603                         break;
 604                 default:
 605                         g_assert_not_reached ();
 606                 }
 607                 break;
 608         }
 609         default:
 610                 g_assert_not_reached ();
 611         }
 612
 613         *endp = p;
 614 }
 615
 616 static gint64
 617 read_encoded_val (guint32 encoding, guint8 *p, guint8 **endp)
 618 {
 619         gint64 res;
 620
 621         switch (encoding & 0xf) {
 622         case DW_EH_PE_sdata8:
 623                 res = *(gint64*)p;
 624                 p += 8;
 625                 break;
 626         case DW_EH_PE_sdata4:
 627                 res = *(gint32*)p;
 628                 p += 4;
 629                 break;
 630         default:
 631                 g_assert_not_reached ();
 632         }
 633
 634         *endp = p;
 635         return res;
 636 }
 637
 638 /*
 639  * decode_lsda:
 640  *
 641  *   Decode the Language Specific Data Area generated by LLVM.
 642  */
 643 static void
 644 decode_lsda (guint8 *lsda, guint8 *code, MonoJitExceptionInfo **ex_info, guint32 *ex_info_len, gpointer **type_info, int *this_reg, int *this_offset)
 645 {
 646         gint32 ttype_offset, call_site_length;
 647         gint32 ttype_encoding, call_site_encoding;
 648         guint8 *ttype, *action_table, *call_site, *p;
 649         int i, ncall_sites;
 650
 651         /*
 652          * LLVM generates a c++ style LSDA, which can be decoded by looking at
 653          * eh_personality.cc in gcc.
 654          */
 655         p = lsda;
 656
 657         if (*p == DW_EH_PE_udata4) {
 658                 /* This is the modified LSDA generated by the LLVM mono branch */
 659                 guint32 mono_magic, version;
 660                 gint32 op, reg, offset;
 661
 662                 p ++;
 663                 mono_magic = decode_uleb128 (p, &p);
 664                 g_assert (mono_magic == 0x4d4fef4f);
 665                 version = decode_uleb128 (p, &p);
 666                 g_assert (version == 1);
 667
 668                 /* 'this' location */
 669                 op = *p;
 670                 g_assert (op == DW_OP_bregx);
 671                 p ++;
 672                 reg = decode_uleb128 (p, &p);
 673                 offset = decode_sleb128 (p, &p);
 674
 675                 *this_reg = mono_dwarf_reg_to_hw_reg (reg);
 676                 *this_offset = offset;
 677         } else {
 678                 /* Read @LPStart */
 679                 g_assert (*p == DW_EH_PE_omit);
 680                 p ++;
 681
 682                 *this_reg = -1;
 683                 *this_offset = -1;
 684         }
 685
 686         /* Read @TType */
 687         ttype_encoding = *p;
 688         p ++;
 689         ttype_offset = decode_uleb128 (p, &p);
 690         ttype = p + ttype_offset;
 691
 692         /* Read call-site table */
 693         call_site_encoding = *p;
 694         g_assert (call_site_encoding == DW_EH_PE_udata4);
 695         p ++;
 696         call_site_length = decode_uleb128 (p, &p);
 697         call_site = p;
 698         p += call_site_length;
 699         action_table = p;
 700
 701         /* Calculate the size of our table */
 702         ncall_sites = 0;
 703         p = call_site;
 704         while (p < action_table) {
 705                 int block_start_offset, block_size, landing_pad, action_offset;
 706
 707                 block_start_offset = read32 (p);
 708                 p += sizeof (gint32);
 709                 block_size = read32 (p);
 710                 p += sizeof (gint32);
 711                 landing_pad = read32 (p);
 712                 p += sizeof (gint32);
 713                 action_offset = decode_uleb128 (p, &p);
 714
 715                 /* landing_pad == 0 means the region has no landing pad */
 716                 if (landing_pad)
 717                         ncall_sites ++;
 718         }
 719
 720         if (ex_info) {
 721                 *ex_info = g_malloc0 (ncall_sites * sizeof (MonoJitExceptionInfo));
 722                 *ex_info_len = ncall_sites;
 723         }
 724
 725         if (type_info)
 726                 *type_info = g_malloc0 (ncall_sites * sizeof (gpointer));
 727
 728         p = call_site;
 729         i = 0;
 730         while (p < action_table) {
 731                 int block_start_offset, block_size, landing_pad, action_offset, type_offset;
 732                 guint8 *action, *tinfo;
 733
 734                 block_start_offset = read32 (p);
 735                 p += sizeof (gint32);
 736                 block_size = read32 (p);
 737                 p += sizeof (gint32);
 738                 landing_pad = read32 (p);
 739                 p += sizeof (gint32);
 740                 action_offset = decode_uleb128 (p, &p);
 741
 742                 if (!action_offset)
 743                         continue;
 744
 745                 action = action_table + action_offset - 1;
 746
 747                 type_offset = decode_sleb128 (action, &action);
 748
 749                 if (landing_pad) {
 750                         //printf ("BLOCK: %p-%p %p, %d\n", code + block_start_offset, code + block_start_offset + block_size, code + landing_pad, action_offset);
 751
 752                         g_assert (ttype_offset);
 753
 754                         if (ttype_encoding == DW_EH_PE_absptr) {
 755                                 guint8 *ttype_entry = (ttype - (type_offset * sizeof (gpointer)));
 756                                 tinfo = *(gpointer*)ttype_entry;
 757                         } else if (ttype_encoding == (DW_EH_PE_indirect | DW_EH_PE_pcrel | DW_EH_PE_sdata4)) {
 758                                 guint8 *ttype_entry = (ttype - (type_offset * 4));
 759                                 gint32 offset = *(gint32*)ttype_entry;
 760                                 guint8 *stub = ttype_entry + offset;
 761                                 tinfo = *(gpointer*)stub;
 762                         } else if (ttype_encoding == (DW_EH_PE_pcrel | DW_EH_PE_sdata4)) {
 763                                 guint8 *ttype_entry = (ttype - (type_offset * 4));
 764                                 gint32 offset = *(gint32*)ttype_entry;
 765                                 tinfo = ttype_entry + offset;
 766                         } else if (ttype_encoding == DW_EH_PE_udata4) {
 767                                 /* Embedded directly */
 768                                 guint8 *ttype_entry = (ttype - (type_offset * 4));
 769                                 tinfo = ttype_entry;
 770                         } else {
 771                                 g_assert_not_reached ();
 772                         }
 773
 774                         if (ex_info) {
 775                                 if (*type_info)
 776                                         (*type_info) [i] = tinfo;
 777                                 (*ex_info)[i].try_start = code + block_start_offset;
 778                                 (*ex_info)[i].try_end = code + block_start_offset + block_size;
 779                                 (*ex_info)[i].handler_start = code + landing_pad;
 780
 781                         }
 782                         i ++;
 783                 }
 784         }
 785 }
 786
 787 /*
 788  * mono_unwind_decode_fde:
 789  *
 790  *   Decode a DWARF FDE entry, returning the unwind opcodes.
 791  * If not NULL, EX_INFO is set to a malloc-ed array of MonoJitExceptionInfo structures,
 792  * only try_start, try_end and handler_start is set.
 793  * If not NULL, TYPE_INFO is set to a malloc-ed array containing the ttype table from the
 794  * LSDA.
 795  */
 796 guint8*
 797 mono_unwind_decode_fde (guint8 *fde, guint32 *out_len, guint32 *code_len, MonoJitExceptionInfo **ex_info, guint32 *ex_info_len, gpointer **type_info, int *this_reg, int *this_offset)
 798 {
 799         guint8 *p, *cie, *fde_current, *fde_aug = NULL, *code, *fde_cfi, *cie_cfi;
 800         gint32 fde_len, cie_offset, pc_begin, pc_range, aug_len, fde_data_len;
 801         gint32 cie_len, cie_id, cie_version, code_align, data_align, return_reg;
 802         gint32 i, cie_aug_len, buf_len;
 803         char *cie_aug_str;
 804         guint8 *buf;
 805         gboolean has_fde_augmentation = FALSE;
 806
 807         /*
 808          * http://refspecs.freestandards.org/LSB_3.0.0/LSB-Core-generic/LSB-Core-generic/ehframechpt.html
 809          */
 810
 811         *type_info = NULL;
 812         *this_reg = -1;
 813         *this_offset = -1;
 814
 815         /* Decode FDE */
 816
 817         p = fde;
 818         // FIXME: Endianess ?
 819         fde_len = *(guint32*)p;
 820         g_assert (fde_len != 0xffffffff && fde_len != 0);
 821         p += 4;
 822         cie_offset = *(guint32*)p;
 823         cie = p - cie_offset;
 824         p += 4;
 825         fde_current = p;
 826
 827         /* Decode CIE */
 828         p = cie;
 829         cie_len = *(guint32*)p;
 830         p += 4;
 831         cie_id = *(guint32*)p;
 832         g_assert (cie_id == 0);
 833         p += 4;
 834         cie_version = *p;
 835         g_assert (cie_version == 1);
 836         p += 1;
 837         cie_aug_str = (char*)p;
 838         p += strlen (cie_aug_str) + 1;
 839         code_align = decode_uleb128 (p, &p);
 840         data_align = decode_sleb128 (p, &p);
 841         return_reg = decode_uleb128 (p, &p);
 842         if (strstr (cie_aug_str, "z")) {
 843                 guint8 *cie_aug;
 844                 guint32 p_encoding;
 845
 846                 cie_aug_len = decode_uleb128 (p, &p);
 847
 848                 has_fde_augmentation = TRUE;
 849
 850                 cie_aug = p;
 851                 for (i = 0; cie_aug_str [i] != '\0'; ++i) {
 852                         switch (cie_aug_str [i]) {
 853                         case 'z':
 854                                 break;
 855                         case 'P':
 856                                 p_encoding = *p;
 857                                 p ++;
 858                                 read_encoded_val (p_encoding, p, &p);
 859                                 break;
 860                         case 'L':
 861                                 g_assert ((*p == (DW_EH_PE_sdata4|DW_EH_PE_pcrel)) || (*p == (DW_EH_PE_sdata8|DW_EH_PE_pcrel)));
 862                                 p ++;
 863                                 break;
 864                         case 'R':
 865                                 g_assert (*p == (DW_EH_PE_sdata4|DW_EH_PE_pcrel));
 866                                 p ++;
 867                                 break;
 868                         default:
 869                                 g_assert_not_reached ();
 870                                 break;
 871                         }
 872                 }
 873
 874                 p = cie_aug;
 875                 p += cie_aug_len;
 876         }
 877         cie_cfi = p;
 878
 879         /* Continue decoding FDE */
 880         p = fde_current;
 881         /* DW_EH_PE_sdata4|DW_EH_PE_pcrel encoding */
 882         pc_begin = *(gint32*)p;
 883         code = p + pc_begin;
 884         p += 4;
 885         pc_range = *(guint32*)p;
 886         p += 4;
 887         if (has_fde_augmentation) {
 888                 aug_len = decode_uleb128 (p, &p);
 889                 fde_aug = p;
 890                 p += aug_len;
 891         } else {
 892                 aug_len = 0;
 893         }
 894         fde_cfi = p;
 895         fde_data_len = fde + 4 + fde_len - p;
 896
 897         if (code_len)
 898                 *code_len = pc_range;
 899
 900         if (ex_info) {
 901                 *ex_info = NULL;
 902                 *ex_info_len = 0;
 903         }
 904
 905         /* Decode FDE augmention */
 906         if (aug_len) {
 907                 gint32 lsda_offset;
 908                 guint8 *lsda;
 909
 910                 /* sdata|pcrel encoding */
 911                 if (aug_len == 4)
 912                         lsda_offset = read32 (fde_aug);
 913                 else if (aug_len == 8)
 914                         lsda_offset = *(gint64*)fde_aug;
 915                 else
 916                         g_assert_not_reached ();
 917                 if (lsda_offset != 0) {
 918                         lsda = fde_aug + lsda_offset;
 919
 920                         decode_lsda (lsda, code, ex_info, ex_info_len, type_info, this_reg, this_offset);
 921                 }
 922         }
 923
 924         /* Make sure the FDE uses the same constants as we do */
 925         g_assert (code_align == 1);
 926         g_assert (data_align == DWARF_DATA_ALIGN);
 927         g_assert (return_reg == DWARF_PC_REG);
 928
 929         buf_len = (cie + cie_len + 4 - cie_cfi) + (fde + fde_len + 4 - fde_cfi);
 930         buf = g_malloc0 (buf_len);
 931
 932         i = 0;
 933         p = cie_cfi;
 934         while (p < cie + cie_len + 4) {
 935                 if (*p == DW_CFA_nop)
 936                         break;
 937                 else
 938                         decode_cie_op (p, &p);
 939         }
 940         memcpy (buf + i, cie_cfi, p - cie_cfi);
 941         i += p - cie_cfi;
 942
 943         p = fde_cfi;
 944         while (p < fde + fde_len + 4) {
 945                 if (*p == DW_CFA_nop)
 946                         break;
 947                 else
 948                         decode_cie_op (p, &p);
 949         }
 950         memcpy (buf + i, fde_cfi, p - fde_cfi);
 951         i += p - fde_cfi;
 952         g_assert (i <= buf_len);
 953
 954         *out_len = i;
 955
 956         return g_realloc (buf, i);
 957 }
 958
 959 /*
 960  * mono_unwind_decode_mono_fde:
 961  *
 962  *   Decode an FDE entry in the LLVM emitted mono EH frame.
 963  * info->ex_info is set to a malloc-ed array of MonoJitExceptionInfo structures,
 964  * only try_start, try_end and handler_start is set.
 965  * info->type_info is set to a malloc-ed array containing the ttype table from the
 966  * LSDA.
 967  */
 968 void
 969 mono_unwind_decode_llvm_mono_fde (guint8 *fde, int fde_len, guint8 *cie, guint8 *code, MonoLLVMFDEInfo *res)
 970 {
 971         guint8 *p, *fde_aug, *cie_cfi, *fde_cfi, *buf;
 972         int has_aug, aug_len, cie_cfi_len, fde_cfi_len;
 973         gint32 code_align, data_align, return_reg, pers_encoding;
 974
 975         memset (res, 0, sizeof (*res));
 976         res->this_reg = -1;
 977         res->this_offset = -1;
 978
 979         /* fde points to data emitted by LLVM in DwarfException::EmitMonoEHFrame () */
 980         p = fde;
 981         has_aug = *p;
 982         p ++;
 983         if (has_aug) {
 984                 aug_len = read32 (p);
 985                 p += 4;
 986         } else {
 987                 aug_len = 0;
 988         }
 989         fde_aug = p;
 990         p += aug_len;
 991         fde_cfi = p;
 992
 993         if (has_aug) {
 994                 guint8 *lsda;
 995
 996                 /* The LSDA is embedded directly into the FDE */
 997                 lsda = fde_aug;
 998
 999                 decode_lsda (lsda, code, &res->ex_info, &res->ex_info_len, &res->type_info, &res->this_reg, &res->this_offset);
1000         }
1001
1002         /* Decode CIE */
1003         p = cie;
1004         code_align = decode_uleb128 (p, &p);
1005         data_align = decode_sleb128 (p, &p);
1006         return_reg = decode_uleb128 (p, &p);
1007         pers_encoding = *p;
1008         p ++;
1009         if (pers_encoding != DW_EH_PE_omit)
1010                 read_encoded_val (pers_encoding, p, &p);
1011
1012         cie_cfi = p;
1013
1014         /* Make sure the FDE uses the same constants as we do */
1015         g_assert (code_align == 1);
1016         g_assert (data_align == DWARF_DATA_ALIGN);
1017         g_assert (return_reg == DWARF_PC_REG);
1018
1019         /* Compute size of CIE unwind info it is DW_CFA_nop terminated */
1020         p = cie_cfi;
1021         while (TRUE) {
1022                 if (*p == DW_CFA_nop)
1023                         break;
1024                 else
1025                         decode_cie_op (p, &p);
1026         }
1027         cie_cfi_len = p - cie_cfi;
1028         fde_cfi_len = (fde + fde_len - fde_cfi);
1029
1030         buf = g_malloc0 (cie_cfi_len + fde_cfi_len);
1031         memcpy (buf, cie_cfi, cie_cfi_len);
1032         memcpy (buf + cie_cfi_len, fde_cfi, fde_cfi_len);
1033
1034         res->unw_info_len = cie_cfi_len + fde_cfi_len;
1035         res->unw_info = buf;
1036 }
1037
1038 /*
1039  * mono_unwind_get_cie_program:
1040  *
1041  *   Get the unwind bytecode for the DWARF CIE.
1042  */
1043 GSList*
1044 mono_unwind_get_cie_program (void)
1045 {
1046 #if defined(TARGET_AMD64) || defined(TARGET_X86) || defined(TARGET_POWERPC)
1047         return mono_arch_get_cie_program ();
1048 #else
1049         return NULL;
1050 #endif
1051 }