claw.tatsu.directive.generator

Class OpenAcc

java.lang.Object

claw.tatsu.directive.generator.DirectiveGenerator

claw.tatsu.directive.generator.OpenAcc

public class OpenAcc
extends DirectiveGenerator

OpenACC specific directive directive generator.

Author:

clementval

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPENACC_DEBUG_PREFIX

Constructor Summary

Constructors

Constructor and Description
OpenAcc() Constructs a new object with the given target.

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.
CompilerDirective	getDirectiveLanguage() Get the target of the current generator.
java.lang.String[]	getEndDataRegion() Get the end pragma to define the end of an directive data region.
java.lang.String[]	getEndLoopDirective() Get the formatted directive to end the parallelization of a loop.
java.lang.String[]	getEndParallelDirective() Get the end pragma to define a parallel accelerated region.
java.lang.String	getParallelKeyword() Get the parallel keyword for a given directive language.
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.
java.lang.String	getPrivateClause(java.util.List<java.lang.String> vars) Return construction of the clause for a list of private variables.
java.lang.String	getPrivateClause(java.lang.String var) Return construction of the clause for a private variable.
java.lang.String[]	getRoutineDirective(boolean seq) Return the formatted directive to be inserted in a subroutine/function definition.
java.lang.String	getSequentialClause() Get the corresponding clause to have a sequential execution of an accelerated region.
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.
java.lang.String[]	getStartDataRegion(java.util.List<java.lang.String> clauses) Get the start pragma to define the start of an directive data region.
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.
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.
boolean	isCompileGuard(java.lang.String rawDirective) Check whether the raw directive is a CLAW compile guard that must be removed.
void	setExecutionMode(OpenAccExecutionMode mode)

Methods inherited from class java.lang.Object

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

Field Detail

OPENACC_DEBUG_PREFIX

public static final java.lang.String OPENACC_DEBUG_PREFIX

See Also:

Constant Field Values

Constructor Detail

OpenAcc

public OpenAcc()

Constructs a new object with the given target.

Method Detail

setExecutionMode

public void setExecutionMode(OpenAccExecutionMode mode)

getPrefix

public java.lang.String getPrefix()

Description copied from class: DirectiveGenerator

Get the prefix for the current directive language.

Specified by:

getPrefix in class DirectiveGenerator

Returns:

Language prefix.

getStartParallelDirective

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

Description copied from class: DirectiveGenerator

Get the start pragma to define a parallel accelerated region.

Specified by:

getStartParallelDirective in class DirectiveGenerator

Parameters:

clauses - Additional clauses append at the start directive.

Returns:

String value that represents the pragma.

getEndParallelDirective

public java.lang.String[] getEndParallelDirective()

Description copied from class: DirectiveGenerator

Get the end pragma to define a parallel accelerated region.

Specified by:

getEndParallelDirective in class DirectiveGenerator

Returns:

String value that represents the pragma.

getSingleDirective

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

Description copied from class: DirectiveGenerator

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

Specified by:

getSingleDirective in class DirectiveGenerator

Parameters:

clause - Clauses to append to the directive directive prefix

Returns:

String value that represents the pragma.

getParallelKeyword

public java.lang.String getParallelKeyword()

Description copied from class: DirectiveGenerator

Get the parallel keyword for a given directive language.

Specified by:

getParallelKeyword in class DirectiveGenerator

Returns:

The corresponding parallel keyword.

getPrivateClause

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

Description copied from class: DirectiveGenerator

Return construction of the clause for a private variable.

Specified by:

getPrivateClause in class DirectiveGenerator

Parameters:

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

Returns:

An directive language specific private clause with the var.

getPrivateClause

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

Description copied from class: DirectiveGenerator

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

Specified by:

getPrivateClause in class DirectiveGenerator

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)

Description copied from class: DirectiveGenerator

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

Overrides:

getPresentClause in class DirectiveGenerator

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)

Description copied from class: DirectiveGenerator

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

Overrides:

getCreateClause in class DirectiveGenerator

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 java.lang.String[] getRoutineDirective(boolean seq)

Description copied from class: DirectiveGenerator

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

Specified by:

getRoutineDirective in class DirectiveGenerator

Parameters:

seq - Apply sequential mode to the routine directive

Returns:

Routine directive.

isCompileGuard

public boolean isCompileGuard(java.lang.String rawDirective)

Description copied from class: DirectiveGenerator

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

Specified by:

isCompileGuard in class DirectiveGenerator

Parameters:

rawDirective - The raw directive without any preprocessing.

Returns:

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

getDirectiveLanguage

public CompilerDirective getDirectiveLanguage()

Description copied from class: DirectiveGenerator

Get the target of the current generator.

Specified by:

getDirectiveLanguage in class DirectiveGenerator

Returns:

Current target as an directive directive enumeration value.

getStartDataRegion

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

Description copied from class: DirectiveGenerator

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

Specified by:

getStartDataRegion in class DirectiveGenerator

Parameters:

clauses - Additional clauses append at the start directive.

Returns:

String value that represents the pragma.

getEndDataRegion

public java.lang.String[] getEndDataRegion()

Description copied from class: DirectiveGenerator

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

Specified by:

getEndDataRegion in class DirectiveGenerator

Returns:

String value that represents the pragma.

getSequentialClause

public java.lang.String getSequentialClause()

Description copied from class: DirectiveGenerator

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

Specified by:

getSequentialClause in class DirectiveGenerator

Returns:

String value that represents the clause.

getStartLoopDirective

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

Description copied from class: DirectiveGenerator

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

Specified by:

getStartLoopDirective in class DirectiveGenerator

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 java.lang.String[] getEndLoopDirective()

Description copied from class: DirectiveGenerator

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

Specified by:

getEndLoopDirective in class DirectiveGenerator

Returns:

String value that represents the start of a parallelized loop.

getUnsupportedStatements

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

Description copied from class: DirectiveGenerator

Get the list of unsupported statements in an directive region.

Overrides:

getUnsupportedStatements in class DirectiveGenerator

Returns:

List of Xcode opcode of unsupported statements.

getSkippedStatementsInPreamble

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

Description copied from class: DirectiveGenerator

Get the list of skipped statements before directive region.

Overrides:

getSkippedStatementsInPreamble in class DirectiveGenerator

Returns:

List of Xcode opcode of supported statements that are skipped.

getSkippedStatementsInEpilogue

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

Description copied from class: DirectiveGenerator

Get the list of skipped statements after directive region.

Overrides:

getSkippedStatementsInEpilogue in class DirectiveGenerator

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)

Description copied from class: DirectiveGenerator

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

Overrides:

getUpdateClause in class DirectiveGenerator

Parameters:

direction - Direction of the update.

vars - List of variables.

Returns:

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