xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_get_AT_name.3 (revision d8a0fe102c0cfdfcd5b818f850eff09d8536c9bc)
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_AT_name.3 3142 2015-01-29 23:11:14Z jkoshy $
26.\"
27.Dd April 22, 2011
28.Os
29.Dt DWARF_GET_AT_NAME 3
30.Sh NAME
31.Nm dwarf_get_ACCESS_name ,
32.Nm dwarf_get_AT_name ,
33.Nm dwarf_get_ATE_name ,
34.Nm dwarf_get_CC_name ,
35.Nm dwarf_get_CFA_name ,
36.Nm dwarf_get_CHILDREN_name ,
37.Nm dwarf_get_DS_name ,
38.Nm dwarf_get_DSC_name ,
39.Nm dwarf_get_EH_name ,
40.Nm dwarf_get_END_name ,
41.Nm dwarf_get_FORM_name ,
42.Nm dwarf_get_ID_name ,
43.Nm dwarf_get_INL_name ,
44.Nm dwarf_get_LANG_name ,
45.Nm dwarf_get_LNE_name ,
46.Nm dwarf_get_LNS_name ,
47.Nm dwarf_get_MACINFO_name ,
48.Nm dwarf_get_OP_name ,
49.Nm dwarf_get_ORD_name ,
50.Nm dwarf_get_TAG_name ,
51.Nm dwarf_get_VIRTUALITY_name ,
52.Nm dwarf_get_VIS_name
53.Nd retrieve the symbolic names of DWARF constants
54.Sh LIBRARY
55.Lb libdwarf
56.Sh SYNOPSIS
57.In libdwarf.h
58.Ft int
59.Fo dwarf_get_ACCESS_name
60.Fa "unsigned val"
61.Fa "char **str"
62.Fc
63.Ft int
64.Fo dwarf_get_AT_name
65.Fa "unsigned val"
66.Fa "char **str"
67.Fc
68.Ft int
69.Fo dwarf_get_ATE_name
70.Fa "unsigned val"
71.Fa "char **str"
72.Fc
73.Ft int
74.Fo dwarf_get_CC_name
75.Fa "unsigned val"
76.Fa "char **str"
77.Fc
78.Ft int
79.Fo dwarf_get_CFA_name
80.Fa "unsigned val"
81.Fa "char **str"
82.Fc
83.Ft int
84.Fo dwarf_get_CHILDREN_name
85.Fa "unsigned val"
86.Fa "char **str"
87.Fc
88.Ft int
89.Fo dwarf_get_DS_name
90.Fa "unsigned val"
91.Fa "char **str"
92.Fc
93.Ft int
94.Fo dwarf_get_DSC_name
95.Fa "unsigned val"
96.Fa "char **str"
97.Fc
98.Ft int
99.Fo dwarf_get_EH_name
100.Fa "unsigned val"
101.Fa "char **str"
102.Fc
103.Ft int
104.Fo dwarf_get_END_name
105.Fa "unsigned val"
106.Fa "char **str"
107.Fc
108.Ft int
109.Fo dwarf_get_FORM_name
110.Fa "unsigned val"
111.Fa "char **str"
112.Fc
113.Ft int
114.Fo dwarf_get_ID_name
115.Fa "unsigned val"
116.Fa "char **str"
117.Fc
118.Ft int
119.Fo dwarf_get_INL_name
120.Fa "unsigned val"
121.Fa "char **str"
122.Fc
123.Ft int
124.Fo dwarf_get_LANG_name
125.Fa "unsigned val"
126.Fa "char **str"
127.Fc
128.Ft int
129.Fo dwarf_get_LNE_name
130.Fa "unsigned val"
131.Fa "char **str"
132.Fc
133.Ft int
134.Fo dwarf_get_LNS_name
135.Fa "unsigned val"
136.Fa "char **str"
137.Fc
138.Ft int
139.Fo dwarf_get_MACINFO_name
140.Fa "unsigned val"
141.Fa "char **str"
142.Fc
143.Ft int
144.Fo dwarf_get_OP_name
145.Fa "unsigned val"
146.Fa "char **str"
147.Fc
148.Ft int
149.Fo dwarf_get_ORD_name
150.Fa "unsigned val"
151.Fa "char **str"
152.Fc
153.Ft int
154.Fo dwarf_get_TAG_name
155.Fa "unsigned val"
156.Fa "char **str"
157.Fc
158.Ft int
159.Fo dwarf_get_VIRTUALITY_name
160.Fa "unsigned val"
161.Fa "char **str"
162.Fc
163.Ft int
164.Fo dwarf_get_VIS_name
165.Fa "unsigned val"
166.Fa "char **str"
167.Fc
168.Sh DESCRIPTION
169These functions return the symbolic name of a numeric DWARF constant.
170.Pp
171Argument
172.Ar val
173specifies the numeric value whose symbolic name is desired.
174.Pp
175Argument
176.Ar str
177should point to a location which will hold the returned
178NUL-terminated string containing the symbolic name of the
179specified value.
180.Pp
181The list of functions and the DWARF constants that they accept are:
182.Pp
183.Bl -tag -width ".Fn dwarf_get_VIRTUALITY_name" -compact
184.It Fn dwarf_get_ACCESS_name
185.Dv DW_ACCESS_*
186constants.
187.It Fn dwarf_get_AT_name
188.Dv DW_AT_*
189constants.
190.It Fn dwarf_get_ATE_name
191.Dv DW_ATE_*
192constants.
193.It Fn dwarf_get_CC_name
194.Dv DW_CC_*
195constants.
196.It Fn dwarf_get_CFA_name
197.Dv DW_CFA_*
198constants.
199.It Fn dwarf_get_CHILDREN_name
200.Dv DW_CHILDREN_*
201constants.
202.It Fn dwarf_get_DS_name
203.Dv DW_DS_*
204constants.
205.It Fn dwarf_get_DSC_name
206.Dv DW_DSC_*
207constants.
208.It Fn dwarf_get_EH_name
209.Dv DW_EH_PE_*
210constants.
211.It Fn dwarf_get_END_name
212.Dv DW_END_*
213constants.
214.It Fn dwarf_get_FORM_name
215.Dv DW_FORM_*
216constants.
217.It Fn dwarf_get_ID_name
218.Dv DW_ID_*
219constants.
220.It Fn dwarf_get_INL_name
221.Dv DW_INL_*
222constants.
223.It Fn dwarf_get_LANG_name
224.Dv DW_LANG_*
225constants.
226.It Fn dwarf_get_LNE_name
227.Dv DW_LNE_*
228constants.
229.It Fn dwarf_get_LNS_name
230.Dv DW_LNS_*
231constants.
232.It Fn dwarf_get_MACINFO_name
233.Dv DW_MACINFO_*
234constants.
235.It Fn dwarf_get_OP_name
236.Dv DW_OP_*
237constants.
238.It Fn dwarf_get_ORD_name
239.Dv DW_ORD_*
240constants.
241.It Fn dwarf_get_TAG_name
242.Dv DW_TAG_*
243constants.
244.It Fn dwarf_get_VIRTUALITY_name
245.Dv DW_VIRTUALITY_*
246constants.
247.It Fn dwarf_get_VIS_name
248.Dv DW_VIS_*
249constants.
250.El
251.Sh RETURN VALUES
252These functions return
253.Dv DW_DLV_OK on success.
254If the DWARF constant denoted by argument
255.Ar val
256is not recognized, these function return
257.Dv DW_DLV_NO_ENTRY .
258.Sh SEE ALSO
259.Xr dwarf 3
260