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_aranges.3 2122 2011-11-09 15:35:14Z jkoshy $
29 .Dt DWARF_GET_ARANGES 3
32 .Nd retrieve program address space mappings
40 .Fa "Dwarf_Arange **ar_list"
41 .Fa "Dwarf_Signed *ar_cnt"
42 .Fa "Dwarf_Error *err"
47 retrieves address range information from the
50 Information about address ranges is returned using opaque descriptors
56 should reference a DWARF debug context allocated using
61 should point to a location which will be set to a pointer to an array
68 should point to a location which will be set to the number of
73 is not NULL, it will be used to store error information in case of an
76 The memory area used for the array returned in argument
80 Application code should not attempt to directly free this area.
81 Portable applications should instead use
83 to indicate that the memory area may be freed.
94 section associated with the specified debugging context.
95 In case of an error, it returns
101 .Fn dwarf_get_aranges
103 .Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY"
104 .It Bq Er DW_DLE_ARGUMENT
111 .It Bq Er DW_DLE_NO_ENTRY
112 The debugging context
119 To loop through all the address lookup table entries, use:
120 .Bd -literal -offset indent
123 Dwarf_Arange *aranges;
126 Dwarf_Unsigned length;
129 if (dwarf_get_aranges(dbg, &aranges, &cnt, &de) != DW_DLV_OK)
130 errx(EXIT_FAILURE, "dwarf_get_aranges: %s",
133 for (i = 0; i < cnt; i++) {
134 if (dwarf_get_arange_info(aranges[i], &start, &length,
135 &die_off, &de) != DW_DLV_OK) {
136 warnx("dwarf_get_arange_info: %s",
140 /* Do something with the returned information. */
145 .Xr dwarf_get_arange 3 ,
146 .Xr dwarf_get_arange_cu_header_offset 3 ,
147 .Xr dwarf_get_arange_info 3 ,
148 .Xr dwarf_get_cu_die_offset 3