contrib/elftoolchain/libdwarf/dwarf_die_link.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_die_link.3 3640 2018-10-14 14:09:13Z jkoshy $
  26 .\"
  27 .Dd September 4, 2011
  28 .Dt DWARF_DIE_LINK 3
  29 .Os
  30 .Sh NAME
  31 .Nm dwarf_die_link
  32 .Nd link a debugging information entry
  33 .Sh LIBRARY
  34 .Lb libdwarf
  35 .Sh SYNOPSIS
  36 .In libdwarf.h
  37 .Ft Dwarf_P_Die
  38 .Fo dwarf_die_link
  39 .Fa "Dwarf_P_Die die"
  40 .Fa "Dwarf_P_Die parent"
  41 .Fa "Dwarf_P_Die child"
  42 .Fa "Dwarf_P_Die left"
  43 .Fa "Dwarf_P_Die right"
  44 .Fa "Dwarf_Error *err"
  45 .Fc
  46 .Sh DESCRIPTION
  47 Function
  48 .Fn dwarf_die_link
  49 links debugging information entries together.
  50 .Pp
  51 Argument
  52 .Ar die
  53 should specify the debugging information entry to be updated.
  54 .Pp
  55 Argument
  56 .Ar parent
  57 specifies the new parent link for the debugging information entry.
  58 .Pp
  59 Argument
  60 .Ar child
  61 specifies the new first child link for the debugging information entry.
  62 .Pp
  63 Argument
  64 .Ar left
  65 specifies the new left sibling link for the debugging information entry.
  66 .Pp
  67 Argument
  68 .Ar right
  69 specifies the new right sibling link for the debugging information entry.
  70 .Pp
  71 Only one of arguments
  72 .Ar parent ,
  73 .Ar child ,
  74 .Ar left
  75 and
  76 .Ar right
  77 is allowed to be non-NULL.
  78 Existing links to parent, child, left or right debugging information
  79 entries, if any, will be unlinked before the specified link is
  80 established.
  81 .Pp
  82 If argument
  83 .Ar err
  84 is not NULL, it will be used to store error information in case
  85 of an error.
  86 .Sh RETURN VALUES
  87 On success, function
  88 .Fn dwarf_die_link
  89 returns the debugging information entry provided in argument
  90 .Ar die .
  91 In case of an error, function
  92 .Fn dwarf_die_link
  93 returns
  94 .Dv DW_DLV_BADADDR
  95 and sets the argument
  96 .Ar err .
  97 .Sh ERRORS
  98 The function
  99 .Fn dwarf_die_link
 100 can fail with:
 101 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
 102 .It Bq Er DW_DLE_ARGUMENT
 103 Argument
 104 .Ar die
 105 was NULL.
 106 .It Bq Er DW_DLE_ARGUMENT
 107 More than one of the arguments
 108 .Ar parent ,
 109 .Ar child ,
 110 .Ar left
 111 and
 112 .Ar right
 113 were non-NULL.
 114 .El
 115 .Sh SEE ALSO
 116 .Xr dwarf 3 ,
 117 .Xr dwarf_add_die_to_debug 3 ,
 118 .Xr dwarf_new_die 3