contrib/elftoolchain/libdwarf/dwarf_add_frame_cie.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_frame_cie.3 3640 2018-10-14 14:09:13Z jkoshy $
  26 .\"
  27 .Dd September 26, 2011
  28 .Dt DWARF_ADD_FRAME_CIE 3
  29 .Os
  30 .Sh NAME
  31 .Nm dwarf_add_frame_cie
  32 .Nd add a call frame common information entry to a DWARF producer instance
  33 .Sh LIBRARY
  34 .Lb libdwarf
  35 .Sh SYNOPSIS
  36 .In libdwarf.h
  37 .Ft "Dwarf_Unsigned"
  38 .Fo dwarf_add_frame_cie
  39 .Fa "Dwarf_P_Debug dbg"
  40 .Fa "char *augmenter"
  41 .Fa "Dwarf_Small caf"
  42 .Fa "Dwarf_Small daf"
  43 .Fa "Dwarf_Small ra"
  44 .Fa "Dwarf_Ptr initinst"
  45 .Fa "Dwarf_Unsigned initlen"
  46 .Fa "Dwarf_Error *err"
  47 .Fc
  48 .Sh DESCRIPTION
  49 Function
  50 .Fn dwarf_add_frame_cie
  51 adds a DWARF call frame common information entry (CIE) to a producer
  52 instance.
  53 .Pp
  54 Argument
  55 .Ar dbg
  56 should reference a DWARF producer instance allocated using
  57 .Xr dwarf_producer_init 3
  58 or
  59 .Xr dwarf_producer_init_b 3 .
  60 .Pp
  61 Argument
  62 .Ar augmenter
  63 should point to a NUL-terminated augmentation string for the common
  64 information entry.
  65 .Pp
  66 Argument
  67 .Ar caf
  68 specifies the code alignment factor.
  69 .Pp
  70 Argument
  71 .Ar daf
  72 specifies the data alignment factor.
  73 .Pp
  74 Argument
  75 .Ar ra
  76 specifies the column number used for the return address register.
  77 .Pp
  78 Argument
  79 .Ar initinst
  80 should point to a byte stream containing the initial instructions
  81 for the common information entry.
  82 .Pp
  83 Argument
  84 .Ar initlen
  85 should hold the length in bytes of the byte stream pointed to by
  86 argument
  87 .Ar initinst .
  88 .Pp
  89 If argument
  90 .Ar err
  91 is not NULL, it will be used to store error information in case of an
  92 error.
  93 .Sh RETURN VALUES
  94 On success, function
  95 .Fn dwarf_add_frame_cie
  96 returns the index value of the created common information entry.
  97 In case of an error, function
  98 .Fn dwarf_add_frame_cie
  99 returns
 100 .Dv DW_DLV_NOCOUNT
 101 and sets the argument
 102 .Ar err .
 103 .Sh ERRORS
 104 Function
 105 .Fn dwarf_add_frame_cie
 106 can fail with:
 107 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
 108 .It Bq Er DW_DLE_ARGUMENT
 109 Argument
 110 .Ar dbg
 111 was NULL.
 112 .It Bq Er DW_DLE_MEMORY
 113 An out of memory condition was encountered during the execution of the
 114 function.
 115 .El
 116 .Sh SEE ALSO
 117 .Xr dwarf 3 ,
 118 .Xr dwarf_add_fde_inst 3 ,
 119 .Xr dwarf_add_frame_fde 3 ,
 120 .Xr dwarf_add_frame_fde_b 3 ,
 121 .Xr dwarf_fde_cfa_offset 3 ,
 122 .Xr dwarf_new_fde 3 ,
 123 .Xr dwarf_producer_init 3 ,
 124 .Xr dwarf_producer_init_b 3