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

   1 .\"     $NetBSD: dwarf_formexprloc.3,v 1.2 2014/03/09 16:58:03 christos Exp $
   2 .\"
   3 .\" Copyright (c) 2010 Joseph Koshy
   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_formexprloc.3 2073 2011-10-27 03:30:47Z jkoshy
  28 .\"
  29 .Dd July 25, 2010
  30 .Os
  31 .Dt DWARF_FORMEXPRLOC 3
  32 .Sh NAME
  33 .Nm dwarf_formexprloc
  34 .Nd return information about a location expression
  35 .Sh LIBRARY
  36 .Lb libdwarf
  37 .Sh SYNOPSIS
  38 .In libdwarf.h
  39 .Ft int
  40 .Fo dwarf_formexprloc
  41 .Fa "Dwarf_Attribute attr"
  42 .Fa "Dwarf_Unsigned *retlen"
  43 .Fa "Dwarf_Ptr *retexpr"
  44 .Fa "Dwarf_Error *err"
  45 .Fc
  46 .Sh DESCRIPTION
  47 Function
  48 .Fn dwarf_formexprloc
  49 allows an application to retrieve the length and the bytes of a
  50 DWARF location expression.
  51 .Pp
  52 Argument
  53 .Ar attr
  54 should reference a DWARF attribute of the form
  55 .Dv DW_FORM_exprloc .
  56 Argument
  57 .Ar retlen
  58 should point to a location that will be set to the length of the
  59 location expression.
  60 Argument
  61 .Ar retexpr
  62 should point to a location that will be set to a pointer to the
  63 content of the location expression itself.
  64 .Pp
  65 If argument
  66 .Ar err
  67 is not NULL, it will be used to return an error descriptor in case
  68 of an error.
  69 .Ss Memory Management
  70 The application should not attempt to free the memory
  71 area referenced by the pointer returned in argument
  72 .Ar retexpr .
  73 .Sh RETURN VALUES
  74 Function
  75 .Fn dwarf_formexprloc
  76 returns
  77 .Dv DW_DLV_OK
  78 on success.
  79 In case of an error, it returns
  80 .Dv DW_DLV_ERROR
  81 and sets argument
  82 .Ar err .
  83 .Sh ERRORS
  84 Function
  85 .Fn dwarf_formexprloc
  86 may fail with the following errors:
  87 .Bl -tag -width ".Bq Er DW_DLE_ATTR_FORM_BAD"
  88 .It Bq Er DW_DLE_ARGUMENT
  89 One of arguments
  90 .Ar attr ,
  91 .Ar retlen
  92 or
  93 .Ar retexpr
  94 was NULL.
  95 .It Bq Er DW_DLE_ATTR_FORM_BAD
  96 The attribute referenced by argument
  97 .Ar attr
  98 was not of form
  99 .Dv DW_FORM_exprloc .
 100 .El
 101 .Sh SEE ALSO
 102 .Xr dwarf 3 ,
 103 .Xr dwarf_attr 3 ,
 104 .Xr dwarf_formblock 3 ,
 105 .Xr dwarf_formflag 3 ,
 106 .Xr dwarf_formref 3 ,
 107 .Xr dwarf_formsdata 3 ,
 108 .Xr dwarf_formsig8 3 ,
 109 .Xr dwarf_formstring 3 ,
 110 .Xr dwarf_formudata 3 ,
 111 .Xr dwarf_hasattr 3