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

   1 .\"     $NetBSD: dwarf_new_fde.3,v 1.2 2014/03/09 16:58:04 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_new_fde.3 2074 2011-10-27 03:34:33Z jkoshy
  28 .\"
  29 .Dd September 24, 2011
  30 .Os
  31 .Dt DWARF_NEW_FDE 3
  32 .Sh NAME
  33 .Nm dwarf_new_fde
  34 .Nd allocate a DWARF frame descriptor
  35 .Sh LIBRARY
  36 .Lb libdwarf
  37 .Sh SYNOPSIS
  38 .In libdwarf.h
  39 .Ft "Dwarf_P_Fde"
  40 .Fo dwarf_new_fde
  41 .Fa "Dwarf_P_Debug dbg"
  42 .Fa "Dwarf_Error *err"
  43 .Fc
  44 .Sh DESCRIPTION
  45 Function
  46 .Fn dwarf_new_fde
  47 allocates a new DWARF frame descriptor.
  48 .Pp
  49 Argument
  50 .Ar dbg
  51 should reference a DWARF producer instance allocated using
  52 .Xr dwarf_producer_init 3
  53 or
  54 .Xr dwarf_producer_init_b 3 .
  55 .Pp
  56 If argument
  57 .Ar err
  58 is not NULL, it will be used to store error information in case of an
  59 error.
  60 .Sh RETURN VALUES
  61 On success, function
  62 .Fn dwarf_new_fde
  63 returns the newly created frame descriptor.
  64 In case of an error, function
  65 .Fn dwarf_new_fde
  66 returns
  67 .Dv DW_DLV_BADADDR
  68 and sets the argument
  69 .Ar err .
  70 .Sh ERRORS
  71 Function
  72 .Fn dwarf_new_fde
  73 can fail with:
  74 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
  75 .It Bq Er DW_DLE_ARGUMENT
  76 Argument
  77 .Ar dbg
  78 was NULL.
  79 .It Bq Er DW_DLE_MEMORY
  80 An out of memory condition was encountered during the execution of the
  81 function.
  82 .El
  83 .Sh SEE ALSO
  84 .Xr dwarf 3 ,
  85 .Xr dwarf_add_fde_inst 3 ,
  86 .Xr dwarf_add_frame_fde 3 ,
  87 .Xr dwarf_add_frame_fde_b 3 ,
  88 .Xr dwarf_add_frame_cie 3 ,
  89 .Xr dwarf_fde_cfa_offset 3