Package com.pnfsoftware.jeb.core.units.code.asm.processor.arch

Class AbstractRegisterBank

java.lang.Object

com.pnfsoftware.jeb.core.units.code.asm.processor.arch.AbstractRegisterBank

All Implemented Interfaces:

IRegisterBank

Direct Known Subclasses:

AbstractRegisterBank2, RegisterBankArm, RegisterBankArm64, RegisterBankDummy1, RegisterBankEmpty, RegisterBankMips, RegisterBankMips64, RegisterBankX64, RegisterBankX86

public abstract class AbstractRegisterBank
extends Object
implements IRegisterBank

Base implementation of a registers bank layout.

It is preferable to use AbstractRegisterBank2 to define register banks.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	REG_GRP_GP	Group for general-purpose registers: always 0.
static final int	REG_GRP_SPECIAL	Group for non-GP registers and registers not fitting in other user-created groups.

Constructor Summary

Constructors

Constructor	Description
AbstractRegisterBank()

Method Summary

Modifier and Type	Method	Description
protected static RegisterDescriptionEntry	add(Map<Integer,RegisterDescriptionEntry> entries, int bitsize, String name)	Creates a RegisterDescriptionEntry based on its name and its bitsize
protected static RegisterDescriptionEntry	add(Map<Integer,RegisterDescriptionEntry> entries, int bitsize, String name, String altname)
protected static RegisterDescriptionEntry	add(Map<Integer,RegisterDescriptionEntry> entries, int bitsize, String name, String altname, RegisterEncoding encoding, RegisterType type)
String	format(int type)	Format the register bank as a string.
Collection<RegisterDescriptionEntry>	getAllDescriptionEntries()	Get the list of all (full and slices) register entries.
int	getCountOfDescriptionEntries()	Get the number of fill register entries.
Collection<RegisterDescriptionEntry>	getDescriptionEntries()	Get the list of full register entries.
RegisterDescriptionEntry	getDescriptionEntry(int regnum)	Get a full register entry by index (do not confuse with id).
RegisterDescriptionEntry	getDescriptionEntryById(long id)	Get a register entry (full or slice) by id (do not confuse with index).
RegisterDescriptionEntry	getDescriptionEntryByName(String name)	Get a register entry (full or slice) by name.
RegisterDescriptionEntry	getDescriptionEntryByName(Collection<String> names)	Get a register entry (full or slice) by name, using a list of candidate names.
RegisterDescriptionEntry	getDescriptionEntryByType(RegisterType type)	Get a full register entry by type.
abstract Map<Integer,RegisterDescriptionEntry>	getDescriptionEntryMap()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

REG_GRP_GP

public static final int REG_GRP_GP

Group for general-purpose registers: always 0.

See Also:

• Constant Field Values

REG_GRP_SPECIAL

public static final int REG_GRP_SPECIAL

Group for non-GP registers and registers not fitting in other user-created groups.

See Also:

• Constant Field Values

Constructor Details

AbstractRegisterBank

public AbstractRegisterBank()

Method Details

add

protected static RegisterDescriptionEntry add(Map<Integer,RegisterDescriptionEntry> entries,
 int bitsize,
 String name,
 String altname,
 RegisterEncoding encoding,
 RegisterType type)

add

protected static RegisterDescriptionEntry add(Map<Integer,RegisterDescriptionEntry> entries,
 int bitsize,
 String name,
 String altname)

add

protected static RegisterDescriptionEntry add(Map<Integer,RegisterDescriptionEntry> entries,
 int bitsize,
 String name)

Creates a RegisterDescriptionEntry based on its name and its bitsize

Parameters:

entries - global map

bitsize - bitsize of the register

name - name of the register

Returns:

getDescriptionEntries

public Collection<RegisterDescriptionEntry> getDescriptionEntries()

Description copied from interface: IRegisterBank

Get the list of full register entries. Slices are not returned.

Specified by:

getDescriptionEntries in interface IRegisterBank

Returns:

getDescriptionEntryMap

public abstract Map<Integer,RegisterDescriptionEntry> getDescriptionEntryMap()

Returns:

a map of full registers: key=index, value=full register entry

getDescriptionEntry

public RegisterDescriptionEntry getDescriptionEntry(int regnum)

Description copied from interface: IRegisterBank

Get a full register entry by index (do not confuse with id). Slices cannot be retrieved.

Specified by:

getDescriptionEntry in interface IRegisterBank

Returns:

getCountOfDescriptionEntries

public int getCountOfDescriptionEntries()

Description copied from interface: IRegisterBank

Get the number of fill register entries. Slices are not counted.

Specified by:

getCountOfDescriptionEntries in interface IRegisterBank

Returns:

getAllDescriptionEntries

public Collection<RegisterDescriptionEntry> getAllDescriptionEntries()

Description copied from interface: IRegisterBank

Get the list of all (full and slices) register entries.

Specified by:

getAllDescriptionEntries in interface IRegisterBank

Returns:

getDescriptionEntryByName

public RegisterDescriptionEntry getDescriptionEntryByName(String name)

Description copied from interface: IRegisterBank

Get a register entry (full or slice) by name.

Specified by:

getDescriptionEntryByName in interface IRegisterBank

Returns:

getDescriptionEntryByName

public RegisterDescriptionEntry getDescriptionEntryByName(Collection<String> names)

Description copied from interface: IRegisterBank

Get a register entry (full or slice) by name, using a list of candidate names. Useful when a register goes by different names.

Specified by:

getDescriptionEntryByName in interface IRegisterBank

Parameters:

names - candidate names

Returns:

getDescriptionEntryById

public RegisterDescriptionEntry getDescriptionEntryById(long id)

Description copied from interface: IRegisterBank

Get a register entry (full or slice) by id (do not confuse with index).

Specified by:

getDescriptionEntryById in interface IRegisterBank

Returns:

getDescriptionEntryByType

public RegisterDescriptionEntry getDescriptionEntryByType(RegisterType type)

Description copied from interface: IRegisterBank

Get a full register entry by type. Slices cannot be retrieved.

Specified by:

getDescriptionEntryByType in interface IRegisterBank

Returns:

toString

public String toString()

Overrides:

toString in class Object

format

public String format(int type)

Description copied from interface: IRegisterBank

Format the register bank as a string.

Specified by:

format in interface IRegisterBank

Parameters:

type - 0: short-form (i.e., #toString()), 1: user-friendly long-form

Returns:

the formatted bank