Mach/NeXTSTEP/Mac OS X (macOS) file format. More...
#include <macho.h>
Inheritance diagram for MachO::MachOFormat:
Public Member Functions | |
| void | ReadFile (Linker::Reader &rd) override |
| Loads file into memory. | |
| void | WriteFile (Linker::Writer &wr) override |
| Stores data in memory to file. | |
 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 void | SetOptions (std::map< std::string, std::string > &options) |
| Passes command line parameters as settings over to format object. | |
| 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 | ProcessModule (Linker::Module &object) |
| Processes the module object and initializes format fields. | |
| virtual void | CalculateValues () |
| 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. | |
| 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, std::string filename) |
| Appends a default extension to the filename. | |
| virtual std::string | GetDefaultExtension (Linker::Module &module) |
| 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 | 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) | |
| 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) |
Additional Inherited Members | |
| 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. | |
| 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
Mach/NeXTSTEP/Mac OS X (macOS) file format.
Originally developed for the Mach kernel, it has been adopted by other UNIX systems based on the Mach kernel, including NeXTSTEP and macOS.
Member Function Documentation
◆ ReadFile()
|
overridevirtual |
Loads file into memory.
Implements Linker::Format.
◆ WriteFile()
|
overridevirtual |
Stores data in memory to file.
Implements Linker::Format.
The documentation for this class was generated from the following files:
- src/format/macho.h
- src/format/macho.cc
