A flat binary format, with no header, loaded directly into memory. More...

#include <binary.h>

Inheritance diagram for Binary::BinaryFormat:

Public Types
enum	memory_model_t { MODEL_DEFAULT , MODEL_TINY , MODEL_SMALL , MODEL_COMPACT , MODEL_LARGE }
	(x86 only) Represents the memory model of the running executable, which is the way in which the segments are set up during execution More...

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

	BinaryFormat (uint64_t default_base_address=0, std::string default_extension="")

	BinaryFormat (std::string default_extension)

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

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

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

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

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

unsigned	FormatAdditionalSectionFlags (std::string section_name) const override

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

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

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

Public Member Functions inherited from Binary::GenericBinaryFormat
void	Clear () override
	Resets all fields to their default values, deallocate memory.

	GenericBinaryFormat (uint64_t default_base_address=0, std::string default_extension="")

	GenericBinaryFormat (std::string default_extension)

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

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

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

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

virtual bool	ProcessRelocation (Linker::Module &module, Linker::Relocation &rel, Linker::Resolution resolution)
	Callback function to process relocations.

void	Link (Linker::Module &module)

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) override
	Appends a default extension to the filename.

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.

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	SetLinkScript (std::string script_file, std::map< std::string, std::string > &options)
	Selects a script file to use for linking.

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

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.

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

Public Member Functions inherited from Linker::LinkerManager
void	ClearLinkerManager ()

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

bool	SetLinkerParameter (std::map< std::string, std::string > &options, std::string key)
	Sets a single linker parameter, if inside options.

bool	SetLinkerParameter (std::map< std::string, std::string > &options, std::string key, std::string variable)
	Sets a single linker parameter, if inside options.

std::unique_ptr< Script::List >	GetScript (Linker::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.

std::shared_ptr< Segment >	AppendSegment (std::string name)
	Terminates the current segment (if there is one), creates a new segment and attaches it 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 Attributes
std::unique_ptr< Microsoft::MZFormat::PIF >	pif = nullptr
	Concurrent DOS program information entry, allocated only if present.

memory_model_t	memory_model = MODEL_DEFAULT
	Memory model of generated executable, must be MODEL_DEFAULT for all non-x86 platforms.

Public Attributes inherited from Binary::GenericBinaryFormat
std::shared_ptr< Linker::Writable >	image = nullptr
	The actual stored image.

bool	position_independent
	Set when the generated code must not reference absolute references.

uint64_t	base_address = 0
	Address at which image is stored, it can be format specific or provided as a parameter.

std::string	extension
	Default filename extension for executables (such as .com for MS-DOS, .r for Human68k)

Public Attributes inherited from Linker::Format
offset_t	file_offset

Public Attributes inherited from Linker::LinkerManager
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.

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

bool	current_is_template = false

bool	current_is_template_head = false

offset_t	template_counter = 0

std::string	current_template_name

Detailed Description

A flat binary format, with no header, loaded directly into memory.

Most often used with disk images or MS-DOS .COM files. They are also used as executable file formats for several operating systems, including:

CP/M-80 and MSX-DOS .com files (loaded at 0x0100)
MS-DOS .com files (loaded at offset 0x0100 in an arbitrary segment)
Human68k .r files (relocatable)
Sinclair QL QDOS files (loaded at 0x00038000)
RISC OS ,ff8 files (loaded at 0x00008000)
other CP/M inspired systems, such as DOS/65 (loaded at a port specific address) and DX-DOS .com files (loaded at an address stored in the directory entry)

Member Enumeration Documentation

◆ memory_model_t

enum Binary::BinaryFormat::memory_model_t

(x86 only) Represents the memory model of the running executable, which is the way in which the segments are set up during execution

Enumerator
MODEL_DEFAULT	Default model, for x86, same as tiny, for other platforms the only possible option.
MODEL_TINY	Tiny model, code and data segment are the same.
MODEL_SMALL	Small model, separate code and data segments.
MODEL_COMPACT	Compact model, separate code and multiple data segments.
MODEL_LARGE	Large model, every section is a separate segment.

Member Function Documentation

◆ Clear()

void BinaryFormat::Clear ( )

overridevirtual

Resets all fields to their default values, deallocate memory.

Reimplemented from Linker::Format.

◆ Dump()

void BinaryFormat::Dump ( Dumper::Dumper & dump )

overridevirtual

Display file contents in a nice manner.

Reimplemented from Linker::Format.

◆ FormatAdditionalSectionFlags()

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

overridevirtual

Reimplemented from Linker::OutputFormat.

◆ FormatIs16bit()

bool BinaryFormat::FormatIs16bit ( ) const

overridevirtual

Whether the format is 16-bit or not.

This is needed for the ELF parser which can not distinguish between the 8086 and 80386 backends.

Reimplemented from Linker::OutputFormat.

◆ FormatSupportsSegmentation()

bool BinaryFormat::FormatSupportsSegmentation ( ) const

overridevirtual

Whether the format supports multiple segments.

This is typically true for Intel 8086 targets and false for non-Intel targets. The ELF parser uses this to provide extended relocations, including the following:

$$SEG$<section name>
$$SEGOF$<symbol name>
$$SEGAT$<symbol name>
$$WRTSEG$<symbol name>$<section name>
$$SEGDIF$<section name>$<section name>

Reimplemented from Linker::OutputFormat.

◆ GetScript()

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

overridevirtual

Reimplemented from Binary::GenericBinaryFormat.

◆ ProcessModule()

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

overridevirtual

Processes the module object and initializes format fields.

Reimplemented from Linker::OutputFormat.

◆ ReadFile()

void BinaryFormat::ReadFile ( Linker::Reader & in )

overridevirtual

Loads file into memory.

Implements Linker::Format.

◆ SetModel()

void BinaryFormat::SetModel ( std::string model )

overridevirtual

Sets the way memory is organized, typically modifying a built-in script.

Reimplemented from Linker::OutputFormat.

◆ WriteFile()

void BinaryFormat::WriteFile ( Linker::Writer & out )

overridevirtual

Stores data in memory to file.

Implements Linker::Format.

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

src/format/binary.h
src/format/binary.cc

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ memory_model_t

Member Function Documentation

◆ Clear()

◆ Dump()

◆ FormatAdditionalSectionFlags()

◆ FormatIs16bit()

◆ FormatSupportsSegmentation()

◆ GetScript()

◆ ProcessModule()

◆ ReadFile()

◆ SetModel()

◆ WriteFile()