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_section_bytes.3 2071 2011-10-27 03:20:00Z jkoshy $
29 .Dt DWARF_GET_SECTION_BYTES 3
31 .Nm dwarf_get_section_bytes
32 .Nd retrieve ELF section byte streams
38 .Fo dwarf_get_section_bytes
39 .Fa "Dwarf_P_Debug dbg"
40 .Fa "Dwarf_Signed dwarf_section"
41 .Fa "Dwarf_Signed *elf_section_index"
42 .Fa "Dwarf_Unsigned *length"
43 .Fa "Dwarf_Error *err"
47 .Fn dwarf_get_section_bytes
48 returns the ELF section byte streams generated by a prior call
50 .Xr dwarf_transform_to_disk_form 3 .
53 .Fn dwarf_get_section_bytes
54 will return the byte stream for one ELF section.
55 The first call to this function will always return the first ELF
56 section, and the subsequent calls will return the rest of sections
57 in the order when they were generated, until the last one.
58 The total number of sections generated is returned by the function
59 .Xr dwarf_transform_to_disk_form 3 .
63 should reference a DWARF producer instance allocated using the
65 .Xr dwarf_producer_init 3
67 .Xr dwarf_producer_init_b 3 .
75 should point to a location which will be set to the section index value
76 of the returned ELF section.
80 should point to a location which will hold the length in bytes of the
85 is not NULL, it will be used to store error information in case of an
88 The memory areas used for the returned ELF section byte streams should
89 be freed using the function
90 .Fn dwarf_producer_finish .
93 .Fn dwarf_get_section_bytes
94 returns a pointer to a ELF section byte stream.
95 In case of an error, function
96 .Fn dwarf_get_section_bytes
97 will return NULL and set the argument
101 .Fn dwarf_get_section_bytes
103 .Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY"
104 .It Bq Er DW_DLE_ARGUMENT
107 .Ar elf_section_index ,
111 .It Bq Er DW_DLE_NO_ENTRY
112 There were no more ELF sections to retrieve, or the function was
113 called before a call to
114 .Xr dwarf_transform_to_disk_form 3 .
117 To generate and retrieve ELF section byte streams, use:
118 .Bd -literal -offset indent
120 Dwarf_Signed count, i, sec_index;
125 /* ... Assume that `dbg' refers to a DWARF producer instance,
126 * and that application code has added DWARF debugging
127 * information to the producer instance. ...
129 if ((count = dwarf_transform_to_disk_form(dbg, &de)) ==
131 warnx("dwarf_transform_to_disk_form failed: %s",
136 /* Retrieve section data. */
137 for (i = 0; i < count; i++) {
138 bytes = dwarf_get_section_bytes(dbg, i, &sec_index, &len,
141 warnx("dwarf_get_section_bytes failed: %s",
145 /* ... use the returned byte stream ... */
148 /* Release resources. */
149 dwarf_producer_finish(dbg, &de);
153 .Xr dwarf_reset_section_bytes 3 ,
154 .Xr dwarf_producer_finish 3 ,
155 .Xr dwarf_producer_init 3 ,
156 .Xr dwarf_producer_init_b 3 ,
157 .Xr dwarf_transform_to_disk_form 3