com.oracle.objectfile.elf.dwarf

Class DwarfSectionImpl

java.lang.Object

com.oracle.objectfile.BasicElementImpl

com.oracle.objectfile.BasicProgbitsSectionImpl

com.oracle.objectfile.elf.dwarf.DwarfSectionImpl

All Implemented Interfaces:

ElementImpl, ObjectFile.ProgbitsSectionImpl, ObjectFile.RelocatableSectionImpl

Direct Known Subclasses:

DwarfAbbrevSectionImpl, DwarfARangesSectionImpl, DwarfFrameSectionImpl, DwarfInfoSectionImpl, DwarfLineSectionImpl, DwarfStrSectionImpl

public abstract class DwarfSectionImpl
extends BasicProgbitsSectionImpl

A class from which all DWARF debug sections inherit providing common behaviours.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	debug
protected long	debugAddress
protected int	debugBase
protected long	debugTextBase
protected DwarfDebugInfo	dwarfSections
protected static byte[]	scratch A scratch buffer used during computation of a section's size.

Constructor Summary

Constructors

Constructor and Description
DwarfSectionImpl(DwarfDebugInfo dwarfSections)

Method Summary

Modifier and Type	Method and Description
boolean	contentByteArrayCreated() Check whether the contents byte array has been sized and created.
abstract void	createContent() Creates the target byte[] array used to define the section contents.
protected int	debugStringIndex(String str)
protected void	enableLog(org.graalvm.compiler.debug.DebugContext context, int pos)
protected int	getCUIndex(ClassEntry classEntry)
protected int	getDeoptCUIndex(ClassEntry classEntry)
Set<BuildDependency>	getDependencies(Map<ObjectFile.Element,LayoutDecisionMap> decisions) Implementing this method allows to declare dependencies to other Sections (i.e.
protected int	getFieldDeclarationIndex(StructureTypeEntry entry, String fieldName)
protected int	getIndirectLayoutIndex(ClassEntry classEntry)
protected int	getIndirectTypeIndex(String typeName)
protected int	getLayoutIndex(ClassEntry classEntry)
protected int	getLineIndex(ClassEntry classEntry)
protected int	getLinePrologueSize(ClassEntry classEntry)
protected int	getLineSectionSize(ClassEntry classEntry)
protected int	getMethodDeclarationIndex(ClassEntry classEntry, String methodName)
byte[]	getOrDecideContent(Map<ObjectFile.Element,LayoutDecisionMap> alreadyDecided, byte[] contentHint) Implement this method to deliver the content of the section.
int	getOrDecideSize(Map<ObjectFile.Element,LayoutDecisionMap> alreadyDecided, int sizeHint) Implement this method to provide the size of this section.
protected Iterable<? extends ClassEntry>	getPrimaryClasses()
abstract String	getSectionName() Identify this debug section by name.
protected int	getTypeIndex(String typeName)
protected Stream<? extends TypeEntry>	getTypes()
boolean	isAArch64()
boolean	isLoadable() Whether this section is loaded into memory at runtime.
protected boolean	littleEndian()
protected void	log(org.graalvm.compiler.debug.DebugContext context, String format, Object... args)
protected TypeEntry	lookupType(String typeName)
protected void	patchLength(int lengthPos, byte[] buffer, int pos)
protected int	putAsciiStringBytes(String s, byte[] buffer, int pos)
protected int	putAsciiStringBytes(String s, int startChar, byte[] buffer, int p)
protected int	putByte(byte b, byte[] buffer, int p)
protected int	putInt(int i, byte[] buffer, int p)
protected int	putLong(long l, byte[] buffer, int p)
protected int	putRelocatableCodeOffset(long l, byte[] buffer, int p)
protected int	putRelocatableHeapOffset(long l, byte[] buffer, int p)
protected int	putShort(short s, byte[] buffer, int p)
protected int	putSLEB(long val, byte[] buffer, int p)
protected int	putULEB(long val, byte[] buffer, int p)
protected void	setCUIndex(ClassEntry classEntry, int pos)
protected void	setDeoptCUIndex(ClassEntry classEntry, int pos)
protected void	setFieldDeclarationIndex(StructureTypeEntry entry, String fieldName, int pos)
protected void	setIndirectLayoutIndex(ClassEntry classEntry, int pos)
protected void	setIndirectTypeIndex(TypeEntry typeEntry, int pos)
protected void	setLayoutIndex(ClassEntry classEntry, int pos)
protected void	setLineIndex(ClassEntry classEntry, int pos)
protected void	setLinePrologueSize(ClassEntry classEntry, int pos)
protected void	setLineSectionSize(ClassEntry classEntry, int pos)
protected void	setMethodDeclarationIndex(ClassEntry classEntry, String methodName, int pos)
protected void	setTypeIndex(TypeEntry typeEntry, int pos)
abstract LayoutDecision.Kind[]	targetSectionKinds() Identify the layout properties of the target section which need to have been decided before the contents of this section can be created.
abstract String	targetSectionName() Identify the section after which this debug section needs to be ordered when sizing and creating content.
protected String	uniqueDebugString(String str)
protected void	verboseLog(org.graalvm.compiler.debug.DebugContext context, String format, Object... args)
protected int	writeAbbrevCode(long code, byte[] buffer, int pos)
protected int	writeAttrAddress(long address, byte[] buffer, int pos)
protected int	writeAttrData1(byte value, byte[] buffer, int pos)
protected int	writeAttrData2(short value, byte[] buffer, int pos)
protected int	writeAttrData4(int value, byte[] buffer, int pos)
protected int	writeAttrData8(long value, byte[] buffer, int pos)
protected int	writeAttrNull(byte[] buffer, int pos)
int	writeAttrRefAddr(int value, byte[] buffer, int p)
abstract void	writeContent(org.graalvm.compiler.debug.DebugContext debugContext) Populates the byte[] array used to contain the section contents.
protected int	writeFlag(byte flag, byte[] buffer, int pos)
protected int	writeTag(long code, byte[] buffer, int pos)

Methods inherited from class com.oracle.objectfile.BasicProgbitsSectionImpl

getAlignment, getContent, getElement, getElements, getMemSize, getOrCreateRelocationElement, markRelocationSite, markRelocationSite, setContent

Methods inherited from class com.oracle.objectfile.BasicElementImpl

getDecisions, getOrDecideOffset, getOrDecideVaddr, getOwner, isReferenceable, setElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.objectfile.ElementImpl

getDecisions, getOrDecideOffset, getOrDecideVaddr, isReferenceable, setElement

Field Detail

dwarfSections

protected DwarfDebugInfo dwarfSections

debug

protected boolean debug

debugTextBase

protected long debugTextBase

debugAddress

protected long debugAddress

debugBase

protected int debugBase

scratch

protected static final byte[] scratch

A scratch buffer used during computation of a section's size.

Constructor Detail

DwarfSectionImpl

public DwarfSectionImpl(DwarfDebugInfo dwarfSections)

Method Detail

isAArch64

public boolean isAArch64()

createContent

public abstract void createContent()

Creates the target byte[] array used to define the section contents. The main task of this method is to precompute the size of the debug section. given the complexity of the data layouts that invariably requires performing a dummy write of the contents, inserting bytes into a small, scratch buffer only when absolutely necessary. subclasses may also cache some information for use when writing the contents.

writeContent

public abstract void writeContent(org.graalvm.compiler.debug.DebugContext debugContext)

Populates the byte[] array used to contain the section contents. In most cases this task reruns the operations performed under createContent but this time actually writing data to the target byte[].

contentByteArrayCreated

public boolean contentByteArrayCreated()

Check whether the contents byte array has been sized and created. n.b. this does not imply that data has been written to the byte array.

Returns:

true if the contents byte array has been sized and created otherwise false.

isLoadable

public boolean isLoadable()

Description copied from interface: ElementImpl

Whether this section is loaded into memory at runtime.

Specified by:

isLoadable in interface ElementImpl

Overrides:

isLoadable in class BasicProgbitsSectionImpl

enableLog

protected void enableLog(org.graalvm.compiler.debug.DebugContext context,
                         int pos)

log

protected void log(org.graalvm.compiler.debug.DebugContext context,
                   String format,
                   Object... args)

verboseLog

protected void verboseLog(org.graalvm.compiler.debug.DebugContext context,
                          String format,
                          Object... args)

littleEndian

protected boolean littleEndian()

putByte

protected int putByte(byte b,
                      byte[] buffer,
                      int p)

putShort

protected int putShort(short s,
                       byte[] buffer,
                       int p)

putInt

protected int putInt(int i,
                     byte[] buffer,
                     int p)

putLong

protected int putLong(long l,
                      byte[] buffer,
                      int p)

putRelocatableCodeOffset

protected int putRelocatableCodeOffset(long l,
                                       byte[] buffer,
                                       int p)

putRelocatableHeapOffset

protected int putRelocatableHeapOffset(long l,
                                       byte[] buffer,
                                       int p)

putULEB

protected int putULEB(long val,
                      byte[] buffer,
                      int p)

putSLEB

protected int putSLEB(long val,
                      byte[] buffer,
                      int p)

putAsciiStringBytes

protected int putAsciiStringBytes(String s,
                                  byte[] buffer,
                                  int pos)

putAsciiStringBytes

protected int putAsciiStringBytes(String s,
                                  int startChar,
                                  byte[] buffer,
                                  int p)

patchLength

protected void patchLength(int lengthPos,
                           byte[] buffer,
                           int pos)

writeAbbrevCode

protected int writeAbbrevCode(long code,
                              byte[] buffer,
                              int pos)

writeTag

protected int writeTag(long code,
                       byte[] buffer,
                       int pos)

writeFlag

protected int writeFlag(byte flag,
                        byte[] buffer,
                        int pos)

writeAttrAddress

protected int writeAttrAddress(long address,
                               byte[] buffer,
                               int pos)

writeAttrData8

protected int writeAttrData8(long value,
                             byte[] buffer,
                             int pos)

writeAttrData4

protected int writeAttrData4(int value,
                             byte[] buffer,
                             int pos)

writeAttrData2

protected int writeAttrData2(short value,
                             byte[] buffer,
                             int pos)

writeAttrData1

protected int writeAttrData1(byte value,
                             byte[] buffer,
                             int pos)

writeAttrRefAddr

public int writeAttrRefAddr(int value,
                            byte[] buffer,
                            int p)

writeAttrNull

protected int writeAttrNull(byte[] buffer,
                            int pos)

targetSectionName

public abstract String targetSectionName()

Identify the section after which this debug section needs to be ordered when sizing and creating content.

Returns:

the name of the preceding section.

targetSectionKinds

public abstract LayoutDecision.Kind[] targetSectionKinds()

Identify the layout properties of the target section which need to have been decided before the contents of this section can be created.

Returns:

an array of the relevant decision kinds.

getSectionName

public abstract String getSectionName()

Identify this debug section by name.

Returns:

the name of the debug section.

getOrDecideSize

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

Description copied from interface: ElementImpl

Implement this method to provide the size of this section.

Specified by:

getOrDecideSize in interface ElementImpl

Overrides:

getOrDecideSize in class BasicProgbitsSectionImpl

getOrDecideContent

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

Description copied from interface: ElementImpl

Implement this method to deliver the content of the section.

Specified by:

getOrDecideContent in interface ElementImpl

Overrides:

getOrDecideContent in class BasicProgbitsSectionImpl

getDependencies

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

Description copied from interface: ElementImpl

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

Specified by:

getDependencies in interface ElementImpl

Overrides:

getDependencies in class BasicProgbitsSectionImpl

getTypes

protected Stream<? extends TypeEntry> getTypes()

getPrimaryClasses

protected Iterable<? extends ClassEntry> getPrimaryClasses()

debugStringIndex

protected int debugStringIndex(String str)

uniqueDebugString

protected String uniqueDebugString(String str)

lookupType

protected TypeEntry lookupType(String typeName)

getTypeIndex

protected int getTypeIndex(String typeName)

setTypeIndex

protected void setTypeIndex(TypeEntry typeEntry,
                            int pos)

getIndirectTypeIndex

protected int getIndirectTypeIndex(String typeName)

setIndirectTypeIndex

protected void setIndirectTypeIndex(TypeEntry typeEntry,
                                    int pos)

getCUIndex

protected int getCUIndex(ClassEntry classEntry)

setCUIndex

protected void setCUIndex(ClassEntry classEntry,
                          int pos)

getDeoptCUIndex

protected int getDeoptCUIndex(ClassEntry classEntry)

setDeoptCUIndex

protected void setDeoptCUIndex(ClassEntry classEntry,
                               int pos)

getLineIndex

protected int getLineIndex(ClassEntry classEntry)

setLineIndex

protected void setLineIndex(ClassEntry classEntry,
                            int pos)

getLineSectionSize

protected int getLineSectionSize(ClassEntry classEntry)

setLineSectionSize

protected void setLineSectionSize(ClassEntry classEntry,
                                  int pos)

getLinePrologueSize

protected int getLinePrologueSize(ClassEntry classEntry)

setLinePrologueSize

protected void setLinePrologueSize(ClassEntry classEntry,
                                   int pos)

getLayoutIndex

protected int getLayoutIndex(ClassEntry classEntry)

setIndirectLayoutIndex

protected void setIndirectLayoutIndex(ClassEntry classEntry,
                                      int pos)

getIndirectLayoutIndex

protected int getIndirectLayoutIndex(ClassEntry classEntry)

setLayoutIndex

protected void setLayoutIndex(ClassEntry classEntry,
                              int pos)

setFieldDeclarationIndex

protected void setFieldDeclarationIndex(StructureTypeEntry entry,
                                        String fieldName,
                                        int pos)

getFieldDeclarationIndex

protected int getFieldDeclarationIndex(StructureTypeEntry entry,
                                       String fieldName)

setMethodDeclarationIndex

protected void setMethodDeclarationIndex(ClassEntry classEntry,
                                         String methodName,
                                         int pos)

getMethodDeclarationIndex

protected int getMethodDeclarationIndex(ClassEntry classEntry,
                                        String methodName)