contrib/elftoolchain/libdwarf/dwarf_get_section_bytes.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_section_bytes.3 3644 2018-10-15 19:55:01Z jkoshy $
  26 .\"
  27 .Dd August 26, 2011
  28 .Dt DWARF_GET_SECTION_BYTES 3
  29 .Os
  30 .Sh NAME
  31 .Nm dwarf_get_section_bytes
  32 .Nd retrieve ELF section byte streams
  33 .Sh LIBRARY
  34 .Lb libdwarf
  35 .Sh SYNOPSIS
  36 .In libdwarf.h
  37 .Ft Dwarf_Ptr
  38 .Fo dwarf_get_section_bytes
  39 .Fa "Dwarf_P_Debug dbg"
  40 .Fa "Dwarf_Signed dwarf_section"
  41 .Fa "Dwarf_Signed *elf_section_index"
  42 .Fa "Dwarf_Unsigned *length"
  43 .Fa "Dwarf_Error *err"
  44 .Fc
  45 .Sh DESCRIPTION
  46 Function
  47 .Fn dwarf_get_section_bytes
  48 returns the ELF section byte streams generated by a prior call
  49 to function
  50 .Xr dwarf_transform_to_disk_form 3 .
  51 .Pp
  52 Each call to function
  53 .Fn dwarf_get_section_bytes
  54 will return the byte stream for one ELF section.
  55 The first call to this function will always return the first ELF
  56 section, and the subsequent calls will return the rest of sections
  57 in the order when they were generated, until the last one.
  58 The total number of sections generated is returned by the function
  59 .Xr dwarf_transform_to_disk_form 3 .
  60 .Pp
  61 Argument
  62 .Ar dbg
  63 should reference a DWARF producer instance allocated using the
  64 functions
  65 .Xr dwarf_producer_init 3
  66 or
  67 .Xr dwarf_producer_init_b 3 .
  68 .Pp
  69 Argument
  70 .Ar dwarf_section
  71 is currently ignored.
  72 .Pp
  73 Argument
  74 .Ar elf_section_index
  75 should point to a location which will be set to the section index value
  76 of the returned ELF section.
  77 .Pp
  78 Argument
  79 .Ar length
  80 should point to a location which will hold the length in bytes of the
  81 returned ELF section.
  82 .Pp
  83 If argument
  84 .Ar err
  85 is not NULL, it will be used to store error information in case of an
  86 error.
  87 .Ss Memory Management
  88 The memory areas used for the returned ELF section byte streams should
  89 be freed using the function
  90 .Fn dwarf_producer_finish .
  91 .Sh RETURN VALUES
  92 On success, function
  93 .Fn dwarf_get_section_bytes
  94 returns a pointer to a ELF section byte stream.
  95 In case of an error, function
  96 .Fn dwarf_get_section_bytes
  97 will return NULL and set the argument
  98 .Ar err .
  99 .Sh EXAMPLES
 100 To generate and retrieve ELF section byte streams, use:
 101 .Bd -literal -offset indent
 102 Dwarf_P_Debug dbg;
 103 Dwarf_Signed count, i, sec_index;
 104 Dwarf_Unsigned len;
 105 Dwarf_Ptr bytes;
 106 Dwarf_Error de;
 107
 108 /* ... Assume that `dbg' refers to a DWARF producer instance,
 109  * and that application code has added DWARF debugging
 110  * information to the producer instance. ...
 111  */
 112 if ((count = dwarf_transform_to_disk_form(dbg, &de)) ==
 113     DW_DLV_NOCOUNT) {
 114         warnx("dwarf_transform_to_disk_form failed: %s",
 115             dwarf_errmsg(-1));
 116         return;
 117 }
 118
 119 /* Retrieve section data. */
 120 for (i = 0; i < count; i++) {
 121         bytes = dwarf_get_section_bytes(dbg, i, &sec_index, &len,
 122             &de);
 123         if (bytes == NULL) {
 124                 warnx("dwarf_get_section_bytes failed: %s",
 125                     dwarf_errmsg(-1));
 126                 continue;
 127         }
 128         /* ... use the returned byte stream ... */
 129 }
 130
 131 /* Release resources. */
 132 dwarf_producer_finish(dbg, &de);
 133 .Ed
 134 .Sh ERRORS
 135 Function
 136 .Fn dwarf_get_section_bytes
 137 can fail with:
 138 .Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY"
 139 .It Bq Er DW_DLE_ARGUMENT
 140 One of the arguments
 141 .Ar dbg ,
 142 .Ar elf_section_index ,
 143 or
 144 .Ar length
 145 was NULL.
 146 .It Bq Er DW_DLE_NO_ENTRY
 147 There were no more ELF sections to retrieve, or the function was
 148 called before a call to
 149 .Xr dwarf_transform_to_disk_form 3 .
 150 .El
 151 .Sh SEE ALSO
 152 .Xr dwarf 3 ,
 153 .Xr dwarf_producer_finish 3 ,
 154 .Xr dwarf_producer_init 3 ,
 155 .Xr dwarf_producer_init_b 3 ,
 156 .Xr dwarf_reset_section_bytes 3 ,
 157 .Xr dwarf_transform_to_disk_form 3