contrib/elftoolchain/libdwarf/dwarf_add_AT_reference.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_add_AT_reference.3 3640 2018-10-14 14:09:13Z jkoshy $
  26 .\"
  27 .Dd September 4, 2011
  28 .Dt DWARF_ADD_AT_REFERENCE 3
  29 .Os
  30 .Sh NAME
  31 .Nm dwarf_add_AT_reference
  32 .Nd create and attach an attribute that references another DIE
  33 .Sh LIBRARY
  34 .Lb libdwarf
  35 .Sh SYNOPSIS
  36 .In libdwarf.h
  37 .Ft "Dwarf_P_Attribute"
  38 .Fo dwarf_add_AT_reference
  39 .Fa "Dwarf_P_Debug dbg"
  40 .Fa "Dwarf_P_Die die"
  41 .Fa "Dwarf_Half attr"
  42 .Fa "Dwarf_P_Die ref_die"
  43 .Fa "Dwarf_Error *err"
  44 .Fc
  45 .Sh DESCRIPTION
  46 Function
  47 .Fn dwarf_add_AT_reference
  48 creates an attribute descriptor that references another debugging
  49 information entry in the same compilation unit.
  50 The attribute will be of DWARF form
  51 .Dv DW_FORM_ref4
  52 or
  53 .Dv DW_FORM_ref8
  54 depending on the target address size, and will contain the
  55 section-relative offset of the referenced debugging information entry
  56 as its value.
  57 .Pp
  58 Argument
  59 .Ar dbg
  60 should reference a DWARF producer instance allocated using
  61 .Xr dwarf_producer_init 3
  62 or
  63 .Xr dwarf_producer_init_b 3 .
  64 .Pp
  65 Argument
  66 .Ar die
  67 should reference a debugging information entry allocated using
  68 .Xr dwarf_new_die 3 .
  69 .Pp
  70 Argument
  71 .Ar attr
  72 should specify the attribute code of the created attribute descriptor.
  73 .Pp
  74 Argument
  75 .Ar ref_die
  76 should hold the debugging information entry descriptor that
  77 the attribute should refer to.
  78 .Pp
  79 If argument
  80 .Ar err
  81 is not NULL, it will be used to store error information in case
  82 of an error.
  83 .Sh RETURN VALUES
  84 On success, function
  85 .Fn dwarf_add_AT_reference
  86 returns the created attribute descriptor.
  87 In case of an error, function
  88 .Fn dwarf_add_AT_reference
  89 returns
  90 .Dv DW_DLV_BADADDR
  91 and sets the argument
  92 .Ar err .
  93 .Sh ERRORS
  94 Function
  95 .Fn dwarf_add_AT_reference
  96 can fail with:
  97 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
  98 .It Bq Er DW_DLE_ARGUMENT
  99 One of the arguments
 100 .Ar dbg ,
 101 .Ar die
 102 or
 103 .Ar ref_die
 104 was NULL.
 105 .It Bq Er DW_DLE_MEMORY
 106 An out of memory condition was encountered during the execution of
 107 the function.
 108 .El
 109 .Sh SEE ALSO
 110 .Xr dwarf 3 ,
 111 .Xr dwarf_add_AT_dataref 3 ,
 112 .Xr dwarf_add_AT_ref_address 3 ,
 113 .Xr dwarf_add_AT_signed_const 3 ,
 114 .Xr dwarf_add_AT_unsigned_const 3 ,
 115 .Xr dwarf_new_die 3 ,
 116 .Xr dwarf_producer_init 3 ,
 117 .Xr dwarf_producer_init_b 3