external/bsd/elftoolchain/dist/libdwarf/dwarf_add_frame_cie.3

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