xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_set_reloc_application.3 (revision d133198b4b7cd74205157bacef0eeb5c17508491)
12de3b87aSKai Wang.\" Copyright (c) 2011 Kai Wang
22de3b87aSKai Wang.\" All rights reserved.
32de3b87aSKai Wang.\"
42de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without
52de3b87aSKai Wang.\" modification, are permitted provided that the following conditions
62de3b87aSKai Wang.\" are met:
72de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright
82de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer.
92de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright
102de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer in the
112de3b87aSKai Wang.\"    documentation and/or other materials provided with the distribution.
122de3b87aSKai Wang.\"
132de3b87aSKai Wang.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
142de3b87aSKai Wang.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
152de3b87aSKai Wang.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
162de3b87aSKai Wang.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
172de3b87aSKai Wang.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
182de3b87aSKai Wang.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
192de3b87aSKai Wang.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
202de3b87aSKai Wang.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
212de3b87aSKai Wang.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
222de3b87aSKai Wang.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
232de3b87aSKai Wang.\" SUCH DAMAGE.
242de3b87aSKai Wang.\"
252de3b87aSKai Wang.\" $Id: dwarf_set_reloc_application.3 2075 2011-10-27 03:47:28Z jkoshy $
262de3b87aSKai Wang.\"
27*d133198bSEd Maste.Dd February 11, 2015
282de3b87aSKai Wang.Os
292de3b87aSKai Wang.Dt DWARF_SET_RELOC_APPLICATION 3
302de3b87aSKai Wang.Sh NAME
312de3b87aSKai Wang.Nm dwarf_set_reloc_application
322de3b87aSKai Wang.Nd set a library-wide relocation flag
332de3b87aSKai Wang.Sh LIBRARY
342de3b87aSKai Wang.Lb libdwarf
352de3b87aSKai Wang.Sh SYNOPSIS
362de3b87aSKai Wang.In libdwarf.h
372de3b87aSKai Wang.Ft int
382de3b87aSKai Wang.Fo dwarf_set_reloc_application
392de3b87aSKai Wang.Fa "int apply"
402de3b87aSKai Wang.Fc
412de3b87aSKai Wang.Sh DESCRIPTION
422de3b87aSKai WangFunction
432de3b87aSKai Wang.Fn dwarf_set_reloc_application
442de3b87aSKai Wangallows applications to specify how relocation information is to be
452de3b87aSKai Wanghandled by the DWARF(3) library.
462de3b87aSKai Wang.Pp
472de3b87aSKai WangIf the argument
482de3b87aSKai Wang.Ar apply
492de3b87aSKai Wangholds a non-zero value, the library will process all the relevant
50*d133198bSEd Maste.Dq ".rel"
51*d133198bSEd Masteand
522de3b87aSKai Wang.Dq ".rela"
532de3b87aSKai Wangrelocation sections and will apply the relocation records found to
542de3b87aSKai Wangtheir corresponding DWARF sections.
552de3b87aSKai Wang.Pp
562de3b87aSKai WangIf the argument
572de3b87aSKai Wang.Ar apply
582de3b87aSKai Wangis zero, the library will not attempt to apply any relocations.
592de3b87aSKai Wang.Pp
602de3b87aSKai WangThe default behaviour of the library is to process relocation records.
612de3b87aSKai Wang.Sh NOTES
622de3b87aSKai WangFunction
632de3b87aSKai Wang.Fn dwarf_set_reloc_application
642de3b87aSKai Wangshould be called before initialising a dwarf debugging context, i.e,
652de3b87aSKai Wangit should be called by the application before calling either of the
662de3b87aSKai Wangfunctions
672de3b87aSKai Wang.Xr dwarf_init 3
682de3b87aSKai Wangor
692de3b87aSKai Wang.Xr dwarf_elf_init 3 .
702de3b87aSKai Wang.Sh RETURN VALUES
712de3b87aSKai WangFunction
722de3b87aSKai Wang.Fn dwarf_set_reloc_application
732de3b87aSKai Wangreturns the previous value of the library-wide relocation application
742de3b87aSKai Wangflag.
752de3b87aSKai Wang.Sh ERRORS
762de3b87aSKai WangFunction
772de3b87aSKai Wang.Fn dwarf_set_reloc_application
782de3b87aSKai Wangdoes not return an error.
792de3b87aSKai Wang.Sh SEE ALSO
802de3b87aSKai Wang.Xr dwarf 3 ,
812de3b87aSKai Wang.Xr dwarf_init 3 ,
822de3b87aSKai Wang.Xr dwarf_elf_init 3
83