CandyMan's DX64 "Flat" and "LV" executable formats. More...
#include <dosexe.h>
Inheritance diagram for DX64::LVFormat:
Classes | |
| class | LVOptionCollector |
Public Types | |
| enum | format_type { FORMAT_FLAT , FORMAT_LV } |
 Public Types inherited from SeychellDOS32::AdamFormat | |
| enum | format_type { FORMAT_UNSPECIFIED , FORMAT_33 , FORMAT_35 , FORMAT_DX64 , FORMAT_LV_FLAT } |
| enum | output_type { OUTPUT_EXE , OUTPUT_DLL } |
| enum | relocation_type { Selector16 , Offset32 } |
| enum | { FLAG_COMPRESSED = 0x0001 , FLAG_DISPLAY_LOGO = 0x0002 , FLAG_4MB_HEAP_LIMIT = 0x0004 } |
Public Member Functions | |
| LVFormat (format_type type) | |
| void | SetSignature (format_type type) |
| void | ReadFile (Linker::Reader &rd) override |
| Loads file into memory. | |
| 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. | |
| 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 | GenerateFile (std::string filename, Linker::Module &module) override |
| The main function that handles processing, calculating and generating the final image. | |
| Public Member Functions inherited from SeychellDOS32::AdamFormat | |
| AdamFormat (format_type format=FORMAT_UNSPECIFIED, output_type output=OUTPUT_EXE) | |
| constexpr bool | IsV35 () const |
| constexpr bool | IsDLL () const |
| void | MakeApplication () |
| void | MakeLibrary () |
| 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. | |
| bool | FormatSupportsSegmentation () const override |
| Whether the format supports multiple segments. | |
| unsigned | FormatAdditionalSectionFlags (std::string section_name) const override |
| 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 () |
| Create the required segments, if they have not already been allocated. The Adam 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::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 | 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 > * > | 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 | 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 | 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 Member Functions inherited from Linker::Format | |
| Format (offset_t file_offset=0) | |
| virtual void | Clear () |
| Resets all fields to their default values, deallocate memory. | |
| 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. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from SeychellDOS32::AdamFormat | |
| static uint32_t | GetRelocationSize (uint32_t displacement, relocation_type type) |
| Public Attributes inherited from SeychellDOS32::AdamFormat | |
| format_type | format |
| output_type | output |
| std::array< char, 4 > | signature |
| std::array< uint8_t, 2 > | minimum_dos_version |
| std::array< uint8_t, 2 > | dlink_version |
| uint32_t | image_size = 0 |
| uint32_t | header_size = 0 |
| uint32_t | program_size = 0 |
| uint32_t | memory_size = 0 |
| uint32_t | contents_size = 0 |
| uint32_t | selector_relocation_count = 0 |
| uint32_t | offset_relocations_size = 0 |
| uint32_t | eip = 0 |
| uint32_t | esp = 0 |
| std::vector< uint32_t > | selector_relocations |
| std::vector< uint32_t > | offset_relocations |
| std::map< uint32_t, relocation_type > | relocations_map |
| uint32_t | flags = 0 |
| std::shared_ptr< Linker::Contents > | image |
| Microsoft::MZSimpleStubWriter | stub |
| uint32_t | stack_size = 0 |
| 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 |
| 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
CandyMan's DX64 "Flat" and "LV" executable formats.
Member Function Documentation
◆ Dump()
|
overridevirtual |
Display file contents in a nice manner.
Reimplemented from SeychellDOS32::AdamFormat.
◆ GenerateFile()
|
overridevirtual |
The main function that handles processing, calculating and generating the final image.
Reimplemented from SeychellDOS32::AdamFormat.
◆ GetOptions()
|
overridevirtual |
Returns object containing a sequence of option fields provided with the -S command line flag.
Reimplemented from SeychellDOS32::AdamFormat.
◆ ReadFile()
|
overridevirtual |
Loads file into memory.
Reimplemented from SeychellDOS32::AdamFormat.
◆ SetOptions()
|
overridevirtual |
Passes command line parameters as settings over to format object.
Reimplemented from SeychellDOS32::AdamFormat.
◆ WriteFile()
|
overridevirtual |
Stores data in memory to file.
Reimplemented from SeychellDOS32::AdamFormat.
The documentation for this class was generated from the following files:
- src/format/dosexe.h
- src/format/dosexe.cc
