DOS16M::BWFormat Class Reference

Rational Systems DOS/16M "BW" .exp file. More...

#include <bwexp.h>

Inheritance diagram for DOS16M::BWFormat:

Classes
class	AbstractSegment
class	DummySegment
class	RelocationSegment
class	Segment

Public Types
enum	relocations_type { RelocationsNone , RelocationsType1 , RelocationsType2 }
	BW .exp files support two versions of relocations.
enum	exp_flag_type { EXP_FLAG_RELOCATABLE = 0x0001 }
enum	option_type { OPTION_RELOCATIONS = 0x1000 }

Public Member Functions
void	ReadFile (Linker::Reader &rd) override
	Loads file into memory.
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
offset_t	MeasureRelocations ()
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
std::unique_ptr< Script::List >	GetScript (Linker::Module &module)
void	Link (Linker::Module &module)
size_t	GetDefaultDataIndex ()
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	WriteFile (Linker::Writer &wr) override
	Stores data in memory to file.
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	SetModel (std::string model)
	Sets the way memory is organized, typically modifying a built-in script.
virtual void	SetLinkScript (std::string script_file, std::map< std::string, std::string > &options)
	Selects a script file to use for linking.
virtual void	GenerateFile (std::string filename, Linker::Module &module)
	The main function that handles processing, calculating and generating the final image.
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)
virtual void	Clear ()
	Resets all fields to their default values, deallocate memory.
virtual void	Dump (Dumper::Dumper &dump)
	Display file contents in a nice manner.
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.
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 Attributes
relocations_type	option_relocations = RelocationsType2
bool	option_force_relocations = true
exp_flag_type	exp_flags = exp_flag_type(0)
option_type	options = option_type(0)
std::map< uint16_t, std::set< uint16_t > >	relocations
offset_t	file_size = 0
offset_t	min_extra = 0
offset_t	max_extra = 0
uint16_t	ss = 0
uint16_t	sp = 0
uint16_t	cs = 0
uint16_t	ip = 0
uint16_t	relocsel = 0
uint16_t	runtime_gdt_length = 0xFFFF
uint16_t	version = 0
uint32_t	next_header_offset = 0
uint32_t	debug_info_offset = 0
uint16_t	first_selector = 0x0080
uint32_t	private_xm = 0
uint16_t	ext_reserve = 0
uint16_t	transparent_stack = 0
uint32_t	program_size = 0
uint8_t	default_memory_strategy = 0
uint16_t	transfer_buffer_size = 0
std::string	exp_name
std::vector< std::unique_ptr< AbstractSegment > >	segments
std::map< std::shared_ptr< Linker::Segment >, size_t >	segment_indices
int	default_data = 0
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 Member Functions inherited from Microsoft::MZStubWriter
	MZStubWriter (std::string stub_file="")
bool	OpenAndCheckValidFile ()
offset_t	GetStubImageSize ()
void	WriteStubImage (std::ostream &out)
void	WriteStubImage (Linker::Writer &wr)
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
Protected Attributes inherited from Microsoft::MZStubWriter
std::string	stub_file
bool	stub_file_valid = true
std::ifstream	stub
uint32_t	original_file_size = -1
uint32_t	stub_file_size = 0
uint16_t	stub_reloc_count = 0
uint32_t	original_header_size = 0
uint32_t	stub_header_size = 0
uint16_t	original_reloc_offset = 0
uint16_t	stub_reloc_offset = 0

Detailed Description

Rational Systems DOS/16M "BW" .exp file.

Member Function Documentation

CalculateValues()

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

FormatAdditionalSectionFlags()

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

overridevirtual

Reimplemented from Linker::OutputFormat.

FormatIs16bit()

bool BWFormat::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 BWFormat::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 BWFormat::GetDefaultExtension ( Linker::Module & module, std::string filename )

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.

ProcessModule()

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

overridevirtual

Processes the module object and initializes format fields.

Reimplemented from Linker::OutputFormat.

ReadFile()

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

overridevirtual

Loads file into memory.

Implements Linker::Format.

SetOptions()

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

overridevirtual

Passes command line parameters as settings over to format object.

Reimplemented from Linker::OutputFormat.

WriteFile()

void BWFormat::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/bwexp.h
• src/format/bwexp.cc