Recent changes to libelf

libelf modified by Joseph Koshy

Joseph Koshy — Sun, 29 Dec 2013 13:53:47 -0000

--- v1
+++ v2
@@ -8,438 +8,113 @@

 ## What's Available

-  * An [implementation of the ELF(3) API](/apps/trac/elftoolchain/browser/trunk/libelf). 
-  * A [TET](http://tetworks.opengroup.org) based [test suite](/apps/trac/elftoolchain/browser/trunk/test/libelf) for the ELF(3) API. 
-  * Comprehensive documentation in the form of manual pages (part of the [source tree](/apps/trac/elftoolchain/browser/trunk/libelf)). 
+  * An [implementation of the ELF(3) API](http://sourceforge.net/p/elftoolchain/code/HEAD/tree/trunk/libelf). 
+  * A [TET](http://tetworks.opengroup.org) based [test suite](http://sourceforge.net/p/elftoolchain/code/HEAD/tree/trunk/test/libelf) for the ELF(3) API. 
+  * Comprehensive documentation in the form of manual pages (part of the [source tree](http://sourceforge.net/p/elftoolchain/code/HEAD/tree/trunk/libelf)). 
   * [A tutorial introduction](http://sourceforge.net/projects/elftoolchain/files/Documentation/libelf-by-example/20120308/libelf-by-example.pdf/download) to **libelf**. 

 ## Implementation Status

-**API**
-**Implementation**
-**Manual Page**
-**Test Cases**
-**Comments**
-
-**Error Handling**
-
-`elf_errno()`
-Y 
-Y 
-Y 
-
-`elf_errmsg()`
-Y 
-Y 
-Y 
-
-**Initialization**
-
-`elf_begin()`
-Y 
-Y 
-Y 
-
-`elf_end()`
-Y 
-Y 
-Partial 
-
-`elf_memory()`
-Y 
-Y 
-Y 
-
-**Archive Access**
-
-`elf_rand()`
-Y 
-Y 
-Partial 
-
-`elf_next()`
-Y 
-Y 
-Y 
-
-`elf_getarsym()`
-Y 
-Y 
-Y 
-
-`elf_getarhdr()`
-Y 
-Y 
-Y 
-
-**ELF Class/Byte order Translation**
-
-`elf32_xlatetof()`
-Y 
-Y 
-Y 
-
-`elf32_xlatetom()`
-Y 
-Y 
-Y 
-
-`elf64_xlatetof()`
-Y 
-Y 
-Y 
-
-`elf64_xlatetom()`
-Y 
-Y 
-Y 
-
-`gelf_xlatetof()`
-Y 
-Y 
-Y 
-
-`gelf_xlatetom()`
-Y 
-Y 
-Y 
-
-**General Queries**
-
-`elf_getbase()`
-Y 
-Y 
-Y 
-
-`elf_getident()`
-Y 
-Y 
-Y 
-
-`elf_getphdrnum()`
-Y 
-Y 
-
-`elf_getphnum()`
-Y 
-Y 
-Deprecated API. See [LibElfIncompatibilityRedHatElfUtils]. 
-
-`elf_getshdrnum()`
-Y 
-Y 
-
-`elf_getshnum()`
-Y 
-Y 
-Y 
-Deprecated API. See [LibElfIncompatibilityRedHatElfUtils]. 
-
-`elf_getshdrstrndx()`
-Y 
-Y 
-
-`elf_getshstrndx()`
-Y 
-Y 
-Y 
-Deprecated API. See [LibElfIncompatibilityRedHatElfUtils]. 
-
-`elf_hash()`
-Y 
-Y 
-Y 
-
-`elf_kind()`
-Y 
-Y 
-Y 
-
-`elf_ndxscn()`
-Y 
-Y 
-Y 
-
-`elf_rawdata()`
-Y 
-Y 
-
-`elf_rawfile()`
-Y 
-Y 
-Y 
-
-`elf_version()`
-Y 
-Y 
-Y 
-
-`elf32_checksum()`
-Y 
-Y 
-
-`elf32_fsize()`
-Y 
-Y 
-Y 
-
-`elf64_checksum()`
-Y 
-Y 
-
-`elf64_fsize()`
-Y 
-Y 
-Y 
-
-`gelf_checksum()`
-Y 
-Y 
-
-`gelf_getclass()`
-Y 
-Y 
-Y 
-
-`gelf_fsize()`
-Y 
-Y 
-Y 
-
-**Elf Headers**
-
-`elf32_getehdr()`
-Y 
-Y 
-Y 
-
-`elf32_getphdr()`
-Y 
-Y 
-Y 
-
-`elf32_getshdr()`
-Y 
-Y 
-Y 
-
-`elf32_newehdr()`
-Y 
-Y 
-Y 
-
-`elf32_newphdr()`
-Y 
-Y 
-
-`elf64_getehdr()`
-Y 
-Y 
-Y 
-
-`elf64_getphdr()`
-Y 
-Y 
-Y 
-
-`elf64_newehdr()`
-Y 
-Y 
-Y 
-
-`elf64_newphdr()`
-Y 
-Y 
-
-`elf64_getshdr()`
-Y 
-Y 
-Y 
-
-`gelf_getehdr()`
-Y 
-Y 
-Y 
-
-`gelf_getphdr()`
-Y 
-Y 
-
-`gelf_getshdr()`
-Y 
-Y 
-
-`gelf_newehdr()`
-Y 
-Y 
-Y 
-
-`gelf_newphdr()`
-Y 
-Y 
-
-`gelf_update_ehdr()`
-Y 
-Y 
-
-`gelf_update_phdr()`
-Y 
-Y 
-
-`gelf_update_shdr()`
-Y 
-Y 
-
-**Elf Sections**
-
-`elf_getscn()`
-Y 
-Y 
-Y 
-
-`elf_nextscn()`
-Y 
-Y 
-Y 
-
-`elf_newscn()`
-Y 
-Y 
-Y 
-
-**Elf Data**
-
-`elf_fill()`
-Y 
-Y 
-
-`elf_getdata()`
-Y 
-Y 
-
-`elf_newdata()`
-Y 
-Y 
-
-`elf_strptr()`
-Y 
-Y 
-
-`gelf_getdyn()`
-Y 
-Y 
-
-`gelf_getmove()`
-Y 
-Y 
-
-`gelf_getrel()`
-Y 
-Y 
-
-`gelf_getrela()`
-Y 
-Y 
-
-`gelf_getsym()`
-Y 
-Y 
-
-`gelf_getsyminfo()`
-Y 
-Y 
-
-`gelf_getsymshndx()`
-Y 
-Y 
-
-`gelf_update_dyn()`
-Y 
-Y 
-
-`gelf_update_move()`
-Y 
-Y 
-
-`gelf_update_rel()`
-Y 
-Y 
-
-`gelf_update_rela()`
-Y 
-Y 
-
-`gelf_update_sym()`
-Y 
-Y 
-
-`gelf_update_syminfo()`
-Y 
-Y 
-
-`gelf_update_symshndx()`
-Y 
-Y 
-
-**I/O Control**
-
-`elf_cntl()`
-Y 
-Y 
-Y 
-
-`elf_flagdata()`
-Y 
-Y 
-Y 
-
-`elf_flagehdr()`
-Y 
-Y 
-Y 
-
-`elf_flagphdr()`
-Y 
-Y 
-Y 
-
-`elf_flagscn()`
-Y 
-Y 
-Y 
-
-`elf_flagshdr()`
-Y 
-Y 
-Y 
-
-`elf_update()`
-Y 
-Y 
-Y 
-
-**API Extensions**
-
-`elf_add_member()`
-See [LibElfArchiveCreation]
-
-`elf_add_symtab()`
-See [LibElfArchiveCreation]
-
-`elf_flagarhdr()`
-Y 
-Y 
-See [LibElfArchiveCreation]
-
-`elf_open()`
-Y 
-
-`elf_openmember()`
-Y 
-
-`elf_setshstrndx()`
-Y 
-Y 
+ **API** | **Implementation** | **Manual Page** | **Test Cases** | **Comments**
+ ------ | --------------- | ------------- | ----------- | ------------
+ **Error Handling**
+ `elf_errno()`| Y  | Y  | Y  | 
+ `elf_errmsg()` | Y | Y  | Y  |
+ **Initialization**
+ `elf_begin()` | Y | Y | Y |
+ `elf_end()` | Y | Y | Partial |
+ `elf_memory()` | Y | Y | Y |
+ **Archive Access**
+ `elf_rand()` | Y | Y | Partial |
+ `elf_next()` | Y | Y | Y |
+ `elf_getarsym()` | Y | Y | Y |
+ `elf_getarhdr()` | Y | Y | Y |
+ **ELF Class/Byte order Translation**
+ `elf32_xlatetof()` | Y | Y | Y |
+ `elf32_xlatetom()` | Y | Y | Y |
+ `elf64_xlatetof()` | Y | Y | Y |
+ `elf64_xlatetom()` | Y | Y | Y |
+ `gelf_xlatetof()` | Y | Y | Y |
+ `gelf_xlatetom()` | Y | Y | Y |
+ **General Queries**
+ `elf_getbase()` | Y | Y | Y |
+ `elf_getident()` | Y | Y | Y |
+ `elf_getphdrnum()` | Y | Y | | |
+ `elf_getphnum()` | Y | Y | | Deprecated API. See [LibElfIncompatibilityRedHatElfUtils]. 
+ `elf_getshdrnum()` | Y | Y | |
+ `elf_getshnum()` | Y | Y | Y | Deprecated API. See [LibElfIncompatibilityRedHatElfUtils]. 
+ `elf_getshdrstrndx()`| Y | Y  | |
+ `elf_getshstrndx()` | Y | Y | Y | Deprecated API. See [LibElfIncompatibilityRedHatElfUtils]. 
+ `elf_hash()` | Y | Y | Y |
+ `elf_kind()` | Y | Y | Y |
+ `elf_ndxscn()` | Y | Y | Y |
+ `elf_rawdata()` | Y | Y | |
+ `elf_rawfile()` | Y | Y | Y |
+ `elf_version()` | Y | Y | Y |
+ `elf32_checksum()` | Y | Y | |
+ `elf32_fsize()` | Y | Y | Y 
+ `elf64_checksum()` | Y | Y | |
+ `elf64_fsize()` | Y | Y | Y |
+ `gelf_checksum()` | Y | Y  | |
+ `gelf_getclass()` | Y | Y | Y |
+ `gelf_fsize()` | Y | Y | Y |
+ **Elf Headers**
+ `elf32_getehdr()` | Y | Y | Y |
+ `elf32_getphdr()` | Y | Y | Y |
+ `elf32_getshdr()` | Y | Y | Y |
+ `elf32_newehdr()` | Y | Y | Y |
+ `elf32_newphdr()` | Y | Y | |
+ `elf64_getehdr()` | Y | Y | Y |
+ `elf64_getphdr()` | Y | Y | Y |
+ `elf64_newehdr()` | Y | Y | Y |
+ `elf64_newphdr()` | Y | Y | |
+ `elf64_getshdr()` | Y  | Y | Y 
+ `gelf_getehdr()` | Y | Y | Y |
+ `gelf_getphdr()` | Y | Y  | |
+ `gelf_getshdr()` | Y | Y | |
+ `gelf_newehdr()` | Y | Y | Y |
+ `gelf_newphdr()` | Y | Y | |
+ `gelf_update_ehdr()` | Y | Y | |
+ `gelf_update_phdr()` | Y | Y | |
+ `gelf_update_shdr()` | Y | Y | |
+ **Elf Sections**
+ `elf_getscn()` | Y | Y | Y |
+ `elf_nextscn()` | Y | Y | Y |
+ `elf_newscn()` | Y | Y | Y |
+ **Elf Data**
+ `elf_fill()` | Y | Y  | |
+ `elf_getdata()` | Y | Y | |
+ `elf_newdata()` | Y | Y | |
+ `elf_strptr()` | Y | Y | |
+ `gelf_getdyn()` | Y | Y | |
+ `gelf_getmove()` | Y | Y | |
+ `gelf_getrel()` | Y | Y | |
+ `gelf_getrela()` | Y | Y  | |
+ `gelf_getsym()` | Y | Y | |
+ `gelf_getsyminfo()` | Y | Y  | |
+ `gelf_getsymshndx()` | Y | Y | |
+ `gelf_update_dyn()` | Y | Y | |
+ `gelf_update_move()` | Y  | Y | |
+ `gelf_update_rel()` | Y | Y | |
+ `gelf_update_rela()` | Y | Y  | |
+ `gelf_update_sym()` | Y | Y | |
+ `gelf_update_syminfo()` | Y | Y  | |
+ `gelf_update_symshndx()` | Y  | Y | |
+ **I/O Control**
+ `elf_cntl()` | Y | Y | Y |
+ `elf_flagdata()` | Y | Y | Y |
+ `elf_flagehdr()` | Y | Y | Y |
+ `elf_flagphdr()` | Y | Y | Y |
+ `elf_flagscn()` | Y | Y | Y |
+ `elf_flagshdr()` | Y | Y | Y |
+ `elf_update()` | Y | Y | Y |
+ **API Extensions**
+ `elf_add_member()` | | | | See [LibElfArchiveCreation]
+ `elf_add_symtab()` | | | | See [LibElfArchiveCreation]
+ `elf_flagarhdr()` | Y | Y | | See [LibElfArchiveCreation]
+ `elf_open()` | Y | | |
+ `elf_openmember()` | Y  | | |
+ `elf_setshstrndx()` | Y | Y  | |

 ## Portability

@@ -453,63 +128,6 @@

   * [Incompatibilities with older versions of Red Hat elfutils](LibElfIncompatibilityRedHatElfUtils). 

-## Open Tickets
-
-[Ticket](/apps/trac/elftoolchain/query?status=%21closed&max=0&component=libelf&order=id&col=id&col=status&col=owner&col=milestone&col=summary&desc=1) [Status](/apps/trac/elftoolchain/query?status=%21closed&max=0&component=libelf&order=status&col=id&col=status&col=owner&col=milestone&col=summary) [Owner](/apps/trac/elftoolchain/query?status=%21closed&max=0&component=libelf&order=owner&col=id&col=status&col=owner&col=milestone&col=summary) [Milestone](/apps/trac/elftoolchain/query?status=%21closed&max=0&component=libelf&order=milestone&col=id&col=status&col=owner&col=milestone&col=summary) [Summary](/apps/trac/elftoolchain/query?status=%21closed&max=0&component=libelf&order=summary&col=id&col=status&col=owner&col=milestone&col=summary)
-
-[#7](/apps/trac/elftoolchain/ticket/7)
-new 
-jkoshy 
-RELEASE_1_0 
-[Add ability to remove a section](/apps/trac/elftoolchain/ticket/7)
-
-[#15](/apps/trac/elftoolchain/ticket/15)
-new 
-jkoshy 
-Future Work 
-[Add APIs to allow creation of ar(1) archives](/apps/trac/elftoolchain/ticket/15)
-
-[#275](/apps/trac/elftoolchain/ticket/275)
-accepted 
-jkoshy 
-Future Work 
-[Track down the origin of ELFOSABI_ARM, ELFOSABI_HURD, ELFOSABI_86OPEN and ELFOSABI_STANDALONE.](/apps/trac/elftoolchain/ticket/275)
-
-[#276](/apps/trac/elftoolchain/ticket/276)
-new 
-jkoshy 
-RELEASE_1_0 
-[Document the file format for ELF files in a manual page.](/apps/trac/elftoolchain/ticket/276)
-
-[#292](/apps/trac/elftoolchain/ticket/292)
-new 
-jkoshy 
-RELEASE_1_0 
-[Increase the level of detail in libelf's error reporting](/apps/trac/elftoolchain/ticket/292)
-
-[#350](/apps/trac/elftoolchain/ticket/350)
-accepted 
-jkoshy 
-Future Work 
-[build fails on ubuntu 11.04](/apps/trac/elftoolchain/ticket/350)
-
-[#409](/apps/trac/elftoolchain/ticket/409)
-new 
-jkoshy 
-RELEASE_1_0 
-[Fix the build of libelf on OpenBSD/amd64](/apps/trac/elftoolchain/ticket/409)
-
-[#429](/apps/trac/elftoolchain/ticket/429)
-accepted 
-jkoshy 
-RELEASE_1_0 
-[elf_newdata for SHR_NOBITS section doesn't set section's offset, size and align value](/apps/trac/elftoolchain/ticket/429)
-
-[#431](/apps/trac/elftoolchain/ticket/431)
-new 
-jkoshy 
-RELEASE_1_0 
-[Avoid "dead assignment" LLVM scan-build warnings (1)](/apps/trac/elftoolchain/ticket/431)

 ## References

libelf modified by Joseph Koshy

Joseph Koshy — Wed, 25 Dec 2013 07:30:45 -0000

libelf

libelf

The libelf library simplifies the task of creating portable and architecture-independent tools that read and write ELF files.

This implementation of libelf implements the full SVR4 ELF(3)/GELF(3) API set, along with a few minor extensions.

What's Available

An implementation of the ELF(3) API.
A TET based test suite for the ELF(3) API.
Comprehensive documentation in the form of manual pages (part of the source tree).
A tutorial introduction to libelf.

Implementation Status

API
Implementation
Manual Page
Test Cases
Comments

Error Handling

elf_errno()
Y
Y
Y

elf_errmsg()
Y
Y
Y

Initialization

elf_begin()
Y
Y
Y

elf_end()
Y
Y
Partial

elf_memory()
Y
Y
Y

Archive Access

elf_rand()
Y
Y
Partial

elf_next()
Y
Y
Y

elf_getarsym()
Y
Y
Y

elf_getarhdr()
Y
Y
Y

ELF Class/Byte order Translation

elf32_xlatetof()
Y
Y
Y

elf32_xlatetom()
Y
Y
Y

elf64_xlatetof()
Y
Y
Y

elf64_xlatetom()
Y
Y
Y

gelf_xlatetof()
Y
Y
Y

gelf_xlatetom()
Y
Y
Y

General Queries

elf_getbase()
Y
Y
Y

elf_getident()
Y
Y
Y

elf_getphdrnum()
Y
Y

elf_getphnum()
Y
Y
Deprecated API. See [LibElfIncompatibilityRedHatElfUtils].

elf_getshdrnum()
Y
Y

elf_getshnum()
Y
Y
Y
Deprecated API. See [LibElfIncompatibilityRedHatElfUtils].

elf_getshdrstrndx()
Y
Y

elf_getshstrndx()
Y
Y
Y
Deprecated API. See [LibElfIncompatibilityRedHatElfUtils].

elf_hash()
Y
Y
Y

elf_kind()
Y
Y
Y

elf_ndxscn()
Y
Y
Y

elf_rawdata()
Y
Y

elf_rawfile()
Y
Y
Y

elf_version()
Y
Y
Y

elf32_checksum()
Y
Y

elf32_fsize()
Y
Y
Y

elf64_checksum()
Y
Y

elf64_fsize()
Y
Y
Y

gelf_checksum()
Y
Y

gelf_getclass()
Y
Y
Y

gelf_fsize()
Y
Y
Y

Elf Headers

elf32_getehdr()
Y
Y
Y

elf32_getphdr()
Y
Y
Y

elf32_getshdr()
Y
Y
Y

elf32_newehdr()
Y
Y
Y

elf32_newphdr()
Y
Y

elf64_getehdr()
Y
Y
Y

elf64_getphdr()
Y
Y
Y

elf64_newehdr()
Y
Y
Y

elf64_newphdr()
Y
Y

elf64_getshdr()
Y
Y
Y

gelf_getehdr()
Y
Y
Y

gelf_getphdr()
Y
Y

gelf_getshdr()
Y
Y

gelf_newehdr()
Y
Y
Y

gelf_newphdr()
Y
Y

gelf_update_ehdr()
Y
Y

gelf_update_phdr()
Y
Y

gelf_update_shdr()
Y
Y

Elf Sections

elf_getscn()
Y
Y
Y

elf_nextscn()
Y
Y
Y

elf_newscn()
Y
Y
Y

Elf Data

elf_fill()
Y
Y

elf_getdata()
Y
Y

elf_newdata()
Y
Y

elf_strptr()
Y
Y

gelf_getdyn()
Y
Y

gelf_getmove()
Y
Y

gelf_getrel()
Y
Y

gelf_getrela()
Y
Y

gelf_getsym()
Y
Y

gelf_getsyminfo()
Y
Y

gelf_getsymshndx()
Y
Y

gelf_update_dyn()
Y
Y

gelf_update_move()
Y
Y

gelf_update_rel()
Y
Y

gelf_update_rela()
Y
Y

gelf_update_sym()
Y
Y

gelf_update_syminfo()
Y
Y

gelf_update_symshndx()
Y
Y

I/O Control

elf_cntl()
Y
Y
Y

elf_flagdata()
Y
Y
Y

elf_flagehdr()
Y
Y
Y

elf_flagphdr()
Y
Y
Y

elf_flagscn()
Y
Y
Y

elf_flagshdr()
Y
Y
Y

elf_update()
Y
Y
Y

API Extensions

elf_add_member()
See [LibElfArchiveCreation]

elf_add_symtab()
See [LibElfArchiveCreation]

elf_flagarhdr()
Y
Y
See [LibElfArchiveCreation]

elf_open()
Y

elf_openmember()
Y

elf_setshstrndx()
Y
Y

Portability

Extensions

Extensions for creating ar(1) archives.

Incompatibilities

Known incompatibilities with other ELF(3) implementations.

Incompatibilities with older versions of Red Hat elfutils.

Open Tickets

Ticket Status Owner Milestone Summary

#7
new
jkoshy
RELEASE_1_0
Add ability to remove a section

#15
new
jkoshy
Future Work
Add APIs to allow creation of ar(1) archives

#275
accepted
jkoshy
Future Work
Track down the origin of ELFOSABI_ARM, ELFOSABI_HURD, ELFOSABI_86OPEN and ELFOSABI_STANDALONE.

#276
new
jkoshy
RELEASE_1_0
Document the file format for ELF files in a manual page.

#292
new
jkoshy
RELEASE_1_0
Increase the level of detail in libelf's error reporting

#350
accepted
jkoshy
Future Work
build fails on ubuntu 11.04

#409
new
jkoshy
RELEASE_1_0
Fix the build of libelf on OpenBSD/amd64

#429
accepted
jkoshy
RELEASE_1_0
elf_newdata for SHR_NOBITS section doesn't set section's offset, size and align value

#431
new
jkoshy
RELEASE_1_0
Avoid "dead assignment" LLVM scan-build warnings (1)

References

ELF gABI from SCO.
Linker and Libraries Guide from Sun Microsystems.
LibELF tutorial from Sun Microsystems.
ELF-64 Object File Format including HP and HP-UX extensions, from Hewlett-Packard.
LGPL'ed libelf(3) implementation by Michael Riepe.
An ELF library from the ERTOS project (doesn't implement the ELF(3) API).
Standards and specs: An unsung hero: The hardworking ELF. IBM Developerworks article by Peter Seebach.
Test Execution Toolkit from the Open Group.