125b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* CIE reading. 225b3c049e70834cf33790a28643ab058b507b35cBen Cheng Copyright (C) 2009-2010 Red Hat, Inc. 325b3c049e70834cf33790a28643ab058b507b35cBen Cheng This file is part of Red Hat elfutils. 425b3c049e70834cf33790a28643ab058b507b35cBen Cheng 525b3c049e70834cf33790a28643ab058b507b35cBen Cheng Red Hat elfutils is free software; you can redistribute it and/or modify 625b3c049e70834cf33790a28643ab058b507b35cBen Cheng it under the terms of the GNU General Public License as published by the 725b3c049e70834cf33790a28643ab058b507b35cBen Cheng Free Software Foundation; version 2 of the License. 825b3c049e70834cf33790a28643ab058b507b35cBen Cheng 925b3c049e70834cf33790a28643ab058b507b35cBen Cheng Red Hat elfutils is distributed in the hope that it will be useful, but 1025b3c049e70834cf33790a28643ab058b507b35cBen Cheng WITHOUT ANY WARRANTY; without even the implied warranty of 1125b3c049e70834cf33790a28643ab058b507b35cBen Cheng MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 1225b3c049e70834cf33790a28643ab058b507b35cBen Cheng General Public License for more details. 1325b3c049e70834cf33790a28643ab058b507b35cBen Cheng 1425b3c049e70834cf33790a28643ab058b507b35cBen Cheng You should have received a copy of the GNU General Public License along 1525b3c049e70834cf33790a28643ab058b507b35cBen Cheng with Red Hat elfutils; if not, write to the Free Software Foundation, 1625b3c049e70834cf33790a28643ab058b507b35cBen Cheng Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA. 1725b3c049e70834cf33790a28643ab058b507b35cBen Cheng 1825b3c049e70834cf33790a28643ab058b507b35cBen Cheng In addition, as a special exception, Red Hat, Inc. gives You the 1925b3c049e70834cf33790a28643ab058b507b35cBen Cheng additional right to link the code of Red Hat elfutils with code licensed 2025b3c049e70834cf33790a28643ab058b507b35cBen Cheng under any Open Source Initiative certified open source license 2125b3c049e70834cf33790a28643ab058b507b35cBen Cheng (http://www.opensource.org/licenses/index.php) which requires the 2225b3c049e70834cf33790a28643ab058b507b35cBen Cheng distribution of source code with any binary distribution and to 2325b3c049e70834cf33790a28643ab058b507b35cBen Cheng distribute linked combinations of the two. Non-GPL Code permitted under 2425b3c049e70834cf33790a28643ab058b507b35cBen Cheng this exception must only link to the code of Red Hat elfutils through 2525b3c049e70834cf33790a28643ab058b507b35cBen Cheng those well defined interfaces identified in the file named EXCEPTION 2625b3c049e70834cf33790a28643ab058b507b35cBen Cheng found in the source code files (the "Approved Interfaces"). The files 2725b3c049e70834cf33790a28643ab058b507b35cBen Cheng of Non-GPL Code may instantiate templates or use macros or inline 2825b3c049e70834cf33790a28643ab058b507b35cBen Cheng functions from the Approved Interfaces without causing the resulting 2925b3c049e70834cf33790a28643ab058b507b35cBen Cheng work to be covered by the GNU General Public License. Only Red Hat, 3025b3c049e70834cf33790a28643ab058b507b35cBen Cheng Inc. may make changes or additions to the list of Approved Interfaces. 3125b3c049e70834cf33790a28643ab058b507b35cBen Cheng Red Hat's grant of this exception is conditioned upon your not adding 3225b3c049e70834cf33790a28643ab058b507b35cBen Cheng any new exceptions. If you wish to add a new Approved Interface or 3325b3c049e70834cf33790a28643ab058b507b35cBen Cheng exception, please contact Red Hat. You must obey the GNU General Public 3425b3c049e70834cf33790a28643ab058b507b35cBen Cheng License in all respects for all of the Red Hat elfutils code and other 3525b3c049e70834cf33790a28643ab058b507b35cBen Cheng code used in conjunction with Red Hat elfutils except the Non-GPL Code 3625b3c049e70834cf33790a28643ab058b507b35cBen Cheng covered by this exception. If you modify this file, you may extend this 3725b3c049e70834cf33790a28643ab058b507b35cBen Cheng exception to your version of the file, but you are not obligated to do 3825b3c049e70834cf33790a28643ab058b507b35cBen Cheng so. If you do not wish to provide this exception without modification, 3925b3c049e70834cf33790a28643ab058b507b35cBen Cheng you must delete this exception statement from your version and license 4025b3c049e70834cf33790a28643ab058b507b35cBen Cheng this file solely under the GPL without exception. 4125b3c049e70834cf33790a28643ab058b507b35cBen Cheng 4225b3c049e70834cf33790a28643ab058b507b35cBen Cheng Red Hat elfutils is an included package of the Open Invention Network. 4325b3c049e70834cf33790a28643ab058b507b35cBen Cheng An included package of the Open Invention Network is a package for which 4425b3c049e70834cf33790a28643ab058b507b35cBen Cheng Open Invention Network licensees cross-license their patents. No patent 4525b3c049e70834cf33790a28643ab058b507b35cBen Cheng license is granted, either expressly or impliedly, by designation as an 4625b3c049e70834cf33790a28643ab058b507b35cBen Cheng included package. Should you wish to participate in the Open Invention 4725b3c049e70834cf33790a28643ab058b507b35cBen Cheng Network licensing program, please visit www.openinventionnetwork.com 4825b3c049e70834cf33790a28643ab058b507b35cBen Cheng <http://www.openinventionnetwork.com>. */ 4925b3c049e70834cf33790a28643ab058b507b35cBen Cheng 5025b3c049e70834cf33790a28643ab058b507b35cBen Cheng#ifdef HAVE_CONFIG_H 5125b3c049e70834cf33790a28643ab058b507b35cBen Cheng# include <config.h> 5225b3c049e70834cf33790a28643ab058b507b35cBen Cheng#endif 5325b3c049e70834cf33790a28643ab058b507b35cBen Cheng 5425b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include "cfi.h" 5525b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include "encoded-value.h" 5625b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include <assert.h> 5725b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include <search.h> 5825b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include <stdlib.h> 5925b3c049e70834cf33790a28643ab058b507b35cBen Cheng 6025b3c049e70834cf33790a28643ab058b507b35cBen Cheng 6125b3c049e70834cf33790a28643ab058b507b35cBen Chengstatic int 6225b3c049e70834cf33790a28643ab058b507b35cBen Chengcompare_cie (const void *a, const void *b) 6325b3c049e70834cf33790a28643ab058b507b35cBen Cheng{ 6425b3c049e70834cf33790a28643ab058b507b35cBen Cheng const struct dwarf_cie *cie1 = a; 6525b3c049e70834cf33790a28643ab058b507b35cBen Cheng const struct dwarf_cie *cie2 = b; 6625b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (cie1->offset < cie2->offset) 6725b3c049e70834cf33790a28643ab058b507b35cBen Cheng return -1; 6825b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (cie1->offset > cie2->offset) 6925b3c049e70834cf33790a28643ab058b507b35cBen Cheng return 1; 7025b3c049e70834cf33790a28643ab058b507b35cBen Cheng return 0; 7125b3c049e70834cf33790a28643ab058b507b35cBen Cheng} 7225b3c049e70834cf33790a28643ab058b507b35cBen Cheng 7325b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* There is no CIE at OFFSET in the tree. Add it. */ 7425b3c049e70834cf33790a28643ab058b507b35cBen Chengstatic struct dwarf_cie * 7525b3c049e70834cf33790a28643ab058b507b35cBen Chengintern_new_cie (Dwarf_CFI *cache, Dwarf_Off offset, const Dwarf_CIE *info) 7625b3c049e70834cf33790a28643ab058b507b35cBen Cheng{ 7725b3c049e70834cf33790a28643ab058b507b35cBen Cheng struct dwarf_cie *cie = malloc (sizeof (struct dwarf_cie)); 7825b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (cie == NULL) 7925b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 8025b3c049e70834cf33790a28643ab058b507b35cBen Cheng __libdw_seterrno (DWARF_E_NOMEM); 8125b3c049e70834cf33790a28643ab058b507b35cBen Cheng return NULL; 8225b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 8325b3c049e70834cf33790a28643ab058b507b35cBen Cheng 8425b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->offset = offset; 8525b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->code_alignment_factor = info->code_alignment_factor; 8625b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->data_alignment_factor = info->data_alignment_factor; 8725b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->return_address_register = info->return_address_register; 8825b3c049e70834cf33790a28643ab058b507b35cBen Cheng 8925b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->fde_augmentation_data_size = 0; 9025b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->sized_augmentation_data = false; 9125b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->signal_frame = false; 9225b3c049e70834cf33790a28643ab058b507b35cBen Cheng 9325b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->fde_encoding = DW_EH_PE_absptr; 9425b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->lsda_encoding = DW_EH_PE_omit; 9525b3c049e70834cf33790a28643ab058b507b35cBen Cheng 9625b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* Grok the augmentation string and its data. */ 9725b3c049e70834cf33790a28643ab058b507b35cBen Cheng const uint8_t *data = info->augmentation_data; 9825b3c049e70834cf33790a28643ab058b507b35cBen Cheng for (const char *ap = info->augmentation; *ap != '\0'; ++ap) 9925b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 10025b3c049e70834cf33790a28643ab058b507b35cBen Cheng uint8_t encoding; 10125b3c049e70834cf33790a28643ab058b507b35cBen Cheng switch (*ap) 10225b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 10325b3c049e70834cf33790a28643ab058b507b35cBen Cheng case 'z': 10425b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->sized_augmentation_data = true; 10525b3c049e70834cf33790a28643ab058b507b35cBen Cheng continue; 10625b3c049e70834cf33790a28643ab058b507b35cBen Cheng 10725b3c049e70834cf33790a28643ab058b507b35cBen Cheng case 'S': 10825b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->signal_frame = true; 10925b3c049e70834cf33790a28643ab058b507b35cBen Cheng continue; 11025b3c049e70834cf33790a28643ab058b507b35cBen Cheng 11125b3c049e70834cf33790a28643ab058b507b35cBen Cheng case 'L': /* LSDA pointer encoding byte. */ 11225b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->lsda_encoding = *data++; 11325b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (!cie->sized_augmentation_data) 11425b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->fde_augmentation_data_size 11525b3c049e70834cf33790a28643ab058b507b35cBen Cheng += encoded_value_size (&cache->data->d, cache->e_ident, 11625b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->lsda_encoding, NULL); 11725b3c049e70834cf33790a28643ab058b507b35cBen Cheng continue; 11825b3c049e70834cf33790a28643ab058b507b35cBen Cheng 11925b3c049e70834cf33790a28643ab058b507b35cBen Cheng case 'R': /* FDE address encoding byte. */ 12025b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->fde_encoding = *data++; 12125b3c049e70834cf33790a28643ab058b507b35cBen Cheng continue; 12225b3c049e70834cf33790a28643ab058b507b35cBen Cheng 12325b3c049e70834cf33790a28643ab058b507b35cBen Cheng case 'P': /* Skip personality routine. */ 12425b3c049e70834cf33790a28643ab058b507b35cBen Cheng encoding = *data++; 12525b3c049e70834cf33790a28643ab058b507b35cBen Cheng data += encoded_value_size (&cache->data->d, cache->e_ident, 12625b3c049e70834cf33790a28643ab058b507b35cBen Cheng encoding, data); 12725b3c049e70834cf33790a28643ab058b507b35cBen Cheng continue; 12825b3c049e70834cf33790a28643ab058b507b35cBen Cheng 12925b3c049e70834cf33790a28643ab058b507b35cBen Cheng default: 13025b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* Unknown augmentation string. If we have 'z' we can ignore it, 13125b3c049e70834cf33790a28643ab058b507b35cBen Cheng otherwise we must bail out. */ 13225b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (cie->sized_augmentation_data) 13325b3c049e70834cf33790a28643ab058b507b35cBen Cheng continue; 13425b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 13525b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* We only get here when we need to bail out. */ 13625b3c049e70834cf33790a28643ab058b507b35cBen Cheng break; 13725b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 13825b3c049e70834cf33790a28643ab058b507b35cBen Cheng 13925b3c049e70834cf33790a28643ab058b507b35cBen Cheng if ((cie->fde_encoding & 0x0f) == DW_EH_PE_absptr) 14025b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 14125b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* Canonicalize encoding to a specific size. */ 14225b3c049e70834cf33790a28643ab058b507b35cBen Cheng assert (DW_EH_PE_absptr == 0); 14325b3c049e70834cf33790a28643ab058b507b35cBen Cheng 14425b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* XXX should get from dwarf_next_cfi with v4 header. */ 14525b3c049e70834cf33790a28643ab058b507b35cBen Cheng uint_fast8_t address_size 14625b3c049e70834cf33790a28643ab058b507b35cBen Cheng = cache->e_ident[EI_CLASS] == ELFCLASS32 ? 4 : 8; 14725b3c049e70834cf33790a28643ab058b507b35cBen Cheng switch (address_size) 14825b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 14925b3c049e70834cf33790a28643ab058b507b35cBen Cheng case 8: 15025b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->fde_encoding |= DW_EH_PE_udata8; 15125b3c049e70834cf33790a28643ab058b507b35cBen Cheng break; 15225b3c049e70834cf33790a28643ab058b507b35cBen Cheng case 4: 15325b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->fde_encoding |= DW_EH_PE_udata4; 15425b3c049e70834cf33790a28643ab058b507b35cBen Cheng break; 15525b3c049e70834cf33790a28643ab058b507b35cBen Cheng default: 15625b3c049e70834cf33790a28643ab058b507b35cBen Cheng free (cie); 15725b3c049e70834cf33790a28643ab058b507b35cBen Cheng __libdw_seterrno (DWARF_E_INVALID_DWARF); 15825b3c049e70834cf33790a28643ab058b507b35cBen Cheng return NULL; 15925b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 16025b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 16125b3c049e70834cf33790a28643ab058b507b35cBen Cheng 16225b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* Save the initial instructions to be played out into initial state. */ 16325b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->initial_instructions = info->initial_instructions; 16425b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->initial_instructions_end = info->initial_instructions_end; 16525b3c049e70834cf33790a28643ab058b507b35cBen Cheng cie->initial_state = NULL; 16625b3c049e70834cf33790a28643ab058b507b35cBen Cheng 16725b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* Add the new entry to the search tree. */ 16825b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (tsearch (cie, &cache->cie_tree, &compare_cie) == NULL) 16925b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 17025b3c049e70834cf33790a28643ab058b507b35cBen Cheng free (cie); 17125b3c049e70834cf33790a28643ab058b507b35cBen Cheng __libdw_seterrno (DWARF_E_NOMEM); 17225b3c049e70834cf33790a28643ab058b507b35cBen Cheng return NULL; 17325b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 17425b3c049e70834cf33790a28643ab058b507b35cBen Cheng 17525b3c049e70834cf33790a28643ab058b507b35cBen Cheng return cie; 17625b3c049e70834cf33790a28643ab058b507b35cBen Cheng} 17725b3c049e70834cf33790a28643ab058b507b35cBen Cheng 17825b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Look up a CIE_pointer for random access. */ 17925b3c049e70834cf33790a28643ab058b507b35cBen Chengstruct dwarf_cie * 18025b3c049e70834cf33790a28643ab058b507b35cBen Chenginternal_function 18125b3c049e70834cf33790a28643ab058b507b35cBen Cheng__libdw_find_cie (Dwarf_CFI *cache, Dwarf_Off offset) 18225b3c049e70834cf33790a28643ab058b507b35cBen Cheng{ 18325b3c049e70834cf33790a28643ab058b507b35cBen Cheng const struct dwarf_cie cie_key = { .offset = offset }; 18425b3c049e70834cf33790a28643ab058b507b35cBen Cheng struct dwarf_cie **found = tfind (&cie_key, &cache->cie_tree, &compare_cie); 18525b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (found != NULL) 18625b3c049e70834cf33790a28643ab058b507b35cBen Cheng return *found; 18725b3c049e70834cf33790a28643ab058b507b35cBen Cheng 18825b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* We have not read this CIE yet. Go find it. */ 18925b3c049e70834cf33790a28643ab058b507b35cBen Cheng Dwarf_Off next_offset = offset; 19025b3c049e70834cf33790a28643ab058b507b35cBen Cheng Dwarf_CFI_Entry entry; 19125b3c049e70834cf33790a28643ab058b507b35cBen Cheng int result = INTUSE(dwarf_next_cfi) (cache->e_ident, 19225b3c049e70834cf33790a28643ab058b507b35cBen Cheng &cache->data->d, CFI_IS_EH (cache), 19325b3c049e70834cf33790a28643ab058b507b35cBen Cheng offset, &next_offset, &entry); 19425b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (result != 0 || entry.cie.CIE_id != DW_CIE_ID_64) 19525b3c049e70834cf33790a28643ab058b507b35cBen Cheng { 19625b3c049e70834cf33790a28643ab058b507b35cBen Cheng __libdw_seterrno (DWARF_E_INVALID_DWARF); 19725b3c049e70834cf33790a28643ab058b507b35cBen Cheng return NULL; 19825b3c049e70834cf33790a28643ab058b507b35cBen Cheng } 19925b3c049e70834cf33790a28643ab058b507b35cBen Cheng 20025b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* If this happened to be what we would have read next, notice it. */ 20125b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (cache->next_offset == offset) 20225b3c049e70834cf33790a28643ab058b507b35cBen Cheng cache->next_offset = next_offset; 20325b3c049e70834cf33790a28643ab058b507b35cBen Cheng 20425b3c049e70834cf33790a28643ab058b507b35cBen Cheng return intern_new_cie (cache, offset, &entry.cie); 20525b3c049e70834cf33790a28643ab058b507b35cBen Cheng} 20625b3c049e70834cf33790a28643ab058b507b35cBen Cheng 20725b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Enter a CIE encountered while reading through for FDEs. */ 20825b3c049e70834cf33790a28643ab058b507b35cBen Chengvoid 20925b3c049e70834cf33790a28643ab058b507b35cBen Chenginternal_function 21025b3c049e70834cf33790a28643ab058b507b35cBen Cheng__libdw_intern_cie (Dwarf_CFI *cache, Dwarf_Off offset, const Dwarf_CIE *info) 21125b3c049e70834cf33790a28643ab058b507b35cBen Cheng{ 21225b3c049e70834cf33790a28643ab058b507b35cBen Cheng const struct dwarf_cie cie_key = { .offset = offset }; 21325b3c049e70834cf33790a28643ab058b507b35cBen Cheng struct dwarf_cie **found = tfind (&cie_key, &cache->cie_tree, &compare_cie); 21425b3c049e70834cf33790a28643ab058b507b35cBen Cheng if (found == NULL) 21525b3c049e70834cf33790a28643ab058b507b35cBen Cheng /* We have not read this CIE yet. Enter it. */ 21625b3c049e70834cf33790a28643ab058b507b35cBen Cheng (void) intern_new_cie (cache, offset, info); 21725b3c049e70834cf33790a28643ab058b507b35cBen Cheng} 218