Ergo OS/286 and OS/386 "XP" .exp file (Ergo was formerly A.I. Architects, then Eclipse) More...

#include <xpexp.h>

Inheritance diagram for Ergo::XPFormat:

Classes
class	Group

struct	Segment

class	XPOptionCollector

Public Types
enum	Wordsize { Unknown = 0 , Word = 2 , DWord = 4 }

enum	memory_model_t { MODEL_DEFAULT , MODEL_SMALL , MODEL_COMPACT }
	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.

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	ReadFile (Linker::Reader &rd) override
	Loads file into memory.

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

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

void	Dump (Dumper::Dumper &dump) const 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.

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

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

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

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

void	CreateDefaultSegments ()
	Create the required segments, if they have not already been allocated. The XP format uses a single segment.

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

void	Link (Linker::Module &module)
	Link application according to script or memory model.

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

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

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

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	OnNewSegment (std::shared_ptr< Segment > segment)
	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.

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 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 > * >	GetLinkerScriptParameterNames ()
	Returns a list of the parameters used in the linker scripts, 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	GenerateFile (std::string filename, Module &module)
	The main function that handles processing, calculating and generating the final image.

virtual std::string	GetDefaultExtension (Module &module) const
	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.

virtual unsigned	FormatAdditionalSectionFlags (std::string section_name) const

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

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::Image
virtual std::shared_ptr< const ActualImage >	AsImage () const
	Retrieves a randomly accessible image.

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

Public Attributes
uint32_t	ldt_offset = 0

uint32_t	image_offset = 0

uint32_t	relocation_offset = 0

uint32_t	relocation_count = 0

uint32_t	minimum_extent = 0

uint32_t	maximum_extent = 0

uint32_t	unknown_field = 0

uint32_t	gs = 0

uint32_t	fs = 0

uint32_t	ds = 0

uint32_t	ss = 0

uint32_t	cs = 0

uint32_t	es = 0

uint32_t	edi = 0

uint32_t	esi = 0

uint32_t	ebp = 0

uint32_t	esp = 0

uint32_t	ebx = 0

uint32_t	edx = 0

uint32_t	ecx = 0

uint32_t	eax = 0

uint32_t	eflags = 0

uint32_t	eip = 0

std::vector< Segment >	ldt

std::shared_ptr< Linker::Image >	image

Microsoft::MZStubWriter	stub

Wordsize	wordsize = Unknown

bool	option_create_selector_pairs = false
	Generate code/data selector pairs for all segments.

bool	option_no_intermediate_selectors = false
	No selectors are generated for segments in groups.

memory_model_t	memory_model = MODEL_DEFAULT
	Memory model of generated executable.

std::vector< Group >	section_groups

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.

Public Attributes inherited from Linker::Format
offset_t	file_offset

Static Public Attributes
static std::vector< Linker::OptionDescription< void > >	MemoryModelNames

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 = false

bool	current_is_template_head = false

offset_t	template_counter = 0

std::string	current_template_name

Detailed Description

Ergo OS/286 and OS/386 "XP" .exp file (Ergo was formerly A.I. Architects, then Eclipse)

Member Enumeration Documentation

◆ memory_model_t

enum Ergo::XPFormat::memory_model_t

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, same as small.
MODEL_SMALL	Small model, separate code and data segments.
MODEL_COMPACT	Compact model, separate code and multiple data segments.

Member Function Documentation

◆ CalculateValues()

void XPFormat::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.

◆ Clear()

void XPFormat::Clear ( )

overridevirtual

Resets all fields to their default values, deallocate memory.

Reimplemented from Linker::Format.

◆ Dump()

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

overridevirtual

Display file contents in a nice manner.

Reimplemented from Linker::Format.

◆ FormatIs16bit()

bool XPFormat::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.

◆ FormatIsProtectedMode()

bool XPFormat::FormatIsProtectedMode ( ) const

overridevirtual

Whether the format is in protected mode or not (x86 only)

This is needed for the ELF parser to determine whether segment references are paragraph offsets (16-byte units) or selector indexes.

For non-x86 targets, the result is meaningless.

Reimplemented from Linker::OutputFormat.

◆ FormatSupportsSegmentation()

bool XPFormat::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.

◆ GetDefaultExtension()

std::string XPFormat::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.

◆ GetMemoryModelNames()

std::vector< Linker::OptionDescription< void > > XPFormat::GetMemoryModelNames ( )

overridevirtual

Returns a list of the supported memory models, used for documentation.

Reimplemented from Linker::OutputFormat.

◆ GetOptions()

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

overridevirtual

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

Reimplemented from Linker::OutputFormat.

◆ ImageSize()

offset_t XPFormat::ImageSize ( ) const

overridevirtual

Retrieves size of stored data.

Reimplemented from Linker::Format.

◆ ProcessModule()

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

overridevirtual

Processes the module object and initializes format fields.

Reimplemented from Linker::OutputFormat.

◆ ReadFile()

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

overridevirtual

Loads file into memory.

Implements Linker::Format.

◆ SetModel()

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

overridevirtual

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

Reimplemented from Linker::OutputFormat.

◆ SetOptions()

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

overridevirtual

Passes command line parameters as settings over to format object.

Reimplemented from Linker::OutputFormat.

◆ WriteFile()

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

overridevirtual

Stores data in memory to file.

Implements Linker::Format.

Member Data Documentation

◆ MemoryModelNames

std::vector< Linker::OptionDescription< void > > XPFormat::MemoryModelNames

static

Initial value:

=
{
    Linker::OptionDescription<void>("default/small", "Small model, symbols in .code have a separate preferred segment"),
    Linker::OptionDescription<void>("compact", "Compact model, symbols in .data, .bss and .comm have a common preferred segment, all other sections are treated as separate segments"),
}

◆ option_create_selector_pairs

bool Ergo::XPFormat::option_create_selector_pairs = false

Generate code/data selector pairs for all segments.

Normally, only certain segments get both selectors generated. This flag makes all segments appear twice, once as code and once as data.

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

src/format/xpexp.h
src/format/xpexp.cc

Classes

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ memory_model_t

Member Function Documentation

◆ CalculateValues()

◆ Clear()

◆ Dump()

◆ FormatIs16bit()

◆ FormatIsProtectedMode()

◆ FormatSupportsSegmentation()

◆ GetDefaultExtension()

◆ GetMemoryModelNames()

◆ GetOptions()

◆ ImageSize()

◆ ProcessModule()

◆ ReadFile()

◆ SetModel()

◆ SetOptions()

◆ WriteFile()

Member Data Documentation

◆ MemoryModelNames

◆ option_create_selector_pairs