Home | History | Annotate | Download | only in libdw
      1 /* Get attributes of the DIE.
      2    Copyright (C) 2004, 2005, 2008, 2009 Red Hat, Inc.
      3    This file is part of Red Hat elfutils.
      4    Written by Ulrich Drepper <drepper (at) redhat.com>, 2004.
      5 
      6    Red Hat elfutils is free software; you can redistribute it and/or modify
      7    it under the terms of the GNU General Public License as published by the
      8    Free Software Foundation; version 2 of the License.
      9 
     10    Red Hat elfutils is distributed in the hope that it will be useful, but
     11    WITHOUT ANY WARRANTY; without even the implied warranty of
     12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     13    General Public License for more details.
     14 
     15    You should have received a copy of the GNU General Public License along
     16    with Red Hat elfutils; if not, write to the Free Software Foundation,
     17    Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA.
     18 
     19    In addition, as a special exception, Red Hat, Inc. gives You the
     20    additional right to link the code of Red Hat elfutils with code licensed
     21    under any Open Source Initiative certified open source license
     22    (http://www.opensource.org/licenses/index.php) which requires the
     23    distribution of source code with any binary distribution and to
     24    distribute linked combinations of the two.  Non-GPL Code permitted under
     25    this exception must only link to the code of Red Hat elfutils through
     26    those well defined interfaces identified in the file named EXCEPTION
     27    found in the source code files (the "Approved Interfaces").  The files
     28    of Non-GPL Code may instantiate templates or use macros or inline
     29    functions from the Approved Interfaces without causing the resulting
     30    work to be covered by the GNU General Public License.  Only Red Hat,
     31    Inc. may make changes or additions to the list of Approved Interfaces.
     32    Red Hat's grant of this exception is conditioned upon your not adding
     33    any new exceptions.  If you wish to add a new Approved Interface or
     34    exception, please contact Red Hat.  You must obey the GNU General Public
     35    License in all respects for all of the Red Hat elfutils code and other
     36    code used in conjunction with Red Hat elfutils except the Non-GPL Code
     37    covered by this exception.  If you modify this file, you may extend this
     38    exception to your version of the file, but you are not obligated to do
     39    so.  If you do not wish to provide this exception without modification,
     40    you must delete this exception statement from your version and license
     41    this file solely under the GPL without exception.
     42 
     43    Red Hat elfutils is an included package of the Open Invention Network.
     44    An included package of the Open Invention Network is a package for which
     45    Open Invention Network licensees cross-license their patents.  No patent
     46    license is granted, either expressly or impliedly, by designation as an
     47    included package.  Should you wish to participate in the Open Invention
     48    Network licensing program, please visit www.openinventionnetwork.com
     49    <http://www.openinventionnetwork.com>.  */
     50 
     51 #ifdef HAVE_CONFIG_H
     52 # include <config.h>
     53 #endif
     54 
     55 #include "libdwP.h"
     56 
     57 
     58 ptrdiff_t
     59 dwarf_getattrs (Dwarf_Die *die, int (*callback) (Dwarf_Attribute *, void *),
     60 		void *arg, ptrdiff_t offset)
     61 {
     62   if (die == NULL)
     63     return -1l;
     64 
     65   if (unlikely (offset == 1))
     66     return 1;
     67 
     68   const unsigned char *die_addr = die->addr;
     69 
     70   /* Get the abbreviation code.  */
     71   unsigned int u128;
     72   get_uleb128 (u128, die_addr);
     73 
     74   if (die->abbrev == NULL)
     75     /* Find the abbreviation.  */
     76     die->abbrev = __libdw_findabbrev (die->cu, u128);
     77 
     78   if (unlikely (die->abbrev == DWARF_END_ABBREV))
     79     {
     80     invalid_dwarf:
     81       __libdw_seterrno (DWARF_E_INVALID_DWARF);
     82       return -1l;
     83     }
     84 
     85   /* This is where the attributes start.  */
     86   const unsigned char *attrp = die->abbrev->attrp;
     87   const unsigned char *const offset_attrp = die->abbrev->attrp + offset;
     88 
     89   /* Go over the list of attributes.  */
     90   Dwarf *dbg = die->cu->dbg;
     91   while (1)
     92     {
     93       /* Are we still in bounds?  */
     94       if (unlikely (attrp
     95 		    >= ((unsigned char *) dbg->sectiondata[IDX_debug_abbrev]->d_buf
     96 			+ dbg->sectiondata[IDX_debug_abbrev]->d_size)))
     97 	goto invalid_dwarf;
     98 
     99       /* Get attribute name and form.  */
    100       Dwarf_Attribute attr;
    101       const unsigned char *remembered_attrp = attrp;
    102 
    103       // XXX Fix bound checks
    104       get_uleb128 (attr.code, attrp);
    105       get_uleb128 (attr.form, attrp);
    106 
    107       /* We can stop if we found the attribute with value zero.  */
    108       if (attr.code == 0 && attr.form == 0)
    109 	/* Do not return 0 here - there would be no way to
    110 	   distinguish this value from the attribute at offset 0.
    111 	   Instead we return +1 which would never be a valid
    112 	   offset of an attribute.  */
    113         return 1l;
    114 
    115       /* If we are not to OFFSET_ATTRP yet, we just have to skip
    116 	 the values of the intervening attributes.  */
    117       if (remembered_attrp >= offset_attrp)
    118 	{
    119 	  /* Fill in the rest.  */
    120 	  attr.valp = (unsigned char *) die_addr;
    121 	  attr.cu = die->cu;
    122 
    123 	  /* Now call the callback function.  */
    124 	  if (callback (&attr, arg) != DWARF_CB_OK)
    125 	    /* Return the offset of the start of the attribute, so that
    126 	       dwarf_getattrs() can be restarted from this point if the
    127 	       caller so desires.  */
    128 	    return remembered_attrp - die->abbrev->attrp;
    129 	}
    130 
    131       /* Skip over the rest of this attribute (if there is any).  */
    132       if (attr.form != 0)
    133 	{
    134 	  size_t len = __libdw_form_val_len (dbg, die->cu, attr.form,
    135 					     die_addr);
    136 
    137 	  if (unlikely (len == (size_t) -1l))
    138 	    /* Something wrong with the file.  */
    139 	    return -1l;
    140 
    141 	  // XXX We need better boundary checks.
    142 	  die_addr += len;
    143 	}
    144     }
    145   /* NOTREACHED */
    146 }
    147