claw.tatsu.directive.generator

Class DirectiveGenerator

java.lang.Object

claw.tatsu.directive.generator.DirectiveGenerator

Direct Known Subclasses:

DirectiveNone, OpenAcc, OpenMp

public abstract class DirectiveGenerator
extends java.lang.Object

Interface for directive directive generator. TODO interface might need some refinements when we have a better idea of TODO OpenACC vs OpenMP

Author:

clementval

Constructor Summary

Constructors

Constructor and Description
DirectiveGenerator()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCreateClause(java.util.List<java.lang.String> vars) Return construction of the clause for a list of created variables.
abstract CompilerDirective	getDirectiveLanguage() Get the target of the current generator.
abstract java.lang.String[]	getEndDataRegion() Get the end pragma to define the end of an directive data region.
abstract java.lang.String[]	getEndLoopDirective() Get the formatted directive to end the parallelization of a loop.
abstract java.lang.String[]	getEndParallelDirective() Get the end pragma to define a parallel accelerated region.
abstract java.lang.String	getParallelKeyword() Get the parallel keyword for a given directive language.
abstract java.lang.String	getPrefix() Get the prefix for the current directive language.
java.lang.String	getPresentClause(java.util.List<java.lang.String> vars) Return construction of the clause for a list of present variables.
abstract java.lang.String	getPrivateClause(java.util.List<java.lang.String> vars) Return construction of the clause for a list of private variables.
abstract java.lang.String	getPrivateClause(java.lang.String var) Return construction of the clause for a private variable.
abstract java.lang.String[]	getRoutineDirective(boolean seq) Return the formatted directive to be inserted in a subroutine/function definition.
abstract java.lang.String	getSequentialClause() Get the corresponding clause to have a sequential execution of an accelerated region.
abstract java.lang.String[]	getSingleDirective(java.lang.String clause) Get formatted pragma defined by the directive directive prefix and the given clauses.
java.util.List<Xcode>	getSkippedStatementsInEpilogue() Get the list of skipped statements after directive region.
java.util.List<Xcode>	getSkippedStatementsInPreamble() Get the list of skipped statements before directive region.
abstract java.lang.String[]	getStartDataRegion(java.util.List<java.lang.String> clauses) Get the start pragma to define the start of an directive data region.
abstract java.lang.String[]	getStartLoopDirective(int value, boolean seq, boolean naked, java.lang.String clauses) Get the formatted directive to start the parallelization of a loop.
abstract java.lang.String[]	getStartParallelDirective(java.lang.String clauses) Get the start pragma to define a parallel accelerated region.
java.util.List<Xcode>	getUnsupportedStatements() Get the list of unsupported statements in an directive region.
java.lang.String[]	getUpdateClause(DataMovement direction, java.util.List<java.lang.String> vars) Get directive for updating directive or host memory with the given variables.
abstract boolean	isCompileGuard(java.lang.String rawDirective) Check whether the raw directive is a CLAW compile guard that must be removed.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectiveGenerator

public DirectiveGenerator()

Method Detail

getPrefix

public abstract java.lang.String getPrefix()

Get the prefix for the current directive language.

Returns:

Language prefix.

getStartParallelDirective

public abstract java.lang.String[] getStartParallelDirective(java.lang.String clauses)

Get the start pragma to define a parallel accelerated region.

Parameters:

clauses - Additional clauses append at the start directive.

Returns:

String value that represents the pragma.

getEndParallelDirective

public abstract java.lang.String[] getEndParallelDirective()

Get the end pragma to define a parallel accelerated region.

Returns:

String value that represents the pragma.

getStartLoopDirective

public abstract java.lang.String[] getStartLoopDirective(int value,
                                                         boolean seq,
                                                         boolean naked,
                                                         java.lang.String clauses)

Get the formatted directive to start the parallelization of a loop.

Parameters:

value - Collapse value. if greater than 0, a collapse clause will be added to the construct.

seq - If true, loop should be executed in a sequential mode.

naked - If true, simple directive is generated without special clauses.

clauses - Additional clauses append at the start directive.

Returns:

String value that represents the start of a parallelized loop.

getEndLoopDirective

public abstract java.lang.String[] getEndLoopDirective()

Get the formatted directive to end the parallelization of a loop.

Returns:

String value that represents the start of a parallelized loop.

getSingleDirective

public abstract java.lang.String[] getSingleDirective(java.lang.String clause)

Get formatted pragma defined by the directive directive prefix and the given clauses.

Parameters:

clause - Clauses to append to the directive directive prefix

Returns:

String value that represents the pragma.

getParallelKeyword

public abstract java.lang.String getParallelKeyword()

Get the parallel keyword for a given directive language.

Returns:

The corresponding parallel keyword.

getPrivateClause

public abstract java.lang.String getPrivateClause(java.lang.String var)

Return construction of the clause for a private variable.

Parameters:

var - Variable name that will be inserted in the generated clause.

Returns:

An directive language specific private clause with the var.

getPrivateClause

public abstract java.lang.String getPrivateClause(java.util.List<java.lang.String> vars)

Return construction of the clause for a list of private variables.

Parameters:

vars - List of variables name that will be inserted in the generated clause.

Returns:

An directive language specific private clause with the list of variables.

getPresentClause

public java.lang.String getPresentClause(java.util.List<java.lang.String> vars)

Return construction of the clause for a list of present variables.

Parameters:

vars - List of variables name that will be inserted in the generated clause.

Returns:

An directive language specific present clause with the list of variables. If the list is null or empty, the implementation returns an empty string.

getCreateClause

public java.lang.String getCreateClause(java.util.List<java.lang.String> vars)

Return construction of the clause for a list of created variables.

Parameters:

vars - List of variables name that will be inserted in the generated clause.

Returns:

An directive language specific create clause with the list of variables. If the list is null or empty, the implementation returns an empty string.

getRoutineDirective

public abstract java.lang.String[] getRoutineDirective(boolean seq)

Return the formatted directive to be inserted in a subroutine/function definition.

Parameters:

seq - Apply sequential mode to the routine directive

Returns:

Routine directive.

isCompileGuard

public abstract boolean isCompileGuard(java.lang.String rawDirective)

Check whether the raw directive is a CLAW compile guard that must be removed.

Parameters:

rawDirective - The raw directive without any preprocessing.

Returns:

True if it is a CLAW compile guard. False otherwise.

getDirectiveLanguage

public abstract CompilerDirective getDirectiveLanguage()

Get the target of the current generator.

Returns:

Current target as an directive directive enumeration value.

getStartDataRegion

public abstract java.lang.String[] getStartDataRegion(java.util.List<java.lang.String> clauses)

Get the start pragma to define the start of an directive data region.

Parameters:

clauses - Additional clauses append at the start directive.

Returns:

String value that represents the pragma.

getEndDataRegion

public abstract java.lang.String[] getEndDataRegion()

Get the end pragma to define the end of an directive data region.

Returns:

String value that represents the pragma.

getSequentialClause

public abstract java.lang.String getSequentialClause()

Get the corresponding clause to have a sequential execution of an accelerated region.

Returns:

String value that represents the clause.

getUnsupportedStatements

public java.util.List<Xcode> getUnsupportedStatements()

Get the list of unsupported statements in an directive region.

Returns:

List of Xcode opcode of unsupported statements.

getSkippedStatementsInPreamble

public java.util.List<Xcode> getSkippedStatementsInPreamble()

Get the list of skipped statements before directive region.

Returns:

List of Xcode opcode of supported statements that are skipped.

getSkippedStatementsInEpilogue

public java.util.List<Xcode> getSkippedStatementsInEpilogue()

Get the list of skipped statements after directive region.

Returns:

List of Xcode opcode of supported statements that are skipped.

getUpdateClause

public java.lang.String[] getUpdateClause(DataMovement direction,
                                          java.util.List<java.lang.String> vars)

Get directive for updating directive or host memory with the given variables.

Parameters:

direction - Direction of the update.

vars - List of variables.

Returns:

String value that represents the directive. Null if no directive generated.