Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
This software is provided by Joseph Koshy ``as is'' and
any express or implied warranties, including, but not limited to, the
implied warranties of merchantability and fitness for a particular purpose
are disclaimed. in no event shall Joseph Koshy be liable
for any direct, indirect, incidental, special, exemplary, or consequential
damages (including, but not limited to, procurement of substitute goods
or services; loss of use, data, or profits; or business interruption)
however caused and on any theory of liability, whether in contract, strict
liability, or tort (including negligence or otherwise) arising in any way
out of the use of this software, even if advised of the possibility of
such damage.
$Id: elf_update.3 3734 2019-04-22 14:10:49Z jkoshy $
.Dd April 22, 2019 .Dt ELF_UPDATE 3 .Os .Sh NAME .Nm elf_update .Nd update an ELF descriptor .Sh LIBRARY .Lb libelf .Sh SYNOPSIS n libelf.h .Ft off_t .Fn elf_update "Elf *elf" "Elf_Cmd cmd" .Sh DESCRIPTION Function .Fn elf_update causes the library to recalculate the structure of an ELF object and optionally write out the image of the object to file.
p Argument .Ar elf should reference a valid ELF descriptor.
p Argument .Ar cmd can be one of the following values: l -tag -width "Dv ELF_C_WRITE" t Dv ELF_C_NULL The library will recalculate structural information flagging modified structures with the .Dv ELF_F_DIRTY flag, but will not write data to the underlying file image. t Dv ELF_C_WRITE The library will recalculate structural information and will also write the new image to the underlying file. The ELF descriptor referenced by argument .Ar elf should permit the underlying ELF object to be written or updated (see .Xr elf_begin 3 ) . .El
p All pointers to .Vt Elf_Scn and .Vt Elf_Data descriptors associated with descriptor .Ar elf should be considered invalid after a call to .Fn elf_update . .Ss Specifying Object Layout The .Lb libelf supports two layout modes. l -tag -width indent t "Library Layout" If the .Dv ELF_F_LAYOUT flag is not set on the ELF descriptor, the ELF library will lay out the ELF object according to the following scheme: l -tag -compact -width "Section Data" t Em EHDR The ELF executable header will be placed at the start of the object. t Em PHDR If the ELF descriptor contains a program header table, it will be placed after the Executable Header. t Em Section Data ELF section data, if any, will be placed next, keeping each section's alignment requirements in mind. t Em SHDR The ELF section header table, if any, will be placed last. .El t "Application Controlled Layout" The application can take full control of the layout of the ELF object by setting the .Dv ELF_F_LAYOUT flag on the ELF descriptor (see .Xr elf_flagelf 3 ) . In this case the library will lay out the ELF object using application-supplied information as below:
p l -tag -compact -width "Section Data" t Em EHDR The ELF executable header will be placed at the start of the object. t Em PHDR The ELF program header table, if any, it will be placed at the offset specified in the .Va e_phoff field of the ELF executable header. t Em Section Data The data for each ELF section will be placed at the offset specified by the .Va sh_offset field of the section's header. The size of the section will be taken from the .Va sh_size field of the section header. t Em SHDR The ELF section header table, if any, will be placed at the offset specified by the .Va e_shoff field of the executable header. .El .El
p Gaps in the coverage of the file's contents will be set to the fill value specified by .Xr elf_fill 3 . .Ss Application Supplied Information The application needs to set the following fields in the data structures associated with the ELF descriptor prior to calling .Fn elf_update . l -tag -width indent t "Executable Header" The fields of the ELF executable header that need to be set by the application are:
p l -tag -width "e_ident[EI_OSABI]" -compact t Va e_entry To be set to the desired entry address for executables. t Va e_flags To be set to the desired processor specific flags. t Va "e_ident[EI_DATA]" Must be set to one of .Dv ELFDATA2LSB or .Dv ELFDATA2MSB . t Va "e_ident[EI_OSABI]" To be set to the OS ABI desired. For example, for .Fx executables, this field should be set to .Dv ELFOSABI_FREEBSD . t Va e_machine To be set to the desired machine architecture, one of the .Dv EM_* values in the header file n elfdefinitions.h . t Va e_phoff If the application is managing the object's layout, it must set this field to the file offset of the ELF program header table. t Va e_shoff If the application is managing the object's layout, it must set this field to the file offset of the ELF section header table. t Va e_shstrndx To be set to the index of the string table containing section names. t Va e_type To be set to the type of the ELF object, one of the .Dv ET_* values in the header file n elfdefinitions.h . t Va e_version To be set to the desired version of the ELF object. .El t "Program Header" All fields of the entries in the program header table need to be set by the application. t "Section Header" The fields of ELF section headers that need to be set by the application are:
p l -tag -width "sh_addralign" -compact t Va sh_addr To be set to the memory address where the section should reside. t Va sh_addralign If the application is managing the file layout, it must set this field to the desired alignment for the section's contents. This value must be a power of two and must be at least as large as the largest alignment needed by any .Vt Elf_Data descriptor associated with the section. t Va sh_entsize To be set to the size of each entry, for sections containing fixed size elements, or set to zero for sections without fixed size elements. If the application is not managing file layout, it may leave this field as zero for those sections whose types are known to the library. t Va sh_flags To be set to the desired section flags. t Va sh_info To be set as described in .Xr elf 5 . t Va sh_link To be set as described in .Xr elf 5 . t Va sh_name To be set to the index of the section's name in the string table containing section names. t Va sh_offset If the application is managing the file layout, it must set this field to the file offset of the section's contents. t Va sh_size If the application is managing the file layout, it must set this field to the file size of the section's contents. t Va sh_type To be set to the type of the section. .El t "Section Data" The .Vt Elf_Data descriptors associated with each section specify its contents (see .Xr elf_getdata 3 ) . While all the fields in these descriptors are under application control, the following fields influence object layout: l -tag -width "Va d_align" -compact t Va d_align To be set to the desired alignment, within the containing section, of the descriptor's data. t Va d_off If the application is managing object layout, it must set this field to the file offset, within the section, at which the descriptor's data should be placed. t Va d_size To be set to the size in bytes of the memory representation of the descriptor's data. .El .El .Sh RETURN VALUES Function .Fn elf_update returns the total size of the file image if successful, or -1 if an error occurred. .Sh ERRORS This function may fail with the following errors: l -tag -width "[ELF_E_RESOURCE]" t Bq Er ELF_E_ARGUMENT Argument .Ar elf was null. t Bq Er ELF_E_ARGUMENT Argument .Ar cmd was not recognized. t Bq Er ELF_E_ARGUMENT The argument .Ar elf was not a descriptor for an ELF object. t Bq Er ELF_E_CLASS The .Va e_ident[EI_CLASS] field of the executable header of argument .Ar elf did not match the class of the file. t Bq Er ELF_E_DATA An .Vt Elf_Data descriptor contained in argument .Ar elf specified an unsupported type. t Bq Er ELF_E_DATA An .Vt Elf_Data descriptor specified an alignment that was zero or was not a power of two. t Bq Er ELF_E_HEADER The ELF header in argument .Ar elf requested a different byte order from the byte order already associated with the file. t Bq Er ELF_E_IO An I/O error was encountered. t Bq Er ELF_E_LAYOUT An .Vt Elf_Data descriptor contained in argument .Ar elf specified an alignment incompatible with its containing section. t Bq Er ELF_E_LAYOUT Argument .Ar elf contained section descriptors that overlapped in extent. t Bq Er ELF_E_LAYOUT Argument .Ar elf contained section descriptors that were incorrectly aligned or were too small for their data. t Bq Er ELF_E_LAYOUT The flag .Dv ELF_F_LAYOUT was set on the Elf descriptor and the executable header overlapped with the program header table. t Bq Er ELF_E_LAYOUT The flag .Dv ELF_F_LAYOUT was set on the Elf descriptor and the program header table was placed at a misaligned file offset. t Bq Er ELF_E_LAYOUT The flag .Dv ELF_F_LAYOUT was set on the Elf descriptor and the section header table overlapped an extent mapped by a section descriptor. t Bq Er ELF_E_LAYOUT The .Dv ELF_F_LAYOUT flag was set on the Elf descriptor, and the .Va d_offset field in an .Vt Elf_Data descriptor contained a value that was not a multiple of the descriptor's specified alignment. t Bq Er ELF_E_MODE An .Dv ELF_C_WRITE operation was requested with an ELF descriptor that was not opened for writing or updating. t Bq Er ELF_E_SECTION Argument .Ar elf contained a section with an unrecognized type. t Bq Er ELF_E_SECTION The section header at index .Dv SHN_UNDEF had an illegal section type. t Bq Er ELF_E_SEQUENCE An .Dv ELF_C_WRITE operation was requested after a prior call to .Fn elf_cntl elf ELF_C_FDDONE disassociated the ELF descriptor .Ar elf from its underlying file. t Bq Er ELF_E_UNIMPL Argument .Ar elf contained a section with an unsupported ELF type. t Bq Er ELF_E_VERSION Argument .Ar elf had an unsupported version or contained an .Vt Elf_Data descriptor with an unsupported version. .El .Sh SEE ALSO .Xr elf 3 , .Xr elf32_getehdr 3 , .Xr elf32_getphdr 3 , .Xr elf32_newehdr 3 , .Xr elf32_newphdr 3 , .Xr elf64_getehdr 3 , .Xr elf64_getphdr 3 , .Xr elf64_newehdr 3 , .Xr elf64_newphdr 3 , .Xr elf_begin 3 , .Xr elf_cntl 3 , .Xr elf_fill 3 , .Xr elf_flagehdr 3 , .Xr elf_flagelf 3 , .Xr elf_getdata 3 , .Xr elf_getscn 3 , .Xr elf_newdata 3 , .Xr elf_newscn 3 , .Xr elf_rawdata 3 , .Xr gelf 3 , .Xr gelf_newehdr 3 , .Xr gelf_newphdr 3 , .Xr elf 5