[libunwind] Add support for dwarf unwinding on windows on x86_64

[mstorsjo]

Summary

Clang doesn't currently support building for windows/x86_64 with dwarf by setting command line parameters, but if manually modified to use dwarf, we can make libunwind work in this configuration as well.

[mstorsjo]

As further explanation/justification - libcxxabi and libunwind don't support SEH exceptions yet.

[compnerd]

include/unwind.h

125

I think I would prefer that we do this generically as:

#if __POINTER_WIDTH__ == 32

src/AddressSpace.hpp

144–145

I think I prefer the generic:

#if __POINTER_WIDTH__ == 64

192

Same.

src/UnwindRegistersRestore.S

68

This is confusing. Why is this _WIN32? Shouldn't this be _WIN64?

72

Hmm, why is this $16? The $rsp was adjusted by $8 in the setjmp.

src/UnwindRegistersSave.S

66

Shouldn't this be _WIN64?

[mstorsjo]

include/unwind.h

125

It seems like GCC doesn't set __POINTER_WIDTH__, but both GCC and clang set __SIZEOF_POINTER__, so I can use that.

src/AddressSpace.hpp

144–145

This one probably could be simplified even further by just using intptr_t and uintptr_t, right?

src/UnwindRegistersRestore.S

68

I guess I could use that as well. I just used _WIN32 out of habit as generic identifier for windows-in-whatever-form; both _WIN32 and _WIN64 are defined, and we're within an #ifdef __x86_64__ anyway. I can change it into _WIN64 for clarity.

72

This is the exact same thing as is done right now for x86_64 on unixy systems already, just with different registers.

The adjustment by 16 bytes is because we store rcx and rip on the stack here to restore them slightly differently than the others. See the store new rcx/rip on new stack, restore rcx later and rcx was saved here earlier and rip was saved here comments below.

src/UnwindRegistersSave.S

66

Same as the otherone; we're within #ifdef __x86_64__, but I can change it into _WIN64 for clarity.

[mstorsjo]

Use __SIZEOF_POINTER__ instead of checking __LP64__ together with _WIN64. Changed _WIN32 into _WIN64 within the assembly sources for consistency/clarity. Removed one type definition ifdef by just using (u)intptr_t instead.

[martell]

docs/index.rst

55

Based on your comments above I assume this supports GCC also ?
If so, replace
Windows i386, x86_64 Clang DWARF CFI
with
Windows i386, x86_64 Clang, GCC DWARF CFI

This is exciting stuff Martin :)

[mstorsjo]

docs/index.rst

55

I'm not sure if gcc supports dwarf exceptions on x86_64 or how much hacking is needed to enable it; the comment about gcc for __SIZEOF_POINTER__ was because it was in generic code that could be used by gcc in one of the existing cases where gcc actually is supported.

[mstorsjo]

Ping

[compnerd]

src/UnwindRegistersRestore.S

98

Doesn't Win64 ABI require some of the MMX registers be saved/restored too?

[mstorsjo]

src/UnwindRegistersRestore.S

98

Right, yes, xmm6-xmm15 should be backed up and restored. I'll try to amend this with such a change.

[mstorsjo]

src/UnwindRegistersRestore.S

98

Actually, such a change doesn't necessarily make much sense on its own.

As long as the dwarf encoding itself doesn't describe how to restore those registers (and on unix platforms you don't need to, so it probably isn't even specified), you'd just end up backing up the xmm registers on entry when throwing the exception, and restoring the exactly same ones again - it only guards against changes within libcxxabi/libunwind and the unwinding machinery itself, not against changes further down in the call stack between the thrower and catcher of the exception.

So with that, I guess this patch is futile unless planning to extend the x86_64 dwarf handling in llvm to include those registers as well - and that's a little out of scope of what I intended to do here...

[rnk]

src/UnwindRegistersRestore.S

98

If we have XMM values in the register context, we might as well reload them here. I assume libunwind will switch away from DWARF and over to UNWIND_INFO opcodes in the near future, and that will give us an accurate register context.

[mstorsjo]

src/UnwindRegistersRestore.S

98

Yeah, although to do anything useful with the XMM registers, the llvm backend would have to output dwarf opcodes for callee saved xmm registers, which it currently doesn't. Otherwise it'll just reload them back to the same values as they already are. I've managed to hack LLVM to do that (without fully understanding what I'm doing though), and I'll see if I manage to update libunwind to use that as well.

[mstorsjo]

Updated to take care of saving/restoring XMM registers as well.

[mstorsjo]

src/UnwindRegistersRestore.S

72

Instead of duplicating the asm for the win64 and unix calling convention, I can also pretty easily template it using the cpp, using a define for whatever register holds the context pointer from the first function argument. Would that be better, or is it clearer just to have it typed out in both forms literally?

[mstorsjo]

Simplified the assembly by sharing much more code between the unix and win64 paths, added a padding element to ensure more stable struct packing.

[rnk]

lgtm

docs/index.rst

 Any          i386, x86_64, ARM    Clang        SjLj
 Bare Metal   ARM                  Clang, GCC   EHABI
 FreeBSD      i386, x86_64, ARM64  Clang        DWARF CFI
 iOS          ARM                  Clang        SjLj
 Linux        ARM                  Clang, GCC   EHABI
 Linux        i386, x86_64, ARM64  Clang, GCC   DWARF CFI
 Mac OS X     i386, x86_64         Clang, GCC   DWARF CFI
 NetBSD       x86_64               Clang, GCC   DWARF CFI
-Windows      i386                 Clang        DWARF CFI
+Windows      i386, x86_64         Clang        DWARF CFI
 ============ ==================== ============ ========================
 
 The following minimum compiler versions are strongly recommended.
 
 * Clang 3.5 and above
 * GCC 4.7 and above.
 
 Anything older *may* work.

include/__libunwind_config.h

 #if defined(_LIBUNWIND_IS_NATIVE_ONLY)
 # if defined(__i386__)
 #  define _LIBUNWIND_TARGET_I386
 #  define _LIBUNWIND_CONTEXT_SIZE 8
 #  define _LIBUNWIND_CURSOR_SIZE 19
 #  define _LIBUNWIND_HIGHEST_DWARF_REGISTER 9
 # elif defined(__x86_64__)
 #  define _LIBUNWIND_TARGET_X86_64 1
-#  define _LIBUNWIND_CONTEXT_SIZE 21
-#  define _LIBUNWIND_CURSOR_SIZE 33
-#  define _LIBUNWIND_HIGHEST_DWARF_REGISTER 17
+#  if defined(_WIN64)
+#    define _LIBUNWIND_CONTEXT_SIZE 53
+#    define _LIBUNWIND_CURSOR_SIZE 65
+#    define _LIBUNWIND_HIGHEST_DWARF_REGISTER 33
+#  else
+#    define _LIBUNWIND_CONTEXT_SIZE 21
+#    define _LIBUNWIND_CURSOR_SIZE 33
+#    define _LIBUNWIND_HIGHEST_DWARF_REGISTER 17
+#  endif
 # elif defined(__ppc__)
 #  define _LIBUNWIND_TARGET_PPC 1
 #  define _LIBUNWIND_CONTEXT_SIZE 117
 #  define _LIBUNWIND_CURSOR_SIZE 128
 #  define _LIBUNWIND_HIGHEST_DWARF_REGISTER 113
 # elif defined(__aarch64__)
 #  define _LIBUNWIND_TARGET_AARCH64 1
 #  define _LIBUNWIND_CONTEXT_SIZE 66

include/libunwind.h

enum {
   UNW_X86_64_RSP = 7,
   UNW_X86_64_R8  = 8,
   UNW_X86_64_R9  = 9,
   UNW_X86_64_R10 = 10,
   UNW_X86_64_R11 = 11,
   UNW_X86_64_R12 = 12,
   UNW_X86_64_R13 = 13,
   UNW_X86_64_R14 = 14,
-  UNW_X86_64_R15 = 15
+  UNW_X86_64_R15 = 15,
+  UNW_X86_64_RIP = 16,
+  UNW_X86_64_XMM0 = 17,
+  UNW_X86_64_XMM1 = 18,
+  UNW_X86_64_XMM2 = 19,
+  UNW_X86_64_XMM3 = 20,
+  UNW_X86_64_XMM4 = 21,
+  UNW_X86_64_XMM5 = 22,
+  UNW_X86_64_XMM6 = 23,
+  UNW_X86_64_XMM7 = 24,
+  UNW_X86_64_XMM8 = 25,
+  UNW_X86_64_XMM9 = 26,
+  UNW_X86_64_XMM10 = 27,
+  UNW_X86_64_XMM11 = 28,
+  UNW_X86_64_XMM12 = 29,
+  UNW_X86_64_XMM13 = 30,
+  UNW_X86_64_XMM14 = 31,
+  UNW_X86_64_XMM15 = 32,
 };
 
 
 // 32-bit ppc register numbers
 enum {
   UNW_PPC_R0  = 0,
   UNW_PPC_R1  = 1,
   UNW_PPC_R2  = 2,

include/unwind.h

 typedef struct _Unwind_Exception _Unwind_Exception;
 
 struct _Unwind_Exception {
   uint64_t exception_class;
   void (*exception_cleanup)(_Unwind_Reason_Code reason,
                             _Unwind_Exception *exc);
   uintptr_t private_1; // non-zero means forced unwind
   uintptr_t private_2; // holds sp that phase1 found for phase2 to use
-#ifndef __LP64__
+#if __SIZEOF_POINTER__ == 4
   // The implementation of _Unwind_Exception uses an attribute mode on the
   // above fields which has the side effect of causing this whole struct to
   // round up to 32 bytes in size. To be more explicit, we add pad fields
   // added for binary compatibility.
   uint32_t reserved[3];
 #endif
   // The Itanium ABI requires that _Unwind_Exception objects are "double-word
   // aligned".  GCC has interpreted this to mean "use the maximum useful

src/AddressSpace.hpp

 #endif
 };
 
 
 /// LocalAddressSpace is used as a template parameter to UnwindCursor when
 /// unwinding a thread in the same process.  The wrappers compile away,
 /// making local unwinds fast.
 class __attribute__((visibility("hidden"))) LocalAddressSpace {
 public:
-#ifdef __LP64__
-  typedef uint64_t pint_t;
-  typedef int64_t  sint_t;
-#else
-  typedef uint32_t pint_t;
-  typedef int32_t  sint_t;
-#endif
+  typedef uintptr_t pint_t;
+  typedef intptr_t  sint_t;
   uint8_t         get8(pint_t addr) {
     uint8_t val;
     memcpy(&val, (void *)addr, sizeof(val));
     return val;
   }
   uint16_t         get16(pint_t addr) {
     uint16_t val;
     memcpy(&val, (void *)addr, sizeof(val));
bool findFunctionName(pint_t addr, char *buf, size_t bufLen,
                         unw_word_t *offset);
   bool findUnwindSections(pint_t targetAddr, UnwindInfoSections &info);
   bool findOtherFDE(pint_t targetAddr, pint_t &fde);
 
   static LocalAddressSpace sThisAddressSpace;
 };
 
 inline uintptr_t LocalAddressSpace::getP(pint_t addr) {
-#ifdef __LP64__
+#if __SIZEOF_POINTER__ == 8
   return get64(addr);
 #else
   return get32(addr);
 #endif
 }
 
 /// Read a ULEB128 into a 64-bit word.
 inline uint64_t LocalAddressSpace::getULEB128(pint_t &addr, pint_t end) {

src/Registers.hpp

public:
   Registers_x86_64(const void *registers);
 
   bool        validRegister(int num) const;
   uint64_t    getRegister(int num) const;
   void        setRegister(int num, uint64_t value);
   bool        validFloatRegister(int) const { return false; }
   double      getFloatRegister(int num) const;
   void        setFloatRegister(int num, double value);
-  bool        validVectorRegister(int) const { return false; }
+  bool        validVectorRegister(int) const;
   v128        getVectorRegister(int num) const;
   void        setVectorRegister(int num, v128 value);
   const char *getRegisterName(int num);
   void        jumpto();
-  static int  lastDwarfRegNum() { return 16; }
+  static int  lastDwarfRegNum() { return 32; }
 
   uint64_t  getSP() const          { return _registers.__rsp; }
   void      setSP(uint64_t value)  { _registers.__rsp = value; }
   uint64_t  getIP() const          { return _registers.__rip; }
   void      setIP(uint64_t value)  { _registers.__rip = value; }
   uint64_t  getRBP() const         { return _registers.__rbp; }
   void      setRBP(uint64_t value) { _registers.__rbp = value; }
   uint64_t  getRBX() const         { return _registers.__rbx; }
struct GPRs {
     uint64_t __r15;
     uint64_t __rip;
     uint64_t __rflags;
     uint64_t __cs;
     uint64_t __fs;
     uint64_t __gs;
   };
   GPRs _registers;
+#if defined(_WIN64)
+  v128 _xmm[16];
+#endif
 };
 
 inline Registers_x86_64::Registers_x86_64(const void *registers) {
   static_assert((check_fit<Registers_x86_64, unw_context_t>::does_fit),
                 "x86_64 registers do not fit into unw_context_t");
   memcpy(&_registers, registers, sizeof(_registers));
 }
 
inline const char *Registers_x86_64::getRegisterName(int regNum) {
   case UNW_X86_64_R12:
     return "r12";
   case UNW_X86_64_R13:
     return "r13";
   case UNW_X86_64_R14:
     return "r14";
   case UNW_X86_64_R15:
     return "r15";
+  case UNW_X86_64_XMM0:
+    return "xmm0";
+  case UNW_X86_64_XMM1:
+    return "xmm1";
+  case UNW_X86_64_XMM2:
+    return "xmm2";
+  case UNW_X86_64_XMM3:
+    return "xmm3";
+  case UNW_X86_64_XMM4:
+    return "xmm4";
+  case UNW_X86_64_XMM5:
+    return "xmm5";
+  case UNW_X86_64_XMM6:
+    return "xmm6";
+  case UNW_X86_64_XMM7:
+    return "xmm7";
+  case UNW_X86_64_XMM8:
+    return "xmm8";
+  case UNW_X86_64_XMM9:
+    return "xmm9";
+  case UNW_X86_64_XMM10:
+    return "xmm10";
+  case UNW_X86_64_XMM11:
+    return "xmm11";
+  case UNW_X86_64_XMM12:
+    return "xmm12";
+  case UNW_X86_64_XMM13:
+    return "xmm13";
+  case UNW_X86_64_XMM14:
+    return "xmm14";
+  case UNW_X86_64_XMM15:
+    return "xmm15";
   default:
     return "unknown register";
   }
 }
 
 inline double Registers_x86_64::getFloatRegister(int) const {
   _LIBUNWIND_ABORT("no x86_64 float registers");
 }
 
 inline void Registers_x86_64::setFloatRegister(int, double) {
   _LIBUNWIND_ABORT("no x86_64 float registers");
 }
 
-inline v128 Registers_x86_64::getVectorRegister(int) const {
+inline bool Registers_x86_64::validVectorRegister(int regNum) const {
+#if defined(_WIN64)
+  if (regNum < UNW_X86_64_XMM0)
+    return false;
+  if (regNum > UNW_X86_64_XMM15)
+    return false;
+  return true;
+#else
+  return false;
+#endif
+}
+
+inline v128 Registers_x86_64::getVectorRegister(int regNum) const {
+#if defined(_WIN64)
+  assert(validVectorRegister(regNum));
+  return _xmm[regNum - UNW_X86_64_XMM0];
+#else
   _LIBUNWIND_ABORT("no x86_64 vector registers");
+#endif
 }
 
-inline void Registers_x86_64::setVectorRegister(int, v128) {
+inline void Registers_x86_64::setVectorRegister(int regNum, v128 value) {
+#if defined(_WIN64)
+  assert(validVectorRegister(regNum));
+  _xmm[regNum - UNW_X86_64_XMM0] = value;
+#else
   _LIBUNWIND_ABORT("no x86_64 vector registers");
+#endif
 }
 #endif // _LIBUNWIND_TARGET_X86_64
 
 
 #if defined(_LIBUNWIND_TARGET_PPC)
 /// Registers_ppc holds the register state of a thread in a 32-bit PowerPC
 /// process.
 class _LIBUNWIND_HIDDEN Registers_ppc {

src/UnwindLevel1.c

if (_LIBUNWIND_TRACING_UNWINDING) {
           (void *)exception_object, pc, frameInfo.start_ip, functionName,
           frameInfo.lsda, frameInfo.handler);
     }
 
     // If there is a personality routine, ask it if it will want to stop at
     // this frame.
     if (frameInfo.handler != 0) {
       __personality_routine p =
-          (__personality_routine)(long)(frameInfo.handler);
+          (__personality_routine)(uintptr_t)(frameInfo.handler);
       _LIBUNWIND_TRACE_UNWINDING(
           "unwind_phase1(ex_ojb=%p): calling personality function %p",
           (void *)exception_object, (void *)(uintptr_t)p);
       _Unwind_Reason_Code personalityResult =
           (*p)(1, _UA_SEARCH_PHASE, exception_object->exception_class,
                exception_object, (struct _Unwind_Context *)(cursor));
       switch (personalityResult) {
       case _URC_HANDLER_FOUND:
if (_LIBUNWIND_TRACING_UNWINDING) {
                                  (void *)exception_object, frameInfo.start_ip,
                                  functionName, sp, frameInfo.lsda,
                                  frameInfo.handler);
     }
 
     // If there is a personality routine, tell it we are unwinding.
     if (frameInfo.handler != 0) {
       __personality_routine p =
-          (__personality_routine)(long)(frameInfo.handler);
+          (__personality_routine)(uintptr_t)(frameInfo.handler);
       _Unwind_Action action = _UA_CLEANUP_PHASE;
       if (sp == exception_object->private_2) {
         // Tell personality this was the frame it marked in phase 1.
         action = (_Unwind_Action)(_UA_CLEANUP_PHASE | _UA_HANDLER_FRAME);
       }
        _Unwind_Reason_Code personalityResult =
           (*p)(1, action, exception_object->exception_class, exception_object,
                (struct _Unwind_Context *)(cursor));

src/UnwindRegistersRestore.S

#endif
   # skip gs
 
 #elif defined(__x86_64__)
 
 DEFINE_LIBUNWIND_PRIVATE_FUNCTION(_ZN9libunwind16Registers_x86_646jumptoEv)
 #
 # void libunwind::Registers_x86_64::jumpto()
 #
+#if defined(_WIN64)
+# On entry, thread_state pointer is in rcx
+
+  movq  56(%rcx), %rax # rax holds new stack pointer
+  subq  $16, %rax
+  movq  %rax, 56(%rcx)
+  movq  16(%rcx), %rdx  # store new rcx on new stack
+  movq  %rdx, 0(%rax)
+  movq  128(%rcx), %rdx # store new rip on new stack
+  movq  %rdx, 8(%rax)
+  # restore all registers
+  movq    0(%rcx), %rax
+  movq    8(%rcx), %rbx
+  # restore rcx later
+  movq   24(%rcx), %rdx
+  movq   32(%rcx), %rdi
+  movq   40(%rcx), %rsi
+  movq   48(%rcx), %rbp
+  # restore rsp later
+  movq   64(%rcx), %r8
+  movq   72(%rcx), %r9
+  movq   80(%rcx), %r10
+  movq   88(%rcx), %r11
+  movq   96(%rcx), %r12
+  movq  104(%rcx), %r13
+  movq  112(%rcx), %r14
+  movq  120(%rcx), %r15
+  # skip rflags
+  # skip cs
+  # skip fs
+  # skip gs
+  movdqu 168(%rcx),%xmm0
+  movdqu 184(%rcx),%xmm1
+  movdqu 200(%rcx),%xmm2
+  movdqu 216(%rcx),%xmm3
+  movdqu 232(%rcx),%xmm4
+  movdqu 248(%rcx),%xmm5
+  movdqu 264(%rcx),%xmm6
+  movdqu 280(%rcx),%xmm7
+  movdqu 296(%rcx),%xmm8
+  movdqu 312(%rcx),%xmm9
+  movdqu 328(%rcx),%xmm10
+  movdqu 344(%rcx),%xmm11
+  movdqu 360(%rcx),%xmm12
+  movdqu 376(%rcx),%xmm13
+  movdqu 392(%rcx),%xmm14
+  movdqu 408(%rcx),%xmm15
+  movq  56(%rcx), %rsp  # cut back rsp to new location
+  pop    %rcx      # rcx was saved here earlier
+#else
 # On entry, thread_state pointer is in rdi
 
   movq  56(%rdi), %rax # rax holds new stack pointer
   subq  $16, %rax
   movq  %rax, 56(%rdi)
   movq  32(%rdi), %rbx  # store new rdi on new stack
   movq  %rbx, 0(%rax)
   movq  128(%rdi), %rbx # store new rip on new stack
# On entry, thread_state pointer is in rdi
   movq  112(%rdi), %r14
   movq  120(%rdi), %r15
   # skip rflags
   # skip cs
   # skip fs
   # skip gs
   movq  56(%rdi), %rsp  # cut back rsp to new location
   pop    %rdi      # rdi was saved here earlier
+#endif
   ret            # rip was saved here
 
 
 #elif defined(__ppc__)
 
 DEFINE_LIBUNWIND_PRIVATE_FUNCTION(_ZN9libunwind13Registers_ppc6jumptoEv)
 ;
 ; void libunwind::Registers_ppc::jumpto()

src/UnwindRegistersSave.S

 
 #
 # extern int unw_getcontext(unw_context_t* thread_state)
 #
 # On entry:
 #  thread_state pointer is in rdi
 #
 DEFINE_LIBUNWIND_FUNCTION(unw_getcontext)
+#if defined(_WIN64)
+  movq  %rax,   (%rcx)
+  movq  %rbx,  8(%rcx)
+  movq  %rcx, 16(%rcx)
+  movq  %rdx, 24(%rcx)
+  movq  %rdi, 32(%rcx)
+  movq  %rsi, 40(%rcx)
+  movq  %rbp, 48(%rcx)
+  movq  %rsp, 56(%rcx)
+  addq  $8,   56(%rcx)
+  movq  %r8,  64(%rcx)
+  movq  %r9,  72(%rcx)
+  movq  %r10, 80(%rcx)
+  movq  %r11, 88(%rcx)
+  movq  %r12, 96(%rcx)
+  movq  %r13,104(%rcx)
+  movq  %r14,112(%rcx)
+  movq  %r15,120(%rcx)
+  movq  (%rsp),%rdx
+  movq  %rdx,128(%rcx) # store return address as rip
+  movdqu %xmm0,168(%rcx)
+  movdqu %xmm1,184(%rcx)
+  movdqu %xmm2,200(%rcx)
+  movdqu %xmm3,216(%rcx)
+  movdqu %xmm4,232(%rcx)
+  movdqu %xmm5,248(%rcx)
+  movdqu %xmm6,264(%rcx)
+  movdqu %xmm7,280(%rcx)
+  movdqu %xmm8,296(%rcx)
+  movdqu %xmm9,312(%rcx)
+  movdqu %xmm10,328(%rcx)
+  movdqu %xmm11,344(%rcx)
+  movdqu %xmm12,360(%rcx)
+  movdqu %xmm13,376(%rcx)
+  movdqu %xmm14,392(%rcx)
+  movdqu %xmm15,408(%rcx)
+#else
   movq  %rax,   (%rdi)
   movq  %rbx,  8(%rdi)
   movq  %rcx, 16(%rdi)
   movq  %rdx, 24(%rdi)
   movq  %rdi, 32(%rdi)
   movq  %rsi, 40(%rdi)
   movq  %rbp, 48(%rdi)
   movq  %rsp, 56(%rdi)
   addq  $8,   56(%rdi)
   movq  %r8,  64(%rdi)
   movq  %r9,  72(%rdi)
   movq  %r10, 80(%rdi)
   movq  %r11, 88(%rdi)
   movq  %r12, 96(%rdi)
   movq  %r13,104(%rdi)
   movq  %r14,112(%rdi)
   movq  %r15,120(%rdi)
   movq  (%rsp),%rsi
   movq  %rsi,128(%rdi) # store return address as rip
+#endif
   # skip rflags
   # skip cs
   # skip fs
   # skip gs
   xorl  %eax, %eax    # return UNW_ESUCCESS
   ret
 
 # elif defined(__mips__)