contrib/elftoolchain/libelf/gelf_newehdr.3

   1 .\" Copyright (c) 2006-2008 Joseph Koshy.  All rights reserved.
   2 .\"
   3 .\" Redistribution and use in source and binary forms, with or without
   4 .\" modification, are permitted provided that the following conditions
   5 .\" are met:
   6 .\" 1. Redistributions of source code must retain the above copyright
   7 .\"    notice, this list of conditions and the following disclaimer.
   8 .\" 2. Redistributions in binary form must reproduce the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer in the
  10 .\"    documentation and/or other materials provided with the distribution.
  11 .\"
  12 .\" This software is provided by Joseph Koshy ``as is'' and
  13 .\" any express or implied warranties, including, but not limited to, the
  14 .\" implied warranties of merchantability and fitness for a particular purpose
  15 .\" are disclaimed.  in no event shall Joseph Koshy be liable
  16 .\" for any direct, indirect, incidental, special, exemplary, or consequential
  17 .\" damages (including, but not limited to, procurement of substitute goods
  18 .\" or services; loss of use, data, or profits; or business interruption)
  19 .\" however caused and on any theory of liability, whether in contract, strict
  20 .\" liability, or tort (including negligence or otherwise) arising in any way
  21 .\" out of the use of this software, even if advised of the possibility of
  22 .\" such damage.
  23 .\"
  24 .\" $Id: gelf_newehdr.3 3643 2018-10-14 21:09:24Z jkoshy $
  25 .\"
  26 .Dd October 22, 2007
  27 .Dt GELF_NEWEHDR 3
  28 .Os
  29 .Sh NAME
  30 .Nm elf32_newehdr ,
  31 .Nm elf64_newehdr ,
  32 .Nm gelf_newehdr
  33 .Nd retrieve or allocate the object file header
  34 .Sh LIBRARY
  35 .Lb libelf
  36 .Sh SYNOPSIS
  37 .In libelf.h
  38 .Ft "Elf32_Ehdr *"
  39 .Fn elf32_newehdr "Elf *elf"
  40 .Ft "Elf64_Ehdr *"
  41 .Fn elf64_newehdr "Elf *elf"
  42 .In gelf.h
  43 .Ft "void *"
  44 .Fn gelf_newehdr "Elf *elf" "int elfclass"
  45 .Sh DESCRIPTION
  46 These functions retrieve the ELF header from the ELF descriptor
  47 .Ar elf ,
  48 allocating a new header if needed.
  49 File data structures are translated to their in-memory representations
  50 as described in
  51 .Xr elf 3 .
  52 .Pp
  53 Function
  54 .Fn elf32_newehdr
  55 returns a pointer to a 32 bit
  56 .Vt Elf32_Ehdr
  57 structure.
  58 Function
  59 .Fn elf64_newehdr
  60 returns a pointer to a 64 bit
  61 .Vt Elf64_Ehdr
  62 structure.
  63 .Pp
  64 When argument
  65 .Ar elfclass
  66 has value
  67 .Dv ELFCLASS32 ,
  68 function
  69 .Fn gelf_newehdr
  70 returns the value returned by
  71 .Fn elf32_newehdr "elf" .
  72 When argument
  73 .Ar elfclass
  74 has value
  75 .Dv ELFCLASS64
  76 it returns the value returned by
  77 .Fn elf64_newehdr "elf" .
  78 .Pp
  79 If a fresh header structure is allocated, the members of the
  80 structure are initialized as follows:
  81 .Bl -tag -width indent
  82 .It Va "e_ident[EI_MAG0..EI_MAG3]"
  83 Identification bytes at offsets
  84 .Dv EI_MAG0 ,
  85 .Dv EI_MAG1 ,
  86 .Dv EI_MAG2
  87 and
  88 .Dv EI_MAG3
  89 are set to the ELF signature.
  90 .It Va "e_ident[EI_CLASS]"
  91 The identification byte at offset
  92 .Dv EI_CLASS
  93 is set to the ELF class associated with the function being called
  94 or to argument
  95 .Ar elfclass
  96 for function
  97 .Fn gelf_newehdr .
  98 .It Va "e_ident[EI_DATA]"
  99 The identification byte at offset
 100 .Dv EI_DATA
 101 is set to
 102 .Dv ELFDATANONE .
 103 .It Va "e_ident[EI_VERSION]"
 104 The identification byte at offset
 105 .Dv EI_VERSION
 106 is set to the ELF library's operating version set by a prior call to
 107 .Xr elf_version 3 .
 108 .It Va e_machine
 109 is set to
 110 .Dv EM_NONE .
 111 .It Va e_type
 112 is set to
 113 .Dv ELF_K_NONE .
 114 .It Va e_version
 115 is set to the ELF library's operating version set by a prior call to
 116 .Xr elf_version 3 .
 117 .El
 118 .Pp
 119 Other members of the header are set to zero.
 120 The application is responsible for changing these values
 121 as needed before calling
 122 .Fn elf_update .
 123 .Pp
 124 If successful, these three functions set the
 125 .Dv ELF_F_DIRTY
 126 flag on ELF descriptor
 127 .Ar elf .
 128 .Sh RETURN VALUES
 129 These functions return a pointer to a translated header descriptor
 130 if successful, or NULL on failure.
 131 .Sh COMPATIBILITY
 132 The
 133 .Fn gelf_newehdr
 134 function uses a type of
 135 .Ft "void *"
 136 for its returned value.
 137 This differs from some other implementations of the ELF(3) API, which use an
 138 .Ft "unsigned long"
 139 return type.
 140 .Sh ERRORS
 141 These functions can fail with the following errors:
 142 .Bl -tag -width "[ELF_E_RESOURCE]"
 143 .It Bq Er ELF_E_ARGUMENT
 144 The argument
 145 .Ar elf
 146 was null.
 147 .It Bq Er ELF_E_ARGUMENT
 148 Argument
 149 .Ar elf
 150 was not a descriptor for an ELF object.
 151 .It Bq Er ELF_E_ARGUMENT
 152 Argument
 153 .Ar elfclass
 154 had an unsupported value.
 155 .It Bq Er ELF_E_ARGUMENT
 156 The class of the ELF descriptor
 157 .Ar elf
 158 did not match that of the requested operation.
 159 .It Bq Er ELF_E_ARGUMENT
 160 For function
 161 .Fn gelf_newehdr ,
 162 the class of argument
 163 .Ar elf
 164 was not
 165 .Dv ELFCLASSNONE
 166 and did not match the argument
 167 .Ar elfclass .
 168 .It Bq Er ELF_E_CLASS
 169 The ELF class of descriptor
 170 .Ar elf
 171 did not match that of the API function being called.
 172 .It Bq Er ELF_E_HEADER
 173 A malformed ELF header was detected.
 174 .It Bq Er ELF_E_RESOURCE
 175 An out of memory condition was detected during execution.
 176 .It Bq Er ELF_E_SECTION
 177 The ELF descriptor in argument
 178 .Ar elf
 179 did not adhere to the conventions used for extended numbering.
 180 .It Bq Er ELF_E_VERSION
 181 The ELF descriptor
 182 .Ar elf
 183 had an unsupported ELF version number.
 184 .El
 185 .Sh SEE ALSO
 186 .Xr elf 3 ,
 187 .Xr elf32_getehdr 3 ,
 188 .Xr elf64_getehdr 3 ,
 189 .Xr elf_flagdata 3 ,
 190 .Xr elf_getident 3 ,
 191 .Xr elf_update 3 ,
 192 .Xr elf_version 3 ,
 193 .Xr gelf 3 ,
 194 .Xr gelf_getehdr 3 ,
 195 .Xr elf 5