130fdc8d8SChris Lattner //===-- DWARFCallFrameInfo.cpp ----------------------------------*- C++ -*-===//
230fdc8d8SChris Lattner //
330fdc8d8SChris Lattner //                     The LLVM Compiler Infrastructure
430fdc8d8SChris Lattner //
530fdc8d8SChris Lattner // This file is distributed under the University of Illinois Open Source
630fdc8d8SChris Lattner // License. See LICENSE.TXT for details.
730fdc8d8SChris Lattner //
830fdc8d8SChris Lattner //===----------------------------------------------------------------------===//
930fdc8d8SChris Lattner 
1030fdc8d8SChris Lattner 
1130fdc8d8SChris Lattner // C Includes
1230fdc8d8SChris Lattner // C++ Includes
1330fdc8d8SChris Lattner #include <list>
1430fdc8d8SChris Lattner 
15e6194f17SJason Molenda #include "lldb/Core/Log.h"
16fbcb7f2cSJason Molenda #include "lldb/Core/Section.h"
1730fdc8d8SChris Lattner #include "lldb/Core/ArchSpec.h"
1830fdc8d8SChris Lattner #include "lldb/Core/Module.h"
1930fdc8d8SChris Lattner #include "lldb/Core/Section.h"
20*74303829SJason Molenda #include "lldb/Core/Timer.h"
21e38a5eddSGreg Clayton #include "lldb/Host/Host.h"
22e38a5eddSGreg Clayton #include "lldb/Symbol/DWARFCallFrameInfo.h"
23e38a5eddSGreg Clayton #include "lldb/Symbol/ObjectFile.h"
24fbcb7f2cSJason Molenda #include "lldb/Symbol/UnwindPlan.h"
25e38a5eddSGreg Clayton #include "lldb/Target/RegisterContext.h"
26e38a5eddSGreg Clayton #include "lldb/Target/Thread.h"
2730fdc8d8SChris Lattner 
2830fdc8d8SChris Lattner using namespace lldb;
2930fdc8d8SChris Lattner using namespace lldb_private;
3030fdc8d8SChris Lattner 
31c9660546SGreg Clayton DWARFCallFrameInfo::DWARFCallFrameInfo(ObjectFile& objfile, SectionSP& section_sp, lldb::RegisterKind reg_kind, bool is_eh_frame) :
3230fdc8d8SChris Lattner     m_objfile (objfile),
33c9660546SGreg Clayton     m_section_sp (section_sp),
34fbcb7f2cSJason Molenda     m_reg_kind (reg_kind),  // The flavor of registers that the CFI data uses (enum RegisterKind)
3571c21d18SStephen Wilson     m_flags (),
3630fdc8d8SChris Lattner     m_cie_map (),
37fbcb7f2cSJason Molenda     m_cfi_data (),
38fbcb7f2cSJason Molenda     m_cfi_data_initialized (false),
39fbcb7f2cSJason Molenda     m_fde_index (),
40fbcb7f2cSJason Molenda     m_fde_index_initialized (false),
4171c21d18SStephen Wilson     m_is_eh_frame (is_eh_frame)
4230fdc8d8SChris Lattner {
4330fdc8d8SChris Lattner }
4430fdc8d8SChris Lattner 
4530fdc8d8SChris Lattner DWARFCallFrameInfo::~DWARFCallFrameInfo()
4630fdc8d8SChris Lattner {
4730fdc8d8SChris Lattner }
4830fdc8d8SChris Lattner 
49fbcb7f2cSJason Molenda 
5030fdc8d8SChris Lattner bool
51fbcb7f2cSJason Molenda DWARFCallFrameInfo::GetUnwindPlan (Address addr, UnwindPlan& unwind_plan)
5230fdc8d8SChris Lattner {
53*74303829SJason Molenda     FDEEntryMap::Entry fde_entry;
54*74303829SJason Molenda 
55*74303829SJason Molenda     // Make sure that the Address we're searching for is the same object file
56*74303829SJason Molenda     // as this DWARFCallFrameInfo, we only store File offsets in m_fde_index.
57*74303829SJason Molenda     ModuleSP module_sp = addr.GetModule();
58*74303829SJason Molenda     if (module_sp.get() == NULL || module_sp->GetObjectFile() == NULL || module_sp->GetObjectFile() != &m_objfile)
59fbcb7f2cSJason Molenda         return false;
60*74303829SJason Molenda 
61*74303829SJason Molenda     if (GetFDEEntryByFileAddress (addr.GetFileAddress(), fde_entry) == false)
62*74303829SJason Molenda         return false;
63*74303829SJason Molenda     return FDEToUnwindPlan (fde_entry.data, addr, unwind_plan);
6430fdc8d8SChris Lattner }
6530fdc8d8SChris Lattner 
66fbcb7f2cSJason Molenda bool
67*74303829SJason Molenda DWARFCallFrameInfo::GetAddressRange (Address addr, AddressRange &range)
6830fdc8d8SChris Lattner {
69*74303829SJason Molenda 
70*74303829SJason Molenda     // Make sure that the Address we're searching for is the same object file
71*74303829SJason Molenda     // as this DWARFCallFrameInfo, we only store File offsets in m_fde_index.
72*74303829SJason Molenda     ModuleSP module_sp = addr.GetModule();
73*74303829SJason Molenda     if (module_sp.get() == NULL || module_sp->GetObjectFile() == NULL || module_sp->GetObjectFile() != &m_objfile)
74*74303829SJason Molenda         return false;
75*74303829SJason Molenda 
76c9660546SGreg Clayton     if (m_section_sp.get() == NULL || m_section_sp->IsEncrypted())
77fbcb7f2cSJason Molenda         return false;
78fbcb7f2cSJason Molenda     GetFDEIndex();
79*74303829SJason Molenda     FDEEntryMap::Entry *fde_entry = m_fde_index.FindEntryThatContains (addr.GetFileAddress());
80*74303829SJason Molenda     if (!fde_entry)
81fbcb7f2cSJason Molenda         return false;
82fbcb7f2cSJason Molenda 
83*74303829SJason Molenda     range = AddressRange(fde_entry->base, fde_entry->size, m_objfile.GetSectionList());
84fbcb7f2cSJason Molenda     return true;
8530fdc8d8SChris Lattner }
8630fdc8d8SChris Lattner 
87*74303829SJason Molenda bool
88*74303829SJason Molenda DWARFCallFrameInfo::GetFDEEntryByFileAddress (addr_t file_addr, FDEEntryMap::Entry &fde_entry)
89*74303829SJason Molenda {
90*74303829SJason Molenda     if (m_section_sp.get() == NULL || m_section_sp->IsEncrypted())
91fbcb7f2cSJason Molenda         return false;
92*74303829SJason Molenda 
93*74303829SJason Molenda     GetFDEIndex();
94*74303829SJason Molenda 
95*74303829SJason Molenda     if (m_fde_index.IsEmpty())
96*74303829SJason Molenda         return false;
97*74303829SJason Molenda 
98*74303829SJason Molenda     FDEEntryMap::Entry *fde = m_fde_index.FindEntryThatContains (file_addr);
99*74303829SJason Molenda 
100*74303829SJason Molenda     if (fde == NULL)
101*74303829SJason Molenda         return false;
102*74303829SJason Molenda 
103*74303829SJason Molenda     fde_entry = *fde;
104*74303829SJason Molenda     return true;
10530fdc8d8SChris Lattner }
10630fdc8d8SChris Lattner 
10730fdc8d8SChris Lattner const DWARFCallFrameInfo::CIE*
10830fdc8d8SChris Lattner DWARFCallFrameInfo::GetCIE(dw_offset_t cie_offset)
10930fdc8d8SChris Lattner {
11030fdc8d8SChris Lattner     cie_map_t::iterator pos = m_cie_map.find(cie_offset);
11130fdc8d8SChris Lattner 
11230fdc8d8SChris Lattner     if (pos != m_cie_map.end())
11330fdc8d8SChris Lattner     {
11430fdc8d8SChris Lattner         // Parse and cache the CIE
11530fdc8d8SChris Lattner         if (pos->second.get() == NULL)
11630fdc8d8SChris Lattner             pos->second = ParseCIE (cie_offset);
11730fdc8d8SChris Lattner 
11830fdc8d8SChris Lattner         return pos->second.get();
11930fdc8d8SChris Lattner     }
12030fdc8d8SChris Lattner     return NULL;
12130fdc8d8SChris Lattner }
12230fdc8d8SChris Lattner 
123fbcb7f2cSJason Molenda DWARFCallFrameInfo::CIESP
12430fdc8d8SChris Lattner DWARFCallFrameInfo::ParseCIE (const dw_offset_t cie_offset)
12530fdc8d8SChris Lattner {
126fbcb7f2cSJason Molenda     CIESP cie_sp(new CIE(cie_offset));
127c7bece56SGreg Clayton     lldb::offset_t offset = cie_offset;
128fbcb7f2cSJason Molenda     if (m_cfi_data_initialized == false)
129f97c5213SGreg Clayton         GetCFIData();
13030fdc8d8SChris Lattner     const uint32_t length = m_cfi_data.GetU32(&offset);
13130fdc8d8SChris Lattner     const dw_offset_t cie_id = m_cfi_data.GetU32(&offset);
13230fdc8d8SChris Lattner     const dw_offset_t end_offset = cie_offset + length + 4;
133c7bece56SGreg Clayton     if (length > 0 && ((!m_is_eh_frame && cie_id == UINT32_MAX) || (m_is_eh_frame && cie_id == 0ul)))
13430fdc8d8SChris Lattner     {
13530fdc8d8SChris Lattner         size_t i;
13630fdc8d8SChris Lattner         //    cie.offset = cie_offset;
13730fdc8d8SChris Lattner         //    cie.length = length;
13830fdc8d8SChris Lattner         //    cie.cieID = cieID;
139ea84e764SJason Molenda         cie_sp->ptr_encoding = DW_EH_PE_absptr;
14030fdc8d8SChris Lattner         cie_sp->version = m_cfi_data.GetU8(&offset);
14130fdc8d8SChris Lattner 
14230fdc8d8SChris Lattner         for (i=0; i<CFI_AUG_MAX_SIZE; ++i)
14330fdc8d8SChris Lattner         {
14430fdc8d8SChris Lattner             cie_sp->augmentation[i] = m_cfi_data.GetU8(&offset);
14530fdc8d8SChris Lattner             if (cie_sp->augmentation[i] == '\0')
14630fdc8d8SChris Lattner             {
14730fdc8d8SChris Lattner                 // Zero out remaining bytes in augmentation string
14830fdc8d8SChris Lattner                 for (size_t j = i+1; j<CFI_AUG_MAX_SIZE; ++j)
14930fdc8d8SChris Lattner                     cie_sp->augmentation[j] = '\0';
15030fdc8d8SChris Lattner 
15130fdc8d8SChris Lattner                 break;
15230fdc8d8SChris Lattner             }
15330fdc8d8SChris Lattner         }
15430fdc8d8SChris Lattner 
15530fdc8d8SChris Lattner         if (i == CFI_AUG_MAX_SIZE && cie_sp->augmentation[CFI_AUG_MAX_SIZE-1] != '\0')
15630fdc8d8SChris Lattner         {
157e38a5eddSGreg Clayton             Host::SystemLog (Host::eSystemLogError, "CIE parse error: CIE augmentation string was too large for the fixed sized buffer of %d bytes.\n", CFI_AUG_MAX_SIZE);
15830fdc8d8SChris Lattner             return cie_sp;
15930fdc8d8SChris Lattner         }
16030fdc8d8SChris Lattner         cie_sp->code_align = (uint32_t)m_cfi_data.GetULEB128(&offset);
16130fdc8d8SChris Lattner         cie_sp->data_align = (int32_t)m_cfi_data.GetSLEB128(&offset);
16230fdc8d8SChris Lattner         cie_sp->return_addr_reg_num = m_cfi_data.GetU8(&offset);
16330fdc8d8SChris Lattner 
16430fdc8d8SChris Lattner         if (cie_sp->augmentation[0])
16530fdc8d8SChris Lattner         {
16630fdc8d8SChris Lattner             // Get the length of the eh_frame augmentation data
16730fdc8d8SChris Lattner             // which starts with a ULEB128 length in bytes
16830fdc8d8SChris Lattner             const size_t aug_data_len = (size_t)m_cfi_data.GetULEB128(&offset);
16930fdc8d8SChris Lattner             const size_t aug_data_end = offset + aug_data_len;
17030fdc8d8SChris Lattner             const size_t aug_str_len = strlen(cie_sp->augmentation);
17130fdc8d8SChris Lattner             // A 'z' may be present as the first character of the string.
17230fdc8d8SChris Lattner             // If present, the Augmentation Data field shall be present.
17330fdc8d8SChris Lattner             // The contents of the Augmentation Data shall be intepreted
17430fdc8d8SChris Lattner             // according to other characters in the Augmentation String.
17530fdc8d8SChris Lattner             if (cie_sp->augmentation[0] == 'z')
17630fdc8d8SChris Lattner             {
17730fdc8d8SChris Lattner                 // Extract the Augmentation Data
17830fdc8d8SChris Lattner                 size_t aug_str_idx = 0;
17930fdc8d8SChris Lattner                 for (aug_str_idx = 1; aug_str_idx < aug_str_len; aug_str_idx++)
18030fdc8d8SChris Lattner                 {
18130fdc8d8SChris Lattner                     char aug = cie_sp->augmentation[aug_str_idx];
18230fdc8d8SChris Lattner                     switch (aug)
18330fdc8d8SChris Lattner                     {
18430fdc8d8SChris Lattner                         case 'L':
18530fdc8d8SChris Lattner                             // Indicates the presence of one argument in the
18630fdc8d8SChris Lattner                             // Augmentation Data of the CIE, and a corresponding
18730fdc8d8SChris Lattner                             // argument in the Augmentation Data of the FDE. The
18830fdc8d8SChris Lattner                             // argument in the Augmentation Data of the CIE is
18930fdc8d8SChris Lattner                             // 1-byte and represents the pointer encoding used
19030fdc8d8SChris Lattner                             // for the argument in the Augmentation Data of the
19130fdc8d8SChris Lattner                             // FDE, which is the address of a language-specific
19230fdc8d8SChris Lattner                             // data area (LSDA). The size of the LSDA pointer is
19330fdc8d8SChris Lattner                             // specified by the pointer encoding used.
19430fdc8d8SChris Lattner                             m_cfi_data.GetU8(&offset);
19530fdc8d8SChris Lattner                             break;
19630fdc8d8SChris Lattner 
19730fdc8d8SChris Lattner                         case 'P':
19830fdc8d8SChris Lattner                             // Indicates the presence of two arguments in the
19930fdc8d8SChris Lattner                             // Augmentation Data of the cie_sp-> The first argument
20030fdc8d8SChris Lattner                             // is 1-byte and represents the pointer encoding
20130fdc8d8SChris Lattner                             // used for the second argument, which is the
20230fdc8d8SChris Lattner                             // address of a personality routine handler. The
20330fdc8d8SChris Lattner                             // size of the personality routine pointer is
20430fdc8d8SChris Lattner                             // specified by the pointer encoding used.
20530fdc8d8SChris Lattner                         {
20630fdc8d8SChris Lattner                             uint8_t arg_ptr_encoding = m_cfi_data.GetU8(&offset);
20730fdc8d8SChris Lattner                             m_cfi_data.GetGNUEHPointer(&offset, arg_ptr_encoding, LLDB_INVALID_ADDRESS, LLDB_INVALID_ADDRESS, LLDB_INVALID_ADDRESS);
20830fdc8d8SChris Lattner                         }
20930fdc8d8SChris Lattner                             break;
21030fdc8d8SChris Lattner 
21130fdc8d8SChris Lattner                         case 'R':
21230fdc8d8SChris Lattner                             // A 'R' may be present at any position after the
21330fdc8d8SChris Lattner                             // first character of the string. The Augmentation
21430fdc8d8SChris Lattner                             // Data shall include a 1 byte argument that
21530fdc8d8SChris Lattner                             // represents the pointer encoding for the address
21630fdc8d8SChris Lattner                             // pointers used in the FDE.
21730fdc8d8SChris Lattner                             cie_sp->ptr_encoding = m_cfi_data.GetU8(&offset);
21830fdc8d8SChris Lattner                             break;
21930fdc8d8SChris Lattner                     }
22030fdc8d8SChris Lattner                 }
22130fdc8d8SChris Lattner             }
22230fdc8d8SChris Lattner             else if (strcmp(cie_sp->augmentation, "eh") == 0)
22330fdc8d8SChris Lattner             {
22430fdc8d8SChris Lattner                 // If the Augmentation string has the value "eh", then
22530fdc8d8SChris Lattner                 // the EH Data field shall be present
22630fdc8d8SChris Lattner             }
22730fdc8d8SChris Lattner 
22830fdc8d8SChris Lattner             // Set the offset to be the end of the augmentation data just in case
22930fdc8d8SChris Lattner             // we didn't understand any of the data.
23030fdc8d8SChris Lattner             offset = (uint32_t)aug_data_end;
23130fdc8d8SChris Lattner         }
23230fdc8d8SChris Lattner 
23330fdc8d8SChris Lattner         if (end_offset > offset)
23430fdc8d8SChris Lattner         {
23530fdc8d8SChris Lattner             cie_sp->inst_offset = offset;
23630fdc8d8SChris Lattner             cie_sp->inst_length = end_offset - offset;
23730fdc8d8SChris Lattner         }
238fbcb7f2cSJason Molenda         while (offset < end_offset)
239fbcb7f2cSJason Molenda         {
240fbcb7f2cSJason Molenda             uint8_t inst = m_cfi_data.GetU8(&offset);
241fbcb7f2cSJason Molenda             uint8_t primary_opcode  = inst & 0xC0;
242fbcb7f2cSJason Molenda             uint8_t extended_opcode = inst & 0x3F;
243fbcb7f2cSJason Molenda 
244fbcb7f2cSJason Molenda             if (extended_opcode == DW_CFA_def_cfa)
245fbcb7f2cSJason Molenda             {
246fbcb7f2cSJason Molenda                 // Takes two unsigned LEB128 operands representing a register
247fbcb7f2cSJason Molenda                 // number and a (non-factored) offset. The required action
248fbcb7f2cSJason Molenda                 // is to define the current CFA rule to use the provided
249fbcb7f2cSJason Molenda                 // register and offset.
250fbcb7f2cSJason Molenda                 uint32_t reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
251fbcb7f2cSJason Molenda                 int op_offset = (int32_t)m_cfi_data.GetULEB128(&offset);
252fbcb7f2cSJason Molenda                 cie_sp->initial_row.SetCFARegister (reg_num);
253fbcb7f2cSJason Molenda                 cie_sp->initial_row.SetCFAOffset (op_offset);
254fbcb7f2cSJason Molenda                 continue;
255fbcb7f2cSJason Molenda             }
256fbcb7f2cSJason Molenda             if (primary_opcode == DW_CFA_offset)
257fbcb7f2cSJason Molenda             {
258fbcb7f2cSJason Molenda                 // 0x80 - high 2 bits are 0x2, lower 6 bits are register.
259fbcb7f2cSJason Molenda                 // Takes two arguments: an unsigned LEB128 constant representing a
260fbcb7f2cSJason Molenda                 // factored offset and a register number. The required action is to
261fbcb7f2cSJason Molenda                 // change the rule for the register indicated by the register number
262fbcb7f2cSJason Molenda                 // to be an offset(N) rule with a value of
263fbcb7f2cSJason Molenda                 // (N = factored offset * data_align).
264fbcb7f2cSJason Molenda                 uint32_t reg_num = extended_opcode;
265fbcb7f2cSJason Molenda                 int op_offset = (int32_t)m_cfi_data.GetULEB128(&offset) * cie_sp->data_align;
266fbcb7f2cSJason Molenda                 UnwindPlan::Row::RegisterLocation reg_location;
267fbcb7f2cSJason Molenda                 reg_location.SetAtCFAPlusOffset(op_offset);
268fbcb7f2cSJason Molenda                 cie_sp->initial_row.SetRegisterInfo (reg_num, reg_location);
269fbcb7f2cSJason Molenda                 continue;
270fbcb7f2cSJason Molenda             }
271fbcb7f2cSJason Molenda             if (extended_opcode == DW_CFA_nop)
272fbcb7f2cSJason Molenda             {
273fbcb7f2cSJason Molenda                 continue;
274fbcb7f2cSJason Molenda             }
275fbcb7f2cSJason Molenda             break;  // Stop if we hit an unrecognized opcode
276fbcb7f2cSJason Molenda         }
27730fdc8d8SChris Lattner     }
27830fdc8d8SChris Lattner 
27930fdc8d8SChris Lattner     return cie_sp;
28030fdc8d8SChris Lattner }
28130fdc8d8SChris Lattner 
282f97c5213SGreg Clayton void
283f97c5213SGreg Clayton DWARFCallFrameInfo::GetCFIData()
284f97c5213SGreg Clayton {
285f97c5213SGreg Clayton     if (m_cfi_data_initialized == false)
286f97c5213SGreg Clayton     {
287f97c5213SGreg Clayton         LogSP log(GetLogIfAllCategoriesSet (LIBLLDB_LOG_UNWIND));
288f97c5213SGreg Clayton         if (log)
289f97c5213SGreg Clayton             m_objfile.GetModule()->LogMessage(log.get(), "Reading EH frame info");
290c9660546SGreg Clayton         m_objfile.ReadSectionData (m_section_sp.get(), m_cfi_data);
291f97c5213SGreg Clayton         m_cfi_data_initialized = true;
292f97c5213SGreg Clayton     }
293f97c5213SGreg Clayton }
294fbcb7f2cSJason Molenda // Scan through the eh_frame or debug_frame section looking for FDEs and noting the start/end addresses
295fbcb7f2cSJason Molenda // of the functions and a pointer back to the function's FDE for later expansion.
296fbcb7f2cSJason Molenda // Internalize CIEs as we come across them.
29730fdc8d8SChris Lattner 
298fbcb7f2cSJason Molenda void
299fbcb7f2cSJason Molenda DWARFCallFrameInfo::GetFDEIndex ()
300fbcb7f2cSJason Molenda {
301c9660546SGreg Clayton     if (m_section_sp.get() == NULL || m_section_sp->IsEncrypted())
302fbcb7f2cSJason Molenda         return;
3037d69f12eSSean Callanan 
304fbcb7f2cSJason Molenda     if (m_fde_index_initialized)
305fbcb7f2cSJason Molenda         return;
306fbcb7f2cSJason Molenda 
3077d69f12eSSean Callanan     Mutex::Locker locker(m_fde_index_mutex);
3087d69f12eSSean Callanan 
3097d69f12eSSean Callanan     if (m_fde_index_initialized) // if two threads hit the locker
3107d69f12eSSean Callanan         return;
311e6194f17SJason Molenda 
312*74303829SJason Molenda     Timer scoped_timer (__PRETTY_FUNCTION__, "%s - %s", __PRETTY_FUNCTION__, m_objfile.GetFileSpec().GetFilename().AsCString(""));
313*74303829SJason Molenda 
314c7bece56SGreg Clayton     lldb::offset_t offset = 0;
315fbcb7f2cSJason Molenda     if (m_cfi_data_initialized == false)
316f97c5213SGreg Clayton         GetCFIData();
317fbcb7f2cSJason Molenda     while (m_cfi_data.ValidOffsetForDataOfSize (offset, 8))
318fbcb7f2cSJason Molenda     {
31973bf5dbdSGreg Clayton         const dw_offset_t current_entry = offset;
320fbcb7f2cSJason Molenda         uint32_t len = m_cfi_data.GetU32 (&offset);
321fbcb7f2cSJason Molenda         dw_offset_t next_entry = current_entry + len + 4;
322fbcb7f2cSJason Molenda         dw_offset_t cie_id = m_cfi_data.GetU32 (&offset);
323fbcb7f2cSJason Molenda 
324fbcb7f2cSJason Molenda         if (cie_id == 0 || cie_id == UINT32_MAX)
325fbcb7f2cSJason Molenda         {
326fbcb7f2cSJason Molenda             m_cie_map[current_entry] = ParseCIE (current_entry);
327fbcb7f2cSJason Molenda             offset = next_entry;
328fbcb7f2cSJason Molenda             continue;
329fbcb7f2cSJason Molenda         }
330fbcb7f2cSJason Molenda 
33173bf5dbdSGreg Clayton         const dw_offset_t cie_offset = current_entry + 4 - cie_id;
33273bf5dbdSGreg Clayton         const CIE *cie = GetCIE (cie_offset);
33373bf5dbdSGreg Clayton         if (cie)
33473bf5dbdSGreg Clayton         {
335c9660546SGreg Clayton             const lldb::addr_t pc_rel_addr = m_section_sp->GetFileAddress();
336fbcb7f2cSJason Molenda             const lldb::addr_t text_addr = LLDB_INVALID_ADDRESS;
337fbcb7f2cSJason Molenda             const lldb::addr_t data_addr = LLDB_INVALID_ADDRESS;
338fbcb7f2cSJason Molenda 
339fbcb7f2cSJason Molenda             lldb::addr_t addr = m_cfi_data.GetGNUEHPointer(&offset, cie->ptr_encoding, pc_rel_addr, text_addr, data_addr);
340fbcb7f2cSJason Molenda             lldb::addr_t length = m_cfi_data.GetGNUEHPointer(&offset, cie->ptr_encoding & DW_EH_PE_MASK_ENCODING, pc_rel_addr, text_addr, data_addr);
341*74303829SJason Molenda             FDEEntryMap::Entry fde (addr, length, current_entry);
342*74303829SJason Molenda             m_fde_index.Append(fde);
34373bf5dbdSGreg Clayton         }
34473bf5dbdSGreg Clayton         else
34573bf5dbdSGreg Clayton         {
346e38a5eddSGreg Clayton             Host::SystemLog (Host::eSystemLogError,
34773bf5dbdSGreg Clayton                              "error: unable to find CIE at 0x%8.8x for cie_id = 0x%8.8x for entry at 0x%8.8x.\n",
34873bf5dbdSGreg Clayton                              cie_offset,
34973bf5dbdSGreg Clayton                              cie_id,
35073bf5dbdSGreg Clayton                              current_entry);
35173bf5dbdSGreg Clayton         }
352fbcb7f2cSJason Molenda         offset = next_entry;
353fbcb7f2cSJason Molenda     }
354*74303829SJason Molenda     m_fde_index.Sort();
355fbcb7f2cSJason Molenda     m_fde_index_initialized = true;
356fbcb7f2cSJason Molenda }
357fbcb7f2cSJason Molenda 
358fbcb7f2cSJason Molenda bool
359c7bece56SGreg Clayton DWARFCallFrameInfo::FDEToUnwindPlan (dw_offset_t dwarf_offset, Address startaddr, UnwindPlan& unwind_plan)
360fbcb7f2cSJason Molenda {
361c7bece56SGreg Clayton     lldb::offset_t offset = dwarf_offset;
362c7bece56SGreg Clayton     lldb::offset_t current_entry = offset;
363fbcb7f2cSJason Molenda 
364c9660546SGreg Clayton     if (m_section_sp.get() == NULL || m_section_sp->IsEncrypted())
365fbcb7f2cSJason Molenda         return false;
366fbcb7f2cSJason Molenda 
367fbcb7f2cSJason Molenda     if (m_cfi_data_initialized == false)
368f97c5213SGreg Clayton         GetCFIData();
369fbcb7f2cSJason Molenda 
370fbcb7f2cSJason Molenda     uint32_t length = m_cfi_data.GetU32 (&offset);
37130fdc8d8SChris Lattner     dw_offset_t cie_offset = m_cfi_data.GetU32 (&offset);
372fbcb7f2cSJason Molenda 
373fbcb7f2cSJason Molenda     assert (cie_offset != 0 && cie_offset != UINT32_MAX);
37430fdc8d8SChris Lattner 
37530fdc8d8SChris Lattner     // Translate the CIE_id from the eh_frame format, which
37630fdc8d8SChris Lattner     // is relative to the FDE offset, into a __eh_frame section
37730fdc8d8SChris Lattner     // offset
378fbcb7f2cSJason Molenda     if (m_is_eh_frame)
379ab4f1924SJason Molenda     {
380ab4f1924SJason Molenda         unwind_plan.SetSourceName ("eh_frame CFI");
381fbcb7f2cSJason Molenda         cie_offset = current_entry + 4 - cie_offset;
38260f0bd49SJason Molenda         unwind_plan.SetUnwindPlanValidAtAllInstructions (eLazyBoolNo);
383ab4f1924SJason Molenda     }
384ab4f1924SJason Molenda     else
385ab4f1924SJason Molenda     {
386ab4f1924SJason Molenda         unwind_plan.SetSourceName ("DWARF CFI");
38760f0bd49SJason Molenda         // In theory the debug_frame info should be valid at all call sites
38860f0bd49SJason Molenda         // ("asynchronous unwind info" as it is sometimes called) but in practice
38960f0bd49SJason Molenda         // gcc et al all emit call frame info for the prologue and call sites, but
39060f0bd49SJason Molenda         // not for the epilogue or all the other locations during the function reliably.
39160f0bd49SJason Molenda         unwind_plan.SetUnwindPlanValidAtAllInstructions (eLazyBoolNo);
392ab4f1924SJason Molenda     }
39360f0bd49SJason Molenda     unwind_plan.SetSourcedFromCompiler (eLazyBoolYes);
39430fdc8d8SChris Lattner 
39530fdc8d8SChris Lattner     const CIE *cie = GetCIE (cie_offset);
396fbcb7f2cSJason Molenda     assert (cie != NULL);
397fbcb7f2cSJason Molenda 
398fbcb7f2cSJason Molenda     const dw_offset_t end_offset = current_entry + length + 4;
399fbcb7f2cSJason Molenda 
400c9660546SGreg Clayton     const lldb::addr_t pc_rel_addr = m_section_sp->GetFileAddress();
40130fdc8d8SChris Lattner     const lldb::addr_t text_addr = LLDB_INVALID_ADDRESS;
40230fdc8d8SChris Lattner     const lldb::addr_t data_addr = LLDB_INVALID_ADDRESS;
40330fdc8d8SChris Lattner     lldb::addr_t range_base = m_cfi_data.GetGNUEHPointer(&offset, cie->ptr_encoding, pc_rel_addr, text_addr, data_addr);
404ea84e764SJason Molenda     lldb::addr_t range_len = m_cfi_data.GetGNUEHPointer(&offset, cie->ptr_encoding & DW_EH_PE_MASK_ENCODING, pc_rel_addr, text_addr, data_addr);
405fbcb7f2cSJason Molenda     AddressRange range (range_base, m_objfile.GetAddressByteSize(), m_objfile.GetSectionList());
406fbcb7f2cSJason Molenda     range.SetByteSize (range_len);
40730fdc8d8SChris Lattner 
40830fdc8d8SChris Lattner     if (cie->augmentation[0] == 'z')
40930fdc8d8SChris Lattner     {
41030fdc8d8SChris Lattner         uint32_t aug_data_len = (uint32_t)m_cfi_data.GetULEB128(&offset);
41130fdc8d8SChris Lattner         offset += aug_data_len;
41230fdc8d8SChris Lattner     }
41330fdc8d8SChris Lattner 
41430fdc8d8SChris Lattner     uint32_t reg_num = 0;
41530fdc8d8SChris Lattner     int32_t op_offset = 0;
41630fdc8d8SChris Lattner     uint32_t code_align = cie->code_align;
41730fdc8d8SChris Lattner     int32_t data_align = cie->data_align;
41830fdc8d8SChris Lattner 
419fbcb7f2cSJason Molenda     unwind_plan.SetPlanValidAddressRange (range);
4201d42c7bcSJason Molenda     UnwindPlan::Row *cie_initial_row = new UnwindPlan::Row;
4211d42c7bcSJason Molenda     *cie_initial_row = cie->initial_row;
4221d42c7bcSJason Molenda     UnwindPlan::RowSP row(cie_initial_row);
42330fdc8d8SChris Lattner 
424fbcb7f2cSJason Molenda     unwind_plan.SetRegisterKind (m_reg_kind);
4258eba46c6SJason Molenda     unwind_plan.SetReturnAddressRegister (cie->return_addr_reg_num);
426fbcb7f2cSJason Molenda 
427fbcb7f2cSJason Molenda     UnwindPlan::Row::RegisterLocation reg_location;
42830fdc8d8SChris Lattner     while (m_cfi_data.ValidOffset(offset) && offset < end_offset)
42930fdc8d8SChris Lattner     {
43030fdc8d8SChris Lattner         uint8_t inst = m_cfi_data.GetU8(&offset);
43130fdc8d8SChris Lattner         uint8_t primary_opcode  = inst & 0xC0;
43230fdc8d8SChris Lattner         uint8_t extended_opcode = inst & 0x3F;
43330fdc8d8SChris Lattner 
43430fdc8d8SChris Lattner         if (primary_opcode)
43530fdc8d8SChris Lattner         {
43630fdc8d8SChris Lattner             switch (primary_opcode)
43730fdc8d8SChris Lattner             {
43830fdc8d8SChris Lattner                 case DW_CFA_advance_loc :   // (Row Creation Instruction)
43930fdc8d8SChris Lattner                     {   // 0x40 - high 2 bits are 0x1, lower 6 bits are delta
44030fdc8d8SChris Lattner                         // takes a single argument that represents a constant delta. The
44130fdc8d8SChris Lattner                         // required action is to create a new table row with a location
44230fdc8d8SChris Lattner                         // value that is computed by taking the current entry's location
44330fdc8d8SChris Lattner                         // value and adding (delta * code_align). All other
44430fdc8d8SChris Lattner                         // values in the new row are initially identical to the current row.
445fbcb7f2cSJason Molenda                         unwind_plan.AppendRow(row);
446fa67e879SJason Molenda                         UnwindPlan::Row *newrow = new UnwindPlan::Row;
447fa67e879SJason Molenda                         *newrow = *row.get();
448fa67e879SJason Molenda                         row.reset (newrow);
4491d42c7bcSJason Molenda                         row->SlideOffset(extended_opcode * code_align);
45030fdc8d8SChris Lattner                     }
45130fdc8d8SChris Lattner                     break;
45230fdc8d8SChris Lattner 
45330fdc8d8SChris Lattner                 case DW_CFA_offset      :
45430fdc8d8SChris Lattner                     {   // 0x80 - high 2 bits are 0x2, lower 6 bits are register
45530fdc8d8SChris Lattner                         // takes two arguments: an unsigned LEB128 constant representing a
45630fdc8d8SChris Lattner                         // factored offset and a register number. The required action is to
45730fdc8d8SChris Lattner                         // change the rule for the register indicated by the register number
45830fdc8d8SChris Lattner                         // to be an offset(N) rule with a value of
45930fdc8d8SChris Lattner                         // (N = factored offset * data_align).
46030fdc8d8SChris Lattner                         reg_num = extended_opcode;
46130fdc8d8SChris Lattner                         op_offset = (int32_t)m_cfi_data.GetULEB128(&offset) * data_align;
46230fdc8d8SChris Lattner                         reg_location.SetAtCFAPlusOffset(op_offset);
4631d42c7bcSJason Molenda                         row->SetRegisterInfo (reg_num, reg_location);
46430fdc8d8SChris Lattner                     }
46530fdc8d8SChris Lattner                     break;
46630fdc8d8SChris Lattner 
46730fdc8d8SChris Lattner                 case DW_CFA_restore     :
46830fdc8d8SChris Lattner                     {   // 0xC0 - high 2 bits are 0x3, lower 6 bits are register
46930fdc8d8SChris Lattner                         // takes a single argument that represents a register number. The
47030fdc8d8SChris Lattner                         // required action is to change the rule for the indicated register
47130fdc8d8SChris Lattner                         // to the rule assigned it by the initial_instructions in the CIE.
47230fdc8d8SChris Lattner                         reg_num = extended_opcode;
47330fdc8d8SChris Lattner                         // We only keep enough register locations around to
47430fdc8d8SChris Lattner                         // unwind what is in our thread, and these are organized
47530fdc8d8SChris Lattner                         // by the register index in that state, so we need to convert our
476fbcb7f2cSJason Molenda                         // GCC register number from the EH frame info, to a register index
47730fdc8d8SChris Lattner 
4781d42c7bcSJason Molenda                         if (unwind_plan.IsValidRowIndex(0) && unwind_plan.GetRowAtIndex(0)->GetRegisterInfo(reg_num, reg_location))
4791d42c7bcSJason Molenda                             row->SetRegisterInfo (reg_num, reg_location);
48030fdc8d8SChris Lattner                     }
48130fdc8d8SChris Lattner                     break;
48230fdc8d8SChris Lattner             }
48330fdc8d8SChris Lattner         }
48430fdc8d8SChris Lattner         else
48530fdc8d8SChris Lattner         {
48630fdc8d8SChris Lattner             switch (extended_opcode)
48730fdc8d8SChris Lattner             {
48830fdc8d8SChris Lattner                 case DW_CFA_nop                 : // 0x0
48930fdc8d8SChris Lattner                     break;
49030fdc8d8SChris Lattner 
49130fdc8d8SChris Lattner                 case DW_CFA_set_loc             : // 0x1 (Row Creation Instruction)
49230fdc8d8SChris Lattner                     {
49330fdc8d8SChris Lattner                         // DW_CFA_set_loc takes a single argument that represents an address.
49430fdc8d8SChris Lattner                         // The required action is to create a new table row using the
49530fdc8d8SChris Lattner                         // specified address as the location. All other values in the new row
49630fdc8d8SChris Lattner                         // are initially identical to the current row. The new location value
49730fdc8d8SChris Lattner                         // should always be greater than the current one.
498fbcb7f2cSJason Molenda                         unwind_plan.AppendRow(row);
499fa67e879SJason Molenda                         UnwindPlan::Row *newrow = new UnwindPlan::Row;
500fa67e879SJason Molenda                         *newrow = *row.get();
501fa67e879SJason Molenda                         row.reset (newrow);
5021d42c7bcSJason Molenda                         row->SetOffset(m_cfi_data.GetPointer(&offset) - startaddr.GetFileAddress());
50330fdc8d8SChris Lattner                     }
50430fdc8d8SChris Lattner                     break;
50530fdc8d8SChris Lattner 
50630fdc8d8SChris Lattner                 case DW_CFA_advance_loc1        : // 0x2 (Row Creation Instruction)
50730fdc8d8SChris Lattner                     {
50830fdc8d8SChris Lattner                         // takes a single uword argument that represents a constant delta.
50930fdc8d8SChris Lattner                         // This instruction is identical to DW_CFA_advance_loc except for the
51030fdc8d8SChris Lattner                         // encoding and size of the delta argument.
511fbcb7f2cSJason Molenda                         unwind_plan.AppendRow(row);
512fa67e879SJason Molenda                         UnwindPlan::Row *newrow = new UnwindPlan::Row;
513fa67e879SJason Molenda                         *newrow = *row.get();
514fa67e879SJason Molenda                         row.reset (newrow);
5151d42c7bcSJason Molenda                         row->SlideOffset (m_cfi_data.GetU8(&offset) * code_align);
51630fdc8d8SChris Lattner                     }
51730fdc8d8SChris Lattner                     break;
51830fdc8d8SChris Lattner 
51930fdc8d8SChris Lattner                 case DW_CFA_advance_loc2        : // 0x3 (Row Creation Instruction)
52030fdc8d8SChris Lattner                     {
52130fdc8d8SChris Lattner                         // takes a single uword argument that represents a constant delta.
52230fdc8d8SChris Lattner                         // This instruction is identical to DW_CFA_advance_loc except for the
52330fdc8d8SChris Lattner                         // encoding and size of the delta argument.
524fbcb7f2cSJason Molenda                         unwind_plan.AppendRow(row);
525fa67e879SJason Molenda                         UnwindPlan::Row *newrow = new UnwindPlan::Row;
526fa67e879SJason Molenda                         *newrow = *row.get();
527fa67e879SJason Molenda                         row.reset (newrow);
5281d42c7bcSJason Molenda                         row->SlideOffset (m_cfi_data.GetU16(&offset) * code_align);
52930fdc8d8SChris Lattner                     }
53030fdc8d8SChris Lattner                     break;
53130fdc8d8SChris Lattner 
53230fdc8d8SChris Lattner                 case DW_CFA_advance_loc4        : // 0x4 (Row Creation Instruction)
53330fdc8d8SChris Lattner                     {
53430fdc8d8SChris Lattner                         // takes a single uword argument that represents a constant delta.
53530fdc8d8SChris Lattner                         // This instruction is identical to DW_CFA_advance_loc except for the
53630fdc8d8SChris Lattner                         // encoding and size of the delta argument.
537fbcb7f2cSJason Molenda                         unwind_plan.AppendRow(row);
538fa67e879SJason Molenda                         UnwindPlan::Row *newrow = new UnwindPlan::Row;
539fa67e879SJason Molenda                         *newrow = *row.get();
540fa67e879SJason Molenda                         row.reset (newrow);
5411d42c7bcSJason Molenda                         row->SlideOffset (m_cfi_data.GetU32(&offset) * code_align);
54230fdc8d8SChris Lattner                     }
54330fdc8d8SChris Lattner                     break;
54430fdc8d8SChris Lattner 
54530fdc8d8SChris Lattner                 case DW_CFA_offset_extended     : // 0x5
54630fdc8d8SChris Lattner                     {
54730fdc8d8SChris Lattner                         // takes two unsigned LEB128 arguments representing a register number
54830fdc8d8SChris Lattner                         // and a factored offset. This instruction is identical to DW_CFA_offset
54930fdc8d8SChris Lattner                         // except for the encoding and size of the register argument.
55030fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
55130fdc8d8SChris Lattner                         op_offset = (int32_t)m_cfi_data.GetULEB128(&offset) * data_align;
55230fdc8d8SChris Lattner                         reg_location.SetAtCFAPlusOffset(op_offset);
5531d42c7bcSJason Molenda                         row->SetRegisterInfo (reg_num, reg_location);
55430fdc8d8SChris Lattner                     }
55530fdc8d8SChris Lattner                     break;
55630fdc8d8SChris Lattner 
55730fdc8d8SChris Lattner                 case DW_CFA_restore_extended    : // 0x6
55830fdc8d8SChris Lattner                     {
55930fdc8d8SChris Lattner                         // takes a single unsigned LEB128 argument that represents a register
56030fdc8d8SChris Lattner                         // number. This instruction is identical to DW_CFA_restore except for
56130fdc8d8SChris Lattner                         // the encoding and size of the register argument.
56230fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
5631d42c7bcSJason Molenda                         if (unwind_plan.IsValidRowIndex(0) && unwind_plan.GetRowAtIndex(0)->GetRegisterInfo(reg_num, reg_location))
5641d42c7bcSJason Molenda                             row->SetRegisterInfo (reg_num, reg_location);
56530fdc8d8SChris Lattner                     }
56630fdc8d8SChris Lattner                     break;
56730fdc8d8SChris Lattner 
56830fdc8d8SChris Lattner                 case DW_CFA_undefined           : // 0x7
56930fdc8d8SChris Lattner                     {
57030fdc8d8SChris Lattner                         // takes a single unsigned LEB128 argument that represents a register
57130fdc8d8SChris Lattner                         // number. The required action is to set the rule for the specified
57230fdc8d8SChris Lattner                         // register to undefined.
57330fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
57430fdc8d8SChris Lattner                         reg_location.SetUndefined();
5751d42c7bcSJason Molenda                         row->SetRegisterInfo (reg_num, reg_location);
57630fdc8d8SChris Lattner                     }
57730fdc8d8SChris Lattner                     break;
57830fdc8d8SChris Lattner 
57930fdc8d8SChris Lattner                 case DW_CFA_same_value          : // 0x8
58030fdc8d8SChris Lattner                     {
58130fdc8d8SChris Lattner                         // takes a single unsigned LEB128 argument that represents a register
58230fdc8d8SChris Lattner                         // number. The required action is to set the rule for the specified
58330fdc8d8SChris Lattner                         // register to same value.
58430fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
58530fdc8d8SChris Lattner                         reg_location.SetSame();
5861d42c7bcSJason Molenda                         row->SetRegisterInfo (reg_num, reg_location);
58730fdc8d8SChris Lattner                     }
58830fdc8d8SChris Lattner                     break;
58930fdc8d8SChris Lattner 
59030fdc8d8SChris Lattner                 case DW_CFA_register            : // 0x9
59130fdc8d8SChris Lattner                     {
59230fdc8d8SChris Lattner                         // takes two unsigned LEB128 arguments representing register numbers.
59330fdc8d8SChris Lattner                         // The required action is to set the rule for the first register to be
59430fdc8d8SChris Lattner                         // the second register.
59530fdc8d8SChris Lattner 
59630fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
59730fdc8d8SChris Lattner                         uint32_t other_reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
59830fdc8d8SChris Lattner                         reg_location.SetInRegister(other_reg_num);
5991d42c7bcSJason Molenda                         row->SetRegisterInfo (reg_num, reg_location);
60030fdc8d8SChris Lattner                     }
60130fdc8d8SChris Lattner                     break;
60230fdc8d8SChris Lattner 
60330fdc8d8SChris Lattner                 case DW_CFA_remember_state      : // 0xA
604fa67e879SJason Molenda                     {
60530fdc8d8SChris Lattner                         // These instructions define a stack of information. Encountering the
60630fdc8d8SChris Lattner                         // DW_CFA_remember_state instruction means to save the rules for every
60730fdc8d8SChris Lattner                         // register on the current row on the stack. Encountering the
60830fdc8d8SChris Lattner                         // DW_CFA_restore_state instruction means to pop the set of rules off
60930fdc8d8SChris Lattner                         // the stack and place them in the current row. (This operation is
61030fdc8d8SChris Lattner                         // useful for compilers that move epilogue code into the body of a
61130fdc8d8SChris Lattner                         // function.)
612fbcb7f2cSJason Molenda                         unwind_plan.AppendRow (row);
613fa67e879SJason Molenda                         UnwindPlan::Row *newrow = new UnwindPlan::Row;
614fa67e879SJason Molenda                         *newrow = *row.get();
615fa67e879SJason Molenda                         row.reset (newrow);
616fa67e879SJason Molenda                     }
61730fdc8d8SChris Lattner                     break;
61830fdc8d8SChris Lattner 
61930fdc8d8SChris Lattner                 case DW_CFA_restore_state       : // 0xB
62030fdc8d8SChris Lattner                     // These instructions define a stack of information. Encountering the
62130fdc8d8SChris Lattner                     // DW_CFA_remember_state instruction means to save the rules for every
62230fdc8d8SChris Lattner                     // register on the current row on the stack. Encountering the
62330fdc8d8SChris Lattner                     // DW_CFA_restore_state instruction means to pop the set of rules off
62430fdc8d8SChris Lattner                     // the stack and place them in the current row. (This operation is
62530fdc8d8SChris Lattner                     // useful for compilers that move epilogue code into the body of a
62630fdc8d8SChris Lattner                     // function.)
62730fdc8d8SChris Lattner                     {
628fbcb7f2cSJason Molenda                         row = unwind_plan.GetRowAtIndex(unwind_plan.GetRowCount() - 1);
62930fdc8d8SChris Lattner                     }
63030fdc8d8SChris Lattner                     break;
63130fdc8d8SChris Lattner 
63230fdc8d8SChris Lattner                 case DW_CFA_def_cfa             : // 0xC    (CFA Definition Instruction)
63330fdc8d8SChris Lattner                     {
63430fdc8d8SChris Lattner                         // Takes two unsigned LEB128 operands representing a register
63530fdc8d8SChris Lattner                         // number and a (non-factored) offset. The required action
63630fdc8d8SChris Lattner                         // is to define the current CFA rule to use the provided
63730fdc8d8SChris Lattner                         // register and offset.
63830fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
63930fdc8d8SChris Lattner                         op_offset = (int32_t)m_cfi_data.GetULEB128(&offset);
6401d42c7bcSJason Molenda                         row->SetCFARegister (reg_num);
6411d42c7bcSJason Molenda                         row->SetCFAOffset (op_offset);
64230fdc8d8SChris Lattner                     }
64330fdc8d8SChris Lattner                     break;
64430fdc8d8SChris Lattner 
64530fdc8d8SChris Lattner                 case DW_CFA_def_cfa_register    : // 0xD    (CFA Definition Instruction)
64630fdc8d8SChris Lattner                     {
64730fdc8d8SChris Lattner                         // takes a single unsigned LEB128 argument representing a register
64830fdc8d8SChris Lattner                         // number. The required action is to define the current CFA rule to
64930fdc8d8SChris Lattner                         // use the provided register (but to keep the old offset).
65030fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
6511d42c7bcSJason Molenda                         row->SetCFARegister (reg_num);
65230fdc8d8SChris Lattner                     }
65330fdc8d8SChris Lattner                     break;
65430fdc8d8SChris Lattner 
65530fdc8d8SChris Lattner                 case DW_CFA_def_cfa_offset      : // 0xE    (CFA Definition Instruction)
65630fdc8d8SChris Lattner                     {
65730fdc8d8SChris Lattner                         // Takes a single unsigned LEB128 operand representing a
65830fdc8d8SChris Lattner                         // (non-factored) offset. The required action is to define
65930fdc8d8SChris Lattner                         // the current CFA rule to use the provided offset (but
66030fdc8d8SChris Lattner                         // to keep the old register).
66130fdc8d8SChris Lattner                         op_offset = (int32_t)m_cfi_data.GetULEB128(&offset);
6621d42c7bcSJason Molenda                         row->SetCFAOffset (op_offset);
66330fdc8d8SChris Lattner                     }
66430fdc8d8SChris Lattner                     break;
66530fdc8d8SChris Lattner 
66630fdc8d8SChris Lattner                 case DW_CFA_def_cfa_expression  : // 0xF    (CFA Definition Instruction)
66730fdc8d8SChris Lattner                     {
66830fdc8d8SChris Lattner                         size_t block_len = (size_t)m_cfi_data.GetULEB128(&offset);
66930fdc8d8SChris Lattner                         offset += (uint32_t)block_len;
67030fdc8d8SChris Lattner                     }
67130fdc8d8SChris Lattner                     break;
67230fdc8d8SChris Lattner 
67330fdc8d8SChris Lattner                 case DW_CFA_expression          : // 0x10
67430fdc8d8SChris Lattner                     {
67530fdc8d8SChris Lattner                         // Takes two operands: an unsigned LEB128 value representing
67630fdc8d8SChris Lattner                         // a register number, and a DW_FORM_block value representing a DWARF
67730fdc8d8SChris Lattner                         // expression. The required action is to change the rule for the
67830fdc8d8SChris Lattner                         // register indicated by the register number to be an expression(E)
67930fdc8d8SChris Lattner                         // rule where E is the DWARF expression. That is, the DWARF
68030fdc8d8SChris Lattner                         // expression computes the address. The value of the CFA is
68130fdc8d8SChris Lattner                         // pushed on the DWARF evaluation stack prior to execution of
68230fdc8d8SChris Lattner                         // the DWARF expression.
68330fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
68430fdc8d8SChris Lattner                         uint32_t block_len = (uint32_t)m_cfi_data.GetULEB128(&offset);
68530fdc8d8SChris Lattner                         const uint8_t *block_data = (uint8_t *)m_cfi_data.GetData(&offset, block_len);
68630fdc8d8SChris Lattner 
68730fdc8d8SChris Lattner                         reg_location.SetAtDWARFExpression(block_data, block_len);
6881d42c7bcSJason Molenda                         row->SetRegisterInfo (reg_num, reg_location);
68930fdc8d8SChris Lattner                     }
69030fdc8d8SChris Lattner                     break;
69130fdc8d8SChris Lattner 
69230fdc8d8SChris Lattner                 case DW_CFA_offset_extended_sf  : // 0x11
69330fdc8d8SChris Lattner                     {
69430fdc8d8SChris Lattner                         // takes two operands: an unsigned LEB128 value representing a
69530fdc8d8SChris Lattner                         // register number and a signed LEB128 factored offset. This
69630fdc8d8SChris Lattner                         // instruction is identical to DW_CFA_offset_extended except
69730fdc8d8SChris Lattner                         //that the second operand is signed and factored.
69830fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
69930fdc8d8SChris Lattner                         op_offset = (int32_t)m_cfi_data.GetSLEB128(&offset) * data_align;
70030fdc8d8SChris Lattner                         reg_location.SetAtCFAPlusOffset(op_offset);
7011d42c7bcSJason Molenda                         row->SetRegisterInfo (reg_num, reg_location);
70230fdc8d8SChris Lattner                     }
70330fdc8d8SChris Lattner                     break;
70430fdc8d8SChris Lattner 
70530fdc8d8SChris Lattner                 case DW_CFA_def_cfa_sf          : // 0x12   (CFA Definition Instruction)
70630fdc8d8SChris Lattner                     {
70730fdc8d8SChris Lattner                         // Takes two operands: an unsigned LEB128 value representing
70830fdc8d8SChris Lattner                         // a register number and a signed LEB128 factored offset.
70930fdc8d8SChris Lattner                         // This instruction is identical to DW_CFA_def_cfa except
71030fdc8d8SChris Lattner                         // that the second operand is signed and factored.
71130fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
71230fdc8d8SChris Lattner                         op_offset = (int32_t)m_cfi_data.GetSLEB128(&offset) * data_align;
7131d42c7bcSJason Molenda                         row->SetCFARegister (reg_num);
7141d42c7bcSJason Molenda                         row->SetCFAOffset (op_offset);
71530fdc8d8SChris Lattner                     }
71630fdc8d8SChris Lattner                     break;
71730fdc8d8SChris Lattner 
71830fdc8d8SChris Lattner                 case DW_CFA_def_cfa_offset_sf   : // 0x13   (CFA Definition Instruction)
71930fdc8d8SChris Lattner                     {
72030fdc8d8SChris Lattner                         // takes a signed LEB128 operand representing a factored
72130fdc8d8SChris Lattner                         // offset. This instruction is identical to  DW_CFA_def_cfa_offset
72230fdc8d8SChris Lattner                         // except that the operand is signed and factored.
72330fdc8d8SChris Lattner                         op_offset = (int32_t)m_cfi_data.GetSLEB128(&offset) * data_align;
7241d42c7bcSJason Molenda                         row->SetCFAOffset (op_offset);
72530fdc8d8SChris Lattner                     }
72630fdc8d8SChris Lattner                     break;
72730fdc8d8SChris Lattner 
72830fdc8d8SChris Lattner                 case DW_CFA_val_expression      :   // 0x16
72930fdc8d8SChris Lattner                     {
73030fdc8d8SChris Lattner                         // takes two operands: an unsigned LEB128 value representing a register
73130fdc8d8SChris Lattner                         // number, and a DW_FORM_block value representing a DWARF expression.
73230fdc8d8SChris Lattner                         // The required action is to change the rule for the register indicated
73330fdc8d8SChris Lattner                         // by the register number to be a val_expression(E) rule where E is the
73430fdc8d8SChris Lattner                         // DWARF expression. That is, the DWARF expression computes the value of
73530fdc8d8SChris Lattner                         // the given register. The value of the CFA is pushed on the DWARF
73630fdc8d8SChris Lattner                         // evaluation stack prior to execution of the DWARF expression.
73730fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
73830fdc8d8SChris Lattner                         uint32_t block_len = (uint32_t)m_cfi_data.GetULEB128(&offset);
73930fdc8d8SChris Lattner                         const uint8_t* block_data = (uint8_t*)m_cfi_data.GetData(&offset, block_len);
74030fdc8d8SChris Lattner //#if defined(__i386__) || defined(__x86_64__)
74130fdc8d8SChris Lattner //                      // The EH frame info for EIP and RIP contains code that looks for traps to
74230fdc8d8SChris Lattner //                      // be a specific type and increments the PC.
74330fdc8d8SChris Lattner //                      // For i386:
74430fdc8d8SChris Lattner //                      // DW_CFA_val_expression where:
74530fdc8d8SChris Lattner //                      // eip = DW_OP_breg6(+28), DW_OP_deref, DW_OP_dup, DW_OP_plus_uconst(0x34),
74630fdc8d8SChris Lattner //                      //       DW_OP_deref, DW_OP_swap, DW_OP_plus_uconst(0), DW_OP_deref,
74730fdc8d8SChris Lattner //                      //       DW_OP_dup, DW_OP_lit3, DW_OP_ne, DW_OP_swap, DW_OP_lit4, DW_OP_ne,
74830fdc8d8SChris Lattner //                      //       DW_OP_and, DW_OP_plus
74930fdc8d8SChris Lattner //                      // This basically does a:
75030fdc8d8SChris Lattner //                      // eip = ucontenxt.mcontext32->gpr.eip;
75130fdc8d8SChris Lattner //                      // if (ucontenxt.mcontext32->exc.trapno != 3 && ucontenxt.mcontext32->exc.trapno != 4)
75230fdc8d8SChris Lattner //                      //   eip++;
75330fdc8d8SChris Lattner //                      //
75430fdc8d8SChris Lattner //                      // For x86_64:
75530fdc8d8SChris Lattner //                      // DW_CFA_val_expression where:
75630fdc8d8SChris Lattner //                      // rip =  DW_OP_breg3(+48), DW_OP_deref, DW_OP_dup, DW_OP_plus_uconst(0x90), DW_OP_deref,
75730fdc8d8SChris Lattner //                      //          DW_OP_swap, DW_OP_plus_uconst(0), DW_OP_deref_size(4), DW_OP_dup, DW_OP_lit3,
75830fdc8d8SChris Lattner //                      //          DW_OP_ne, DW_OP_swap, DW_OP_lit4, DW_OP_ne, DW_OP_and, DW_OP_plus
75930fdc8d8SChris Lattner //                      // This basically does a:
76030fdc8d8SChris Lattner //                      // rip = ucontenxt.mcontext64->gpr.rip;
76130fdc8d8SChris Lattner //                      // if (ucontenxt.mcontext64->exc.trapno != 3 && ucontenxt.mcontext64->exc.trapno != 4)
76230fdc8d8SChris Lattner //                      //   rip++;
76330fdc8d8SChris Lattner //                      // The trap comparisons and increments are not needed as it hoses up the unwound PC which
76430fdc8d8SChris Lattner //                      // is expected to point at least past the instruction that causes the fault/trap. So we
76530fdc8d8SChris Lattner //                      // take it out by trimming the expression right at the first "DW_OP_swap" opcodes
76630fdc8d8SChris Lattner //                      if (block_data != NULL && thread->GetPCRegNum(Thread::GCC) == reg_num)
76730fdc8d8SChris Lattner //                      {
76830fdc8d8SChris Lattner //                          if (thread->Is64Bit())
76930fdc8d8SChris Lattner //                          {
77030fdc8d8SChris Lattner //                              if (block_len > 9 && block_data[8] == DW_OP_swap && block_data[9] == DW_OP_plus_uconst)
77130fdc8d8SChris Lattner //                                  block_len = 8;
77230fdc8d8SChris Lattner //                          }
77330fdc8d8SChris Lattner //                          else
77430fdc8d8SChris Lattner //                          {
77530fdc8d8SChris Lattner //                              if (block_len > 8 && block_data[7] == DW_OP_swap && block_data[8] == DW_OP_plus_uconst)
77630fdc8d8SChris Lattner //                                  block_len = 7;
77730fdc8d8SChris Lattner //                          }
77830fdc8d8SChris Lattner //                      }
77930fdc8d8SChris Lattner //#endif
78030fdc8d8SChris Lattner                         reg_location.SetIsDWARFExpression(block_data, block_len);
7811d42c7bcSJason Molenda                         row->SetRegisterInfo (reg_num, reg_location);
78230fdc8d8SChris Lattner                     }
78330fdc8d8SChris Lattner                     break;
78430fdc8d8SChris Lattner 
78530fdc8d8SChris Lattner                 case DW_CFA_val_offset          :   // 0x14
78630fdc8d8SChris Lattner                 case DW_CFA_val_offset_sf       :   // 0x15
78730fdc8d8SChris Lattner                 default:
78830fdc8d8SChris Lattner                     break;
78930fdc8d8SChris Lattner             }
79030fdc8d8SChris Lattner         }
79130fdc8d8SChris Lattner     }
792fbcb7f2cSJason Molenda     unwind_plan.AppendRow(row);
79330fdc8d8SChris Lattner 
794fbcb7f2cSJason Molenda     return true;
79530fdc8d8SChris Lattner }
796