xref: /freebsd-src/contrib/elftoolchain/libdwarf/dwarf_die_link.3 (revision ae500c1ff8974130f7f2692772cf288b90349e0d)
12de3b87aSKai Wang.\" Copyright (c) 2011 Kai Wang
22de3b87aSKai Wang.\" All rights reserved.
32de3b87aSKai Wang.\"
42de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without
52de3b87aSKai Wang.\" modification, are permitted provided that the following conditions
62de3b87aSKai Wang.\" are met:
72de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright
82de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer.
92de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright
102de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer in the
112de3b87aSKai Wang.\"    documentation and/or other materials provided with the distribution.
122de3b87aSKai Wang.\"
132de3b87aSKai Wang.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
142de3b87aSKai Wang.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
152de3b87aSKai Wang.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
162de3b87aSKai Wang.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
172de3b87aSKai Wang.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
182de3b87aSKai Wang.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
192de3b87aSKai Wang.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
202de3b87aSKai Wang.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
212de3b87aSKai Wang.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
222de3b87aSKai Wang.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
232de3b87aSKai Wang.\" SUCH DAMAGE.
242de3b87aSKai Wang.\"
25*ae500c1fSEd Maste.\" $Id: dwarf_die_link.3 3640 2018-10-14 14:09:13Z jkoshy $
262de3b87aSKai Wang.\"
272de3b87aSKai Wang.Dd September 4, 2011
282de3b87aSKai Wang.Dt DWARF_DIE_LINK 3
29*ae500c1fSEd Maste.Os
302de3b87aSKai Wang.Sh NAME
312de3b87aSKai Wang.Nm dwarf_die_link
322de3b87aSKai Wang.Nd link a debugging information entry
332de3b87aSKai Wang.Sh LIBRARY
342de3b87aSKai Wang.Lb libdwarf
352de3b87aSKai Wang.Sh SYNOPSIS
362de3b87aSKai Wang.In libdwarf.h
372de3b87aSKai Wang.Ft Dwarf_P_Die
382de3b87aSKai Wang.Fo dwarf_die_link
392de3b87aSKai Wang.Fa "Dwarf_P_Die die"
402de3b87aSKai Wang.Fa "Dwarf_P_Die parent"
412de3b87aSKai Wang.Fa "Dwarf_P_Die child"
422de3b87aSKai Wang.Fa "Dwarf_P_Die left"
432de3b87aSKai Wang.Fa "Dwarf_P_Die right"
442de3b87aSKai Wang.Fa "Dwarf_Error *err"
452de3b87aSKai Wang.Fc
462de3b87aSKai Wang.Sh DESCRIPTION
472de3b87aSKai WangFunction
482de3b87aSKai Wang.Fn dwarf_die_link
492de3b87aSKai Wanglinks debugging information entries together.
502de3b87aSKai Wang.Pp
512de3b87aSKai WangArgument
522de3b87aSKai Wang.Ar die
532de3b87aSKai Wangshould specify the debugging information entry to be updated.
542de3b87aSKai Wang.Pp
552de3b87aSKai WangArgument
562de3b87aSKai Wang.Ar parent
572de3b87aSKai Wangspecifies the new parent link for the debugging information entry.
582de3b87aSKai Wang.Pp
592de3b87aSKai WangArgument
602de3b87aSKai Wang.Ar child
612de3b87aSKai Wangspecifies the new first child link for the debugging information entry.
622de3b87aSKai Wang.Pp
632de3b87aSKai WangArgument
642de3b87aSKai Wang.Ar left
652de3b87aSKai Wangspecifies the new left sibling link for the debugging information entry.
662de3b87aSKai Wang.Pp
672de3b87aSKai WangArgument
682de3b87aSKai Wang.Ar right
692de3b87aSKai Wangspecifies the new right sibling link for the debugging information entry.
702de3b87aSKai Wang.Pp
712de3b87aSKai WangOnly one of arguments
722de3b87aSKai Wang.Ar parent ,
732de3b87aSKai Wang.Ar child ,
742de3b87aSKai Wang.Ar left
752de3b87aSKai Wangand
762de3b87aSKai Wang.Ar right
772de3b87aSKai Wangis allowed to be non-NULL.
782de3b87aSKai WangExisting links to parent, child, left or right debugging information
792de3b87aSKai Wangentries, if any, will be unlinked before the specified link is
802de3b87aSKai Wangestablished.
812de3b87aSKai Wang.Pp
822de3b87aSKai WangIf argument
832de3b87aSKai Wang.Ar err
842de3b87aSKai Wangis not NULL, it will be used to store error information in case
852de3b87aSKai Wangof an error.
862de3b87aSKai Wang.Sh RETURN VALUES
872de3b87aSKai WangOn success, function
882de3b87aSKai Wang.Fn dwarf_die_link
892de3b87aSKai Wangreturns the debugging information entry provided in argument
902de3b87aSKai Wang.Ar die .
912de3b87aSKai WangIn case of an error, function
922de3b87aSKai Wang.Fn dwarf_die_link
932de3b87aSKai Wangreturns
942de3b87aSKai Wang.Dv DW_DLV_BADADDR
952de3b87aSKai Wangand sets the argument
962de3b87aSKai Wang.Ar err .
972de3b87aSKai Wang.Sh ERRORS
982de3b87aSKai WangThe function
992de3b87aSKai Wang.Fn dwarf_die_link
1002de3b87aSKai Wangcan fail with:
1012de3b87aSKai Wang.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
1022de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT
1032de3b87aSKai WangArgument
1042de3b87aSKai Wang.Ar die
1052de3b87aSKai Wangwas NULL.
1062de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT
1072de3b87aSKai WangMore than one of the arguments
1082de3b87aSKai Wang.Ar parent ,
1092de3b87aSKai Wang.Ar child ,
1102de3b87aSKai Wang.Ar left
1112de3b87aSKai Wangand
1122de3b87aSKai Wang.Ar right
1132de3b87aSKai Wangwere non-NULL.
1142de3b87aSKai Wang.El
1152de3b87aSKai Wang.Sh SEE ALSO
1162de3b87aSKai Wang.Xr dwarf 3 ,
1172de3b87aSKai Wang.Xr dwarf_add_die_to_debug 3 ,
1182de3b87aSKai Wang.Xr dwarf_new_die 3
119