external/bsd/libelf/dist/elf_flagdata.3

   1 .\"     $NetBSD$
   2 .\"
   3 .\" Copyright (c) 2006,2007 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 .\" $FreeBSD: src/lib/libelf/elf_flagdata.3,v 1.3.2.1.2.1 2009/10/25 01:10:29 kensmith Exp $
  27 .\"
  28 .Dd October 22, 2007
  29 .Os
  30 .Dt ELF_FLAGDATA 3
  31 .Sh NAME
  32 .Nm elf_flagdata ,
  33 .Nm elf_flagehdr ,
  34 .Nm elf_flagelf ,
  35 .Nm elf_flagphdr ,
  36 .Nm elf_flagscn ,
  37 .Nm elf_flagshdr
  38 .Nd manipulate flags associated with ELF(3) data structures
  39 .Sh LIBRARY
  40 .Lb libelf
  41 .Sh SYNOPSIS
  42 .In libelf.h
  43 .Ft "unsigned int"
  44 .Fn elf_flagdata "Elf_Data *data" "Elf_Cmd cmd" "unsigned int flags"
  45 .Ft "unsigned int"
  46 .Fn elf_flagehdr "Elf *elf" "Elf_Cmd cmd" "unsigned int flags"
  47 .Ft "unsigned int"
  48 .Fn elf_flagelf "Elf *elf" "Elf_Cmd cmd" "unsigned int flags"
  49 .Ft "unsigned int"
  50 .Fn elf_flagphdr "Elf *elf" "Elf_Cmd cmd" "unsigned int flags"
  51 .Ft "unsigned int"
  52 .Fn elf_flagscn "Elf_Scn *scn" "Elf_Cmd cmd" "unsigned int flags"
  53 .Ft "unsigned int"
  54 .Fn elf_flagshdr "Elf_Scn *scn" "Elf_Cmd cmd" "unsigned int flags"
  55 .Sh DESCRIPTION
  56 These functions are used to query, set or reset flags on data
  57 structures associated with an ELF file.
  58 .Pp
  59 Arguments
  60 .Ar data ,
  61 .Ar elf
  62 and
  63 .Ar scn
  64 denote the data structures whose flags need to be changed.
  65 These values are allowed to be NULL to simplify error handling in
  66 application code.
  67 .Pp
  68 Argument
  69 .Ar cmd
  70 may have the following values:
  71 .Bl -tag -width ELF_C_SET
  72 .It Dv ELF_C_CLR
  73 The argument
  74 .Ar flags
  75 specifies the flags to be cleared.
  76 .It Dv ELF_C_SET
  77 The argument
  78 .Ar flags
  79 specifies the flags to be set.
  80 .El
  81 .Pp
  82 The argument
  83 .Ar flags
  84 is allowed to have the following flags set:
  85 .Bl -tag -width ELF_F_LAYOUT
  86 .It Dv ELF_F_DIRTY
  87 Mark the associated data structure as needing to be written back
  88 to the underlying file.
  89 A subsequent call to
  90 .Xr elf_update 3
  91 will resynchronize the library's internal data structures.
  92 .It Dv ELF_F_LAYOUT
  93 This flag is only valid with the
  94 .Fn elf_flagelf
  95 API.
  96 It informs the library that the application will take
  97 responsibility for the layout of the file and that the library is
  98 not to insert any padding in between sections.
  99 .El
 100 .Pp
 101 Marking a given data structure as
 102 .Dq dirty
 103 affects all of its contained elements.
 104 Thus marking an ELF descriptor
 105 .Ar elf
 106 with
 107 .Fn elf_flagelf "elf" "ELF_C_SET" "ELF_F_DIRTY"
 108 means that the entire contents of the descriptor are
 109 .Dq dirty .
 110 .Pp
 111 Using a value of zero for argument
 112 .Ar flags
 113 will return the current set of flags for the data structure being
 114 queried.
 115 .Sh RETURN VALUES
 116 These functions return the updated flags is successful, and zero if
 117 an error is detected.
 118 .Sh ERRORS
 119 These functions may fail with the following errors:
 120 .Bl -tag -width "[ELF_E_RESOURCE]"
 121 .It Bq Er ELF_E_ARGUMENT
 122 An unsupported value was used for the
 123 .Ar cmd
 124 argument.
 125 .It Bq Er ELF_E_ARGUMENT
 126 Argument
 127 .Ar flags
 128 had unsupported flags set.
 129 .It Bq Er ELF_E_ARGUMENT
 130 The argument
 131 .Ar elf
 132 was not a descriptor for an ELF object.
 133 .It Bq Er ELF_E_SEQUENCE
 134 Function
 135 .Fn elf_flagehdr
 136 was called without an executable header being allocated.
 137 .It Bq Er ELF_E_SEQUENCE
 138 Function
 139 .Fn elf_flagphdr
 140 was called without a program header being allocated.
 141 .El
 142 .Sh SEE ALSO
 143 .Xr elf 3 ,
 144 .Xr elf32_newehdr 3 ,
 145 .Xr elf32_newphdr 3 ,
 146 .Xr elf32_newshdr 3 ,
 147 .Xr elf64_newehdr 3 ,
 148 .Xr elf64_newphdr 3 ,
 149 .Xr elf64_newshdr 3 ,
 150 .Xr elf_newdata 3 ,
 151 .Xr elf_update 3 ,
 152 .Xr gelf 3 ,
 153 .Xr gelf_newehdr 3 ,
 154 .Xr gelf_newphdr 3 ,
 155 .Xr gelf_newshdr 3 ,
 156 .Xr gelf_update_dyn 3 ,
 157 .Xr gelf_update_move 3 ,
 158 .Xr gelf_update_rel 3 ,
 159 .Xr gelf_update_rela 3 ,
 160 .Xr gelf_update_sym 3 ,
 161 .Xr gelf_update_syminfo 3