external/bsd/elftoolchain/dist/libdwarf/dwarf_add_AT_dataref.3

   1 .\"     $NetBSD: dwarf_add_AT_dataref.3,v 1.2 2014/03/09 16:58:03 christos Exp $
   2 .\"
   3 .\" Copyright (c) 2011 Kai Wang
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" Id: dwarf_add_AT_dataref.3 2072 2011-10-27 03:26:49Z jkoshy
  28 .\"
  29 .Dd September 4, 2011
  30 .Os
  31 .Dt DWARF_ADD_AT_DATAREF 3
  32 .Sh NAME
  33 .Nm dwarf_add_AT_dataref
  34 .Nd create an attribute descriptor for a relocatable address
  35 .Sh LIBRARY
  36 .Lb libdwarf
  37 .Sh SYNOPSIS
  38 .In libdwarf.h
  39 .Ft "Dwarf_P_Attribute"
  40 .Fo dwarf_add_AT_dataref
  41 .Fa "Dwarf_P_Debug dbg"
  42 .Fa "Dwarf_P_Die die"
  43 .Fa "Dwarf_Half attr"
  44 .Fa "Dwarf_Unsigned pc_value"
  45 .Fa "Dwarf_Unsigned sym_index"
  46 .Fa "Dwarf_Error *err"
  47 .Fc
  48 .Sh DESCRIPTION
  49 Function
  50 .Fn dwarf_add_AT_dataref
  51 creates an attribute descriptor for a relocatable address and attaches
  52 it to the debugging information entry referenced by argument
  53 .Ar die .
  54 .Pp
  55 If flag
  56 .Dv DW_DLC_SIZE_64
  57 is set, the address value will be 8 bytes in size and of the DWARF form
  58 .Dv DW_FORM_data8 .
  59 Otherwise, the address value will be 4 bytes in size and of the DWARF form
  60 .Dv DW_FORM_data4 .
  61 .Pp
  62 Argument
  63 .Ar dbg
  64 should reference a DWARF producer instance allocated using
  65 .Xr dwarf_producer_init 3
  66 or
  67 .Xr dwarf_producer_init_b 3 .
  68 .Pp
  69 Argument
  70 .Ar die
  71 should reference a debugging information entry allocated using
  72 .Xr dwarf_new_die 3 .
  73 .Pp
  74 Argument
  75 .Ar attr
  76 specifies the attribute code of the created attribute descriptor.
  77 .Pp
  78 Argument
  79 .Ar pc_value
  80 specifies the value of the relocatable address.
  81 .Pp
  82 Argument
  83 .Ar sym_index
  84 specifies the ELF symbol index of the symbol to be used for
  85 relocation.
  86 .Pp
  87 If argument
  88 .Ar err
  89 is not NULL, it will be used to store error information in case
  90 of an error.
  91 .Sh RETURN VALUES
  92 On success, function
  93 .Fn dwarf_add_AT_dataref
  94 returns the created attribute descriptor.
  95 In case of an error, function
  96 .Fn dwarf_add_AT_dataref
  97 returns
  98 .Dv DW_DLV_BADADDR
  99 and sets the argument
 100 .Ar err .
 101 .Sh ERRORS
 102 Function
 103 .Fn dwarf_add_AT_dataref
 104 can fail with:
 105 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
 106 .It Bq Er DW_DLE_ARGUMENT
 107 Either of the arguments
 108 .Ar dbg
 109 or
 110 .Ar die
 111 was NULL.
 112 .It Bq Er DW_DLE_MEMORY
 113 An out of memory condition was encountered during the execution of the
 114 function.
 115 .El
 116 .Sh SEE ALSO
 117 .Xr dwarf 3 ,
 118 .Xr dwarf_add_AT_reference 3 ,
 119 .Xr dwarf_add_AT_ref_address 3 ,
 120 .Xr dwarf_add_AT_signed_const 3 ,
 121 .Xr dwarf_add_AT_unsigned_const 3 ,
 122 .Xr dwarf_new_die 3 ,
 123 .Xr dwarf_producer_init 3 ,
 124 .Xr dwarf_producer_init_b 3