contrib/elftoolchain/libdwarf/dwarf_get_cu_die_offset.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_get_cu_die_offset.3 2071 2011-10-27 03:20:00Z jkoshy $
  26 .\"
  27 .Dd April 10, 2011
  28 .Os
  29 .Dt DWARF_GET_CU_DIE_OFFSET 3
  30 .Sh NAME
  31 .Nm dwarf_get_arange_cu_header_offset ,
  32 .Nm dwarf_get_cu_die_offset
  33 .Nd retrieve compilation unit offsets
  34 .Sh LIBRARY
  35 .Lb libdwarf
  36 .Sh SYNOPSIS
  37 .In libdwarf.h
  38 .Ft int
  39 .Fo dwarf_get_arange_cu_header_offset
  40 .Fa "Dwarf_Arange ar"
  41 .Fa "Dwarf_Off *ret"
  42 .Fa "Dwarf_Error *err"
  43 .Fc
  44 .Ft int
  45 .Fo dwarf_get_cu_die_offset
  46 .Fa "Dwarf_Arange ar"
  47 .Fa "Dwarf_Off *ret"
  48 .Fa "Dwarf_Error *err"
  49 .Fc
  50 .Sh DESCRIPTION
  51 These functions retrieve the offsets, relative to the
  52 .Dq ".debug_info"
  53 DWARF section, of the debugging information entries describing the
  54 compilation unit associated with a
  55 .Vt Dwarf_Arange
  56 descriptor.
  57 .Pp
  58 Function
  59 .Fn dwarf_get_arange_cu_header_offset
  60 retrieves the offset of the compilation unit header associated with
  61 argument
  62 .Ar ar ,
  63 and stores it in the location pointed to by argument
  64 .Ar ret .
  65 .Pp
  66 Function
  67 .Fn dwarf_get_cu_die_offset
  68 retrieves the offset of the debugging information entry for the
  69 compilation unit associated with argument
  70 .Ar ar ,
  71 and stores it in the location pointed to by argument
  72 .Ar ret .
  73 .Pp
  74 If argument
  75 .Ar err
  76 is not NULL, these functions will use it to store error information,
  77 in case of an error.
  78 .Sh RETURN VALUES
  79 On success, these functions returns
  80 .Dv DW_DLV_OK .
  81 In case of an error, they return
  82 .Dv DW_DLV_ERROR
  83 and set the argument
  84 .Ar err .
  85 .Sh ERRORS
  86 These functions may fail with:
  87 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
  88 .It Bq Er DW_DLE_ARGUMENT
  89 Argument
  90 .Ar ar
  91 was not a valid
  92 .Vt Dwarf_Arange
  93 descriptor.
  94 .It Bq Er DW_DLE_ARGUMENT
  95 Argument
  96 .Ar ret
  97 was NULL.
  98 .El
  99 .Sh SEE ALSO
 100 .Xr dwarf 3 ,
 101 .Xr dwarf_get_arange 3 ,
 102 .Xr dwarf_get_arange_info 3 ,
 103 .Xr dwarf_get_aranges 3