1*0a6a1f1dSLionel Sambuc.\" $NetBSD: dwarf_die_link.3,v 1.2 2014/03/09 16:58:03 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_die_link.3 2073 2011-10-27 03:30:47Z jkoshy 28*0a6a1f1dSLionel Sambuc.\" 29*0a6a1f1dSLionel Sambuc.Dd September 4, 2011 30*0a6a1f1dSLionel Sambuc.Os 31*0a6a1f1dSLionel Sambuc.Dt DWARF_DIE_LINK 3 32*0a6a1f1dSLionel Sambuc.Sh NAME 33*0a6a1f1dSLionel Sambuc.Nm dwarf_die_link 34*0a6a1f1dSLionel Sambuc.Nd link a debugging information entry 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 Dwarf_P_Die 40*0a6a1f1dSLionel Sambuc.Fo dwarf_die_link 41*0a6a1f1dSLionel Sambuc.Fa "Dwarf_P_Die die" 42*0a6a1f1dSLionel Sambuc.Fa "Dwarf_P_Die parent" 43*0a6a1f1dSLionel Sambuc.Fa "Dwarf_P_Die child" 44*0a6a1f1dSLionel Sambuc.Fa "Dwarf_P_Die left" 45*0a6a1f1dSLionel Sambuc.Fa "Dwarf_P_Die right" 46*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Error *err" 47*0a6a1f1dSLionel Sambuc.Fc 48*0a6a1f1dSLionel Sambuc.Sh DESCRIPTION 49*0a6a1f1dSLionel SambucFunction 50*0a6a1f1dSLionel Sambuc.Fn dwarf_die_link 51*0a6a1f1dSLionel Sambuclinks debugging information entries together. 52*0a6a1f1dSLionel Sambuc.Pp 53*0a6a1f1dSLionel SambucArgument 54*0a6a1f1dSLionel Sambuc.Ar die 55*0a6a1f1dSLionel Sambucshould specify the debugging information entry to be updated. 56*0a6a1f1dSLionel Sambuc.Pp 57*0a6a1f1dSLionel SambucArgument 58*0a6a1f1dSLionel Sambuc.Ar parent 59*0a6a1f1dSLionel Sambucspecifies the new parent link for the debugging information entry. 60*0a6a1f1dSLionel Sambuc.Pp 61*0a6a1f1dSLionel SambucArgument 62*0a6a1f1dSLionel Sambuc.Ar child 63*0a6a1f1dSLionel Sambucspecifies the new first child link for the debugging information entry. 64*0a6a1f1dSLionel Sambuc.Pp 65*0a6a1f1dSLionel SambucArgument 66*0a6a1f1dSLionel Sambuc.Ar left 67*0a6a1f1dSLionel Sambucspecifies the new left sibling link for the debugging information entry. 68*0a6a1f1dSLionel Sambuc.Pp 69*0a6a1f1dSLionel SambucArgument 70*0a6a1f1dSLionel Sambuc.Ar right 71*0a6a1f1dSLionel Sambucspecifies the new right sibling link for the debugging information entry. 72*0a6a1f1dSLionel Sambuc.Pp 73*0a6a1f1dSLionel SambucOnly one of arguments 74*0a6a1f1dSLionel Sambuc.Ar parent , 75*0a6a1f1dSLionel Sambuc.Ar child , 76*0a6a1f1dSLionel Sambuc.Ar left 77*0a6a1f1dSLionel Sambucand 78*0a6a1f1dSLionel Sambuc.Ar right 79*0a6a1f1dSLionel Sambucis allowed to be non-NULL. 80*0a6a1f1dSLionel SambucExisting links to parent, child, left or right debugging information 81*0a6a1f1dSLionel Sambucentries, if any, will be unlinked before the specified link is 82*0a6a1f1dSLionel Sambucestablished. 83*0a6a1f1dSLionel Sambuc.Pp 84*0a6a1f1dSLionel SambucIf argument 85*0a6a1f1dSLionel Sambuc.Ar err 86*0a6a1f1dSLionel Sambucis not NULL, it will be used to store error information in case 87*0a6a1f1dSLionel Sambucof an error. 88*0a6a1f1dSLionel Sambuc.Sh RETURN VALUES 89*0a6a1f1dSLionel SambucOn success, function 90*0a6a1f1dSLionel Sambuc.Fn dwarf_die_link 91*0a6a1f1dSLionel Sambucreturns the debugging information entry provided in argument 92*0a6a1f1dSLionel Sambuc.Ar die . 93*0a6a1f1dSLionel SambucIn case of an error, function 94*0a6a1f1dSLionel Sambuc.Fn dwarf_die_link 95*0a6a1f1dSLionel Sambucreturns 96*0a6a1f1dSLionel Sambuc.Dv DW_DLV_BADADDR 97*0a6a1f1dSLionel Sambucand sets the argument 98*0a6a1f1dSLionel Sambuc.Ar err . 99*0a6a1f1dSLionel Sambuc.Sh ERRORS 100*0a6a1f1dSLionel SambucThe function 101*0a6a1f1dSLionel Sambuc.Fn dwarf_die_link 102*0a6a1f1dSLionel Sambuccan fail with: 103*0a6a1f1dSLionel Sambuc.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 104*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_ARGUMENT 105*0a6a1f1dSLionel SambucArgument 106*0a6a1f1dSLionel Sambuc.Ar die 107*0a6a1f1dSLionel Sambucwas NULL. 108*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_ARGUMENT 109*0a6a1f1dSLionel SambucMore than one of the arguments 110*0a6a1f1dSLionel Sambuc.Ar parent , 111*0a6a1f1dSLionel Sambuc.Ar child , 112*0a6a1f1dSLionel Sambuc.Ar left 113*0a6a1f1dSLionel Sambucand 114*0a6a1f1dSLionel Sambuc.Ar right 115*0a6a1f1dSLionel Sambucwere non-NULL. 116*0a6a1f1dSLionel Sambuc.El 117*0a6a1f1dSLionel Sambuc.Sh SEE ALSO 118*0a6a1f1dSLionel Sambuc.Xr dwarf 3 , 119*0a6a1f1dSLionel Sambuc.Xr dwarf_add_die_to_debug 3 , 120*0a6a1f1dSLionel Sambuc.Xr dwarf_new_die 3 121