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_transform_to_disk_form.3 3640 2018-10-14 14:09:13Z jkoshy $
26.\"
27.Dd August 25, 2011
28.Dt DWARF_TRANSFORM_TO_DISK_FORM 3
29.Os
30.Sh NAME
31.Nm dwarf_transform_to_disk_form
32.Nd transform DWARF information into byte streams
33.Sh LIBRARY
34.Lb libdwarf
35.Sh SYNOPSIS
36.In libdwarf.h
37.Ft Dwarf_Signed
38.Fo dwarf_transform_to_disk_form
39.Fa "Dwarf_P_Debug dbg"
40.Fa "Dwarf_Error *err"
41.Fc
42.Sh DESCRIPTION
43Function
44.Fn dwarf_transform_to_disk_form
45transforms the DWARF information gathered by the producer into
46byte streams for the application to write out as ELF sections.
47If the flag
48.Dv DW_DLC_SYMBOLIC_RELOCATIONS
49is set on the producer, the function will also generate the associated
50relocation arrays.
51.Pp
52Argument
53.Ar dbg
54should reference a DWARF producer instance allocated using
55.Xr dwarf_producer_init 3
56or
57.Xr dwarf_producer_init_b 3 .
58.Pp
59If argument
60.Ar err
61is not NULL, it will be used to store error information in case
62of an error.
63.Pp
64After a call to this function, the application can call the function
65.Xr dwarf_get_section_bytes 3
66to retrieve the byte streams for each ELF section.
67If the flag
68.Dv DW_DLC_SYMBOLIC_RELOCATIONS
69was set on the descriptor, the application can also call the function
70.Xr dwarf_get_relocation_info 3
71to retrieve the generated relocation arrays.
72.Sh RETURN VALUES
73On success, function
74.Fn dwarf_transform_to_disk_form
75returns the total number of ELF sections generated.
76In case of an error, function
77.Fn dwarf_transform_to_disk_form
78returns
79.Dv DW_DLV_NOCOUNT
80and sets the argument
81.Ar err .
82.Sh ERRORS
83Function
84.Fn dwarf_transform_to_disk_form
85can fail with:
86.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
87.It Bq Er DW_DLE_ARGUMENT
88Argument
89.Ar dbg
90was NULL.
91.It Bq Er DW_DLE_MEMORY
92An out of memory condition was encountered during execution.
93.El
94.Sh SEE ALSO
95.Xr dwarf 3 ,
96.Xr dwarf_get_relocation_info 3 ,
97.Xr dwarf_get_section_bytes 3 ,
98.Xr dwarf_producer_init 3 ,
99.Xr dwarf_producer_init_b 3
100