Package mars.tools

Class InstructionStatistics

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

mars.tools.AbstractMarsTool

mars.tools.InstructionStatistics

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants, Memory.Listener, MarsTool

public class InstructionStatistics
extends AbstractMarsTool

A MARS tool for obtaining instruction statistics by instruction category.

The code of this tools is initially based on the InstructionCounter tool by Felipe Lessa.

Author:

Ingo Kofler (ingo.kofler@itec.uni-klu.ac.at)

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JFrame

JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected int	lastAddress	The last address we saw.

Fields inherited from class mars.tools.AbstractMarsTool

dialog

Fields inherited from class javax.swing.JFrame

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
InstructionStatistics()	Construct an instance of this tool.

Method Summary

Modifier and Type	Method	Description
protected JComponent	buildMainDisplayArea()	creates the display area for the tool as required by the API
protected int	getInstructionCategory(BasicStatement stmt)	decodes the instruction and determines the category of the instruction.
String	getName()	returns the name of the tool
protected void	initializePreGUI()	performs initialization tasks of the counters before the GUI is created.
void	memoryRead(int address, int length, int value, int wordAddress, int wordValue)	Method that is called each time the MIPS simulator accesses the text segment.
protected void	reset()	resets the counter values of the tool and updates the display.
protected void	startObserving()	registers the tool as observer for the text segment of the MIPS program
protected void	stopObserving()	Unregister this tool as a listener of memory and/or registers, if applicable.

Methods inherited from class mars.tools.AbstractMarsTool

action, buildButtonArea, buildContentPane, closeTool, getHelpComponent, handleClose, initializePostGUI

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface mars.tools.MarsTool

getIcon, getToolMenuOrder

Methods inherited from interface mars.mips.hardware.Memory.Listener

memoryReset, memoryWritten

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Details

lastAddress

protected int lastAddress

The last address we saw. We ignore it because the only way for a program to execute twice the same instruction is to enter an infinite loop, which is not insteresting in the POV of counting instructions.

Constructor Details

InstructionStatistics

public InstructionStatistics()

Construct an instance of this tool. This will be used by the ToolManager.

Method Details

getName

public String getName()

returns the name of the tool

Specified by:

getName in interface MarsTool

Specified by:

getName in class AbstractMarsTool

Returns:

the tools's name

buildMainDisplayArea

protected JComponent buildMainDisplayArea()

creates the display area for the tool as required by the API

Specified by:

buildMainDisplayArea in class AbstractMarsTool

Returns:

a panel that holds the GUI of the tool

startObserving

protected void startObserving()

registers the tool as observer for the text segment of the MIPS program

Overrides:

startObserving in class AbstractMarsTool

See Also:

• Register.addListener(Register.Listener)
• Memory.addListener(Memory.Listener)
• Memory.addListener(Memory.Listener, int)
• Memory.addListener(Memory.Listener, int, int)

stopObserving

protected void stopObserving()

Description copied from class: AbstractMarsTool

Unregister this tool as a listener of memory and/or registers, if applicable. This method is called when the tool is closed by the user. Does nothing by default.

Overrides:

stopObserving in class AbstractMarsTool

See Also:

• Register.removeListener(Register.Listener)
• Memory.removeListener(Memory.Listener)

getInstructionCategory

protected int getInstructionCategory(BasicStatement stmt)

decodes the instruction and determines the category of the instruction.

The instruction is decoded by extracting the operation and function code of the 32-bit instruction. Only the most relevant instructions are decoded and categorized.

Parameters:

stmt - the instruction to decode

Returns:

the category of the instruction

See Also:

• CATEGORY_ALU
• CATEGORY_JUMP
• CATEGORY_BRANCH
• CATEGORY_MEM
• CATEGORY_OTHER

memoryRead

public void memoryRead(int address,
 int length,
 int value,
 int wordAddress,
 int wordValue)

Method that is called each time the MIPS simulator accesses the text segment. Before an instruction is executed by the simulator, the instruction is fetched from the program memory. This memory access is observed and the corresponding instruction is decoded and categorized by the tool. According to the category the counter values are increased and the display gets updated.

Parameters:

address - The address which was read from.

length - The number of bytes read. Will always be 1 (single byte), Memory.BYTES_PER_HALFWORD, or Memory.BYTES_PER_WORD.

value - The value which was read.

wordAddress - The address of the word affected by the operation.

wordValue - The full value of the word.

initializePreGUI

protected void initializePreGUI()

performs initialization tasks of the counters before the GUI is created.

Overrides:

initializePreGUI in class AbstractMarsTool

reset

protected void reset()

resets the counter values of the tool and updates the display.

Overrides:

reset in class AbstractMarsTool