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/Symbol/DWARFCallFrameInfo.h"
1830fdc8d8SChris Lattner #include "lldb/Core/ArchSpec.h"
1930fdc8d8SChris Lattner #include "lldb/Core/Module.h"
2030fdc8d8SChris Lattner #include "lldb/Symbol/ObjectFile.h"
2130fdc8d8SChris Lattner #include "lldb/Target/RegisterContext.h"
2230fdc8d8SChris Lattner #include "lldb/Core/Section.h"
2330fdc8d8SChris Lattner #include "lldb/Target/Thread.h"
24fbcb7f2cSJason Molenda #include "lldb/Symbol/UnwindPlan.h"
2530fdc8d8SChris Lattner 
2630fdc8d8SChris Lattner using namespace lldb;
2730fdc8d8SChris Lattner using namespace lldb_private;
2830fdc8d8SChris Lattner 
29fbcb7f2cSJason Molenda DWARFCallFrameInfo::DWARFCallFrameInfo(ObjectFile& objfile, SectionSP& section, uint32_t reg_kind, bool is_eh_frame) :
3030fdc8d8SChris Lattner     m_objfile (objfile),
3130fdc8d8SChris Lattner     m_section (section),
32fbcb7f2cSJason Molenda     m_reg_kind (reg_kind),  // The flavor of registers that the CFI data uses (enum RegisterKind)
3330fdc8d8SChris Lattner     m_cie_map (),
34fbcb7f2cSJason Molenda     m_cfi_data (),
35fbcb7f2cSJason Molenda     m_cfi_data_initialized (false),
36fbcb7f2cSJason Molenda     m_fde_index (),
37fbcb7f2cSJason Molenda     m_fde_index_initialized (false),
38fa19c3e7SJason Molenda     m_is_eh_frame (is_eh_frame),
39fa19c3e7SJason Molenda     m_flags ()
4030fdc8d8SChris Lattner {
4130fdc8d8SChris Lattner }
4230fdc8d8SChris Lattner 
4330fdc8d8SChris Lattner DWARFCallFrameInfo::~DWARFCallFrameInfo()
4430fdc8d8SChris Lattner {
4530fdc8d8SChris Lattner }
4630fdc8d8SChris Lattner 
47fbcb7f2cSJason Molenda 
4830fdc8d8SChris Lattner bool
49fbcb7f2cSJason Molenda DWARFCallFrameInfo::GetAddressRange (Address addr, AddressRange &range)
5030fdc8d8SChris Lattner {
51fbcb7f2cSJason Molenda     FDEEntry fde_entry;
52fbcb7f2cSJason Molenda     if (GetFDEEntryByAddress (addr, fde_entry) == false)
53fbcb7f2cSJason Molenda         return false;
54fbcb7f2cSJason Molenda     range = fde_entry.bounds;
55fbcb7f2cSJason Molenda     return true;
5630fdc8d8SChris Lattner }
5730fdc8d8SChris Lattner 
58fbcb7f2cSJason Molenda bool
59fbcb7f2cSJason Molenda DWARFCallFrameInfo::GetUnwindPlan (Address addr, UnwindPlan& unwind_plan)
6030fdc8d8SChris Lattner {
61fbcb7f2cSJason Molenda     FDEEntry fde_entry;
62fbcb7f2cSJason Molenda     if (GetFDEEntryByAddress (addr, fde_entry) == false)
63fbcb7f2cSJason Molenda         return false;
64fbcb7f2cSJason Molenda     return FDEToUnwindPlan (fde_entry.offset, addr, unwind_plan);
6530fdc8d8SChris Lattner }
6630fdc8d8SChris Lattner 
67fbcb7f2cSJason Molenda bool
68fbcb7f2cSJason Molenda DWARFCallFrameInfo::GetFDEEntryByAddress (Address addr, FDEEntry& fde_entry)
6930fdc8d8SChris Lattner {
70*8fe0c8c6SJason Molenda     if (m_section.get() == NULL || m_section->IsEncrypted())
71fbcb7f2cSJason Molenda         return false;
72fbcb7f2cSJason Molenda     GetFDEIndex();
73fbcb7f2cSJason Molenda 
74fbcb7f2cSJason Molenda     struct FDEEntry searchfde;
75fbcb7f2cSJason Molenda     searchfde.bounds = AddressRange (addr, 1);
76fbcb7f2cSJason Molenda 
77fbcb7f2cSJason Molenda     std::vector<FDEEntry>::const_iterator idx;
78fbcb7f2cSJason Molenda     if (m_fde_index.size() == 0)
79fbcb7f2cSJason Molenda         return false;
80fbcb7f2cSJason Molenda 
81fbcb7f2cSJason Molenda     idx = std::lower_bound (m_fde_index.begin(), m_fde_index.end(), searchfde);
82fbcb7f2cSJason Molenda     if (idx == m_fde_index.end())
83fbcb7f2cSJason Molenda     {
84fbcb7f2cSJason Molenda         --idx;
85fbcb7f2cSJason Molenda     }
86*8fe0c8c6SJason Molenda     if (idx != m_fde_index.begin() && !idx->bounds.ContainsFileAddress (addr))
87fbcb7f2cSJason Molenda     {
88fbcb7f2cSJason Molenda        --idx;
89fbcb7f2cSJason Molenda     }
90fbcb7f2cSJason Molenda     if (idx->bounds.ContainsFileAddress (addr))
91fbcb7f2cSJason Molenda     {
92fbcb7f2cSJason Molenda         fde_entry = *idx;
93fbcb7f2cSJason Molenda         return true;
9430fdc8d8SChris Lattner     }
9530fdc8d8SChris Lattner 
96fbcb7f2cSJason Molenda     return false;
9730fdc8d8SChris Lattner }
9830fdc8d8SChris Lattner 
9930fdc8d8SChris Lattner const DWARFCallFrameInfo::CIE*
10030fdc8d8SChris Lattner DWARFCallFrameInfo::GetCIE(dw_offset_t cie_offset)
10130fdc8d8SChris Lattner {
10230fdc8d8SChris Lattner     cie_map_t::iterator pos = m_cie_map.find(cie_offset);
10330fdc8d8SChris Lattner 
10430fdc8d8SChris Lattner     if (pos != m_cie_map.end())
10530fdc8d8SChris Lattner     {
10630fdc8d8SChris Lattner         // Parse and cache the CIE
10730fdc8d8SChris Lattner         if (pos->second.get() == NULL)
10830fdc8d8SChris Lattner             pos->second = ParseCIE (cie_offset);
10930fdc8d8SChris Lattner 
11030fdc8d8SChris Lattner         return pos->second.get();
11130fdc8d8SChris Lattner     }
11230fdc8d8SChris Lattner     return NULL;
11330fdc8d8SChris Lattner }
11430fdc8d8SChris Lattner 
115fbcb7f2cSJason Molenda DWARFCallFrameInfo::CIESP
11630fdc8d8SChris Lattner DWARFCallFrameInfo::ParseCIE (const dw_offset_t cie_offset)
11730fdc8d8SChris Lattner {
118fbcb7f2cSJason Molenda     CIESP cie_sp(new CIE(cie_offset));
11930fdc8d8SChris Lattner     dw_offset_t offset = cie_offset;
120fbcb7f2cSJason Molenda     if (m_cfi_data_initialized == false)
121fbcb7f2cSJason Molenda     {
122fbcb7f2cSJason Molenda         m_section->ReadSectionDataFromObjectFile (&m_objfile, m_cfi_data);
123fbcb7f2cSJason Molenda         m_cfi_data_initialized = true;
124fbcb7f2cSJason Molenda     }
12530fdc8d8SChris Lattner     const uint32_t length = m_cfi_data.GetU32(&offset);
12630fdc8d8SChris Lattner     const dw_offset_t cie_id = m_cfi_data.GetU32(&offset);
12730fdc8d8SChris Lattner     const dw_offset_t end_offset = cie_offset + length + 4;
128fbcb7f2cSJason Molenda     if (length > 0 && (!m_is_eh_frame && cie_id == 0xfffffffful) || (m_is_eh_frame && cie_id == 0ul))
12930fdc8d8SChris Lattner     {
13030fdc8d8SChris Lattner         size_t i;
13130fdc8d8SChris Lattner         //    cie.offset = cie_offset;
13230fdc8d8SChris Lattner         //    cie.length = length;
13330fdc8d8SChris Lattner         //    cie.cieID = cieID;
134ea84e764SJason Molenda         cie_sp->ptr_encoding = DW_EH_PE_absptr;
13530fdc8d8SChris Lattner         cie_sp->version = m_cfi_data.GetU8(&offset);
13630fdc8d8SChris Lattner 
13730fdc8d8SChris Lattner         for (i=0; i<CFI_AUG_MAX_SIZE; ++i)
13830fdc8d8SChris Lattner         {
13930fdc8d8SChris Lattner             cie_sp->augmentation[i] = m_cfi_data.GetU8(&offset);
14030fdc8d8SChris Lattner             if (cie_sp->augmentation[i] == '\0')
14130fdc8d8SChris Lattner             {
14230fdc8d8SChris Lattner                 // Zero out remaining bytes in augmentation string
14330fdc8d8SChris Lattner                 for (size_t j = i+1; j<CFI_AUG_MAX_SIZE; ++j)
14430fdc8d8SChris Lattner                     cie_sp->augmentation[j] = '\0';
14530fdc8d8SChris Lattner 
14630fdc8d8SChris Lattner                 break;
14730fdc8d8SChris Lattner             }
14830fdc8d8SChris Lattner         }
14930fdc8d8SChris Lattner 
15030fdc8d8SChris Lattner         if (i == CFI_AUG_MAX_SIZE && cie_sp->augmentation[CFI_AUG_MAX_SIZE-1] != '\0')
15130fdc8d8SChris Lattner         {
15230fdc8d8SChris Lattner             fprintf(stderr, "CIE parse error: CIE augmentation string was too large for the fixed sized buffer of %d bytes.\n", CFI_AUG_MAX_SIZE);
15330fdc8d8SChris Lattner             return cie_sp;
15430fdc8d8SChris Lattner         }
15530fdc8d8SChris Lattner         cie_sp->code_align = (uint32_t)m_cfi_data.GetULEB128(&offset);
15630fdc8d8SChris Lattner         cie_sp->data_align = (int32_t)m_cfi_data.GetSLEB128(&offset);
15730fdc8d8SChris Lattner         cie_sp->return_addr_reg_num = m_cfi_data.GetU8(&offset);
15830fdc8d8SChris Lattner 
15930fdc8d8SChris Lattner         if (cie_sp->augmentation[0])
16030fdc8d8SChris Lattner         {
16130fdc8d8SChris Lattner             // Get the length of the eh_frame augmentation data
16230fdc8d8SChris Lattner             // which starts with a ULEB128 length in bytes
16330fdc8d8SChris Lattner             const size_t aug_data_len = (size_t)m_cfi_data.GetULEB128(&offset);
16430fdc8d8SChris Lattner             const size_t aug_data_end = offset + aug_data_len;
16530fdc8d8SChris Lattner             const size_t aug_str_len = strlen(cie_sp->augmentation);
16630fdc8d8SChris Lattner             // A 'z' may be present as the first character of the string.
16730fdc8d8SChris Lattner             // If present, the Augmentation Data field shall be present.
16830fdc8d8SChris Lattner             // The contents of the Augmentation Data shall be intepreted
16930fdc8d8SChris Lattner             // according to other characters in the Augmentation String.
17030fdc8d8SChris Lattner             if (cie_sp->augmentation[0] == 'z')
17130fdc8d8SChris Lattner             {
17230fdc8d8SChris Lattner                 // Extract the Augmentation Data
17330fdc8d8SChris Lattner                 size_t aug_str_idx = 0;
17430fdc8d8SChris Lattner                 for (aug_str_idx = 1; aug_str_idx < aug_str_len; aug_str_idx++)
17530fdc8d8SChris Lattner                 {
17630fdc8d8SChris Lattner                     char aug = cie_sp->augmentation[aug_str_idx];
17730fdc8d8SChris Lattner                     switch (aug)
17830fdc8d8SChris Lattner                     {
17930fdc8d8SChris Lattner                         case 'L':
18030fdc8d8SChris Lattner                             // Indicates the presence of one argument in the
18130fdc8d8SChris Lattner                             // Augmentation Data of the CIE, and a corresponding
18230fdc8d8SChris Lattner                             // argument in the Augmentation Data of the FDE. The
18330fdc8d8SChris Lattner                             // argument in the Augmentation Data of the CIE is
18430fdc8d8SChris Lattner                             // 1-byte and represents the pointer encoding used
18530fdc8d8SChris Lattner                             // for the argument in the Augmentation Data of the
18630fdc8d8SChris Lattner                             // FDE, which is the address of a language-specific
18730fdc8d8SChris Lattner                             // data area (LSDA). The size of the LSDA pointer is
18830fdc8d8SChris Lattner                             // specified by the pointer encoding used.
18930fdc8d8SChris Lattner                             m_cfi_data.GetU8(&offset);
19030fdc8d8SChris Lattner                             break;
19130fdc8d8SChris Lattner 
19230fdc8d8SChris Lattner                         case 'P':
19330fdc8d8SChris Lattner                             // Indicates the presence of two arguments in the
19430fdc8d8SChris Lattner                             // Augmentation Data of the cie_sp-> The first argument
19530fdc8d8SChris Lattner                             // is 1-byte and represents the pointer encoding
19630fdc8d8SChris Lattner                             // used for the second argument, which is the
19730fdc8d8SChris Lattner                             // address of a personality routine handler. The
19830fdc8d8SChris Lattner                             // size of the personality routine pointer is
19930fdc8d8SChris Lattner                             // specified by the pointer encoding used.
20030fdc8d8SChris Lattner                         {
20130fdc8d8SChris Lattner                             uint8_t arg_ptr_encoding = m_cfi_data.GetU8(&offset);
20230fdc8d8SChris Lattner                             m_cfi_data.GetGNUEHPointer(&offset, arg_ptr_encoding, LLDB_INVALID_ADDRESS, LLDB_INVALID_ADDRESS, LLDB_INVALID_ADDRESS);
20330fdc8d8SChris Lattner                         }
20430fdc8d8SChris Lattner                             break;
20530fdc8d8SChris Lattner 
20630fdc8d8SChris Lattner                         case 'R':
20730fdc8d8SChris Lattner                             // A 'R' may be present at any position after the
20830fdc8d8SChris Lattner                             // first character of the string. The Augmentation
20930fdc8d8SChris Lattner                             // Data shall include a 1 byte argument that
21030fdc8d8SChris Lattner                             // represents the pointer encoding for the address
21130fdc8d8SChris Lattner                             // pointers used in the FDE.
21230fdc8d8SChris Lattner                             cie_sp->ptr_encoding = m_cfi_data.GetU8(&offset);
21330fdc8d8SChris Lattner                             break;
21430fdc8d8SChris Lattner                     }
21530fdc8d8SChris Lattner                 }
21630fdc8d8SChris Lattner             }
21730fdc8d8SChris Lattner             else if (strcmp(cie_sp->augmentation, "eh") == 0)
21830fdc8d8SChris Lattner             {
21930fdc8d8SChris Lattner                 // If the Augmentation string has the value "eh", then
22030fdc8d8SChris Lattner                 // the EH Data field shall be present
22130fdc8d8SChris Lattner             }
22230fdc8d8SChris Lattner 
22330fdc8d8SChris Lattner             // Set the offset to be the end of the augmentation data just in case
22430fdc8d8SChris Lattner             // we didn't understand any of the data.
22530fdc8d8SChris Lattner             offset = (uint32_t)aug_data_end;
22630fdc8d8SChris Lattner         }
22730fdc8d8SChris Lattner 
22830fdc8d8SChris Lattner         if (end_offset > offset)
22930fdc8d8SChris Lattner         {
23030fdc8d8SChris Lattner             cie_sp->inst_offset = offset;
23130fdc8d8SChris Lattner             cie_sp->inst_length = end_offset - offset;
23230fdc8d8SChris Lattner         }
233fbcb7f2cSJason Molenda         while (offset < end_offset)
234fbcb7f2cSJason Molenda         {
235fbcb7f2cSJason Molenda             uint8_t inst = m_cfi_data.GetU8(&offset);
236fbcb7f2cSJason Molenda             uint8_t primary_opcode  = inst & 0xC0;
237fbcb7f2cSJason Molenda             uint8_t extended_opcode = inst & 0x3F;
238fbcb7f2cSJason Molenda 
239fbcb7f2cSJason Molenda             if (extended_opcode == DW_CFA_def_cfa)
240fbcb7f2cSJason Molenda             {
241fbcb7f2cSJason Molenda                 // Takes two unsigned LEB128 operands representing a register
242fbcb7f2cSJason Molenda                 // number and a (non-factored) offset. The required action
243fbcb7f2cSJason Molenda                 // is to define the current CFA rule to use the provided
244fbcb7f2cSJason Molenda                 // register and offset.
245fbcb7f2cSJason Molenda                 uint32_t reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
246fbcb7f2cSJason Molenda                 int op_offset = (int32_t)m_cfi_data.GetULEB128(&offset);
247fbcb7f2cSJason Molenda                 cie_sp->initial_row.SetCFARegister (reg_num);
248fbcb7f2cSJason Molenda                 cie_sp->initial_row.SetCFAOffset (op_offset);
249fbcb7f2cSJason Molenda                 continue;
250fbcb7f2cSJason Molenda             }
251fbcb7f2cSJason Molenda             if (primary_opcode == DW_CFA_offset)
252fbcb7f2cSJason Molenda             {
253fbcb7f2cSJason Molenda                 // 0x80 - high 2 bits are 0x2, lower 6 bits are register.
254fbcb7f2cSJason Molenda                 // Takes two arguments: an unsigned LEB128 constant representing a
255fbcb7f2cSJason Molenda                 // factored offset and a register number. The required action is to
256fbcb7f2cSJason Molenda                 // change the rule for the register indicated by the register number
257fbcb7f2cSJason Molenda                 // to be an offset(N) rule with a value of
258fbcb7f2cSJason Molenda                 // (N = factored offset * data_align).
259fbcb7f2cSJason Molenda                 uint32_t reg_num = extended_opcode;
260fbcb7f2cSJason Molenda                 int op_offset = (int32_t)m_cfi_data.GetULEB128(&offset) * cie_sp->data_align;
261fbcb7f2cSJason Molenda                 UnwindPlan::Row::RegisterLocation reg_location;
262fbcb7f2cSJason Molenda                 reg_location.SetAtCFAPlusOffset(op_offset);
263fbcb7f2cSJason Molenda                 cie_sp->initial_row.SetRegisterInfo (reg_num, reg_location);
264fbcb7f2cSJason Molenda                 continue;
265fbcb7f2cSJason Molenda             }
266fbcb7f2cSJason Molenda             if (extended_opcode == DW_CFA_nop)
267fbcb7f2cSJason Molenda             {
268fbcb7f2cSJason Molenda                 continue;
269fbcb7f2cSJason Molenda             }
270fbcb7f2cSJason Molenda             break;  // Stop if we hit an unrecognized opcode
271fbcb7f2cSJason Molenda         }
27230fdc8d8SChris Lattner     }
27330fdc8d8SChris Lattner 
27430fdc8d8SChris Lattner     return cie_sp;
27530fdc8d8SChris Lattner }
27630fdc8d8SChris Lattner 
277fbcb7f2cSJason Molenda // Scan through the eh_frame or debug_frame section looking for FDEs and noting the start/end addresses
278fbcb7f2cSJason Molenda // of the functions and a pointer back to the function's FDE for later expansion.
279fbcb7f2cSJason Molenda // Internalize CIEs as we come across them.
28030fdc8d8SChris Lattner 
281fbcb7f2cSJason Molenda void
282fbcb7f2cSJason Molenda DWARFCallFrameInfo::GetFDEIndex ()
283fbcb7f2cSJason Molenda {
284*8fe0c8c6SJason Molenda     if (m_section.get() == NULL || m_section->IsEncrypted())
285fbcb7f2cSJason Molenda         return;
286fbcb7f2cSJason Molenda     if (m_fde_index_initialized)
287fbcb7f2cSJason Molenda         return;
288fbcb7f2cSJason Molenda 
289e6194f17SJason Molenda 
290fbcb7f2cSJason Molenda     dw_offset_t offset = 0;
291fbcb7f2cSJason Molenda     if (m_cfi_data_initialized == false)
292fbcb7f2cSJason Molenda     {
2932d4edfbcSGreg Clayton         LogSP log(GetLogIfAllCategoriesSet (LIBLLDB_LOG_UNWIND));
294e6194f17SJason Molenda         if (log)
295e6194f17SJason Molenda         {
296e6194f17SJason Molenda             log->Printf ("Reading eh_frame information for %s", m_objfile.GetFileSpec().GetFilename().GetCString());
297e6194f17SJason Molenda         }
298fbcb7f2cSJason Molenda         m_section->ReadSectionDataFromObjectFile (&m_objfile, m_cfi_data);
299fbcb7f2cSJason Molenda         m_cfi_data_initialized = true;
300fbcb7f2cSJason Molenda     }
301fbcb7f2cSJason Molenda     while (m_cfi_data.ValidOffsetForDataOfSize (offset, 8))
302fbcb7f2cSJason Molenda     {
303fbcb7f2cSJason Molenda         dw_offset_t current_entry = offset;
304fbcb7f2cSJason Molenda         uint32_t len = m_cfi_data.GetU32 (&offset);
305fbcb7f2cSJason Molenda         dw_offset_t next_entry = current_entry + len + 4;
306fbcb7f2cSJason Molenda         dw_offset_t cie_id = m_cfi_data.GetU32 (&offset);
307fbcb7f2cSJason Molenda 
308fbcb7f2cSJason Molenda         if (cie_id == 0 || cie_id == UINT32_MAX)
309fbcb7f2cSJason Molenda         {
310fbcb7f2cSJason Molenda             m_cie_map[current_entry] = ParseCIE (current_entry);
311fbcb7f2cSJason Molenda             offset = next_entry;
312fbcb7f2cSJason Molenda             continue;
313fbcb7f2cSJason Molenda         }
314fbcb7f2cSJason Molenda 
315fbcb7f2cSJason Molenda         const CIE *cie = GetCIE (current_entry + 4 - cie_id);
316fbcb7f2cSJason Molenda         assert (cie != NULL);
317fbcb7f2cSJason Molenda 
318fbcb7f2cSJason Molenda         const lldb::addr_t pc_rel_addr = m_section->GetFileAddress();
319fbcb7f2cSJason Molenda         const lldb::addr_t text_addr = LLDB_INVALID_ADDRESS;
320fbcb7f2cSJason Molenda         const lldb::addr_t data_addr = LLDB_INVALID_ADDRESS;
321fbcb7f2cSJason Molenda 
322fbcb7f2cSJason Molenda         lldb::addr_t addr = m_cfi_data.GetGNUEHPointer(&offset, cie->ptr_encoding, pc_rel_addr, text_addr, data_addr);
323fbcb7f2cSJason 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);
324fbcb7f2cSJason Molenda         FDEEntry fde;
325fbcb7f2cSJason Molenda         fde.bounds = AddressRange (addr, length, m_objfile.GetSectionList());
326fbcb7f2cSJason Molenda         fde.offset = current_entry;
327fbcb7f2cSJason Molenda         m_fde_index.push_back(fde);
328fbcb7f2cSJason Molenda 
329fbcb7f2cSJason Molenda         offset = next_entry;
330fbcb7f2cSJason Molenda     }
331fbcb7f2cSJason Molenda     std::sort (m_fde_index.begin(), m_fde_index.end());
332fbcb7f2cSJason Molenda     m_fde_index_initialized = true;
333fbcb7f2cSJason Molenda }
334fbcb7f2cSJason Molenda 
335fbcb7f2cSJason Molenda bool
336fbcb7f2cSJason Molenda DWARFCallFrameInfo::FDEToUnwindPlan (dw_offset_t offset, Address startaddr, UnwindPlan& unwind_plan)
337fbcb7f2cSJason Molenda {
338fbcb7f2cSJason Molenda     dw_offset_t current_entry = offset;
339fbcb7f2cSJason Molenda 
340*8fe0c8c6SJason Molenda     if (m_section.get() == NULL || m_section->IsEncrypted())
341fbcb7f2cSJason Molenda         return false;
342fbcb7f2cSJason Molenda 
343fbcb7f2cSJason Molenda     if (m_cfi_data_initialized == false)
344fbcb7f2cSJason Molenda     {
345fbcb7f2cSJason Molenda         m_section->ReadSectionDataFromObjectFile (&m_objfile, m_cfi_data);
346fbcb7f2cSJason Molenda         m_cfi_data_initialized = true;
347fbcb7f2cSJason Molenda     }
348fbcb7f2cSJason Molenda 
349fbcb7f2cSJason Molenda     uint32_t length = m_cfi_data.GetU32 (&offset);
35030fdc8d8SChris Lattner     dw_offset_t cie_offset = m_cfi_data.GetU32 (&offset);
351fbcb7f2cSJason Molenda 
352fbcb7f2cSJason Molenda     assert (cie_offset != 0 && cie_offset != UINT32_MAX);
35330fdc8d8SChris Lattner 
35430fdc8d8SChris Lattner     // Translate the CIE_id from the eh_frame format, which
35530fdc8d8SChris Lattner     // is relative to the FDE offset, into a __eh_frame section
35630fdc8d8SChris Lattner     // offset
357fbcb7f2cSJason Molenda     if (m_is_eh_frame)
358ab4f1924SJason Molenda     {
359ab4f1924SJason Molenda         unwind_plan.SetSourceName ("eh_frame CFI");
360fbcb7f2cSJason Molenda         cie_offset = current_entry + 4 - cie_offset;
361ab4f1924SJason Molenda     }
362ab4f1924SJason Molenda     else
363ab4f1924SJason Molenda     {
364ab4f1924SJason Molenda         unwind_plan.SetSourceName ("DWARF CFI");
365ab4f1924SJason Molenda     }
36630fdc8d8SChris Lattner 
36730fdc8d8SChris Lattner     const CIE *cie = GetCIE (cie_offset);
368fbcb7f2cSJason Molenda     assert (cie != NULL);
369fbcb7f2cSJason Molenda 
370fbcb7f2cSJason Molenda     const dw_offset_t end_offset = current_entry + length + 4;
371fbcb7f2cSJason Molenda 
37230fdc8d8SChris Lattner     const lldb::addr_t pc_rel_addr = m_section->GetFileAddress();
37330fdc8d8SChris Lattner     const lldb::addr_t text_addr = LLDB_INVALID_ADDRESS;
37430fdc8d8SChris Lattner     const lldb::addr_t data_addr = LLDB_INVALID_ADDRESS;
37530fdc8d8SChris Lattner     lldb::addr_t range_base = m_cfi_data.GetGNUEHPointer(&offset, cie->ptr_encoding, pc_rel_addr, text_addr, data_addr);
376ea84e764SJason 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);
377fbcb7f2cSJason Molenda     AddressRange range (range_base, m_objfile.GetAddressByteSize(), m_objfile.GetSectionList());
378fbcb7f2cSJason Molenda     range.SetByteSize (range_len);
37930fdc8d8SChris Lattner 
38030fdc8d8SChris Lattner     if (cie->augmentation[0] == 'z')
38130fdc8d8SChris Lattner     {
38230fdc8d8SChris Lattner         uint32_t aug_data_len = (uint32_t)m_cfi_data.GetULEB128(&offset);
38330fdc8d8SChris Lattner         offset += aug_data_len;
38430fdc8d8SChris Lattner     }
38530fdc8d8SChris Lattner 
38630fdc8d8SChris Lattner     uint32_t reg_num = 0;
38730fdc8d8SChris Lattner     int32_t op_offset = 0;
38830fdc8d8SChris Lattner     uint32_t tmp_uval32;
38930fdc8d8SChris Lattner     uint32_t code_align = cie->code_align;
39030fdc8d8SChris Lattner     int32_t data_align = cie->data_align;
39130fdc8d8SChris Lattner 
392fbcb7f2cSJason Molenda     unwind_plan.SetPlanValidAddressRange (range);
393fbcb7f2cSJason Molenda     UnwindPlan::Row row = cie->initial_row;
39430fdc8d8SChris Lattner 
395fbcb7f2cSJason Molenda     unwind_plan.SetRegisterKind (m_reg_kind);
396fbcb7f2cSJason Molenda 
397fbcb7f2cSJason Molenda     UnwindPlan::Row::RegisterLocation reg_location;
39830fdc8d8SChris Lattner     while (m_cfi_data.ValidOffset(offset) && offset < end_offset)
39930fdc8d8SChris Lattner     {
40030fdc8d8SChris Lattner         uint8_t inst = m_cfi_data.GetU8(&offset);
40130fdc8d8SChris Lattner         uint8_t primary_opcode  = inst & 0xC0;
40230fdc8d8SChris Lattner         uint8_t extended_opcode = inst & 0x3F;
40330fdc8d8SChris Lattner 
40430fdc8d8SChris Lattner         if (primary_opcode)
40530fdc8d8SChris Lattner         {
40630fdc8d8SChris Lattner             switch (primary_opcode)
40730fdc8d8SChris Lattner             {
40830fdc8d8SChris Lattner                 case DW_CFA_advance_loc :   // (Row Creation Instruction)
40930fdc8d8SChris Lattner                     {   // 0x40 - high 2 bits are 0x1, lower 6 bits are delta
41030fdc8d8SChris Lattner                         // takes a single argument that represents a constant delta. The
41130fdc8d8SChris Lattner                         // required action is to create a new table row with a location
41230fdc8d8SChris Lattner                         // value that is computed by taking the current entry's location
41330fdc8d8SChris Lattner                         // value and adding (delta * code_align). All other
41430fdc8d8SChris Lattner                         // values in the new row are initially identical to the current row.
415fbcb7f2cSJason Molenda                         unwind_plan.AppendRow(row);
41630fdc8d8SChris Lattner                         row.SlideOffset(extended_opcode * code_align);
41730fdc8d8SChris Lattner                     }
41830fdc8d8SChris Lattner                     break;
41930fdc8d8SChris Lattner 
42030fdc8d8SChris Lattner                 case DW_CFA_offset      :
42130fdc8d8SChris Lattner                     {   // 0x80 - high 2 bits are 0x2, lower 6 bits are register
42230fdc8d8SChris Lattner                         // takes two arguments: an unsigned LEB128 constant representing a
42330fdc8d8SChris Lattner                         // factored offset and a register number. The required action is to
42430fdc8d8SChris Lattner                         // change the rule for the register indicated by the register number
42530fdc8d8SChris Lattner                         // to be an offset(N) rule with a value of
42630fdc8d8SChris Lattner                         // (N = factored offset * data_align).
42730fdc8d8SChris Lattner                         reg_num = extended_opcode;
42830fdc8d8SChris Lattner                         op_offset = (int32_t)m_cfi_data.GetULEB128(&offset) * data_align;
42930fdc8d8SChris Lattner                         reg_location.SetAtCFAPlusOffset(op_offset);
43030fdc8d8SChris Lattner                         row.SetRegisterInfo (reg_num, reg_location);
43130fdc8d8SChris Lattner                     }
43230fdc8d8SChris Lattner                     break;
43330fdc8d8SChris Lattner 
43430fdc8d8SChris Lattner                 case DW_CFA_restore     :
43530fdc8d8SChris Lattner                     {   // 0xC0 - high 2 bits are 0x3, lower 6 bits are register
43630fdc8d8SChris Lattner                         // takes a single argument that represents a register number. The
43730fdc8d8SChris Lattner                         // required action is to change the rule for the indicated register
43830fdc8d8SChris Lattner                         // to the rule assigned it by the initial_instructions in the CIE.
43930fdc8d8SChris Lattner                         reg_num = extended_opcode;
44030fdc8d8SChris Lattner                         // We only keep enough register locations around to
44130fdc8d8SChris Lattner                         // unwind what is in our thread, and these are organized
44230fdc8d8SChris Lattner                         // by the register index in that state, so we need to convert our
443fbcb7f2cSJason Molenda                         // GCC register number from the EH frame info, to a register index
44430fdc8d8SChris Lattner 
445fbcb7f2cSJason Molenda                         if (unwind_plan.IsValidRowIndex(0) && unwind_plan.GetRowAtIndex(0).GetRegisterInfo(reg_num, reg_location))
44630fdc8d8SChris Lattner                             row.SetRegisterInfo (reg_num, reg_location);
44730fdc8d8SChris Lattner                     }
44830fdc8d8SChris Lattner                     break;
44930fdc8d8SChris Lattner             }
45030fdc8d8SChris Lattner         }
45130fdc8d8SChris Lattner         else
45230fdc8d8SChris Lattner         {
45330fdc8d8SChris Lattner             switch (extended_opcode)
45430fdc8d8SChris Lattner             {
45530fdc8d8SChris Lattner                 case DW_CFA_nop                 : // 0x0
45630fdc8d8SChris Lattner                     break;
45730fdc8d8SChris Lattner 
45830fdc8d8SChris Lattner                 case DW_CFA_set_loc             : // 0x1 (Row Creation Instruction)
45930fdc8d8SChris Lattner                     {
46030fdc8d8SChris Lattner                         // DW_CFA_set_loc takes a single argument that represents an address.
46130fdc8d8SChris Lattner                         // The required action is to create a new table row using the
46230fdc8d8SChris Lattner                         // specified address as the location. All other values in the new row
46330fdc8d8SChris Lattner                         // are initially identical to the current row. The new location value
46430fdc8d8SChris Lattner                         // should always be greater than the current one.
465fbcb7f2cSJason Molenda                         unwind_plan.AppendRow(row);
466fbcb7f2cSJason Molenda                         row.SetOffset(m_cfi_data.GetPointer(&offset) - startaddr.GetFileAddress());
46730fdc8d8SChris Lattner                     }
46830fdc8d8SChris Lattner                     break;
46930fdc8d8SChris Lattner 
47030fdc8d8SChris Lattner                 case DW_CFA_advance_loc1        : // 0x2 (Row Creation Instruction)
47130fdc8d8SChris Lattner                     {
47230fdc8d8SChris Lattner                         // takes a single uword argument that represents a constant delta.
47330fdc8d8SChris Lattner                         // This instruction is identical to DW_CFA_advance_loc except for the
47430fdc8d8SChris Lattner                         // encoding and size of the delta argument.
475fbcb7f2cSJason Molenda                         unwind_plan.AppendRow(row);
47630fdc8d8SChris Lattner                         row.SlideOffset (m_cfi_data.GetU8(&offset) * code_align);
47730fdc8d8SChris Lattner                     }
47830fdc8d8SChris Lattner                     break;
47930fdc8d8SChris Lattner 
48030fdc8d8SChris Lattner                 case DW_CFA_advance_loc2        : // 0x3 (Row Creation Instruction)
48130fdc8d8SChris Lattner                     {
48230fdc8d8SChris Lattner                         // takes a single uword argument that represents a constant delta.
48330fdc8d8SChris Lattner                         // This instruction is identical to DW_CFA_advance_loc except for the
48430fdc8d8SChris Lattner                         // encoding and size of the delta argument.
485fbcb7f2cSJason Molenda                         unwind_plan.AppendRow(row);
48630fdc8d8SChris Lattner                         row.SlideOffset (m_cfi_data.GetU16(&offset) * code_align);
48730fdc8d8SChris Lattner                     }
48830fdc8d8SChris Lattner                     break;
48930fdc8d8SChris Lattner 
49030fdc8d8SChris Lattner                 case DW_CFA_advance_loc4        : // 0x4 (Row Creation Instruction)
49130fdc8d8SChris Lattner                     {
49230fdc8d8SChris Lattner                         // takes a single uword argument that represents a constant delta.
49330fdc8d8SChris Lattner                         // This instruction is identical to DW_CFA_advance_loc except for the
49430fdc8d8SChris Lattner                         // encoding and size of the delta argument.
495fbcb7f2cSJason Molenda                         unwind_plan.AppendRow(row);
49630fdc8d8SChris Lattner                         row.SlideOffset (m_cfi_data.GetU32(&offset) * code_align);
49730fdc8d8SChris Lattner                     }
49830fdc8d8SChris Lattner                     break;
49930fdc8d8SChris Lattner 
50030fdc8d8SChris Lattner                 case DW_CFA_offset_extended     : // 0x5
50130fdc8d8SChris Lattner                     {
50230fdc8d8SChris Lattner                         // takes two unsigned LEB128 arguments representing a register number
50330fdc8d8SChris Lattner                         // and a factored offset. This instruction is identical to DW_CFA_offset
50430fdc8d8SChris Lattner                         // except for the encoding and size of the register argument.
50530fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
50630fdc8d8SChris Lattner                         op_offset = (int32_t)m_cfi_data.GetULEB128(&offset) * data_align;
50730fdc8d8SChris Lattner                         reg_location.SetAtCFAPlusOffset(op_offset);
50830fdc8d8SChris Lattner                         row.SetRegisterInfo (reg_num, reg_location);
50930fdc8d8SChris Lattner                     }
51030fdc8d8SChris Lattner                     break;
51130fdc8d8SChris Lattner 
51230fdc8d8SChris Lattner                 case DW_CFA_restore_extended    : // 0x6
51330fdc8d8SChris Lattner                     {
51430fdc8d8SChris Lattner                         // takes a single unsigned LEB128 argument that represents a register
51530fdc8d8SChris Lattner                         // number. This instruction is identical to DW_CFA_restore except for
51630fdc8d8SChris Lattner                         // the encoding and size of the register argument.
51730fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
518fbcb7f2cSJason Molenda                         if (unwind_plan.IsValidRowIndex(0) && unwind_plan.GetRowAtIndex(0).GetRegisterInfo(reg_num, reg_location))
51930fdc8d8SChris Lattner                             row.SetRegisterInfo (reg_num, reg_location);
52030fdc8d8SChris Lattner                     }
52130fdc8d8SChris Lattner                     break;
52230fdc8d8SChris Lattner 
52330fdc8d8SChris Lattner                 case DW_CFA_undefined           : // 0x7
52430fdc8d8SChris Lattner                     {
52530fdc8d8SChris Lattner                         // takes a single unsigned LEB128 argument that represents a register
52630fdc8d8SChris Lattner                         // number. The required action is to set the rule for the specified
52730fdc8d8SChris Lattner                         // register to undefined.
52830fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
52930fdc8d8SChris Lattner                         reg_location.SetUndefined();
53030fdc8d8SChris Lattner                         row.SetRegisterInfo (reg_num, reg_location);
53130fdc8d8SChris Lattner                     }
53230fdc8d8SChris Lattner                     break;
53330fdc8d8SChris Lattner 
53430fdc8d8SChris Lattner                 case DW_CFA_same_value          : // 0x8
53530fdc8d8SChris Lattner                     {
53630fdc8d8SChris Lattner                         // takes a single unsigned LEB128 argument that represents a register
53730fdc8d8SChris Lattner                         // number. The required action is to set the rule for the specified
53830fdc8d8SChris Lattner                         // register to same value.
53930fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
54030fdc8d8SChris Lattner                         reg_location.SetSame();
54130fdc8d8SChris Lattner                         row.SetRegisterInfo (reg_num, reg_location);
54230fdc8d8SChris Lattner                     }
54330fdc8d8SChris Lattner                     break;
54430fdc8d8SChris Lattner 
54530fdc8d8SChris Lattner                 case DW_CFA_register            : // 0x9
54630fdc8d8SChris Lattner                     {
54730fdc8d8SChris Lattner                         // takes two unsigned LEB128 arguments representing register numbers.
54830fdc8d8SChris Lattner                         // The required action is to set the rule for the first register to be
54930fdc8d8SChris Lattner                         // the second register.
55030fdc8d8SChris Lattner 
55130fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
55230fdc8d8SChris Lattner                         uint32_t other_reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
55330fdc8d8SChris Lattner                         reg_location.SetInRegister(other_reg_num);
55430fdc8d8SChris Lattner                         row.SetRegisterInfo (reg_num, reg_location);
55530fdc8d8SChris Lattner                     }
55630fdc8d8SChris Lattner                     break;
55730fdc8d8SChris Lattner 
55830fdc8d8SChris Lattner                 case DW_CFA_remember_state      : // 0xA
55930fdc8d8SChris Lattner                     // These instructions define a stack of information. Encountering the
56030fdc8d8SChris Lattner                     // DW_CFA_remember_state instruction means to save the rules for every
56130fdc8d8SChris Lattner                     // register on the current row on the stack. Encountering the
56230fdc8d8SChris Lattner                     // DW_CFA_restore_state instruction means to pop the set of rules off
56330fdc8d8SChris Lattner                     // the stack and place them in the current row. (This operation is
56430fdc8d8SChris Lattner                     // useful for compilers that move epilogue code into the body of a
56530fdc8d8SChris Lattner                     // function.)
566fbcb7f2cSJason Molenda                     unwind_plan.AppendRow (row);
56730fdc8d8SChris Lattner                     break;
56830fdc8d8SChris Lattner 
56930fdc8d8SChris Lattner                 case DW_CFA_restore_state       : // 0xB
57030fdc8d8SChris Lattner                     // These instructions define a stack of information. Encountering the
57130fdc8d8SChris Lattner                     // DW_CFA_remember_state instruction means to save the rules for every
57230fdc8d8SChris Lattner                     // register on the current row on the stack. Encountering the
57330fdc8d8SChris Lattner                     // DW_CFA_restore_state instruction means to pop the set of rules off
57430fdc8d8SChris Lattner                     // the stack and place them in the current row. (This operation is
57530fdc8d8SChris Lattner                     // useful for compilers that move epilogue code into the body of a
57630fdc8d8SChris Lattner                     // function.)
57730fdc8d8SChris Lattner                     {
578fbcb7f2cSJason Molenda                         row = unwind_plan.GetRowAtIndex(unwind_plan.GetRowCount() - 1);
57930fdc8d8SChris Lattner                     }
58030fdc8d8SChris Lattner                     break;
58130fdc8d8SChris Lattner 
58230fdc8d8SChris Lattner                 case DW_CFA_def_cfa             : // 0xC    (CFA Definition Instruction)
58330fdc8d8SChris Lattner                     {
58430fdc8d8SChris Lattner                         // Takes two unsigned LEB128 operands representing a register
58530fdc8d8SChris Lattner                         // number and a (non-factored) offset. The required action
58630fdc8d8SChris Lattner                         // is to define the current CFA rule to use the provided
58730fdc8d8SChris Lattner                         // register and offset.
58830fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
58930fdc8d8SChris Lattner                         op_offset = (int32_t)m_cfi_data.GetULEB128(&offset);
59030fdc8d8SChris Lattner                         row.SetCFARegister (reg_num);
59130fdc8d8SChris Lattner                         row.SetCFAOffset (op_offset);
59230fdc8d8SChris Lattner                     }
59330fdc8d8SChris Lattner                     break;
59430fdc8d8SChris Lattner 
59530fdc8d8SChris Lattner                 case DW_CFA_def_cfa_register    : // 0xD    (CFA Definition Instruction)
59630fdc8d8SChris Lattner                     {
59730fdc8d8SChris Lattner                         // takes a single unsigned LEB128 argument representing a register
59830fdc8d8SChris Lattner                         // number. The required action is to define the current CFA rule to
59930fdc8d8SChris Lattner                         // use the provided register (but to keep the old offset).
60030fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
60130fdc8d8SChris Lattner                         row.SetCFARegister (reg_num);
60230fdc8d8SChris Lattner                     }
60330fdc8d8SChris Lattner                     break;
60430fdc8d8SChris Lattner 
60530fdc8d8SChris Lattner                 case DW_CFA_def_cfa_offset      : // 0xE    (CFA Definition Instruction)
60630fdc8d8SChris Lattner                     {
60730fdc8d8SChris Lattner                         // Takes a single unsigned LEB128 operand representing a
60830fdc8d8SChris Lattner                         // (non-factored) offset. The required action is to define
60930fdc8d8SChris Lattner                         // the current CFA rule to use the provided offset (but
61030fdc8d8SChris Lattner                         // to keep the old register).
61130fdc8d8SChris Lattner                         op_offset = (int32_t)m_cfi_data.GetULEB128(&offset);
61230fdc8d8SChris Lattner                         row.SetCFAOffset (op_offset);
61330fdc8d8SChris Lattner                     }
61430fdc8d8SChris Lattner                     break;
61530fdc8d8SChris Lattner 
61630fdc8d8SChris Lattner                 case DW_CFA_def_cfa_expression  : // 0xF    (CFA Definition Instruction)
61730fdc8d8SChris Lattner                     {
61830fdc8d8SChris Lattner                         size_t block_len = (size_t)m_cfi_data.GetULEB128(&offset);
61930fdc8d8SChris Lattner                         offset += (uint32_t)block_len;
62030fdc8d8SChris Lattner                     }
62130fdc8d8SChris Lattner                     break;
62230fdc8d8SChris Lattner 
62330fdc8d8SChris Lattner                 case DW_CFA_expression          : // 0x10
62430fdc8d8SChris Lattner                     {
62530fdc8d8SChris Lattner                         // Takes two operands: an unsigned LEB128 value representing
62630fdc8d8SChris Lattner                         // a register number, and a DW_FORM_block value representing a DWARF
62730fdc8d8SChris Lattner                         // expression. The required action is to change the rule for the
62830fdc8d8SChris Lattner                         // register indicated by the register number to be an expression(E)
62930fdc8d8SChris Lattner                         // rule where E is the DWARF expression. That is, the DWARF
63030fdc8d8SChris Lattner                         // expression computes the address. The value of the CFA is
63130fdc8d8SChris Lattner                         // pushed on the DWARF evaluation stack prior to execution of
63230fdc8d8SChris Lattner                         // the DWARF expression.
63330fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
63430fdc8d8SChris Lattner                         uint32_t block_len = (uint32_t)m_cfi_data.GetULEB128(&offset);
63530fdc8d8SChris Lattner                         const uint8_t *block_data = (uint8_t *)m_cfi_data.GetData(&offset, block_len);
63630fdc8d8SChris Lattner 
63730fdc8d8SChris Lattner                         reg_location.SetAtDWARFExpression(block_data, block_len);
63830fdc8d8SChris Lattner                         row.SetRegisterInfo (reg_num, reg_location);
63930fdc8d8SChris Lattner                     }
64030fdc8d8SChris Lattner                     break;
64130fdc8d8SChris Lattner 
64230fdc8d8SChris Lattner                 case DW_CFA_offset_extended_sf  : // 0x11
64330fdc8d8SChris Lattner                     {
64430fdc8d8SChris Lattner                         // takes two operands: an unsigned LEB128 value representing a
64530fdc8d8SChris Lattner                         // register number and a signed LEB128 factored offset. This
64630fdc8d8SChris Lattner                         // instruction is identical to DW_CFA_offset_extended except
64730fdc8d8SChris Lattner                         //that the second operand is signed and factored.
64830fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
64930fdc8d8SChris Lattner                         op_offset = (int32_t)m_cfi_data.GetSLEB128(&offset) * data_align;
65030fdc8d8SChris Lattner                         reg_location.SetAtCFAPlusOffset(op_offset);
65130fdc8d8SChris Lattner                         row.SetRegisterInfo (reg_num, reg_location);
65230fdc8d8SChris Lattner                     }
65330fdc8d8SChris Lattner                     break;
65430fdc8d8SChris Lattner 
65530fdc8d8SChris Lattner                 case DW_CFA_def_cfa_sf          : // 0x12   (CFA Definition Instruction)
65630fdc8d8SChris Lattner                     {
65730fdc8d8SChris Lattner                         // Takes two operands: an unsigned LEB128 value representing
65830fdc8d8SChris Lattner                         // a register number and a signed LEB128 factored offset.
65930fdc8d8SChris Lattner                         // This instruction is identical to DW_CFA_def_cfa except
66030fdc8d8SChris Lattner                         // that the second operand is signed and factored.
66130fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
66230fdc8d8SChris Lattner                         op_offset = (int32_t)m_cfi_data.GetSLEB128(&offset) * data_align;
66330fdc8d8SChris Lattner                         row.SetCFARegister (reg_num);
66430fdc8d8SChris Lattner                         row.SetCFAOffset (op_offset);
66530fdc8d8SChris Lattner                     }
66630fdc8d8SChris Lattner                     break;
66730fdc8d8SChris Lattner 
66830fdc8d8SChris Lattner                 case DW_CFA_def_cfa_offset_sf   : // 0x13   (CFA Definition Instruction)
66930fdc8d8SChris Lattner                     {
67030fdc8d8SChris Lattner                         // takes a signed LEB128 operand representing a factored
67130fdc8d8SChris Lattner                         // offset. This instruction is identical to  DW_CFA_def_cfa_offset
67230fdc8d8SChris Lattner                         // except that the operand is signed and factored.
67330fdc8d8SChris Lattner                         op_offset = (int32_t)m_cfi_data.GetSLEB128(&offset) * data_align;
67430fdc8d8SChris Lattner                         row.SetCFAOffset (op_offset);
67530fdc8d8SChris Lattner                     }
67630fdc8d8SChris Lattner                     break;
67730fdc8d8SChris Lattner 
67830fdc8d8SChris Lattner                 case DW_CFA_val_expression      :   // 0x16
67930fdc8d8SChris Lattner                     {
68030fdc8d8SChris Lattner                         // takes two operands: an unsigned LEB128 value representing a register
68130fdc8d8SChris Lattner                         // number, and a DW_FORM_block value representing a DWARF expression.
68230fdc8d8SChris Lattner                         // The required action is to change the rule for the register indicated
68330fdc8d8SChris Lattner                         // by the register number to be a val_expression(E) rule where E is the
68430fdc8d8SChris Lattner                         // DWARF expression. That is, the DWARF expression computes the value of
68530fdc8d8SChris Lattner                         // the given register. The value of the CFA is pushed on the DWARF
68630fdc8d8SChris Lattner                         // evaluation stack prior to execution of the DWARF expression.
68730fdc8d8SChris Lattner                         reg_num = (uint32_t)m_cfi_data.GetULEB128(&offset);
68830fdc8d8SChris Lattner                         uint32_t block_len = (uint32_t)m_cfi_data.GetULEB128(&offset);
68930fdc8d8SChris Lattner                         const uint8_t* block_data = (uint8_t*)m_cfi_data.GetData(&offset, block_len);
69030fdc8d8SChris Lattner //#if defined(__i386__) || defined(__x86_64__)
69130fdc8d8SChris Lattner //                      // The EH frame info for EIP and RIP contains code that looks for traps to
69230fdc8d8SChris Lattner //                      // be a specific type and increments the PC.
69330fdc8d8SChris Lattner //                      // For i386:
69430fdc8d8SChris Lattner //                      // DW_CFA_val_expression where:
69530fdc8d8SChris Lattner //                      // eip = DW_OP_breg6(+28), DW_OP_deref, DW_OP_dup, DW_OP_plus_uconst(0x34),
69630fdc8d8SChris Lattner //                      //       DW_OP_deref, DW_OP_swap, DW_OP_plus_uconst(0), DW_OP_deref,
69730fdc8d8SChris Lattner //                      //       DW_OP_dup, DW_OP_lit3, DW_OP_ne, DW_OP_swap, DW_OP_lit4, DW_OP_ne,
69830fdc8d8SChris Lattner //                      //       DW_OP_and, DW_OP_plus
69930fdc8d8SChris Lattner //                      // This basically does a:
70030fdc8d8SChris Lattner //                      // eip = ucontenxt.mcontext32->gpr.eip;
70130fdc8d8SChris Lattner //                      // if (ucontenxt.mcontext32->exc.trapno != 3 && ucontenxt.mcontext32->exc.trapno != 4)
70230fdc8d8SChris Lattner //                      //   eip++;
70330fdc8d8SChris Lattner //                      //
70430fdc8d8SChris Lattner //                      // For x86_64:
70530fdc8d8SChris Lattner //                      // DW_CFA_val_expression where:
70630fdc8d8SChris Lattner //                      // rip =  DW_OP_breg3(+48), DW_OP_deref, DW_OP_dup, DW_OP_plus_uconst(0x90), DW_OP_deref,
70730fdc8d8SChris Lattner //                      //          DW_OP_swap, DW_OP_plus_uconst(0), DW_OP_deref_size(4), DW_OP_dup, DW_OP_lit3,
70830fdc8d8SChris Lattner //                      //          DW_OP_ne, DW_OP_swap, DW_OP_lit4, DW_OP_ne, DW_OP_and, DW_OP_plus
70930fdc8d8SChris Lattner //                      // This basically does a:
71030fdc8d8SChris Lattner //                      // rip = ucontenxt.mcontext64->gpr.rip;
71130fdc8d8SChris Lattner //                      // if (ucontenxt.mcontext64->exc.trapno != 3 && ucontenxt.mcontext64->exc.trapno != 4)
71230fdc8d8SChris Lattner //                      //   rip++;
71330fdc8d8SChris Lattner //                      // The trap comparisons and increments are not needed as it hoses up the unwound PC which
71430fdc8d8SChris Lattner //                      // is expected to point at least past the instruction that causes the fault/trap. So we
71530fdc8d8SChris Lattner //                      // take it out by trimming the expression right at the first "DW_OP_swap" opcodes
71630fdc8d8SChris Lattner //                      if (block_data != NULL && thread->GetPCRegNum(Thread::GCC) == reg_num)
71730fdc8d8SChris Lattner //                      {
71830fdc8d8SChris Lattner //                          if (thread->Is64Bit())
71930fdc8d8SChris Lattner //                          {
72030fdc8d8SChris Lattner //                              if (block_len > 9 && block_data[8] == DW_OP_swap && block_data[9] == DW_OP_plus_uconst)
72130fdc8d8SChris Lattner //                                  block_len = 8;
72230fdc8d8SChris Lattner //                          }
72330fdc8d8SChris Lattner //                          else
72430fdc8d8SChris Lattner //                          {
72530fdc8d8SChris Lattner //                              if (block_len > 8 && block_data[7] == DW_OP_swap && block_data[8] == DW_OP_plus_uconst)
72630fdc8d8SChris Lattner //                                  block_len = 7;
72730fdc8d8SChris Lattner //                          }
72830fdc8d8SChris Lattner //                      }
72930fdc8d8SChris Lattner //#endif
73030fdc8d8SChris Lattner                         reg_location.SetIsDWARFExpression(block_data, block_len);
73130fdc8d8SChris Lattner                         row.SetRegisterInfo (reg_num, reg_location);
73230fdc8d8SChris Lattner                     }
73330fdc8d8SChris Lattner                     break;
73430fdc8d8SChris Lattner 
73530fdc8d8SChris Lattner                 case DW_CFA_val_offset          :   // 0x14
73630fdc8d8SChris Lattner                 case DW_CFA_val_offset_sf       :   // 0x15
73730fdc8d8SChris Lattner                 default:
73830fdc8d8SChris Lattner                     tmp_uval32 = extended_opcode;
73930fdc8d8SChris Lattner                     break;
74030fdc8d8SChris Lattner             }
74130fdc8d8SChris Lattner         }
74230fdc8d8SChris Lattner     }
743fbcb7f2cSJason Molenda     unwind_plan.AppendRow(row);
74430fdc8d8SChris Lattner 
745fbcb7f2cSJason Molenda     return true;
74630fdc8d8SChris Lattner }
747