1*0a6a1f1dSLionel Sambuc.\" $NetBSD: dwarf_add_die_to_debug.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_add_die_to_debug.3 2938 2013-04-27 05:09:17Z jkoshy 28*0a6a1f1dSLionel Sambuc.\" 29*0a6a1f1dSLionel Sambuc.Dd August 21, 2011 30*0a6a1f1dSLionel Sambuc.Os 31*0a6a1f1dSLionel Sambuc.Dt DWARF_ADD_DIE_TO_DEBUG 3 32*0a6a1f1dSLionel Sambuc.Sh NAME 33*0a6a1f1dSLionel Sambuc.Nm dwarf_add_die_to_debug 34*0a6a1f1dSLionel Sambuc.Nd set the root 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_Unsigned 40*0a6a1f1dSLionel Sambuc.Fo dwarf_add_die_to_debug 41*0a6a1f1dSLionel Sambuc.Fa "Dwarf_P_Debug dbg" 42*0a6a1f1dSLionel Sambuc.Fa "Dwarf_P_Die first_die" 43*0a6a1f1dSLionel Sambuc.Fa "Dwarf_Error *err" 44*0a6a1f1dSLionel Sambuc.Fc 45*0a6a1f1dSLionel Sambuc.Sh DESCRIPTION 46*0a6a1f1dSLionel SambucFunction 47*0a6a1f1dSLionel Sambuc.Fn dwarf_add_die_to_debug 48*0a6a1f1dSLionel Sambucsets the root debugging information entry of a DWARF producer 49*0a6a1f1dSLionel Sambucinstance. 50*0a6a1f1dSLionel SambucAll debugging information entries linked to the root entry will also 51*0a6a1f1dSLionel Sambucbe added to the producer instance. 52*0a6a1f1dSLionel Sambuc.Pp 53*0a6a1f1dSLionel SambucArgument 54*0a6a1f1dSLionel Sambuc.Ar dbg 55*0a6a1f1dSLionel Sambucshould reference a DWARF producer instance allocated using 56*0a6a1f1dSLionel Sambuc.Xr dwarf_producer_init 3 57*0a6a1f1dSLionel Sambucor 58*0a6a1f1dSLionel Sambuc.Xr dwarf_producer_init_b 3 . 59*0a6a1f1dSLionel Sambuc.Pp 60*0a6a1f1dSLionel SambucArgument 61*0a6a1f1dSLionel Sambuc.Ar first_die 62*0a6a1f1dSLionel Sambucshould hold the debugging information entry which will become 63*0a6a1f1dSLionel Sambucthe root DIE. 64*0a6a1f1dSLionel Sambuc.Pp 65*0a6a1f1dSLionel SambucIf argument 66*0a6a1f1dSLionel Sambuc.Ar err 67*0a6a1f1dSLionel Sambucis not NULL, it will be used to store error information in case 68*0a6a1f1dSLionel Sambucof an error. 69*0a6a1f1dSLionel Sambuc.Sh RETURN VALUES 70*0a6a1f1dSLionel SambucOn success, function 71*0a6a1f1dSLionel Sambuc.Fn dwarf_add_die_to_debug 72*0a6a1f1dSLionel Sambucreturns 73*0a6a1f1dSLionel Sambuc.Dv DW_DLV_OK . 74*0a6a1f1dSLionel SambucIn case of an error, function 75*0a6a1f1dSLionel Sambuc.Fn dwarf_add_die_to_debug 76*0a6a1f1dSLionel Sambucreturns 77*0a6a1f1dSLionel Sambuc.Dv DW_DLV_NOCOUNT 78*0a6a1f1dSLionel Sambucand sets the argument 79*0a6a1f1dSLionel Sambuc.Ar err . 80*0a6a1f1dSLionel Sambuc.Sh ERRORS 81*0a6a1f1dSLionel SambucFunction 82*0a6a1f1dSLionel Sambuc.Fn dwarf_add_die_to_debug 83*0a6a1f1dSLionel Sambuccan fail with: 84*0a6a1f1dSLionel Sambuc.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 85*0a6a1f1dSLionel Sambuc.It Bq Er DW_DLE_ARGUMENT 86*0a6a1f1dSLionel SambucEither of the arguments 87*0a6a1f1dSLionel Sambuc.Ar dbg 88*0a6a1f1dSLionel Sambucor 89*0a6a1f1dSLionel Sambuc.Ar first_die 90*0a6a1f1dSLionel Sambucwas NULL. 91*0a6a1f1dSLionel Sambuc.El 92*0a6a1f1dSLionel Sambuc.Sh SEE ALSO 93*0a6a1f1dSLionel Sambuc.Xr dwarf 3 , 94*0a6a1f1dSLionel Sambuc.Xr dwarf_die_link 3 , 95*0a6a1f1dSLionel Sambuc.Xr dwarf_new_die 3 , 96*0a6a1f1dSLionel Sambuc.Xr dwarf_producer_init 3 , 97*0a6a1f1dSLionel Sambuc.Xr dwarf_producer_init_b 3 98