com.oracle.objectfile

Interface ElementImpl

All Known Subinterfaces:

ObjectFile.NobitsSectionImpl, ObjectFile.ProgbitsSectionImpl, ObjectFile.RelocatableSectionImpl

All Known Implementing Classes:

BasicElementImpl, BasicNobitsSectionImpl, BasicProgbitsSectionImpl, CVSymbolSectionImpl, CVTypeSectionImpl, DwarfAbbrevSectionImpl, DwarfARangesSectionImpl, DwarfFrameSectionImpl, DwarfFrameSectionImplAArch64, DwarfFrameSectionImplX86_64, DwarfInfoSectionImpl, DwarfLineSectionImpl, DwarfSectionImpl, DwarfStrSectionImpl, ELFNobitsSection, ELFObjectFile.ELFHeader, ELFObjectFile.ELFSection, ELFObjectFile.SectionHeaderStrtab, ELFObjectFile.SectionHeaderTable, ELFProgbitsSection, ELFRelocationSection, ELFStrtab, ELFSymtab, ELFUserDefinedSection, MachOObjectFile.AbstractDylibCommand, MachOObjectFile.DySymtabCommand, MachOObjectFile.IDDylibCommand, MachOObjectFile.LinkEditSegment64Command, MachOObjectFile.LoadCommand, MachOObjectFile.LoadDylibCommand, MachOObjectFile.MachOSection, MachOObjectFile.RPathCommand, MachOObjectFile.Segment64Command, MachOObjectFile.SymtabCommand, MachOObjectFile.UUIDCommand, MachORegularSection, MachOStrtab, MachOSymtab, MachOUserDefinedSection, MachOZeroFillSection, ObjectFile.Element, ObjectFile.Header, ObjectFile.Section, PECoffNobitsSection, PECoffObjectFile.PECoffDirectiveSection, PECoffObjectFile.PECoffHeader, PECoffObjectFile.PECoffSection, PECoffObjectFile.SectionHeaderTable, PECoffProgbitsSection, PECoffRelocationTable, PECoffSymtab, PECoffUserDefinedSection, StringSectionImpl

public interface ElementImpl

Clients defining their own kinds of section typically want to do so in a way that is agnostic w.r.t. ELF, Mach-O or other object file formats. Each object file class has a corresponding "user-defined section" class, and these sections' implementations delegate to an ElementImpl. A single ElementImpl interface suffices for all classes of object file. Therefore, by implementing this interface, clients can breaks out of the ELF/Mach-O/... class hierarchy and implement common functionality (e.g. DWARF debugging sections) in a format-agnostic way.

Method Summary

Modifier and Type	Method and Description
int	getAlignment()
LayoutDecisionMap	getDecisions(LayoutDecisionMap copyingIn)
Iterable<BuildDependency>	getDependencies(Map<ObjectFile.Element,LayoutDecisionMap> decisions) Implementing this method allows to declare dependencies to other Sections (i.e.
ObjectFile.Element	getElement()
int	getMemSize(Map<ObjectFile.Element,LayoutDecisionMap> alreadyDecided) Implement this method to provide the section size in memory (at runtime).
byte[]	getOrDecideContent(Map<ObjectFile.Element,LayoutDecisionMap> alreadyDecided, byte[] contentHint) Implement this method to deliver the content of the section.
int	getOrDecideOffset(Map<ObjectFile.Element,LayoutDecisionMap> alreadyDecided, int offsetHint) Implement this method to provide the offset this section should be placed at.
int	getOrDecideSize(Map<ObjectFile.Element,LayoutDecisionMap> alreadyDecided, int sizeHint) Implement this method to provide the size of this section.
int	getOrDecideVaddr(Map<ObjectFile.Element,LayoutDecisionMap> alreadyDecided, int vaddrHint) Implement this method to provide the virtual address of this section.
boolean	isLoadable() Whether this section is loaded into memory at runtime.
boolean	isReferenceable() Locations in this section are referenceable by symbol names, section names, or by relocation, so the section needs a virtual address.
void	setElement(ObjectFile.Element e)

Method Detail

getDependencies

Iterable<BuildDependency> getDependencies(Map<ObjectFile.Element,LayoutDecisionMap> decisions)

Implementing this method allows to declare dependencies to other Sections (i.e. information about other sections needed to construct this section). The information will be used to construct the buildOrder in ObjectFile.writeInternal(). A good example can be found at: ELFObjectFile.ProgramHeaderTable.getDependencies

getOrDecideOffset

int getOrDecideOffset(Map<ObjectFile.Element,LayoutDecisionMap> alreadyDecided,
                      int offsetHint)

Implement this method to provide the offset this section should be placed at.

getOrDecideSize

int getOrDecideSize(Map<ObjectFile.Element,LayoutDecisionMap> alreadyDecided,
                    int sizeHint)

Implement this method to provide the size of this section.

getOrDecideContent

byte[] getOrDecideContent(Map<ObjectFile.Element,LayoutDecisionMap> alreadyDecided,
                          byte[] contentHint)

Implement this method to deliver the content of the section.

getOrDecideVaddr

int getOrDecideVaddr(Map<ObjectFile.Element,LayoutDecisionMap> alreadyDecided,
                     int vaddrHint)

Implement this method to provide the virtual address of this section. For loadable sections, this is where the section is expected to be mapped to at runtime (see ElementImpl.isLoadable()).

getMemSize

int getMemSize(Map<ObjectFile.Element,LayoutDecisionMap> alreadyDecided)

Implement this method to provide the section size in memory (at runtime).

getDecisions

LayoutDecisionMap getDecisions(LayoutDecisionMap copyingIn)

getElement

ObjectFile.Element getElement()

setElement

void setElement(ObjectFile.Element e)

getAlignment

int getAlignment()

isLoadable

boolean isLoadable()

Whether this section is loaded into memory at runtime.

isReferenceable

boolean isReferenceable()

Locations in this section are referenceable by symbol names, section names, or by relocation, so the section needs a virtual address. Generally applies to loadable sections, but can also be used to enable references into sections that are not loadable, such as debug sections.