com.oracle.objectfile.macho

Class MachOObjectFile

java.lang.Object

com.oracle.objectfile.ObjectFile

com.oracle.objectfile.macho.MachOObjectFile

public final class MachOObjectFile
extends ObjectFile

Models a Mach-O relocatable object file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MachOObjectFile.AbstractDylibCommand This abstract superclass models all load commands wrapping a struct dylib, namely MachOObjectFile.LoadDylibCommand and MachOObjectFile.IDDylibCommand (and, if we implement it, LoadWeakDylibCommand).
class	MachOObjectFile.DySymtabCommand Symtab load command.
static class	MachOObjectFile.FileType Mach-O file type.
class	MachOObjectFile.IDDylibCommand
class	MachOObjectFile.LinkEditSegment64Command We model the link edit segment as a separate class.
class	MachOObjectFile.LoadCommand Abstract super class of all load commands.
static class	MachOObjectFile.LoadCommandKind This enum defines an element for every defined value for 'cmd', i.e.
class	MachOObjectFile.LoadDylibCommand
class	MachOObjectFile.MachOSection
class	MachOObjectFile.RPathCommand
static class	MachOObjectFile.SectionFlag
static class	MachOObjectFile.SectionInfoStruct Section directory entries as held by a Segment64 load command.
static class	MachOObjectFile.SectionType
class	MachOObjectFile.Segment64Command
class	MachOObjectFile.SymtabCommand Symtab load command.
class	MachOObjectFile.UUIDCommand UUID load command.
static class	MachOObjectFile.VMProt

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
MachOObjectFile() Create an empty Mach-O object file.

Method Summary

Modifier and Type	Method and Description
void	addOpaqueLoadCommand(String name, MachOObjectFile.LoadCommandKind k, byte[] bs)
int	bake(List<ObjectFile.Element> sortedObjectFileElements)
ObjectFile.Symbol	createDefinedSymbol(String name, ObjectFile.Element baseSection, long position, int size, boolean isCode, boolean isGlobal)
protected ElementList	createElementList()
protected MachOObjectFile.LinkEditSegment64Command	createLinkEditSegment()
protected SymbolTable	createSymbolTable()
ObjectFile.Symbol	createUndefinedSymbol(String name, int size, boolean isCode)
ByteOrder	getByteOrder()
Set<com.oracle.objectfile.macho.MachOObjectFile.Flag>	getFlags()
ObjectFile.Format	getFormat()
ObjectFile.Header	getHeader() We override getHeader() since LoadCommands are also headers, so we do not have a unique Element satisfying instanceof Header.
MachOObjectFile.Segment64Command	getLinkEditSegment()
MachOObjectFile.LoadCommand	getLoadCommand(MachOObjectFile.LoadCommandKind k)
protected int	getMinimumFileSize()
protected MachOObjectFile.LinkEditSegment64Command	getOrCreateLinkEditSegment()
com.oracle.objectfile.macho.MachORelocationElement	getOrCreateRelocationElement(boolean useImplicitAddend)
protected MachOObjectFile.Segment64Command	getOrCreateSegment(String segmentNameOrNull, 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.
com.oracle.objectfile.macho.MachORelocationElement	getRelocationElement()
Set<ObjectFile.Segment>	getSegments()
MachOSymtab	getSymbolTable()
protected static String	getUnnamedSegmentName()
int	getWordSizeInBytes()
protected int	initialVaddr()
MachOZeroFillSection	newNobitsSection(ObjectFile.Segment segment, String name, ObjectFile.NobitsSectionImpl impl)
MachORegularSection	newProgbitsSection(ObjectFile.Segment segment, String name, int alignment, boolean writable, boolean executable, ObjectFile.ProgbitsSectionImpl impl)
MachOUserDefinedSection	newUserDefinedSection(ObjectFile.Segment segment, String name, int alignment, ElementImpl impl) Create a new section for holding user data.
void	setByteOrder(ByteOrder byteOrder)
void	setFlags(EnumSet<com.oracle.objectfile.macho.MachOObjectFile.Flag> flags)
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, basicDependencies, createRuntimeDebugInfo, decisionsByKind, defaultDecisions, defaultDependencies, defaultGetOrDecide, defaultGetOrDecideContent, defaultGetOrDecideOffset, defaultGetOrDecideSize, defaultGetOrDecideVaddr, elementForName, elementsCanSharePage, elementsMappedOnPage, findSegmentByName, flagSetAsLong, flagSetFromLong, getDecisionsByElement, getDecisionsTaken, getElements, getFilenameSuffix, getHostPageSize, getNativeFormat, getNativeObjectFile, getOffsetBootstrapElement, getOrCreateSymbolTable, getPageSize, getPageSizeShift, getSections, greatestCommonDivisor, 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

Constructor Detail

MachOObjectFile

public MachOObjectFile()

Create an empty Mach-O object file.

Method Detail

getFormat

public ObjectFile.Format getFormat()

Specified by:

getFormat in class ObjectFile

getUnnamedSegmentName

protected static String getUnnamedSegmentName()

createElementList

protected ElementList createElementList()

Overrides:

createElementList 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

setMainEntryPoint

public void setMainEntryPoint(String name)

Specified by:

setMainEntryPoint in class ObjectFile

initialVaddr

protected int initialVaddr()

Overrides:

initialVaddr in class ObjectFile

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

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 MachOObjectFile.Segment64Command getOrCreateSegment(String segmentNameOrNull,
                                                              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:

segmentNameOrNull - 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

newNobitsSection

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

Specified by:

newNobitsSection in class ObjectFile

newProgbitsSection

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

Specified by:

newProgbitsSection in class ObjectFile

newUserDefinedSection

public MachOUserDefinedSection 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

getLoadCommand

public MachOObjectFile.LoadCommand getLoadCommand(MachOObjectFile.LoadCommandKind k)

getLinkEditSegment

public MachOObjectFile.Segment64Command getLinkEditSegment()

getRelocationElement

public com.oracle.objectfile.macho.MachORelocationElement getRelocationElement()

getOrCreateRelocationElement

public com.oracle.objectfile.macho.MachORelocationElement getOrCreateRelocationElement(boolean useImplicitAddend)

getSegments

public Set<ObjectFile.Segment> getSegments()

Specified by:

getSegments in class ObjectFile

getHeader

public ObjectFile.Header getHeader()

We override getHeader() since LoadCommands are also headers, so we do not have a unique Element satisfying instanceof Header. (For the reason why LoadCommands are headers, see com.oracle.svm.debug.sections.CustomRelocationSectionImpl.getDependencies().)

Overrides:

getHeader in class ObjectFile

Returns:

a platform-dependent ObjectFile.Header. Depending on the mode of the object file (read or write), the header is newly created or read from the buffer.

getMinimumFileSize

protected int getMinimumFileSize()

Specified by:

getMinimumFileSize in class ObjectFile

bake

public int bake(List<ObjectFile.Element> sortedObjectFileElements)

Overrides:

bake in class ObjectFile

getFlags

public Set<com.oracle.objectfile.macho.MachOObjectFile.Flag> getFlags()

setFlags

public void setFlags(EnumSet<com.oracle.objectfile.macho.MachOObjectFile.Flag> flags)

getOrCreateLinkEditSegment

protected MachOObjectFile.LinkEditSegment64Command getOrCreateLinkEditSegment()

createLinkEditSegment

protected MachOObjectFile.LinkEditSegment64Command createLinkEditSegment()

createSymbolTable

protected SymbolTable createSymbolTable()

Specified by:

createSymbolTable in class ObjectFile

getSymbolTable

public MachOSymtab getSymbolTable()

Specified by:

getSymbolTable in class ObjectFile

addOpaqueLoadCommand

public void addOpaqueLoadCommand(String name,
                                 MachOObjectFile.LoadCommandKind k,
                                 byte[] bs)