/* unwinder.c

 *

 * Copyright 2002-2005 ARM Limited. All rights reserved.

 *

 * Your rights to use this code are set out in the accompanying licence

 * text file LICENCE.txt (ARM contract number LEC-ELA-00080 v1.0).

 */

/* Portions copyright Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). */

/*

 * RCS $Revision: 92986 $

 * Checkin $Date: 2005-10-13 15:56:12 +0100 (Thu, 13 Oct 2005) $

 * Revising $Author: achapman $

 */

/* Language-independent unwinder implementation */

/* This source file is compiled automatically by ARM's make system into

 * multiple object files. The source regions constituting object file

 * xxx.o are delimited by ifdef xxx_c / endif directives.

 *

 * The source regions currently marked are:

 * unwinder_c

 * unwind_activity_c

 */

#ifndef __EPOC32__

#include <stddef.h>

#include <stdlib.h>

#else

#include <e32def.h>

#endif

/* Environment: */

#include "unwind_env.h"

/* Language-independent unwinder declarations: */

#include "unwinder.h"

#ifdef __EPOC32__

/* Symbian specific support */

#include "symbian_support.h"

#endif

/* Define UNWIND_ACTIVITY_DIAGNOSTICS for printed information from _Unwind_Activity */

/* Define VRS_DIAGNOSTICS for printed diagnostics about VRS operations */

#if defined(VRS_DIAGNOSTICS) || defined(UNWIND_ACTIVITY_DIAGNOSTICS)

#ifndef __EPOC32__

extern int printf(const char *, ...);

#endif

#endif

#ifdef SUPPORT_NESTED_EXCEPTIONS

extern _Unwind_Control_Block *AllocSavedUCB();

extern void FreeSavedUCB(_Unwind_Control_Block *context);

#endif

#ifdef unwinder_c

/* =========================                      ========================= */

/* ========================= Virtual register set ========================= */

/* =========================                      ========================= */

/* The approach taken by this implementation is to use the real machine

 * registers to hold all but the values of core (integer)

 * registers. Consequently the implementation must use only the core

 * registers except when manipulating the virtual register set. Non-core

 * registers are saved only on first use, so the single implementation can

 * cope with execution on processors which lack certain registers.  The

 * registers as they were at the start of the propagation must be preserved

 * over phase 1 so that the machine state is correct at the start of phase

 * 2. This requires a copy to be taken (which can be stack allocated). During

 * a stack unwind (phase 1 or phase 2), the "current" virtual register set is

 * implemented as core register values held in a data structure, and non-core

 * register values held in the registers themselves. To ensure that all

 * original register values are available at the beginning of phase 2, the

 * core registers are saved in a second structure at the start of phase 1 and

 * the non-core registers are demand-saved into another part of the data

 * structure that holds the current core registers during the phase 1 stack

 * unwind.

 */

/* Extent to which the access routines are implemented:

 * _Unwind_VRS_Get and _Unwind_VRS_Set implement only access to the core registers.

 * _Unwind_VRS_Pop implements only popping of core and vfp registers.

 * There is no support here for the Intel WMMX registers, but space is nevertheless

 * reserved in the virtual register set structure to indicate whether demand-saving

 * of those registers is required (as they are unsupported, it never is). The space

 * costs nothing as it is required for alignment.

 * The level of supported functionality is compliant with the requirements of the

 * Exceptions ABI.

 */

typedef unsigned char bool;

struct core_s  { uint32_t r[16]; };        /* core integer regs */

struct vfp_s   { uint64_t d[32]; };        /* VFP registers saved in FSTMD format */

/* Phase 1 virtual register set includes demand-save areas */

/* The phase 2 virtual register set must be a prefix of the phase 1 set */

typedef struct phase1_virtual_register_set_s {

  /* demand_save flag == 1 means save the registers in the demand-save area */

  bool demand_save_vfp_low;

  bool demand_save_vfp_high;

  bool demand_save_wmmxd;

  bool demand_save_wmmxc;

  struct core_s core;      /* current core registers */

  struct vfp_s  vfp;       /* demand-saved vfp registers */

} phase1_virtual_register_set;

/* Phase 2 virtual register set has no demand-save areas */

/* The phase 2 virtual register set must be a prefix of the phase 1 set */

/* The assembly fragments for _Unwind_RaiseException and _Unwind_Resume create

 * a phase2_virtual_register_set_s by hand so be careful.

 */

typedef struct phase2_virtual_register_set_s {

  /* demand_save flag == 1 means save the registers in the demand-save area */

  /* Always 0 in phase 2 */

  bool demand_save_vfp_low;

  bool demand_save_vfp_high;

  bool demand_save_wmmxd;

  bool demand_save_wmmxc;

  struct core_s core;      /* current core registers */

} phase2_virtual_register_set;

/* -- Helper macros for the embedded assembly */

#if defined(__TARGET_ARCH_5T)  || defined(__TARGET_ARCH_5TXM) || \

    defined(__TARGET_ARCH_5TE) || defined(__TARGET_ARCH_6) || \

    defined(__TARGET_ARCH_6T2) || defined(__TARGET_ARCH_7_A) /* || ... */

  #define ARCH_5T_OR_LATER 1

#else

  #define ARCH_5T_OR_LATER 0

#endif

#if defined(__APCS_INTERWORK) && !ARCH_5T_OR_LATER

  #define OLD_STYLE_INTERWORKING 1

#else

  #define OLD_STYLE_INTERWORKING 0

#endif

#if defined(__TARGET_ARCH_4T) || defined(__TARGET_ARCH_4TXM) || ARCH_5T_OR_LATER

  #define HAVE_BX 1

#else

  #define HAVE_BX 0

#endif

#if defined(__TARGET_ARCH_THUMBNAIL)

  #define THUMBNAIL 1

#else

  #define THUMBNAIL 0

#endif

#if HAVE_BX

  #define RET_LR bx lr

#else

  #define RET_LR mov pc,lr

#endif

/* ----- Routines: ----- */

/* ----- Helper routines, private ----- */

/* R_ARM_PREL31 is a place-relative 31-bit signed relocation.  The

 * routine takes the address of a location that was relocated by

 * R_ARM_PREL31, and returns an absolute address.

 */

static FORCEINLINE uint32_t __ARM_resolve_prel31(void *p)

{

  return (uint32_t)((((*(int32_t *)p) << 1) >> 1) + (int32_t)p);

}

/* ----- Helper routines, private but external ----- */

/* Note '%0' refers to local label '0' */

#if defined(__thumb)

#define MAYBE_SWITCH_TO_ARM_STATE SWITCH_TO_ARM_STATE

#define MAYBE_CODE16 code16

#else

#define MAYBE_SWITCH_TO_ARM_STATE /* nothing */

#define MAYBE_CODE16              /* nothing */

#endif

__asm void __ARM_Unwind_VRS_VFPpreserve_low(void *vfpp)

{

vfp_d0 CN 0;

  /* Preserve the low vfp registers in the passed memory */

#if defined(__thumb)

  macro;

  SWITCH_TO_ARM_STATE;

1

  align 4;

2

  assert (%2 - %1) = 0;

  bx pc;

  nop;

  code32;

  mend;

#endif

  MAYBE_SWITCH_TO_ARM_STATE;

  stc   p11,vfp_d0,[r0],{0x20};  /* 0xec800b20  FSTMIAD r0,{d0-d15} */

  RET_LR;

  MAYBE_CODE16;

}

__asm void __ARM_Unwind_VRS_VFPpreserve_high(void *vfpp)

{

vfp_d16 CN 0;                      /* =16 when used with stcl */

  /* Preserve the high vfp registers in the passed memory */

  MAYBE_SWITCH_TO_ARM_STATE;

  stcl  p11,vfp_d16,[r0],{0x20};  /* 0xecc00b20  FSTMIAD r0,{d16-d31} */

  RET_LR;

  MAYBE_CODE16;

}

__asm void __ARM_Unwind_VRS_VFPrestore_low(void *vfpp)

{

  /* Restore the low vfp registers from the passed memory */

vfp_d0 CN 0;

  MAYBE_SWITCH_TO_ARM_STATE;

  ldc   p11,vfp_d0,[r0],{0x20};  /* 0xec900b20  FLDMIAD r0,{d0-d15} */

  RET_LR;

  MAYBE_CODE16;

}

__asm void __ARM_Unwind_VRS_VFPrestore_high(void *vfpp)

{

  /* Restore the high vfp registers from the passed memory */

vfp_d16 CN 0;                      /* =16 when used with ldcl */

  MAYBE_SWITCH_TO_ARM_STATE;

  ldcl   p11,vfp_d16,[r0],{0x20};  /* 0xecd00b20  FLDMIAD r0,{d16-d31} */

  RET_LR;

  MAYBE_CODE16;

}

__asm NORETURNDECL void __ARM_Unwind_VRS_corerestore(void *corep)

{

  /* We rely here on corep pointing to a location in the stack,

   * as we briefly assign it to sp. This allows us to safely do

   * ldmia's which restore sp (if we use a different base register,

   * the updated sp may be used by the handler of any data abort

   * that occurs during the ldmia, and the stack gets overwritten).

   * By hypothesis this is preserve8 but the load of sp means the

   * assembler can't infer that.

   */

#if THUMBNAIL

  preserve8;

  mov.w   r13, r0;

  ldmia.w r13!,{r0-r12};

  ldr.w   r14, [r13, #4]   /* lr */

  ldr.w   r12, [r13, #4*2] /* pc */

  ldr.w   r13, [r13, #0]   /* sp */

  bx      r12

#else

  preserve8;

  MAYBE_SWITCH_TO_ARM_STATE;

#if OLD_STYLE_INTERWORKING

  mov   r13, r0;

  ldmia r13!,{r0-r12};

  ldr   r12,[r13, #4*2]; /* pc */

  ldmia r13,{r13-r14};

  bx    r12;

#else

  #if __ARMCC_VERSION < 300000

  mov   r13, r0;

  ldmia r13,{r0-r15};

  #else

  mov r14, r0;

  ldmia r14!, {r0-r12};

  ldr r13, [r14], #4;

  ldmia r14, {r14,r15};

  #endif

#endif

  MAYBE_CODE16;

#endif

}

/* ----- Development support ----- */

#ifdef VRS_DIAGNOSTICS

static void debug_print_vrs_vfp(uint32_t base, uint64_t *lp)

{

  int c = 0;

  int i;

  for (i = 0; i < 16; i++) {

    printf("D%-2d  0x%16.16llx    ", i + base, *lp);

    lp++;

    if (c++ == 1) {

      c = 0;

      printf("\n");

    }

  }

}

static void debug_print_vrs(_Unwind_Context *context)

{

  phase1_virtual_register_set *vrsp = (phase1_virtual_register_set *)context;

  int i;

  int c;

  printf("------------------------------------------------------------------------\n");

  c = 0;

  for (i = 0; i < 16; i++) {

    printf("r%-2d  0x%8.8x    ", i, vrsp->core.r[i]);

    if (c++ == 3) {

      c = 0;

      printf("\n");

    }

  }

  printf("-----\n");

  if (vrsp->demand_save_vfp_low == 1)

    printf("VFP low registers not saved\n");

  else

    debug_print_vrs_vfp(0, &vrsp->vfp.d[0]);

  printf("-----\n");

  if (vrsp->demand_save_vfp_high == 1)

    printf("VFP high registers not saved\n");

  else

    debug_print_vrs_vfp(16, &vrsp->vfp.d[16]);

  printf("------------------------------------------------------------------------\n");

}

#endif

/* ----- Public routines ----- */

EXPORT_C _Unwind_VRS_Result _Unwind_VRS_Set(_Unwind_Context *context,

                                            _Unwind_VRS_RegClass regclass,

                                            uint32_t regno,

                                            _Unwind_VRS_DataRepresentation representation,

                                            void *valuep)

{

  phase1_virtual_register_set *vrsp = (phase1_virtual_register_set *)context;

  switch (regclass) {

  case _UVRSC_CORE:

    {

      if (representation != _UVRSD_UINT32 || regno > 15)

        return _UVRSR_FAILED;

       vrsp->core.r[regno] = *(uint32_t *)valuep;

       return _UVRSR_OK;

    }

  case _UVRSC_VFP:

  case _UVRSC_WMMXD:

  case _UVRSC_WMMXC:

    return _UVRSR_NOT_IMPLEMENTED;

  default:

    break;

  }

  return _UVRSR_FAILED;

}

EXPORT_C _Unwind_VRS_Result _Unwind_VRS_Get(_Unwind_Context *context,

                                            _Unwind_VRS_RegClass regclass,

                                            uint32_t regno,

                                            _Unwind_VRS_DataRepresentation representation,

                                            void *valuep)

{

  phase1_virtual_register_set *vrsp = (phase1_virtual_register_set *)context;

  switch (regclass) {

  case _UVRSC_CORE:

    {

      if (representation != _UVRSD_UINT32 || regno > 15)

        return _UVRSR_FAILED;

      *(uint32_t *)valuep = vrsp->core.r[regno];

      return _UVRSR_OK;

    }

  case _UVRSC_VFP:

  case _UVRSC_WMMXD:

  case _UVRSC_WMMXC:

    return _UVRSR_NOT_IMPLEMENTED;

  default:

    break;

  }

  return _UVRSR_FAILED;

}

#define R_SP 13

EXPORT_C _Unwind_VRS_Result _Unwind_VRS_Pop(_Unwind_Context *context,

                                            _Unwind_VRS_RegClass regclass,

                                            uint32_t descriminator,

                                            _Unwind_VRS_DataRepresentation representation)

{

  phase1_virtual_register_set *vrsp = (phase1_virtual_register_set *)context;

  switch (regclass) {

  case _UVRSC_CORE:

    {

      /* If SP is included in the mask, the loaded value is used in preference to

       * the writeback value, but only on completion of the loading.

       */

      uint32_t mask, *vsp, *rp, sp_loaded;

      if (representation != _UVRSD_UINT32)

        return _UVRSR_FAILED;

      vsp = (uint32_t *)vrsp->core.r[R_SP];

      rp = (uint32_t *)&vrsp->core;

      mask = descriminator & 0xffff;

      sp_loaded = mask & (1 << R_SP);

      while (mask != 0) {

        if (mask & 1) {

#ifdef VRS_DIAGNOSTICS

          printf("VRS Pop r%d\n", rp - &vrsp->core.r[0]);

#endif

          *rp = *vsp++;

        }

        rp++;

        mask >>= 1;

      }

      if (!sp_loaded)

        vrsp->core.r[R_SP] = (uint32_t)vsp;

      return _UVRSR_OK;

    }

  case _UVRSC_VFP:

    {

      uint32_t start = descriminator >> 16;

      uint32_t count = descriminator & 0xffff;

      bool some_low = start < 16;

      bool some_high = start + count > 16;

      if ((representation != _UVRSD_VFPX && representation != _UVRSD_DOUBLE) ||

          (representation == _UVRSD_VFPX && some_high) ||

          (representation == _UVRSD_DOUBLE && start + count > 32))

        return _UVRSR_FAILED;

      if (some_low && vrsp->demand_save_vfp_low == 1) { /* Demand-save over phase 1 */

        vrsp->demand_save_vfp_low = 0;

        __ARM_Unwind_VRS_VFPpreserve_low(&vrsp->vfp.d[0]);

      }

      if (some_high && vrsp->demand_save_vfp_high == 1) { /* Demand-save over phase 1 */

        vrsp->demand_save_vfp_high = 0;

        __ARM_Unwind_VRS_VFPpreserve_high(&vrsp->vfp.d[16]);

      }

      /* Now recover from the stack into the real machine registers.

       * Note for _UVRSD_VFPX we assume FSTMX standard format 1.

       * Do this by saving the current VFP registers to a memory area,

       * moving the in-memory values into that area, and

       * restoring from the whole area.

       * Must be careful as the 64-bit values saved by FSTMX might be

       * only 32-bit aligned.

       */

      {

        struct unaligned_vfp_reg_s { uint32_t w1; uint32_t w2; };

        struct unaligned_vfp_reg_s *vsp;

        struct vfp_s temp_vfp;

        if (some_low)

          __ARM_Unwind_VRS_VFPpreserve_low(&temp_vfp.d[0]);

        if (some_high)

          __ARM_Unwind_VRS_VFPpreserve_high(&temp_vfp.d[16]);

        vsp = (struct unaligned_vfp_reg_s *)vrsp->core.r[R_SP];

        while (count--) {

          struct unaligned_vfp_reg_s *v =

            (struct unaligned_vfp_reg_s *)&temp_vfp.d[start++];

          *v = *vsp++;

#ifdef VRS_DIAGNOSTICS

          printf("VRS Pop D%d = 0x%llx\n", start - 1, temp_vfp.d[start - 1]);

#endif

        }

        vrsp->core.r[R_SP] = (uint32_t)((uint32_t *)vsp +

                                        (representation == _UVRSD_VFPX ?

                                         1 : /* +1 to skip the format word */

                                         0));

        if (some_low)

          __ARM_Unwind_VRS_VFPrestore_low(&temp_vfp.d[0]);

        if (some_high)

          __ARM_Unwind_VRS_VFPrestore_high(&temp_vfp.d[16]);

      }

      return _UVRSR_OK;

    }

  case _UVRSC_WMMXD:

  case _UVRSC_WMMXC:

    return _UVRSR_NOT_IMPLEMENTED;

  default:

    break;

  }

  return _UVRSR_FAILED;

}

/* =========================              ========================= */

/* ========================= The unwinder ========================= */

/* =========================              ========================= */

/* This implementation uses the UCB unwinder_cache as follows:

 * reserved1 is documented in the EABI as requiring initialisation to 0.

 *  It is used to manage nested simultaneous propagation. If the value is 0,

 *  the UCB is participating in no propagations. If the value is 1, the UCB

 *  is participating in one propagation. Otherwise the value is a pointer to

 *  a structure holding saved UCB state from the next propagation out.

 *  The structure used is simply a mallocated UCB.

 * reserved2 is used to preserve the call-site address over calls to a

 *  personality routine and cleanup.

 * reserved3 is used to cache the PR address.

 * reserved4 is used by the Symbian implementation to cache the ROM exeception 

 *  search table

 * reserved5 is used by the symbian implementation to cache the 

 *  TExceptionDescriptor for the executable of the 'current' frame

 */

#define NESTED_CONTEXT      unwinder_cache.reserved1

#define SAVED_CALLSITE_ADDR unwinder_cache.reserved2

#define PR_ADDR             unwinder_cache.reserved3

/* Index table entry: */

#ifndef __EPOC32__  // Symbian OS defines this in symbian_support.h

typedef struct __EIT_entry {

  uint32_t fnoffset; /* Place-relative */

  uint32_t content;

} __EIT_entry;

#endif

/* Private defines etc: */

static const uint32_t EXIDX_CANTUNWIND = 1;

static const uint32_t uint32_highbit = 0x80000000;

/* ARM C++ personality routines: */

typedef _Unwind_Reason_Code (*personality_routine)(_Unwind_State,

                                                   _Unwind_Control_Block *,

                                                   _Unwind_Context *);

WEAKDECL _Unwind_Reason_Code __aeabi_unwind_cpp_pr0(_Unwind_State state, _Unwind_Control_Block *,