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_vendor_ext.3 3640 2018-10-14 14:09:13Z jkoshy $ 26.\" 27.Dd September 25, 2011 28.Dt DWARF_VENDOR_EXT 3 29.Os 30.Sh NAME 31.Nm dwarf_vendor_ext 32.Nd add vendor-specific macro information to a DWARF producer instance 33.Sh LIBRARY 34.Lb libdwarf 35.Sh SYNOPSIS 36.In libdwarf.h 37.Ft "int" 38.Fo dwarf_vendor_ext 39.Fa "Dwarf_P_Debug dbg" 40.Fa "Dwarf_Unsigned constant" 41.Fa "char *string" 42.Fa "Dwarf_Error *err" 43.Fc 44.Sh DESCRIPTION 45Function 46.Fn dwarf_vendor_ext 47adds a vendor-specific macro information entry to a DWARF producer 48instance. 49.Pp 50Argument 51.Ar dbg 52should reference a DWARF producer instance allocated using 53.Xr dwarf_producer_init 3 54or 55.Xr dwarf_producer_init_b 3 . 56.Pp 57Argument 58.Ar constant 59specifies a constant value for the macro information entry. 60.Pp 61Argument 62.Ar string 63point to a NUL-terminated string containing the string value 64for the macro information entry. 65.Pp 66If argument 67.Ar err 68is not NULL, it will be used to store error information in case of an 69error. 70.Pp 71The meaning of the arguments 72.Ar constant 73and 74.Ar string 75are not defined by the DWARF specification, but are instead governed 76by application and vendor conventions. 77.Sh RETURN VALUES 78On success, function 79.Fn dwarf_vendor_ext 80returns 81.Dv DW_DLV_OK . 82In case of an error, function 83.Fn dwarf_vendor_ext 84returns 85.Dv DW_DLV_ERROR 86and sets the argument 87.Ar err . 88.Sh ERRORS 89Function 90.Fn dwarf_vendor_ext 91can fail with: 92.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 93.It Bq Er DW_DLE_ARGUMENT 94Either arguments 95.Ar dbg 96or 97.Ar string 98was NULL. 99.It Bq Er DW_DLE_MEMORY 100An out of memory condition was encountered during the execution of the 101function. 102.El 103.Sh SEE ALSO 104.Xr dwarf 3 , 105.Xr dwarf_def_macro 3 , 106.Xr dwarf_end_macro_file 3 , 107.Xr dwarf_producer_init 3 , 108.Xr dwarf_producer_init_b 3 , 109.Xr dwarf_start_macro_file 3 , 110.Xr dwarf_undef_macro 3 111