source: rtems-tools/rtemstoolkit/elftoolchain/libdwarf/dwarf_get_arange.3 @ 4bb3996

5
Last change on this file since 4bb3996 was 4bb3996, checked in by Chris Johns <chrisj@…>, on 04/30/18 at 05:34:48

rtemstoolkit: Add libdwarf from elftoolchain.

The code is taken from:

​https://svn.code.sf.net/p/elftoolchain/code/trunk

Update #3417
  • Property mode set to 100644
File size: 3.1 KB
Line 
1.\" Copyright (c) 2011 Kai Wang
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
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.
12.\"
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
23.\" SUCH DAMAGE.
24.\"
25.\" $Id: dwarf_get_arange.3 2071 2011-10-27 03:20:00Z jkoshy $
26.\"
27.Dd April 16, 2011
28.Os
29.Dt DWARF_GET_ARANGE 3
30.Sh NAME
31.Nm dwarf_get_arange
32.Nd retrieve the address range descriptor for an address
33.Sh LIBRARY
34.Lb libdwarf
35.Sh SYNOPSIS
36.In libdwarf.h
37.Ft int
38.Fo dwarf_get_arange
39.Fa "Dwarf_Arange *ar_list"
40.Fa "Dwarf_Unsigned ar_cnt"
41.Fa "Dwarf_Addr addr"
42.Fa "Dwarf_Arange *ret_ar"
43.Fa "Dwarf_Error *err"
44.Fc
45.Sh DESCRIPTION
46Function
47.Fn dwarf_get_arange
48searches an array of
49.Vt Dwarf_Arange
50descriptors for one that covers a given address.
51.Pp
52Argument
53.Ar ar_list
54should point to an array of
55.Vt Dwarf_Arange
56descriptors.
57.Pp
58Argument
59.Ar ar_cnt
60specifies the number of
61.Vt Dwarf_Arange
62descriptors in the array pointed to by argument
63.Ar ar_list .
64.Pp
65Argument
66.Ar addr
67specifies the address being looked up.
68.Pp
69Argument
70.Ar ret_ar
71will be used to store the
72.Vt Dwarf_Arange
73descriptor that covers the given address.
74.Pp
75If argument
76.Ar err
77is not NULL, it will be used to store error information in case of an
78error.
79.Sh RETURN VALUES
80Function
81.Fn dwarf_get_arange
82returns
83.Dv DW_DLV_OK
84when it succeeds.
85It returns
86.Dv DW_DLV_NO_ENTRY
87if there is no
88.Vt Dwarf_Arange
89descriptor that covers the provided address.
90In case of an error, it returns
91.Dv DW_DLV_ERROR
92and sets the argument
93.Ar err .
94.Sh ERRORS
95Function
96.Fn dwarf_get_arange
97can fail with:
98.Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY"
99.It Bq Er DW_DLE_ARGUMENT
100One of the arguments
101.Ar dbg ,
102.Ar ar_list
103or
104.Ar ret_ar
105was NULL.
106.It Bq Er DW_DLE_ARGUMENT
107Value of argument
108.Ar ar_cnt
109equals to 0.
110.It Bq Er DW_DLE_NO_ENTRY
111A
112.Vt Dwarf_Arange
113descriptor that covers the given address
114was not found.
115.El
116.Sh SEE ALSO
117.Xr dwarf 3 ,
118.Xr dwarf_get_aranges 3 ,
119.Xr dwarf_get_arange_cu_header_offset 3 ,
120.Xr dwarf_get_arange_info 3 ,
121.Xr dwarf_get_cu_die_offset 3
Note: See TracBrowser for help on using the repository browser.