com.oracle.objectfile.pecoff

Class PECoffObjectFile

java.lang.Object

com.oracle.objectfile.ObjectFile

com.oracle.objectfile.pecoff.PECoffObjectFile

public class PECoffObjectFile
extends ObjectFile

Represents a PECoff object file. The main job of this class is to maintain the essential structure of an PECoff file, meaning its header, section table, symbols and symbol table and relocation table. File output order: HEADER, SECTION TABLES, DATA FOR EACH SECTION, RELOCATION TABLE, SYMBOL TABLE & STRING TABLE [TODO]: Fix section alignment in SectionHeaderTable.getOrDecideContent Currently hard coded at 16. Fix relocation offset calculation in PECoffRelocationTable.getOffset().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PECoffObjectFile.PECoffDirectiveSection
class	PECoffObjectFile.PECoffHeader Representation of an PECoff binary header.
class	PECoffObjectFile.PECoffSection
static class	PECoffObjectFile.PECoffSectionFlag
class	PECoffObjectFile.SectionHeaderTable PECoff's section header table "sht" is an Element which describes the file Sections.

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 inherited from class com.oracle.objectfile.ObjectFile

elements, nameForElement

Constructor Summary

Constructors

Constructor and Description
PECoffObjectFile(int pageSize)

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 PECoffSymtab	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.
ByteOrder	getByteOrder()
ObjectFile.Format	getFormat()
int	getIndexForSection(PECoffObjectFile.PECoffSection s)
PECoffMachine	getMachine()
protected int	getMinimumFileSize()
PECoffRelocationTable	getOrCreateRelocSection(PECoffSymtab 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.
List<PECoffObjectFile.PECoffSection>	getPECoffSections()
PECoffRelocationTable	getRelocationTable()
PECoffObjectFile.PECoffSection	getSectionByIndex(int i)
Set<ObjectFile.Segment>	getSegments()
SymbolTable	getSymbolTable()
static ByteOrder	getTargetByteOrder()
int	getWordSizeInBytes()
void	installDebugInfo(DebugInfoProvider debugInfoProvider) API method provided to allow a native image generator to provide details of types, code and heap data inserted into a native image.
ObjectFile.Section	newDebugSection(String name, ElementImpl impl)
PECoffNobitsSection	newNobitsSection(ObjectFile.Segment segment, String name, ObjectFile.NobitsSectionImpl impl)
PECoffProgbitsSection	newProgbitsSection(ObjectFile.Segment segment, String name, int alignment, boolean writable, boolean executable, ObjectFile.ProgbitsSectionImpl impl)
PECoffUserDefinedSection	newUserDefinedSection(ObjectFile.Segment segment, String name, int alignment, ElementImpl impl) Create a new section for holding user data.
void	setByteOrder(ByteOrder byteorder)
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, debugContext, decisionsByKind, defaultDecisions, defaultDependencies, defaultGetOrDecide, defaultGetOrDecideContent, defaultGetOrDecideOffset, defaultGetOrDecideSize, defaultGetOrDecideVaddr, elementForName, elementsMappedOnPage, findSegmentByName, flagSetAsLong, flagSetFromLong, getDecisionsByElement, getDecisionsTaken, getElements, getFilenameSuffix, getHeader, getNativeFormat, getNativeObjectFile, getOffsetBootstrapElement, getOrCreateSymbolTable, getPageSize, getPageSizeShift, getSections, greatestCommonDivisor, initialVaddr, lowestCommonMultiple, maximalDecisionValues, minimalDecisionValues, minimalDependencies, nameForElement, newNobitsSection, newProgbitsSection, newUserDefinedSection, nextAvailableOffset, nextAvailableVaddr, nextIntegerMultiple, nextIntegerMultipleWithCongruence, roundUpToPageSize, sortedDecisionValues, withDebugContext, write, writeBuffer

Methods inherited from class java.lang.Object

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

Constructor Detail

PECoffObjectFile

public PECoffObjectFile(int pageSize)

Method Detail

getFormat

public ObjectFile.Format getFormat()

Specified by:

getFormat in class ObjectFile

createSymbolTable

protected PECoffSymtab 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 PECoffUserDefinedSection 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 PECoffProgbitsSection newProgbitsSection(ObjectFile.Segment segment,
                                                String name,
                                                int alignment,
                                                boolean writable,
                                                boolean executable,
                                                ObjectFile.ProgbitsSectionImpl impl)

Specified by:

newProgbitsSection in class ObjectFile

newNobitsSection

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

Specified by:

newNobitsSection in class ObjectFile

getSectionByIndex

public PECoffObjectFile.PECoffSection getSectionByIndex(int i)

getIndexForSection

public int getIndexForSection(PECoffObjectFile.PECoffSection 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

getPECoffSections

public List<PECoffObjectFile.PECoffSection> getPECoffSections()

getSegments

public Set<ObjectFile.Segment> getSegments()

Specified by:

getSegments in class ObjectFile

getByteOrder

public ByteOrder getByteOrder()

Specified by:

getByteOrder in class ObjectFile

setByteOrder

public void setByteOrder(ByteOrder byteorder)

Specified by:

setByteOrder in class ObjectFile

getTargetByteOrder

public static ByteOrder getTargetByteOrder()

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 PECoffMachine getMachine()

getOrCreateRelocSection

public PECoffRelocationTable getOrCreateRelocSection(PECoffSymtab syms,
                                                     boolean withExplicitAddends)

getSymbolTable

public SymbolTable getSymbolTable()

Specified by:

getSymbolTable in class ObjectFile

getRelocationTable

public PECoffRelocationTable getRelocationTable()

getMinimumFileSize

protected int getMinimumFileSize()

Specified by:

getMinimumFileSize in class ObjectFile

newDebugSection

public ObjectFile.Section newDebugSection(String name,
                                          ElementImpl impl)

Overrides:

newDebugSection in class ObjectFile

installDebugInfo

public void installDebugInfo(DebugInfoProvider debugInfoProvider)

Description copied from class: ObjectFile

API method provided to allow a native image generator to provide details of types, code and heap data inserted into a native image.

Overrides:

installDebugInfo in class ObjectFile

Parameters:

debugInfoProvider - an implementation of the provider interface that communicates details of the relevant types, code and heap data.