This class is a container of multiple memory items. More...

#include <CCodeStore.h>

Public Member Functions
	CCodeStore (const SPConnectionMgr &rspConnectionMgr)
	Creates a new instance.
void	clear ()
	Clears all items.
void	copy (const CCodeStore &rSrc)
	Copies from another code store instance.
bool	empty () const
	Returns true if container is empty.
void	exclude (TCodeStoreAddress aAddressExcl, TCodeStoreAddress aEndExcl)
	Excludes a range.
int	findItem (TCodeStoreAddress aAddress) const
	Finds an item in the requested range.
uint32_t	get_MAU_size ()
	Returns the size of one MAU (minimum addressable unit) in bytes.
TCodeStoreAddress	getBuffer (TCodeStoreAddress aAddress, std::vector< BYTE > &vBuffer) const
	Obtains the code from the specified region.
SPCodeStoreItem	getItem (int nIndex) const
	Returns item at index nIndex.
TCodeStoreAddress	getRangeHi () const
	Returns highest loaded location.
TCodeStoreAddress	getRangeLo () const
	Returns lowest loaded location.
TCodeStoreAddress	getTotal () const
	Returns total number of contained locations.
void	insert (TCodeStoreAddress aAddress, const std::vector< BYTE > vBuffer)
	Inserts a new chunk of code.
void	insertWithAccessInfo (TCodeStoreAddress aAddress, const std::vector< BYTE > vBuffer)
	Inserts a new chunk of code, but only bytes, which have valid access.
void	load (DWORD dwFlags, const std::string &rstrFileName, TCodeStoreAddress aOffset)
	Load from a file.
DWORD	load1 (DWORD dwFlags, const std::string &rstrFileName, TCodeStoreAddress aOffset)
	Load from a file.
int	numItems () const
	Returns number of all items.
bool	report (const std::string &fileReport, bool append, const std::string &format, DWORD maxInLine) const
	Creates a report to file.
bool	reportDif (const std::string &fileReport, bool append, const std::string &format, DWORD maxInLine, const CCodeStore &rCC1, const CCodeStore &rCC2) const
	Creates a difference report to file.
void	save (DWORD dwFlags, const std::string &rstrFileName, TCodeStoreAddress aOffset)
	Save to file.
void	set_MAU_size (uint32_t bytesPerMAU)
	Sets the size of one MAU (minimum addressable unit) in bytes.

Detailed Description

This class is a container of multiple memory items.

Each item is of type CCodeStoreItem

Note: This class has not been ported to Linux yet.

Python example for saving memory to Motorola S format: test_code_store.py

Constructor & Destructor Documentation

◆ CCodeStore()

isys::CCodeStore::CCodeStore ( const SPConnectionMgr & rspConnectionMgr )

Creates a new instance.

Parameters

rspConnectionMgr ConnectionMgr object

Since: 9.12.288

Member Function Documentation

◆ clear()

void isys::CCodeStore::clear ( )

Clears all items.

Since: 9.12.288

◆ copy()

void isys::CCodeStore::copy ( const CCodeStore & rSrc )

Copies from another code store instance.

Previous contents are cleared.

Parameters

rSrc	CCodeStore object to copy from

Since: 9.12.288

◆ empty()

bool isys::CCodeStore::empty ( ) const

Returns true if container is empty.

Returns

true : container is empty
false: container is not empty

Since: 9.12.288

◆ exclude()

void isys::CCodeStore::exclude	(	TCodeStoreAddress	aAddressExcl,
		TCodeStoreAddress	aEndExcl )

Excludes a range.

Parameters

aAddressExcl	start of range to exclude
aEndExcl	last address of range to exclude

Since: 9.12.288

◆ findItem()

int isys::CCodeStore::findItem ( TCodeStoreAddress aAddress ) const

Finds an item in the requested range.

Parameters

aAddress address which the found item covers

Returns

Index of the item
-1 - no item in the range

Since: 9.12.288

◆ get_MAU_size()

uint32_t isys::CCodeStore::get_MAU_size ( )

Returns the size of one MAU (minimum addressable unit) in bytes.

Returns

Number of bytes required for one MAU.

◆ getBuffer()

TCodeStoreAddress isys::CCodeStore::getBuffer	(	TCodeStoreAddress	aAddress,
		std::vector< BYTE > &	vBuffer ) const

Obtains the code from the specified region.

Parameters

aAddress	address from which the code should be retrieved
vBuffer	buffer which is filled with the code. Caller must preallocate vBuffer to the size that should be retrieved. For languages other than C++ use vBuffer = isystem.connect.VectorBYTE(size).

Returns

number of locations filled

Since: 9.12.288

◆ getItem()

SPCodeStoreItem isys::CCodeStore::getItem ( int nIndex ) const

Returns item at index nIndex.

Parameters

nIndex index of the element. Must be in range 0 .. numItems()-1

Returns

Pointer to item

Since: 9.12.288

◆ getRangeHi()

TCodeStoreAddress isys::CCodeStore::getRangeHi ( ) const

Returns highest loaded location.

Returns

Highest loaded location. 0 if empty

Since: 9.12.288

◆ getRangeLo()

TCodeStoreAddress isys::CCodeStore::getRangeLo ( ) const

Returns lowest loaded location.

Returns

Lowest loaded location. 0 if empty

Since: 9.12.288

◆ getTotal()

TCodeStoreAddress isys::CCodeStore::getTotal ( ) const

Returns total number of contained locations.

Returns

Number of contained locations

Since: 9.12.288

◆ insert()

void isys::CCodeStore::insert	(	TCodeStoreAddress	aAddress,
		const std::vector< BYTE >	vBuffer )

Inserts a new chunk of code.

Parameters

aAddress	address at which the new code is inserted
vBuffer	code to insert

Since: 9.12.288

◆ insertWithAccessInfo()

void isys::CCodeStore::insertWithAccessInfo	(	TCodeStoreAddress	aAddress,
		const std::vector< BYTE >	vBuffer )

Inserts a new chunk of code, but only bytes, which have valid access.

Use this method if data was obtaind by method CDataController::readMemory(), because only bytes, which have ACCESS_OK may be inserted into code cache.

Parameters

aAddress	address at which the new code is inserted
vBuffer	code to insert in the first vBuffer.size() / 2 bytes, access info in the last half.

Since: 9.12.288

◆ load()

void isys::CCodeStore::load	(	DWORD	dwFlags,
		const std::string &	rstrFileName,
		TCodeStoreAddress	aOffset )

Load from a file.

Parameters

dwFlags	for default behavior specify 0 for dwFlags, otherwise use ICodeCache::ESaveLoadFlags
rstrFileName	path to the file to load from
aOffset	offset to add to the code loaded from the file

Since: 9.12.288

◆ load1()

DWORD isys::CCodeStore::load1	(	DWORD	dwFlags,
		const std::string &	rstrFileName,
		TCodeStoreAddress	aOffset )

Load from a file.

The same operation as load(), but this one returns format used in loading the file.

Parameters

dwFlags	for default behavior specify 0 for dwFlags, otherwise use ICodeCache::ESaveLoadFlags
rstrFileName	path to the file to load from
aOffset	offset to add to the code loaded from the file

Returns

Format used in loading the file. See ICodeCache::ESaveLoadFlags, enums lFormat... for possible return values and associated format. In Python you can refer to them as ic.ICodeCache.lFormatELF, for example.

Since: 9.12.288

◆ numItems()

int isys::CCodeStore::numItems ( ) const

Returns number of all items.

Returns

Number of items

Since: 9.12.288

◆ report()

bool isys::CCodeStore::report	(	const std::string &	fileReport,
		bool	append,
		const std::string &	format,
		DWORD	maxInLine ) const

Creates a report to file.

Parameters

fileReport	path to the report file
append	true to append, false to create a new file
format	for every single item, using %ADDR%, %SIZE%, %EADDR% and %DATA% macros. If empty, the default "A:%ADDR% S:%SIZE% D:%DATA%" is used
maxInLine	specifies maximum number of addresses reported in a line. Use 0 to report contiguous ranges in one line

Returns

true on success

Since: 9.12.288

◆ reportDif()

bool isys::CCodeStore::reportDif	(	const std::string &	fileReport,
		bool	append,
		const std::string &	format,
		DWORD	maxInLine,
		const CCodeStore &	rCC1,
		const CCodeStore &	rCC2 ) const

Creates a difference report to file.

Parameters

fileReport	path to the report file
append	true to append, false to create a new file
format	for every single item, using %ADDR%, %SIZE%, %EADDR%, %DIF% and %DATA1%, %DATA2% macros. If empty, the default "A:%ADDR% S:%SIZE%\n D1:%DATA1%\n D2:%DATA2%" is used
maxInLine	specifies maximum number of addresses reported in a line. Use 0 to report contiguous ranges in one line
rCC1	is the first reference code store from which this difference object was created
rCC2	is the second reference code store from which this difference object was created

Returns

true on success

Since: 9.12.288

◆ save()

void isys::CCodeStore::save	(	DWORD	dwFlags,
		const std::string &	rstrFileName,
		TCodeStoreAddress	aOffset )

Save to file.

Parameters

dwFlags	use ICodeCache::ESaveLoadFlags to specify format. Only lFormatMotorolaS lFormatIntelHex and lFormatBinary are supported. Note: Gaps in the store are padded with 0h when saving to binary file.
rstrFileName	path to the file to save to
aOffset	offset to add to the code saved to the file. If format is binary, then the offset determines the position in the store from where the saving starts.

Since: 9.12.288

◆ set_MAU_size()

void isys::CCodeStore::set_MAU_size ( uint32_t bytesPerMAU )

Sets the size of one MAU (minimum addressable unit) in bytes.

The default value is 1, which is appropriate for most architectures.

The number of bytes required for every MAU is:

MAU Size in bits	Bytes Required per MAU
1 - 8	1
9 - 16	2
17 - 32	4

Parameters

bytesPerMAU Number of bytes required for one MAU.

winIDEA SDK

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CCodeStore()

Member Function Documentation

◆ clear()

◆ copy()

◆ empty()

◆ exclude()

◆ findItem()

◆ get_MAU_size()

◆ getBuffer()

◆ getItem()

◆ getRangeHi()

◆ getRangeLo()

◆ getTotal()

◆ insert()

◆ insertWithAccessInfo()

◆ load()

◆ load1()

◆ numItems()

◆ report()

◆ reportDif()

◆ save()

◆ set_MAU_size()