claw.tatsu.primitive

Class Loop

java.lang.Object

claw.tatsu.primitive.Loop

public final class Loop
extends java.lang.Object

Primitive transformation and test applied on FdoStatement. This included: - loop fusion (merge) - loop reorder (reorder) - loop hoisting (hoist) - extract body of a loop - check iteration range

Author:

clementval

Method Summary

Modifier and Type	Method and Description
static void	extractBody(NestedDoStatement nest) Extract the body of the inner do statement and place it directly after the outer do statement.
static void	extractBody(Xnode loop) Extract the body of a do statement and place it directly after it.
static void	extractBody(Xnode loop, Xnode ref) Extract the body of a do statement and place it after the reference node.
static java.lang.String	extractInductionVariable(Xnode doStatement) Get the string representation of the induction variable of a do statement.
static boolean	hasSameIndexRange(Xnode l1, Xnode l2) Compare the iteration range of two do statements.
static boolean	hasSameIndexRangeBesidesLower(Xnode l1, Xnode l2) Compare the iteration range of two do statements.
static HoistedNestedDoStatement	hoist(java.util.List<HoistedNestedDoStatement> hoistedGroups, Xnode start, Xnode end, XcodeML xcodeml) Perform a loop hoisting on the given nested do statements.
static void	merge(NestedDoStatement master, NestedDoStatement slave) Merge two nested do statements group together.
static void	merge(Xnode masterDoStmt, Xnode slaveDoStmt) Merge two do statements together.
static void	reorder(NestedDoStatement nestedGroup, java.util.List<java.lang.String> newInductionVarOrder) Perform a do statements reordering based on the new order specified by induction variables.

Methods inherited from class java.lang.Object

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

Method Detail

merge

public static void merge(Xnode masterDoStmt,
                         Xnode slaveDoStmt)
                  throws IllegalTransformationException

Merge two do statements together. Body of the slave do statement will be append to the body of the master do statement.

Parameters:

masterDoStmt - Master do statement for the merge operation. Stay in place. Other do statement will be merged into it.

slaveDoStmt - Slave do statement for the merge operation. Will be merged into the master do statement.

Throws:

IllegalTransformationException - If given node are null or not FdoStatement nodes.

merge

public static void merge(NestedDoStatement master,
                         NestedDoStatement slave)
                  throws IllegalTransformationException

Merge two nested do statements group together. Inner most body of the slave group is merged into the inner most body of the master group. Slave group is then deleted.

Parameters:

master - Master nested do statements group for the merge operation.

slave - Slave nested do statements group for the merge operation.

Throws:

IllegalTransformationException - If given node are null or not FdoStatement nodes.

reorder

public static void reorder(NestedDoStatement nestedGroup,
                           java.util.List<java.lang.String> newInductionVarOrder)
                    throws IllegalTransformationException

Perform a do statements reordering based on the new order specified by induction variables. i,j,k → k,j,i

Parameters:

nestedGroup - The nested group of do statements to be reordered.

newInductionVarOrder - New order of the induction variables. E.g. k,j,i.

Throws:

IllegalTransformationException - If reordering acton is not supported.

hoist

public static HoistedNestedDoStatement hoist(java.util.List<HoistedNestedDoStatement> hoistedGroups,
                                             Xnode start,
                                             Xnode end,
                                             XcodeML xcodeml)
                                      throws IllegalTransformationException

Perform a loop hoisting on the given nested do statements.

Parameters:

hoistedGroups - List of groups that will be hoisted.

start - Starting point of the hoisted loop.

end - Ending point of the hoisted loop.

xcodeml - Current XcodeML translation unit for node creation.

Returns:

Hoisted nested do statement group.

Throws:

IllegalTransformationException - If underlying methods throw exception.

extractBody

public static void extractBody(Xnode loop,
                               Xnode ref)
                        throws IllegalTransformationException

Extract the body of a do statement and place it after the reference node.

Parameters:

loop - The do statement containing the body to be extracted.

ref - Element after which statement are shifted.

Throws:

IllegalTransformationException - If node passed as arguments are incompatible with the transformation.

extractBody

public static void extractBody(Xnode loop)
                        throws IllegalTransformationException

Extract the body of a do statement and place it directly after it.

Parameters:

loop - The do statement containing the body to be extracted.

Throws:

IllegalTransformationException - If node passed as arguments are incompatible with the transformation.

extractBody

public static void extractBody(NestedDoStatement nest)
                        throws IllegalTransformationException

Extract the body of the inner do statement and place it directly after the outer do statement.

Parameters:

nest - Nest do statement group.

Throws:

IllegalTransformationException - If node passed as arguments are incompatible with the transformation.

extractInductionVariable

public static java.lang.String extractInductionVariable(Xnode doStatement)

Get the string representation of the induction variable of a do statement.

Parameters:

doStatement - Do statement to extract the induction variable.

Returns:

The string value of the induction variable. Empty string if the passed Xnode is not a FdoStatement node or has no Var node.

hasSameIndexRange

public static boolean hasSameIndexRange(Xnode l1,
                                        Xnode l2)

Compare the iteration range of two do statements.

Parameters:

l1 - First do statement.

l2 - Second do statement.

Returns:

True if the iteration range are identical.

hasSameIndexRangeBesidesLower

public static boolean hasSameIndexRangeBesidesLower(Xnode l1,
                                                    Xnode l2)

Compare the iteration range of two do statements.

Parameters:

l1 - First do statement.

l2 - Second do statement.

Returns:

True if the iteration range are identical besides the lower bound.