com.oracle.objectfile.elf

Class ELFObjectFile

java.lang.Object

com.oracle.objectfile.ObjectFile

com.oracle.objectfile.elf.ELFObjectFile

public class ELFObjectFile
extends ObjectFile

Represents an ELF object file (of any kind: relocatable, shared library, executable, core, ...). The main job of this class is to maintain the essential structure of an ELF file, meaning its header, section header table, shstrtab, and (if present) program header table. Note that header tables are neither headers nor sections, but since they have dependencies, they are Elements.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ELFObjectFile.ELFClass File class: 32 or 64 bit.
static class	ELFObjectFile.ELFEncoding Encoding: little endian or big endian.
class	ELFObjectFile.ELFHeader Representation of an ELF binary header.
static class	ELFObjectFile.ELFOsAbi ABI encoding.
class	ELFObjectFile.ELFSection
static class	ELFObjectFile.ELFSectionFlag
static class	ELFObjectFile.ELFSegmentFlag
static class	ELFObjectFile.ELFType ELF file type.
protected class	ELFObjectFile.SectionHeaderStrtab This class implements the shstrtab section.
class	ELFObjectFile.SectionHeaderTable ELF's section header table (SHT) is an element which indexes and summarises the contents of the file.
static class	ELFObjectFile.SectionType ELF section type.
static class	ELFObjectFile.SegmentType

Nested classes/interfaces inherited from class com.oracle.objectfile.ObjectFile

ObjectFile.Element, ObjectFile.ElementComparatorByDecidedOffset, ObjectFile.Format, ObjectFile.Header, ObjectFile.IntegerDecisionComparator, ObjectFile.NobitsSectionImpl, ObjectFile.ProgbitsSectionImpl, ObjectFile.RelocatableSectionImpl, ObjectFile.RelocationKind, ObjectFile.RelocationMethod, ObjectFile.RelocationRecord, ObjectFile.RelocationSiteInfo, ObjectFile.Section, ObjectFile.Segment, ObjectFile.SizeTiebreakComparator, ObjectFile.Symbol, ObjectFile.ValueEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	IDENT_LENGTH
static char[]	IDENT_MAGIC
protected ELFObjectFile.ELFSection	interp

Fields inherited from class com.oracle.objectfile.ObjectFile

elements, nameForElement

Constructor Summary

Constructors

Constructor and Description
ELFObjectFile()
ELFObjectFile(boolean runtimeDebugInfoGeneration)
ELFObjectFile(ELFMachine machine)
ELFObjectFile(ELFMachine machine, boolean runtimeDebugInfoGeneration)

Method Summary

Modifier and Type	Method and Description
ObjectFile.Symbol	createDefinedSymbol(String name, ObjectFile.Element baseSection, long position, int size, boolean isCode, boolean isGlobal)
protected ELFSymtab	createSymbolTable()
ObjectFile.Symbol	createUndefinedSymbol(String name, int size, boolean isCode)
protected boolean	elementsCanSharePage(ObjectFile.Element s1, ObjectFile.Element s2, int off1, int off2) Returns whether, according to the semantics of the object file, two sections could reasonably both be placed (partially) on the same page-sized region of virtual memory.
int	getAbiVersion()
ByteOrder	getByteOrder()
ELFObjectFile.ELFEncoding	getDataEncoding()
ELFObjectFile.ELFClass	getFileClass()
long	getFlags()
ObjectFile.Format	getFormat()
int	getIndexForSection(ELFObjectFile.ELFSection s)
ELFMachine	getMachine()
protected int	getMinimumFileSize()
ELFRelocationSection	getOrCreateDynamicRelocSection(ELFSymtab syms, boolean withExplicitAddends)
ELFRelocationSection	getOrCreateRelocSection(ELFUserDefinedSection elfUserDefinedSection, ELFSymtab syms, boolean withExplicitAddends)
protected ObjectFile.Segment	getOrCreateSegment(String maybeSegmentName, String sectionName, boolean writable, boolean executable) Return a Segment object which is appropriate for containing a section of the given name, if such a segment is mandatory according to the object file format specification.
ELFObjectFile.ELFOsAbi	getOsAbi()
ELFObjectFile.ELFSection	getSectionByIndex(int i)
Set<ObjectFile.Segment>	getSegments()
SymbolTable	getSymbolTable()
char	getVersion()
int	getWordSizeInBytes()
ELFNobitsSection	newNobitsSection(ObjectFile.Segment segment, String name, ObjectFile.NobitsSectionImpl impl)
ELFProgbitsSection	newProgbitsSection(ObjectFile.Segment segment, String name, int alignment, boolean writable, boolean executable, ObjectFile.ProgbitsSectionImpl impl)
ELFUserDefinedSection	newUserDefinedSection(ObjectFile.Segment segment, String name, int alignment, ElementImpl impl) Create a new section for holding user data.
void	setByteOrder(ByteOrder byteOrder)
void	setFileClass(ELFObjectFile.ELFClass fileClass)
void	setMachine(ELFMachine machine)
void	setMainEntryPoint(String name)
boolean	shouldRecordDebugRelocations() Determines whether references between debug sections should be recorded for relocation.

Methods inherited from class com.oracle.objectfile.ObjectFile

allDecisions, bake, basicDependencies, createElementList, createRuntimeDebugInfo, decisionsByKind, defaultDecisions, defaultDependencies, defaultGetOrDecide, defaultGetOrDecideContent, defaultGetOrDecideOffset, defaultGetOrDecideSize, defaultGetOrDecideVaddr, elementForName, elementsMappedOnPage, findSegmentByName, flagSetAsLong, flagSetFromLong, getDecisionsByElement, getDecisionsTaken, getElements, getFilenameSuffix, getHeader, getHostPageSize, getNativeFormat, getNativeObjectFile, getOffsetBootstrapElement, getOrCreateSymbolTable, getPageSize, getPageSizeShift, getSections, greatestCommonDivisor, initialVaddr, lowestCommonMultiple, maximalDecisionValues, minimalDecisionValues, minimalDependencies, nameForElement, newDebugSection, newNobitsSection, newProgbitsSection, newUserDefinedSection, nextAvailableOffset, nextAvailableVaddr, nextIntegerMultiple, nextIntegerMultipleWithCongruence, roundUpToPageSize, setPageSize, sortedDecisionValues, write, writeBuffer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IDENT_LENGTH

public static final int IDENT_LENGTH

See Also:

Constant Field Values

IDENT_MAGIC

public static final char[] IDENT_MAGIC

interp

protected ELFObjectFile.ELFSection interp

Constructor Detail

ELFObjectFile

public ELFObjectFile(ELFMachine machine,
                     boolean runtimeDebugInfoGeneration)

ELFObjectFile

public ELFObjectFile(ELFMachine machine)

ELFObjectFile

public ELFObjectFile()

ELFObjectFile

public ELFObjectFile(boolean runtimeDebugInfoGeneration)

Method Detail

getFormat

public ObjectFile.Format getFormat()

Specified by:

getFormat in class ObjectFile

setFileClass

public void setFileClass(ELFObjectFile.ELFClass fileClass)

setMainEntryPoint

public void setMainEntryPoint(String name)

Specified by:

setMainEntryPoint in class ObjectFile

createSymbolTable

protected ELFSymtab createSymbolTable()

Specified by:

createSymbolTable in class ObjectFile

createDefinedSymbol

public ObjectFile.Symbol createDefinedSymbol(String name,
                                             ObjectFile.Element baseSection,
                                             long position,
                                             int size,
                                             boolean isCode,
                                             boolean isGlobal)

Specified by:

createDefinedSymbol in class ObjectFile

createUndefinedSymbol

public ObjectFile.Symbol createUndefinedSymbol(String name,
                                               int size,
                                               boolean isCode)

Specified by:

createUndefinedSymbol in class ObjectFile

getOrCreateSegment

protected ObjectFile.Segment getOrCreateSegment(String maybeSegmentName,
                                                String sectionName,
                                                boolean writable,
                                                boolean executable)

Description copied from class: ObjectFile

Return a Segment object which is appropriate for containing a section of the given name, if such a segment is mandatory according to the object file format specification. Otherwise, return null.

Specified by:

getOrCreateSegment in class ObjectFile

Parameters:

maybeSegmentName - either null, or the name of a segment which the caller would prefer should contain the given section (in the case where multiple names would be possible for the created segment, so the choice would be ambiguous)

sectionName - a platform-dependent section name

writable - whether the segment contents should be writable

executable - whether the segment contents should be executable

Returns:

the segment object, or null if no such segment is necessary

newUserDefinedSection

public ELFUserDefinedSection newUserDefinedSection(ObjectFile.Segment segment,
                                                   String name,
                                                   int alignment,
                                                   ElementImpl impl)

Description copied from class: ObjectFile

Create a new section for holding user data. By default this creates a "regular" a.k.a. "progbits" section, that actually contains data. The object returned is an instance of some format-specific class, taking care of format details. The format-agnostic behavior of the section is specified by an ElementImpl which the user supplies.

Specified by:

newUserDefinedSection in class ObjectFile

Returns:

a Section

newProgbitsSection

public ELFProgbitsSection newProgbitsSection(ObjectFile.Segment segment,
                                             String name,
                                             int alignment,
                                             boolean writable,
                                             boolean executable,
                                             ObjectFile.ProgbitsSectionImpl impl)

Specified by:

newProgbitsSection in class ObjectFile

newNobitsSection

public ELFNobitsSection newNobitsSection(ObjectFile.Segment segment,
                                         String name,
                                         ObjectFile.NobitsSectionImpl impl)

Specified by:

newNobitsSection in class ObjectFile

getSectionByIndex

public ELFObjectFile.ELFSection getSectionByIndex(int i)

getIndexForSection

public int getIndexForSection(ELFObjectFile.ELFSection s)

elementsCanSharePage

protected boolean elementsCanSharePage(ObjectFile.Element s1,
                                       ObjectFile.Element s2,
                                       int off1,
                                       int off2)

Description copied from class: ObjectFile

Returns whether, according to the semantics of the object file, two sections could reasonably both be placed (partially) on the same page-sized region of virtual memory. Usually this means accounting for segment-level permissions/flags, as well as the physical layout of the file.

Overrides:

elementsCanSharePage in class ObjectFile

Parameters:

s1 - one section

s2 - another section

getSegments

public Set<ObjectFile.Segment> getSegments()

Specified by:

getSegments in class ObjectFile

getDataEncoding

public ELFObjectFile.ELFEncoding getDataEncoding()

getByteOrder

public ByteOrder getByteOrder()

Specified by:

getByteOrder in class ObjectFile

setByteOrder

public void setByteOrder(ByteOrder byteOrder)

Specified by:

setByteOrder in class ObjectFile

getVersion

public char getVersion()

getOsAbi

public ELFObjectFile.ELFOsAbi getOsAbi()

getAbiVersion

public int getAbiVersion()

getFileClass

public ELFObjectFile.ELFClass getFileClass()

getWordSizeInBytes

public int getWordSizeInBytes()

Specified by:

getWordSizeInBytes in class ObjectFile

shouldRecordDebugRelocations

public boolean shouldRecordDebugRelocations()

Description copied from class: ObjectFile

Determines whether references between debug sections should be recorded for relocation.

Specified by:

shouldRecordDebugRelocations in class ObjectFile

getMachine

public ELFMachine getMachine()

setMachine

public void setMachine(ELFMachine machine)

getFlags

public long getFlags()

getOrCreateDynamicRelocSection

public ELFRelocationSection getOrCreateDynamicRelocSection(ELFSymtab syms,
                                                           boolean withExplicitAddends)

getOrCreateRelocSection

public ELFRelocationSection getOrCreateRelocSection(ELFUserDefinedSection elfUserDefinedSection,
                                                    ELFSymtab syms,
                                                    boolean withExplicitAddends)

getSymbolTable

public SymbolTable getSymbolTable()

Specified by:

getSymbolTable in class ObjectFile

getMinimumFileSize

protected int getMinimumFileSize()

Specified by:

getMinimumFileSize in class ObjectFile