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