1 .\" Copyright (c) 2010 Joseph Koshy
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" $Id: dwarf_formref.3 2073 2011-10-27 03:30:47Z jkoshy $
32 .Nm dwarf_global_formref
33 .Nd retrieve offsets for REFERENCE class attributes
40 .Fa "Dwarf_Attribute attr"
41 .Fa "Dwarf_Off *retoffset"
42 .Fa "Dwarf_Error *err"
45 .Fo dwarf_global_formref
46 .Fa "Dwarf_Attribute attr"
47 .Fa "Dwarf_Off *retoffset"
48 .Fa "Dwarf_Error *err"
51 These functions return the offsets associated with a DWARF attribute
56 returns the compilation unit relative offset of the descriptor
57 referenced by argument
59 in the location pointed to by argument
63 must be a reference that is local to a compilation unit.
64 Permitted forms for argument
72 .Dv DW_FORM_ref_udata .
75 .Fn dwarf_global_formref
76 returns the section-relative offset of the descriptor referenced by
79 in the location pointed to by argument
86 Permitted forms for argument
89 .Dv DW_FORM_ref_addr ,
90 .Dv DW_FORM_ref_udata ,
96 .Dv DW_FORM_sec_offset .
97 The returned offset is relative to the start of the
103 is not NULL, it will be used to return an error descriptor in case
106 These functions return
109 In case of an error, these functions return
114 These functions may fail with the following errors:
115 .Bl -tag -width ".Bq Er DW_DLE_ATTR_FORM_BAD"
116 .It Bq Er DW_DLE_ARGUMENT
122 .It Bq Er DW_DLE_ATTR_FORM_BAD
123 The attribute referenced by argument
125 was not of a permitted kind.
130 .Xr dwarf_formblock 3 ,
131 .Xr dwarf_formflag 3 ,
132 .Xr dwarf_formsdata 3 ,
133 .Xr dwarf_formsig8 3 ,
134 .Xr dwarf_formstring 3 ,
135 .Xr dwarf_formudata 3 ,