xref: /openbsd-src/gnu/llvm/libunwind/src/UnwindCursor.hpp (revision 202cdb0e0a5b97857d0b77e650500ce112f967da)
1*202cdb0eSrobert //===----------------------------------------------------------------------===//
2f6c50668Spatrick //
3f6c50668Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4f6c50668Spatrick // See https://llvm.org/LICENSE.txt for license information.
5f6c50668Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6f6c50668Spatrick //
7f6c50668Spatrick //
8f6c50668Spatrick // C++ interface to lower levels of libunwind
9f6c50668Spatrick //===----------------------------------------------------------------------===//
10f6c50668Spatrick 
11f6c50668Spatrick #ifndef __UNWINDCURSOR_HPP__
12f6c50668Spatrick #define __UNWINDCURSOR_HPP__
13f6c50668Spatrick 
14*202cdb0eSrobert #include "cet_unwind.h"
15f6c50668Spatrick #include <stdint.h>
16f6c50668Spatrick #include <stdio.h>
17f6c50668Spatrick #include <stdlib.h>
18f6c50668Spatrick #include <unwind.h>
19f6c50668Spatrick 
20f6c50668Spatrick #ifdef _WIN32
21f6c50668Spatrick   #include <windows.h>
22f6c50668Spatrick   #include <ntverp.h>
23f6c50668Spatrick #endif
24f6c50668Spatrick #ifdef __APPLE__
25f6c50668Spatrick   #include <mach-o/dyld.h>
26f6c50668Spatrick #endif
27*202cdb0eSrobert #ifdef _AIX
28*202cdb0eSrobert #include <dlfcn.h>
29*202cdb0eSrobert #include <sys/debug.h>
30*202cdb0eSrobert #include <sys/pseg.h>
31*202cdb0eSrobert #endif
32*202cdb0eSrobert 
33*202cdb0eSrobert #if defined(_LIBUNWIND_TARGET_LINUX) &&                                        \
34*202cdb0eSrobert     (defined(_LIBUNWIND_TARGET_AARCH64) || defined(_LIBUNWIND_TARGET_S390X))
35*202cdb0eSrobert #include <sys/syscall.h>
36*202cdb0eSrobert #include <sys/uio.h>
37*202cdb0eSrobert #include <unistd.h>
38*202cdb0eSrobert #define _LIBUNWIND_CHECK_LINUX_SIGRETURN 1
39*202cdb0eSrobert #endif
40*202cdb0eSrobert 
41*202cdb0eSrobert #include "AddressSpace.hpp"
42*202cdb0eSrobert #include "CompactUnwinder.hpp"
43*202cdb0eSrobert #include "config.h"
44*202cdb0eSrobert #include "DwarfInstructions.hpp"
45*202cdb0eSrobert #include "EHHeaderParser.hpp"
46*202cdb0eSrobert #include "libunwind.h"
47*202cdb0eSrobert #include "libunwind_ext.h"
48*202cdb0eSrobert #include "Registers.hpp"
49*202cdb0eSrobert #include "RWMutex.hpp"
50*202cdb0eSrobert #include "Unwind-EHABI.h"
51f6c50668Spatrick 
52f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_SEH_UNWIND)
53f6c50668Spatrick // Provide a definition for the DISPATCHER_CONTEXT struct for old (Win7 and
54f6c50668Spatrick // earlier) SDKs.
55f6c50668Spatrick // MinGW-w64 has always provided this struct.
56f6c50668Spatrick   #if defined(_WIN32) && defined(_LIBUNWIND_TARGET_X86_64) && \
57f6c50668Spatrick       !defined(__MINGW32__) && VER_PRODUCTBUILD < 8000
58f6c50668Spatrick struct _DISPATCHER_CONTEXT {
59f6c50668Spatrick   ULONG64 ControlPc;
60f6c50668Spatrick   ULONG64 ImageBase;
61f6c50668Spatrick   PRUNTIME_FUNCTION FunctionEntry;
62f6c50668Spatrick   ULONG64 EstablisherFrame;
63f6c50668Spatrick   ULONG64 TargetIp;
64f6c50668Spatrick   PCONTEXT ContextRecord;
65f6c50668Spatrick   PEXCEPTION_ROUTINE LanguageHandler;
66f6c50668Spatrick   PVOID HandlerData;
67f6c50668Spatrick   PUNWIND_HISTORY_TABLE HistoryTable;
68f6c50668Spatrick   ULONG ScopeIndex;
69f6c50668Spatrick   ULONG Fill0;
70f6c50668Spatrick };
71f6c50668Spatrick   #endif
72f6c50668Spatrick 
73f6c50668Spatrick struct UNWIND_INFO {
74f6c50668Spatrick   uint8_t Version : 3;
75f6c50668Spatrick   uint8_t Flags : 5;
76f6c50668Spatrick   uint8_t SizeOfProlog;
77f6c50668Spatrick   uint8_t CountOfCodes;
78f6c50668Spatrick   uint8_t FrameRegister : 4;
79f6c50668Spatrick   uint8_t FrameOffset : 4;
80f6c50668Spatrick   uint16_t UnwindCodes[2];
81f6c50668Spatrick };
82f6c50668Spatrick 
83f6c50668Spatrick extern "C" _Unwind_Reason_Code __libunwind_seh_personality(
84f6c50668Spatrick     int, _Unwind_Action, uint64_t, _Unwind_Exception *,
85f6c50668Spatrick     struct _Unwind_Context *);
86f6c50668Spatrick 
87f6c50668Spatrick #endif
88f6c50668Spatrick 
89f6c50668Spatrick namespace libunwind {
90f6c50668Spatrick 
916f07627aSotto static thread_local UnwindInfoSectionsCache uwis_cache;
92974930e3Spatrick 
93f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
94f6c50668Spatrick /// Cache of recently found FDEs.
95f6c50668Spatrick template <typename A>
96f6c50668Spatrick class _LIBUNWIND_HIDDEN DwarfFDECache {
97f6c50668Spatrick   typedef typename A::pint_t pint_t;
98f6c50668Spatrick public:
99a0747c9fSpatrick   static constexpr pint_t kSearchAll = static_cast<pint_t>(-1);
100f6c50668Spatrick   static pint_t findFDE(pint_t mh, pint_t pc);
101f6c50668Spatrick   static void add(pint_t mh, pint_t ip_start, pint_t ip_end, pint_t fde);
102f6c50668Spatrick   static void removeAllIn(pint_t mh);
103f6c50668Spatrick   static void iterateCacheEntries(void (*func)(unw_word_t ip_start,
104f6c50668Spatrick                                                unw_word_t ip_end,
105f6c50668Spatrick                                                unw_word_t fde, unw_word_t mh));
106f6c50668Spatrick 
107f6c50668Spatrick private:
108f6c50668Spatrick 
109f6c50668Spatrick   struct entry {
110f6c50668Spatrick     pint_t mh;
111f6c50668Spatrick     pint_t ip_start;
112f6c50668Spatrick     pint_t ip_end;
113f6c50668Spatrick     pint_t fde;
114f6c50668Spatrick   };
115f6c50668Spatrick 
116f6c50668Spatrick   // These fields are all static to avoid needing an initializer.
117f6c50668Spatrick   // There is only one instance of this class per process.
118f6c50668Spatrick   static RWMutex _lock;
119f6c50668Spatrick #ifdef __APPLE__
120f6c50668Spatrick   static void dyldUnloadHook(const struct mach_header *mh, intptr_t slide);
121f6c50668Spatrick   static bool _registeredForDyldUnloads;
122f6c50668Spatrick #endif
123f6c50668Spatrick   static entry *_buffer;
124f6c50668Spatrick   static entry *_bufferUsed;
125f6c50668Spatrick   static entry *_bufferEnd;
126f6c50668Spatrick   static entry _initialBuffer[64];
127f6c50668Spatrick };
128f6c50668Spatrick 
129f6c50668Spatrick template <typename A>
130f6c50668Spatrick typename DwarfFDECache<A>::entry *
131f6c50668Spatrick DwarfFDECache<A>::_buffer = _initialBuffer;
132f6c50668Spatrick 
133f6c50668Spatrick template <typename A>
134f6c50668Spatrick typename DwarfFDECache<A>::entry *
135f6c50668Spatrick DwarfFDECache<A>::_bufferUsed = _initialBuffer;
136f6c50668Spatrick 
137f6c50668Spatrick template <typename A>
138f6c50668Spatrick typename DwarfFDECache<A>::entry *
139f6c50668Spatrick DwarfFDECache<A>::_bufferEnd = &_initialBuffer[64];
140f6c50668Spatrick 
141f6c50668Spatrick template <typename A>
142f6c50668Spatrick typename DwarfFDECache<A>::entry DwarfFDECache<A>::_initialBuffer[64];
143f6c50668Spatrick 
144f6c50668Spatrick template <typename A>
145f6c50668Spatrick RWMutex DwarfFDECache<A>::_lock;
146f6c50668Spatrick 
147f6c50668Spatrick #ifdef __APPLE__
148f6c50668Spatrick template <typename A>
149f6c50668Spatrick bool DwarfFDECache<A>::_registeredForDyldUnloads = false;
150f6c50668Spatrick #endif
151f6c50668Spatrick 
152f6c50668Spatrick template <typename A>
findFDE(pint_t mh,pint_t pc)153f6c50668Spatrick typename A::pint_t DwarfFDECache<A>::findFDE(pint_t mh, pint_t pc) {
154f6c50668Spatrick   pint_t result = 0;
155f6c50668Spatrick   _LIBUNWIND_LOG_IF_FALSE(_lock.lock_shared());
156f6c50668Spatrick   for (entry *p = _buffer; p < _bufferUsed; ++p) {
157a0747c9fSpatrick     if ((mh == p->mh) || (mh == kSearchAll)) {
158f6c50668Spatrick       if ((p->ip_start <= pc) && (pc < p->ip_end)) {
159f6c50668Spatrick         result = p->fde;
160f6c50668Spatrick         break;
161f6c50668Spatrick       }
162f6c50668Spatrick     }
163f6c50668Spatrick   }
164f6c50668Spatrick   _LIBUNWIND_LOG_IF_FALSE(_lock.unlock_shared());
165f6c50668Spatrick   return result;
166f6c50668Spatrick }
167f6c50668Spatrick 
168f6c50668Spatrick template <typename A>
add(pint_t mh,pint_t ip_start,pint_t ip_end,pint_t fde)169f6c50668Spatrick void DwarfFDECache<A>::add(pint_t mh, pint_t ip_start, pint_t ip_end,
170f6c50668Spatrick                            pint_t fde) {
171f6c50668Spatrick #if !defined(_LIBUNWIND_NO_HEAP)
172f6c50668Spatrick   _LIBUNWIND_LOG_IF_FALSE(_lock.lock());
173f6c50668Spatrick   if (_bufferUsed >= _bufferEnd) {
174f6c50668Spatrick     size_t oldSize = (size_t)(_bufferEnd - _buffer);
175f6c50668Spatrick     size_t newSize = oldSize * 4;
176f6c50668Spatrick     // Can't use operator new (we are below it).
177f6c50668Spatrick     entry *newBuffer = (entry *)malloc(newSize * sizeof(entry));
178f6c50668Spatrick     memcpy(newBuffer, _buffer, oldSize * sizeof(entry));
179f6c50668Spatrick     if (_buffer != _initialBuffer)
180f6c50668Spatrick       free(_buffer);
181f6c50668Spatrick     _buffer = newBuffer;
182f6c50668Spatrick     _bufferUsed = &newBuffer[oldSize];
183f6c50668Spatrick     _bufferEnd = &newBuffer[newSize];
184f6c50668Spatrick   }
185f6c50668Spatrick   _bufferUsed->mh = mh;
186f6c50668Spatrick   _bufferUsed->ip_start = ip_start;
187f6c50668Spatrick   _bufferUsed->ip_end = ip_end;
188f6c50668Spatrick   _bufferUsed->fde = fde;
189f6c50668Spatrick   ++_bufferUsed;
190f6c50668Spatrick #ifdef __APPLE__
191f6c50668Spatrick   if (!_registeredForDyldUnloads) {
192f6c50668Spatrick     _dyld_register_func_for_remove_image(&dyldUnloadHook);
193f6c50668Spatrick     _registeredForDyldUnloads = true;
194f6c50668Spatrick   }
195f6c50668Spatrick #endif
196f6c50668Spatrick   _LIBUNWIND_LOG_IF_FALSE(_lock.unlock());
197f6c50668Spatrick #endif
198f6c50668Spatrick }
199f6c50668Spatrick 
200f6c50668Spatrick template <typename A>
removeAllIn(pint_t mh)201f6c50668Spatrick void DwarfFDECache<A>::removeAllIn(pint_t mh) {
202f6c50668Spatrick   _LIBUNWIND_LOG_IF_FALSE(_lock.lock());
203f6c50668Spatrick   entry *d = _buffer;
204f6c50668Spatrick   for (const entry *s = _buffer; s < _bufferUsed; ++s) {
205f6c50668Spatrick     if (s->mh != mh) {
206f6c50668Spatrick       if (d != s)
207f6c50668Spatrick         *d = *s;
208f6c50668Spatrick       ++d;
209f6c50668Spatrick     }
210f6c50668Spatrick   }
211f6c50668Spatrick   _bufferUsed = d;
212f6c50668Spatrick   _LIBUNWIND_LOG_IF_FALSE(_lock.unlock());
213f6c50668Spatrick }
214f6c50668Spatrick 
215f6c50668Spatrick #ifdef __APPLE__
216f6c50668Spatrick template <typename A>
dyldUnloadHook(const struct mach_header * mh,intptr_t)217f6c50668Spatrick void DwarfFDECache<A>::dyldUnloadHook(const struct mach_header *mh, intptr_t ) {
218f6c50668Spatrick   removeAllIn((pint_t) mh);
219f6c50668Spatrick }
220f6c50668Spatrick #endif
221f6c50668Spatrick 
222f6c50668Spatrick template <typename A>
iterateCacheEntries(void (* func)(unw_word_t ip_start,unw_word_t ip_end,unw_word_t fde,unw_word_t mh))223f6c50668Spatrick void DwarfFDECache<A>::iterateCacheEntries(void (*func)(
224f6c50668Spatrick     unw_word_t ip_start, unw_word_t ip_end, unw_word_t fde, unw_word_t mh)) {
225f6c50668Spatrick   _LIBUNWIND_LOG_IF_FALSE(_lock.lock());
226f6c50668Spatrick   for (entry *p = _buffer; p < _bufferUsed; ++p) {
227f6c50668Spatrick     (*func)(p->ip_start, p->ip_end, p->fde, p->mh);
228f6c50668Spatrick   }
229f6c50668Spatrick   _LIBUNWIND_LOG_IF_FALSE(_lock.unlock());
230f6c50668Spatrick }
231f6c50668Spatrick #endif // defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
232f6c50668Spatrick 
233f6c50668Spatrick 
234f6c50668Spatrick #define arrayoffsetof(type, index, field) ((size_t)(&((type *)0)[index].field))
235f6c50668Spatrick 
236f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
237f6c50668Spatrick template <typename A> class UnwindSectionHeader {
238f6c50668Spatrick public:
UnwindSectionHeader(A & addressSpace,typename A::pint_t addr)239f6c50668Spatrick   UnwindSectionHeader(A &addressSpace, typename A::pint_t addr)
240f6c50668Spatrick       : _addressSpace(addressSpace), _addr(addr) {}
241f6c50668Spatrick 
version() const242f6c50668Spatrick   uint32_t version() const {
243f6c50668Spatrick     return _addressSpace.get32(_addr +
244f6c50668Spatrick                                offsetof(unwind_info_section_header, version));
245f6c50668Spatrick   }
commonEncodingsArraySectionOffset() const246f6c50668Spatrick   uint32_t commonEncodingsArraySectionOffset() const {
247f6c50668Spatrick     return _addressSpace.get32(_addr +
248f6c50668Spatrick                                offsetof(unwind_info_section_header,
249f6c50668Spatrick                                         commonEncodingsArraySectionOffset));
250f6c50668Spatrick   }
commonEncodingsArrayCount() const251f6c50668Spatrick   uint32_t commonEncodingsArrayCount() const {
252f6c50668Spatrick     return _addressSpace.get32(_addr + offsetof(unwind_info_section_header,
253f6c50668Spatrick                                                 commonEncodingsArrayCount));
254f6c50668Spatrick   }
personalityArraySectionOffset() const255f6c50668Spatrick   uint32_t personalityArraySectionOffset() const {
256f6c50668Spatrick     return _addressSpace.get32(_addr + offsetof(unwind_info_section_header,
257f6c50668Spatrick                                                 personalityArraySectionOffset));
258f6c50668Spatrick   }
personalityArrayCount() const259f6c50668Spatrick   uint32_t personalityArrayCount() const {
260f6c50668Spatrick     return _addressSpace.get32(
261f6c50668Spatrick         _addr + offsetof(unwind_info_section_header, personalityArrayCount));
262f6c50668Spatrick   }
indexSectionOffset() const263f6c50668Spatrick   uint32_t indexSectionOffset() const {
264f6c50668Spatrick     return _addressSpace.get32(
265f6c50668Spatrick         _addr + offsetof(unwind_info_section_header, indexSectionOffset));
266f6c50668Spatrick   }
indexCount() const267f6c50668Spatrick   uint32_t indexCount() const {
268f6c50668Spatrick     return _addressSpace.get32(
269f6c50668Spatrick         _addr + offsetof(unwind_info_section_header, indexCount));
270f6c50668Spatrick   }
271f6c50668Spatrick 
272f6c50668Spatrick private:
273f6c50668Spatrick   A                     &_addressSpace;
274f6c50668Spatrick   typename A::pint_t     _addr;
275f6c50668Spatrick };
276f6c50668Spatrick 
277f6c50668Spatrick template <typename A> class UnwindSectionIndexArray {
278f6c50668Spatrick public:
UnwindSectionIndexArray(A & addressSpace,typename A::pint_t addr)279f6c50668Spatrick   UnwindSectionIndexArray(A &addressSpace, typename A::pint_t addr)
280f6c50668Spatrick       : _addressSpace(addressSpace), _addr(addr) {}
281f6c50668Spatrick 
functionOffset(uint32_t index) const282f6c50668Spatrick   uint32_t functionOffset(uint32_t index) const {
283f6c50668Spatrick     return _addressSpace.get32(
284f6c50668Spatrick         _addr + arrayoffsetof(unwind_info_section_header_index_entry, index,
285f6c50668Spatrick                               functionOffset));
286f6c50668Spatrick   }
secondLevelPagesSectionOffset(uint32_t index) const287f6c50668Spatrick   uint32_t secondLevelPagesSectionOffset(uint32_t index) const {
288f6c50668Spatrick     return _addressSpace.get32(
289f6c50668Spatrick         _addr + arrayoffsetof(unwind_info_section_header_index_entry, index,
290f6c50668Spatrick                               secondLevelPagesSectionOffset));
291f6c50668Spatrick   }
lsdaIndexArraySectionOffset(uint32_t index) const292f6c50668Spatrick   uint32_t lsdaIndexArraySectionOffset(uint32_t index) const {
293f6c50668Spatrick     return _addressSpace.get32(
294f6c50668Spatrick         _addr + arrayoffsetof(unwind_info_section_header_index_entry, index,
295f6c50668Spatrick                               lsdaIndexArraySectionOffset));
296f6c50668Spatrick   }
297f6c50668Spatrick 
298f6c50668Spatrick private:
299f6c50668Spatrick   A                   &_addressSpace;
300f6c50668Spatrick   typename A::pint_t   _addr;
301f6c50668Spatrick };
302f6c50668Spatrick 
303f6c50668Spatrick template <typename A> class UnwindSectionRegularPageHeader {
304f6c50668Spatrick public:
UnwindSectionRegularPageHeader(A & addressSpace,typename A::pint_t addr)305f6c50668Spatrick   UnwindSectionRegularPageHeader(A &addressSpace, typename A::pint_t addr)
306f6c50668Spatrick       : _addressSpace(addressSpace), _addr(addr) {}
307f6c50668Spatrick 
kind() const308f6c50668Spatrick   uint32_t kind() const {
309f6c50668Spatrick     return _addressSpace.get32(
310f6c50668Spatrick         _addr + offsetof(unwind_info_regular_second_level_page_header, kind));
311f6c50668Spatrick   }
entryPageOffset() const312f6c50668Spatrick   uint16_t entryPageOffset() const {
313f6c50668Spatrick     return _addressSpace.get16(
314f6c50668Spatrick         _addr + offsetof(unwind_info_regular_second_level_page_header,
315f6c50668Spatrick                          entryPageOffset));
316f6c50668Spatrick   }
entryCount() const317f6c50668Spatrick   uint16_t entryCount() const {
318f6c50668Spatrick     return _addressSpace.get16(
319f6c50668Spatrick         _addr +
320f6c50668Spatrick         offsetof(unwind_info_regular_second_level_page_header, entryCount));
321f6c50668Spatrick   }
322f6c50668Spatrick 
323f6c50668Spatrick private:
324f6c50668Spatrick   A &_addressSpace;
325f6c50668Spatrick   typename A::pint_t _addr;
326f6c50668Spatrick };
327f6c50668Spatrick 
328f6c50668Spatrick template <typename A> class UnwindSectionRegularArray {
329f6c50668Spatrick public:
UnwindSectionRegularArray(A & addressSpace,typename A::pint_t addr)330f6c50668Spatrick   UnwindSectionRegularArray(A &addressSpace, typename A::pint_t addr)
331f6c50668Spatrick       : _addressSpace(addressSpace), _addr(addr) {}
332f6c50668Spatrick 
functionOffset(uint32_t index) const333f6c50668Spatrick   uint32_t functionOffset(uint32_t index) const {
334f6c50668Spatrick     return _addressSpace.get32(
335f6c50668Spatrick         _addr + arrayoffsetof(unwind_info_regular_second_level_entry, index,
336f6c50668Spatrick                               functionOffset));
337f6c50668Spatrick   }
encoding(uint32_t index) const338f6c50668Spatrick   uint32_t encoding(uint32_t index) const {
339f6c50668Spatrick     return _addressSpace.get32(
340f6c50668Spatrick         _addr +
341f6c50668Spatrick         arrayoffsetof(unwind_info_regular_second_level_entry, index, encoding));
342f6c50668Spatrick   }
343f6c50668Spatrick 
344f6c50668Spatrick private:
345f6c50668Spatrick   A &_addressSpace;
346f6c50668Spatrick   typename A::pint_t _addr;
347f6c50668Spatrick };
348f6c50668Spatrick 
349f6c50668Spatrick template <typename A> class UnwindSectionCompressedPageHeader {
350f6c50668Spatrick public:
UnwindSectionCompressedPageHeader(A & addressSpace,typename A::pint_t addr)351f6c50668Spatrick   UnwindSectionCompressedPageHeader(A &addressSpace, typename A::pint_t addr)
352f6c50668Spatrick       : _addressSpace(addressSpace), _addr(addr) {}
353f6c50668Spatrick 
kind() const354f6c50668Spatrick   uint32_t kind() const {
355f6c50668Spatrick     return _addressSpace.get32(
356f6c50668Spatrick         _addr +
357f6c50668Spatrick         offsetof(unwind_info_compressed_second_level_page_header, kind));
358f6c50668Spatrick   }
entryPageOffset() const359f6c50668Spatrick   uint16_t entryPageOffset() const {
360f6c50668Spatrick     return _addressSpace.get16(
361f6c50668Spatrick         _addr + offsetof(unwind_info_compressed_second_level_page_header,
362f6c50668Spatrick                          entryPageOffset));
363f6c50668Spatrick   }
entryCount() const364f6c50668Spatrick   uint16_t entryCount() const {
365f6c50668Spatrick     return _addressSpace.get16(
366f6c50668Spatrick         _addr +
367f6c50668Spatrick         offsetof(unwind_info_compressed_second_level_page_header, entryCount));
368f6c50668Spatrick   }
encodingsPageOffset() const369f6c50668Spatrick   uint16_t encodingsPageOffset() const {
370f6c50668Spatrick     return _addressSpace.get16(
371f6c50668Spatrick         _addr + offsetof(unwind_info_compressed_second_level_page_header,
372f6c50668Spatrick                          encodingsPageOffset));
373f6c50668Spatrick   }
encodingsCount() const374f6c50668Spatrick   uint16_t encodingsCount() const {
375f6c50668Spatrick     return _addressSpace.get16(
376f6c50668Spatrick         _addr + offsetof(unwind_info_compressed_second_level_page_header,
377f6c50668Spatrick                          encodingsCount));
378f6c50668Spatrick   }
379f6c50668Spatrick 
380f6c50668Spatrick private:
381f6c50668Spatrick   A &_addressSpace;
382f6c50668Spatrick   typename A::pint_t _addr;
383f6c50668Spatrick };
384f6c50668Spatrick 
385f6c50668Spatrick template <typename A> class UnwindSectionCompressedArray {
386f6c50668Spatrick public:
UnwindSectionCompressedArray(A & addressSpace,typename A::pint_t addr)387f6c50668Spatrick   UnwindSectionCompressedArray(A &addressSpace, typename A::pint_t addr)
388f6c50668Spatrick       : _addressSpace(addressSpace), _addr(addr) {}
389f6c50668Spatrick 
functionOffset(uint32_t index) const390f6c50668Spatrick   uint32_t functionOffset(uint32_t index) const {
391f6c50668Spatrick     return UNWIND_INFO_COMPRESSED_ENTRY_FUNC_OFFSET(
392f6c50668Spatrick         _addressSpace.get32(_addr + index * sizeof(uint32_t)));
393f6c50668Spatrick   }
encodingIndex(uint32_t index) const394f6c50668Spatrick   uint16_t encodingIndex(uint32_t index) const {
395f6c50668Spatrick     return UNWIND_INFO_COMPRESSED_ENTRY_ENCODING_INDEX(
396f6c50668Spatrick         _addressSpace.get32(_addr + index * sizeof(uint32_t)));
397f6c50668Spatrick   }
398f6c50668Spatrick 
399f6c50668Spatrick private:
400f6c50668Spatrick   A &_addressSpace;
401f6c50668Spatrick   typename A::pint_t _addr;
402f6c50668Spatrick };
403f6c50668Spatrick 
404f6c50668Spatrick template <typename A> class UnwindSectionLsdaArray {
405f6c50668Spatrick public:
UnwindSectionLsdaArray(A & addressSpace,typename A::pint_t addr)406f6c50668Spatrick   UnwindSectionLsdaArray(A &addressSpace, typename A::pint_t addr)
407f6c50668Spatrick       : _addressSpace(addressSpace), _addr(addr) {}
408f6c50668Spatrick 
functionOffset(uint32_t index) const409f6c50668Spatrick   uint32_t functionOffset(uint32_t index) const {
410f6c50668Spatrick     return _addressSpace.get32(
411f6c50668Spatrick         _addr + arrayoffsetof(unwind_info_section_header_lsda_index_entry,
412f6c50668Spatrick                               index, functionOffset));
413f6c50668Spatrick   }
lsdaOffset(uint32_t index) const414f6c50668Spatrick   uint32_t lsdaOffset(uint32_t index) const {
415f6c50668Spatrick     return _addressSpace.get32(
416f6c50668Spatrick         _addr + arrayoffsetof(unwind_info_section_header_lsda_index_entry,
417f6c50668Spatrick                               index, lsdaOffset));
418f6c50668Spatrick   }
419f6c50668Spatrick 
420f6c50668Spatrick private:
421f6c50668Spatrick   A                   &_addressSpace;
422f6c50668Spatrick   typename A::pint_t   _addr;
423f6c50668Spatrick };
424f6c50668Spatrick #endif // defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
425f6c50668Spatrick 
426f6c50668Spatrick class _LIBUNWIND_HIDDEN AbstractUnwindCursor {
427f6c50668Spatrick public:
428f6c50668Spatrick   // NOTE: provide a class specific placement deallocation function (S5.3.4 p20)
429f6c50668Spatrick   // This avoids an unnecessary dependency to libc++abi.
operator delete(void *,size_t)430f6c50668Spatrick   void operator delete(void *, size_t) {}
431f6c50668Spatrick 
~AbstractUnwindCursor()432f6c50668Spatrick   virtual ~AbstractUnwindCursor() {}
validReg(int)433f6c50668Spatrick   virtual bool validReg(int) { _LIBUNWIND_ABORT("validReg not implemented"); }
getReg(int)434f6c50668Spatrick   virtual unw_word_t getReg(int) { _LIBUNWIND_ABORT("getReg not implemented"); }
setReg(int,unw_word_t)435f6c50668Spatrick   virtual void setReg(int, unw_word_t) {
436f6c50668Spatrick     _LIBUNWIND_ABORT("setReg not implemented");
437f6c50668Spatrick   }
validFloatReg(int)438f6c50668Spatrick   virtual bool validFloatReg(int) {
439f6c50668Spatrick     _LIBUNWIND_ABORT("validFloatReg not implemented");
440f6c50668Spatrick   }
getFloatReg(int)441f6c50668Spatrick   virtual unw_fpreg_t getFloatReg(int) {
442f6c50668Spatrick     _LIBUNWIND_ABORT("getFloatReg not implemented");
443f6c50668Spatrick   }
setFloatReg(int,unw_fpreg_t)444f6c50668Spatrick   virtual void setFloatReg(int, unw_fpreg_t) {
445f6c50668Spatrick     _LIBUNWIND_ABORT("setFloatReg not implemented");
446f6c50668Spatrick   }
step(bool=false)447*202cdb0eSrobert   virtual int step(bool = false) { _LIBUNWIND_ABORT("step not implemented"); }
getInfo(unw_proc_info_t *)448f6c50668Spatrick   virtual void getInfo(unw_proc_info_t *) {
449f6c50668Spatrick     _LIBUNWIND_ABORT("getInfo not implemented");
450f6c50668Spatrick   }
jumpto()451f6c50668Spatrick   virtual void jumpto() { _LIBUNWIND_ABORT("jumpto not implemented"); }
isSignalFrame()452f6c50668Spatrick   virtual bool isSignalFrame() {
453f6c50668Spatrick     _LIBUNWIND_ABORT("isSignalFrame not implemented");
454f6c50668Spatrick   }
getFunctionName(char *,size_t,unw_word_t *)455f6c50668Spatrick   virtual bool getFunctionName(char *, size_t, unw_word_t *) {
456f6c50668Spatrick     _LIBUNWIND_ABORT("getFunctionName not implemented");
457f6c50668Spatrick   }
setInfoBasedOnIPRegister(bool=false)458f6c50668Spatrick   virtual void setInfoBasedOnIPRegister(bool = false) {
459f6c50668Spatrick     _LIBUNWIND_ABORT("setInfoBasedOnIPRegister not implemented");
460f6c50668Spatrick   }
getRegisterName(int)461f6c50668Spatrick   virtual const char *getRegisterName(int) {
462f6c50668Spatrick     _LIBUNWIND_ABORT("getRegisterName not implemented");
463f6c50668Spatrick   }
464f6c50668Spatrick #ifdef __arm__
saveVFPAsX()465f6c50668Spatrick   virtual void saveVFPAsX() { _LIBUNWIND_ABORT("saveVFPAsX not implemented"); }
466f6c50668Spatrick #endif
467*202cdb0eSrobert 
468*202cdb0eSrobert #ifdef _AIX
getDataRelBase()469*202cdb0eSrobert   virtual uintptr_t getDataRelBase() {
470*202cdb0eSrobert     _LIBUNWIND_ABORT("getDataRelBase not implemented");
471*202cdb0eSrobert   }
472*202cdb0eSrobert #endif
473*202cdb0eSrobert 
474*202cdb0eSrobert #if defined(_LIBUNWIND_USE_CET)
get_registers()475*202cdb0eSrobert   virtual void *get_registers() {
476*202cdb0eSrobert     _LIBUNWIND_ABORT("get_registers not implemented");
477*202cdb0eSrobert   }
478*202cdb0eSrobert #endif
479f6c50668Spatrick };
480f6c50668Spatrick 
481f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_SEH_UNWIND) && defined(_WIN32)
482f6c50668Spatrick 
483f6c50668Spatrick /// \c UnwindCursor contains all state (including all register values) during
484f6c50668Spatrick /// an unwind.  This is normally stack-allocated inside a unw_cursor_t.
485f6c50668Spatrick template <typename A, typename R>
486f6c50668Spatrick class UnwindCursor : public AbstractUnwindCursor {
487f6c50668Spatrick   typedef typename A::pint_t pint_t;
488f6c50668Spatrick public:
489f6c50668Spatrick                       UnwindCursor(unw_context_t *context, A &as);
490f6c50668Spatrick                       UnwindCursor(CONTEXT *context, A &as);
491f6c50668Spatrick                       UnwindCursor(A &as, void *threadArg);
~UnwindCursor()492f6c50668Spatrick   virtual             ~UnwindCursor() {}
493f6c50668Spatrick   virtual bool        validReg(int);
494f6c50668Spatrick   virtual unw_word_t  getReg(int);
495f6c50668Spatrick   virtual void        setReg(int, unw_word_t);
496f6c50668Spatrick   virtual bool        validFloatReg(int);
497f6c50668Spatrick   virtual unw_fpreg_t getFloatReg(int);
498f6c50668Spatrick   virtual void        setFloatReg(int, unw_fpreg_t);
499*202cdb0eSrobert   virtual int         step(bool = false);
500f6c50668Spatrick   virtual void        getInfo(unw_proc_info_t *);
501f6c50668Spatrick   virtual void        jumpto();
502f6c50668Spatrick   virtual bool        isSignalFrame();
503f6c50668Spatrick   virtual bool        getFunctionName(char *buf, size_t len, unw_word_t *off);
504f6c50668Spatrick   virtual void        setInfoBasedOnIPRegister(bool isReturnAddress = false);
505f6c50668Spatrick   virtual const char *getRegisterName(int num);
506f6c50668Spatrick #ifdef __arm__
507f6c50668Spatrick   virtual void        saveVFPAsX();
508f6c50668Spatrick #endif
509f6c50668Spatrick 
getDispatcherContext()510f6c50668Spatrick   DISPATCHER_CONTEXT *getDispatcherContext() { return &_dispContext; }
setDispatcherContext(DISPATCHER_CONTEXT * disp)511f6c50668Spatrick   void setDispatcherContext(DISPATCHER_CONTEXT *disp) { _dispContext = *disp; }
512f6c50668Spatrick 
513f6c50668Spatrick   // libunwind does not and should not depend on C++ library which means that we
514*202cdb0eSrobert   // need our own definition of inline placement new.
operator new(size_t,UnwindCursor<A,R> * p)515f6c50668Spatrick   static void *operator new(size_t, UnwindCursor<A, R> *p) { return p; }
516f6c50668Spatrick 
517f6c50668Spatrick private:
518f6c50668Spatrick 
getLastPC() const519f6c50668Spatrick   pint_t getLastPC() const { return _dispContext.ControlPc; }
setLastPC(pint_t pc)520f6c50668Spatrick   void setLastPC(pint_t pc) { _dispContext.ControlPc = pc; }
lookUpSEHUnwindInfo(pint_t pc,pint_t * base)521f6c50668Spatrick   RUNTIME_FUNCTION *lookUpSEHUnwindInfo(pint_t pc, pint_t *base) {
522*202cdb0eSrobert #ifdef __arm__
523*202cdb0eSrobert     // Remove the thumb bit; FunctionEntry ranges don't include the thumb bit.
524*202cdb0eSrobert     pc &= ~1U;
525*202cdb0eSrobert #endif
526*202cdb0eSrobert     // If pc points exactly at the end of the range, we might resolve the
527*202cdb0eSrobert     // next function instead. Decrement pc by 1 to fit inside the current
528*202cdb0eSrobert     // function.
529*202cdb0eSrobert     pc -= 1;
530f6c50668Spatrick     _dispContext.FunctionEntry = RtlLookupFunctionEntry(pc,
531f6c50668Spatrick                                                         &_dispContext.ImageBase,
532f6c50668Spatrick                                                         _dispContext.HistoryTable);
533f6c50668Spatrick     *base = _dispContext.ImageBase;
534f6c50668Spatrick     return _dispContext.FunctionEntry;
535f6c50668Spatrick   }
536f6c50668Spatrick   bool getInfoFromSEH(pint_t pc);
stepWithSEHData()537f6c50668Spatrick   int stepWithSEHData() {
538f6c50668Spatrick     _dispContext.LanguageHandler = RtlVirtualUnwind(UNW_FLAG_UHANDLER,
539f6c50668Spatrick                                                     _dispContext.ImageBase,
540f6c50668Spatrick                                                     _dispContext.ControlPc,
541f6c50668Spatrick                                                     _dispContext.FunctionEntry,
542f6c50668Spatrick                                                     _dispContext.ContextRecord,
543f6c50668Spatrick                                                     &_dispContext.HandlerData,
544f6c50668Spatrick                                                     &_dispContext.EstablisherFrame,
545f6c50668Spatrick                                                     NULL);
546f6c50668Spatrick     // Update some fields of the unwind info now, since we have them.
547f6c50668Spatrick     _info.lsda = reinterpret_cast<unw_word_t>(_dispContext.HandlerData);
548f6c50668Spatrick     if (_dispContext.LanguageHandler) {
549f6c50668Spatrick       _info.handler = reinterpret_cast<unw_word_t>(__libunwind_seh_personality);
550f6c50668Spatrick     } else
551f6c50668Spatrick       _info.handler = 0;
552f6c50668Spatrick     return UNW_STEP_SUCCESS;
553f6c50668Spatrick   }
554f6c50668Spatrick 
555f6c50668Spatrick   A                   &_addressSpace;
556f6c50668Spatrick   unw_proc_info_t      _info;
557f6c50668Spatrick   DISPATCHER_CONTEXT   _dispContext;
558f6c50668Spatrick   CONTEXT              _msContext;
559f6c50668Spatrick   UNWIND_HISTORY_TABLE _histTable;
560f6c50668Spatrick   bool                 _unwindInfoMissing;
561f6c50668Spatrick };
562f6c50668Spatrick 
563f6c50668Spatrick 
564f6c50668Spatrick template <typename A, typename R>
UnwindCursor(unw_context_t * context,A & as)565f6c50668Spatrick UnwindCursor<A, R>::UnwindCursor(unw_context_t *context, A &as)
566f6c50668Spatrick     : _addressSpace(as), _unwindInfoMissing(false) {
567f6c50668Spatrick   static_assert((check_fit<UnwindCursor<A, R>, unw_cursor_t>::does_fit),
568f6c50668Spatrick                 "UnwindCursor<> does not fit in unw_cursor_t");
569a0747c9fSpatrick   static_assert((alignof(UnwindCursor<A, R>) <= alignof(unw_cursor_t)),
570a0747c9fSpatrick                 "UnwindCursor<> requires more alignment than unw_cursor_t");
571f6c50668Spatrick   memset(&_info, 0, sizeof(_info));
572f6c50668Spatrick   memset(&_histTable, 0, sizeof(_histTable));
573f6c50668Spatrick   _dispContext.ContextRecord = &_msContext;
574f6c50668Spatrick   _dispContext.HistoryTable = &_histTable;
575f6c50668Spatrick   // Initialize MS context from ours.
576f6c50668Spatrick   R r(context);
577f6c50668Spatrick   _msContext.ContextFlags = CONTEXT_CONTROL|CONTEXT_INTEGER|CONTEXT_FLOATING_POINT;
578f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_X86_64)
579f6c50668Spatrick   _msContext.Rax = r.getRegister(UNW_X86_64_RAX);
580f6c50668Spatrick   _msContext.Rcx = r.getRegister(UNW_X86_64_RCX);
581f6c50668Spatrick   _msContext.Rdx = r.getRegister(UNW_X86_64_RDX);
582f6c50668Spatrick   _msContext.Rbx = r.getRegister(UNW_X86_64_RBX);
583f6c50668Spatrick   _msContext.Rsp = r.getRegister(UNW_X86_64_RSP);
584f6c50668Spatrick   _msContext.Rbp = r.getRegister(UNW_X86_64_RBP);
585f6c50668Spatrick   _msContext.Rsi = r.getRegister(UNW_X86_64_RSI);
586f6c50668Spatrick   _msContext.Rdi = r.getRegister(UNW_X86_64_RDI);
587f6c50668Spatrick   _msContext.R8 = r.getRegister(UNW_X86_64_R8);
588f6c50668Spatrick   _msContext.R9 = r.getRegister(UNW_X86_64_R9);
589f6c50668Spatrick   _msContext.R10 = r.getRegister(UNW_X86_64_R10);
590f6c50668Spatrick   _msContext.R11 = r.getRegister(UNW_X86_64_R11);
591f6c50668Spatrick   _msContext.R12 = r.getRegister(UNW_X86_64_R12);
592f6c50668Spatrick   _msContext.R13 = r.getRegister(UNW_X86_64_R13);
593f6c50668Spatrick   _msContext.R14 = r.getRegister(UNW_X86_64_R14);
594f6c50668Spatrick   _msContext.R15 = r.getRegister(UNW_X86_64_R15);
595f6c50668Spatrick   _msContext.Rip = r.getRegister(UNW_REG_IP);
596f6c50668Spatrick   union {
597f6c50668Spatrick     v128 v;
598f6c50668Spatrick     M128A m;
599f6c50668Spatrick   } t;
600f6c50668Spatrick   t.v = r.getVectorRegister(UNW_X86_64_XMM0);
601f6c50668Spatrick   _msContext.Xmm0 = t.m;
602f6c50668Spatrick   t.v = r.getVectorRegister(UNW_X86_64_XMM1);
603f6c50668Spatrick   _msContext.Xmm1 = t.m;
604f6c50668Spatrick   t.v = r.getVectorRegister(UNW_X86_64_XMM2);
605f6c50668Spatrick   _msContext.Xmm2 = t.m;
606f6c50668Spatrick   t.v = r.getVectorRegister(UNW_X86_64_XMM3);
607f6c50668Spatrick   _msContext.Xmm3 = t.m;
608f6c50668Spatrick   t.v = r.getVectorRegister(UNW_X86_64_XMM4);
609f6c50668Spatrick   _msContext.Xmm4 = t.m;
610f6c50668Spatrick   t.v = r.getVectorRegister(UNW_X86_64_XMM5);
611f6c50668Spatrick   _msContext.Xmm5 = t.m;
612f6c50668Spatrick   t.v = r.getVectorRegister(UNW_X86_64_XMM6);
613f6c50668Spatrick   _msContext.Xmm6 = t.m;
614f6c50668Spatrick   t.v = r.getVectorRegister(UNW_X86_64_XMM7);
615f6c50668Spatrick   _msContext.Xmm7 = t.m;
616f6c50668Spatrick   t.v = r.getVectorRegister(UNW_X86_64_XMM8);
617f6c50668Spatrick   _msContext.Xmm8 = t.m;
618f6c50668Spatrick   t.v = r.getVectorRegister(UNW_X86_64_XMM9);
619f6c50668Spatrick   _msContext.Xmm9 = t.m;
620f6c50668Spatrick   t.v = r.getVectorRegister(UNW_X86_64_XMM10);
621f6c50668Spatrick   _msContext.Xmm10 = t.m;
622f6c50668Spatrick   t.v = r.getVectorRegister(UNW_X86_64_XMM11);
623f6c50668Spatrick   _msContext.Xmm11 = t.m;
624f6c50668Spatrick   t.v = r.getVectorRegister(UNW_X86_64_XMM12);
625f6c50668Spatrick   _msContext.Xmm12 = t.m;
626f6c50668Spatrick   t.v = r.getVectorRegister(UNW_X86_64_XMM13);
627f6c50668Spatrick   _msContext.Xmm13 = t.m;
628f6c50668Spatrick   t.v = r.getVectorRegister(UNW_X86_64_XMM14);
629f6c50668Spatrick   _msContext.Xmm14 = t.m;
630f6c50668Spatrick   t.v = r.getVectorRegister(UNW_X86_64_XMM15);
631f6c50668Spatrick   _msContext.Xmm15 = t.m;
632f6c50668Spatrick #elif defined(_LIBUNWIND_TARGET_ARM)
633f6c50668Spatrick   _msContext.R0 = r.getRegister(UNW_ARM_R0);
634f6c50668Spatrick   _msContext.R1 = r.getRegister(UNW_ARM_R1);
635f6c50668Spatrick   _msContext.R2 = r.getRegister(UNW_ARM_R2);
636f6c50668Spatrick   _msContext.R3 = r.getRegister(UNW_ARM_R3);
637f6c50668Spatrick   _msContext.R4 = r.getRegister(UNW_ARM_R4);
638f6c50668Spatrick   _msContext.R5 = r.getRegister(UNW_ARM_R5);
639f6c50668Spatrick   _msContext.R6 = r.getRegister(UNW_ARM_R6);
640f6c50668Spatrick   _msContext.R7 = r.getRegister(UNW_ARM_R7);
641f6c50668Spatrick   _msContext.R8 = r.getRegister(UNW_ARM_R8);
642f6c50668Spatrick   _msContext.R9 = r.getRegister(UNW_ARM_R9);
643f6c50668Spatrick   _msContext.R10 = r.getRegister(UNW_ARM_R10);
644f6c50668Spatrick   _msContext.R11 = r.getRegister(UNW_ARM_R11);
645f6c50668Spatrick   _msContext.R12 = r.getRegister(UNW_ARM_R12);
646f6c50668Spatrick   _msContext.Sp = r.getRegister(UNW_ARM_SP);
647f6c50668Spatrick   _msContext.Lr = r.getRegister(UNW_ARM_LR);
648f6c50668Spatrick   _msContext.Pc = r.getRegister(UNW_ARM_IP);
649f6c50668Spatrick   for (int i = UNW_ARM_D0; i <= UNW_ARM_D31; ++i) {
650f6c50668Spatrick     union {
651f6c50668Spatrick       uint64_t w;
652f6c50668Spatrick       double d;
653f6c50668Spatrick     } d;
654f6c50668Spatrick     d.d = r.getFloatRegister(i);
655f6c50668Spatrick     _msContext.D[i - UNW_ARM_D0] = d.w;
656f6c50668Spatrick   }
657f6c50668Spatrick #elif defined(_LIBUNWIND_TARGET_AARCH64)
658*202cdb0eSrobert   for (int i = UNW_AARCH64_X0; i <= UNW_ARM64_X30; ++i)
659*202cdb0eSrobert     _msContext.X[i - UNW_AARCH64_X0] = r.getRegister(i);
660f6c50668Spatrick   _msContext.Sp = r.getRegister(UNW_REG_SP);
661f6c50668Spatrick   _msContext.Pc = r.getRegister(UNW_REG_IP);
662*202cdb0eSrobert   for (int i = UNW_AARCH64_V0; i <= UNW_ARM64_D31; ++i)
663*202cdb0eSrobert     _msContext.V[i - UNW_AARCH64_V0].D[0] = r.getFloatRegister(i);
664f6c50668Spatrick #endif
665f6c50668Spatrick }
666f6c50668Spatrick 
667f6c50668Spatrick template <typename A, typename R>
UnwindCursor(CONTEXT * context,A & as)668f6c50668Spatrick UnwindCursor<A, R>::UnwindCursor(CONTEXT *context, A &as)
669f6c50668Spatrick     : _addressSpace(as), _unwindInfoMissing(false) {
670f6c50668Spatrick   static_assert((check_fit<UnwindCursor<A, R>, unw_cursor_t>::does_fit),
671f6c50668Spatrick                 "UnwindCursor<> does not fit in unw_cursor_t");
672f6c50668Spatrick   memset(&_info, 0, sizeof(_info));
673f6c50668Spatrick   memset(&_histTable, 0, sizeof(_histTable));
674f6c50668Spatrick   _dispContext.ContextRecord = &_msContext;
675f6c50668Spatrick   _dispContext.HistoryTable = &_histTable;
676f6c50668Spatrick   _msContext = *context;
677f6c50668Spatrick }
678f6c50668Spatrick 
679f6c50668Spatrick 
680f6c50668Spatrick template <typename A, typename R>
validReg(int regNum)681f6c50668Spatrick bool UnwindCursor<A, R>::validReg(int regNum) {
682f6c50668Spatrick   if (regNum == UNW_REG_IP || regNum == UNW_REG_SP) return true;
683f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_X86_64)
684f6c50668Spatrick   if (regNum >= UNW_X86_64_RAX && regNum <= UNW_X86_64_R15) return true;
685f6c50668Spatrick #elif defined(_LIBUNWIND_TARGET_ARM)
686*202cdb0eSrobert   if ((regNum >= UNW_ARM_R0 && regNum <= UNW_ARM_R15) ||
687*202cdb0eSrobert       regNum == UNW_ARM_RA_AUTH_CODE)
688*202cdb0eSrobert     return true;
689f6c50668Spatrick #elif defined(_LIBUNWIND_TARGET_AARCH64)
690*202cdb0eSrobert   if (regNum >= UNW_AARCH64_X0 && regNum <= UNW_ARM64_X30) return true;
691f6c50668Spatrick #endif
692f6c50668Spatrick   return false;
693f6c50668Spatrick }
694f6c50668Spatrick 
695f6c50668Spatrick template <typename A, typename R>
getReg(int regNum)696f6c50668Spatrick unw_word_t UnwindCursor<A, R>::getReg(int regNum) {
697f6c50668Spatrick   switch (regNum) {
698f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_X86_64)
699f6c50668Spatrick   case UNW_REG_IP: return _msContext.Rip;
700f6c50668Spatrick   case UNW_X86_64_RAX: return _msContext.Rax;
701f6c50668Spatrick   case UNW_X86_64_RDX: return _msContext.Rdx;
702f6c50668Spatrick   case UNW_X86_64_RCX: return _msContext.Rcx;
703f6c50668Spatrick   case UNW_X86_64_RBX: return _msContext.Rbx;
704f6c50668Spatrick   case UNW_REG_SP:
705f6c50668Spatrick   case UNW_X86_64_RSP: return _msContext.Rsp;
706f6c50668Spatrick   case UNW_X86_64_RBP: return _msContext.Rbp;
707f6c50668Spatrick   case UNW_X86_64_RSI: return _msContext.Rsi;
708f6c50668Spatrick   case UNW_X86_64_RDI: return _msContext.Rdi;
709f6c50668Spatrick   case UNW_X86_64_R8: return _msContext.R8;
710f6c50668Spatrick   case UNW_X86_64_R9: return _msContext.R9;
711f6c50668Spatrick   case UNW_X86_64_R10: return _msContext.R10;
712f6c50668Spatrick   case UNW_X86_64_R11: return _msContext.R11;
713f6c50668Spatrick   case UNW_X86_64_R12: return _msContext.R12;
714f6c50668Spatrick   case UNW_X86_64_R13: return _msContext.R13;
715f6c50668Spatrick   case UNW_X86_64_R14: return _msContext.R14;
716f6c50668Spatrick   case UNW_X86_64_R15: return _msContext.R15;
717f6c50668Spatrick #elif defined(_LIBUNWIND_TARGET_ARM)
718f6c50668Spatrick   case UNW_ARM_R0: return _msContext.R0;
719f6c50668Spatrick   case UNW_ARM_R1: return _msContext.R1;
720f6c50668Spatrick   case UNW_ARM_R2: return _msContext.R2;
721f6c50668Spatrick   case UNW_ARM_R3: return _msContext.R3;
722f6c50668Spatrick   case UNW_ARM_R4: return _msContext.R4;
723f6c50668Spatrick   case UNW_ARM_R5: return _msContext.R5;
724f6c50668Spatrick   case UNW_ARM_R6: return _msContext.R6;
725f6c50668Spatrick   case UNW_ARM_R7: return _msContext.R7;
726f6c50668Spatrick   case UNW_ARM_R8: return _msContext.R8;
727f6c50668Spatrick   case UNW_ARM_R9: return _msContext.R9;
728f6c50668Spatrick   case UNW_ARM_R10: return _msContext.R10;
729f6c50668Spatrick   case UNW_ARM_R11: return _msContext.R11;
730f6c50668Spatrick   case UNW_ARM_R12: return _msContext.R12;
731f6c50668Spatrick   case UNW_REG_SP:
732f6c50668Spatrick   case UNW_ARM_SP: return _msContext.Sp;
733f6c50668Spatrick   case UNW_ARM_LR: return _msContext.Lr;
734f6c50668Spatrick   case UNW_REG_IP:
735f6c50668Spatrick   case UNW_ARM_IP: return _msContext.Pc;
736f6c50668Spatrick #elif defined(_LIBUNWIND_TARGET_AARCH64)
737f6c50668Spatrick   case UNW_REG_SP: return _msContext.Sp;
738f6c50668Spatrick   case UNW_REG_IP: return _msContext.Pc;
739*202cdb0eSrobert   default: return _msContext.X[regNum - UNW_AARCH64_X0];
740f6c50668Spatrick #endif
741f6c50668Spatrick   }
742f6c50668Spatrick   _LIBUNWIND_ABORT("unsupported register");
743f6c50668Spatrick }
744f6c50668Spatrick 
745f6c50668Spatrick template <typename A, typename R>
setReg(int regNum,unw_word_t value)746f6c50668Spatrick void UnwindCursor<A, R>::setReg(int regNum, unw_word_t value) {
747f6c50668Spatrick   switch (regNum) {
748f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_X86_64)
749f6c50668Spatrick   case UNW_REG_IP: _msContext.Rip = value; break;
750f6c50668Spatrick   case UNW_X86_64_RAX: _msContext.Rax = value; break;
751f6c50668Spatrick   case UNW_X86_64_RDX: _msContext.Rdx = value; break;
752f6c50668Spatrick   case UNW_X86_64_RCX: _msContext.Rcx = value; break;
753f6c50668Spatrick   case UNW_X86_64_RBX: _msContext.Rbx = value; break;
754f6c50668Spatrick   case UNW_REG_SP:
755f6c50668Spatrick   case UNW_X86_64_RSP: _msContext.Rsp = value; break;
756f6c50668Spatrick   case UNW_X86_64_RBP: _msContext.Rbp = value; break;
757f6c50668Spatrick   case UNW_X86_64_RSI: _msContext.Rsi = value; break;
758f6c50668Spatrick   case UNW_X86_64_RDI: _msContext.Rdi = value; break;
759f6c50668Spatrick   case UNW_X86_64_R8: _msContext.R8 = value; break;
760f6c50668Spatrick   case UNW_X86_64_R9: _msContext.R9 = value; break;
761f6c50668Spatrick   case UNW_X86_64_R10: _msContext.R10 = value; break;
762f6c50668Spatrick   case UNW_X86_64_R11: _msContext.R11 = value; break;
763f6c50668Spatrick   case UNW_X86_64_R12: _msContext.R12 = value; break;
764f6c50668Spatrick   case UNW_X86_64_R13: _msContext.R13 = value; break;
765f6c50668Spatrick   case UNW_X86_64_R14: _msContext.R14 = value; break;
766f6c50668Spatrick   case UNW_X86_64_R15: _msContext.R15 = value; break;
767f6c50668Spatrick #elif defined(_LIBUNWIND_TARGET_ARM)
768f6c50668Spatrick   case UNW_ARM_R0: _msContext.R0 = value; break;
769f6c50668Spatrick   case UNW_ARM_R1: _msContext.R1 = value; break;
770f6c50668Spatrick   case UNW_ARM_R2: _msContext.R2 = value; break;
771f6c50668Spatrick   case UNW_ARM_R3: _msContext.R3 = value; break;
772f6c50668Spatrick   case UNW_ARM_R4: _msContext.R4 = value; break;
773f6c50668Spatrick   case UNW_ARM_R5: _msContext.R5 = value; break;
774f6c50668Spatrick   case UNW_ARM_R6: _msContext.R6 = value; break;
775f6c50668Spatrick   case UNW_ARM_R7: _msContext.R7 = value; break;
776f6c50668Spatrick   case UNW_ARM_R8: _msContext.R8 = value; break;
777f6c50668Spatrick   case UNW_ARM_R9: _msContext.R9 = value; break;
778f6c50668Spatrick   case UNW_ARM_R10: _msContext.R10 = value; break;
779f6c50668Spatrick   case UNW_ARM_R11: _msContext.R11 = value; break;
780f6c50668Spatrick   case UNW_ARM_R12: _msContext.R12 = value; break;
781f6c50668Spatrick   case UNW_REG_SP:
782f6c50668Spatrick   case UNW_ARM_SP: _msContext.Sp = value; break;
783f6c50668Spatrick   case UNW_ARM_LR: _msContext.Lr = value; break;
784f6c50668Spatrick   case UNW_REG_IP:
785f6c50668Spatrick   case UNW_ARM_IP: _msContext.Pc = value; break;
786f6c50668Spatrick #elif defined(_LIBUNWIND_TARGET_AARCH64)
787f6c50668Spatrick   case UNW_REG_SP: _msContext.Sp = value; break;
788f6c50668Spatrick   case UNW_REG_IP: _msContext.Pc = value; break;
789*202cdb0eSrobert   case UNW_AARCH64_X0:
790*202cdb0eSrobert   case UNW_AARCH64_X1:
791*202cdb0eSrobert   case UNW_AARCH64_X2:
792*202cdb0eSrobert   case UNW_AARCH64_X3:
793*202cdb0eSrobert   case UNW_AARCH64_X4:
794*202cdb0eSrobert   case UNW_AARCH64_X5:
795*202cdb0eSrobert   case UNW_AARCH64_X6:
796*202cdb0eSrobert   case UNW_AARCH64_X7:
797*202cdb0eSrobert   case UNW_AARCH64_X8:
798*202cdb0eSrobert   case UNW_AARCH64_X9:
799*202cdb0eSrobert   case UNW_AARCH64_X10:
800*202cdb0eSrobert   case UNW_AARCH64_X11:
801*202cdb0eSrobert   case UNW_AARCH64_X12:
802*202cdb0eSrobert   case UNW_AARCH64_X13:
803*202cdb0eSrobert   case UNW_AARCH64_X14:
804*202cdb0eSrobert   case UNW_AARCH64_X15:
805*202cdb0eSrobert   case UNW_AARCH64_X16:
806*202cdb0eSrobert   case UNW_AARCH64_X17:
807*202cdb0eSrobert   case UNW_AARCH64_X18:
808*202cdb0eSrobert   case UNW_AARCH64_X19:
809*202cdb0eSrobert   case UNW_AARCH64_X20:
810*202cdb0eSrobert   case UNW_AARCH64_X21:
811*202cdb0eSrobert   case UNW_AARCH64_X22:
812*202cdb0eSrobert   case UNW_AARCH64_X23:
813*202cdb0eSrobert   case UNW_AARCH64_X24:
814*202cdb0eSrobert   case UNW_AARCH64_X25:
815*202cdb0eSrobert   case UNW_AARCH64_X26:
816*202cdb0eSrobert   case UNW_AARCH64_X27:
817*202cdb0eSrobert   case UNW_AARCH64_X28:
818*202cdb0eSrobert   case UNW_AARCH64_FP:
819*202cdb0eSrobert   case UNW_AARCH64_LR: _msContext.X[regNum - UNW_ARM64_X0] = value; break;
820f6c50668Spatrick #endif
821f6c50668Spatrick   default:
822f6c50668Spatrick     _LIBUNWIND_ABORT("unsupported register");
823f6c50668Spatrick   }
824f6c50668Spatrick }
825f6c50668Spatrick 
826f6c50668Spatrick template <typename A, typename R>
validFloatReg(int regNum)827f6c50668Spatrick bool UnwindCursor<A, R>::validFloatReg(int regNum) {
828f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_ARM)
829f6c50668Spatrick   if (regNum >= UNW_ARM_S0 && regNum <= UNW_ARM_S31) return true;
830f6c50668Spatrick   if (regNum >= UNW_ARM_D0 && regNum <= UNW_ARM_D31) return true;
831f6c50668Spatrick #elif defined(_LIBUNWIND_TARGET_AARCH64)
832*202cdb0eSrobert   if (regNum >= UNW_AARCH64_V0 && regNum <= UNW_ARM64_D31) return true;
833f6c50668Spatrick #else
834f6c50668Spatrick   (void)regNum;
835f6c50668Spatrick #endif
836f6c50668Spatrick   return false;
837f6c50668Spatrick }
838f6c50668Spatrick 
839f6c50668Spatrick template <typename A, typename R>
getFloatReg(int regNum)840f6c50668Spatrick unw_fpreg_t UnwindCursor<A, R>::getFloatReg(int regNum) {
841f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_ARM)
842f6c50668Spatrick   if (regNum >= UNW_ARM_S0 && regNum <= UNW_ARM_S31) {
843f6c50668Spatrick     union {
844f6c50668Spatrick       uint32_t w;
845f6c50668Spatrick       float f;
846f6c50668Spatrick     } d;
847f6c50668Spatrick     d.w = _msContext.S[regNum - UNW_ARM_S0];
848f6c50668Spatrick     return d.f;
849f6c50668Spatrick   }
850f6c50668Spatrick   if (regNum >= UNW_ARM_D0 && regNum <= UNW_ARM_D31) {
851f6c50668Spatrick     union {
852f6c50668Spatrick       uint64_t w;
853f6c50668Spatrick       double d;
854f6c50668Spatrick     } d;
855f6c50668Spatrick     d.w = _msContext.D[regNum - UNW_ARM_D0];
856f6c50668Spatrick     return d.d;
857f6c50668Spatrick   }
858f6c50668Spatrick   _LIBUNWIND_ABORT("unsupported float register");
859f6c50668Spatrick #elif defined(_LIBUNWIND_TARGET_AARCH64)
860*202cdb0eSrobert   return _msContext.V[regNum - UNW_AARCH64_V0].D[0];
861f6c50668Spatrick #else
862f6c50668Spatrick   (void)regNum;
863f6c50668Spatrick   _LIBUNWIND_ABORT("float registers unimplemented");
864f6c50668Spatrick #endif
865f6c50668Spatrick }
866f6c50668Spatrick 
867f6c50668Spatrick template <typename A, typename R>
setFloatReg(int regNum,unw_fpreg_t value)868f6c50668Spatrick void UnwindCursor<A, R>::setFloatReg(int regNum, unw_fpreg_t value) {
869f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_ARM)
870f6c50668Spatrick   if (regNum >= UNW_ARM_S0 && regNum <= UNW_ARM_S31) {
871f6c50668Spatrick     union {
872f6c50668Spatrick       uint32_t w;
873f6c50668Spatrick       float f;
874f6c50668Spatrick     } d;
875*202cdb0eSrobert     d.f = (float)value;
876f6c50668Spatrick     _msContext.S[regNum - UNW_ARM_S0] = d.w;
877f6c50668Spatrick   }
878f6c50668Spatrick   if (regNum >= UNW_ARM_D0 && regNum <= UNW_ARM_D31) {
879f6c50668Spatrick     union {
880f6c50668Spatrick       uint64_t w;
881f6c50668Spatrick       double d;
882f6c50668Spatrick     } d;
883f6c50668Spatrick     d.d = value;
884f6c50668Spatrick     _msContext.D[regNum - UNW_ARM_D0] = d.w;
885f6c50668Spatrick   }
886f6c50668Spatrick   _LIBUNWIND_ABORT("unsupported float register");
887f6c50668Spatrick #elif defined(_LIBUNWIND_TARGET_AARCH64)
888*202cdb0eSrobert   _msContext.V[regNum - UNW_AARCH64_V0].D[0] = value;
889f6c50668Spatrick #else
890f6c50668Spatrick   (void)regNum;
891f6c50668Spatrick   (void)value;
892f6c50668Spatrick   _LIBUNWIND_ABORT("float registers unimplemented");
893f6c50668Spatrick #endif
894f6c50668Spatrick }
895f6c50668Spatrick 
jumpto()896f6c50668Spatrick template <typename A, typename R> void UnwindCursor<A, R>::jumpto() {
897f6c50668Spatrick   RtlRestoreContext(&_msContext, nullptr);
898f6c50668Spatrick }
899f6c50668Spatrick 
900f6c50668Spatrick #ifdef __arm__
saveVFPAsX()901f6c50668Spatrick template <typename A, typename R> void UnwindCursor<A, R>::saveVFPAsX() {}
902f6c50668Spatrick #endif
903f6c50668Spatrick 
904f6c50668Spatrick template <typename A, typename R>
getRegisterName(int regNum)905f6c50668Spatrick const char *UnwindCursor<A, R>::getRegisterName(int regNum) {
906f6c50668Spatrick   return R::getRegisterName(regNum);
907f6c50668Spatrick }
908f6c50668Spatrick 
isSignalFrame()909f6c50668Spatrick template <typename A, typename R> bool UnwindCursor<A, R>::isSignalFrame() {
910f6c50668Spatrick   return false;
911f6c50668Spatrick }
912f6c50668Spatrick 
913f6c50668Spatrick #else  // !defined(_LIBUNWIND_SUPPORT_SEH_UNWIND) || !defined(_WIN32)
914f6c50668Spatrick 
915f6c50668Spatrick /// UnwindCursor contains all state (including all register values) during
916f6c50668Spatrick /// an unwind.  This is normally stack allocated inside a unw_cursor_t.
917f6c50668Spatrick template <typename A, typename R>
918f6c50668Spatrick class UnwindCursor : public AbstractUnwindCursor{
919f6c50668Spatrick   typedef typename A::pint_t pint_t;
920f6c50668Spatrick public:
921f6c50668Spatrick                       UnwindCursor(unw_context_t *context, A &as);
922f6c50668Spatrick                       UnwindCursor(A &as, void *threadArg);
~UnwindCursor()923f6c50668Spatrick   virtual             ~UnwindCursor() {}
924f6c50668Spatrick   virtual bool        validReg(int);
925f6c50668Spatrick   virtual unw_word_t  getReg(int);
926f6c50668Spatrick   virtual void        setReg(int, unw_word_t);
927f6c50668Spatrick   virtual bool        validFloatReg(int);
928f6c50668Spatrick   virtual unw_fpreg_t getFloatReg(int);
929f6c50668Spatrick   virtual void        setFloatReg(int, unw_fpreg_t);
930*202cdb0eSrobert   virtual int         step(bool stage2 = false);
931f6c50668Spatrick   virtual void        getInfo(unw_proc_info_t *);
932f6c50668Spatrick   virtual void        jumpto();
933f6c50668Spatrick   virtual bool        isSignalFrame();
934f6c50668Spatrick   virtual bool        getFunctionName(char *buf, size_t len, unw_word_t *off);
935f6c50668Spatrick   virtual void        setInfoBasedOnIPRegister(bool isReturnAddress = false);
936f6c50668Spatrick   virtual const char *getRegisterName(int num);
937f6c50668Spatrick #ifdef __arm__
938f6c50668Spatrick   virtual void        saveVFPAsX();
939f6c50668Spatrick #endif
940f6c50668Spatrick 
941*202cdb0eSrobert #ifdef _AIX
942*202cdb0eSrobert   virtual uintptr_t getDataRelBase();
943*202cdb0eSrobert #endif
944*202cdb0eSrobert 
945*202cdb0eSrobert #if defined(_LIBUNWIND_USE_CET)
get_registers()946*202cdb0eSrobert   virtual void *get_registers() { return &_registers; }
947*202cdb0eSrobert #endif
948*202cdb0eSrobert 
949f6c50668Spatrick   // libunwind does not and should not depend on C++ library which means that we
950*202cdb0eSrobert   // need our own definition of inline placement new.
operator new(size_t,UnwindCursor<A,R> * p)951f6c50668Spatrick   static void *operator new(size_t, UnwindCursor<A, R> *p) { return p; }
952f6c50668Spatrick 
953f6c50668Spatrick private:
954f6c50668Spatrick 
955f6c50668Spatrick #if defined(_LIBUNWIND_ARM_EHABI)
956f6c50668Spatrick   bool getInfoFromEHABISection(pint_t pc, const UnwindInfoSections &sects);
957f6c50668Spatrick 
stepWithEHABI()958f6c50668Spatrick   int stepWithEHABI() {
959f6c50668Spatrick     size_t len = 0;
960f6c50668Spatrick     size_t off = 0;
961f6c50668Spatrick     // FIXME: Calling decode_eht_entry() here is violating the libunwind
962f6c50668Spatrick     // abstraction layer.
963f6c50668Spatrick     const uint32_t *ehtp =
964f6c50668Spatrick         decode_eht_entry(reinterpret_cast<const uint32_t *>(_info.unwind_info),
965f6c50668Spatrick                          &off, &len);
966f6c50668Spatrick     if (_Unwind_VRS_Interpret((_Unwind_Context *)this, ehtp, off, len) !=
967f6c50668Spatrick             _URC_CONTINUE_UNWIND)
968f6c50668Spatrick       return UNW_STEP_END;
969f6c50668Spatrick     return UNW_STEP_SUCCESS;
970f6c50668Spatrick   }
971f6c50668Spatrick #endif
972f6c50668Spatrick 
973*202cdb0eSrobert #if defined(_LIBUNWIND_CHECK_LINUX_SIGRETURN)
setInfoForSigReturn()974a0747c9fSpatrick   bool setInfoForSigReturn() {
975a0747c9fSpatrick     R dummy;
976a0747c9fSpatrick     return setInfoForSigReturn(dummy);
977a0747c9fSpatrick   }
stepThroughSigReturn()978a0747c9fSpatrick   int stepThroughSigReturn() {
979a0747c9fSpatrick     R dummy;
980a0747c9fSpatrick     return stepThroughSigReturn(dummy);
981a0747c9fSpatrick   }
982*202cdb0eSrobert #if defined(_LIBUNWIND_TARGET_AARCH64)
983a0747c9fSpatrick   bool setInfoForSigReturn(Registers_arm64 &);
984a0747c9fSpatrick   int stepThroughSigReturn(Registers_arm64 &);
985*202cdb0eSrobert #endif
986*202cdb0eSrobert #if defined(_LIBUNWIND_TARGET_S390X)
987*202cdb0eSrobert   bool setInfoForSigReturn(Registers_s390x &);
988*202cdb0eSrobert   int stepThroughSigReturn(Registers_s390x &);
989*202cdb0eSrobert #endif
setInfoForSigReturn(Registers &)990a0747c9fSpatrick   template <typename Registers> bool setInfoForSigReturn(Registers &) {
991a0747c9fSpatrick     return false;
992a0747c9fSpatrick   }
stepThroughSigReturn(Registers &)993a0747c9fSpatrick   template <typename Registers> int stepThroughSigReturn(Registers &) {
994a0747c9fSpatrick     return UNW_STEP_END;
995a0747c9fSpatrick   }
996a0747c9fSpatrick #endif
997a0747c9fSpatrick 
998f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
999a0747c9fSpatrick   bool getInfoFromFdeCie(const typename CFI_Parser<A>::FDE_Info &fdeInfo,
1000a0747c9fSpatrick                          const typename CFI_Parser<A>::CIE_Info &cieInfo,
1001a0747c9fSpatrick                          pint_t pc, uintptr_t dso_base);
1002f6c50668Spatrick   bool getInfoFromDwarfSection(pint_t pc, const UnwindInfoSections &sects,
1003f6c50668Spatrick                                             uint32_t fdeSectionOffsetHint=0);
stepWithDwarfFDE(bool stage2)1004*202cdb0eSrobert   int stepWithDwarfFDE(bool stage2) {
1005*202cdb0eSrobert     return DwarfInstructions<A, R>::stepWithDwarf(
1006*202cdb0eSrobert         _addressSpace, (pint_t)this->getReg(UNW_REG_IP),
1007*202cdb0eSrobert         (pint_t)_info.unwind_info, _registers, _isSignalFrame, stage2);
1008f6c50668Spatrick   }
1009f6c50668Spatrick #endif
1010f6c50668Spatrick 
1011f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
1012f6c50668Spatrick   bool getInfoFromCompactEncodingSection(pint_t pc,
1013f6c50668Spatrick                                             const UnwindInfoSections &sects);
stepWithCompactEncoding(bool stage2=false)1014*202cdb0eSrobert   int stepWithCompactEncoding(bool stage2 = false) {
1015f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
1016f6c50668Spatrick     if ( compactSaysUseDwarf() )
1017*202cdb0eSrobert       return stepWithDwarfFDE(stage2);
1018f6c50668Spatrick #endif
1019f6c50668Spatrick     R dummy;
1020f6c50668Spatrick     return stepWithCompactEncoding(dummy);
1021f6c50668Spatrick   }
1022f6c50668Spatrick 
1023f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_X86_64)
stepWithCompactEncoding(Registers_x86_64 &)1024f6c50668Spatrick   int stepWithCompactEncoding(Registers_x86_64 &) {
1025f6c50668Spatrick     return CompactUnwinder_x86_64<A>::stepWithCompactEncoding(
1026f6c50668Spatrick         _info.format, _info.start_ip, _addressSpace, _registers);
1027f6c50668Spatrick   }
1028f6c50668Spatrick #endif
1029f6c50668Spatrick 
1030f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_I386)
stepWithCompactEncoding(Registers_x86 &)1031f6c50668Spatrick   int stepWithCompactEncoding(Registers_x86 &) {
1032f6c50668Spatrick     return CompactUnwinder_x86<A>::stepWithCompactEncoding(
1033f6c50668Spatrick         _info.format, (uint32_t)_info.start_ip, _addressSpace, _registers);
1034f6c50668Spatrick   }
1035f6c50668Spatrick #endif
1036f6c50668Spatrick 
1037f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_PPC)
stepWithCompactEncoding(Registers_ppc &)1038f6c50668Spatrick   int stepWithCompactEncoding(Registers_ppc &) {
1039f6c50668Spatrick     return UNW_EINVAL;
1040f6c50668Spatrick   }
1041f6c50668Spatrick #endif
1042f6c50668Spatrick 
1043f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_PPC64)
stepWithCompactEncoding(Registers_ppc64 &)1044f6c50668Spatrick   int stepWithCompactEncoding(Registers_ppc64 &) {
1045f6c50668Spatrick     return UNW_EINVAL;
1046f6c50668Spatrick   }
1047f6c50668Spatrick #endif
1048f6c50668Spatrick 
1049f6c50668Spatrick 
1050f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_AARCH64)
stepWithCompactEncoding(Registers_arm64 &)1051f6c50668Spatrick   int stepWithCompactEncoding(Registers_arm64 &) {
1052f6c50668Spatrick     return CompactUnwinder_arm64<A>::stepWithCompactEncoding(
1053f6c50668Spatrick         _info.format, _info.start_ip, _addressSpace, _registers);
1054f6c50668Spatrick   }
1055f6c50668Spatrick #endif
1056f6c50668Spatrick 
1057f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_MIPS_O32)
stepWithCompactEncoding(Registers_mips_o32 &)1058f6c50668Spatrick   int stepWithCompactEncoding(Registers_mips_o32 &) {
1059f6c50668Spatrick     return UNW_EINVAL;
1060f6c50668Spatrick   }
1061f6c50668Spatrick #endif
1062f6c50668Spatrick 
1063f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_MIPS_NEWABI)
stepWithCompactEncoding(Registers_mips_newabi &)1064f6c50668Spatrick   int stepWithCompactEncoding(Registers_mips_newabi &) {
1065f6c50668Spatrick     return UNW_EINVAL;
1066f6c50668Spatrick   }
1067f6c50668Spatrick #endif
1068f6c50668Spatrick 
1069*202cdb0eSrobert #if defined(_LIBUNWIND_TARGET_LOONGARCH)
stepWithCompactEncoding(Registers_loongarch &)1070*202cdb0eSrobert   int stepWithCompactEncoding(Registers_loongarch &) { return UNW_EINVAL; }
1071*202cdb0eSrobert #endif
1072*202cdb0eSrobert 
1073f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_SPARC)
stepWithCompactEncoding(Registers_sparc &)1074f6c50668Spatrick   int stepWithCompactEncoding(Registers_sparc &) { return UNW_EINVAL; }
1075f6c50668Spatrick #endif
1076f6c50668Spatrick 
1077*202cdb0eSrobert #if defined(_LIBUNWIND_TARGET_SPARC64)
stepWithCompactEncoding(Registers_sparc64 &)1078*202cdb0eSrobert   int stepWithCompactEncoding(Registers_sparc64 &) { return UNW_EINVAL; }
1079*202cdb0eSrobert #endif
1080*202cdb0eSrobert 
1081f6c50668Spatrick #if defined (_LIBUNWIND_TARGET_RISCV)
stepWithCompactEncoding(Registers_riscv &)1082f6c50668Spatrick   int stepWithCompactEncoding(Registers_riscv &) {
1083f6c50668Spatrick     return UNW_EINVAL;
1084f6c50668Spatrick   }
1085f6c50668Spatrick #endif
1086f6c50668Spatrick 
compactSaysUseDwarf(uint32_t * offset=NULL) const1087f6c50668Spatrick   bool compactSaysUseDwarf(uint32_t *offset=NULL) const {
1088f6c50668Spatrick     R dummy;
1089f6c50668Spatrick     return compactSaysUseDwarf(dummy, offset);
1090f6c50668Spatrick   }
1091f6c50668Spatrick 
1092f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_X86_64)
compactSaysUseDwarf(Registers_x86_64 &,uint32_t * offset) const1093f6c50668Spatrick   bool compactSaysUseDwarf(Registers_x86_64 &, uint32_t *offset) const {
1094f6c50668Spatrick     if ((_info.format & UNWIND_X86_64_MODE_MASK) == UNWIND_X86_64_MODE_DWARF) {
1095f6c50668Spatrick       if (offset)
1096f6c50668Spatrick         *offset = (_info.format & UNWIND_X86_64_DWARF_SECTION_OFFSET);
1097f6c50668Spatrick       return true;
1098f6c50668Spatrick     }
1099f6c50668Spatrick     return false;
1100f6c50668Spatrick   }
1101f6c50668Spatrick #endif
1102f6c50668Spatrick 
1103f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_I386)
compactSaysUseDwarf(Registers_x86 &,uint32_t * offset) const1104f6c50668Spatrick   bool compactSaysUseDwarf(Registers_x86 &, uint32_t *offset) const {
1105f6c50668Spatrick     if ((_info.format & UNWIND_X86_MODE_MASK) == UNWIND_X86_MODE_DWARF) {
1106f6c50668Spatrick       if (offset)
1107f6c50668Spatrick         *offset = (_info.format & UNWIND_X86_DWARF_SECTION_OFFSET);
1108f6c50668Spatrick       return true;
1109f6c50668Spatrick     }
1110f6c50668Spatrick     return false;
1111f6c50668Spatrick   }
1112f6c50668Spatrick #endif
1113f6c50668Spatrick 
1114f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_PPC)
compactSaysUseDwarf(Registers_ppc &,uint32_t *) const1115f6c50668Spatrick   bool compactSaysUseDwarf(Registers_ppc &, uint32_t *) const {
1116f6c50668Spatrick     return true;
1117f6c50668Spatrick   }
1118f6c50668Spatrick #endif
1119f6c50668Spatrick 
1120f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_PPC64)
compactSaysUseDwarf(Registers_ppc64 &,uint32_t *) const1121f6c50668Spatrick   bool compactSaysUseDwarf(Registers_ppc64 &, uint32_t *) const {
1122f6c50668Spatrick     return true;
1123f6c50668Spatrick   }
1124f6c50668Spatrick #endif
1125f6c50668Spatrick 
1126f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_AARCH64)
compactSaysUseDwarf(Registers_arm64 &,uint32_t * offset) const1127f6c50668Spatrick   bool compactSaysUseDwarf(Registers_arm64 &, uint32_t *offset) const {
1128f6c50668Spatrick     if ((_info.format & UNWIND_ARM64_MODE_MASK) == UNWIND_ARM64_MODE_DWARF) {
1129f6c50668Spatrick       if (offset)
1130f6c50668Spatrick         *offset = (_info.format & UNWIND_ARM64_DWARF_SECTION_OFFSET);
1131f6c50668Spatrick       return true;
1132f6c50668Spatrick     }
1133f6c50668Spatrick     return false;
1134f6c50668Spatrick   }
1135f6c50668Spatrick #endif
1136f6c50668Spatrick 
1137f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_MIPS_O32)
compactSaysUseDwarf(Registers_mips_o32 &,uint32_t *) const1138f6c50668Spatrick   bool compactSaysUseDwarf(Registers_mips_o32 &, uint32_t *) const {
1139f6c50668Spatrick     return true;
1140f6c50668Spatrick   }
1141f6c50668Spatrick #endif
1142f6c50668Spatrick 
1143f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_MIPS_NEWABI)
compactSaysUseDwarf(Registers_mips_newabi &,uint32_t *) const1144f6c50668Spatrick   bool compactSaysUseDwarf(Registers_mips_newabi &, uint32_t *) const {
1145f6c50668Spatrick     return true;
1146f6c50668Spatrick   }
1147f6c50668Spatrick #endif
1148f6c50668Spatrick 
1149*202cdb0eSrobert #if defined(_LIBUNWIND_TARGET_LOONGARCH)
compactSaysUseDwarf(Registers_loongarch &,uint32_t *) const1150*202cdb0eSrobert   bool compactSaysUseDwarf(Registers_loongarch &, uint32_t *) const {
1151*202cdb0eSrobert     return true;
1152*202cdb0eSrobert   }
1153*202cdb0eSrobert #endif
1154*202cdb0eSrobert 
1155f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_SPARC)
compactSaysUseDwarf(Registers_sparc &,uint32_t *) const1156f6c50668Spatrick   bool compactSaysUseDwarf(Registers_sparc &, uint32_t *) const { return true; }
1157f6c50668Spatrick #endif
1158f6c50668Spatrick 
1159*202cdb0eSrobert #if defined(_LIBUNWIND_TARGET_SPARC64)
compactSaysUseDwarf(Registers_sparc64 &,uint32_t *) const1160*202cdb0eSrobert   bool compactSaysUseDwarf(Registers_sparc64 &, uint32_t *) const {
1161*202cdb0eSrobert     return true;
1162*202cdb0eSrobert   }
1163*202cdb0eSrobert #endif
1164*202cdb0eSrobert 
1165f6c50668Spatrick #if defined (_LIBUNWIND_TARGET_RISCV)
compactSaysUseDwarf(Registers_riscv &,uint32_t *) const1166f6c50668Spatrick   bool compactSaysUseDwarf(Registers_riscv &, uint32_t *) const {
1167f6c50668Spatrick     return true;
1168f6c50668Spatrick   }
1169f6c50668Spatrick #endif
1170f6c50668Spatrick 
1171f6c50668Spatrick #endif // defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
1172f6c50668Spatrick 
1173f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
dwarfEncoding() const1174f6c50668Spatrick   compact_unwind_encoding_t dwarfEncoding() const {
1175f6c50668Spatrick     R dummy;
1176f6c50668Spatrick     return dwarfEncoding(dummy);
1177f6c50668Spatrick   }
1178f6c50668Spatrick 
1179f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_X86_64)
dwarfEncoding(Registers_x86_64 &) const1180f6c50668Spatrick   compact_unwind_encoding_t dwarfEncoding(Registers_x86_64 &) const {
1181f6c50668Spatrick     return UNWIND_X86_64_MODE_DWARF;
1182f6c50668Spatrick   }
1183f6c50668Spatrick #endif
1184f6c50668Spatrick 
1185f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_I386)
dwarfEncoding(Registers_x86 &) const1186f6c50668Spatrick   compact_unwind_encoding_t dwarfEncoding(Registers_x86 &) const {
1187f6c50668Spatrick     return UNWIND_X86_MODE_DWARF;
1188f6c50668Spatrick   }
1189f6c50668Spatrick #endif
1190f6c50668Spatrick 
1191f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_PPC)
dwarfEncoding(Registers_ppc &) const1192f6c50668Spatrick   compact_unwind_encoding_t dwarfEncoding(Registers_ppc &) const {
1193f6c50668Spatrick     return 0;
1194f6c50668Spatrick   }
1195f6c50668Spatrick #endif
1196f6c50668Spatrick 
1197f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_PPC64)
dwarfEncoding(Registers_ppc64 &) const1198f6c50668Spatrick   compact_unwind_encoding_t dwarfEncoding(Registers_ppc64 &) const {
1199f6c50668Spatrick     return 0;
1200f6c50668Spatrick   }
1201f6c50668Spatrick #endif
1202f6c50668Spatrick 
1203f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_AARCH64)
dwarfEncoding(Registers_arm64 &) const1204f6c50668Spatrick   compact_unwind_encoding_t dwarfEncoding(Registers_arm64 &) const {
1205f6c50668Spatrick     return UNWIND_ARM64_MODE_DWARF;
1206f6c50668Spatrick   }
1207f6c50668Spatrick #endif
1208f6c50668Spatrick 
1209f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_ARM)
dwarfEncoding(Registers_arm &) const1210f6c50668Spatrick   compact_unwind_encoding_t dwarfEncoding(Registers_arm &) const {
1211f6c50668Spatrick     return 0;
1212f6c50668Spatrick   }
1213f6c50668Spatrick #endif
1214f6c50668Spatrick 
1215f6c50668Spatrick #if defined (_LIBUNWIND_TARGET_OR1K)
dwarfEncoding(Registers_or1k &) const1216f6c50668Spatrick   compact_unwind_encoding_t dwarfEncoding(Registers_or1k &) const {
1217f6c50668Spatrick     return 0;
1218f6c50668Spatrick   }
1219f6c50668Spatrick #endif
1220f6c50668Spatrick 
1221f6c50668Spatrick #if defined (_LIBUNWIND_TARGET_HEXAGON)
dwarfEncoding(Registers_hexagon &) const1222f6c50668Spatrick   compact_unwind_encoding_t dwarfEncoding(Registers_hexagon &) const {
1223f6c50668Spatrick     return 0;
1224f6c50668Spatrick   }
1225f6c50668Spatrick #endif
1226f6c50668Spatrick 
1227f6c50668Spatrick #if defined (_LIBUNWIND_TARGET_MIPS_O32)
dwarfEncoding(Registers_mips_o32 &) const1228f6c50668Spatrick   compact_unwind_encoding_t dwarfEncoding(Registers_mips_o32 &) const {
1229f6c50668Spatrick     return 0;
1230f6c50668Spatrick   }
1231f6c50668Spatrick #endif
1232f6c50668Spatrick 
1233f6c50668Spatrick #if defined (_LIBUNWIND_TARGET_MIPS_NEWABI)
dwarfEncoding(Registers_mips_newabi &) const1234f6c50668Spatrick   compact_unwind_encoding_t dwarfEncoding(Registers_mips_newabi &) const {
1235f6c50668Spatrick     return 0;
1236f6c50668Spatrick   }
1237f6c50668Spatrick #endif
1238f6c50668Spatrick 
1239*202cdb0eSrobert #if defined(_LIBUNWIND_TARGET_LOONGARCH)
dwarfEncoding(Registers_loongarch &) const1240*202cdb0eSrobert   compact_unwind_encoding_t dwarfEncoding(Registers_loongarch &) const {
1241*202cdb0eSrobert     return 0;
1242*202cdb0eSrobert   }
1243*202cdb0eSrobert #endif
1244*202cdb0eSrobert 
1245f6c50668Spatrick #if defined(_LIBUNWIND_TARGET_SPARC)
dwarfEncoding(Registers_sparc &) const1246f6c50668Spatrick   compact_unwind_encoding_t dwarfEncoding(Registers_sparc &) const { return 0; }
1247f6c50668Spatrick #endif
1248f6c50668Spatrick 
1249974930e3Spatrick #if defined(_LIBUNWIND_TARGET_SPARC64)
dwarfEncoding(Registers_sparc64 &) const1250974930e3Spatrick   compact_unwind_encoding_t dwarfEncoding(Registers_sparc64 &) const {
1251974930e3Spatrick     return 0;
1252974930e3Spatrick   }
1253974930e3Spatrick #endif
1254974930e3Spatrick 
1255f6c50668Spatrick #if defined (_LIBUNWIND_TARGET_RISCV)
dwarfEncoding(Registers_riscv &) const1256f6c50668Spatrick   compact_unwind_encoding_t dwarfEncoding(Registers_riscv &) const {
1257f6c50668Spatrick     return 0;
1258f6c50668Spatrick   }
1259f6c50668Spatrick #endif
1260f6c50668Spatrick 
1261*202cdb0eSrobert #if defined (_LIBUNWIND_TARGET_S390X)
dwarfEncoding(Registers_s390x &) const1262*202cdb0eSrobert   compact_unwind_encoding_t dwarfEncoding(Registers_s390x &) const {
1263*202cdb0eSrobert     return 0;
1264*202cdb0eSrobert   }
1265*202cdb0eSrobert #endif
1266*202cdb0eSrobert 
1267f6c50668Spatrick #endif // defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
1268f6c50668Spatrick 
1269f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_SEH_UNWIND)
1270f6c50668Spatrick   // For runtime environments using SEH unwind data without Windows runtime
1271f6c50668Spatrick   // support.
getLastPC() const1272f6c50668Spatrick   pint_t getLastPC() const { /* FIXME: Implement */ return 0; }
setLastPC(pint_t pc)1273f6c50668Spatrick   void setLastPC(pint_t pc) { /* FIXME: Implement */ }
lookUpSEHUnwindInfo(pint_t pc,pint_t * base)1274f6c50668Spatrick   RUNTIME_FUNCTION *lookUpSEHUnwindInfo(pint_t pc, pint_t *base) {
1275f6c50668Spatrick     /* FIXME: Implement */
1276f6c50668Spatrick     *base = 0;
1277f6c50668Spatrick     return nullptr;
1278f6c50668Spatrick   }
1279f6c50668Spatrick   bool getInfoFromSEH(pint_t pc);
stepWithSEHData()1280f6c50668Spatrick   int stepWithSEHData() { /* FIXME: Implement */ return 0; }
1281f6c50668Spatrick #endif // defined(_LIBUNWIND_SUPPORT_SEH_UNWIND)
1282f6c50668Spatrick 
1283*202cdb0eSrobert #if defined(_LIBUNWIND_SUPPORT_TBTAB_UNWIND)
1284*202cdb0eSrobert   bool getInfoFromTBTable(pint_t pc, R &registers);
1285*202cdb0eSrobert   int stepWithTBTable(pint_t pc, tbtable *TBTable, R &registers,
1286*202cdb0eSrobert                       bool &isSignalFrame);
stepWithTBTableData()1287*202cdb0eSrobert   int stepWithTBTableData() {
1288*202cdb0eSrobert     return stepWithTBTable(reinterpret_cast<pint_t>(this->getReg(UNW_REG_IP)),
1289*202cdb0eSrobert                            reinterpret_cast<tbtable *>(_info.unwind_info),
1290*202cdb0eSrobert                            _registers, _isSignalFrame);
1291*202cdb0eSrobert   }
1292*202cdb0eSrobert #endif // defined(_LIBUNWIND_SUPPORT_TBTAB_UNWIND)
1293f6c50668Spatrick 
1294f6c50668Spatrick   A               &_addressSpace;
1295f6c50668Spatrick   R                _registers;
1296f6c50668Spatrick   unw_proc_info_t  _info;
1297f6c50668Spatrick   bool             _unwindInfoMissing;
1298f6c50668Spatrick   bool             _isSignalFrame;
1299*202cdb0eSrobert #if defined(_LIBUNWIND_CHECK_LINUX_SIGRETURN)
1300a0747c9fSpatrick   bool             _isSigReturn = false;
1301a0747c9fSpatrick #endif
1302f6c50668Spatrick };
1303f6c50668Spatrick 
1304f6c50668Spatrick 
1305f6c50668Spatrick template <typename A, typename R>
UnwindCursor(unw_context_t * context,A & as)1306f6c50668Spatrick UnwindCursor<A, R>::UnwindCursor(unw_context_t *context, A &as)
1307f6c50668Spatrick     : _addressSpace(as), _registers(context), _unwindInfoMissing(false),
1308f6c50668Spatrick       _isSignalFrame(false) {
1309f6c50668Spatrick   static_assert((check_fit<UnwindCursor<A, R>, unw_cursor_t>::does_fit),
1310f6c50668Spatrick                 "UnwindCursor<> does not fit in unw_cursor_t");
1311a0747c9fSpatrick   static_assert((alignof(UnwindCursor<A, R>) <= alignof(unw_cursor_t)),
1312a0747c9fSpatrick                 "UnwindCursor<> requires more alignment than unw_cursor_t");
1313f6c50668Spatrick   memset(&_info, 0, sizeof(_info));
1314f6c50668Spatrick }
1315f6c50668Spatrick 
1316f6c50668Spatrick template <typename A, typename R>
UnwindCursor(A & as,void *)1317f6c50668Spatrick UnwindCursor<A, R>::UnwindCursor(A &as, void *)
1318f6c50668Spatrick     : _addressSpace(as), _unwindInfoMissing(false), _isSignalFrame(false) {
1319f6c50668Spatrick   memset(&_info, 0, sizeof(_info));
1320f6c50668Spatrick   // FIXME
1321f6c50668Spatrick   // fill in _registers from thread arg
1322f6c50668Spatrick }
1323f6c50668Spatrick 
1324f6c50668Spatrick 
1325f6c50668Spatrick template <typename A, typename R>
validReg(int regNum)1326f6c50668Spatrick bool UnwindCursor<A, R>::validReg(int regNum) {
1327f6c50668Spatrick   return _registers.validRegister(regNum);
1328f6c50668Spatrick }
1329f6c50668Spatrick 
1330f6c50668Spatrick template <typename A, typename R>
getReg(int regNum)1331f6c50668Spatrick unw_word_t UnwindCursor<A, R>::getReg(int regNum) {
1332f6c50668Spatrick   return _registers.getRegister(regNum);
1333f6c50668Spatrick }
1334f6c50668Spatrick 
1335f6c50668Spatrick template <typename A, typename R>
setReg(int regNum,unw_word_t value)1336f6c50668Spatrick void UnwindCursor<A, R>::setReg(int regNum, unw_word_t value) {
1337f6c50668Spatrick   _registers.setRegister(regNum, (typename A::pint_t)value);
1338f6c50668Spatrick }
1339f6c50668Spatrick 
1340f6c50668Spatrick template <typename A, typename R>
validFloatReg(int regNum)1341f6c50668Spatrick bool UnwindCursor<A, R>::validFloatReg(int regNum) {
1342f6c50668Spatrick   return _registers.validFloatRegister(regNum);
1343f6c50668Spatrick }
1344f6c50668Spatrick 
1345f6c50668Spatrick template <typename A, typename R>
getFloatReg(int regNum)1346f6c50668Spatrick unw_fpreg_t UnwindCursor<A, R>::getFloatReg(int regNum) {
1347f6c50668Spatrick   return _registers.getFloatRegister(regNum);
1348f6c50668Spatrick }
1349f6c50668Spatrick 
1350f6c50668Spatrick template <typename A, typename R>
setFloatReg(int regNum,unw_fpreg_t value)1351f6c50668Spatrick void UnwindCursor<A, R>::setFloatReg(int regNum, unw_fpreg_t value) {
1352f6c50668Spatrick   _registers.setFloatRegister(regNum, value);
1353f6c50668Spatrick }
1354f6c50668Spatrick 
jumpto()1355f6c50668Spatrick template <typename A, typename R> void UnwindCursor<A, R>::jumpto() {
1356f6c50668Spatrick   _registers.jumpto();
1357f6c50668Spatrick }
1358f6c50668Spatrick 
1359f6c50668Spatrick #ifdef __arm__
saveVFPAsX()1360f6c50668Spatrick template <typename A, typename R> void UnwindCursor<A, R>::saveVFPAsX() {
1361f6c50668Spatrick   _registers.saveVFPAsX();
1362f6c50668Spatrick }
1363f6c50668Spatrick #endif
1364f6c50668Spatrick 
1365*202cdb0eSrobert #ifdef _AIX
1366*202cdb0eSrobert template <typename A, typename R>
getDataRelBase()1367*202cdb0eSrobert uintptr_t UnwindCursor<A, R>::getDataRelBase() {
1368*202cdb0eSrobert   return reinterpret_cast<uintptr_t>(_info.extra);
1369*202cdb0eSrobert }
1370*202cdb0eSrobert #endif
1371*202cdb0eSrobert 
1372f6c50668Spatrick template <typename A, typename R>
getRegisterName(int regNum)1373f6c50668Spatrick const char *UnwindCursor<A, R>::getRegisterName(int regNum) {
1374f6c50668Spatrick   return _registers.getRegisterName(regNum);
1375f6c50668Spatrick }
1376f6c50668Spatrick 
isSignalFrame()1377f6c50668Spatrick template <typename A, typename R> bool UnwindCursor<A, R>::isSignalFrame() {
1378f6c50668Spatrick   return _isSignalFrame;
1379f6c50668Spatrick }
1380f6c50668Spatrick 
1381f6c50668Spatrick #endif // defined(_LIBUNWIND_SUPPORT_SEH_UNWIND)
1382f6c50668Spatrick 
1383f6c50668Spatrick #if defined(_LIBUNWIND_ARM_EHABI)
1384f6c50668Spatrick template<typename A>
1385f6c50668Spatrick struct EHABISectionIterator {
1386f6c50668Spatrick   typedef EHABISectionIterator _Self;
1387f6c50668Spatrick 
1388f6c50668Spatrick   typedef typename A::pint_t value_type;
1389f6c50668Spatrick   typedef typename A::pint_t* pointer;
1390f6c50668Spatrick   typedef typename A::pint_t& reference;
1391f6c50668Spatrick   typedef size_t size_type;
1392f6c50668Spatrick   typedef size_t difference_type;
1393f6c50668Spatrick 
beginlibunwind::EHABISectionIterator1394f6c50668Spatrick   static _Self begin(A& addressSpace, const UnwindInfoSections& sects) {
1395f6c50668Spatrick     return _Self(addressSpace, sects, 0);
1396f6c50668Spatrick   }
endlibunwind::EHABISectionIterator1397f6c50668Spatrick   static _Self end(A& addressSpace, const UnwindInfoSections& sects) {
1398f6c50668Spatrick     return _Self(addressSpace, sects,
1399f6c50668Spatrick                  sects.arm_section_length / sizeof(EHABIIndexEntry));
1400f6c50668Spatrick   }
1401f6c50668Spatrick 
EHABISectionIteratorlibunwind::EHABISectionIterator1402f6c50668Spatrick   EHABISectionIterator(A& addressSpace, const UnwindInfoSections& sects, size_t i)
1403f6c50668Spatrick       : _i(i), _addressSpace(&addressSpace), _sects(&sects) {}
1404f6c50668Spatrick 
operator ++libunwind::EHABISectionIterator1405f6c50668Spatrick   _Self& operator++() { ++_i; return *this; }
operator +=libunwind::EHABISectionIterator1406f6c50668Spatrick   _Self& operator+=(size_t a) { _i += a; return *this; }
operator --libunwind::EHABISectionIterator1407f6c50668Spatrick   _Self& operator--() { assert(_i > 0); --_i; return *this; }
operator -=libunwind::EHABISectionIterator1408f6c50668Spatrick   _Self& operator-=(size_t a) { assert(_i >= a); _i -= a; return *this; }
1409f6c50668Spatrick 
operator +libunwind::EHABISectionIterator1410f6c50668Spatrick   _Self operator+(size_t a) { _Self out = *this; out._i += a; return out; }
operator -libunwind::EHABISectionIterator1411f6c50668Spatrick   _Self operator-(size_t a) { assert(_i >= a); _Self out = *this; out._i -= a; return out; }
1412f6c50668Spatrick 
operator -libunwind::EHABISectionIterator1413f6c50668Spatrick   size_t operator-(const _Self& other) const { return _i - other._i; }
1414f6c50668Spatrick 
operator ==libunwind::EHABISectionIterator1415f6c50668Spatrick   bool operator==(const _Self& other) const {
1416f6c50668Spatrick     assert(_addressSpace == other._addressSpace);
1417f6c50668Spatrick     assert(_sects == other._sects);
1418f6c50668Spatrick     return _i == other._i;
1419f6c50668Spatrick   }
1420f6c50668Spatrick 
operator !=libunwind::EHABISectionIterator1421f6c50668Spatrick   bool operator!=(const _Self& other) const {
1422f6c50668Spatrick     assert(_addressSpace == other._addressSpace);
1423f6c50668Spatrick     assert(_sects == other._sects);
1424f6c50668Spatrick     return _i != other._i;
1425f6c50668Spatrick   }
1426f6c50668Spatrick 
operator *libunwind::EHABISectionIterator1427f6c50668Spatrick   typename A::pint_t operator*() const { return functionAddress(); }
1428f6c50668Spatrick 
functionAddresslibunwind::EHABISectionIterator1429f6c50668Spatrick   typename A::pint_t functionAddress() const {
1430f6c50668Spatrick     typename A::pint_t indexAddr = _sects->arm_section + arrayoffsetof(
1431f6c50668Spatrick         EHABIIndexEntry, _i, functionOffset);
1432f6c50668Spatrick     return indexAddr + signExtendPrel31(_addressSpace->get32(indexAddr));
1433f6c50668Spatrick   }
1434f6c50668Spatrick 
dataAddresslibunwind::EHABISectionIterator1435f6c50668Spatrick   typename A::pint_t dataAddress() {
1436f6c50668Spatrick     typename A::pint_t indexAddr = _sects->arm_section + arrayoffsetof(
1437f6c50668Spatrick         EHABIIndexEntry, _i, data);
1438f6c50668Spatrick     return indexAddr;
1439f6c50668Spatrick   }
1440f6c50668Spatrick 
1441f6c50668Spatrick  private:
1442f6c50668Spatrick   size_t _i;
1443f6c50668Spatrick   A* _addressSpace;
1444f6c50668Spatrick   const UnwindInfoSections* _sects;
1445f6c50668Spatrick };
1446f6c50668Spatrick 
1447f6c50668Spatrick namespace {
1448f6c50668Spatrick 
1449f6c50668Spatrick template <typename A>
EHABISectionUpperBound(EHABISectionIterator<A> first,EHABISectionIterator<A> last,typename A::pint_t value)1450f6c50668Spatrick EHABISectionIterator<A> EHABISectionUpperBound(
1451f6c50668Spatrick     EHABISectionIterator<A> first,
1452f6c50668Spatrick     EHABISectionIterator<A> last,
1453f6c50668Spatrick     typename A::pint_t value) {
1454f6c50668Spatrick   size_t len = last - first;
1455f6c50668Spatrick   while (len > 0) {
1456f6c50668Spatrick     size_t l2 = len / 2;
1457f6c50668Spatrick     EHABISectionIterator<A> m = first + l2;
1458f6c50668Spatrick     if (value < *m) {
1459f6c50668Spatrick         len = l2;
1460f6c50668Spatrick     } else {
1461f6c50668Spatrick         first = ++m;
1462f6c50668Spatrick         len -= l2 + 1;
1463f6c50668Spatrick     }
1464f6c50668Spatrick   }
1465f6c50668Spatrick   return first;
1466f6c50668Spatrick }
1467f6c50668Spatrick 
1468f6c50668Spatrick }
1469f6c50668Spatrick 
1470f6c50668Spatrick template <typename A, typename R>
getInfoFromEHABISection(pint_t pc,const UnwindInfoSections & sects)1471f6c50668Spatrick bool UnwindCursor<A, R>::getInfoFromEHABISection(
1472f6c50668Spatrick     pint_t pc,
1473f6c50668Spatrick     const UnwindInfoSections &sects) {
1474f6c50668Spatrick   EHABISectionIterator<A> begin =
1475f6c50668Spatrick       EHABISectionIterator<A>::begin(_addressSpace, sects);
1476f6c50668Spatrick   EHABISectionIterator<A> end =
1477f6c50668Spatrick       EHABISectionIterator<A>::end(_addressSpace, sects);
1478f6c50668Spatrick   if (begin == end)
1479f6c50668Spatrick     return false;
1480f6c50668Spatrick 
1481f6c50668Spatrick   EHABISectionIterator<A> itNextPC = EHABISectionUpperBound(begin, end, pc);
1482f6c50668Spatrick   if (itNextPC == begin)
1483f6c50668Spatrick     return false;
1484f6c50668Spatrick   EHABISectionIterator<A> itThisPC = itNextPC - 1;
1485f6c50668Spatrick 
1486f6c50668Spatrick   pint_t thisPC = itThisPC.functionAddress();
1487f6c50668Spatrick   // If an exception is thrown from a function, corresponding to the last entry
1488f6c50668Spatrick   // in the table, we don't really know the function extent and have to choose a
1489f6c50668Spatrick   // value for nextPC. Choosing max() will allow the range check during trace to
1490f6c50668Spatrick   // succeed.
1491f6c50668Spatrick   pint_t nextPC = (itNextPC == end) ? UINTPTR_MAX : itNextPC.functionAddress();
1492f6c50668Spatrick   pint_t indexDataAddr = itThisPC.dataAddress();
1493f6c50668Spatrick 
1494f6c50668Spatrick   if (indexDataAddr == 0)
1495f6c50668Spatrick     return false;
1496f6c50668Spatrick 
1497f6c50668Spatrick   uint32_t indexData = _addressSpace.get32(indexDataAddr);
1498f6c50668Spatrick   if (indexData == UNW_EXIDX_CANTUNWIND)
1499f6c50668Spatrick     return false;
1500f6c50668Spatrick 
1501f6c50668Spatrick   // If the high bit is set, the exception handling table entry is inline inside
1502f6c50668Spatrick   // the index table entry on the second word (aka |indexDataAddr|). Otherwise,
1503f6c50668Spatrick   // the table points at an offset in the exception handling table (section 5
1504f6c50668Spatrick   // EHABI).
1505f6c50668Spatrick   pint_t exceptionTableAddr;
1506f6c50668Spatrick   uint32_t exceptionTableData;
1507f6c50668Spatrick   bool isSingleWordEHT;
1508f6c50668Spatrick   if (indexData & 0x80000000) {
1509f6c50668Spatrick     exceptionTableAddr = indexDataAddr;
1510f6c50668Spatrick     // TODO(ajwong): Should this data be 0?
1511f6c50668Spatrick     exceptionTableData = indexData;
1512f6c50668Spatrick     isSingleWordEHT = true;
1513f6c50668Spatrick   } else {
1514f6c50668Spatrick     exceptionTableAddr = indexDataAddr + signExtendPrel31(indexData);
1515f6c50668Spatrick     exceptionTableData = _addressSpace.get32(exceptionTableAddr);
1516f6c50668Spatrick     isSingleWordEHT = false;
1517f6c50668Spatrick   }
1518f6c50668Spatrick 
1519f6c50668Spatrick   // Now we know the 3 things:
1520f6c50668Spatrick   //   exceptionTableAddr -- exception handler table entry.
1521f6c50668Spatrick   //   exceptionTableData -- the data inside the first word of the eht entry.
1522f6c50668Spatrick   //   isSingleWordEHT -- whether the entry is in the index.
1523f6c50668Spatrick   unw_word_t personalityRoutine = 0xbadf00d;
1524f6c50668Spatrick   bool scope32 = false;
1525f6c50668Spatrick   uintptr_t lsda;
1526f6c50668Spatrick 
1527f6c50668Spatrick   // If the high bit in the exception handling table entry is set, the entry is
1528f6c50668Spatrick   // in compact form (section 6.3 EHABI).
1529f6c50668Spatrick   if (exceptionTableData & 0x80000000) {
1530f6c50668Spatrick     // Grab the index of the personality routine from the compact form.
1531f6c50668Spatrick     uint32_t choice = (exceptionTableData & 0x0f000000) >> 24;
1532f6c50668Spatrick     uint32_t extraWords = 0;
1533f6c50668Spatrick     switch (choice) {
1534f6c50668Spatrick       case 0:
1535f6c50668Spatrick         personalityRoutine = (unw_word_t) &__aeabi_unwind_cpp_pr0;
1536f6c50668Spatrick         extraWords = 0;
1537f6c50668Spatrick         scope32 = false;
1538f6c50668Spatrick         lsda = isSingleWordEHT ? 0 : (exceptionTableAddr + 4);
1539f6c50668Spatrick         break;
1540f6c50668Spatrick       case 1:
1541f6c50668Spatrick         personalityRoutine = (unw_word_t) &__aeabi_unwind_cpp_pr1;
1542f6c50668Spatrick         extraWords = (exceptionTableData & 0x00ff0000) >> 16;
1543f6c50668Spatrick         scope32 = false;
1544f6c50668Spatrick         lsda = exceptionTableAddr + (extraWords + 1) * 4;
1545f6c50668Spatrick         break;
1546f6c50668Spatrick       case 2:
1547f6c50668Spatrick         personalityRoutine = (unw_word_t) &__aeabi_unwind_cpp_pr2;
1548f6c50668Spatrick         extraWords = (exceptionTableData & 0x00ff0000) >> 16;
1549f6c50668Spatrick         scope32 = true;
1550f6c50668Spatrick         lsda = exceptionTableAddr + (extraWords + 1) * 4;
1551f6c50668Spatrick         break;
1552f6c50668Spatrick       default:
1553f6c50668Spatrick         _LIBUNWIND_ABORT("unknown personality routine");
1554f6c50668Spatrick         return false;
1555f6c50668Spatrick     }
1556f6c50668Spatrick 
1557f6c50668Spatrick     if (isSingleWordEHT) {
1558f6c50668Spatrick       if (extraWords != 0) {
1559f6c50668Spatrick         _LIBUNWIND_ABORT("index inlined table detected but pr function "
1560f6c50668Spatrick                          "requires extra words");
1561f6c50668Spatrick         return false;
1562f6c50668Spatrick       }
1563f6c50668Spatrick     }
1564f6c50668Spatrick   } else {
1565f6c50668Spatrick     pint_t personalityAddr =
1566f6c50668Spatrick         exceptionTableAddr + signExtendPrel31(exceptionTableData);
1567f6c50668Spatrick     personalityRoutine = personalityAddr;
1568f6c50668Spatrick 
1569f6c50668Spatrick     // ARM EHABI # 6.2, # 9.2
1570f6c50668Spatrick     //
1571f6c50668Spatrick     //  +---- ehtp
1572f6c50668Spatrick     //  v
1573f6c50668Spatrick     // +--------------------------------------+
1574f6c50668Spatrick     // | +--------+--------+--------+-------+ |
1575f6c50668Spatrick     // | |0| prel31 to personalityRoutine   | |
1576f6c50668Spatrick     // | +--------+--------+--------+-------+ |
1577f6c50668Spatrick     // | |      N |      unwind opcodes     | |  <-- UnwindData
1578f6c50668Spatrick     // | +--------+--------+--------+-------+ |
1579f6c50668Spatrick     // | | Word 2        unwind opcodes     | |
1580f6c50668Spatrick     // | +--------+--------+--------+-------+ |
1581f6c50668Spatrick     // | ...                                  |
1582f6c50668Spatrick     // | +--------+--------+--------+-------+ |
1583f6c50668Spatrick     // | | Word N        unwind opcodes     | |
1584f6c50668Spatrick     // | +--------+--------+--------+-------+ |
1585f6c50668Spatrick     // | | LSDA                             | |  <-- lsda
1586f6c50668Spatrick     // | | ...                              | |
1587f6c50668Spatrick     // | +--------+--------+--------+-------+ |
1588f6c50668Spatrick     // +--------------------------------------+
1589f6c50668Spatrick 
1590f6c50668Spatrick     uint32_t *UnwindData = reinterpret_cast<uint32_t*>(exceptionTableAddr) + 1;
1591f6c50668Spatrick     uint32_t FirstDataWord = *UnwindData;
1592f6c50668Spatrick     size_t N = ((FirstDataWord >> 24) & 0xff);
1593f6c50668Spatrick     size_t NDataWords = N + 1;
1594f6c50668Spatrick     lsda = reinterpret_cast<uintptr_t>(UnwindData + NDataWords);
1595f6c50668Spatrick   }
1596f6c50668Spatrick 
1597f6c50668Spatrick   _info.start_ip = thisPC;
1598f6c50668Spatrick   _info.end_ip = nextPC;
1599f6c50668Spatrick   _info.handler = personalityRoutine;
1600f6c50668Spatrick   _info.unwind_info = exceptionTableAddr;
1601f6c50668Spatrick   _info.lsda = lsda;
1602f6c50668Spatrick   // flags is pr_cache.additional. See EHABI #7.2 for definition of bit 0.
1603f6c50668Spatrick   _info.flags = (isSingleWordEHT ? 1 : 0) | (scope32 ? 0x2 : 0);  // Use enum?
1604f6c50668Spatrick 
1605f6c50668Spatrick   return true;
1606f6c50668Spatrick }
1607f6c50668Spatrick #endif
1608f6c50668Spatrick 
1609f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
1610f6c50668Spatrick template <typename A, typename R>
getInfoFromFdeCie(const typename CFI_Parser<A>::FDE_Info & fdeInfo,const typename CFI_Parser<A>::CIE_Info & cieInfo,pint_t pc,uintptr_t dso_base)1611a0747c9fSpatrick bool UnwindCursor<A, R>::getInfoFromFdeCie(
1612a0747c9fSpatrick     const typename CFI_Parser<A>::FDE_Info &fdeInfo,
1613a0747c9fSpatrick     const typename CFI_Parser<A>::CIE_Info &cieInfo, pint_t pc,
1614a0747c9fSpatrick     uintptr_t dso_base) {
1615a0747c9fSpatrick   typename CFI_Parser<A>::PrologInfo prolog;
1616a0747c9fSpatrick   if (CFI_Parser<A>::parseFDEInstructions(_addressSpace, fdeInfo, cieInfo, pc,
1617a0747c9fSpatrick                                           R::getArch(), &prolog)) {
1618a0747c9fSpatrick     // Save off parsed FDE info
1619a0747c9fSpatrick     _info.start_ip          = fdeInfo.pcStart;
1620a0747c9fSpatrick     _info.end_ip            = fdeInfo.pcEnd;
1621a0747c9fSpatrick     _info.lsda              = fdeInfo.lsda;
1622a0747c9fSpatrick     _info.handler           = cieInfo.personality;
1623a0747c9fSpatrick     // Some frameless functions need SP altered when resuming in function, so
1624a0747c9fSpatrick     // propagate spExtraArgSize.
1625a0747c9fSpatrick     _info.gp                = prolog.spExtraArgSize;
1626a0747c9fSpatrick     _info.flags             = 0;
1627a0747c9fSpatrick     _info.format            = dwarfEncoding();
1628a0747c9fSpatrick     _info.unwind_info       = fdeInfo.fdeStart;
1629a0747c9fSpatrick     _info.unwind_info_size  = static_cast<uint32_t>(fdeInfo.fdeLength);
1630a0747c9fSpatrick     _info.extra             = static_cast<unw_word_t>(dso_base);
1631a0747c9fSpatrick     return true;
1632a0747c9fSpatrick   }
1633a0747c9fSpatrick   return false;
1634a0747c9fSpatrick }
1635a0747c9fSpatrick 
1636a0747c9fSpatrick template <typename A, typename R>
getInfoFromDwarfSection(pint_t pc,const UnwindInfoSections & sects,uint32_t fdeSectionOffsetHint)1637f6c50668Spatrick bool UnwindCursor<A, R>::getInfoFromDwarfSection(pint_t pc,
1638f6c50668Spatrick                                                 const UnwindInfoSections &sects,
1639f6c50668Spatrick                                                 uint32_t fdeSectionOffsetHint) {
1640f6c50668Spatrick   typename CFI_Parser<A>::FDE_Info fdeInfo;
1641f6c50668Spatrick   typename CFI_Parser<A>::CIE_Info cieInfo;
1642f6c50668Spatrick   bool foundFDE = false;
1643f6c50668Spatrick   bool foundInCache = false;
1644f6c50668Spatrick   // If compact encoding table gave offset into dwarf section, go directly there
1645f6c50668Spatrick   if (fdeSectionOffsetHint != 0) {
1646f6c50668Spatrick     foundFDE = CFI_Parser<A>::findFDE(_addressSpace, pc, sects.dwarf_section,
1647a0747c9fSpatrick                                     sects.dwarf_section_length,
1648f6c50668Spatrick                                     sects.dwarf_section + fdeSectionOffsetHint,
1649f6c50668Spatrick                                     &fdeInfo, &cieInfo);
1650f6c50668Spatrick   }
1651f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_DWARF_INDEX)
1652f6c50668Spatrick   if (!foundFDE && (sects.dwarf_index_section != 0)) {
1653f6c50668Spatrick     foundFDE = EHHeaderParser<A>::findFDE(
1654f6c50668Spatrick         _addressSpace, pc, sects.dwarf_index_section,
1655f6c50668Spatrick         (uint32_t)sects.dwarf_index_section_length, &fdeInfo, &cieInfo);
1656f6c50668Spatrick   }
1657f6c50668Spatrick #endif
1658f6c50668Spatrick   if (!foundFDE) {
1659f6c50668Spatrick     // otherwise, search cache of previously found FDEs.
1660f6c50668Spatrick     pint_t cachedFDE = DwarfFDECache<A>::findFDE(sects.dso_base, pc);
1661f6c50668Spatrick     if (cachedFDE != 0) {
1662f6c50668Spatrick       foundFDE =
1663f6c50668Spatrick           CFI_Parser<A>::findFDE(_addressSpace, pc, sects.dwarf_section,
1664a0747c9fSpatrick                                  sects.dwarf_section_length,
1665f6c50668Spatrick                                  cachedFDE, &fdeInfo, &cieInfo);
1666f6c50668Spatrick       foundInCache = foundFDE;
1667f6c50668Spatrick     }
1668f6c50668Spatrick   }
1669f6c50668Spatrick   if (!foundFDE) {
1670f6c50668Spatrick     // Still not found, do full scan of __eh_frame section.
1671f6c50668Spatrick     foundFDE = CFI_Parser<A>::findFDE(_addressSpace, pc, sects.dwarf_section,
1672a0747c9fSpatrick                                       sects.dwarf_section_length, 0,
1673f6c50668Spatrick                                       &fdeInfo, &cieInfo);
1674f6c50668Spatrick   }
1675f6c50668Spatrick   if (foundFDE) {
1676a0747c9fSpatrick     if (getInfoFromFdeCie(fdeInfo, cieInfo, pc, sects.dso_base)) {
1677f6c50668Spatrick       // Add to cache (to make next lookup faster) if we had no hint
1678f6c50668Spatrick       // and there was no index.
1679f6c50668Spatrick       if (!foundInCache && (fdeSectionOffsetHint == 0)) {
1680f6c50668Spatrick   #if defined(_LIBUNWIND_SUPPORT_DWARF_INDEX)
1681f6c50668Spatrick         if (sects.dwarf_index_section == 0)
1682f6c50668Spatrick   #endif
1683f6c50668Spatrick         DwarfFDECache<A>::add(sects.dso_base, fdeInfo.pcStart, fdeInfo.pcEnd,
1684f6c50668Spatrick                               fdeInfo.fdeStart);
1685f6c50668Spatrick       }
1686f6c50668Spatrick       return true;
1687f6c50668Spatrick     }
1688f6c50668Spatrick   }
1689f6c50668Spatrick   //_LIBUNWIND_DEBUG_LOG("can't find/use FDE for pc=0x%llX", (uint64_t)pc);
1690f6c50668Spatrick   return false;
1691f6c50668Spatrick }
1692f6c50668Spatrick #endif // defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
1693f6c50668Spatrick 
1694f6c50668Spatrick 
1695f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
1696f6c50668Spatrick template <typename A, typename R>
getInfoFromCompactEncodingSection(pint_t pc,const UnwindInfoSections & sects)1697f6c50668Spatrick bool UnwindCursor<A, R>::getInfoFromCompactEncodingSection(pint_t pc,
1698f6c50668Spatrick                                               const UnwindInfoSections &sects) {
1699f6c50668Spatrick   const bool log = false;
1700f6c50668Spatrick   if (log)
1701f6c50668Spatrick     fprintf(stderr, "getInfoFromCompactEncodingSection(pc=0x%llX, mh=0x%llX)\n",
1702f6c50668Spatrick             (uint64_t)pc, (uint64_t)sects.dso_base);
1703f6c50668Spatrick 
1704f6c50668Spatrick   const UnwindSectionHeader<A> sectionHeader(_addressSpace,
1705f6c50668Spatrick                                                 sects.compact_unwind_section);
1706f6c50668Spatrick   if (sectionHeader.version() != UNWIND_SECTION_VERSION)
1707f6c50668Spatrick     return false;
1708f6c50668Spatrick 
1709f6c50668Spatrick   // do a binary search of top level index to find page with unwind info
1710f6c50668Spatrick   pint_t targetFunctionOffset = pc - sects.dso_base;
1711f6c50668Spatrick   const UnwindSectionIndexArray<A> topIndex(_addressSpace,
1712f6c50668Spatrick                                            sects.compact_unwind_section
1713f6c50668Spatrick                                          + sectionHeader.indexSectionOffset());
1714f6c50668Spatrick   uint32_t low = 0;
1715f6c50668Spatrick   uint32_t high = sectionHeader.indexCount();
1716f6c50668Spatrick   uint32_t last = high - 1;
1717f6c50668Spatrick   while (low < high) {
1718f6c50668Spatrick     uint32_t mid = (low + high) / 2;
1719f6c50668Spatrick     //if ( log ) fprintf(stderr, "\tmid=%d, low=%d, high=%d, *mid=0x%08X\n",
1720f6c50668Spatrick     //mid, low, high, topIndex.functionOffset(mid));
1721f6c50668Spatrick     if (topIndex.functionOffset(mid) <= targetFunctionOffset) {
1722f6c50668Spatrick       if ((mid == last) ||
1723f6c50668Spatrick           (topIndex.functionOffset(mid + 1) > targetFunctionOffset)) {
1724f6c50668Spatrick         low = mid;
1725f6c50668Spatrick         break;
1726f6c50668Spatrick       } else {
1727f6c50668Spatrick         low = mid + 1;
1728f6c50668Spatrick       }
1729f6c50668Spatrick     } else {
1730f6c50668Spatrick       high = mid;
1731f6c50668Spatrick     }
1732f6c50668Spatrick   }
1733f6c50668Spatrick   const uint32_t firstLevelFunctionOffset = topIndex.functionOffset(low);
1734f6c50668Spatrick   const uint32_t firstLevelNextPageFunctionOffset =
1735f6c50668Spatrick       topIndex.functionOffset(low + 1);
1736f6c50668Spatrick   const pint_t secondLevelAddr =
1737f6c50668Spatrick       sects.compact_unwind_section + topIndex.secondLevelPagesSectionOffset(low);
1738f6c50668Spatrick   const pint_t lsdaArrayStartAddr =
1739f6c50668Spatrick       sects.compact_unwind_section + topIndex.lsdaIndexArraySectionOffset(low);
1740f6c50668Spatrick   const pint_t lsdaArrayEndAddr =
1741f6c50668Spatrick       sects.compact_unwind_section + topIndex.lsdaIndexArraySectionOffset(low+1);
1742f6c50668Spatrick   if (log)
1743f6c50668Spatrick     fprintf(stderr, "\tfirst level search for result index=%d "
1744f6c50668Spatrick                     "to secondLevelAddr=0x%llX\n",
1745f6c50668Spatrick                     low, (uint64_t) secondLevelAddr);
1746f6c50668Spatrick   // do a binary search of second level page index
1747f6c50668Spatrick   uint32_t encoding = 0;
1748f6c50668Spatrick   pint_t funcStart = 0;
1749f6c50668Spatrick   pint_t funcEnd = 0;
1750f6c50668Spatrick   pint_t lsda = 0;
1751f6c50668Spatrick   pint_t personality = 0;
1752f6c50668Spatrick   uint32_t pageKind = _addressSpace.get32(secondLevelAddr);
1753f6c50668Spatrick   if (pageKind == UNWIND_SECOND_LEVEL_REGULAR) {
1754f6c50668Spatrick     // regular page
1755f6c50668Spatrick     UnwindSectionRegularPageHeader<A> pageHeader(_addressSpace,
1756f6c50668Spatrick                                                  secondLevelAddr);
1757f6c50668Spatrick     UnwindSectionRegularArray<A> pageIndex(
1758f6c50668Spatrick         _addressSpace, secondLevelAddr + pageHeader.entryPageOffset());
1759f6c50668Spatrick     // binary search looks for entry with e where index[e].offset <= pc <
1760f6c50668Spatrick     // index[e+1].offset
1761f6c50668Spatrick     if (log)
1762f6c50668Spatrick       fprintf(stderr, "\tbinary search for targetFunctionOffset=0x%08llX in "
1763f6c50668Spatrick                       "regular page starting at secondLevelAddr=0x%llX\n",
1764f6c50668Spatrick               (uint64_t) targetFunctionOffset, (uint64_t) secondLevelAddr);
1765f6c50668Spatrick     low = 0;
1766f6c50668Spatrick     high = pageHeader.entryCount();
1767f6c50668Spatrick     while (low < high) {
1768f6c50668Spatrick       uint32_t mid = (low + high) / 2;
1769f6c50668Spatrick       if (pageIndex.functionOffset(mid) <= targetFunctionOffset) {
1770f6c50668Spatrick         if (mid == (uint32_t)(pageHeader.entryCount() - 1)) {
1771f6c50668Spatrick           // at end of table
1772f6c50668Spatrick           low = mid;
1773f6c50668Spatrick           funcEnd = firstLevelNextPageFunctionOffset + sects.dso_base;
1774f6c50668Spatrick           break;
1775f6c50668Spatrick         } else if (pageIndex.functionOffset(mid + 1) > targetFunctionOffset) {
1776f6c50668Spatrick           // next is too big, so we found it
1777f6c50668Spatrick           low = mid;
1778f6c50668Spatrick           funcEnd = pageIndex.functionOffset(low + 1) + sects.dso_base;
1779f6c50668Spatrick           break;
1780f6c50668Spatrick         } else {
1781f6c50668Spatrick           low = mid + 1;
1782f6c50668Spatrick         }
1783f6c50668Spatrick       } else {
1784f6c50668Spatrick         high = mid;
1785f6c50668Spatrick       }
1786f6c50668Spatrick     }
1787f6c50668Spatrick     encoding = pageIndex.encoding(low);
1788f6c50668Spatrick     funcStart = pageIndex.functionOffset(low) + sects.dso_base;
1789f6c50668Spatrick     if (pc < funcStart) {
1790f6c50668Spatrick       if (log)
1791f6c50668Spatrick         fprintf(
1792f6c50668Spatrick             stderr,
1793f6c50668Spatrick             "\tpc not in table, pc=0x%llX, funcStart=0x%llX, funcEnd=0x%llX\n",
1794f6c50668Spatrick             (uint64_t) pc, (uint64_t) funcStart, (uint64_t) funcEnd);
1795f6c50668Spatrick       return false;
1796f6c50668Spatrick     }
1797f6c50668Spatrick     if (pc > funcEnd) {
1798f6c50668Spatrick       if (log)
1799f6c50668Spatrick         fprintf(
1800f6c50668Spatrick             stderr,
1801f6c50668Spatrick             "\tpc not in table, pc=0x%llX, funcStart=0x%llX, funcEnd=0x%llX\n",
1802f6c50668Spatrick             (uint64_t) pc, (uint64_t) funcStart, (uint64_t) funcEnd);
1803f6c50668Spatrick       return false;
1804f6c50668Spatrick     }
1805f6c50668Spatrick   } else if (pageKind == UNWIND_SECOND_LEVEL_COMPRESSED) {
1806f6c50668Spatrick     // compressed page
1807f6c50668Spatrick     UnwindSectionCompressedPageHeader<A> pageHeader(_addressSpace,
1808f6c50668Spatrick                                                     secondLevelAddr);
1809f6c50668Spatrick     UnwindSectionCompressedArray<A> pageIndex(
1810f6c50668Spatrick         _addressSpace, secondLevelAddr + pageHeader.entryPageOffset());
1811f6c50668Spatrick     const uint32_t targetFunctionPageOffset =
1812f6c50668Spatrick         (uint32_t)(targetFunctionOffset - firstLevelFunctionOffset);
1813f6c50668Spatrick     // binary search looks for entry with e where index[e].offset <= pc <
1814f6c50668Spatrick     // index[e+1].offset
1815f6c50668Spatrick     if (log)
1816f6c50668Spatrick       fprintf(stderr, "\tbinary search of compressed page starting at "
1817f6c50668Spatrick                       "secondLevelAddr=0x%llX\n",
1818f6c50668Spatrick               (uint64_t) secondLevelAddr);
1819f6c50668Spatrick     low = 0;
1820f6c50668Spatrick     last = pageHeader.entryCount() - 1;
1821f6c50668Spatrick     high = pageHeader.entryCount();
1822f6c50668Spatrick     while (low < high) {
1823f6c50668Spatrick       uint32_t mid = (low + high) / 2;
1824f6c50668Spatrick       if (pageIndex.functionOffset(mid) <= targetFunctionPageOffset) {
1825f6c50668Spatrick         if ((mid == last) ||
1826f6c50668Spatrick             (pageIndex.functionOffset(mid + 1) > targetFunctionPageOffset)) {
1827f6c50668Spatrick           low = mid;
1828f6c50668Spatrick           break;
1829f6c50668Spatrick         } else {
1830f6c50668Spatrick           low = mid + 1;
1831f6c50668Spatrick         }
1832f6c50668Spatrick       } else {
1833f6c50668Spatrick         high = mid;
1834f6c50668Spatrick       }
1835f6c50668Spatrick     }
1836f6c50668Spatrick     funcStart = pageIndex.functionOffset(low) + firstLevelFunctionOffset
1837f6c50668Spatrick                                                               + sects.dso_base;
1838f6c50668Spatrick     if (low < last)
1839f6c50668Spatrick       funcEnd =
1840f6c50668Spatrick           pageIndex.functionOffset(low + 1) + firstLevelFunctionOffset
1841f6c50668Spatrick                                                               + sects.dso_base;
1842f6c50668Spatrick     else
1843f6c50668Spatrick       funcEnd = firstLevelNextPageFunctionOffset + sects.dso_base;
1844f6c50668Spatrick     if (pc < funcStart) {
1845a0747c9fSpatrick       _LIBUNWIND_DEBUG_LOG("malformed __unwind_info, pc=0x%llX "
1846a0747c9fSpatrick                            "not in second level compressed unwind table. "
1847a0747c9fSpatrick                            "funcStart=0x%llX",
1848f6c50668Spatrick                             (uint64_t) pc, (uint64_t) funcStart);
1849f6c50668Spatrick       return false;
1850f6c50668Spatrick     }
1851f6c50668Spatrick     if (pc > funcEnd) {
1852a0747c9fSpatrick       _LIBUNWIND_DEBUG_LOG("malformed __unwind_info, pc=0x%llX "
1853a0747c9fSpatrick                            "not in second level compressed unwind table. "
1854a0747c9fSpatrick                            "funcEnd=0x%llX",
1855f6c50668Spatrick                            (uint64_t) pc, (uint64_t) funcEnd);
1856f6c50668Spatrick       return false;
1857f6c50668Spatrick     }
1858f6c50668Spatrick     uint16_t encodingIndex = pageIndex.encodingIndex(low);
1859f6c50668Spatrick     if (encodingIndex < sectionHeader.commonEncodingsArrayCount()) {
1860f6c50668Spatrick       // encoding is in common table in section header
1861f6c50668Spatrick       encoding = _addressSpace.get32(
1862f6c50668Spatrick           sects.compact_unwind_section +
1863f6c50668Spatrick           sectionHeader.commonEncodingsArraySectionOffset() +
1864f6c50668Spatrick           encodingIndex * sizeof(uint32_t));
1865f6c50668Spatrick     } else {
1866f6c50668Spatrick       // encoding is in page specific table
1867f6c50668Spatrick       uint16_t pageEncodingIndex =
1868f6c50668Spatrick           encodingIndex - (uint16_t)sectionHeader.commonEncodingsArrayCount();
1869f6c50668Spatrick       encoding = _addressSpace.get32(secondLevelAddr +
1870f6c50668Spatrick                                      pageHeader.encodingsPageOffset() +
1871f6c50668Spatrick                                      pageEncodingIndex * sizeof(uint32_t));
1872f6c50668Spatrick     }
1873f6c50668Spatrick   } else {
1874a0747c9fSpatrick     _LIBUNWIND_DEBUG_LOG(
1875a0747c9fSpatrick         "malformed __unwind_info at 0x%0llX bad second level page",
1876f6c50668Spatrick         (uint64_t)sects.compact_unwind_section);
1877f6c50668Spatrick     return false;
1878f6c50668Spatrick   }
1879f6c50668Spatrick 
1880f6c50668Spatrick   // look up LSDA, if encoding says function has one
1881f6c50668Spatrick   if (encoding & UNWIND_HAS_LSDA) {
1882f6c50668Spatrick     UnwindSectionLsdaArray<A> lsdaIndex(_addressSpace, lsdaArrayStartAddr);
1883f6c50668Spatrick     uint32_t funcStartOffset = (uint32_t)(funcStart - sects.dso_base);
1884f6c50668Spatrick     low = 0;
1885f6c50668Spatrick     high = (uint32_t)(lsdaArrayEndAddr - lsdaArrayStartAddr) /
1886f6c50668Spatrick                     sizeof(unwind_info_section_header_lsda_index_entry);
1887f6c50668Spatrick     // binary search looks for entry with exact match for functionOffset
1888f6c50668Spatrick     if (log)
1889f6c50668Spatrick       fprintf(stderr,
1890f6c50668Spatrick               "\tbinary search of lsda table for targetFunctionOffset=0x%08X\n",
1891f6c50668Spatrick               funcStartOffset);
1892f6c50668Spatrick     while (low < high) {
1893f6c50668Spatrick       uint32_t mid = (low + high) / 2;
1894f6c50668Spatrick       if (lsdaIndex.functionOffset(mid) == funcStartOffset) {
1895f6c50668Spatrick         lsda = lsdaIndex.lsdaOffset(mid) + sects.dso_base;
1896f6c50668Spatrick         break;
1897f6c50668Spatrick       } else if (lsdaIndex.functionOffset(mid) < funcStartOffset) {
1898f6c50668Spatrick         low = mid + 1;
1899f6c50668Spatrick       } else {
1900f6c50668Spatrick         high = mid;
1901f6c50668Spatrick       }
1902f6c50668Spatrick     }
1903f6c50668Spatrick     if (lsda == 0) {
1904f6c50668Spatrick       _LIBUNWIND_DEBUG_LOG("found encoding 0x%08X with HAS_LSDA bit set for "
1905f6c50668Spatrick                     "pc=0x%0llX, but lsda table has no entry",
1906f6c50668Spatrick                     encoding, (uint64_t) pc);
1907f6c50668Spatrick       return false;
1908f6c50668Spatrick     }
1909f6c50668Spatrick   }
1910f6c50668Spatrick 
1911a0747c9fSpatrick   // extract personality routine, if encoding says function has one
1912f6c50668Spatrick   uint32_t personalityIndex = (encoding & UNWIND_PERSONALITY_MASK) >>
1913f6c50668Spatrick                               (__builtin_ctz(UNWIND_PERSONALITY_MASK));
1914f6c50668Spatrick   if (personalityIndex != 0) {
1915f6c50668Spatrick     --personalityIndex; // change 1-based to zero-based index
1916a0747c9fSpatrick     if (personalityIndex >= sectionHeader.personalityArrayCount()) {
1917f6c50668Spatrick       _LIBUNWIND_DEBUG_LOG("found encoding 0x%08X with personality index %d,  "
1918f6c50668Spatrick                             "but personality table has only %d entries",
1919f6c50668Spatrick                             encoding, personalityIndex,
1920f6c50668Spatrick                             sectionHeader.personalityArrayCount());
1921f6c50668Spatrick       return false;
1922f6c50668Spatrick     }
1923f6c50668Spatrick     int32_t personalityDelta = (int32_t)_addressSpace.get32(
1924f6c50668Spatrick         sects.compact_unwind_section +
1925f6c50668Spatrick         sectionHeader.personalityArraySectionOffset() +
1926f6c50668Spatrick         personalityIndex * sizeof(uint32_t));
1927f6c50668Spatrick     pint_t personalityPointer = sects.dso_base + (pint_t)personalityDelta;
1928f6c50668Spatrick     personality = _addressSpace.getP(personalityPointer);
1929f6c50668Spatrick     if (log)
1930f6c50668Spatrick       fprintf(stderr, "getInfoFromCompactEncodingSection(pc=0x%llX), "
1931f6c50668Spatrick                       "personalityDelta=0x%08X, personality=0x%08llX\n",
1932f6c50668Spatrick               (uint64_t) pc, personalityDelta, (uint64_t) personality);
1933f6c50668Spatrick   }
1934f6c50668Spatrick 
1935f6c50668Spatrick   if (log)
1936f6c50668Spatrick     fprintf(stderr, "getInfoFromCompactEncodingSection(pc=0x%llX), "
1937f6c50668Spatrick                     "encoding=0x%08X, lsda=0x%08llX for funcStart=0x%llX\n",
1938f6c50668Spatrick             (uint64_t) pc, encoding, (uint64_t) lsda, (uint64_t) funcStart);
1939f6c50668Spatrick   _info.start_ip = funcStart;
1940f6c50668Spatrick   _info.end_ip = funcEnd;
1941f6c50668Spatrick   _info.lsda = lsda;
1942f6c50668Spatrick   _info.handler = personality;
1943f6c50668Spatrick   _info.gp = 0;
1944f6c50668Spatrick   _info.flags = 0;
1945f6c50668Spatrick   _info.format = encoding;
1946f6c50668Spatrick   _info.unwind_info = 0;
1947f6c50668Spatrick   _info.unwind_info_size = 0;
1948f6c50668Spatrick   _info.extra = sects.dso_base;
1949f6c50668Spatrick   return true;
1950f6c50668Spatrick }
1951f6c50668Spatrick #endif // defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
1952f6c50668Spatrick 
1953f6c50668Spatrick 
1954f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_SEH_UNWIND)
1955f6c50668Spatrick template <typename A, typename R>
getInfoFromSEH(pint_t pc)1956f6c50668Spatrick bool UnwindCursor<A, R>::getInfoFromSEH(pint_t pc) {
1957f6c50668Spatrick   pint_t base;
1958f6c50668Spatrick   RUNTIME_FUNCTION *unwindEntry = lookUpSEHUnwindInfo(pc, &base);
1959f6c50668Spatrick   if (!unwindEntry) {
1960f6c50668Spatrick     _LIBUNWIND_DEBUG_LOG("\tpc not in table, pc=0x%llX", (uint64_t) pc);
1961f6c50668Spatrick     return false;
1962f6c50668Spatrick   }
1963f6c50668Spatrick   _info.gp = 0;
1964f6c50668Spatrick   _info.flags = 0;
1965f6c50668Spatrick   _info.format = 0;
1966f6c50668Spatrick   _info.unwind_info_size = sizeof(RUNTIME_FUNCTION);
1967f6c50668Spatrick   _info.unwind_info = reinterpret_cast<unw_word_t>(unwindEntry);
1968f6c50668Spatrick   _info.extra = base;
1969f6c50668Spatrick   _info.start_ip = base + unwindEntry->BeginAddress;
1970f6c50668Spatrick #ifdef _LIBUNWIND_TARGET_X86_64
1971f6c50668Spatrick   _info.end_ip = base + unwindEntry->EndAddress;
1972f6c50668Spatrick   // Only fill in the handler and LSDA if they're stale.
1973f6c50668Spatrick   if (pc != getLastPC()) {
1974f6c50668Spatrick     UNWIND_INFO *xdata = reinterpret_cast<UNWIND_INFO *>(base + unwindEntry->UnwindData);
1975f6c50668Spatrick     if (xdata->Flags & (UNW_FLAG_EHANDLER|UNW_FLAG_UHANDLER)) {
1976f6c50668Spatrick       // The personality is given in the UNWIND_INFO itself. The LSDA immediately
1977f6c50668Spatrick       // follows the UNWIND_INFO. (This follows how both Clang and MSVC emit
1978f6c50668Spatrick       // these structures.)
1979f6c50668Spatrick       // N.B. UNWIND_INFO structs are DWORD-aligned.
1980f6c50668Spatrick       uint32_t lastcode = (xdata->CountOfCodes + 1) & ~1;
1981f6c50668Spatrick       const uint32_t *handler = reinterpret_cast<uint32_t *>(&xdata->UnwindCodes[lastcode]);
1982f6c50668Spatrick       _info.lsda = reinterpret_cast<unw_word_t>(handler+1);
1983f6c50668Spatrick       if (*handler) {
1984f6c50668Spatrick         _info.handler = reinterpret_cast<unw_word_t>(__libunwind_seh_personality);
1985f6c50668Spatrick       } else
1986f6c50668Spatrick         _info.handler = 0;
1987f6c50668Spatrick     } else {
1988f6c50668Spatrick       _info.lsda = 0;
1989f6c50668Spatrick       _info.handler = 0;
1990f6c50668Spatrick     }
1991f6c50668Spatrick   }
1992f6c50668Spatrick #endif
1993f6c50668Spatrick   setLastPC(pc);
1994f6c50668Spatrick   return true;
1995f6c50668Spatrick }
1996f6c50668Spatrick #endif
1997f6c50668Spatrick 
1998*202cdb0eSrobert #if defined(_LIBUNWIND_SUPPORT_TBTAB_UNWIND)
1999*202cdb0eSrobert // Masks for traceback table field xtbtable.
2000*202cdb0eSrobert enum xTBTableMask : uint8_t {
2001*202cdb0eSrobert   reservedBit = 0x02, // The traceback table was incorrectly generated if set
2002*202cdb0eSrobert                       // (see comments in function getInfoFromTBTable().
2003*202cdb0eSrobert   ehInfoBit = 0x08    // Exception handling info is present if set
2004*202cdb0eSrobert };
2005*202cdb0eSrobert 
2006*202cdb0eSrobert enum frameType : unw_word_t {
2007*202cdb0eSrobert   frameWithXLEHStateTable = 0,
2008*202cdb0eSrobert   frameWithEHInfo = 1
2009*202cdb0eSrobert };
2010*202cdb0eSrobert 
2011*202cdb0eSrobert extern "C" {
2012*202cdb0eSrobert typedef _Unwind_Reason_Code __xlcxx_personality_v0_t(int, _Unwind_Action,
2013*202cdb0eSrobert                                                      uint64_t,
2014*202cdb0eSrobert                                                      _Unwind_Exception *,
2015*202cdb0eSrobert                                                      struct _Unwind_Context *);
2016*202cdb0eSrobert __attribute__((__weak__)) __xlcxx_personality_v0_t __xlcxx_personality_v0;
2017*202cdb0eSrobert }
2018*202cdb0eSrobert 
2019*202cdb0eSrobert static __xlcxx_personality_v0_t *xlcPersonalityV0;
2020*202cdb0eSrobert static RWMutex xlcPersonalityV0InitLock;
2021*202cdb0eSrobert 
2022*202cdb0eSrobert template <typename A, typename R>
getInfoFromTBTable(pint_t pc,R & registers)2023*202cdb0eSrobert bool UnwindCursor<A, R>::getInfoFromTBTable(pint_t pc, R &registers) {
2024*202cdb0eSrobert   uint32_t *p = reinterpret_cast<uint32_t *>(pc);
2025*202cdb0eSrobert 
2026*202cdb0eSrobert   // Keep looking forward until a word of 0 is found. The traceback
2027*202cdb0eSrobert   // table starts at the following word.
2028*202cdb0eSrobert   while (*p)
2029*202cdb0eSrobert     ++p;
2030*202cdb0eSrobert   tbtable *TBTable = reinterpret_cast<tbtable *>(p + 1);
2031*202cdb0eSrobert 
2032*202cdb0eSrobert   if (_LIBUNWIND_TRACING_UNWINDING) {
2033*202cdb0eSrobert     char functionBuf[512];
2034*202cdb0eSrobert     const char *functionName = functionBuf;
2035*202cdb0eSrobert     unw_word_t offset;
2036*202cdb0eSrobert     if (!getFunctionName(functionBuf, sizeof(functionBuf), &offset)) {
2037*202cdb0eSrobert       functionName = ".anonymous.";
2038*202cdb0eSrobert     }
2039*202cdb0eSrobert     _LIBUNWIND_TRACE_UNWINDING("%s: Look up traceback table of func=%s at %p",
2040*202cdb0eSrobert                                __func__, functionName,
2041*202cdb0eSrobert                                reinterpret_cast<void *>(TBTable));
2042*202cdb0eSrobert   }
2043*202cdb0eSrobert 
2044*202cdb0eSrobert   // If the traceback table does not contain necessary info, bypass this frame.
2045*202cdb0eSrobert   if (!TBTable->tb.has_tboff)
2046*202cdb0eSrobert     return false;
2047*202cdb0eSrobert 
2048*202cdb0eSrobert   // Structure tbtable_ext contains important data we are looking for.
2049*202cdb0eSrobert   p = reinterpret_cast<uint32_t *>(&TBTable->tb_ext);
2050*202cdb0eSrobert 
2051*202cdb0eSrobert   // Skip field parminfo if it exists.
2052*202cdb0eSrobert   if (TBTable->tb.fixedparms || TBTable->tb.floatparms)
2053*202cdb0eSrobert     ++p;
2054*202cdb0eSrobert 
2055*202cdb0eSrobert   // p now points to tb_offset, the offset from start of function to TB table.
2056*202cdb0eSrobert   unw_word_t start_ip =
2057*202cdb0eSrobert       reinterpret_cast<unw_word_t>(TBTable) - *p - sizeof(uint32_t);
2058*202cdb0eSrobert   unw_word_t end_ip = reinterpret_cast<unw_word_t>(TBTable);
2059*202cdb0eSrobert   ++p;
2060*202cdb0eSrobert 
2061*202cdb0eSrobert   _LIBUNWIND_TRACE_UNWINDING("start_ip=%p, end_ip=%p\n",
2062*202cdb0eSrobert                              reinterpret_cast<void *>(start_ip),
2063*202cdb0eSrobert                              reinterpret_cast<void *>(end_ip));
2064*202cdb0eSrobert 
2065*202cdb0eSrobert   // Skip field hand_mask if it exists.
2066*202cdb0eSrobert   if (TBTable->tb.int_hndl)
2067*202cdb0eSrobert     ++p;
2068*202cdb0eSrobert 
2069*202cdb0eSrobert   unw_word_t lsda = 0;
2070*202cdb0eSrobert   unw_word_t handler = 0;
2071*202cdb0eSrobert   unw_word_t flags = frameType::frameWithXLEHStateTable;
2072*202cdb0eSrobert 
2073*202cdb0eSrobert   if (TBTable->tb.lang == TB_CPLUSPLUS && TBTable->tb.has_ctl) {
2074*202cdb0eSrobert     // State table info is available. The ctl_info field indicates the
2075*202cdb0eSrobert     // number of CTL anchors. There should be only one entry for the C++
2076*202cdb0eSrobert     // state table.
2077*202cdb0eSrobert     assert(*p == 1 && "libunwind: there must be only one ctl_info entry");
2078*202cdb0eSrobert     ++p;
2079*202cdb0eSrobert     // p points to the offset of the state table into the stack.
2080*202cdb0eSrobert     pint_t stateTableOffset = *p++;
2081*202cdb0eSrobert 
2082*202cdb0eSrobert     int framePointerReg;
2083*202cdb0eSrobert 
2084*202cdb0eSrobert     // Skip fields name_len and name if exist.
2085*202cdb0eSrobert     if (TBTable->tb.name_present) {
2086*202cdb0eSrobert       const uint16_t name_len = *(reinterpret_cast<uint16_t *>(p));
2087*202cdb0eSrobert       p = reinterpret_cast<uint32_t *>(reinterpret_cast<char *>(p) + name_len +
2088*202cdb0eSrobert                                        sizeof(uint16_t));
2089*202cdb0eSrobert     }
2090*202cdb0eSrobert 
2091*202cdb0eSrobert     if (TBTable->tb.uses_alloca)
2092*202cdb0eSrobert       framePointerReg = *(reinterpret_cast<char *>(p));
2093*202cdb0eSrobert     else
2094*202cdb0eSrobert       framePointerReg = 1; // default frame pointer == SP
2095*202cdb0eSrobert 
2096*202cdb0eSrobert     _LIBUNWIND_TRACE_UNWINDING(
2097*202cdb0eSrobert         "framePointerReg=%d, framePointer=%p, "
2098*202cdb0eSrobert         "stateTableOffset=%#lx\n",
2099*202cdb0eSrobert         framePointerReg,
2100*202cdb0eSrobert         reinterpret_cast<void *>(_registers.getRegister(framePointerReg)),
2101*202cdb0eSrobert         stateTableOffset);
2102*202cdb0eSrobert     lsda = _registers.getRegister(framePointerReg) + stateTableOffset;
2103*202cdb0eSrobert 
2104*202cdb0eSrobert     // Since the traceback table generated by the legacy XLC++ does not
2105*202cdb0eSrobert     // provide the location of the personality for the state table,
2106*202cdb0eSrobert     // function __xlcxx_personality_v0(), which is the personality for the state
2107*202cdb0eSrobert     // table and is exported from libc++abi, is directly assigned as the
2108*202cdb0eSrobert     // handler here. When a legacy XLC++ frame is encountered, the symbol
2109*202cdb0eSrobert     // is resolved dynamically using dlopen() to avoid hard dependency from
2110*202cdb0eSrobert     // libunwind on libc++abi.
2111*202cdb0eSrobert 
2112*202cdb0eSrobert     // Resolve the function pointer to the state table personality if it has
2113*202cdb0eSrobert     // not already.
2114*202cdb0eSrobert     if (xlcPersonalityV0 == NULL) {
2115*202cdb0eSrobert       xlcPersonalityV0InitLock.lock();
2116*202cdb0eSrobert       if (xlcPersonalityV0 == NULL) {
2117*202cdb0eSrobert         // If libc++abi is statically linked in, symbol __xlcxx_personality_v0
2118*202cdb0eSrobert         // has been resolved at the link time.
2119*202cdb0eSrobert         xlcPersonalityV0 = &__xlcxx_personality_v0;
2120*202cdb0eSrobert         if (xlcPersonalityV0 == NULL) {
2121*202cdb0eSrobert           // libc++abi is dynamically linked. Resolve __xlcxx_personality_v0
2122*202cdb0eSrobert           // using dlopen().
2123*202cdb0eSrobert           const char libcxxabi[] = "libc++abi.a(libc++abi.so.1)";
2124*202cdb0eSrobert           void *libHandle;
2125*202cdb0eSrobert           // The AIX dlopen() sets errno to 0 when it is successful, which
2126*202cdb0eSrobert           // clobbers the value of errno from the user code. This is an AIX
2127*202cdb0eSrobert           // bug because according to POSIX it should not set errno to 0. To
2128*202cdb0eSrobert           // workaround before AIX fixes the bug, errno is saved and restored.
2129*202cdb0eSrobert           int saveErrno = errno;
2130*202cdb0eSrobert           libHandle = dlopen(libcxxabi, RTLD_MEMBER | RTLD_NOW);
2131*202cdb0eSrobert           if (libHandle == NULL) {
2132*202cdb0eSrobert             _LIBUNWIND_TRACE_UNWINDING("dlopen() failed with errno=%d\n",
2133*202cdb0eSrobert                                        errno);
2134*202cdb0eSrobert             assert(0 && "dlopen() failed");
2135*202cdb0eSrobert           }
2136*202cdb0eSrobert           xlcPersonalityV0 = reinterpret_cast<__xlcxx_personality_v0_t *>(
2137*202cdb0eSrobert               dlsym(libHandle, "__xlcxx_personality_v0"));
2138*202cdb0eSrobert           if (xlcPersonalityV0 == NULL) {
2139*202cdb0eSrobert             _LIBUNWIND_TRACE_UNWINDING("dlsym() failed with errno=%d\n", errno);
2140*202cdb0eSrobert             assert(0 && "dlsym() failed");
2141*202cdb0eSrobert           }
2142*202cdb0eSrobert           dlclose(libHandle);
2143*202cdb0eSrobert           errno = saveErrno;
2144*202cdb0eSrobert         }
2145*202cdb0eSrobert       }
2146*202cdb0eSrobert       xlcPersonalityV0InitLock.unlock();
2147*202cdb0eSrobert     }
2148*202cdb0eSrobert     handler = reinterpret_cast<unw_word_t>(xlcPersonalityV0);
2149*202cdb0eSrobert     _LIBUNWIND_TRACE_UNWINDING("State table: LSDA=%p, Personality=%p\n",
2150*202cdb0eSrobert                                reinterpret_cast<void *>(lsda),
2151*202cdb0eSrobert                                reinterpret_cast<void *>(handler));
2152*202cdb0eSrobert   } else if (TBTable->tb.longtbtable) {
2153*202cdb0eSrobert     // This frame has the traceback table extension. Possible cases are
2154*202cdb0eSrobert     // 1) a C++ frame that has the 'eh_info' structure; 2) a C++ frame that
2155*202cdb0eSrobert     // is not EH aware; or, 3) a frame of other languages. We need to figure out
2156*202cdb0eSrobert     // if the traceback table extension contains the 'eh_info' structure.
2157*202cdb0eSrobert     //
2158*202cdb0eSrobert     // We also need to deal with the complexity arising from some XL compiler
2159*202cdb0eSrobert     // versions use the wrong ordering of 'longtbtable' and 'has_vec' bits
2160*202cdb0eSrobert     // where the 'longtbtable' bit is meant to be the 'has_vec' bit and vice
2161*202cdb0eSrobert     // versa. For frames of code generated by those compilers, the 'longtbtable'
2162*202cdb0eSrobert     // bit may be set but there isn't really a traceback table extension.
2163*202cdb0eSrobert     //
2164*202cdb0eSrobert     // In </usr/include/sys/debug.h>, there is the following definition of
2165*202cdb0eSrobert     // 'struct tbtable_ext'. It is not really a structure but a dummy to
2166*202cdb0eSrobert     // collect the description of optional parts of the traceback table.
2167*202cdb0eSrobert     //
2168*202cdb0eSrobert     // struct tbtable_ext {
2169*202cdb0eSrobert     //   ...
2170*202cdb0eSrobert     //   char alloca_reg;        /* Register for alloca automatic storage */
2171*202cdb0eSrobert     //   struct vec_ext vec_ext; /* Vector extension (if has_vec is set) */
2172*202cdb0eSrobert     //   unsigned char xtbtable; /* More tbtable fields, if longtbtable is set*/
2173*202cdb0eSrobert     // };
2174*202cdb0eSrobert     //
2175*202cdb0eSrobert     // Depending on how the 'has_vec'/'longtbtable' bit is interpreted, the data
2176*202cdb0eSrobert     // following 'alloca_reg' can be treated either as 'struct vec_ext' or
2177*202cdb0eSrobert     // 'unsigned char xtbtable'. 'xtbtable' bits are defined in
2178*202cdb0eSrobert     // </usr/include/sys/debug.h> as flags. The 7th bit '0x02' is currently
2179*202cdb0eSrobert     // unused and should not be set. 'struct vec_ext' is defined in
2180*202cdb0eSrobert     // </usr/include/sys/debug.h> as follows:
2181*202cdb0eSrobert     //
2182*202cdb0eSrobert     // struct vec_ext {
2183*202cdb0eSrobert     //   unsigned vr_saved:6;      /* Number of non-volatile vector regs saved
2184*202cdb0eSrobert     //   */
2185*202cdb0eSrobert     //                             /* first register saved is assumed to be */
2186*202cdb0eSrobert     //                             /* 32 - vr_saved                         */
2187*202cdb0eSrobert     //   unsigned saves_vrsave:1;  /* Set if vrsave is saved on the stack */
2188*202cdb0eSrobert     //   unsigned has_varargs:1;
2189*202cdb0eSrobert     //   ...
2190*202cdb0eSrobert     // };
2191*202cdb0eSrobert     //
2192*202cdb0eSrobert     // Here, the 7th bit is used as 'saves_vrsave'. To determine whether it
2193*202cdb0eSrobert     // is 'struct vec_ext' or 'xtbtable' that follows 'alloca_reg',
2194*202cdb0eSrobert     // we checks if the 7th bit is set or not because 'xtbtable' should
2195*202cdb0eSrobert     // never have the 7th bit set. The 7th bit of 'xtbtable' will be reserved
2196*202cdb0eSrobert     // in the future to make sure the mitigation works. This mitigation
2197*202cdb0eSrobert     // is not 100% bullet proof because 'struct vec_ext' may not always have
2198*202cdb0eSrobert     // 'saves_vrsave' bit set.
2199*202cdb0eSrobert     //
2200*202cdb0eSrobert     // 'reservedBit' is defined in enum 'xTBTableMask' above as the mask for
2201*202cdb0eSrobert     // checking the 7th bit.
2202*202cdb0eSrobert 
2203*202cdb0eSrobert     // p points to field name len.
2204*202cdb0eSrobert     uint8_t *charPtr = reinterpret_cast<uint8_t *>(p);
2205*202cdb0eSrobert 
2206*202cdb0eSrobert     // Skip fields name_len and name if they exist.
2207*202cdb0eSrobert     if (TBTable->tb.name_present) {
2208*202cdb0eSrobert       const uint16_t name_len = *(reinterpret_cast<uint16_t *>(charPtr));
2209*202cdb0eSrobert       charPtr = charPtr + name_len + sizeof(uint16_t);
2210*202cdb0eSrobert     }
2211*202cdb0eSrobert 
2212*202cdb0eSrobert     // Skip field alloc_reg if it exists.
2213*202cdb0eSrobert     if (TBTable->tb.uses_alloca)
2214*202cdb0eSrobert       ++charPtr;
2215*202cdb0eSrobert 
2216*202cdb0eSrobert     // Check traceback table bit has_vec. Skip struct vec_ext if it exists.
2217*202cdb0eSrobert     if (TBTable->tb.has_vec)
2218*202cdb0eSrobert       // Note struct vec_ext does exist at this point because whether the
2219*202cdb0eSrobert       // ordering of longtbtable and has_vec bits is correct or not, both
2220*202cdb0eSrobert       // are set.
2221*202cdb0eSrobert       charPtr += sizeof(struct vec_ext);
2222*202cdb0eSrobert 
2223*202cdb0eSrobert     // charPtr points to field 'xtbtable'. Check if the EH info is available.
2224*202cdb0eSrobert     // Also check if the reserved bit of the extended traceback table field
2225*202cdb0eSrobert     // 'xtbtable' is set. If it is, the traceback table was incorrectly
2226*202cdb0eSrobert     // generated by an XL compiler that uses the wrong ordering of 'longtbtable'
2227*202cdb0eSrobert     // and 'has_vec' bits and this is in fact 'struct vec_ext'. So skip the
2228*202cdb0eSrobert     // frame.
2229*202cdb0eSrobert     if ((*charPtr & xTBTableMask::ehInfoBit) &&
2230*202cdb0eSrobert         !(*charPtr & xTBTableMask::reservedBit)) {
2231*202cdb0eSrobert       // Mark this frame has the new EH info.
2232*202cdb0eSrobert       flags = frameType::frameWithEHInfo;
2233*202cdb0eSrobert 
2234*202cdb0eSrobert       // eh_info is available.
2235*202cdb0eSrobert       charPtr++;
2236*202cdb0eSrobert       // The pointer is 4-byte aligned.
2237*202cdb0eSrobert       if (reinterpret_cast<uintptr_t>(charPtr) % 4)
2238*202cdb0eSrobert         charPtr += 4 - reinterpret_cast<uintptr_t>(charPtr) % 4;
2239*202cdb0eSrobert       uintptr_t *ehInfo =
2240*202cdb0eSrobert           reinterpret_cast<uintptr_t *>(*(reinterpret_cast<uintptr_t *>(
2241*202cdb0eSrobert               registers.getRegister(2) +
2242*202cdb0eSrobert               *(reinterpret_cast<uintptr_t *>(charPtr)))));
2243*202cdb0eSrobert 
2244*202cdb0eSrobert       // ehInfo points to structure en_info. The first member is version.
2245*202cdb0eSrobert       // Only version 0 is currently supported.
2246*202cdb0eSrobert       assert(*(reinterpret_cast<uint32_t *>(ehInfo)) == 0 &&
2247*202cdb0eSrobert              "libunwind: ehInfo version other than 0 is not supported");
2248*202cdb0eSrobert 
2249*202cdb0eSrobert       // Increment ehInfo to point to member lsda.
2250*202cdb0eSrobert       ++ehInfo;
2251*202cdb0eSrobert       lsda = *ehInfo++;
2252*202cdb0eSrobert 
2253*202cdb0eSrobert       // enInfo now points to member personality.
2254*202cdb0eSrobert       handler = *ehInfo;
2255*202cdb0eSrobert 
2256*202cdb0eSrobert       _LIBUNWIND_TRACE_UNWINDING("Range table: LSDA=%#lx, Personality=%#lx\n",
2257*202cdb0eSrobert                                  lsda, handler);
2258*202cdb0eSrobert     }
2259*202cdb0eSrobert   }
2260*202cdb0eSrobert 
2261*202cdb0eSrobert   _info.start_ip = start_ip;
2262*202cdb0eSrobert   _info.end_ip = end_ip;
2263*202cdb0eSrobert   _info.lsda = lsda;
2264*202cdb0eSrobert   _info.handler = handler;
2265*202cdb0eSrobert   _info.gp = 0;
2266*202cdb0eSrobert   _info.flags = flags;
2267*202cdb0eSrobert   _info.format = 0;
2268*202cdb0eSrobert   _info.unwind_info = reinterpret_cast<unw_word_t>(TBTable);
2269*202cdb0eSrobert   _info.unwind_info_size = 0;
2270*202cdb0eSrobert   _info.extra = registers.getRegister(2);
2271*202cdb0eSrobert 
2272*202cdb0eSrobert   return true;
2273*202cdb0eSrobert }
2274*202cdb0eSrobert 
2275*202cdb0eSrobert // Step back up the stack following the frame back link.
2276*202cdb0eSrobert template <typename A, typename R>
stepWithTBTable(pint_t pc,tbtable * TBTable,R & registers,bool & isSignalFrame)2277*202cdb0eSrobert int UnwindCursor<A, R>::stepWithTBTable(pint_t pc, tbtable *TBTable,
2278*202cdb0eSrobert                                         R &registers, bool &isSignalFrame) {
2279*202cdb0eSrobert   if (_LIBUNWIND_TRACING_UNWINDING) {
2280*202cdb0eSrobert     char functionBuf[512];
2281*202cdb0eSrobert     const char *functionName = functionBuf;
2282*202cdb0eSrobert     unw_word_t offset;
2283*202cdb0eSrobert     if (!getFunctionName(functionBuf, sizeof(functionBuf), &offset)) {
2284*202cdb0eSrobert       functionName = ".anonymous.";
2285*202cdb0eSrobert     }
2286*202cdb0eSrobert     _LIBUNWIND_TRACE_UNWINDING("%s: Look up traceback table of func=%s at %p",
2287*202cdb0eSrobert                                __func__, functionName,
2288*202cdb0eSrobert                                reinterpret_cast<void *>(TBTable));
2289*202cdb0eSrobert   }
2290*202cdb0eSrobert 
2291*202cdb0eSrobert #if defined(__powerpc64__)
2292*202cdb0eSrobert   // Instruction to reload TOC register "l r2,40(r1)"
2293*202cdb0eSrobert   const uint32_t loadTOCRegInst = 0xe8410028;
2294*202cdb0eSrobert   const int32_t unwPPCF0Index = UNW_PPC64_F0;
2295*202cdb0eSrobert   const int32_t unwPPCV0Index = UNW_PPC64_V0;
2296*202cdb0eSrobert #else
2297*202cdb0eSrobert   // Instruction to reload TOC register "l r2,20(r1)"
2298*202cdb0eSrobert   const uint32_t loadTOCRegInst = 0x80410014;
2299*202cdb0eSrobert   const int32_t unwPPCF0Index = UNW_PPC_F0;
2300*202cdb0eSrobert   const int32_t unwPPCV0Index = UNW_PPC_V0;
2301*202cdb0eSrobert #endif
2302*202cdb0eSrobert 
2303*202cdb0eSrobert   R newRegisters = registers;
2304*202cdb0eSrobert 
2305*202cdb0eSrobert   // lastStack points to the stack frame of the next routine up.
2306*202cdb0eSrobert   pint_t lastStack = *(reinterpret_cast<pint_t *>(registers.getSP()));
2307*202cdb0eSrobert 
2308*202cdb0eSrobert   // Return address is the address after call site instruction.
2309*202cdb0eSrobert   pint_t returnAddress;
2310*202cdb0eSrobert 
2311*202cdb0eSrobert   if (isSignalFrame) {
2312*202cdb0eSrobert     _LIBUNWIND_TRACE_UNWINDING("Possible signal handler frame: lastStack=%p",
2313*202cdb0eSrobert                                reinterpret_cast<void *>(lastStack));
2314*202cdb0eSrobert 
2315*202cdb0eSrobert     sigcontext *sigContext = reinterpret_cast<sigcontext *>(
2316*202cdb0eSrobert         reinterpret_cast<char *>(lastStack) + STKMIN);
2317*202cdb0eSrobert     returnAddress = sigContext->sc_jmpbuf.jmp_context.iar;
2318*202cdb0eSrobert 
2319*202cdb0eSrobert     _LIBUNWIND_TRACE_UNWINDING("From sigContext=%p, returnAddress=%p\n",
2320*202cdb0eSrobert                                reinterpret_cast<void *>(sigContext),
2321*202cdb0eSrobert                                reinterpret_cast<void *>(returnAddress));
2322*202cdb0eSrobert 
2323*202cdb0eSrobert     if (returnAddress < 0x10000000) {
2324*202cdb0eSrobert       // Try again using STKMINALIGN
2325*202cdb0eSrobert       sigContext = reinterpret_cast<sigcontext *>(
2326*202cdb0eSrobert           reinterpret_cast<char *>(lastStack) + STKMINALIGN);
2327*202cdb0eSrobert       returnAddress = sigContext->sc_jmpbuf.jmp_context.iar;
2328*202cdb0eSrobert       if (returnAddress < 0x10000000) {
2329*202cdb0eSrobert         _LIBUNWIND_TRACE_UNWINDING("Bad returnAddress=%p\n",
2330*202cdb0eSrobert                                    reinterpret_cast<void *>(returnAddress));
2331*202cdb0eSrobert         return UNW_EBADFRAME;
2332*202cdb0eSrobert       } else {
2333*202cdb0eSrobert         _LIBUNWIND_TRACE_UNWINDING("Tried again using STKMINALIGN: "
2334*202cdb0eSrobert                                    "sigContext=%p, returnAddress=%p. "
2335*202cdb0eSrobert                                    "Seems to be a valid address\n",
2336*202cdb0eSrobert                                    reinterpret_cast<void *>(sigContext),
2337*202cdb0eSrobert                                    reinterpret_cast<void *>(returnAddress));
2338*202cdb0eSrobert       }
2339*202cdb0eSrobert     }
2340*202cdb0eSrobert     // Restore the condition register from sigcontext.
2341*202cdb0eSrobert     newRegisters.setCR(sigContext->sc_jmpbuf.jmp_context.cr);
2342*202cdb0eSrobert 
2343*202cdb0eSrobert     // Restore GPRs from sigcontext.
2344*202cdb0eSrobert     for (int i = 0; i < 32; ++i)
2345*202cdb0eSrobert       newRegisters.setRegister(i, sigContext->sc_jmpbuf.jmp_context.gpr[i]);
2346*202cdb0eSrobert 
2347*202cdb0eSrobert     // Restore FPRs from sigcontext.
2348*202cdb0eSrobert     for (int i = 0; i < 32; ++i)
2349*202cdb0eSrobert       newRegisters.setFloatRegister(i + unwPPCF0Index,
2350*202cdb0eSrobert                                     sigContext->sc_jmpbuf.jmp_context.fpr[i]);
2351*202cdb0eSrobert 
2352*202cdb0eSrobert     // Restore vector registers if there is an associated extended context
2353*202cdb0eSrobert     // structure.
2354*202cdb0eSrobert     if (sigContext->sc_jmpbuf.jmp_context.msr & __EXTCTX) {
2355*202cdb0eSrobert       ucontext_t *uContext = reinterpret_cast<ucontext_t *>(sigContext);
2356*202cdb0eSrobert       if (uContext->__extctx->__extctx_magic == __EXTCTX_MAGIC) {
2357*202cdb0eSrobert         for (int i = 0; i < 32; ++i)
2358*202cdb0eSrobert           newRegisters.setVectorRegister(
2359*202cdb0eSrobert               i + unwPPCV0Index, *(reinterpret_cast<v128 *>(
2360*202cdb0eSrobert                                      &(uContext->__extctx->__vmx.__vr[i]))));
2361*202cdb0eSrobert       }
2362*202cdb0eSrobert     }
2363*202cdb0eSrobert   } else {
2364*202cdb0eSrobert     // Step up a normal frame.
2365*202cdb0eSrobert     returnAddress = reinterpret_cast<pint_t *>(lastStack)[2];
2366*202cdb0eSrobert 
2367*202cdb0eSrobert     _LIBUNWIND_TRACE_UNWINDING("Extract info from lastStack=%p, "
2368*202cdb0eSrobert                                "returnAddress=%p\n",
2369*202cdb0eSrobert                                reinterpret_cast<void *>(lastStack),
2370*202cdb0eSrobert                                reinterpret_cast<void *>(returnAddress));
2371*202cdb0eSrobert     _LIBUNWIND_TRACE_UNWINDING("fpr_regs=%d, gpr_regs=%d, saves_cr=%d\n",
2372*202cdb0eSrobert                                TBTable->tb.fpr_saved, TBTable->tb.gpr_saved,
2373*202cdb0eSrobert                                TBTable->tb.saves_cr);
2374*202cdb0eSrobert 
2375*202cdb0eSrobert     // Restore FP registers.
2376*202cdb0eSrobert     char *ptrToRegs = reinterpret_cast<char *>(lastStack);
2377*202cdb0eSrobert     double *FPRegs = reinterpret_cast<double *>(
2378*202cdb0eSrobert         ptrToRegs - (TBTable->tb.fpr_saved * sizeof(double)));
2379*202cdb0eSrobert     for (int i = 0; i < TBTable->tb.fpr_saved; ++i)
2380*202cdb0eSrobert       newRegisters.setFloatRegister(
2381*202cdb0eSrobert           32 - TBTable->tb.fpr_saved + i + unwPPCF0Index, FPRegs[i]);
2382*202cdb0eSrobert 
2383*202cdb0eSrobert     // Restore GP registers.
2384*202cdb0eSrobert     ptrToRegs = reinterpret_cast<char *>(FPRegs);
2385*202cdb0eSrobert     uintptr_t *GPRegs = reinterpret_cast<uintptr_t *>(
2386*202cdb0eSrobert         ptrToRegs - (TBTable->tb.gpr_saved * sizeof(uintptr_t)));
2387*202cdb0eSrobert     for (int i = 0; i < TBTable->tb.gpr_saved; ++i)
2388*202cdb0eSrobert       newRegisters.setRegister(32 - TBTable->tb.gpr_saved + i, GPRegs[i]);
2389*202cdb0eSrobert 
2390*202cdb0eSrobert     // Restore Vector registers.
2391*202cdb0eSrobert     ptrToRegs = reinterpret_cast<char *>(GPRegs);
2392*202cdb0eSrobert 
2393*202cdb0eSrobert     // Restore vector registers only if this is a Clang frame. Also
2394*202cdb0eSrobert     // check if traceback table bit has_vec is set. If it is, structure
2395*202cdb0eSrobert     // vec_ext is available.
2396*202cdb0eSrobert     if (_info.flags == frameType::frameWithEHInfo && TBTable->tb.has_vec) {
2397*202cdb0eSrobert 
2398*202cdb0eSrobert       // Get to the vec_ext structure to check if vector registers are saved.
2399*202cdb0eSrobert       uint32_t *p = reinterpret_cast<uint32_t *>(&TBTable->tb_ext);
2400*202cdb0eSrobert 
2401*202cdb0eSrobert       // Skip field parminfo if exists.
2402*202cdb0eSrobert       if (TBTable->tb.fixedparms || TBTable->tb.floatparms)
2403*202cdb0eSrobert         ++p;
2404*202cdb0eSrobert 
2405*202cdb0eSrobert       // Skip field tb_offset if exists.
2406*202cdb0eSrobert       if (TBTable->tb.has_tboff)
2407*202cdb0eSrobert         ++p;
2408*202cdb0eSrobert 
2409*202cdb0eSrobert       // Skip field hand_mask if exists.
2410*202cdb0eSrobert       if (TBTable->tb.int_hndl)
2411*202cdb0eSrobert         ++p;
2412*202cdb0eSrobert 
2413*202cdb0eSrobert       // Skip fields ctl_info and ctl_info_disp if exist.
2414*202cdb0eSrobert       if (TBTable->tb.has_ctl) {
2415*202cdb0eSrobert         // Skip field ctl_info.
2416*202cdb0eSrobert         ++p;
2417*202cdb0eSrobert         // Skip field ctl_info_disp.
2418*202cdb0eSrobert         ++p;
2419*202cdb0eSrobert       }
2420*202cdb0eSrobert 
2421*202cdb0eSrobert       // Skip fields name_len and name if exist.
2422*202cdb0eSrobert       // p is supposed to point to field name_len now.
2423*202cdb0eSrobert       uint8_t *charPtr = reinterpret_cast<uint8_t *>(p);
2424*202cdb0eSrobert       if (TBTable->tb.name_present) {
2425*202cdb0eSrobert         const uint16_t name_len = *(reinterpret_cast<uint16_t *>(charPtr));
2426*202cdb0eSrobert         charPtr = charPtr + name_len + sizeof(uint16_t);
2427*202cdb0eSrobert       }
2428*202cdb0eSrobert 
2429*202cdb0eSrobert       // Skip field alloc_reg if it exists.
2430*202cdb0eSrobert       if (TBTable->tb.uses_alloca)
2431*202cdb0eSrobert         ++charPtr;
2432*202cdb0eSrobert 
2433*202cdb0eSrobert       struct vec_ext *vec_ext = reinterpret_cast<struct vec_ext *>(charPtr);
2434*202cdb0eSrobert 
2435*202cdb0eSrobert       _LIBUNWIND_TRACE_UNWINDING("vr_saved=%d\n", vec_ext->vr_saved);
2436*202cdb0eSrobert 
2437*202cdb0eSrobert       // Restore vector register(s) if saved on the stack.
2438*202cdb0eSrobert       if (vec_ext->vr_saved) {
2439*202cdb0eSrobert         // Saved vector registers are 16-byte aligned.
2440*202cdb0eSrobert         if (reinterpret_cast<uintptr_t>(ptrToRegs) % 16)
2441*202cdb0eSrobert           ptrToRegs -= reinterpret_cast<uintptr_t>(ptrToRegs) % 16;
2442*202cdb0eSrobert         v128 *VecRegs = reinterpret_cast<v128 *>(ptrToRegs - vec_ext->vr_saved *
2443*202cdb0eSrobert                                                                  sizeof(v128));
2444*202cdb0eSrobert         for (int i = 0; i < vec_ext->vr_saved; ++i) {
2445*202cdb0eSrobert           newRegisters.setVectorRegister(
2446*202cdb0eSrobert               32 - vec_ext->vr_saved + i + unwPPCV0Index, VecRegs[i]);
2447*202cdb0eSrobert         }
2448*202cdb0eSrobert       }
2449*202cdb0eSrobert     }
2450*202cdb0eSrobert     if (TBTable->tb.saves_cr) {
2451*202cdb0eSrobert       // Get the saved condition register. The condition register is only
2452*202cdb0eSrobert       // a single word.
2453*202cdb0eSrobert       newRegisters.setCR(
2454*202cdb0eSrobert           *(reinterpret_cast<uint32_t *>(lastStack + sizeof(uintptr_t))));
2455*202cdb0eSrobert     }
2456*202cdb0eSrobert 
2457*202cdb0eSrobert     // Restore the SP.
2458*202cdb0eSrobert     newRegisters.setSP(lastStack);
2459*202cdb0eSrobert 
2460*202cdb0eSrobert     // The first instruction after return.
2461*202cdb0eSrobert     uint32_t firstInstruction = *(reinterpret_cast<uint32_t *>(returnAddress));
2462*202cdb0eSrobert 
2463*202cdb0eSrobert     // Do we need to set the TOC register?
2464*202cdb0eSrobert     _LIBUNWIND_TRACE_UNWINDING(
2465*202cdb0eSrobert         "Current gpr2=%p\n",
2466*202cdb0eSrobert         reinterpret_cast<void *>(newRegisters.getRegister(2)));
2467*202cdb0eSrobert     if (firstInstruction == loadTOCRegInst) {
2468*202cdb0eSrobert       _LIBUNWIND_TRACE_UNWINDING(
2469*202cdb0eSrobert           "Set gpr2=%p from frame\n",
2470*202cdb0eSrobert           reinterpret_cast<void *>(reinterpret_cast<pint_t *>(lastStack)[5]));
2471*202cdb0eSrobert       newRegisters.setRegister(2, reinterpret_cast<pint_t *>(lastStack)[5]);
2472*202cdb0eSrobert     }
2473*202cdb0eSrobert   }
2474*202cdb0eSrobert   _LIBUNWIND_TRACE_UNWINDING("lastStack=%p, returnAddress=%p, pc=%p\n",
2475*202cdb0eSrobert                              reinterpret_cast<void *>(lastStack),
2476*202cdb0eSrobert                              reinterpret_cast<void *>(returnAddress),
2477*202cdb0eSrobert                              reinterpret_cast<void *>(pc));
2478*202cdb0eSrobert 
2479*202cdb0eSrobert   // The return address is the address after call site instruction, so
2480*202cdb0eSrobert   // setting IP to that simulates a return.
2481*202cdb0eSrobert   newRegisters.setIP(reinterpret_cast<uintptr_t>(returnAddress));
2482*202cdb0eSrobert 
2483*202cdb0eSrobert   // Simulate the step by replacing the register set with the new ones.
2484*202cdb0eSrobert   registers = newRegisters;
2485*202cdb0eSrobert 
2486*202cdb0eSrobert   // Check if the next frame is a signal frame.
2487*202cdb0eSrobert   pint_t nextStack = *(reinterpret_cast<pint_t *>(registers.getSP()));
2488*202cdb0eSrobert 
2489*202cdb0eSrobert   // Return address is the address after call site instruction.
2490*202cdb0eSrobert   pint_t nextReturnAddress = reinterpret_cast<pint_t *>(nextStack)[2];
2491*202cdb0eSrobert 
2492*202cdb0eSrobert   if (nextReturnAddress > 0x01 && nextReturnAddress < 0x10000) {
2493*202cdb0eSrobert     _LIBUNWIND_TRACE_UNWINDING("The next is a signal handler frame: "
2494*202cdb0eSrobert                                "nextStack=%p, next return address=%p\n",
2495*202cdb0eSrobert                                reinterpret_cast<void *>(nextStack),
2496*202cdb0eSrobert                                reinterpret_cast<void *>(nextReturnAddress));
2497*202cdb0eSrobert     isSignalFrame = true;
2498*202cdb0eSrobert   } else {
2499*202cdb0eSrobert     isSignalFrame = false;
2500*202cdb0eSrobert   }
2501*202cdb0eSrobert 
2502*202cdb0eSrobert   return UNW_STEP_SUCCESS;
2503*202cdb0eSrobert }
2504*202cdb0eSrobert #endif // defined(_LIBUNWIND_SUPPORT_TBTAB_UNWIND)
2505f6c50668Spatrick 
2506f6c50668Spatrick template <typename A, typename R>
setInfoBasedOnIPRegister(bool isReturnAddress)2507f6c50668Spatrick void UnwindCursor<A, R>::setInfoBasedOnIPRegister(bool isReturnAddress) {
2508*202cdb0eSrobert #if defined(_LIBUNWIND_CHECK_LINUX_SIGRETURN)
2509a0747c9fSpatrick   _isSigReturn = false;
2510a0747c9fSpatrick #endif
2511a0747c9fSpatrick 
2512a0747c9fSpatrick   pint_t pc = static_cast<pint_t>(this->getReg(UNW_REG_IP));
2513f6c50668Spatrick #if defined(_LIBUNWIND_ARM_EHABI)
2514f6c50668Spatrick   // Remove the thumb bit so the IP represents the actual instruction address.
2515f6c50668Spatrick   // This matches the behaviour of _Unwind_GetIP on arm.
2516f6c50668Spatrick   pc &= (pint_t)~0x1;
2517f6c50668Spatrick #endif
2518f6c50668Spatrick 
2519f6c50668Spatrick   // Exit early if at the top of the stack.
2520f6c50668Spatrick   if (pc == 0) {
2521f6c50668Spatrick     _unwindInfoMissing = true;
2522f6c50668Spatrick     return;
2523f6c50668Spatrick   }
2524f6c50668Spatrick 
2525f6c50668Spatrick   // If the last line of a function is a "throw" the compiler sometimes
2526f6c50668Spatrick   // emits no instructions after the call to __cxa_throw.  This means
2527f6c50668Spatrick   // the return address is actually the start of the next function.
2528f6c50668Spatrick   // To disambiguate this, back up the pc when we know it is a return
2529f6c50668Spatrick   // address.
2530f6c50668Spatrick   if (isReturnAddress)
2531*202cdb0eSrobert #if defined(_AIX)
2532*202cdb0eSrobert     // PC needs to be a 4-byte aligned address to be able to look for a
2533*202cdb0eSrobert     // word of 0 that indicates the start of the traceback table at the end
2534*202cdb0eSrobert     // of a function on AIX.
2535*202cdb0eSrobert     pc -= 4;
2536*202cdb0eSrobert #else
2537f6c50668Spatrick     --pc;
2538*202cdb0eSrobert #endif
2539f6c50668Spatrick 
2540f6c50668Spatrick   // Ask address space object to find unwind sections for this pc.
2541f6c50668Spatrick   UnwindInfoSections sects;
2542974930e3Spatrick   bool have_sects = false;
2543974930e3Spatrick   if (uwis_cache.getUnwindInfoSectionsForPC(pc, sects))
2544974930e3Spatrick     have_sects = true;
2545974930e3Spatrick   else if (_addressSpace.findUnwindSections(pc, sects)) {
2546974930e3Spatrick     uwis_cache.setUnwindInfoSectionsForPC(pc, sects);
2547974930e3Spatrick     have_sects = true;
2548974930e3Spatrick   }
2549974930e3Spatrick   if (have_sects) {
2550f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
2551f6c50668Spatrick     // If there is a compact unwind encoding table, look there first.
2552f6c50668Spatrick     if (sects.compact_unwind_section != 0) {
2553f6c50668Spatrick       if (this->getInfoFromCompactEncodingSection(pc, sects)) {
2554f6c50668Spatrick   #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
2555f6c50668Spatrick         // Found info in table, done unless encoding says to use dwarf.
2556f6c50668Spatrick         uint32_t dwarfOffset;
2557f6c50668Spatrick         if ((sects.dwarf_section != 0) && compactSaysUseDwarf(&dwarfOffset)) {
2558f6c50668Spatrick           if (this->getInfoFromDwarfSection(pc, sects, dwarfOffset)) {
2559f6c50668Spatrick             // found info in dwarf, done
2560f6c50668Spatrick             return;
2561f6c50668Spatrick           }
2562f6c50668Spatrick         }
2563f6c50668Spatrick   #endif
2564f6c50668Spatrick         // If unwind table has entry, but entry says there is no unwind info,
2565f6c50668Spatrick         // record that we have no unwind info.
2566f6c50668Spatrick         if (_info.format == 0)
2567f6c50668Spatrick           _unwindInfoMissing = true;
2568f6c50668Spatrick         return;
2569f6c50668Spatrick       }
2570f6c50668Spatrick     }
2571f6c50668Spatrick #endif // defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
2572f6c50668Spatrick 
2573f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_SEH_UNWIND)
2574f6c50668Spatrick     // If there is SEH unwind info, look there next.
2575f6c50668Spatrick     if (this->getInfoFromSEH(pc))
2576f6c50668Spatrick       return;
2577f6c50668Spatrick #endif
2578f6c50668Spatrick 
2579*202cdb0eSrobert #if defined(_LIBUNWIND_SUPPORT_TBTAB_UNWIND)
2580*202cdb0eSrobert     // If there is unwind info in the traceback table, look there next.
2581*202cdb0eSrobert     if (this->getInfoFromTBTable(pc, _registers))
2582*202cdb0eSrobert       return;
2583*202cdb0eSrobert #endif
2584*202cdb0eSrobert 
2585f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
2586f6c50668Spatrick     // If there is dwarf unwind info, look there next.
2587f6c50668Spatrick     if (sects.dwarf_section != 0) {
2588f6c50668Spatrick       if (this->getInfoFromDwarfSection(pc, sects)) {
2589f6c50668Spatrick         // found info in dwarf, done
2590f6c50668Spatrick         return;
2591f6c50668Spatrick       }
2592f6c50668Spatrick     }
2593f6c50668Spatrick #endif
2594f6c50668Spatrick 
2595f6c50668Spatrick #if defined(_LIBUNWIND_ARM_EHABI)
2596f6c50668Spatrick     // If there is ARM EHABI unwind info, look there next.
2597f6c50668Spatrick     if (sects.arm_section != 0 && this->getInfoFromEHABISection(pc, sects))
2598f6c50668Spatrick       return;
2599f6c50668Spatrick #endif
2600f6c50668Spatrick   }
2601f6c50668Spatrick 
2602f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
2603f6c50668Spatrick   // There is no static unwind info for this pc. Look to see if an FDE was
2604f6c50668Spatrick   // dynamically registered for it.
2605a0747c9fSpatrick   pint_t cachedFDE = DwarfFDECache<A>::findFDE(DwarfFDECache<A>::kSearchAll,
2606a0747c9fSpatrick                                                pc);
2607f6c50668Spatrick   if (cachedFDE != 0) {
2608a0747c9fSpatrick     typename CFI_Parser<A>::FDE_Info fdeInfo;
2609a0747c9fSpatrick     typename CFI_Parser<A>::CIE_Info cieInfo;
2610a0747c9fSpatrick     if (!CFI_Parser<A>::decodeFDE(_addressSpace, cachedFDE, &fdeInfo, &cieInfo))
2611a0747c9fSpatrick       if (getInfoFromFdeCie(fdeInfo, cieInfo, pc, 0))
2612f6c50668Spatrick         return;
2613f6c50668Spatrick   }
2614f6c50668Spatrick 
2615f6c50668Spatrick   // Lastly, ask AddressSpace object about platform specific ways to locate
2616f6c50668Spatrick   // other FDEs.
2617f6c50668Spatrick   pint_t fde;
2618f6c50668Spatrick   if (_addressSpace.findOtherFDE(pc, fde)) {
2619a0747c9fSpatrick     typename CFI_Parser<A>::FDE_Info fdeInfo;
2620a0747c9fSpatrick     typename CFI_Parser<A>::CIE_Info cieInfo;
2621f6c50668Spatrick     if (!CFI_Parser<A>::decodeFDE(_addressSpace, fde, &fdeInfo, &cieInfo)) {
2622f6c50668Spatrick       // Double check this FDE is for a function that includes the pc.
2623a0747c9fSpatrick       if ((fdeInfo.pcStart <= pc) && (pc < fdeInfo.pcEnd))
2624a0747c9fSpatrick         if (getInfoFromFdeCie(fdeInfo, cieInfo, pc, 0))
2625f6c50668Spatrick           return;
2626f6c50668Spatrick     }
2627f6c50668Spatrick   }
2628f6c50668Spatrick #endif // #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
2629f6c50668Spatrick 
2630*202cdb0eSrobert #if defined(_LIBUNWIND_CHECK_LINUX_SIGRETURN)
2631a0747c9fSpatrick   if (setInfoForSigReturn())
2632a0747c9fSpatrick     return;
2633a0747c9fSpatrick #endif
2634a0747c9fSpatrick 
2635f6c50668Spatrick   // no unwind info, flag that we can't reliably unwind
2636f6c50668Spatrick   _unwindInfoMissing = true;
2637f6c50668Spatrick }
2638f6c50668Spatrick 
2639*202cdb0eSrobert #if defined(_LIBUNWIND_CHECK_LINUX_SIGRETURN) &&                               \
2640*202cdb0eSrobert     defined(_LIBUNWIND_TARGET_AARCH64)
2641a0747c9fSpatrick template <typename A, typename R>
setInfoForSigReturn(Registers_arm64 &)2642a0747c9fSpatrick bool UnwindCursor<A, R>::setInfoForSigReturn(Registers_arm64 &) {
2643a0747c9fSpatrick   // Look for the sigreturn trampoline. The trampoline's body is two
2644a0747c9fSpatrick   // specific instructions (see below). Typically the trampoline comes from the
2645a0747c9fSpatrick   // vDSO[1] (i.e. the __kernel_rt_sigreturn function). A libc might provide its
2646a0747c9fSpatrick   // own restorer function, though, or user-mode QEMU might write a trampoline
2647a0747c9fSpatrick   // onto the stack.
2648a0747c9fSpatrick   //
2649a0747c9fSpatrick   // This special code path is a fallback that is only used if the trampoline
2650a0747c9fSpatrick   // lacks proper (e.g. DWARF) unwind info. On AArch64, a new DWARF register
2651a0747c9fSpatrick   // constant for the PC needs to be defined before DWARF can handle a signal
2652a0747c9fSpatrick   // trampoline. This code may segfault if the target PC is unreadable, e.g.:
2653a0747c9fSpatrick   //  - The PC points at a function compiled without unwind info, and which is
2654a0747c9fSpatrick   //    part of an execute-only mapping (e.g. using -Wl,--execute-only).
2655a0747c9fSpatrick   //  - The PC is invalid and happens to point to unreadable or unmapped memory.
2656a0747c9fSpatrick   //
2657a0747c9fSpatrick   // [1] https://github.com/torvalds/linux/blob/master/arch/arm64/kernel/vdso/sigreturn.S
2658a0747c9fSpatrick   const pint_t pc = static_cast<pint_t>(this->getReg(UNW_REG_IP));
2659*202cdb0eSrobert   // The PC might contain an invalid address if the unwind info is bad, so
2660*202cdb0eSrobert   // directly accessing it could cause a segfault. Use process_vm_readv to read
2661*202cdb0eSrobert   // the memory safely instead. process_vm_readv was added in Linux 3.2, and
2662*202cdb0eSrobert   // AArch64 supported was added in Linux 3.7, so the syscall is guaranteed to
2663*202cdb0eSrobert   // be present. Unfortunately, there are Linux AArch64 environments where the
2664*202cdb0eSrobert   // libc wrapper for the syscall might not be present (e.g. Android 5), so call
2665*202cdb0eSrobert   // the syscall directly instead.
2666*202cdb0eSrobert   uint32_t instructions[2];
2667*202cdb0eSrobert   struct iovec local_iov = {&instructions, sizeof instructions};
2668*202cdb0eSrobert   struct iovec remote_iov = {reinterpret_cast<void *>(pc), sizeof instructions};
2669*202cdb0eSrobert   long bytesRead =
2670*202cdb0eSrobert       syscall(SYS_process_vm_readv, getpid(), &local_iov, 1, &remote_iov, 1, 0);
2671a0747c9fSpatrick   // Look for instructions: mov x8, #0x8b; svc #0x0
2672*202cdb0eSrobert   if (bytesRead != sizeof instructions || instructions[0] != 0xd2801168 ||
2673*202cdb0eSrobert       instructions[1] != 0xd4000001)
2674*202cdb0eSrobert     return false;
2675*202cdb0eSrobert 
2676a0747c9fSpatrick   _info = {};
2677*202cdb0eSrobert   _info.start_ip = pc;
2678*202cdb0eSrobert   _info.end_ip = pc + 4;
2679a0747c9fSpatrick   _isSigReturn = true;
2680a0747c9fSpatrick   return true;
2681a0747c9fSpatrick }
2682a0747c9fSpatrick 
2683a0747c9fSpatrick template <typename A, typename R>
stepThroughSigReturn(Registers_arm64 &)2684a0747c9fSpatrick int UnwindCursor<A, R>::stepThroughSigReturn(Registers_arm64 &) {
2685a0747c9fSpatrick   // In the signal trampoline frame, sp points to an rt_sigframe[1], which is:
2686a0747c9fSpatrick   //  - 128-byte siginfo struct
2687a0747c9fSpatrick   //  - ucontext struct:
2688a0747c9fSpatrick   //     - 8-byte long (uc_flags)
2689a0747c9fSpatrick   //     - 8-byte pointer (uc_link)
2690a0747c9fSpatrick   //     - 24-byte stack_t
2691a0747c9fSpatrick   //     - 128-byte signal set
2692a0747c9fSpatrick   //     - 8 bytes of padding because sigcontext has 16-byte alignment
2693a0747c9fSpatrick   //     - sigcontext/mcontext_t
2694a0747c9fSpatrick   // [1] https://github.com/torvalds/linux/blob/master/arch/arm64/kernel/signal.c
2695a0747c9fSpatrick   const pint_t kOffsetSpToSigcontext = (128 + 8 + 8 + 24 + 128 + 8); // 304
2696a0747c9fSpatrick 
2697a0747c9fSpatrick   // Offsets from sigcontext to each register.
2698a0747c9fSpatrick   const pint_t kOffsetGprs = 8; // offset to "__u64 regs[31]" field
2699a0747c9fSpatrick   const pint_t kOffsetSp = 256; // offset to "__u64 sp" field
2700a0747c9fSpatrick   const pint_t kOffsetPc = 264; // offset to "__u64 pc" field
2701a0747c9fSpatrick 
2702a0747c9fSpatrick   pint_t sigctx = _registers.getSP() + kOffsetSpToSigcontext;
2703a0747c9fSpatrick 
2704a0747c9fSpatrick   for (int i = 0; i <= 30; ++i) {
2705a0747c9fSpatrick     uint64_t value = _addressSpace.get64(sigctx + kOffsetGprs +
2706a0747c9fSpatrick                                          static_cast<pint_t>(i * 8));
2707*202cdb0eSrobert     _registers.setRegister(UNW_AARCH64_X0 + i, value);
2708a0747c9fSpatrick   }
2709a0747c9fSpatrick   _registers.setSP(_addressSpace.get64(sigctx + kOffsetSp));
2710a0747c9fSpatrick   _registers.setIP(_addressSpace.get64(sigctx + kOffsetPc));
2711a0747c9fSpatrick   _isSignalFrame = true;
2712a0747c9fSpatrick   return UNW_STEP_SUCCESS;
2713a0747c9fSpatrick }
2714*202cdb0eSrobert #endif // defined(_LIBUNWIND_CHECK_LINUX_SIGRETURN) &&
2715*202cdb0eSrobert        // defined(_LIBUNWIND_TARGET_AARCH64)
2716*202cdb0eSrobert 
2717*202cdb0eSrobert #if defined(_LIBUNWIND_CHECK_LINUX_SIGRETURN) &&                               \
2718*202cdb0eSrobert     defined(_LIBUNWIND_TARGET_S390X)
2719*202cdb0eSrobert template <typename A, typename R>
setInfoForSigReturn(Registers_s390x &)2720*202cdb0eSrobert bool UnwindCursor<A, R>::setInfoForSigReturn(Registers_s390x &) {
2721*202cdb0eSrobert   // Look for the sigreturn trampoline. The trampoline's body is a
2722*202cdb0eSrobert   // specific instruction (see below). Typically the trampoline comes from the
2723*202cdb0eSrobert   // vDSO (i.e. the __kernel_[rt_]sigreturn function). A libc might provide its
2724*202cdb0eSrobert   // own restorer function, though, or user-mode QEMU might write a trampoline
2725*202cdb0eSrobert   // onto the stack.
2726*202cdb0eSrobert   const pint_t pc = static_cast<pint_t>(this->getReg(UNW_REG_IP));
2727*202cdb0eSrobert   // The PC might contain an invalid address if the unwind info is bad, so
2728*202cdb0eSrobert   // directly accessing it could cause a segfault. Use process_vm_readv to
2729*202cdb0eSrobert   // read the memory safely instead.
2730*202cdb0eSrobert   uint16_t inst;
2731*202cdb0eSrobert   struct iovec local_iov = {&inst, sizeof inst};
2732*202cdb0eSrobert   struct iovec remote_iov = {reinterpret_cast<void *>(pc), sizeof inst};
2733*202cdb0eSrobert   long bytesRead = process_vm_readv(getpid(), &local_iov, 1, &remote_iov, 1, 0);
2734*202cdb0eSrobert   if (bytesRead == sizeof inst && (inst == 0x0a77 || inst == 0x0aad)) {
2735*202cdb0eSrobert     _info = {};
2736*202cdb0eSrobert     _info.start_ip = pc;
2737*202cdb0eSrobert     _info.end_ip = pc + 2;
2738*202cdb0eSrobert     _isSigReturn = true;
2739*202cdb0eSrobert     return true;
2740*202cdb0eSrobert   }
2741*202cdb0eSrobert   return false;
2742*202cdb0eSrobert }
2743a0747c9fSpatrick 
2744f6c50668Spatrick template <typename A, typename R>
stepThroughSigReturn(Registers_s390x &)2745*202cdb0eSrobert int UnwindCursor<A, R>::stepThroughSigReturn(Registers_s390x &) {
2746*202cdb0eSrobert   // Determine current SP.
2747*202cdb0eSrobert   const pint_t sp = static_cast<pint_t>(this->getReg(UNW_REG_SP));
2748*202cdb0eSrobert   // According to the s390x ABI, the CFA is at (incoming) SP + 160.
2749*202cdb0eSrobert   const pint_t cfa = sp + 160;
2750*202cdb0eSrobert 
2751*202cdb0eSrobert   // Determine current PC and instruction there (this must be either
2752*202cdb0eSrobert   // a "svc __NR_sigreturn" or "svc __NR_rt_sigreturn").
2753*202cdb0eSrobert   const pint_t pc = static_cast<pint_t>(this->getReg(UNW_REG_IP));
2754*202cdb0eSrobert   const uint16_t inst = _addressSpace.get16(pc);
2755*202cdb0eSrobert 
2756*202cdb0eSrobert   // Find the addresses of the signo and sigcontext in the frame.
2757*202cdb0eSrobert   pint_t pSigctx = 0;
2758*202cdb0eSrobert   pint_t pSigno = 0;
2759*202cdb0eSrobert 
2760*202cdb0eSrobert   // "svc __NR_sigreturn" uses a non-RT signal trampoline frame.
2761*202cdb0eSrobert   if (inst == 0x0a77) {
2762*202cdb0eSrobert     // Layout of a non-RT signal trampoline frame, starting at the CFA:
2763*202cdb0eSrobert     //  - 8-byte signal mask
2764*202cdb0eSrobert     //  - 8-byte pointer to sigcontext, followed by signo
2765*202cdb0eSrobert     //  - 4-byte signo
2766*202cdb0eSrobert     pSigctx = _addressSpace.get64(cfa + 8);
2767*202cdb0eSrobert     pSigno = pSigctx + 344;
2768*202cdb0eSrobert   }
2769*202cdb0eSrobert 
2770*202cdb0eSrobert   // "svc __NR_rt_sigreturn" uses a RT signal trampoline frame.
2771*202cdb0eSrobert   if (inst == 0x0aad) {
2772*202cdb0eSrobert     // Layout of a RT signal trampoline frame, starting at the CFA:
2773*202cdb0eSrobert     //  - 8-byte retcode (+ alignment)
2774*202cdb0eSrobert     //  - 128-byte siginfo struct (starts with signo)
2775*202cdb0eSrobert     //  - ucontext struct:
2776*202cdb0eSrobert     //     - 8-byte long (uc_flags)
2777*202cdb0eSrobert     //     - 8-byte pointer (uc_link)
2778*202cdb0eSrobert     //     - 24-byte stack_t
2779*202cdb0eSrobert     //     - 8 bytes of padding because sigcontext has 16-byte alignment
2780*202cdb0eSrobert     //     - sigcontext/mcontext_t
2781*202cdb0eSrobert     pSigctx = cfa + 8 + 128 + 8 + 8 + 24 + 8;
2782*202cdb0eSrobert     pSigno = cfa + 8;
2783*202cdb0eSrobert   }
2784*202cdb0eSrobert 
2785*202cdb0eSrobert   assert(pSigctx != 0);
2786*202cdb0eSrobert   assert(pSigno != 0);
2787*202cdb0eSrobert 
2788*202cdb0eSrobert   // Offsets from sigcontext to each register.
2789*202cdb0eSrobert   const pint_t kOffsetPc = 8;
2790*202cdb0eSrobert   const pint_t kOffsetGprs = 16;
2791*202cdb0eSrobert   const pint_t kOffsetFprs = 216;
2792*202cdb0eSrobert 
2793*202cdb0eSrobert   // Restore all registers.
2794*202cdb0eSrobert   for (int i = 0; i < 16; ++i) {
2795*202cdb0eSrobert     uint64_t value = _addressSpace.get64(pSigctx + kOffsetGprs +
2796*202cdb0eSrobert                                          static_cast<pint_t>(i * 8));
2797*202cdb0eSrobert     _registers.setRegister(UNW_S390X_R0 + i, value);
2798*202cdb0eSrobert   }
2799*202cdb0eSrobert   for (int i = 0; i < 16; ++i) {
2800*202cdb0eSrobert     static const int fpr[16] = {
2801*202cdb0eSrobert       UNW_S390X_F0, UNW_S390X_F1, UNW_S390X_F2, UNW_S390X_F3,
2802*202cdb0eSrobert       UNW_S390X_F4, UNW_S390X_F5, UNW_S390X_F6, UNW_S390X_F7,
2803*202cdb0eSrobert       UNW_S390X_F8, UNW_S390X_F9, UNW_S390X_F10, UNW_S390X_F11,
2804*202cdb0eSrobert       UNW_S390X_F12, UNW_S390X_F13, UNW_S390X_F14, UNW_S390X_F15
2805*202cdb0eSrobert     };
2806*202cdb0eSrobert     double value = _addressSpace.getDouble(pSigctx + kOffsetFprs +
2807*202cdb0eSrobert                                            static_cast<pint_t>(i * 8));
2808*202cdb0eSrobert     _registers.setFloatRegister(fpr[i], value);
2809*202cdb0eSrobert   }
2810*202cdb0eSrobert   _registers.setIP(_addressSpace.get64(pSigctx + kOffsetPc));
2811*202cdb0eSrobert 
2812*202cdb0eSrobert   // SIGILL, SIGFPE and SIGTRAP are delivered with psw_addr
2813*202cdb0eSrobert   // after the faulting instruction rather than before it.
2814*202cdb0eSrobert   // Do not set _isSignalFrame in that case.
2815*202cdb0eSrobert   uint32_t signo = _addressSpace.get32(pSigno);
2816*202cdb0eSrobert   _isSignalFrame = (signo != 4 && signo != 5 && signo != 8);
2817*202cdb0eSrobert 
2818*202cdb0eSrobert   return UNW_STEP_SUCCESS;
2819*202cdb0eSrobert }
2820*202cdb0eSrobert #endif // defined(_LIBUNWIND_CHECK_LINUX_SIGRETURN) &&
2821*202cdb0eSrobert        // defined(_LIBUNWIND_TARGET_S390X)
2822*202cdb0eSrobert 
step(bool stage2)2823*202cdb0eSrobert template <typename A, typename R> int UnwindCursor<A, R>::step(bool stage2) {
2824*202cdb0eSrobert   (void)stage2;
2825f6c50668Spatrick   // Bottom of stack is defined is when unwind info cannot be found.
2826f6c50668Spatrick   if (_unwindInfoMissing)
2827f6c50668Spatrick     return UNW_STEP_END;
2828f6c50668Spatrick 
2829f6c50668Spatrick   // Use unwinding info to modify register set as if function returned.
2830f6c50668Spatrick   int result;
2831*202cdb0eSrobert #if defined(_LIBUNWIND_CHECK_LINUX_SIGRETURN)
2832a0747c9fSpatrick   if (_isSigReturn) {
2833a0747c9fSpatrick     result = this->stepThroughSigReturn();
2834a0747c9fSpatrick   } else
2835a0747c9fSpatrick #endif
2836a0747c9fSpatrick   {
2837f6c50668Spatrick #if defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
2838*202cdb0eSrobert     result = this->stepWithCompactEncoding(stage2);
2839f6c50668Spatrick #elif defined(_LIBUNWIND_SUPPORT_SEH_UNWIND)
2840f6c50668Spatrick     result = this->stepWithSEHData();
2841*202cdb0eSrobert #elif defined(_LIBUNWIND_SUPPORT_TBTAB_UNWIND)
2842*202cdb0eSrobert     result = this->stepWithTBTableData();
2843f6c50668Spatrick #elif defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
2844*202cdb0eSrobert     result = this->stepWithDwarfFDE(stage2);
2845f6c50668Spatrick #elif defined(_LIBUNWIND_ARM_EHABI)
2846f6c50668Spatrick     result = this->stepWithEHABI();
2847f6c50668Spatrick #else
2848f6c50668Spatrick   #error Need _LIBUNWIND_SUPPORT_COMPACT_UNWIND or \
2849f6c50668Spatrick               _LIBUNWIND_SUPPORT_SEH_UNWIND or \
2850f6c50668Spatrick               _LIBUNWIND_SUPPORT_DWARF_UNWIND or \
2851f6c50668Spatrick               _LIBUNWIND_ARM_EHABI
2852f6c50668Spatrick #endif
2853a0747c9fSpatrick   }
2854f6c50668Spatrick 
2855f6c50668Spatrick   // update info based on new PC
2856f6c50668Spatrick   if (result == UNW_STEP_SUCCESS) {
2857f6c50668Spatrick     this->setInfoBasedOnIPRegister(true);
2858f6c50668Spatrick     if (_unwindInfoMissing)
2859f6c50668Spatrick       return UNW_STEP_END;
2860f6c50668Spatrick   }
2861f6c50668Spatrick 
2862f6c50668Spatrick   return result;
2863f6c50668Spatrick }
2864f6c50668Spatrick 
2865f6c50668Spatrick template <typename A, typename R>
getInfo(unw_proc_info_t * info)2866f6c50668Spatrick void UnwindCursor<A, R>::getInfo(unw_proc_info_t *info) {
2867f6c50668Spatrick   if (_unwindInfoMissing)
2868f6c50668Spatrick     memset(info, 0, sizeof(*info));
2869f6c50668Spatrick   else
2870f6c50668Spatrick     *info = _info;
2871f6c50668Spatrick }
2872f6c50668Spatrick 
2873f6c50668Spatrick template <typename A, typename R>
getFunctionName(char * buf,size_t bufLen,unw_word_t * offset)2874f6c50668Spatrick bool UnwindCursor<A, R>::getFunctionName(char *buf, size_t bufLen,
2875f6c50668Spatrick                                                            unw_word_t *offset) {
2876f6c50668Spatrick   return _addressSpace.findFunctionName((pint_t)this->getReg(UNW_REG_IP),
2877f6c50668Spatrick                                          buf, bufLen, offset);
2878f6c50668Spatrick }
2879f6c50668Spatrick 
2880*202cdb0eSrobert #if defined(_LIBUNWIND_USE_CET)
__libunwind_cet_get_registers(unw_cursor_t * cursor)2881*202cdb0eSrobert extern "C" void *__libunwind_cet_get_registers(unw_cursor_t *cursor) {
2882*202cdb0eSrobert   AbstractUnwindCursor *co = (AbstractUnwindCursor *)cursor;
2883*202cdb0eSrobert   return co->get_registers();
2884*202cdb0eSrobert }
2885*202cdb0eSrobert #endif
2886f6c50668Spatrick } // namespace libunwind
2887f6c50668Spatrick 
2888f6c50668Spatrick #endif // __UNWINDCURSOR_HPP__
2889