The UNIX COFF file format. More...

#include <coff.h>

Inheritance diagram for COFF::COFFFormat:

Classes
class	AOutHeader
	A standard 28 byte a.out optional header, used by DJGPP. More...

struct	CDOS68K_Relocation

class	COFFOptionCollector

class	ECOFFAOutHeader
	ECOFF optional header. More...

class	FlexOSAOutHeader
	Concurrent DOS 68K/FlexOS 386 optional header Concurrent DOS 68K uses the typical a.out header with two additional fields for the offset to relocations and the size of the stack. More...

class	GNUAOutHeader
	GNU a.out optional header TODO. More...

struct	MachineType

class	MIPSAOutHeader
	56 byte long header used on MIPS More...

class	OptionalHeader
	An abstract class to represent the optional header. More...

class	Relocation
	A generic COFF relocation. More...

class	Section
	A COFF section. More...

class	Symbol
	A COFF symbol. More...

class	UnknownOptionalHeader
	A simplified class to represent an optional header of unknown structure. More...

class	XCOFFAOutHeader
	XCOFF optional header. More...

Public Types
enum	cpu { CPU_UNKNOWN = 0 , CPU_I386 = 0x014C , CPU_M68K = 0x0150 , CPU_W65 = 0x6500 , CPU_Z80 = 0x805A , CPU_Z8K = 0x8000 , CPU_I86 = 0x0148 , CPU_I286 = 0x014A , CPU_NS32K = 0x0154 , CPU_I370 = 0x0158 , CPU_MIPS = 0x0160 , CPU_M88K = 0x016D , CPU_WE32K = 0x0170 , CPU_VAX = 0x0178 , CPU_AM29K = 0x017A , CPU_ALPHA = 0x0183 , CPU_PPC = 0x01DF , CPU_PPC64 = 0x01F7 , CPU_SHARC = 0x521C , CPU_C5400 = 0x0098 , CPU_C6000 = 0x0099 , CPU_C5500 = 0x009C , CPU_MSP430 = 0x00A0 , CPU_I860 = 0x014D , CPU_SH = 0x01A2 , CPU_ARM = 0x01C0 , CPU_AM33 = 0x01D3 , CPU_IA64 = 0x0200 , CPU_HPPA = 0x0290 , CPU_EFI = 0x0EBC , CPU_RISCV32 = 0x5032 , CPU_RISCV64 = 0x5064 , CPU_RISCV128 = 0x5128 , CPU_AMD64 = 0x8664 , CPU_M32R = 0x9041 , CPU_ARM64 = 0xAA64 }
	Represents the first 16-bit word of a COFF file. More...

enum	COFFVariantType { COFF = 1 , ECOFF = 2 , XCOFF32 = 3 , XCOFF64 = 4 , PECOFF = 5 , TICOFF = 6 , TICOFF1 = 7 }
	Variants of the COFF file format. More...

enum	relocation_format_type { COFF_10 , COFF_14 , COFF_16 , ECOFF_8 , ECOFF_16 , XCOFF_10 , XCOFF_14 , TICOFF_10 , TICOFF_12 }

enum	format_type { GENERIC , DJGPP , CDOS68K , CDOS386 , WINDOWS }
	Represents the type of target system, which will determine the CPU type and several other fields. More...

enum	{ FLAG_NO_RELOCATIONS = 0x0001 , FLAG_EXECUTABLE = 0x0002 , FLAG_NO_LINE_NUMBERS = 0x0004 , FLAG_NO_SYMBOLS = 0x0008 , FLAG_PDP11_ENDIAN = 0x0080 , FLAG_32BIT_LITTLE_ENDIAN = 0x0100 , FLAG_32BIT_BIG_ENDIAN = 0x0200 , OMAGIC = 0x0107 , NMAGIC = 0x0108 , ZMAGIC = 0x010B , MAGIC_FLEXOS386 = 0x01C0 }
	COFF file header flags, most of these are obsolete, we only use them as precombined flag sets. More...

Public Member Functions
::EndianType	GetEndianType () const
	Retrieves the natural byte order for the architecture.

constexpr size_t	GetRelocationEntrySize () const

void	Clear () override
	Resets all fields to their default values, deallocate memory.

void	AssignMagicValue (uint16_t value, ::EndianType as_endian_type)
	Loads the specified 16-bit integer in the specified byte order into the COFF header signature.

void	AssignMagicValue (uint16_t value)
	Loads the specified 16-bit integer in the currently set byte order into the COFF header signature.

void	AssignMagicValue ()
	Loads the currently set CPU value in the currently set byte order into the COFF header signature.

bool	DetectCpuType (::EndianType expected)

void	DetectCpuType ()

void	ReadFile (Linker::Reader &rd) override
	Loads file into memory.

offset_t	ImageSize () const override
	Retrieves size of stored data.

offset_t	WriteFile (Linker::Writer &wr) const override
	Stores data in memory to file.

void	Dump (Dumper::Dumper &dump) const override
	Display file contents in a nice manner.

void	SetupOptions (std::shared_ptr< Linker::OutputFormat > format) override
	Initializes the reader for linking purposes.

bool	FormatRequiresDataStreamFix () const override
	Whether the generated file might contain bugs that require fixing.

void	GenerateModule (Linker::Module &module) const override
	Loads the information into a module object, a convenience method when there is a single module generated.

	COFFFormat (format_type type=GENERIC, COFFVariantType coff_variant=COFF, EndianType endiantype=::UndefinedEndian)

unsigned	FormatAdditionalSectionFlags (std::string section_name) const override

std::vector< Linker::OptionDescription< void > * >	GetLinkerScriptParameterNames () override
	Returns a list of the parameters used in the linker scripts, used for documentation.

std::shared_ptr< Linker::OptionCollector >	GetOptions () override
	Returns object containing a sequence of option fields provided with the -S command line flag.

void	SetOptions (std::map< std::string, std::string > &options) override
	Passes command line parameters as settings over to format object.

void	OnNewSegment (std::shared_ptr< Linker::Segment > segment) override
	Callback function when allocating a new segment When the linker script runs, it creates segments consecutively. Overriding this method permits the output format to handle the allocated segment.

void	CreateDefaultSegments ()

std::unique_ptr< Script::List >	GetScript (Linker::Module &module)

void	Link (Linker::Module &module)

std::shared_ptr< Linker::Segment >	GetSegment (std::shared_ptr< Section > &section)
	Return the segment stored inside the section, note that this only works for binary generation.

std::shared_ptr< Linker::Segment >	GetCodeSegment ()

std::shared_ptr< Linker::Segment >	GetDataSegment ()

std::shared_ptr< Linker::Segment >	GetBssSegment ()

void	ProcessModule (Linker::Module &module) override
	Processes the module object and initializes format fields.

void	CalculateValues () override
	Intermediate step between processing module and generating output file to set up headers and management sections It is expected that after a module is processed, additional steps are required to evaluate the final values of the fields.

void	GenerateFile (std::string filename, Linker::Module &module) override
	The main function that handles processing, calculating and generating the final image.

std::string	GetDefaultExtension (Linker::Module &module, std::string filename) const override
	Appends a default extension to the filename.

Public Member Functions inherited from Linker::InputFormat
virtual void	ProduceModule (ModuleCollector &linker, Reader &rd, std::string file_name)
	Reads a file and loads the information into a module object.

virtual void	ProduceModule (Module &module, Reader &rd)
	Reads a file and loads the information into a module object, a convenience method when there is a single module generated.

virtual void	GenerateModule (ModuleCollector &linker, std::string file_name, bool is_library=false) const
	Loads the information into a module object.

virtual bool	FormatProvidesSegmentation () const
	Whether the format enables multiple x86 segments.

virtual bool	FormatProvidesResources () const
	Whether the format supports resources.

virtual bool	FormatProvidesLibraries () const
	Whether the format enables importing/exporting libraries.

Public Member Functions inherited from Linker::Format
	Format (offset_t file_offset=0)

offset_t	ImageSize () const override
	Retrieves size of stored data.

offset_t	WriteFile (Writer &wr, offset_t count, offset_t offset=0) const override
	Writes data of non-zero filled sections.

Public Member Functions inherited from Linker::Contents
virtual std::shared_ptr< const Image >	AsImage () const
	Retrieves a randomly accessible image.

std::shared_ptr< Image >	AsImage ()
	Retrieves a randomly accessible image.

Public Member Functions inherited from Linker::SegmentManager
void	ClearSegmentManager ()

void	SetLinkScript (std::string script_file, std::map< std::string, std::string > &options) override
	Sets up the linker script and linker parameters.

std::unique_ptr< Script::List >	GetScript (Module &module)
	Compiles the linker script into an internal format.

offset_t	GetCurrentAddress () const
	Retrieves current address pointer.

void	SetCurrentAddress (offset_t address)
	Moves the current address pointer further, and if the current segment already contains data, fill it up to the point.

void	AlignCurrentAddress (offset_t align)
	Aligns current address to alignment, using SetCurrentAddress.

void	SetLatestBase (offset_t address)
	Sets the base of the current section (the value from which offsets are counted from)

void	FinishCurrentSegment ()
	Closes the current segment, sets current_segment to null.

virtual void	OnCallDirective (std::string identifier)
	Callback function for the CALL directive.

std::shared_ptr< Segment >	AppendSegment (std::string name)
	Creates a new segment and attaches it to the image.

void	AppendSegment (std::shared_ptr< Segment > segment)
	Attaches the segment to the image.

std::shared_ptr< Segment >	FetchSegment (std::string name)
	Attempts to fetch a segment, returns null if not found.

void	AppendSection (std::shared_ptr< Section > section)
	Adds a new section to the current segment, sets the base to the same as the segment.

void	ProcessScript (std::unique_ptr< Script::List > &directives, Module &module)
	Executes a parsed linker script on a module and collects segments The function OnNewSegment can be defined to handle each newly allocated segment.

void	ProcessAction (std::unique_ptr< Script::Node > &action, Module &module)

void	PostProcessAction (std::unique_ptr< Script::Node > &action, Module &module)

void	ProcessCommand (std::unique_ptr< Script::Node > &command, Module &module)

bool	CheckPredicate (std::unique_ptr< Script::Node > &predicate, std::shared_ptr< Section > section, Module &module)

offset_t	EvaluateExpression (std::unique_ptr< Script::Node > &expression, Module &module)

Public Member Functions inherited from Linker::OutputFormat
virtual bool	AddSupplementaryOutputFormat (std::string subformat)
	If the output format actually drives multiple output formats (resource file, apple double, etc.), specify multiple types, return false if unknown.

virtual std::vector< OptionDescription< void > >	GetMemoryModelNames ()
	Returns a list of the supported memory models, used for documentation.

virtual std::vector< OptionDescription< void > >	GetSpecialSymbolNames ()
	Returns a list of special symbol names recognized by the format, used for documentation.

std::optional< std::string >	FetchOption (std::map< std::string, std::string > &options, std::string name)
	Convenience method to look up option by name.

std::string	FetchOption (std::map< std::string, std::string > &options, std::string name, std::string default_value)
	Convenience method to look up option by name, returning default value if name is missing.

std::optional< offset_t >	FetchIntegerOption (std::map< std::string, std::string > &options, std::string name)
	Convenience method to look up option by name and convert it to integer.

virtual void	SetModel (std::string model)
	Sets the way memory is organized, typically modifying a built-in script.

virtual std::string	GetDefaultExtension (Module &module) const
	Provides a default filename for the output file.

virtual bool	FormatSupportsSegmentation () const
	Whether the format supports multiple segments.

virtual bool	FormatIs16bit () const
	Whether the format is 16-bit or not.

virtual bool	FormatIsProtectedMode () const
	Whether the format is in protected mode or not (x86 only)

virtual bool	FormatIsLinear () const
	Whether the address space is linear or segmented.

virtual bool	FormatSupportsResources () const
	Whether the format supports resources.

virtual bool	FormatSupportsLibraries () const
	Whether the format supports libraries.

virtual void	AllocateSymbols (Module &module) const
	Instructs the module to allocate any unallocated local symbols.

Public Attributes
offset_t	file_size

char	signature [2] = { }
	The actual value of the magic number (COFF name: f_magic)

relocation_format_type	relocation_format

std::vector< std::shared_ptr< Section > >	sections
	The list of COFF sections.

uint16_t	section_count = 0
	Section count (COFF name: f_nscns)

uint32_t	timestamp = 0
	Time stamp, unused (COFF name: f_timdat)

offset_t	symbol_table_offset = 0
	Offset to the first symbol (COFF name: f_symptr)

uint32_t	symbol_count = 0
	The number of symbols (COFF name: f_nsyms)

std::vector< std::unique_ptr< Symbol > >	symbols
	The symbols stored inside the COFF file.

uint32_t	optional_header_size = 0
	The size of the optional header (COFF: f_opthdr)

uint16_t	flags = 0
	COFF flags, such as whether the file is executable (f_flags)

uint16_t	target = 0
	TI system target ID.

std::unique_ptr< OptionalHeader >	optional_header = nullptr
	The optional header instance used for reading/writing the COFF file.

std::map< uint32_t, CDOS68K_Relocation >	relocations
	Concurrent DOS 68K requires a special block of data to represent "crunched" relocations (see CPM68KWriter for more details)

COFFVariantType	coff_variant = AnyCOFFVariant

cpu	cpu_type = CPU_UNKNOWN
	The CPU type, reflected by the first 16-bit word of a COFF file.

::EndianType	endiantype = ::UndefinedEndian
	The byte order.

bool	option_segmentation = false

Microsoft::MZSimpleStubWriter	stub

format_type	type = GENERIC
	A representation of the format to generate.

bool	option_no_relocation = false
	Suppress relocation generation, only relevant for Concurrent DOS 68K, since the other target formats do not store relocations.

uint32_t	stub_size = 0
	Size of MZ stub, only used for DJGPP COFF executables.

std::shared_ptr< Linker::Segment >	stack
	Concurrent DOS 68K and FlexOS 386: The stack segment, not stored as part of any section.

uint32_t	entry_address = 0
	Entry address, gets stored in optional header later.

uint32_t	relocations_offset = 0
	Concurrent DOS 68K: Offset to relocations.

Public Attributes inherited from Linker::Format
offset_t	file_offset

Public Attributes inherited from Linker::SegmentManager
offset_t	current_base = 0
	The base address of the current section.

std::vector< std::shared_ptr< Segment > >	segment_vector
	Ordered sequence of segments.

std::map< std::string, std::shared_ptr< Segment > >	segment_map
	Map of segments from their names.

std::shared_ptr< Segment >	current_segment
	Currently processed segment.

std::map< std::string, Location >	linker_parameters
	Parameters that permit customizing the linker script.

std::string	linker_script
	Contents of the linker script.

Static Public Attributes
static constexpr COFFVariantType	AnyCOFFVariant = COFFVariantType(0)

static const std::map< uint32_t, MachineType >	MACHINE_TYPES

static constexpr uint16_t	R_ABS = 0
	No relocation.

static constexpr uint16_t	R_DIR16 = 1
	16-bit direct address of symbol

static constexpr uint16_t	R_REL16 = 2
	16-bit relative address of symbol

static constexpr uint16_t	R_IND16 = 3
	16-bit indirect address of symbol

static constexpr uint16_t	R_DIR24 = 4
	24-bit direct address of symbol

static constexpr uint16_t	R_REL24 = 5
	24-bit relative address of symbol

static constexpr uint16_t	R_DIR32 = 6
	32-bit direct address of symbol

static constexpr uint16_t	R_OFF8 = 7
	8-bit low byte of address of symbol

static constexpr uint16_t	R_OFF16 = 8
	8-bit high byte of address of symbol

static constexpr uint16_t	R_SEG12 = 9
	(Intel x86) 16-bit segment selector of symbol

static constexpr uint16_t	R_DIR32S = 10
	(WE32K) 32-bit direct address of symbol, byte swapped

static constexpr uint16_t	R_AUX = 11
	Auxiliary relocation.

static constexpr uint16_t	R_OPT16 = 12
	16-bit (WE32K) optimized indirect address of symbol

static constexpr uint16_t	R_IND24 = 13
	24-bit indirect address of symbol

static constexpr uint16_t	R_IND32 = 14
	32-bit indirect address of symbol

static constexpr uint16_t	R_RELBYTE = 15
	8-bit direct (symbol relative) address of symbol

static constexpr uint16_t	R_RELWORD = 16
	16-bit direct (symbol relative) address of symbol

static constexpr uint16_t	R_RELLONG = 17
	32-bit direct (symbol relative) address of symbol

static constexpr uint16_t	R_PCRBYTE = 18
	8-bit PC relative address of symbol

static constexpr uint16_t	R_PCRWORD = 19
	16-bit PC relative address of symbol

static constexpr uint16_t	R_PCRLONG = 20
	32-bit PC relative address of symbol

static constexpr uint16_t	REL_I386_ABSOLUTE = 0
	No relocation.

static constexpr uint16_t	REL_I386_DIR16 = 1
	16-bit virtual address of symbol (not supported)

static constexpr uint16_t	REL_I386_REL16 = 2
	16-bit relative address of symbol (not supported)

static constexpr uint16_t	REL_I386_DIR32 = 6
	32-bit virtual address of symbol

static constexpr uint16_t	REL_I386_DIR32NB = 7
	32-bit relative virtual address of symbol

static constexpr uint16_t	REL_I386_SEG12 = 9
	16-bit segment selector of symbol (not supported)

static constexpr uint16_t	REL_I386_SECTION = 10
	16-bit section index (debugging)

static constexpr uint16_t	REL_I386_SECREL = 11
	32-bit offset from section start (debugging)

static constexpr uint16_t	REL_I386_TOKEN = 12
	CLR token.

static constexpr uint16_t	REL_I386_SECREL7 = 13
	7-bit offset from section base

static constexpr uint16_t	REL_I386_REL32 = 20
	32-bit relative address of symbol

static constexpr uint16_t	REL_AMD64_ABSOLUTE = 0
	No relocation.

static constexpr uint16_t	REL_AMD64_ADDR64 = 1
	64-bit virtual address of symbol

static constexpr uint16_t	REL_AMD64_ADDR32 = 2
	32-bit virtual address of symbol

static constexpr uint16_t	REL_AMD64_ADDR32NB = 3
	32-bit relative virtual address of symbol

static constexpr uint16_t	REL_AMD64_REL32 = 4
	32-bit relative address of symbol

static constexpr uint16_t	REL_AMD64_REL32_1 = 5
	32-bit relative address of symbol minus 1

static constexpr uint16_t	REL_AMD64_REL32_2 = 6
	32-bit relative address of symbol minus 2

static constexpr uint16_t	REL_AMD64_REL32_3 = 7
	32-bit relative address of symbol minus 3

static constexpr uint16_t	REL_AMD64_REL32_4 = 8
	32-bit relative address of symbol minus 4

static constexpr uint16_t	REL_AMD64_REL32_5 = 9
	32-bit relative address of symbol minus 5

static constexpr uint16_t	REL_AMD64_SECTION = 10
	16-bit section index (debugging)

static constexpr uint16_t	REL_AMD64_SECREL = 11
	32-bit offset from section start (debugging)

static constexpr uint16_t	REL_AMD64_SECREL7 = 12
	7-bit offset from section base

static constexpr uint16_t	REL_AMD64_TOKEN = 13
	CLR token.

static constexpr uint16_t	REL_AMD64_SREL32 = 14
	?

static constexpr uint16_t	REL_AMD64_PAIR = 15
	?

static constexpr uint16_t	REL_AMD64_SSPAN32 = 16
	?

static constexpr uint16_t	REL_ARM_ABSOLUTE = 0
	No relocation.

static constexpr uint16_t	REL_ARM_ADDR32 = 1
	32-bit virtual address of symbol

static constexpr uint16_t	REL_ARM_ADDR32NB = 2
	32-bit relative virtual address of symbol

static constexpr uint16_t	REL_ARM_BRANCH24 = 3
	24-bit ARM relative address of symbol

static constexpr uint16_t	REL_ARM_BRANCH11 = 4
	Two 16-bit instructions with 11 bits of the relative address of symbol each.

static constexpr uint16_t	REL_ARM_REL32 = 10
	32-bit relative address of symbol

static constexpr uint16_t	REL_ARM_SECTION = 14
	16-bit section index (debugging)

static constexpr uint16_t	REL_ARM_SECREL = 15
	32-bit offset from section start (debugging)

static constexpr uint16_t	REL_ARM_MOV32 = 16
	Two 32-bit ARM instructions with 32 bits of the virtual address of the symbol.

static constexpr uint16_t	REL_THUMB_MOV32 = 17
	Two 32-bit Thumb instructions with 32 bits of the virtual address of the symbol.

static constexpr uint16_t	REL_THUMB_BRANCH24 = 20
	24-bit Thumb relative address of symbol

static constexpr uint16_t	REL_THUMB_BLX23 = 21
	23-bit Thumb BLX relative address of symbol

static constexpr uint16_t	REL_ARM_PAIR = 22
	?

static constexpr uint16_t	REL_ARM64_ABSOLUTE = 0
	No relocation.

static constexpr uint16_t	REL_ARM64_ADDR32 = 1
	32-bit virtual address of symbol

static constexpr uint16_t	REL_ARM64_ADDR32NB = 2
	32-bit relative virtual address of symbol

static constexpr uint16_t	REL_ARM64_BRANCH26 = 3
	26-bit ARM relative address of symbol

static constexpr uint16_t	REL_ARM64_PAGEBASE_REL21 = 4
	Page base of symbol for ADRP.

static constexpr uint16_t	REL_ARM64_REL21 = 5
	12-bit relative address of symbol for ADR

static constexpr uint16_t	REL_ARM64_PAGEOFFSET_12A = 6
	12-bit page offset of symbol for ADD/ADDS

static constexpr uint16_t	REL_ARM64_PAGEOFFSET_12L = 7
	12-bit page offset of symbol for LDR

static constexpr uint16_t	REL_ARM64_SECREL = 8
	32-bit offset from section start (debugging)

static constexpr uint16_t	REL_ARM64_SECREL_LOW12A = 9
	Low 12 bits of offset from section start for ADD/ADDS.

static constexpr uint16_t	REL_ARM64_SECREL_HIGH12A = 10
	Bits 12 to 23 of offset from section start for ADD/ADDS.

static constexpr uint16_t	REL_ARM64_SECREL_LOW12L = 11
	Low 12 bits of offset from section start for LDR.

static constexpr uint16_t	REL_ARM64_TOKEN = 12
	CLR token.

static constexpr uint16_t	REL_ARM64_SECTION = 13
	16-bit section index (debugging)

static constexpr uint16_t	REL_ARM64_ADDR64 = 14
	64-bit virtual address of symbol

static constexpr uint16_t	REL_ARM64_BRANCH19 = 15
	19-bit relative address of symbol

static constexpr uint16_t	REL_ARM64_BRANCH14 = 16
	14-bit relative address of symbol for TBZ/TBNZ

static constexpr uint16_t	REL_ARM64_REL32 = 17
	32-bit relative address of symbol

static constexpr uint16_t	REL_ALPHA_ABSOLUTE = 0
	No relocation.

static constexpr uint16_t	REL_ALPHA_REFLONG = 1
	32-bit virtual address of symbol

static constexpr uint16_t	REL_ALPHA_REFQUAD = 2
	64-bit virtual address of symbol

static constexpr uint16_t	REL_ALPHA_GPREL32 = 3
	32-bit global pointer relative address of symbol

static constexpr uint16_t	REL_ALPHA_LITERAL = 4
	16-bit global pointer relative address of symbol

static constexpr uint16_t	REL_ALPHA_LITUSE = 5
	reserved

static constexpr uint16_t	REL_ALPHA_GPDISP = 6
	reserved

static constexpr uint16_t	REL_ALPHA_BRADDR = 7
	21-bit relative address of symbol

static constexpr uint16_t	REL_ALPHA_HINT = 8
	14-bit hint for jump target

static constexpr uint16_t	REL_ALPHA_INLINE_REFLONG = 9
	32-bit virtual address of symbol split into two 16-bit values; this relocation must be followed by an ABSOLUTE or MATCH relocation

static constexpr uint16_t	REL_ALPHA_REFHI = 10
	High 16 bits of 32-bit virtual address of symbol; this relocation must be followed by a PAIR relocation.

static constexpr uint16_t	REL_ALPHA_REFLO = 11
	Low 16 bits of 32-bit virtual address of symbol.

static constexpr uint16_t	REL_ALPHA_PAIR = 12
	Displacement value for a preceding REFHI, SECRELHI, REFQ3 or REFQ2 relocation.

static constexpr uint16_t	REL_ALPHA_MATCH = 13
	Displacement value for a preceding REFLONG relocation.

static constexpr uint16_t	REL_ALPHA_SECTION = 14
	16-bit section index (debugging)

static constexpr uint16_t	REL_ALPHA_SECREL = 15
	32-bit offset from section start (debugging)

static constexpr uint16_t	REL_ALPHA_REFLONGNB = 16
	32-bit relative virtual address of symbol

static constexpr uint16_t	REL_ALPHA_SECRELLO = 17
	Low 16 bits of 32-bit offset from section start (debugging)

static constexpr uint16_t	REL_ALPHA_SECRELHI = 18
	High 16 bits of 32-bit offset from section start; this relocation must be followed by a PAIR relocation (debugging)

static constexpr uint16_t	REL_ALPHA_REFQ3 = 19
	The second most significant 16 bits of the 64-bit virtual address of symbol; this relocation must be followed by a PAIR relocation.

static constexpr uint16_t	REL_ALPHA_REFQ2 = 20
	The third most significant 16 bits of the 64-bit virtual address of symbol; this relocation must be followed by a PAIR relocation.

static constexpr uint16_t	REL_ALPHA_REFQ1 = 21
	The least significant 16 bits of the 64-bit virtual address of symbol.

static constexpr uint16_t	REL_ALPHA_GPRELLO = 22
	Low 16 bits of 32-bit global pointer relative address of symbol.

static constexpr uint16_t	REL_ALPHA_GPRELHI = 23
	High 16 bits of 32-bit global pointer relative address of symbol.

static constexpr uint16_t	R_Z80_IMM8 = 0x22

static constexpr uint16_t	R_Z80_IMM16 = 0x01

static constexpr uint16_t	R_Z80_IMM24 = 0x33

static constexpr uint16_t	R_Z80_IMM32 = 0x17

static constexpr uint16_t	R_Z80_OFF8 = 0x32

static constexpr uint16_t	R_Z80_JR = 0x02

static constexpr uint16_t	R_Z8K_IMM4L = 0x23

static constexpr uint16_t	R_Z8K_IMM4H = 0x24

static constexpr uint16_t	R_Z8K_DISP7 = 0x25

static constexpr uint16_t	R_Z8K_IMM8 = 0x22

static constexpr uint16_t	R_Z8K_IMM16 = 0x01

static constexpr uint16_t	R_Z8K_REL16 = 0x04

static constexpr uint16_t	R_Z8K_IMM32 = 0x11

static constexpr uint16_t	R_Z8K_JR = 0x02

static constexpr uint16_t	R_Z8K_CALLR = 0x05

static constexpr uint16_t	R_W65_ABS8 = 0x01

static constexpr uint16_t	R_W65_ABS16 = 0x02

static constexpr uint16_t	R_W65_ABS24 = 0x03

static constexpr uint16_t	R_W65_ABS8S8 = 0x04

static constexpr uint16_t	R_W65_ABS8S16 = 0x05

static constexpr uint16_t	R_W65_ABS16S8 = 0x06

static constexpr uint16_t	R_W65_ABS16S16 = 0x07

static constexpr uint16_t	R_W65_PCR8 = 0x08

static constexpr uint16_t	R_W65_PCR16 = 0x09

static constexpr uint16_t	R_W65_DP = 0x0A

static std::vector< Linker::OptionDescription< void > * >	ParameterNames

Protected Member Functions
void	ReadCOFFHeader (Linker::Reader &rd)

void	ReadOptionalHeader (Linker::Reader &rd)

void	ReadRestOfFile (Linker::Reader &rd)

offset_t	WriteFileContents (Linker::Writer &wr) const

Additional Inherited Members
Protected Attributes inherited from Linker::SegmentManager
offset_t	current_address = 0
	Holds the current address value when there is no current_segment.

bool	current_is_template_head = false
	Set during evaluation of `guard` in a `for <guard> { <body> }` statement.

bool	current_is_template = false
	Set during evaluation of `body` in a `for <guard> { <body> }` statement.

offset_t	template_counter = 0
	Counts how many times a `for` statement has been invoked.

bool	condition_failed = false
	Condition to signal end of current `for` statement.

std::string	current_template_name
	Records the name of the currently generating segment for a `for` statement.

Detailed Description

The UNIX COFF file format.

Originally introduced in UNIX System V, it replaced the previous a.out format. It was later adopted, often with extensions, on many UNIX and non-UNIX operating systems.

The current implementation supports the following formats:

DJGPP version 1.11 or later, running on top of MS-DOS
Digital Research Concurrent DOS 68K

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

COFF file header flags, most of these are obsolete, we only use them as precombined flag sets.

Enumerator
FLAG_NO_RELOCATIONS	F_RELFLG.
FLAG_EXECUTABLE	F_EXEC.
FLAG_NO_LINE_NUMBERS	F_LNNO.
FLAG_NO_SYMBOLS	F_LSYMS.
FLAG_PDP11_ENDIAN	F_AR16WR.
FLAG_32BIT_LITTLE_ENDIAN	F_AR32WR.
FLAG_32BIT_BIG_ENDIAN	F_AR32W.
ZMAGIC	Stored as the magic of the a.out header.
MAGIC_FLEXOS386	Magic number required by FlexOS 386.

◆ COFFVariantType

enum COFF::COFFFormat::COFFVariantType

Variants of the COFF file format.

Enumerator
COFF	Standard COFF variant (also for 32-bit ECOFF for MIPS)
ECOFF	ECOFF 64-bit version.
XCOFF32	32-bit XCOFF from IBM
XCOFF64	64-bit XCOFF from IBM
PECOFF	Microsoft PE/COFF variant.
TICOFF	Texas Instruments COFF variant (COFF2)
TICOFF1	Texas Instruments COFF variant (COFF1)

◆ cpu

enum COFF::COFFFormat::cpu

Represents the first 16-bit word of a COFF file.

Enumerator
CPU_I386	Intel x86-32, introduced with the Intel 80386. Value as used by UNIX, Microsoft and DJGPP
CPU_M68K	Motorola 68000 and compatibles. Value as used by UNIX and Digital Research Concurrent DOS 68K
CPU_W65	WDC 65C816. Value as used by GNU binutils
CPU_Z80	Zilog Z80. Value as used by GNU binutils
CPU_Z8K	Zilog Z8000. Value as used by GNU binutils
CPU_I86	Intel x86-16, introduced with the Intel 8086. Value as used by UNIX
CPU_I286	Intel x86-16, introduced with the Intel 286. Value as used by UNIX
CPU_NS32K	National Semiconductor NS32000. Value as used by UNIX
CPU_I370	IBM System/370. Value as used by UNIX
CPU_MIPS	MIPS architecture. Value as used by UNIX
CPU_M88K	Motorola 88000. Value as used by UNIX and also defined in ECOFF
CPU_WE32K	AT&T Bellmac 32, Western Electric 32000 and family. Value as used by UNIX
CPU_VAX	DEC VAX. Value as used by UNIX
CPU_AM29K	AMD 29000. Value as used by UNIX
CPU_ALPHA	DEC Alpha. Value as used by UNIX
CPU_PPC	IBM PowerPC, 32-bit. Value as defined by XCOFF
CPU_PPC64	IBM PowerPC, 64-bit. Value as defined by XCOFF
CPU_SHARC	SHARC from Analog Devices.
CPU_I860	Intel i860. Value as shown in early Microsoft documentation
CPU_SH	Hitachi SuperH family. Value as defined by Microsoft
CPU_ARM	ARM, also known as ARM32 or AArch32; also represents Thumb. Value as defined by Microsoft
CPU_AM33	Matsushita AM33. Value as defined by Microsoft
CPU_IA64	Intel Itanium architecture, also known as IA-64. Value as defined by Microsoft
CPU_HPPA	Hewlett-Packard PA-RISC. Value as defined by Microsoft
CPU_EFI	EFI bytecode. Value as defined by Microsoft
CPU_RISCV32	RISC-V 32. Value as defined by Microsoft
CPU_RISCV64	RISC-V 64. Value as defined by Microsoft
CPU_RISCV128	RISC-V 128. Value as defined by Microsoft
CPU_AMD64	x86-64, introduced by AMD Value as defined by Microsoft
CPU_M32R	Mitsubishi M32R. Value as defined by Microsoft
CPU_ARM64	ARM64, also known as AArch64. Value as defined by Microsoft

◆ format_type

enum COFF::COFFFormat::format_type

Represents the type of target system, which will determine the CPU type and several other fields.

Enumerator
GENERIC	An unspecified value, probably will not work.
DJGPP	DJGPP COFF executable.
CDOS68K	Concurrent DOS 68K executable (untested but confident)
CDOS386	FlexOS 386 executable.
WINDOWS	Windows Portable Executable (used only by PE)

◆ relocation_format_type

enum COFF::COFFFormat::relocation_format_type

Enumerator
COFF_10	The standard 10-byte UNIX COFF relocation format, also used for Microsoft PE COFF objects.
COFF_14	A 14-byte relocation.
COFF_16	A 16-byte relocation, as stored by the Z80/Z8000 GNU assembler.
ECOFF_8	An 8-byte relocation, used for 32-bit ECOFF MIPS binaries.
ECOFF_16	A 16-byte relocation, used for 64-bit ECOFF Alpha binaries.
XCOFF_10	A 10-byte relocation, used for 32-bit XCOFF32 binaries.
XCOFF_14	A 14-byte relocation, used for 64-bit XCOFF64 binaries.
TICOFF_10	A 10-byte relocation used for TICOFF.
TICOFF_12	A 12-byte relocation used for TICOFF.

Member Function Documentation

◆ CalculateValues()

void COFFFormat::CalculateValues ( )

overridevirtual

Intermediate step between processing module and generating output file to set up headers and management sections It is expected that after a module is processed, additional steps are required to evaluate the final values of the fields.

Reimplemented from Linker::OutputFormat.

Reimplemented in Microsoft::PEFormat.

◆ Clear()

void COFFFormat::Clear ( )

overridevirtual

Resets all fields to their default values, deallocate memory.

Reimplemented from Linker::Format.

◆ Dump()

void COFFFormat::Dump ( Dumper::Dumper & dump ) const

overridevirtual

Display file contents in a nice manner.

Reimplemented from Linker::Format.

Reimplemented in Microsoft::PEFormat.

◆ FormatAdditionalSectionFlags()

unsigned COFFFormat::FormatAdditionalSectionFlags ( std::string section_name ) const

overridevirtual

Reimplemented from Linker::OutputFormat.

◆ FormatRequiresDataStreamFix()

bool COFFFormat::FormatRequiresDataStreamFix ( ) const

overridevirtual

Whether the generated file might contain bugs that require fixing.

Reimplemented from Linker::InputFormat.

◆ GenerateFile()

void COFFFormat::GenerateFile	(	std::string	filename,
		Linker::Module &	module )

overridevirtual

The main function that handles processing, calculating and generating the final image.

Reimplemented from Linker::OutputFormat.

Reimplemented in Microsoft::PEFormat.

◆ GenerateModule()

void COFFFormat::GenerateModule ( Linker::Module & module ) const

overridevirtual

Loads the information into a module object, a convenience method when there is a single module generated.

Reimplemented from Linker::InputFormat.

◆ GetDefaultExtension()

std::string COFFFormat::GetDefaultExtension	(	Linker::Module &	module,
		std::string	filename ) const

overridevirtual

Appends a default extension to the filename.

A typical behavior would be to append .exe at the end of the filename. The default action is to leave it intact.

Reimplemented from Linker::OutputFormat.

Reimplemented in Microsoft::PEFormat.

◆ GetLinkerScriptParameterNames()

std::vector< Linker::OptionDescription< void > * > COFFFormat::GetLinkerScriptParameterNames ( )

overridevirtual

Returns a list of the parameters used in the linker scripts, used for documentation.

Reimplemented from Linker::OutputFormat.

Reimplemented in Microsoft::PEFormat.

◆ GetOptions()

std::shared_ptr< Linker::OptionCollector > COFFFormat::GetOptions ( )

overridevirtual

Returns object containing a sequence of option fields provided with the -S command line flag.

Reimplemented from Linker::OutputFormat.

Reimplemented in Microsoft::PEFormat.

◆ ImageSize()

offset_t COFFFormat::ImageSize ( ) const

overridevirtual

Retrieves size of stored data.

Implements Linker::Contents.

◆ OnNewSegment()

void COFFFormat::OnNewSegment ( std::shared_ptr< Linker::Segment > segment )

overridevirtual

Callback function when allocating a new segment When the linker script runs, it creates segments consecutively. Overriding this method permits the output format to handle the allocated segment.

Reimplemented from Linker::SegmentManager.

Reimplemented in Microsoft::PEFormat.

◆ ProcessModule()

void COFFFormat::ProcessModule ( Linker::Module & object )

overridevirtual

Processes the module object and initializes format fields.

Reimplemented from Linker::OutputFormat.

Reimplemented in Microsoft::PEFormat.

◆ ReadFile()

void COFFFormat::ReadFile ( Linker::Reader & rd )

overridevirtual

Loads file into memory.

Implements Linker::Format.

Reimplemented in Microsoft::PEFormat.

◆ SetOptions()

void COFFFormat::SetOptions ( std::map< std::string, std::string > & options )

overridevirtual

Passes command line parameters as settings over to format object.

Reimplemented from Linker::OutputFormat.

Reimplemented in Microsoft::PEFormat.

◆ SetupOptions()

void COFFFormat::SetupOptions ( std::shared_ptr< Linker::OutputFormat > format )

overridevirtual

Initializes the reader for linking purposes.

Parameters

format The output format that will be used. This is required to know which extra special features need to be implemented (such as segmentation).

Reimplemented from Linker::InputFormat.

◆ WriteFile()

offset_t COFFFormat::WriteFile ( Linker::Writer & wr ) const

overridevirtual

Stores data in memory to file.

Implements Linker::Format.

Reimplemented in Microsoft::PEFormat.

Member Data Documentation

◆ cpu_type

cpu COFF::COFFFormat::cpu_type = CPU_UNKNOWN

The CPU type, reflected by the first 16-bit word of a COFF file.

The byte order has to be determined heuristically.

◆ ParameterNames

std::vector< Linker::OptionDescription< void > * > COFFFormat::ParameterNames

static

Initial value:

=
{
    &p_code_base_address,
    &p_data_base_address,
    &p_bss_base_address,
}

The documentation for this class was generated from the following files:

src/format/coff.h
src/format/coff.cc

Classes

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ COFFVariantType

◆ cpu

◆ format_type

◆ relocation_format_type

Member Function Documentation

◆ CalculateValues()

◆ Clear()

◆ Dump()

◆ FormatAdditionalSectionFlags()

◆ FormatRequiresDataStreamFix()

◆ GenerateFile()

◆ GenerateModule()

◆ GetDefaultExtension()

◆ GetLinkerScriptParameterNames()

◆ GetOptions()

◆ ImageSize()

◆ OnNewSegment()

◆ ProcessModule()

◆ ReadFile()

◆ SetOptions()

◆ SetupOptions()

◆ WriteFile()

Member Data Documentation

◆ cpu_type

◆ ParameterNames