external/bsd/elftoolchain/dist/libelf/gelf_getsym.3

   1 .\"     $NetBSD: gelf_getsym.3,v 1.2 2014/03/09 16:58:04 christos Exp $
   2 .\"
   3 .\" Copyright (c) 2006,2008 Joseph Koshy.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" This software is provided by Joseph Koshy ``as is'' and
  15 .\" any express or implied warranties, including, but not limited to, the
  16 .\" implied warranties of merchantability and fitness for a particular purpose
  17 .\" are disclaimed.  in no event shall Joseph Koshy be liable
  18 .\" for any direct, indirect, incidental, special, exemplary, or consequential
  19 .\" damages (including, but not limited to, procurement of substitute goods
  20 .\" or services; loss of use, data, or profits; or business interruption)
  21 .\" however caused and on any theory of liability, whether in contract, strict
  22 .\" liability, or tort (including negligence or otherwise) arising in any way
  23 .\" out of the use of this software, even if advised of the possibility of
  24 .\" such damage.
  25 .\"
  26 .\" Id: gelf_getsym.3 189 2008-07-20 10:38:08Z jkoshy
  27 .\"
  28 .Dd August 29, 2006
  29 .Os
  30 .Dt GELF_GETSYM 3
  31 .Sh NAME
  32 .Nm gelf_getsym ,
  33 .Nm gelf_update_sym
  34 .Nd read and update symbol information
  35 .Sh LIBRARY
  36 .Lb libelf
  37 .Sh SYNOPSIS
  38 .In gelf.h
  39 .Ft "GElf_Sym *"
  40 .Fn gelf_getsym "Elf_Data *data" "int ndx" "GElf_Sym *sym"
  41 .Ft int
  42 .Fn gelf_update_sym "Elf_Data *data" "int ndx" "GElf_Sym *sym"
  43 .Sh DESCRIPTION
  44 These convenience functions are used to retrieve and update class-dependent
  45 .Vt Elf32_Sym
  46 and
  47 .Vt Elf64_Sym
  48 structures in an ELF object.
  49 .Pp
  50 Argument
  51 .Ar data
  52 is an
  53 .Vt Elf_Data
  54 descriptor associated with a section of type
  55 .Dv SHT_SYMTAB ,
  56 .Dv SHT_DYNSYM
  57 or
  58 .Dv SHT_GNU_versym .
  59 Argument
  60 .Ar ndx
  61 is the index of the symbol being retrieved or updated.
  62 The class-independent
  63 .Vt GElf_Sym
  64 structure is described in
  65 .Xr gelf 3 .
  66 .Pp
  67 Function
  68 .Fn gelf_getsym
  69 retrieves class-dependent symbol information at index
  70 .Ar ndx
  71 in data buffer
  72 .Ar data
  73 and copies it to the destination pointed to by argument
  74 .Ar sym
  75 after translation to class-independent form.
  76 .Pp
  77 Function
  78 .Fn gelf_update_sym
  79 converts the class-independent symbol information pointed to
  80 by argument
  81 .Ar sym
  82 to class-dependent form, and writes it to the symbol entry at index
  83 .Ar ndx
  84 in the data buffer described by argument
  85 .Ar data .
  86 Function
  87 .Fn gelf_update_sym
  88 signals an error if any of the values in the class-independent
  89 representation exceeds the representable limits of the target
  90 type.
  91 .Sh RETURN VALUES
  92 Function
  93 .Fn gelf_getsym
  94 returns the value of argument
  95 .Ar sym
  96 if successful, or NULL in case of an error.
  97 Function
  98 .Fn gelf_update_sym
  99 returns a non-zero value if successful, or zero in case of an error.
 100 .Sh ERRORS
 101 These functions may fail with the following errors:
 102 .Bl -tag -width "[ELF_E_RESOURCE]"
 103 .It Bq Er ELF_E_ARGUMENT
 104 Arguments
 105 .Ar data
 106 or
 107 .Ar sym
 108 were NULL.
 109 .It Bq Er ELF_E_ARGUMENT
 110 Argument
 111 .Ar ndx
 112 was less than zero or larger than the number of symbols in the data
 113 descriptor.
 114 .It Bq Er ELF_E_ARGUMENT
 115 Data descriptor
 116 .Ar data
 117 was not associated with a section containing symbol information.
 118 .It Bq Er ELF_E_RANGE
 119 A value was not representable in the target type.
 120 .El
 121 .Sh SEE ALSO
 122 .Xr elf 3 ,
 123 .Xr elf_getdata 3 ,
 124 .Xr elf_getscn 3 ,
 125 .Xr gelf 3 ,
 126 .Xr gelf_getsyminfo 3 ,
 127 .Xr gelf_update_syminfo 3