cetus.analysis

Class InlineExpansion

java.lang.Object

cetus.analysis.InlineExpansion

public class InlineExpansion
extends java.lang.Object

Performs simple function inlining. It assumes that the code to be inlined is already compiled correctly and has no errors. Following are taken care of: * Functions that result in recursion are not inlined * Functions that use static external variables are not inlined * Global variables used in the function to be inlined are handled by declaring them as extern * Variable reshaping (array-dimensions) is handled * Long function call chains (a->b->c->d->...) are handled as long as they do not result in a recursion * Switches are provided for controlling variable names and their length * Support for making log * Comments with the inlined code

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODE_DEFAULT Default mode for inlining, inlining will be performed inside main function
static int	MODE_INLINE_PRAGMAS Same as "MODE_INLINEIN_PRAGMAS" except that "inline" pragmas will also be honored
static int	MODE_INLINEIN_PRAGMAS Starting from main function inline the code which is inside "inlinein" pragmas
static int	MODE_INSIDE_SELECTED_FUNCTIONS Inlining will be performed inside the selected functions provided on command line via "functions" option
static int	MODE_SELECTED_FUNCTIONS_INVOCATIONS The selected functions provided on command line will be inlined wherever they are invoked

Constructor Summary

Constructors

Constructor and Description
InlineExpansion() default constructor
InlineExpansion(int mode)
InlineExpansion(int mode, java.util.ArrayList<java.lang.String> functions) Creates an instance of the Inliner

Method Summary

Methods

Modifier and Type	Method and Description
java.util.ArrayList<java.lang.String>	getCommandlineFunctions() returns an array list of function names provided at the command line for MODE_INSIDE_SELECTED_FUNCTIONS and MODE_SELECTED_FUNCTIONS_INVOCATIONS modes
java.lang.String	getLabelPrefix() returns the prefix used in naming labels that replace labels in the inlined code
java.lang.String	getLocalVarPrefix() returns the prefix used in naming variables that replace local variables in the inlined code
int	getMaxVarLength() returns the maximum allowed length for the variable names that inlining introduces
int	getMode() tells the mode of the inliner, which is one of the MODE_XXX constants
java.lang.String	getParamPrefix() returns the prefix used in naming variables that replace parameters in the function to be inlined
java.lang.String	getResultPrefix() returns the prefix used in naming the variable that holds the return value of the function that has been inlined
void	inline(Program program) performs inlining in the given program according to the options that have been set before calling this function Following are taken care of: * Functions that result in recursion are not inlined * Functions that use static external variables are not inlined * Global variables used in the function to be inlined are handled by declaring them as extern * Variable reshaping (array-dimensions) is handled * Long function call chains (a->b->c->d->...) are handled as long as they do not result in a recursion * Switches are provided for controlling variable names and their lengths * Support for making log * Comments with the inlined code
void	inlineIn(CompoundStatement inlineIn) inlines the function calls in the given compound statement, doesn't go deeper than that i.e.
void	inlineIn(Procedure proc) inlines the function calls in the body of the given procedure, doesn't go deeper than that i.e.
boolean	isComplementFunctions() tells if the complement functions option is on
boolean	isDebugOption() tells if the debug option is on
boolean	isFullyQualifiedName() tells if the inlining code uses verbose names for variables that it introuduces
boolean	isHonorPragmas() tells if the honor pragmas option is on
boolean	isInlineFuncsWithStaticVars() tells if the functions having static local variables will be inlined or not
boolean	isInsideForOnly() tells if the foronly option is on
boolean	isLevel_1() tells if the level_1 option is on
boolean	isMakeLog() tells if the log is being made
void	setCommandlineFunctions(java.util.ArrayList<java.lang.String> functions) sets the function names given on command line for MODE_INSIDE_SELECTED_FUNCTIONS and MODE_SELECTED_FUNCTIONS_INVOCATIONS modes
void	setComplementFunctions(boolean complementFunctions) sets the complement functions option, which when on, will consider all functions for inlining according to the provided mode, except the ones given in the command line
void	setDebugOption(boolean debug) sets the debug option, which when on, will not result in deleting the unreachable functions after inlining
void	setFullyQualifiedName(boolean verboseName) sets the option to have verbose variable names
void	setHonorPragmas(boolean honorPragmas) sets the honor pragmas option
void	setInlineFuncsWithStaticVars(boolean inline) sets the option to inline functions that have static local variables
void	setInsideForOnly(boolean insideForOnly) sets the inside foronly option, which when on, will instruct the inliner to try to inline the function calls inside for loops only
void	setLabelPrefix(java.lang.String labelPrefix) sets the currently used prefix for new labels replacing old labels
void	setLevel_1(boolean level_1) sets the level_1 option, which when on, will result in 1-level inlining as opposed to recursive
void	setLocalVarPrefix(java.lang.String localVarPrefix) sets the currently used prefix for new variables replacing old local variables
void	setMakeLog(boolean makeLog) sets the make-log flag
void	setMaxVarLength(int length) sets the maximum length for the variables introduced by inlining
void	setMode(int mode) sets the mode for the inliner
void	setParamPrefix(java.lang.String paramPrefix) sets the currently used prefix for new variables replacing old function parameters
void	setResultPrefix(java.lang.String resultPrefix) sets the currently used prefix for new variables used to hold return value of the function that has been inlined

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MODE_DEFAULT

public static final int MODE_DEFAULT

Default mode for inlining, inlining will be performed inside main function

See Also:

Constant Field Values

MODE_INSIDE_SELECTED_FUNCTIONS

public static final int MODE_INSIDE_SELECTED_FUNCTIONS

Inlining will be performed inside the selected functions provided on command line via "functions" option

See Also:

Constant Field Values

MODE_SELECTED_FUNCTIONS_INVOCATIONS

public static final int MODE_SELECTED_FUNCTIONS_INVOCATIONS

The selected functions provided on command line will be inlined wherever they are invoked

See Also:

Constant Field Values

MODE_INLINEIN_PRAGMAS

public static final int MODE_INLINEIN_PRAGMAS

Starting from main function inline the code which is inside "inlinein" pragmas

See Also:

Constant Field Values

MODE_INLINE_PRAGMAS

public static final int MODE_INLINE_PRAGMAS

Same as "MODE_INLINEIN_PRAGMAS" except that "inline" pragmas will also be honored

See Also:

Constant Field Values

Constructor Detail

InlineExpansion

public InlineExpansion()

default constructor

InlineExpansion

public InlineExpansion(int mode)

Parameters:

mode - - the mode for the inliner, should be one of the MODE_XXX constants

InlineExpansion

public InlineExpansion(int mode,
               java.util.ArrayList<java.lang.String> functions)

Creates an instance of the Inliner

Parameters:

mode - - mode for the inliner, should be one of the MODE_XXX constants

functions - - ArrayList containing function names provided by the user on the command line - it will be used by MODE_INSIDE_SELECTED_FUNCTIONS and MODE_SELECTED_FUNCTIONS_INVOCATIONS modes

Method Detail

setMakeLog

public void setMakeLog(boolean makeLog)

sets the make-log flag

Parameters:

makeLog - - new value for the currently used make-log option

setParamPrefix

public void setParamPrefix(java.lang.String paramPrefix)

sets the currently used prefix for new variables replacing old function parameters

Parameters:

paramPrefix - - the new prefix

setResultPrefix

public void setResultPrefix(java.lang.String resultPrefix)

sets the currently used prefix for new variables used to hold return value of the function that has been inlined

Parameters:

resultPrefix - - the new prefix

setLocalVarPrefix

public void setLocalVarPrefix(java.lang.String localVarPrefix)

sets the currently used prefix for new variables replacing old local variables

Parameters:

localVarPrefix - - the new prefix for local variables in the inlined code

setLabelPrefix

public void setLabelPrefix(java.lang.String labelPrefix)

sets the currently used prefix for new labels replacing old labels

Parameters:

labelPrefix - - the new prefix for labels in the inlined code

setMaxVarLength

public void setMaxVarLength(int length)

sets the maximum length for the variables introduced by inlining

Parameters:

length - - new length for variables

setFullyQualifiedName

public void setFullyQualifiedName(boolean verboseName)

sets the option to have verbose variable names

Parameters:

verboseName - - the option to have verbose names

setInlineFuncsWithStaticVars

public void setInlineFuncsWithStaticVars(boolean inline)

sets the option to inline functions that have static local variables

Parameters:

inline - - the option to inline such function

setMode

public void setMode(int mode)

sets the mode for the inliner

Parameters:

mode - - the mode value, should be one of the MODE_XXX constants

setCommandlineFunctions

public void setCommandlineFunctions(java.util.ArrayList<java.lang.String> functions)

sets the function names given on command line for MODE_INSIDE_SELECTED_FUNCTIONS and MODE_SELECTED_FUNCTIONS_INVOCATIONS modes

Parameters:

functions - - function names provided on the command line

setDebugOption

public void setDebugOption(boolean debug)

sets the debug option, which when on, will not result in deleting the unreachable functions after inlining

Parameters:

debug - - the boolean value for debug option

setHonorPragmas

public void setHonorPragmas(boolean honorPragmas)

sets the honor pragmas option

Parameters:

honorPragmas - - the boolean value for honor pragmas option

setLevel_1

public void setLevel_1(boolean level_1)

sets the level_1 option, which when on, will result in 1-level inlining as opposed to recursive

Parameters:

level_1 - - the boolean value for level_1 option

setInsideForOnly

public void setInsideForOnly(boolean insideForOnly)

sets the inside foronly option, which when on, will instruct the inliner to try to inline the function calls inside for loops only

Parameters:

insdeForOnly - - the boolean value for foronly option

setComplementFunctions

public void setComplementFunctions(boolean complementFunctions)

sets the complement functions option, which when on, will consider all functions for inlining according to the provided mode, except the ones given in the command line

Parameters:

complementFunctions - - the boolean value for complement functions option

isMakeLog

public boolean isMakeLog()

tells if the log is being made

getParamPrefix

public java.lang.String getParamPrefix()

returns the prefix used in naming variables that replace parameters in the function to be inlined

getLocalVarPrefix

public java.lang.String getLocalVarPrefix()

returns the prefix used in naming variables that replace local variables in the inlined code

getLabelPrefix

public java.lang.String getLabelPrefix()

returns the prefix used in naming labels that replace labels in the inlined code

getResultPrefix

public java.lang.String getResultPrefix()

returns the prefix used in naming the variable that holds the return value of the function that has been inlined

getMaxVarLength

public int getMaxVarLength()

returns the maximum allowed length for the variable names that inlining introduces

isFullyQualifiedName

public boolean isFullyQualifiedName()

tells if the inlining code uses verbose names for variables that it introuduces

isInlineFuncsWithStaticVars

public boolean isInlineFuncsWithStaticVars()

tells if the functions having static local variables will be inlined or not

getMode

public int getMode()

tells the mode of the inliner, which is one of the MODE_XXX constants

getCommandlineFunctions

public java.util.ArrayList<java.lang.String> getCommandlineFunctions()

returns an array list of function names provided at the command line for MODE_INSIDE_SELECTED_FUNCTIONS and MODE_SELECTED_FUNCTIONS_INVOCATIONS modes

Returns:

isDebugOption

public boolean isDebugOption()

tells if the debug option is on

isHonorPragmas

public boolean isHonorPragmas()

tells if the honor pragmas option is on

isLevel_1

public boolean isLevel_1()

tells if the level_1 option is on

isInsideForOnly

public boolean isInsideForOnly()

tells if the foronly option is on

isComplementFunctions

public boolean isComplementFunctions()

tells if the complement functions option is on

inline

public void inline(Program program)

performs inlining in the given program according to the options that have been set before calling this function Following are taken care of: * Functions that result in recursion are not inlined * Functions that use static external variables are not inlined * Global variables used in the function to be inlined are handled by declaring them as extern * Variable reshaping (array-dimensions) is handled * Long function call chains (a->b->c->d->...) are handled as long as they do not result in a recursion * Switches are provided for controlling variable names and their lengths * Support for making log * Comments with the inlined code

Parameters:

program - - the program

inlineIn

public void inlineIn(Procedure proc)

inlines the function calls in the body of the given procedure, doesn't go deeper than that i.e. does not inline inside functions called by the procedure recursively.

Parameters:

proc - - the procedure Following are taken care of: * Function calls that result in recursion are not inlined * Functions that use static external variables are not inlined * Global variables used in the function to be inlined are handled by declaring them as extern * Variable reshaping (array-dimensions) is handled * Switches are provided for controlling variable names and their lengths * Support for making log * Comments with the inlined code

inlineIn

public void inlineIn(CompoundStatement inlineIn)

inlines the function calls in the given compound statement, doesn't go deeper than that i.e. does not inline inside functions called from the given compound statement.

Parameters:

inlineIn - - the compound statement in which inlining is to be performed Following are taken care of: * Function calls that result in recursion are not inlined * Functions that use static external variables are not inlined * Global variables used in the function to be inlined are handled by declaring them as extern * Variable reshaping (array-dimensions) is handled * Switches are provided for controlling variable names and their lengths * Support for making log * Comments with the inlined code