1 .\" Copyright (c) 2011 Kai Wang
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_get_globals.3 3640 2018-10-14 14:09:13Z jkoshy $
28 .Dt DWARF_GET_GLOBALS 3
31 .Nm dwarf_get_globals ,
32 .Nm dwarf_global_cu_offset ,
33 .Nm dwarf_global_die_offset ,
34 .Nm dwarf_global_name_offsets ,
36 .Nd retrieve information about global objects
44 .Fa "Dwarf_Global **globals"
45 .Fa "Dwarf_Signed *nglobals"
46 .Fa "Dwarf_Error *err"
49 .Fo dwarf_global_cu_offset
50 .Fa "Dwarf_Global global"
51 .Fa "Dwarf_Off *cu_offset"
52 .Fa "Dwarf_Error *err"
55 .Fo dwarf_global_die_offset
56 .Fa "Dwarf_Global global"
57 .Fa "Dwarf_Off *die_offset"
58 .Fa "Dwarf_Error *err"
61 .Fo dwarf_global_name_offsets
62 .Fa "Dwarf_Global global"
64 .Fa "Dwarf_Off *die_offset"
65 .Fa "Dwarf_Off *cu_die_offset"
66 .Fa "Dwarf_Error *err"
70 .Fa "Dwarf_Global global"
72 .Fa "Dwarf_Error *err"
75 These functions retrieve information about global symbols from the
79 Information about these global symbols is returned using opaque descriptors
82 Applications need to use the functions described below to retrieve the
83 name and the offsets for these descriptors.
87 retrieves descriptors for all the global symbols associated with the
88 DWARF debug context specified by argument
92 should point to a location that will be set to a pointer to an array
98 should point to a location that will be set to the number of
102 .Fn dwarf_global_cu_offset
103 returns the section-relative offset, relative to the
105 section, of the compilation unit that contains the debugging
106 information entry associated with the argument
110 should point to a location that will hold the returned offset.
113 .Fn dwarf_global_die_offset
114 retrieves the section-relative offset, relative to the
116 section, of the debugging information entry associated with the
119 and stores it into the location pointed to by the argument
123 .Fn dwarf_global_name_offsets
124 retrieves the name and the offsets for the debugging information
129 should point to a location which will be set to a pointer to a
130 NUL-terminated string containing the name of the associated debugging
134 should point to a location which will be set to a section-relative
135 offset, relative to the
137 section, of the associated debugging information entry.
140 should point to a location which will be set to a
141 section-relative offset, relative to the
143 section, of the first debugging information entry in
144 the compilation unit associated with argument
149 sets the location pointed to by argument
151 to a pointer to a NUL-terminated string holding the name of the
152 debugging information entry associated with the argument
154 .Ss Memory Management
155 The memory area used for the array of
157 descriptors returned in argument
160 .Fn dwarf_get_globals
163 Application code should not attempt to directly free this pointer.
164 Portable code should instead use the function
165 .Xr dwarf_globals_dealloc 3
166 to indicate that the memory area may be freed.
168 The memory area used for the string returned in the
170 argument to functions
173 .Fn dwarf_global_name_offsets
176 Portable code should use the
178 function to indicate that the memory area may be freed.
182 is not NULL, these functions will use it to store error information,
185 On success, these functions returns
187 In case of an error, they return
192 These functions may fail with the following errors:
193 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
194 .It Bq Er DW_DLE_ARGUMENT
209 .Xr dwarf_dealloc 3 ,
210 .Xr dwarf_get_cu_die_offset_given_cu_header_offset 3 ,
211 .Xr dwarf_globals_dealloc 3