1.\" $NetBSD: dwarf_add_AT_comp_dir.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_AT_comp_dir.3 3961 2022-03-12 15:13:22Z jkoshy 28.\" 29.Dd September 4, 2011 30.Dt DWARF_ADD_AT_COMP_DIR 3 31.Os 32.Sh NAME 33.Nm dwarf_add_AT_comp_dir 34.Nd create and attach a DW_AT_comp_dir attribute 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft Dwarf_P_Attribute 40.Fo dwarf_add_AT_comp_dir 41.Fa "Dwarf_P_Die die" 42.Fa "char *dir" 43.Fa "Dwarf_Error *err" 44.Fc 45.Sh DESCRIPTION 46Function 47.Fn dwarf_add_AT_comp_dir 48creates a 49.Dv DW_AT_comp_dir 50attribute descriptor and attaches it to the debugging information 51entry referenced by argument 52.Fa die . 53The created attribute will have DWARF form 54.Dv DW_FORM_strp . 55.Pp 56Argument 57.Fa die 58should reference a debugging information entry allocated using 59.Xr dwarf_new_die 3 . 60.Pp 61Argument 62.Fa dir 63should point to a NUL-terminated string which will become the value of 64the created attribute. 65.Pp 66If argument 67.Fa err 68is not 69.Dv NULL , 70it will be used to store error information in case of an error. 71.Sh RETURN VALUES 72On success, function 73.Fn dwarf_add_AT_comp_dir 74returns the created attribute descriptor. 75In case of an error, function 76.Fn dwarf_add_AT_comp_dir 77returns 78.Dv DW_DLV_BADADDR 79and sets the argument 80.Fa err . 81.Sh ERRORS 82Function 83.Fn dwarf_add_AT_comp_dir 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 die 89or 90.Fa dir 91was 92.Dv NULL . 93.It Bq Er DW_DLE_MEMORY 94An out of memory condition was encountered during the execution of the 95function. 96.El 97.Sh SEE ALSO 98.Xr dwarf 3 , 99.Xr dwarf_add_AT_const_value_string 3 , 100.Xr dwarf_add_AT_name 3 , 101.Xr dwarf_add_AT_producer 3 , 102.Xr dwarf_add_AT_string 3 , 103.Xr dwarf_new_die 3 104