xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_set_reloc_application.3 (revision 2de3b87a120614a3b053be7dd845b72f1e9ce804)
1*2de3b87aSKai Wang.\" Copyright (c) 2011 Kai Wang
2*2de3b87aSKai Wang.\" All rights reserved.
3*2de3b87aSKai Wang.\"
4*2de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without
5*2de3b87aSKai Wang.\" modification, are permitted provided that the following conditions
6*2de3b87aSKai Wang.\" are met:
7*2de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright
8*2de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer.
9*2de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright
10*2de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer in the
11*2de3b87aSKai Wang.\"    documentation and/or other materials provided with the distribution.
12*2de3b87aSKai Wang.\"
13*2de3b87aSKai Wang.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14*2de3b87aSKai Wang.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15*2de3b87aSKai Wang.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16*2de3b87aSKai Wang.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17*2de3b87aSKai Wang.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18*2de3b87aSKai Wang.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19*2de3b87aSKai Wang.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20*2de3b87aSKai Wang.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21*2de3b87aSKai Wang.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22*2de3b87aSKai Wang.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23*2de3b87aSKai Wang.\" SUCH DAMAGE.
24*2de3b87aSKai Wang.\"
25*2de3b87aSKai Wang.\" $Id: dwarf_set_reloc_application.3 2075 2011-10-27 03:47:28Z jkoshy $
26*2de3b87aSKai Wang.\"
27*2de3b87aSKai Wang.Dd June 26, 2011
28*2de3b87aSKai Wang.Os
29*2de3b87aSKai Wang.Dt DWARF_SET_RELOC_APPLICATION 3
30*2de3b87aSKai Wang.Sh NAME
31*2de3b87aSKai Wang.Nm dwarf_set_reloc_application
32*2de3b87aSKai Wang.Nd set a library-wide relocation flag
33*2de3b87aSKai Wang.Sh LIBRARY
34*2de3b87aSKai Wang.Lb libdwarf
35*2de3b87aSKai Wang.Sh SYNOPSIS
36*2de3b87aSKai Wang.In libdwarf.h
37*2de3b87aSKai Wang.Ft int
38*2de3b87aSKai Wang.Fo dwarf_set_reloc_application
39*2de3b87aSKai Wang.Fa "int apply"
40*2de3b87aSKai Wang.Fc
41*2de3b87aSKai Wang.Sh DESCRIPTION
42*2de3b87aSKai WangFunction
43*2de3b87aSKai Wang.Fn dwarf_set_reloc_application
44*2de3b87aSKai Wangallows applications to specify how relocation information is to be
45*2de3b87aSKai Wanghandled by the DWARF(3) library.
46*2de3b87aSKai Wang.Pp
47*2de3b87aSKai WangIf the argument
48*2de3b87aSKai Wang.Ar apply
49*2de3b87aSKai Wangholds a non-zero value, the library will process all the relevant
50*2de3b87aSKai Wang.Dq ".rela"
51*2de3b87aSKai Wangrelocation sections and will apply the relocation records found to
52*2de3b87aSKai Wangtheir corresponding DWARF sections.
53*2de3b87aSKai Wang.Pp
54*2de3b87aSKai WangIf the argument
55*2de3b87aSKai Wang.Ar apply
56*2de3b87aSKai Wangis zero, the library will not attempt to apply any relocations.
57*2de3b87aSKai Wang.Pp
58*2de3b87aSKai WangThe default behaviour of the library is to process relocation records.
59*2de3b87aSKai Wang.Sh NOTES
60*2de3b87aSKai WangFunction
61*2de3b87aSKai Wang.Fn dwarf_set_reloc_application
62*2de3b87aSKai Wangshould be called before initialising a dwarf debugging context, i.e,
63*2de3b87aSKai Wangit should be called by the application before calling either of the
64*2de3b87aSKai Wangfunctions
65*2de3b87aSKai Wang.Xr dwarf_init 3
66*2de3b87aSKai Wangor
67*2de3b87aSKai Wang.Xr dwarf_elf_init 3 .
68*2de3b87aSKai Wang.Sh RETURN VALUES
69*2de3b87aSKai WangFunction
70*2de3b87aSKai Wang.Fn dwarf_set_reloc_application
71*2de3b87aSKai Wangreturns the previous value of the library-wide relocation application
72*2de3b87aSKai Wangflag.
73*2de3b87aSKai Wang.Sh ERRORS
74*2de3b87aSKai WangFunction
75*2de3b87aSKai Wang.Fn dwarf_set_reloc_application
76*2de3b87aSKai Wangdoes not return an error.
77*2de3b87aSKai Wang.Sh SEE ALSO
78*2de3b87aSKai Wang.Xr dwarf 3 ,
79*2de3b87aSKai Wang.Xr dwarf_init 3 ,
80*2de3b87aSKai Wang.Xr dwarf_elf_init 3
81