1 //===------------------------- UnwindCursor.hpp ---------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is dual licensed under the MIT and the University of Illinois Open
6 // Source Licenses. See LICENSE.TXT for details.
7 //
8 //
9 // C++ interface to lower levels of libunwind
10 //===----------------------------------------------------------------------===//
11 
12 #ifndef __UNWINDCURSOR_HPP__
13 #define __UNWINDCURSOR_HPP__
14 
15 #include <algorithm>
16 #include <stdint.h>
17 #include <stdio.h>
18 #include <stdlib.h>
19 #include <unwind.h>
20 
21 #ifdef __APPLE__
22   #include <mach-o/dyld.h>
23 #endif
24 
25 #include "config.h"
26 
27 #include "AddressSpace.hpp"
28 #include "CompactUnwinder.hpp"
29 #include "config.h"
30 #include "DwarfInstructions.hpp"
31 #include "EHHeaderParser.hpp"
32 #include "libunwind.h"
33 #include "Registers.hpp"
34 #include "RWMutex.hpp"
35 #include "Unwind-EHABI.h"
36 
37 namespace libunwind {
38 
39 #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
40 /// Cache of recently found FDEs.
41 template <typename A>
42 class _LIBUNWIND_HIDDEN DwarfFDECache {
43   typedef typename A::pint_t pint_t;
44 public:
45   static pint_t findFDE(pint_t mh, pint_t pc);
46   static void add(pint_t mh, pint_t ip_start, pint_t ip_end, pint_t fde);
47   static void removeAllIn(pint_t mh);
48   static void iterateCacheEntries(void (*func)(unw_word_t ip_start,
49                                                unw_word_t ip_end,
50                                                unw_word_t fde, unw_word_t mh));
51 
52 private:
53 
54   struct entry {
55     pint_t mh;
56     pint_t ip_start;
57     pint_t ip_end;
58     pint_t fde;
59   };
60 
61   // These fields are all static to avoid needing an initializer.
62   // There is only one instance of this class per process.
63   static RWMutex _lock;
64 #ifdef __APPLE__
65   static void dyldUnloadHook(const struct mach_header *mh, intptr_t slide);
66   static bool _registeredForDyldUnloads;
67 #endif
68   // Can't use std::vector<> here because this code is below libc++.
69   static entry *_buffer;
70   static entry *_bufferUsed;
71   static entry *_bufferEnd;
72   static entry _initialBuffer[64];
73 };
74 
75 template <typename A>
76 typename DwarfFDECache<A>::entry *
77 DwarfFDECache<A>::_buffer = _initialBuffer;
78 
79 template <typename A>
80 typename DwarfFDECache<A>::entry *
81 DwarfFDECache<A>::_bufferUsed = _initialBuffer;
82 
83 template <typename A>
84 typename DwarfFDECache<A>::entry *
85 DwarfFDECache<A>::_bufferEnd = &_initialBuffer[64];
86 
87 template <typename A>
88 typename DwarfFDECache<A>::entry DwarfFDECache<A>::_initialBuffer[64];
89 
90 template <typename A>
91 RWMutex DwarfFDECache<A>::_lock;
92 
93 #ifdef __APPLE__
94 template <typename A>
95 bool DwarfFDECache<A>::_registeredForDyldUnloads = false;
96 #endif
97 
98 template <typename A>
99 typename A::pint_t DwarfFDECache<A>::findFDE(pint_t mh, pint_t pc) {
100   pint_t result = 0;
101   _LIBUNWIND_LOG_IF_FALSE(_lock.lock_shared());
102   for (entry *p = _buffer; p < _bufferUsed; ++p) {
103     if ((mh == p->mh) || (mh == 0)) {
104       if ((p->ip_start <= pc) && (pc < p->ip_end)) {
105         result = p->fde;
106         break;
107       }
108     }
109   }
110   _LIBUNWIND_LOG_IF_FALSE(_lock.unlock_shared());
111   return result;
112 }
113 
114 template <typename A>
115 void DwarfFDECache<A>::add(pint_t mh, pint_t ip_start, pint_t ip_end,
116                            pint_t fde) {
117 #if !defined(_LIBUNWIND_NO_HEAP)
118   _LIBUNWIND_LOG_IF_FALSE(_lock.lock());
119   if (_bufferUsed >= _bufferEnd) {
120     size_t oldSize = (size_t)(_bufferEnd - _buffer);
121     size_t newSize = oldSize * 4;
122     // Can't use operator new (we are below it).
123     entry *newBuffer = (entry *)malloc(newSize * sizeof(entry));
124     memcpy(newBuffer, _buffer, oldSize * sizeof(entry));
125     if (_buffer != _initialBuffer)
126       free(_buffer);
127     _buffer = newBuffer;
128     _bufferUsed = &newBuffer[oldSize];
129     _bufferEnd = &newBuffer[newSize];
130   }
131   _bufferUsed->mh = mh;
132   _bufferUsed->ip_start = ip_start;
133   _bufferUsed->ip_end = ip_end;
134   _bufferUsed->fde = fde;
135   ++_bufferUsed;
136 #ifdef __APPLE__
137   if (!_registeredForDyldUnloads) {
138     _dyld_register_func_for_remove_image(&dyldUnloadHook);
139     _registeredForDyldUnloads = true;
140   }
141 #endif
142   _LIBUNWIND_LOG_IF_FALSE(_lock.unlock());
143 #endif
144 }
145 
146 template <typename A>
147 void DwarfFDECache<A>::removeAllIn(pint_t mh) {
148   _LIBUNWIND_LOG_IF_FALSE(_lock.lock());
149   entry *d = _buffer;
150   for (const entry *s = _buffer; s < _bufferUsed; ++s) {
151     if (s->mh != mh) {
152       if (d != s)
153         *d = *s;
154       ++d;
155     }
156   }
157   _bufferUsed = d;
158   _LIBUNWIND_LOG_IF_FALSE(_lock.unlock());
159 }
160 
161 #ifdef __APPLE__
162 template <typename A>
163 void DwarfFDECache<A>::dyldUnloadHook(const struct mach_header *mh, intptr_t ) {
164   removeAllIn((pint_t) mh);
165 }
166 #endif
167 
168 template <typename A>
169 void DwarfFDECache<A>::iterateCacheEntries(void (*func)(
170     unw_word_t ip_start, unw_word_t ip_end, unw_word_t fde, unw_word_t mh)) {
171   _LIBUNWIND_LOG_IF_FALSE(_lock.lock());
172   for (entry *p = _buffer; p < _bufferUsed; ++p) {
173     (*func)(p->ip_start, p->ip_end, p->fde, p->mh);
174   }
175   _LIBUNWIND_LOG_IF_FALSE(_lock.unlock());
176 }
177 #endif // defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
178 
179 
180 #define arrayoffsetof(type, index, field) ((size_t)(&((type *)0)[index].field))
181 
182 #if defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
183 template <typename A> class UnwindSectionHeader {
184 public:
185   UnwindSectionHeader(A &addressSpace, typename A::pint_t addr)
186       : _addressSpace(addressSpace), _addr(addr) {}
187 
188   uint32_t version() const {
189     return _addressSpace.get32(_addr +
190                                offsetof(unwind_info_section_header, version));
191   }
192   uint32_t commonEncodingsArraySectionOffset() const {
193     return _addressSpace.get32(_addr +
194                                offsetof(unwind_info_section_header,
195                                         commonEncodingsArraySectionOffset));
196   }
197   uint32_t commonEncodingsArrayCount() const {
198     return _addressSpace.get32(_addr + offsetof(unwind_info_section_header,
199                                                 commonEncodingsArrayCount));
200   }
201   uint32_t personalityArraySectionOffset() const {
202     return _addressSpace.get32(_addr + offsetof(unwind_info_section_header,
203                                                 personalityArraySectionOffset));
204   }
205   uint32_t personalityArrayCount() const {
206     return _addressSpace.get32(
207         _addr + offsetof(unwind_info_section_header, personalityArrayCount));
208   }
209   uint32_t indexSectionOffset() const {
210     return _addressSpace.get32(
211         _addr + offsetof(unwind_info_section_header, indexSectionOffset));
212   }
213   uint32_t indexCount() const {
214     return _addressSpace.get32(
215         _addr + offsetof(unwind_info_section_header, indexCount));
216   }
217 
218 private:
219   A                     &_addressSpace;
220   typename A::pint_t     _addr;
221 };
222 
223 template <typename A> class UnwindSectionIndexArray {
224 public:
225   UnwindSectionIndexArray(A &addressSpace, typename A::pint_t addr)
226       : _addressSpace(addressSpace), _addr(addr) {}
227 
228   uint32_t functionOffset(uint32_t index) const {
229     return _addressSpace.get32(
230         _addr + arrayoffsetof(unwind_info_section_header_index_entry, index,
231                               functionOffset));
232   }
233   uint32_t secondLevelPagesSectionOffset(uint32_t index) const {
234     return _addressSpace.get32(
235         _addr + arrayoffsetof(unwind_info_section_header_index_entry, index,
236                               secondLevelPagesSectionOffset));
237   }
238   uint32_t lsdaIndexArraySectionOffset(uint32_t index) const {
239     return _addressSpace.get32(
240         _addr + arrayoffsetof(unwind_info_section_header_index_entry, index,
241                               lsdaIndexArraySectionOffset));
242   }
243 
244 private:
245   A                   &_addressSpace;
246   typename A::pint_t   _addr;
247 };
248 
249 template <typename A> class UnwindSectionRegularPageHeader {
250 public:
251   UnwindSectionRegularPageHeader(A &addressSpace, typename A::pint_t addr)
252       : _addressSpace(addressSpace), _addr(addr) {}
253 
254   uint32_t kind() const {
255     return _addressSpace.get32(
256         _addr + offsetof(unwind_info_regular_second_level_page_header, kind));
257   }
258   uint16_t entryPageOffset() const {
259     return _addressSpace.get16(
260         _addr + offsetof(unwind_info_regular_second_level_page_header,
261                          entryPageOffset));
262   }
263   uint16_t entryCount() const {
264     return _addressSpace.get16(
265         _addr +
266         offsetof(unwind_info_regular_second_level_page_header, entryCount));
267   }
268 
269 private:
270   A &_addressSpace;
271   typename A::pint_t _addr;
272 };
273 
274 template <typename A> class UnwindSectionRegularArray {
275 public:
276   UnwindSectionRegularArray(A &addressSpace, typename A::pint_t addr)
277       : _addressSpace(addressSpace), _addr(addr) {}
278 
279   uint32_t functionOffset(uint32_t index) const {
280     return _addressSpace.get32(
281         _addr + arrayoffsetof(unwind_info_regular_second_level_entry, index,
282                               functionOffset));
283   }
284   uint32_t encoding(uint32_t index) const {
285     return _addressSpace.get32(
286         _addr +
287         arrayoffsetof(unwind_info_regular_second_level_entry, index, encoding));
288   }
289 
290 private:
291   A &_addressSpace;
292   typename A::pint_t _addr;
293 };
294 
295 template <typename A> class UnwindSectionCompressedPageHeader {
296 public:
297   UnwindSectionCompressedPageHeader(A &addressSpace, typename A::pint_t addr)
298       : _addressSpace(addressSpace), _addr(addr) {}
299 
300   uint32_t kind() const {
301     return _addressSpace.get32(
302         _addr +
303         offsetof(unwind_info_compressed_second_level_page_header, kind));
304   }
305   uint16_t entryPageOffset() const {
306     return _addressSpace.get16(
307         _addr + offsetof(unwind_info_compressed_second_level_page_header,
308                          entryPageOffset));
309   }
310   uint16_t entryCount() const {
311     return _addressSpace.get16(
312         _addr +
313         offsetof(unwind_info_compressed_second_level_page_header, entryCount));
314   }
315   uint16_t encodingsPageOffset() const {
316     return _addressSpace.get16(
317         _addr + offsetof(unwind_info_compressed_second_level_page_header,
318                          encodingsPageOffset));
319   }
320   uint16_t encodingsCount() const {
321     return _addressSpace.get16(
322         _addr + offsetof(unwind_info_compressed_second_level_page_header,
323                          encodingsCount));
324   }
325 
326 private:
327   A &_addressSpace;
328   typename A::pint_t _addr;
329 };
330 
331 template <typename A> class UnwindSectionCompressedArray {
332 public:
333   UnwindSectionCompressedArray(A &addressSpace, typename A::pint_t addr)
334       : _addressSpace(addressSpace), _addr(addr) {}
335 
336   uint32_t functionOffset(uint32_t index) const {
337     return UNWIND_INFO_COMPRESSED_ENTRY_FUNC_OFFSET(
338         _addressSpace.get32(_addr + index * sizeof(uint32_t)));
339   }
340   uint16_t encodingIndex(uint32_t index) const {
341     return UNWIND_INFO_COMPRESSED_ENTRY_ENCODING_INDEX(
342         _addressSpace.get32(_addr + index * sizeof(uint32_t)));
343   }
344 
345 private:
346   A &_addressSpace;
347   typename A::pint_t _addr;
348 };
349 
350 template <typename A> class UnwindSectionLsdaArray {
351 public:
352   UnwindSectionLsdaArray(A &addressSpace, typename A::pint_t addr)
353       : _addressSpace(addressSpace), _addr(addr) {}
354 
355   uint32_t functionOffset(uint32_t index) const {
356     return _addressSpace.get32(
357         _addr + arrayoffsetof(unwind_info_section_header_lsda_index_entry,
358                               index, functionOffset));
359   }
360   uint32_t lsdaOffset(uint32_t index) const {
361     return _addressSpace.get32(
362         _addr + arrayoffsetof(unwind_info_section_header_lsda_index_entry,
363                               index, lsdaOffset));
364   }
365 
366 private:
367   A                   &_addressSpace;
368   typename A::pint_t   _addr;
369 };
370 #endif // defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
371 
372 class _LIBUNWIND_HIDDEN AbstractUnwindCursor {
373 public:
374   // NOTE: provide a class specific placement deallocation function (S5.3.4 p20)
375   // This avoids an unnecessary dependency to libc++abi.
376   void operator delete(void *, size_t) {}
377 
378   virtual ~AbstractUnwindCursor() {}
379   virtual bool validReg(int) { _LIBUNWIND_ABORT("validReg not implemented"); }
380   virtual unw_word_t getReg(int) { _LIBUNWIND_ABORT("getReg not implemented"); }
381   virtual void setReg(int, unw_word_t) {
382     _LIBUNWIND_ABORT("setReg not implemented");
383   }
384   virtual bool validFloatReg(int) {
385     _LIBUNWIND_ABORT("validFloatReg not implemented");
386   }
387   virtual unw_fpreg_t getFloatReg(int) {
388     _LIBUNWIND_ABORT("getFloatReg not implemented");
389   }
390   virtual void setFloatReg(int, unw_fpreg_t) {
391     _LIBUNWIND_ABORT("setFloatReg not implemented");
392   }
393   virtual int step() { _LIBUNWIND_ABORT("step not implemented"); }
394   virtual void getInfo(unw_proc_info_t *) {
395     _LIBUNWIND_ABORT("getInfo not implemented");
396   }
397   virtual void jumpto() { _LIBUNWIND_ABORT("jumpto not implemented"); }
398   virtual bool isSignalFrame() {
399     _LIBUNWIND_ABORT("isSignalFrame not implemented");
400   }
401   virtual bool getFunctionName(char *, size_t, unw_word_t *) {
402     _LIBUNWIND_ABORT("getFunctionName not implemented");
403   }
404   virtual void setInfoBasedOnIPRegister(bool = false) {
405     _LIBUNWIND_ABORT("setInfoBasedOnIPRegister not implemented");
406   }
407   virtual const char *getRegisterName(int) {
408     _LIBUNWIND_ABORT("getRegisterName not implemented");
409   }
410 #ifdef __arm__
411   virtual void saveVFPAsX() { _LIBUNWIND_ABORT("saveVFPAsX not implemented"); }
412 #endif
413 };
414 
415 /// UnwindCursor contains all state (including all register values) during
416 /// an unwind.  This is normally stack allocated inside a unw_cursor_t.
417 template <typename A, typename R>
418 class UnwindCursor : public AbstractUnwindCursor{
419   typedef typename A::pint_t pint_t;
420 public:
421                       UnwindCursor(unw_context_t *context, A &as);
422                       UnwindCursor(A &as, void *threadArg);
423   virtual             ~UnwindCursor() {}
424   virtual bool        validReg(int);
425   virtual unw_word_t  getReg(int);
426   virtual void        setReg(int, unw_word_t);
427   virtual bool        validFloatReg(int);
428   virtual unw_fpreg_t getFloatReg(int);
429   virtual void        setFloatReg(int, unw_fpreg_t);
430   virtual int         step();
431   virtual void        getInfo(unw_proc_info_t *);
432   virtual void        jumpto();
433   virtual bool        isSignalFrame();
434   virtual bool        getFunctionName(char *buf, size_t len, unw_word_t *off);
435   virtual void        setInfoBasedOnIPRegister(bool isReturnAddress = false);
436   virtual const char *getRegisterName(int num);
437 #ifdef __arm__
438   virtual void        saveVFPAsX();
439 #endif
440 
441 private:
442 
443 #if defined(_LIBUNWIND_ARM_EHABI)
444   bool getInfoFromEHABISection(pint_t pc, const UnwindInfoSections &sects);
445 
446   int stepWithEHABI() {
447     size_t len = 0;
448     size_t off = 0;
449     // FIXME: Calling decode_eht_entry() here is violating the libunwind
450     // abstraction layer.
451     const uint32_t *ehtp =
452         decode_eht_entry(reinterpret_cast<const uint32_t *>(_info.unwind_info),
453                          &off, &len);
454     if (_Unwind_VRS_Interpret((_Unwind_Context *)this, ehtp, off, len) !=
455             _URC_CONTINUE_UNWIND)
456       return UNW_STEP_END;
457     return UNW_STEP_SUCCESS;
458   }
459 #endif
460 
461 #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
462   bool getInfoFromDwarfSection(pint_t pc, const UnwindInfoSections &sects,
463                                             uint32_t fdeSectionOffsetHint=0);
464   int stepWithDwarfFDE() {
465     return DwarfInstructions<A, R>::stepWithDwarf(_addressSpace,
466                                               (pint_t)this->getReg(UNW_REG_IP),
467                                               (pint_t)_info.unwind_info,
468                                               _registers);
469   }
470 #endif
471 
472 #if defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
473   bool getInfoFromCompactEncodingSection(pint_t pc,
474                                             const UnwindInfoSections &sects);
475   int stepWithCompactEncoding() {
476   #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
477     if ( compactSaysUseDwarf() )
478       return stepWithDwarfFDE();
479   #endif
480     R dummy;
481     return stepWithCompactEncoding(dummy);
482   }
483 
484 #if defined(_LIBUNWIND_TARGET_X86_64)
485   int stepWithCompactEncoding(Registers_x86_64 &) {
486     return CompactUnwinder_x86_64<A>::stepWithCompactEncoding(
487         _info.format, _info.start_ip, _addressSpace, _registers);
488   }
489 #endif
490 
491 #if defined(_LIBUNWIND_TARGET_I386)
492   int stepWithCompactEncoding(Registers_x86 &) {
493     return CompactUnwinder_x86<A>::stepWithCompactEncoding(
494         _info.format, (uint32_t)_info.start_ip, _addressSpace, _registers);
495   }
496 #endif
497 
498 #if defined(_LIBUNWIND_TARGET_PPC)
499   int stepWithCompactEncoding(Registers_ppc &) {
500     return UNW_EINVAL;
501   }
502 #endif
503 
504 #if defined(_LIBUNWIND_TARGET_AARCH64)
505   int stepWithCompactEncoding(Registers_arm64 &) {
506     return CompactUnwinder_arm64<A>::stepWithCompactEncoding(
507         _info.format, _info.start_ip, _addressSpace, _registers);
508   }
509 #endif
510 
511   bool compactSaysUseDwarf(uint32_t *offset=NULL) const {
512     R dummy;
513     return compactSaysUseDwarf(dummy, offset);
514   }
515 
516 #if defined(_LIBUNWIND_TARGET_X86_64)
517   bool compactSaysUseDwarf(Registers_x86_64 &, uint32_t *offset) const {
518     if ((_info.format & UNWIND_X86_64_MODE_MASK) == UNWIND_X86_64_MODE_DWARF) {
519       if (offset)
520         *offset = (_info.format & UNWIND_X86_64_DWARF_SECTION_OFFSET);
521       return true;
522     }
523     return false;
524   }
525 #endif
526 
527 #if defined(_LIBUNWIND_TARGET_I386)
528   bool compactSaysUseDwarf(Registers_x86 &, uint32_t *offset) const {
529     if ((_info.format & UNWIND_X86_MODE_MASK) == UNWIND_X86_MODE_DWARF) {
530       if (offset)
531         *offset = (_info.format & UNWIND_X86_DWARF_SECTION_OFFSET);
532       return true;
533     }
534     return false;
535   }
536 #endif
537 
538 #if defined(_LIBUNWIND_TARGET_PPC)
539   bool compactSaysUseDwarf(Registers_ppc &, uint32_t *) const {
540     return true;
541   }
542 #endif
543 
544 #if defined(_LIBUNWIND_TARGET_AARCH64)
545   bool compactSaysUseDwarf(Registers_arm64 &, uint32_t *offset) const {
546     if ((_info.format & UNWIND_ARM64_MODE_MASK) == UNWIND_ARM64_MODE_DWARF) {
547       if (offset)
548         *offset = (_info.format & UNWIND_ARM64_DWARF_SECTION_OFFSET);
549       return true;
550     }
551     return false;
552   }
553 #endif
554 #endif // defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
555 
556 #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
557   compact_unwind_encoding_t dwarfEncoding() const {
558     R dummy;
559     return dwarfEncoding(dummy);
560   }
561 
562 #if defined(_LIBUNWIND_TARGET_X86_64)
563   compact_unwind_encoding_t dwarfEncoding(Registers_x86_64 &) const {
564     return UNWIND_X86_64_MODE_DWARF;
565   }
566 #endif
567 
568 #if defined(_LIBUNWIND_TARGET_I386)
569   compact_unwind_encoding_t dwarfEncoding(Registers_x86 &) const {
570     return UNWIND_X86_MODE_DWARF;
571   }
572 #endif
573 
574 #if defined(_LIBUNWIND_TARGET_PPC)
575   compact_unwind_encoding_t dwarfEncoding(Registers_ppc &) const {
576     return 0;
577   }
578 #endif
579 
580 #if defined(_LIBUNWIND_TARGET_AARCH64)
581   compact_unwind_encoding_t dwarfEncoding(Registers_arm64 &) const {
582     return UNWIND_ARM64_MODE_DWARF;
583   }
584 #endif
585 
586 #if defined(_LIBUNWIND_TARGET_ARM)
587   compact_unwind_encoding_t dwarfEncoding(Registers_arm &) const {
588     return 0;
589   }
590 #endif
591 
592 #if defined (_LIBUNWIND_TARGET_OR1K)
593   compact_unwind_encoding_t dwarfEncoding(Registers_or1k &) const {
594     return 0;
595   }
596 #endif
597 #endif // defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
598 
599 
600   A               &_addressSpace;
601   R                _registers;
602   unw_proc_info_t  _info;
603   bool             _unwindInfoMissing;
604   bool             _isSignalFrame;
605 };
606 
607 
608 template <typename A, typename R>
609 UnwindCursor<A, R>::UnwindCursor(unw_context_t *context, A &as)
610     : _addressSpace(as), _registers(context), _unwindInfoMissing(false),
611       _isSignalFrame(false) {
612   static_assert((check_fit<UnwindCursor<A, R>, unw_cursor_t>::does_fit),
613                 "UnwindCursor<> does not fit in unw_cursor_t");
614   memset(&_info, 0, sizeof(_info));
615 }
616 
617 template <typename A, typename R>
618 UnwindCursor<A, R>::UnwindCursor(A &as, void *)
619     : _addressSpace(as), _unwindInfoMissing(false), _isSignalFrame(false) {
620   memset(&_info, 0, sizeof(_info));
621   // FIXME
622   // fill in _registers from thread arg
623 }
624 
625 
626 template <typename A, typename R>
627 bool UnwindCursor<A, R>::validReg(int regNum) {
628   return _registers.validRegister(regNum);
629 }
630 
631 template <typename A, typename R>
632 unw_word_t UnwindCursor<A, R>::getReg(int regNum) {
633   return _registers.getRegister(regNum);
634 }
635 
636 template <typename A, typename R>
637 void UnwindCursor<A, R>::setReg(int regNum, unw_word_t value) {
638   _registers.setRegister(regNum, (typename A::pint_t)value);
639 }
640 
641 template <typename A, typename R>
642 bool UnwindCursor<A, R>::validFloatReg(int regNum) {
643   return _registers.validFloatRegister(regNum);
644 }
645 
646 template <typename A, typename R>
647 unw_fpreg_t UnwindCursor<A, R>::getFloatReg(int regNum) {
648   return _registers.getFloatRegister(regNum);
649 }
650 
651 template <typename A, typename R>
652 void UnwindCursor<A, R>::setFloatReg(int regNum, unw_fpreg_t value) {
653   _registers.setFloatRegister(regNum, value);
654 }
655 
656 template <typename A, typename R> void UnwindCursor<A, R>::jumpto() {
657   _registers.jumpto();
658 }
659 
660 #ifdef __arm__
661 template <typename A, typename R> void UnwindCursor<A, R>::saveVFPAsX() {
662   _registers.saveVFPAsX();
663 }
664 #endif
665 
666 template <typename A, typename R>
667 const char *UnwindCursor<A, R>::getRegisterName(int regNum) {
668   return _registers.getRegisterName(regNum);
669 }
670 
671 template <typename A, typename R> bool UnwindCursor<A, R>::isSignalFrame() {
672   return _isSignalFrame;
673 }
674 
675 #if defined(_LIBUNWIND_ARM_EHABI)
676 struct EHABIIndexEntry {
677   uint32_t functionOffset;
678   uint32_t data;
679 };
680 
681 template<typename A>
682 struct EHABISectionIterator {
683   typedef EHABISectionIterator _Self;
684 
685   typedef std::random_access_iterator_tag iterator_category;
686   typedef typename A::pint_t value_type;
687   typedef typename A::pint_t* pointer;
688   typedef typename A::pint_t& reference;
689   typedef size_t size_type;
690   typedef size_t difference_type;
691 
692   static _Self begin(A& addressSpace, const UnwindInfoSections& sects) {
693     return _Self(addressSpace, sects, 0);
694   }
695   static _Self end(A& addressSpace, const UnwindInfoSections& sects) {
696     return _Self(addressSpace, sects,
697                  sects.arm_section_length / sizeof(EHABIIndexEntry));
698   }
699 
700   EHABISectionIterator(A& addressSpace, const UnwindInfoSections& sects, size_t i)
701       : _i(i), _addressSpace(&addressSpace), _sects(&sects) {}
702 
703   _Self& operator++() { ++_i; return *this; }
704   _Self& operator+=(size_t a) { _i += a; return *this; }
705   _Self& operator--() { assert(_i > 0); --_i; return *this; }
706   _Self& operator-=(size_t a) { assert(_i >= a); _i -= a; return *this; }
707 
708   _Self operator+(size_t a) { _Self out = *this; out._i += a; return out; }
709   _Self operator-(size_t a) { assert(_i >= a); _Self out = *this; out._i -= a; return out; }
710 
711   size_t operator-(const _Self& other) { return _i - other._i; }
712 
713   bool operator==(const _Self& other) const {
714     assert(_addressSpace == other._addressSpace);
715     assert(_sects == other._sects);
716     return _i == other._i;
717   }
718 
719   typename A::pint_t operator*() const { return functionAddress(); }
720 
721   typename A::pint_t functionAddress() const {
722     typename A::pint_t indexAddr = _sects->arm_section + arrayoffsetof(
723         EHABIIndexEntry, _i, functionOffset);
724     return indexAddr + signExtendPrel31(_addressSpace->get32(indexAddr));
725   }
726 
727   typename A::pint_t dataAddress() {
728     typename A::pint_t indexAddr = _sects->arm_section + arrayoffsetof(
729         EHABIIndexEntry, _i, data);
730     return indexAddr;
731   }
732 
733  private:
734   size_t _i;
735   A* _addressSpace;
736   const UnwindInfoSections* _sects;
737 };
738 
739 template <typename A, typename R>
740 bool UnwindCursor<A, R>::getInfoFromEHABISection(
741     pint_t pc,
742     const UnwindInfoSections &sects) {
743   EHABISectionIterator<A> begin =
744       EHABISectionIterator<A>::begin(_addressSpace, sects);
745   EHABISectionIterator<A> end =
746       EHABISectionIterator<A>::end(_addressSpace, sects);
747   if (begin == end)
748     return false;
749 
750   EHABISectionIterator<A> itNextPC = std::upper_bound(begin, end, pc);
751   if (itNextPC == begin)
752     return false;
753   EHABISectionIterator<A> itThisPC = itNextPC - 1;
754 
755   pint_t thisPC = itThisPC.functionAddress();
756   // If an exception is thrown from a function, corresponding to the last entry
757   // in the table, we don't really know the function extent and have to choose a
758   // value for nextPC. Choosing max() will allow the range check during trace to
759   // succeed.
760   pint_t nextPC = (itNextPC == end) ? std::numeric_limits<pint_t>::max()
761                                     : itNextPC.functionAddress();
762   pint_t indexDataAddr = itThisPC.dataAddress();
763 
764   if (indexDataAddr == 0)
765     return false;
766 
767   uint32_t indexData = _addressSpace.get32(indexDataAddr);
768   if (indexData == UNW_EXIDX_CANTUNWIND)
769     return false;
770 
771   // If the high bit is set, the exception handling table entry is inline inside
772   // the index table entry on the second word (aka |indexDataAddr|). Otherwise,
773   // the table points at an offset in the exception handling table (section 5 EHABI).
774   pint_t exceptionTableAddr;
775   uint32_t exceptionTableData;
776   bool isSingleWordEHT;
777   if (indexData & 0x80000000) {
778     exceptionTableAddr = indexDataAddr;
779     // TODO(ajwong): Should this data be 0?
780     exceptionTableData = indexData;
781     isSingleWordEHT = true;
782   } else {
783     exceptionTableAddr = indexDataAddr + signExtendPrel31(indexData);
784     exceptionTableData = _addressSpace.get32(exceptionTableAddr);
785     isSingleWordEHT = false;
786   }
787 
788   // Now we know the 3 things:
789   //   exceptionTableAddr -- exception handler table entry.
790   //   exceptionTableData -- the data inside the first word of the eht entry.
791   //   isSingleWordEHT -- whether the entry is in the index.
792   unw_word_t personalityRoutine = 0xbadf00d;
793   bool scope32 = false;
794   uintptr_t lsda;
795 
796   // If the high bit in the exception handling table entry is set, the entry is
797   // in compact form (section 6.3 EHABI).
798   if (exceptionTableData & 0x80000000) {
799     // Grab the index of the personality routine from the compact form.
800     uint32_t choice = (exceptionTableData & 0x0f000000) >> 24;
801     uint32_t extraWords = 0;
802     switch (choice) {
803       case 0:
804         personalityRoutine = (unw_word_t) &__aeabi_unwind_cpp_pr0;
805         extraWords = 0;
806         scope32 = false;
807         lsda = isSingleWordEHT ? 0 : (exceptionTableAddr + 4);
808         break;
809       case 1:
810         personalityRoutine = (unw_word_t) &__aeabi_unwind_cpp_pr1;
811         extraWords = (exceptionTableData & 0x00ff0000) >> 16;
812         scope32 = false;
813         lsda = exceptionTableAddr + (extraWords + 1) * 4;
814         break;
815       case 2:
816         personalityRoutine = (unw_word_t) &__aeabi_unwind_cpp_pr2;
817         extraWords = (exceptionTableData & 0x00ff0000) >> 16;
818         scope32 = true;
819         lsda = exceptionTableAddr + (extraWords + 1) * 4;
820         break;
821       default:
822         _LIBUNWIND_ABORT("unknown personality routine");
823         return false;
824     }
825 
826     if (isSingleWordEHT) {
827       if (extraWords != 0) {
828         _LIBUNWIND_ABORT("index inlined table detected but pr function "
829                          "requires extra words");
830         return false;
831       }
832     }
833   } else {
834     pint_t personalityAddr =
835         exceptionTableAddr + signExtendPrel31(exceptionTableData);
836     personalityRoutine = personalityAddr;
837 
838     // ARM EHABI # 6.2, # 9.2
839     //
840     //  +---- ehtp
841     //  v
842     // +--------------------------------------+
843     // | +--------+--------+--------+-------+ |
844     // | |0| prel31 to personalityRoutine   | |
845     // | +--------+--------+--------+-------+ |
846     // | |      N |      unwind opcodes     | |  <-- UnwindData
847     // | +--------+--------+--------+-------+ |
848     // | | Word 2        unwind opcodes     | |
849     // | +--------+--------+--------+-------+ |
850     // | ...                                  |
851     // | +--------+--------+--------+-------+ |
852     // | | Word N        unwind opcodes     | |
853     // | +--------+--------+--------+-------+ |
854     // | | LSDA                             | |  <-- lsda
855     // | | ...                              | |
856     // | +--------+--------+--------+-------+ |
857     // +--------------------------------------+
858 
859     uint32_t *UnwindData = reinterpret_cast<uint32_t*>(exceptionTableAddr) + 1;
860     uint32_t FirstDataWord = *UnwindData;
861     size_t N = ((FirstDataWord >> 24) & 0xff);
862     size_t NDataWords = N + 1;
863     lsda = reinterpret_cast<uintptr_t>(UnwindData + NDataWords);
864   }
865 
866   _info.start_ip = thisPC;
867   _info.end_ip = nextPC;
868   _info.handler = personalityRoutine;
869   _info.unwind_info = exceptionTableAddr;
870   _info.lsda = lsda;
871   // flags is pr_cache.additional. See EHABI #7.2 for definition of bit 0.
872   _info.flags = isSingleWordEHT ? 1 : 0 | scope32 ? 0x2 : 0;  // Use enum?
873 
874   return true;
875 }
876 #endif
877 
878 #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
879 template <typename A, typename R>
880 bool UnwindCursor<A, R>::getInfoFromDwarfSection(pint_t pc,
881                                                 const UnwindInfoSections &sects,
882                                                 uint32_t fdeSectionOffsetHint) {
883   typename CFI_Parser<A>::FDE_Info fdeInfo;
884   typename CFI_Parser<A>::CIE_Info cieInfo;
885   bool foundFDE = false;
886   bool foundInCache = false;
887   // If compact encoding table gave offset into dwarf section, go directly there
888   if (fdeSectionOffsetHint != 0) {
889     foundFDE = CFI_Parser<A>::findFDE(_addressSpace, pc, sects.dwarf_section,
890                                     (uint32_t)sects.dwarf_section_length,
891                                     sects.dwarf_section + fdeSectionOffsetHint,
892                                     &fdeInfo, &cieInfo);
893   }
894 #if defined(_LIBUNWIND_SUPPORT_DWARF_INDEX)
895   if (!foundFDE && (sects.dwarf_index_section != 0)) {
896     foundFDE = EHHeaderParser<A>::findFDE(
897         _addressSpace, pc, sects.dwarf_index_section,
898         (uint32_t)sects.dwarf_index_section_length, &fdeInfo, &cieInfo);
899   }
900 #endif
901   if (!foundFDE) {
902     // otherwise, search cache of previously found FDEs.
903     pint_t cachedFDE = DwarfFDECache<A>::findFDE(sects.dso_base, pc);
904     if (cachedFDE != 0) {
905       foundFDE =
906           CFI_Parser<A>::findFDE(_addressSpace, pc, sects.dwarf_section,
907                                  (uint32_t)sects.dwarf_section_length,
908                                  cachedFDE, &fdeInfo, &cieInfo);
909       foundInCache = foundFDE;
910     }
911   }
912   if (!foundFDE) {
913     // Still not found, do full scan of __eh_frame section.
914     foundFDE = CFI_Parser<A>::findFDE(_addressSpace, pc, sects.dwarf_section,
915                                       (uint32_t)sects.dwarf_section_length, 0,
916                                       &fdeInfo, &cieInfo);
917   }
918   if (foundFDE) {
919     typename CFI_Parser<A>::PrologInfo prolog;
920     if (CFI_Parser<A>::parseFDEInstructions(_addressSpace, fdeInfo, cieInfo, pc,
921                                             &prolog)) {
922       // Save off parsed FDE info
923       _info.start_ip          = fdeInfo.pcStart;
924       _info.end_ip            = fdeInfo.pcEnd;
925       _info.lsda              = fdeInfo.lsda;
926       _info.handler           = cieInfo.personality;
927       _info.gp                = prolog.spExtraArgSize;
928       _info.flags             = 0;
929       _info.format            = dwarfEncoding();
930       _info.unwind_info       = fdeInfo.fdeStart;
931       _info.unwind_info_size  = (uint32_t)fdeInfo.fdeLength;
932       _info.extra             = (unw_word_t) sects.dso_base;
933 
934       // Add to cache (to make next lookup faster) if we had no hint
935       // and there was no index.
936       if (!foundInCache && (fdeSectionOffsetHint == 0)) {
937   #if defined(_LIBUNWIND_SUPPORT_DWARF_INDEX)
938         if (sects.dwarf_index_section == 0)
939   #endif
940         DwarfFDECache<A>::add(sects.dso_base, fdeInfo.pcStart, fdeInfo.pcEnd,
941                               fdeInfo.fdeStart);
942       }
943       return true;
944     }
945   }
946   //_LIBUNWIND_DEBUG_LOG("can't find/use FDE for pc=0x%llX", (uint64_t)pc);
947   return false;
948 }
949 #endif // defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
950 
951 
952 #if defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
953 template <typename A, typename R>
954 bool UnwindCursor<A, R>::getInfoFromCompactEncodingSection(pint_t pc,
955                                               const UnwindInfoSections &sects) {
956   const bool log = false;
957   if (log)
958     fprintf(stderr, "getInfoFromCompactEncodingSection(pc=0x%llX, mh=0x%llX)\n",
959             (uint64_t)pc, (uint64_t)sects.dso_base);
960 
961   const UnwindSectionHeader<A> sectionHeader(_addressSpace,
962                                                 sects.compact_unwind_section);
963   if (sectionHeader.version() != UNWIND_SECTION_VERSION)
964     return false;
965 
966   // do a binary search of top level index to find page with unwind info
967   pint_t targetFunctionOffset = pc - sects.dso_base;
968   const UnwindSectionIndexArray<A> topIndex(_addressSpace,
969                                            sects.compact_unwind_section
970                                          + sectionHeader.indexSectionOffset());
971   uint32_t low = 0;
972   uint32_t high = sectionHeader.indexCount();
973   uint32_t last = high - 1;
974   while (low < high) {
975     uint32_t mid = (low + high) / 2;
976     //if ( log ) fprintf(stderr, "\tmid=%d, low=%d, high=%d, *mid=0x%08X\n",
977     //mid, low, high, topIndex.functionOffset(mid));
978     if (topIndex.functionOffset(mid) <= targetFunctionOffset) {
979       if ((mid == last) ||
980           (topIndex.functionOffset(mid + 1) > targetFunctionOffset)) {
981         low = mid;
982         break;
983       } else {
984         low = mid + 1;
985       }
986     } else {
987       high = mid;
988     }
989   }
990   const uint32_t firstLevelFunctionOffset = topIndex.functionOffset(low);
991   const uint32_t firstLevelNextPageFunctionOffset =
992       topIndex.functionOffset(low + 1);
993   const pint_t secondLevelAddr =
994       sects.compact_unwind_section + topIndex.secondLevelPagesSectionOffset(low);
995   const pint_t lsdaArrayStartAddr =
996       sects.compact_unwind_section + topIndex.lsdaIndexArraySectionOffset(low);
997   const pint_t lsdaArrayEndAddr =
998       sects.compact_unwind_section + topIndex.lsdaIndexArraySectionOffset(low+1);
999   if (log)
1000     fprintf(stderr, "\tfirst level search for result index=%d "
1001                     "to secondLevelAddr=0x%llX\n",
1002                     low, (uint64_t) secondLevelAddr);
1003   // do a binary search of second level page index
1004   uint32_t encoding = 0;
1005   pint_t funcStart = 0;
1006   pint_t funcEnd = 0;
1007   pint_t lsda = 0;
1008   pint_t personality = 0;
1009   uint32_t pageKind = _addressSpace.get32(secondLevelAddr);
1010   if (pageKind == UNWIND_SECOND_LEVEL_REGULAR) {
1011     // regular page
1012     UnwindSectionRegularPageHeader<A> pageHeader(_addressSpace,
1013                                                  secondLevelAddr);
1014     UnwindSectionRegularArray<A> pageIndex(
1015         _addressSpace, secondLevelAddr + pageHeader.entryPageOffset());
1016     // binary search looks for entry with e where index[e].offset <= pc <
1017     // index[e+1].offset
1018     if (log)
1019       fprintf(stderr, "\tbinary search for targetFunctionOffset=0x%08llX in "
1020                       "regular page starting at secondLevelAddr=0x%llX\n",
1021               (uint64_t) targetFunctionOffset, (uint64_t) secondLevelAddr);
1022     low = 0;
1023     high = pageHeader.entryCount();
1024     while (low < high) {
1025       uint32_t mid = (low + high) / 2;
1026       if (pageIndex.functionOffset(mid) <= targetFunctionOffset) {
1027         if (mid == (uint32_t)(pageHeader.entryCount() - 1)) {
1028           // at end of table
1029           low = mid;
1030           funcEnd = firstLevelNextPageFunctionOffset + sects.dso_base;
1031           break;
1032         } else if (pageIndex.functionOffset(mid + 1) > targetFunctionOffset) {
1033           // next is too big, so we found it
1034           low = mid;
1035           funcEnd = pageIndex.functionOffset(low + 1) + sects.dso_base;
1036           break;
1037         } else {
1038           low = mid + 1;
1039         }
1040       } else {
1041         high = mid;
1042       }
1043     }
1044     encoding = pageIndex.encoding(low);
1045     funcStart = pageIndex.functionOffset(low) + sects.dso_base;
1046     if (pc < funcStart) {
1047       if (log)
1048         fprintf(
1049             stderr,
1050             "\tpc not in table, pc=0x%llX, funcStart=0x%llX, funcEnd=0x%llX\n",
1051             (uint64_t) pc, (uint64_t) funcStart, (uint64_t) funcEnd);
1052       return false;
1053     }
1054     if (pc > funcEnd) {
1055       if (log)
1056         fprintf(
1057             stderr,
1058             "\tpc not in table, pc=0x%llX, funcStart=0x%llX, funcEnd=0x%llX\n",
1059             (uint64_t) pc, (uint64_t) funcStart, (uint64_t) funcEnd);
1060       return false;
1061     }
1062   } else if (pageKind == UNWIND_SECOND_LEVEL_COMPRESSED) {
1063     // compressed page
1064     UnwindSectionCompressedPageHeader<A> pageHeader(_addressSpace,
1065                                                     secondLevelAddr);
1066     UnwindSectionCompressedArray<A> pageIndex(
1067         _addressSpace, secondLevelAddr + pageHeader.entryPageOffset());
1068     const uint32_t targetFunctionPageOffset =
1069         (uint32_t)(targetFunctionOffset - firstLevelFunctionOffset);
1070     // binary search looks for entry with e where index[e].offset <= pc <
1071     // index[e+1].offset
1072     if (log)
1073       fprintf(stderr, "\tbinary search of compressed page starting at "
1074                       "secondLevelAddr=0x%llX\n",
1075               (uint64_t) secondLevelAddr);
1076     low = 0;
1077     last = pageHeader.entryCount() - 1;
1078     high = pageHeader.entryCount();
1079     while (low < high) {
1080       uint32_t mid = (low + high) / 2;
1081       if (pageIndex.functionOffset(mid) <= targetFunctionPageOffset) {
1082         if ((mid == last) ||
1083             (pageIndex.functionOffset(mid + 1) > targetFunctionPageOffset)) {
1084           low = mid;
1085           break;
1086         } else {
1087           low = mid + 1;
1088         }
1089       } else {
1090         high = mid;
1091       }
1092     }
1093     funcStart = pageIndex.functionOffset(low) + firstLevelFunctionOffset
1094                                                               + sects.dso_base;
1095     if (low < last)
1096       funcEnd =
1097           pageIndex.functionOffset(low + 1) + firstLevelFunctionOffset
1098                                                               + sects.dso_base;
1099     else
1100       funcEnd = firstLevelNextPageFunctionOffset + sects.dso_base;
1101     if (pc < funcStart) {
1102       _LIBUNWIND_DEBUG_LOG("malformed __unwind_info, pc=0x%llX not in second  "
1103                            "level compressed unwind table. funcStart=0x%llX",
1104                             (uint64_t) pc, (uint64_t) funcStart);
1105       return false;
1106     }
1107     if (pc > funcEnd) {
1108       _LIBUNWIND_DEBUG_LOG("malformed __unwind_info, pc=0x%llX not in second  "
1109                           "level compressed unwind table. funcEnd=0x%llX",
1110                            (uint64_t) pc, (uint64_t) funcEnd);
1111       return false;
1112     }
1113     uint16_t encodingIndex = pageIndex.encodingIndex(low);
1114     if (encodingIndex < sectionHeader.commonEncodingsArrayCount()) {
1115       // encoding is in common table in section header
1116       encoding = _addressSpace.get32(
1117           sects.compact_unwind_section +
1118           sectionHeader.commonEncodingsArraySectionOffset() +
1119           encodingIndex * sizeof(uint32_t));
1120     } else {
1121       // encoding is in page specific table
1122       uint16_t pageEncodingIndex =
1123           encodingIndex - (uint16_t)sectionHeader.commonEncodingsArrayCount();
1124       encoding = _addressSpace.get32(secondLevelAddr +
1125                                      pageHeader.encodingsPageOffset() +
1126                                      pageEncodingIndex * sizeof(uint32_t));
1127     }
1128   } else {
1129     _LIBUNWIND_DEBUG_LOG("malformed __unwind_info at 0x%0llX bad second "
1130                          "level page",
1131                           (uint64_t) sects.compact_unwind_section);
1132     return false;
1133   }
1134 
1135   // look up LSDA, if encoding says function has one
1136   if (encoding & UNWIND_HAS_LSDA) {
1137     UnwindSectionLsdaArray<A> lsdaIndex(_addressSpace, lsdaArrayStartAddr);
1138     uint32_t funcStartOffset = (uint32_t)(funcStart - sects.dso_base);
1139     low = 0;
1140     high = (uint32_t)(lsdaArrayEndAddr - lsdaArrayStartAddr) /
1141                     sizeof(unwind_info_section_header_lsda_index_entry);
1142     // binary search looks for entry with exact match for functionOffset
1143     if (log)
1144       fprintf(stderr,
1145               "\tbinary search of lsda table for targetFunctionOffset=0x%08X\n",
1146               funcStartOffset);
1147     while (low < high) {
1148       uint32_t mid = (low + high) / 2;
1149       if (lsdaIndex.functionOffset(mid) == funcStartOffset) {
1150         lsda = lsdaIndex.lsdaOffset(mid) + sects.dso_base;
1151         break;
1152       } else if (lsdaIndex.functionOffset(mid) < funcStartOffset) {
1153         low = mid + 1;
1154       } else {
1155         high = mid;
1156       }
1157     }
1158     if (lsda == 0) {
1159       _LIBUNWIND_DEBUG_LOG("found encoding 0x%08X with HAS_LSDA bit set for "
1160                     "pc=0x%0llX, but lsda table has no entry",
1161                     encoding, (uint64_t) pc);
1162       return false;
1163     }
1164   }
1165 
1166   // extact personality routine, if encoding says function has one
1167   uint32_t personalityIndex = (encoding & UNWIND_PERSONALITY_MASK) >>
1168                               (__builtin_ctz(UNWIND_PERSONALITY_MASK));
1169   if (personalityIndex != 0) {
1170     --personalityIndex; // change 1-based to zero-based index
1171     if (personalityIndex > sectionHeader.personalityArrayCount()) {
1172       _LIBUNWIND_DEBUG_LOG("found encoding 0x%08X with personality index %d,  "
1173                             "but personality table has only %d entires",
1174                             encoding, personalityIndex,
1175                             sectionHeader.personalityArrayCount());
1176       return false;
1177     }
1178     int32_t personalityDelta = (int32_t)_addressSpace.get32(
1179         sects.compact_unwind_section +
1180         sectionHeader.personalityArraySectionOffset() +
1181         personalityIndex * sizeof(uint32_t));
1182     pint_t personalityPointer = sects.dso_base + (pint_t)personalityDelta;
1183     personality = _addressSpace.getP(personalityPointer);
1184     if (log)
1185       fprintf(stderr, "getInfoFromCompactEncodingSection(pc=0x%llX), "
1186                       "personalityDelta=0x%08X, personality=0x%08llX\n",
1187               (uint64_t) pc, personalityDelta, (uint64_t) personality);
1188   }
1189 
1190   if (log)
1191     fprintf(stderr, "getInfoFromCompactEncodingSection(pc=0x%llX), "
1192                     "encoding=0x%08X, lsda=0x%08llX for funcStart=0x%llX\n",
1193             (uint64_t) pc, encoding, (uint64_t) lsda, (uint64_t) funcStart);
1194   _info.start_ip = funcStart;
1195   _info.end_ip = funcEnd;
1196   _info.lsda = lsda;
1197   _info.handler = personality;
1198   _info.gp = 0;
1199   _info.flags = 0;
1200   _info.format = encoding;
1201   _info.unwind_info = 0;
1202   _info.unwind_info_size = 0;
1203   _info.extra = sects.dso_base;
1204   return true;
1205 }
1206 #endif // defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
1207 
1208 
1209 template <typename A, typename R>
1210 void UnwindCursor<A, R>::setInfoBasedOnIPRegister(bool isReturnAddress) {
1211   pint_t pc = (pint_t)this->getReg(UNW_REG_IP);
1212 #if defined(_LIBUNWIND_ARM_EHABI)
1213   // Remove the thumb bit so the IP represents the actual instruction address.
1214   // This matches the behaviour of _Unwind_GetIP on arm.
1215   pc &= (pint_t)~0x1;
1216 #endif
1217 
1218   // If the last line of a function is a "throw" the compiler sometimes
1219   // emits no instructions after the call to __cxa_throw.  This means
1220   // the return address is actually the start of the next function.
1221   // To disambiguate this, back up the pc when we know it is a return
1222   // address.
1223   if (isReturnAddress)
1224     --pc;
1225 
1226   // Ask address space object to find unwind sections for this pc.
1227   UnwindInfoSections sects;
1228   if (_addressSpace.findUnwindSections(pc, sects)) {
1229 #if defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
1230     // If there is a compact unwind encoding table, look there first.
1231     if (sects.compact_unwind_section != 0) {
1232       if (this->getInfoFromCompactEncodingSection(pc, sects)) {
1233   #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
1234         // Found info in table, done unless encoding says to use dwarf.
1235         uint32_t dwarfOffset;
1236         if ((sects.dwarf_section != 0) && compactSaysUseDwarf(&dwarfOffset)) {
1237           if (this->getInfoFromDwarfSection(pc, sects, dwarfOffset)) {
1238             // found info in dwarf, done
1239             return;
1240           }
1241         }
1242   #endif
1243         // If unwind table has entry, but entry says there is no unwind info,
1244         // record that we have no unwind info.
1245         if (_info.format == 0)
1246           _unwindInfoMissing = true;
1247         return;
1248       }
1249     }
1250 #endif // defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
1251 
1252 #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
1253     // If there is dwarf unwind info, look there next.
1254     if (sects.dwarf_section != 0) {
1255       if (this->getInfoFromDwarfSection(pc, sects)) {
1256         // found info in dwarf, done
1257         return;
1258       }
1259     }
1260 #endif
1261 
1262 #if defined(_LIBUNWIND_ARM_EHABI)
1263     // If there is ARM EHABI unwind info, look there next.
1264     if (sects.arm_section != 0 && this->getInfoFromEHABISection(pc, sects))
1265       return;
1266 #endif
1267   }
1268 
1269 #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
1270   // There is no static unwind info for this pc. Look to see if an FDE was
1271   // dynamically registered for it.
1272   pint_t cachedFDE = DwarfFDECache<A>::findFDE(0, pc);
1273   if (cachedFDE != 0) {
1274     CFI_Parser<LocalAddressSpace>::FDE_Info fdeInfo;
1275     CFI_Parser<LocalAddressSpace>::CIE_Info cieInfo;
1276     const char *msg = CFI_Parser<A>::decodeFDE(_addressSpace,
1277                                                 cachedFDE, &fdeInfo, &cieInfo);
1278     if (msg == NULL) {
1279       typename CFI_Parser<A>::PrologInfo prolog;
1280       if (CFI_Parser<A>::parseFDEInstructions(_addressSpace, fdeInfo, cieInfo,
1281                                                                 pc, &prolog)) {
1282         // save off parsed FDE info
1283         _info.start_ip         = fdeInfo.pcStart;
1284         _info.end_ip           = fdeInfo.pcEnd;
1285         _info.lsda             = fdeInfo.lsda;
1286         _info.handler          = cieInfo.personality;
1287         _info.gp               = prolog.spExtraArgSize;
1288                                   // Some frameless functions need SP
1289                                   // altered when resuming in function.
1290         _info.flags            = 0;
1291         _info.format           = dwarfEncoding();
1292         _info.unwind_info      = fdeInfo.fdeStart;
1293         _info.unwind_info_size = (uint32_t)fdeInfo.fdeLength;
1294         _info.extra            = 0;
1295         return;
1296       }
1297     }
1298   }
1299 
1300   // Lastly, ask AddressSpace object about platform specific ways to locate
1301   // other FDEs.
1302   pint_t fde;
1303   if (_addressSpace.findOtherFDE(pc, fde)) {
1304     CFI_Parser<LocalAddressSpace>::FDE_Info fdeInfo;
1305     CFI_Parser<LocalAddressSpace>::CIE_Info cieInfo;
1306     if (!CFI_Parser<A>::decodeFDE(_addressSpace, fde, &fdeInfo, &cieInfo)) {
1307       // Double check this FDE is for a function that includes the pc.
1308       if ((fdeInfo.pcStart <= pc) && (pc < fdeInfo.pcEnd)) {
1309         typename CFI_Parser<A>::PrologInfo prolog;
1310         if (CFI_Parser<A>::parseFDEInstructions(_addressSpace, fdeInfo,
1311                                                 cieInfo, pc, &prolog)) {
1312           // save off parsed FDE info
1313           _info.start_ip         = fdeInfo.pcStart;
1314           _info.end_ip           = fdeInfo.pcEnd;
1315           _info.lsda             = fdeInfo.lsda;
1316           _info.handler          = cieInfo.personality;
1317           _info.gp               = prolog.spExtraArgSize;
1318           _info.flags            = 0;
1319           _info.format           = dwarfEncoding();
1320           _info.unwind_info      = fdeInfo.fdeStart;
1321           _info.unwind_info_size = (uint32_t)fdeInfo.fdeLength;
1322           _info.extra            = 0;
1323           return;
1324         }
1325       }
1326     }
1327   }
1328 #endif // #if defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
1329 
1330   // no unwind info, flag that we can't reliably unwind
1331   _unwindInfoMissing = true;
1332 }
1333 
1334 template <typename A, typename R>
1335 int UnwindCursor<A, R>::step() {
1336   // Bottom of stack is defined is when unwind info cannot be found.
1337   if (_unwindInfoMissing)
1338     return UNW_STEP_END;
1339 
1340   // Use unwinding info to modify register set as if function returned.
1341   int result;
1342 #if defined(_LIBUNWIND_SUPPORT_COMPACT_UNWIND)
1343   result = this->stepWithCompactEncoding();
1344 #elif defined(_LIBUNWIND_SUPPORT_DWARF_UNWIND)
1345   result = this->stepWithDwarfFDE();
1346 #elif defined(_LIBUNWIND_ARM_EHABI)
1347   result = this->stepWithEHABI();
1348 #else
1349   #error Need _LIBUNWIND_SUPPORT_COMPACT_UNWIND or \
1350               _LIBUNWIND_SUPPORT_DWARF_UNWIND or \
1351               _LIBUNWIND_ARM_EHABI
1352 #endif
1353 
1354   // update info based on new PC
1355   if (result == UNW_STEP_SUCCESS) {
1356     this->setInfoBasedOnIPRegister(true);
1357     if (_unwindInfoMissing)
1358       return UNW_STEP_END;
1359     if (_info.gp)
1360       setReg(UNW_REG_SP, getReg(UNW_REG_SP) + _info.gp);
1361   }
1362 
1363   return result;
1364 }
1365 
1366 template <typename A, typename R>
1367 void UnwindCursor<A, R>::getInfo(unw_proc_info_t *info) {
1368   *info = _info;
1369 }
1370 
1371 template <typename A, typename R>
1372 bool UnwindCursor<A, R>::getFunctionName(char *buf, size_t bufLen,
1373                                                            unw_word_t *offset) {
1374   return _addressSpace.findFunctionName((pint_t)this->getReg(UNW_REG_IP),
1375                                          buf, bufLen, offset);
1376 }
1377 
1378 } // namespace libunwind
1379 
1380 #endif // __UNWINDCURSOR_HPP__
1381