1.\" $NetBSD: dwarf_add_die_to_debug.3,v 1.6 2024/03/03 17:37:30 christos Exp $ 2.\" 3.\" Copyright (c) 2011 Kai Wang 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25.\" SUCH DAMAGE. 26.\" 27.\" Id: dwarf_add_die_to_debug.3 3961 2022-03-12 15:13:22Z jkoshy 28.\" 29.Dd August 21, 2011 30.Dt DWARF_ADD_DIE_TO_DEBUG 3 31.Os 32.Sh NAME 33.Nm dwarf_add_die_to_debug 34.Nd set the root debugging information entry 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft Dwarf_Unsigned 40.Fo dwarf_add_die_to_debug 41.Fa "Dwarf_P_Debug dbg" 42.Fa "Dwarf_P_Die first_die" 43.Fa "Dwarf_Error *err" 44.Fc 45.Sh DESCRIPTION 46Function 47.Fn dwarf_add_die_to_debug 48sets the root debugging information entry of a DWARF producer 49instance. 50All debugging information entries linked to the root entry will also 51be added to the producer instance. 52.Pp 53Argument 54.Fa dbg 55should reference a DWARF producer instance allocated using 56.Xr dwarf_producer_init 3 57or 58.Xr dwarf_producer_init_b 3 . 59.Pp 60Argument 61.Fa first_die 62should hold the debugging information entry which will become 63the root DIE. 64.Pp 65If argument 66.Fa err 67is not 68.Dv NULL , 69it will be used to store error information in case of an error. 70.Sh RETURN VALUES 71On success, function 72.Fn dwarf_add_die_to_debug 73returns 74.Dv DW_DLV_OK . 75In case of an error, function 76.Fn dwarf_add_die_to_debug 77returns 78.Dv DW_DLV_NOCOUNT 79and sets the argument 80.Fa err . 81.Sh ERRORS 82Function 83.Fn dwarf_add_die_to_debug 84can fail with: 85.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 86.It Bq Er DW_DLE_ARGUMENT 87Either of the arguments 88.Fa dbg 89or 90.Fa first_die 91was 92.Dv NULL . 93.El 94.Sh SEE ALSO 95.Xr dwarf 3 , 96.Xr dwarf_die_link 3 , 97.Xr dwarf_new_die 3 , 98.Xr dwarf_producer_init 3 , 99.Xr dwarf_producer_init_b 3 100