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_relocation_info_count.3 2071 2011-10-27 03:20:00Z jkoshy $
29 .Dt DWARF_GET_RELOCATION_INFO_COUNT 3
31 .Nm dwarf_get_relocation_info_count
32 .Nd return the number of relocation arrays
38 .Fo dwarf_get_relocation_info_count
39 .Fa "Dwarf_P_Debug dbg"
40 .Fa "Dwarf_Unsigned *reloc_cnt"
41 .Fa "int *drd_buffer_version"
42 .Fa "Dwarf_Error *err"
46 .Fn dwarf_get_relocation_info_count
47 retrieves the total number of relocation arrays generated by a prior
49 .Xr dwarf_transform_to_disk_form 3 .
53 should reference a DWARF producer instance allocated using
54 .Xr dwarf_producer_init 3
56 .Xr dwarf_producer_init_b 3 .
58 .Dv DW_DLC_SYMBOLIC_RELOCATIONS
59 flag should have been set on the producer instance.
63 should point to a location which will be set to the total number of
64 relocation arrays generated.
67 .Ar drd_buffer_version
68 should point to a location which will be set to the version number
69 of the relocation structures returned (see the symbol
70 .Dv DWARF_DRD_BUFFER_VERSION ,
71 defined in the header file
76 is not NULL, it will be used to store error information in case
80 .Fn dwarf_get_relocation_info_count
86 .Dv DW_DLC_SYMBOLIC_RELOCATIONS
87 flag is not set on the producer instance.
88 In case of an error, function
89 .Fn dwarf_get_relocation_info_count
96 .Fn dwarf_get_relocation_info_count
98 .Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY"
99 .It Bq Er DW_DLE_ARGUMENT
104 .Ar drd_buffer_version
106 .It Bq Er DW_DLE_NO_ENTRY
108 .Dv DW_DLC_SYMBOLIC_RELOCATIONS
113 .Xr dwarf_get_relocation_info 3 ,
114 .Xr dwarf_producer_init 3 ,
115 .Xr dwarf_producer_init_b 3 ,
116 .Xr dwarf_transform_to_disk_form 3