external/bsd/elftoolchain/dist/libdwarf/dwarf_get_weaks.3

   1 .\"     $NetBSD: dwarf_get_weaks.3,v 1.2 2014/03/09 16:58:04 christos Exp $
   2 .\"
   3 .\" Copyright (c) 2011 Kai Wang
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" Id: dwarf_get_weaks.3 2071 2011-10-27 03:20:00Z jkoshy
  28 .\"
  29 .Dd April 10, 2011
  30 .Os
  31 .Dt DWARF_GET_WEAKS 3
  32 .Sh NAME
  33 .Nm dwarf_get_weaks ,
  34 .Nm dwarf_weak_cu_offset ,
  35 .Nm dwarf_weak_die_offset ,
  36 .Nm dwarf_weak_name_offsets ,
  37 .Nm dwarf_weakname
  38 .Nd retrieve information about weak symbols
  39 .Sh LIBRARY
  40 .Lb libdwarf
  41 .Sh SYNOPSIS
  42 .In libdwarf.h
  43 .Ft int
  44 .Fo dwarf_get_weaks
  45 .Fa "Dwarf_Debug dbg"
  46 .Fa "Dwarf_Weak **weaks"
  47 .Fa "Dwarf_Signed *nweaks"
  48 .Fa "Dwarf_Error *err"
  49 .Fc
  50 .Ft int
  51 .Fo dwarf_weak_cu_offset
  52 .Fa "Dwarf_Weak weak"
  53 .Fa "Dwarf_Off *cu_offset"
  54 .Fa "Dwarf_Error *err"
  55 .Fc
  56 .Ft int
  57 .Fo dwarf_weak_die_offset
  58 .Fa "Dwarf_Weak weak"
  59 .Fa "Dwarf_Off *die_offset"
  60 .Fa "Dwarf_Error *err"
  61 .Fc
  62 .Ft int
  63 .Fo dwarf_weak_name_offsets
  64 .Fa "Dwarf_Weak weak"
  65 .Fa "char **name"
  66 .Fa "Dwarf_Off *die_offset"
  67 .Fa "Dwarf_Off *cu_die_offset"
  68 .Fa "Dwarf_Error *err"
  69 .Fc
  70 .Ft int
  71 .Fo dwarf_weakname
  72 .Fa "Dwarf_Weak weak"
  73 .Fa "char **name"
  74 .Fa "Dwarf_Error *err"
  75 .Fc
  76 .Sh DESCRIPTION
  77 These functions retrieve information about weak symbols from the
  78 lookup tables in the (SGI-specific)
  79 .Dq ".debug_weaknames"
  80 section.
  81 Information about weak symbols is returned using opaque descriptors
  82 of type
  83 .Vt Dwarf_Weak .
  84 Applications need to use the functions described below to retrieve
  85 the name and offset information contained in these descriptors.
  86 .Pp
  87 Function
  88 .Fn dwarf_get_weaks
  89 retrieves descriptors for all the weak symbols associated with the
  90 DWARF debug context specified by argument
  91 .Ar dbg .
  92 The argument
  93 .Ar weaks
  94 should point to a location that will be set to a pointer to an array
  95 of
  96 .Vt Dwarf_Weak
  97 descriptors.
  98 The argument
  99 .Ar nweaks
 100 should point to a location that will be set to the number of
 101 descriptors returned.
 102 .Pp
 103 Function
 104 .Fn dwarf_weak_cu_offset
 105 returns the offset, relative to the
 106 .Dq ".debug_info"
 107 section, of the compilation unit that contains the debugging
 108 information entry associated with the argument
 109 .Ar weak .
 110 Argument
 111 .Ar cu_offset
 112 should point to a location that will hold the returned offset.
 113 .Pp
 114 Function
 115 .Fn dwarf_weak_die_offset
 116 retrieves the offset, relative to the
 117 .Dq ".debug_info"
 118 section, of the debugging information entry associated with the
 119 argument
 120 .Ar weak ,
 121 and stores it into the location pointed to by the argument
 122 .Ar die_offset .
 123 .Pp
 124 Function
 125 .Fn dwarf_weak_name_offsets
 126 retrieves the name and offsets for the debugging information
 127 entry for argument
 128 .Ar weak .
 129 Argument
 130 .Ar name
 131 should point to a location which will be set to a pointer to a
 132 NUL-terminated string containing the name of the associated debugging
 133 information entry.
 134 Argument
 135 .Ar die_offset
 136 should point to a location which will be set to the offset, relative
 137 to the
 138 .Dq ".debug_info"
 139 section, of the associated debugging information entry.
 140 Argument
 141 .Ar cu_die_offset
 142 should point to a location which will be set to the
 143 offset, relative to the
 144 .Dq ".debug_info"
 145 section, of the first debugging information entry in the compilation
 146 unit associated with argument
 147 .Ar weak .
 148 .Pp
 149 Function
 150 .Fn dwarf_weakname
 151 sets the location pointed to by argument
 152 .Ar name
 153 to a pointer to a NUL-terminated string holding the name of the
 154 debugging information entry associated with the argument
 155 .Ar weak .
 156 .Ss Memory Management
 157 The memory area used for the array of
 158 .Vt Dwarf_Weak
 159 descriptors returned in argument
 160 .Ar weaks
 161 by function
 162 .Fn dwarf_get_weaks
 163 is owned by the
 164 .Lb libdwarf .
 165 Application code should not attempt to directly free this pointer.
 166 Portable code should instead use the function
 167 .Xr dwarf_weaks_dealloc 3
 168 to indicate that the memory area may be freed.
 169 .Pp
 170 The memory area used for the string returned in the
 171 .Ar name
 172 argument to functions
 173 .Fn dwarf_weak_name_offsets
 174 and
 175 .Fn dwarf_weakname
 176 is owned by the
 177 .Lb libdwarf .
 178 Portable code should indicate that the memory area can
 179 be freed using the
 180 .Xr dwarf_dealloc 3
 181 function.
 182 .Ss Error Returns
 183 If argument
 184 .Ar err
 185 is not NULL, these functions will use it to store error information,
 186 in case of an error.
 187 .Sh RETURN VALUES
 188 On success, these functions returns
 189 .Dv DW_DLV_OK .
 190 In case of an error, they return
 191 .Dv DW_DLV_ERROR
 192 and set the argument
 193 .Ar err .
 194 .Sh ERRORS
 195 These functions may fail with the following errors:
 196 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
 197 .It Bq Er DW_DLE_ARGUMENT
 198 One of the arguments
 199 .Va cu_die_offset ,
 200 .Va cu_offset ,
 201 .Va dbg ,
 202 .Va die_offset ,
 203 .Va weak ,
 204 .Va weaks ,
 205 .Va name ,
 206 or
 207 .Va nweaks
 208 was NULL.
 209 .It Bq Er DW_DLE_NO_ENTRY
 210 The DWARF debugging context referenced by argument
 211 .Ar dbg
 212 did not contain information about weak symbols.
 213 .El
 214 .Sh SEE ALSO
 215 .Xr dwarf 3 ,
 216 .Xr dwarf_get_cu_die_offset_given_cu_header_offset 3 ,
 217 .Xr dwarf_weaks_dealloc 3