ghidra::VolatileOp Class Reference

A base class for operations that access volatile memory. More...

#include <userop.hh>

Inheritance diagram for ghidra::VolatileOp:

Collaboration diagram for ghidra::VolatileOp:

Public Member Functions
	VolatileOp (const string &nm, Architecture *g, uint4 tp, int4 ind)
	Constructor.
virtual void	decode (Decoder &decoder)
	Currently volatile ops only need their name.
Public Member Functions inherited from ghidra::UserPcodeOp
	UserPcodeOp (const string &nm, Architecture *g, uint4 tp, int4 ind)
	Construct from name and index.
const string &	getName (void) const
	Get the low-level name of the p-code op.
uint4	getType (void) const
	Get the encoded class type.
int4	getIndex (void) const
	Get the constant id of the op.
uint4	getDisplay (void) const
	Get display type (0=functional)
virtual	~UserPcodeOp (void)
	Destructor.
virtual string	getOperatorName (const PcodeOp *op) const
	Get the symbol representing this operation in decompiled code.
virtual Datatype *	getOutputLocal (const PcodeOp *op) const
	Return the output data-type of the user-op if specified.
virtual Datatype *	getInputLocal (const PcodeOp *op, int4 slot) const
	Return the input data-type to the user-op in the given slot.
virtual int4	extractAnnotationSize (const Varnode *vn, const PcodeOp *op)
	Assign a size to an annotation input to this userop.

Static Protected Member Functions
static string	appendSize (const string &base, int4 size)
	Append a suffix to a string encoding a specific size.

Additional Inherited Members
Public Types inherited from ghidra::UserPcodeOp
enum	userop_flags { annotation_assignment = 1 , no_operator = 2 , display_string = 4 }
	Enumeration of different boolean properties that can be assigned to a CALLOTHER. More...
enum	userop_type {   unspecialized = 1 , injected = 2 , volatile_read = 3 , volatile_write = 4 ,   segment = 5 , jumpassist = 6 , string_data = 7 , datatype = 8 }
	User-op class encoded as an enum. More...
Static Public Attributes inherited from ghidra::UserPcodeOp
static const uint4	BUILTIN_STRINGDATA = 0x10000000
	Built-in id for the InternalStringOp.
static const uint4	BUILTIN_VOLATILE_READ = 0x10000001
	Built-in id for VolatileReadOp.
static const uint4	BUILTIN_VOLATILE_WRITE = 0x10000002
	Built-in id for VolatileWriteOp.
static const uint4	BUILTIN_MEMCPY = 0x10000003
	Built-in id for memcpy.
static const uint4	BUILTIN_STRNCPY = 0x10000004
	Built-in id for strcpy.
static const uint4	BUILTIN_WCSNCPY = 0x10000005
	Built-in id for wcsncpy.
Protected Attributes inherited from ghidra::UserPcodeOp
string	name
	Low-level name of p-code operator.
Architecture *	glb
	Architecture owning the user defined op.
uint4	type
	Encoded class type (userop_type)
int4	useropindex
	Index passed in the CALLOTHER op.
uint4	flags
	Boolean attributes of the CALLOTHER.

Detailed Description

A base class for operations that access volatile memory.

The decompiler models volatile memory by converting any direct read or write of the memory to a function that accesses the memory. This class and its derived classes model such functions. Within the p-code control-flow, dedicated user defined ops serve as a placeholder for the (possibly unknown) effects of modifying/accessing the memory and prevent accidental constant propagation.

Member Function Documentation

appendSize()

string ghidra::VolatileOp::appendSize ( const string &  base, int4  size  )

staticprotected

Append a suffix to a string encoding a specific size.

This allows a single user defined operator to have multiple symbol names based on the size of its operands in context.

Parameters

base	is the string to append the suffix to
size	is the size to encode expressed as the number of bytes

Returns

the appended string

Referenced by ghidra::VolatileReadOp::getOperatorName(), and ghidra::VolatileWriteOp::getOperatorName().

decode()

virtual void ghidra::VolatileOp::decode ( Decoder &  decoder )

inlinevirtual

Currently volatile ops only need their name.

Implements ghidra::UserPcodeOp.

---

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

• /builds/appsec/reveng-binrw/ghidraplusplus/src/dec/userop.hh
• /builds/appsec/reveng-binrw/ghidraplusplus/src/dec/userop.cc