contrib/elftoolchain/libdwarf/dwarf_add_AT_producer.3

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