org.apache.sysml.runtime.instructions

Class Instruction

java.lang.Object

org.apache.sysml.runtime.instructions.Instruction

Direct Known Subclasses:

ExternalFunctionInvocationInstruction, GPUInstruction, MRJobInstruction, SPInstruction

public abstract class Instruction
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Instruction.INSTRUCTION_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
protected int	beginCol
protected int	beginLine
static String	DATATYPE_PREFIX
protected int	endCol
protected int	endLine
protected String	filename
static String	GPU_INST_PREFIX
protected String	instOpcode
static String	INSTRUCTION_DELIM
protected String	instString
static String	LITERAL_PREFIX
protected static org.apache.commons.logging.Log	LOG
static String	OPERAND_DELIM
static String	SP_INST_PREFIX
protected Instruction.INSTRUCTION_TYPE	type
static String	VALUETYPE_PREFIX

Constructor Summary

Constructors

Constructor and Description
Instruction()

Method Summary

Modifier and Type	Method and Description
int	getBeginColumn()
int	getBeginLine()
int	getEndColumn()
int	getEndLine()
String	getExtendedOpcode()
String	getFilename()
String	getGraphString()
long	getInstID() Getter for instruction unique identifier
int	getLineNum() Getter for instruction line number
String	getOpcode()
Instruction.INSTRUCTION_TYPE	getType()
void	postprocessInstruction(org.apache.sysml.runtime.controlprogram.context.ExecutionContext ec) This method should be used for any tear down after executing this instruction.
Instruction	preprocessInstruction(org.apache.sysml.runtime.controlprogram.context.ExecutionContext ec) This method should be used for any setup before executing this instruction.
void	printMe()
abstract void	processInstruction(org.apache.sysml.runtime.controlprogram.context.ExecutionContext ec) This method should be used to execute the instruction.
boolean	requiresLabelUpdate()
void	setInstID(long id) Setter for instruction unique identifier
void	setLocation(org.apache.sysml.parser.DataIdentifier id)
void	setLocation(Instruction oldInst)
void	setLocation(org.apache.sysml.lops.Lop lop)
void	setLocation(String filename, int beginLine, int endLine, int beginCol, int endCol)
void	setType(Instruction.INSTRUCTION_TYPE tp)
String	toString()
void	updateInstructionThreadID(String pattern, String replace) All instructions that have thread-specific filenames or names encoded in it should overwrite this method in order to update (1) the in-memory instruction and (2) the instruction string

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

OPERAND_DELIM

public static final String OPERAND_DELIM

See Also:

Constant Field Values

DATATYPE_PREFIX

public static final String DATATYPE_PREFIX

See Also:

Constant Field Values

VALUETYPE_PREFIX

public static final String VALUETYPE_PREFIX

See Also:

Constant Field Values

LITERAL_PREFIX

public static final String LITERAL_PREFIX

See Also:

Constant Field Values

INSTRUCTION_DELIM

public static final String INSTRUCTION_DELIM

See Also:

Constant Field Values

SP_INST_PREFIX

public static final String SP_INST_PREFIX

See Also:

Constant Field Values

GPU_INST_PREFIX

public static final String GPU_INST_PREFIX

See Also:

Constant Field Values

type

protected Instruction.INSTRUCTION_TYPE type

instString

protected String instString

instOpcode

protected String instOpcode

filename

protected String filename

beginLine

protected int beginLine

endLine

protected int endLine

beginCol

protected int beginCol

endCol

protected int endCol

Constructor Detail

Instruction

public Instruction()

Method Detail

getFilename

public String getFilename()

getBeginLine

public int getBeginLine()

getEndLine

public int getEndLine()

getBeginColumn

public int getBeginColumn()

getEndColumn

public int getEndColumn()

setType

public void setType(Instruction.INSTRUCTION_TYPE tp)

getType

public Instruction.INSTRUCTION_TYPE getType()

setLocation

public void setLocation(String filename,
                        int beginLine,
                        int endLine,
                        int beginCol,
                        int endCol)

setLocation

public void setLocation(org.apache.sysml.lops.Lop lop)

setLocation

public void setLocation(org.apache.sysml.parser.DataIdentifier id)

setLocation

public void setLocation(Instruction oldInst)

getLineNum

public int getLineNum()

Getter for instruction line number

Returns:

lineNum Instruction approximate DML script line number

setInstID

public void setInstID(long id)

Setter for instruction unique identifier

Parameters:

id - Instruction unique identifier

getInstID

public long getInstID()

Getter for instruction unique identifier

Returns:

instID Instruction unique identifier

printMe

public void printMe()

toString

public String toString()

Overrides:

toString in class Object

getGraphString

public String getGraphString()

getOpcode

public String getOpcode()

getExtendedOpcode

public String getExtendedOpcode()

requiresLabelUpdate

public boolean requiresLabelUpdate()

updateInstructionThreadID

public void updateInstructionThreadID(String pattern,
                                      String replace)
                               throws DMLRuntimeException

All instructions that have thread-specific filenames or names encoded in it should overwrite this method in order to update (1) the in-memory instruction and (2) the instruction string

Parameters:

pattern - ?

replace - ?

Throws:

DMLRuntimeException - if DMLRuntimeException occurs

preprocessInstruction

public Instruction preprocessInstruction(org.apache.sysml.runtime.controlprogram.context.ExecutionContext ec)
                                  throws DMLRuntimeException

This method should be used for any setup before executing this instruction. Overwriting methods should first call the super method and subsequently do their custom setup.

Parameters:

ec - execution context

Returns:

instruction

Throws:

DMLRuntimeException - if DMLRuntimeException occurs

processInstruction

public abstract void processInstruction(org.apache.sysml.runtime.controlprogram.context.ExecutionContext ec)
                                 throws DMLRuntimeException

This method should be used to execute the instruction.

Parameters:

ec - execution context

Throws:

DMLRuntimeException - if DMLRuntimeException occurs

postprocessInstruction

public void postprocessInstruction(org.apache.sysml.runtime.controlprogram.context.ExecutionContext ec)
                            throws DMLRuntimeException

This method should be used for any tear down after executing this instruction. Overwriting methods should first do their custom tear down and subsequently call the super method.

Parameters:

ec - execution context

Throws:

DMLRuntimeException - if DMLRuntimeException occurs