contrib/elftoolchain/libdwarf/dwarf_set_reloc_application.3

   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_set_reloc_application.3 3644 2018-10-15 19:55:01Z jkoshy $
  26 .\"
  27 .Dd February 11, 2015
  28 .Dt DWARF_SET_RELOC_APPLICATION 3
  29 .Os
  30 .Sh NAME
  31 .Nm dwarf_set_reloc_application
  32 .Nd set a library-wide relocation flag
  33 .Sh LIBRARY
  34 .Lb libdwarf
  35 .Sh SYNOPSIS
  36 .In libdwarf.h
  37 .Ft int
  38 .Fo dwarf_set_reloc_application
  39 .Fa "int apply"
  40 .Fc
  41 .Sh DESCRIPTION
  42 Function
  43 .Fn dwarf_set_reloc_application
  44 allows applications to specify how relocation information is to be
  45 handled by the DWARF(3) library.
  46 .Pp
  47 If the argument
  48 .Ar apply
  49 holds a non-zero value, the library will process all the relevant
  50 .Dq ".rel"
  51 and
  52 .Dq ".rela"
  53 relocation sections and will apply the relocation records found to
  54 their corresponding DWARF sections.
  55 .Pp
  56 If the argument
  57 .Ar apply
  58 is zero, the library will not attempt to apply any relocations.
  59 .Pp
  60 The default behaviour of the library is to process relocation records.
  61 .Sh NOTES
  62 Function
  63 .Fn dwarf_set_reloc_application
  64 should be called before initialising a dwarf debugging context, i.e,
  65 it should be called by the application before calling either of the
  66 functions
  67 .Xr dwarf_init 3
  68 or
  69 .Xr dwarf_elf_init 3 .
  70 .Sh RETURN VALUES
  71 Function
  72 .Fn dwarf_set_reloc_application
  73 returns the previous value of the library-wide relocation application
  74 flag.
  75 .Sh ERRORS
  76 Function
  77 .Fn dwarf_set_reloc_application
  78 does not return an error.
  79 .Sh SEE ALSO
  80 .Xr dwarf 3 ,
  81 .Xr dwarf_elf_init 3 ,
  82 .Xr dwarf_init 3