An Architecture that loads executables using an XML format. More...
#include <xml_arch.hh>
Inheritance diagram for ghidra::XmlArchitecture:
Public Member Functions | |
| virtual void | encode (Encoder &encoder) const |
| virtual void | restoreXml (DocumentStorage &store) |
| Restore the Architecture state from XML documents. More... | |
| XmlArchitecture (const string &fname, const string &targ, ostream *estream) | |
| Constructor. More... | |
 Public Member Functions inherited from ghidra::SleighArchitecture | |
| SleighArchitecture (const string &fname, const string &targ, ostream *estream) | |
| Construct given executable file. More... | |
| const string & | getFilename (void) const |
| Get the executable filename. | |
| const string & | getTarget (void) const |
| Get the language id of the active processor. | |
| void | encodeHeader (Encoder &encoder) const |
| Encode basic attributes of the active executable. More... | |
| void | restoreXmlHeader (const Element *el) |
| Restore from basic attributes of an executable. More... | |
| virtual void | printMessage (const string &message) const |
| Print an error message to console. More... | |
| virtual string | getDescription (void) const |
| Get a string describing this architecture. | |
| Public Member Functions inherited from ghidra::Architecture | |
| Architecture (void) | |
| Construct an uninitialized Architecture. More... | |
| void | init (DocumentStorage &store) |
| Load the image and configure architecture. More... | |
| void | resetDefaultsInternal (void) |
| Reset default values for options specific to Architecture. | |
| void | resetDefaults (void) |
| Reset defaults values for options owned by this. More... | |
| ProtoModel * | getModel (const string &nm) const |
| Get a specific PrototypeModel. More... | |
| bool | hasModel (const string &nm) const |
| Does this Architecture have a specific PrototypeModel. More... | |
| ProtoModel * | createUnknownModel (const string &modelName) |
| Create a model for an unrecognized name. More... | |
| bool | highPtrPossible (const Address &loc, int4 size) const |
| Are pointers possible to the given location? More... | |
| AddrSpace * | getSpaceBySpacebase (const Address &loc, int4 size) const |
| Get space associated with a spacebase register. More... | |
| const LanedRegister * | getLanedRegister (const Address &loc, int4 size) const |
| Get LanedRegister associated with storage. More... | |
| int4 | getMinimumLanedRegisterSize (void) const |
| Get the minimum size of a laned register in bytes. More... | |
| void | setDefaultModel (ProtoModel *model) |
| Set the default PrototypeModel. More... | |
| void | clearAnalysis (Funcdata *fd) |
| Clear analysis specific to a function. More... | |
| void | readLoaderSymbols (const string &delim) |
| Read any symbols from loader into database. More... | |
| void | collectBehaviors (vector< OpBehavior *> &behave) const |
| Provide a list of OpBehavior objects. More... | |
| SegmentOp * | getSegmentOp (AddrSpace *spc) const |
| Retrieve the segment op for the given space if any. More... | |
| void | setPrototype (const PrototypePieces &pieces) |
| Set the prototype for a particular function. More... | |
| void | setPrintLanguage (const string &nm) |
| Establish a particular output language. More... | |
| void | globalify (void) |
| Mark all spaces as global. More... | |
| void | decodeFlowOverride (Decoder &decoder) |
| Set flow overrides from XML. More... | |
| virtual | ~Architecture (void) |
| Destructor. More... | |
| virtual void | nameFunction (const Address &addr, string &name) const |
| Pick a default name for a function. More... | |
| Public Member Functions inherited from ghidra::AddrSpaceManager | |
| AddrSpaceManager (void) | |
| Construct an empty address space manager. More... | |
| virtual | ~AddrSpaceManager (void) |
| Destroy the manager. More... | |
| int4 | getDefaultSize (void) const |
| Get size of addresses for the default space. More... | |
| AddrSpace * | getSpaceByName (const string &nm) const |
| Get address space by name. More... | |
| AddrSpace * | getSpaceByShortcut (char sc) const |
| Get address space from its shortcut. More... | |
| AddrSpace * | getIopSpace (void) const |
| Get the internal pcode op space. More... | |
| AddrSpace * | getFspecSpace (void) const |
| Get the internal callspec space. More... | |
| AddrSpace * | getJoinSpace (void) const |
| Get the joining space. More... | |
| AddrSpace * | getStackSpace (void) const |
| Get the stack space for this processor. More... | |
| AddrSpace * | getUniqueSpace (void) const |
| Get the temporary register space for this processor. More... | |
| AddrSpace * | getDefaultCodeSpace (void) const |
| Get the default address space of this processor. More... | |
| AddrSpace * | getDefaultDataSpace (void) const |
| Get the default address space where data is stored. More... | |
| AddrSpace * | getConstantSpace (void) const |
| Get the constant space. More... | |
| Address | getConstant (uintb val) const |
| Get a constant encoded as an Address. More... | |
| Address | createConstFromSpace (AddrSpace *spc) const |
| Create a constant address encoding an address space. More... | |
| Address | resolveConstant (AddrSpace *spc, uintb val, int4 sz, const Address &point, uintb &fullEncoding) const |
| Resolve a native constant into an Address. More... | |
| int4 | numSpaces (void) const |
| Get the number of address spaces for this processor. More... | |
| AddrSpace * | getSpace (int4 i) const |
| Get an address space via its index. More... | |
| AddrSpace * | getNextSpaceInOrder (AddrSpace *spc) const |
| Get the next contiguous address space. More... | |
| JoinRecord * | findAddJoin (const vector< VarnodeData > &pieces, uint4 logicalsize) |
| Get (or create) JoinRecord for pieces. More... | |
| JoinRecord * | findJoin (uintb offset) const |
| Find JoinRecord for offset in the join space. More... | |
| void | setDeadcodeDelay (AddrSpace *spc, int4 delaydelta) |
| Set the deadcodedelay for a specific space. More... | |
| void | truncateSpace (const TruncationTag &tag) |
| Mark a space as truncated from its original size. More... | |
| Address | constructFloatExtensionAddress (const Address &realaddr, int4 realsize, int4 logicalsize) |
| Build a logically lower precision storage location for a bigger floating point register. More... | |
| Address | constructJoinAddress (const Translate *translate, const Address &hiaddr, int4 hisz, const Address &loaddr, int4 losz) |
| Build a logical whole from register pairs. More... | |
| void | renormalizeJoinAddress (Address &addr, int4 size) |
| Make sure a possibly offset join address has a proper JoinRecord. More... | |
| Address | parseAddressSimple (const string &val) |
| Parse a string with just an address space name and a hex offset. More... | |
Private Member Functions | |
| virtual void | buildLoader (DocumentStorage &store) |
| Build the LoadImage object and load the executable image. More... | |
| virtual void | postSpecFile (void) |
| Read in image information (which uses translator) | |
Private Attributes | |
| long | adjustvma |
| The amount to adjust the virtual memory address. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ghidra::SleighArchitecture | |
| static string | normalizeProcessor (const string &nm) |
| Try to recover a language id processor field. More... | |
| static string | normalizeEndian (const string &nm) |
| Try to recover a language id endianess field. More... | |
| static string | normalizeSize (const string &nm) |
| Try to recover a language id size field. More... | |
| static string | normalizeArchitecture (const string &nm) |
| Try to recover a language id string. More... | |
| static void | scanForSleighDirectories (const string &rootpath) |
| Scan directories for SLEIGH specification files. More... | |
| static const vector< LanguageDescription > & | getDescriptions (void) |
| Get list of all known language descriptions. More... | |
| static void | shutdown (void) |
| Shutdown all Translate objects and free global resources. | |
| Public Attributes inherited from ghidra::Architecture | |
| string | archid |
| ID string uniquely describing this architecture. | |
| int4 | trim_recurse_max |
| How many levels to let parameter trims recurse. | |
| int4 | max_implied_ref |
| Maximum number of references to an implied var. | |
| int4 | max_term_duplication |
| Max terms duplicated without a new variable. | |
| int4 | max_basetype_size |
| Maximum size of an "integer" type before creating an array type. | |
| int4 | min_funcsymbol_size |
| Minimum size of a function symbol. | |
| uint4 | max_jumptable_size |
| Maximum number of entries in a single JumpTable. | |
| bool | aggressive_ext_trim |
| Aggressively trim inputs that look like they are sign extended. | |
| bool | readonlypropagate |
| true if readonly values should be treated as constants | |
| bool | infer_pointers |
| True if we should infer pointers from constants that are likely addresses. | |
| bool | analyze_for_loops |
| True if we should attempt conversion of whiledo loops to for loops. | |
| vector< AddrSpace * > | inferPtrSpaces |
| Set of address spaces in which a pointer constant is inferable. | |
| int4 | funcptr_align |
| How many bits of alignment a function ptr has. | |
| uint4 | flowoptions |
| options passed to flow following engine | |
| uint4 | max_instructions |
| Maximum instructions that can be processed in one function. | |
| int4 | alias_block_level |
| Aliases blocked by 0=none, 1=struct, 2=array, 3=all. | |
| uint4 | split_datatype_config |
| Toggle for data-types splitting: Bit 0=structs, 1=arrays, 2=pointers. | |
| vector< Rule * > | extra_pool_rules |
| Extra rules that go in the main pool (cpu specific, experimental) | |
| Database * | symboltab |
| Memory map of global variables and functions. | |
| ContextDatabase * | context |
| Map from addresses to context settings. | |
| map< string, ProtoModel * > | protoModels |
| Parsed forms of possible prototypes. | |
| ProtoModel * | defaultfp |
| Parsed form of default prototype. | |
| VarnodeData | defaultReturnAddr |
| Default storage location of return address (for current function) | |
| ProtoModel * | evalfp_current |
| Function proto to use when evaluating current function. | |
| ProtoModel * | evalfp_called |
| Function proto to use when evaluating called functions. | |
| TypeFactory * | types |
| List of types for this binary. | |
| const Translate * | translate |
| Translation method for this binary. | |
| LoadImage * | loader |
| Method for loading portions of binary. | |
| PcodeInjectLibrary * | pcodeinjectlib |
| Pcode injection manager. | |
| RangeList | nohighptr |
| Ranges for which high-level pointers are not possible. | |
| CommentDatabase * | commentdb |
| Comments for this architecture. | |
| StringManager * | stringManager |
| Manager of decoded strings. | |
| ConstantPool * | cpool |
| Deferred constant values. | |
| PrintLanguage * | |
| Current high-level language printer. | |
| vector< PrintLanguage * > | printlist |
| List of high-level language printers supported. | |
| OptionDatabase * | options |
| Options that can be configured. | |
| vector< TypeOp * > | inst |
| Registered p-code instructions. | |
| UserOpManage | userops |
| Specifically registered user-defined p-code ops. | |
| vector< PreferSplitRecord > | splitrecords |
| registers that we would prefer to see split for this processor | |
| vector< LanedRegister > | lanerecords |
| Vector registers that have preferred lane sizes. | |
| ActionDatabase | allacts |
| Actions that can be applied in this architecture. | |
| bool | loadersymbols_parsed |
| True if loader symbols have been read. | |
| Static Public Attributes inherited from ghidra::SleighArchitecture | |
| static FileManage | specpaths |
| Known directories that contain .ldefs files. | |
| Protected Member Functions inherited from ghidra::SleighArchitecture | |
| virtual Translate * | buildTranslator (DocumentStorage &store) |
| Build the Translator object. More... | |
| virtual PcodeInjectLibrary * | buildPcodeInjectLibrary (void) |
| Build the injection library. More... | |
| virtual void | buildTypegrp (DocumentStorage &store) |
| Build the data-type factory/container. More... | |
| virtual void | buildCommentDB (DocumentStorage &store) |
| Build the comment database. More... | |
| virtual void | buildStringManager (DocumentStorage &store) |
| Build the string manager. More... | |
| virtual void | buildConstantPool (DocumentStorage &store) |
| Build the constant pool. More... | |
| virtual void | buildContext (DocumentStorage &store) |
| Build the Context database. More... | |
| virtual void | buildSymbols (DocumentStorage &store) |
| Build any symbols from spec files. More... | |
| virtual void | buildSpecFile (DocumentStorage &store) |
| Load any relevant specification files. More... | |
| virtual void | modifySpaces (Translate *trans) |
| Modify address spaces as required by this Architecture. More... | |
| virtual void | resolveArchitecture (void) |
| Figure out the processor and compiler of the target executable. | |
| Protected Member Functions inherited from ghidra::Architecture | |
| void | addSpacebase (AddrSpace *basespace, const string &nm, const VarnodeData &ptrdata, int4 truncSize, bool isreversejustified, bool stackGrowth, bool isFormal) |
| Create a new address space associated with a pointer register. More... | |
| void | addNoHighPtr (const Range &rng) |
| Add a new region where pointers do not exist. More... | |
| virtual Scope * | buildDatabase (DocumentStorage &store) |
| Build the database and global scope for this executable. More... | |
| virtual void | buildInstructions (DocumentStorage &store) |
| Register the p-code operations. More... | |
| virtual void | buildAction (DocumentStorage &store) |
| Build the Action framework. More... | |
| void | restoreFromSpec (DocumentStorage &store) |
| Fully initialize the Translate object. More... | |
| void | fillinReadOnlyFromLoader (void) |
| Load info about read-only sections. More... | |
| void | initializeSegments () |
| Set up segment resolvers. More... | |
| void | cacheAddrSpaceProperties (void) |
| Calculate some frequently used space properties and cache them. More... | |
| void | createModelAlias (const string &aliasName, const string &parentName) |
| Create name alias for a ProtoModel. More... | |
| void | parseProcessorConfig (DocumentStorage &store) |
| Apply processor specific configuration. More... | |
| void | parseCompilerConfig (DocumentStorage &store) |
| Apply compiler specific configuration. More... | |
| void | parseExtraRules (DocumentStorage &store) |
| Apply any Rule tags. More... | |
| void | decodeDynamicRule (Decoder &decoder) |
| Apply details of a dynamic Rule object. More... | |
| ProtoModel * | decodeProto (Decoder &decoder) |
| Parse a proto-type model from a stream. More... | |
| void | decodeProtoEval (Decoder &decoder) |
| Apply prototype evaluation configuration. More... | |
| void | decodeDefaultProto (Decoder &decoder) |
| Apply default prototype model configuration. More... | |
| void | decodeGlobal (Decoder &decoder, vector< RangeProperties > &rangeProps) |
| Parse information about global ranges. More... | |
| void | addToGlobalScope (const RangeProperties &props) |
| Add a memory range to the set of addresses considered global. More... | |
| void | addOtherSpace (void) |
| Add OTHER space and all of its overlays to the symboltab. | |
| void | decodeReadOnly (Decoder &decoder) |
| Apply read-only region configuration. More... | |
| void | decodeVolatile (Decoder &decoder) |
| Apply volatile region configuration. More... | |
| void | decodeReturnAddress (Decoder &decoder) |
| Apply return address configuration. More... | |
| void | decodeIncidentalCopy (Decoder &decoder) |
| Apply incidental copy configuration. More... | |
| void | decodeLaneSizes (Decoder &decoder) |
| Apply lane size configuration. More... | |
| void | decodeStackPointer (Decoder &decoder) |
| Apply stack pointer configuration. More... | |
| void | decodeDeadcodeDelay (Decoder &decoder) |
| Apply dead-code delay configuration. More... | |
| void | decodeInferPtrBounds (Decoder &decoder) |
| Apply pointer inference bounds. More... | |
| void | decodeFuncPtrAlign (Decoder &decoder) |
| Apply function pointer alignment configuration. More... | |
| void | decodeSpacebase (Decoder &decoder) |
| Create an additional indexed space. More... | |
| void | decodeNoHighPtr (Decoder &decoder) |
| Apply memory alias configuration. More... | |
| void | decodePreferSplit (Decoder &decoder) |
| Designate registers to be split. More... | |
| void | decodeAggressiveTrim (Decoder &decoder) |
| Designate how to trim extension p-code ops. More... | |
| Protected Member Functions inherited from ghidra::AddrSpaceManager | |
| AddrSpace * | decodeSpace (Decoder &decoder, const Translate *trans) |
| Add a space to the model based an on XML tag. More... | |
| void | decodeSpaces (Decoder &decoder, const Translate *trans) |
| Restore address spaces in the model from an XML tag. More... | |
| void | setDefaultCodeSpace (int4 index) |
| Set the default address space (for code) More... | |
| void | setDefaultDataSpace (int4 index) |
| Set the default address space for data. More... | |
| void | setReverseJustified (AddrSpace *spc) |
| Set reverse justified property on this space. More... | |
| void | assignShortcut (AddrSpace *spc) |
| Select a shortcut character for a new space. More... | |
| void | markNearPointers (AddrSpace *spc, int4 size) |
| Mark that given space can be accessed with near pointers. More... | |
| void | insertSpace (AddrSpace *spc) |
| Add a new address space to the model. More... | |
| void | copySpaces (const AddrSpaceManager *op2) |
| Copy spaces from another manager. More... | |
| void | addSpacebasePointer (SpacebaseSpace *basespace, const VarnodeData &ptrdata, int4 truncSize, bool stackGrowth) |
| Set the base register of a spacebase space. More... | |
| void | insertResolver (AddrSpace *spc, AddressResolver *rsolv) |
| Override the base resolver for a space. More... | |
| void | setInferPtrBounds (const Range &range) |
| Set the range of addresses that can be inferred as pointers. More... | |
| JoinRecord * | findJoinInternal (uintb offset) const |
| Find JoinRecord for offset in the join space. More... | |
| Static Protected Member Functions inherited from ghidra::SleighArchitecture | |
| static void | collectSpecFiles (ostream &errs) |
| Gather specification files in normal locations. More... | |
| Protected Attributes inherited from ghidra::SleighArchitecture | |
| ostream * | errorstream |
| Error stream associated with this SleighArchitecture. | |
Detailed Description
An Architecture that loads executables using an XML format.
Constructor & Destructor Documentation
◆ XmlArchitecture()
| ghidra::XmlArchitecture::XmlArchitecture | ( | const string & | fname, |
| const string & | targ, | ||
| ostream * | estream | ||
| ) |
Constructor.
This just wraps the base constructor
- Parameters
-
fname is the path to the executable file (containing XML) targ is the (optional) language id estream is the stream to use for the error console
References adjustvma.
Member Function Documentation
◆ buildLoader()
|
privatevirtual |
Build the LoadImage object and load the executable image.
- Parameters
-
store may hold configuration information
Implements ghidra::Architecture.
References ghidra::Document::getRoot(), ghidra::DocumentStorage::getTag(), ghidra::DocumentStorage::openDocument(), and ghidra::DocumentStorage::registerTag().
◆ encode()
|
virtual |
Prepend extra stuff to specify binary file and spec
- Parameters
-
encoder is the stream encoder
Reimplemented from ghidra::Architecture.
References adjustvma, ghidra::Encoder::closeElement(), ghidra::Architecture::encode(), ghidra::TypeFactory::encodeCoreTypes(), ghidra::SleighArchitecture::encodeHeader(), ghidra::Architecture::loader, ghidra::Encoder::openElement(), ghidra::Architecture::types, and ghidra::Encoder::writeUnsignedInteger().
◆ restoreXml()
|
virtual |
Restore the Architecture state from XML documents.
Read in all the sub-component state from a <save_state> XML tag When adding stuff to this BEWARE: The spec file has already initialized stuff
- Parameters
-
store is document store containing the parsed root tag
Reimplemented from ghidra::Architecture.
References adjustvma, ghidra::Element::getAttributeValue(), ghidra::Element::getChildren(), ghidra::DocumentStorage::getTag(), ghidra::Architecture::init(), ghidra::DocumentStorage::registerTag(), ghidra::Architecture::restoreXml(), and ghidra::SleighArchitecture::restoreXmlHeader().
The documentation for this class was generated from the following files:
- xml_arch.hh
- xml_arch.cc
