Class JavaParsingAtomicLinkedQueueGenerator

java.lang.Object

com.github.javaparser.ast.visitor.VoidVisitorAdapter<Void>

org.jctools.queues.atomic.JavaParsingAtomicQueueGenerator

org.jctools.queues.atomic.JavaParsingAtomicLinkedQueueGenerator

All Implemented Interfaces:

com.github.javaparser.ast.visitor.VoidVisitor<Void>, JCToolsGenerator

Direct Known Subclasses:

JavaParsingAtomicUnpaddedLinkedQueueGenerator

public class JavaParsingAtomicLinkedQueueGenerator
extends JavaParsingAtomicQueueGenerator

This generator takes in an JCTools 'LinkedQueue' Java source file and patches Unsafe accesses into atomic AtomicLongFieldUpdater. It outputs a Java source file with these patches.

An 'LinkedQueue' is one that is backed by a linked list and use a producerNode and a consumerNode field to track the positions of each.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	mpscLinkedQueueName

Fields inherited from class JavaParsingAtomicQueueGenerator

GEN_DIRECTIVE_CLASS_CONTAINS_ORDERED_FIELD_ACCESSORS, GEN_DIRECTIVE_METHOD_IGNORE, sourceFileName

Constructor Summary

Constructors

Constructor	Description
JavaParsingAtomicLinkedQueueGenerator(String sourceFileName)

Method Summary

Modifier and Type	Method	Description
private String	atomicQueueName()
private com.github.javaparser.ast.type.ClassOrInterfaceType	atomicRefArrayType(com.github.javaparser.ast.type.ArrayType in)
private com.github.javaparser.ast.body.FieldDeclaration	declareRefFieldUpdater(String className, String variableName)	Generates something like private static final AtomicReferenceFieldUpdater P_NODE_UPDATER = AtomicReferenceFieldUpdater.newUpdater(MpmcAtomicArrayQueueProducerNodeField.class, "producerNode");
(package private) String	fieldUpdaterFieldName(String fieldName)
private com.github.javaparser.ast.stmt.BlockStmt	fieldUpdaterGetAndSet(String fieldUpdaterFieldName, String newValueName)	Generates something like return P_INDEX_UPDATER.getAndSet(this, newValue)
static void	main(String[] args)
private com.github.javaparser.ast.expr.MethodCallExpr	newAtomicRefFieldUpdater(String className, String variableName)
private void	patchAtomicFieldUpdaterAccessorMethods(com.github.javaparser.ast.body.ClassOrInterfaceDeclaration n)	For each method accessor to a field, add in the calls necessary to AtomicFieldUpdaters.
(package private) void	processSpecialNodeTypes(com.github.javaparser.ast.nodeTypes.NodeWithType<?, com.github.javaparser.ast.type.Type> node, String name)	Given a variable declaration of some sort, check it's name and type and if it looks like any of the key type changes between unsafe and atomic queues, perform the conversion to change it's type.
void	visit(com.github.javaparser.ast.body.ClassOrInterfaceDeclaration node, Void arg)
void	visit(com.github.javaparser.ast.body.ConstructorDeclaration n, Void arg)
void	visit(com.github.javaparser.ast.body.MethodDeclaration n, Void arg)
void	visit(com.github.javaparser.ast.expr.CastExpr n, Void arg)
void	visit(com.github.javaparser.ast.expr.ObjectCreationExpr n, Void arg)

Methods inherited from class JavaParsingAtomicQueueGenerator

capitalise, classType, cleanupComments, declareLongFieldUpdater, fieldAssignment, fieldDeclarationWithInitialiser, fieldUpdaterCompareAndSet, fieldUpdaterLazySet, isCommentPresent, isRefArray, isRefType, methodCallExpr, newAtomicLongFieldUpdater, organiseImports, outputPackage, patchAtomicFieldUpdaterAccessorMethod, queueClassNamePrefix, removeStaticFieldsAndInitialisers, replaceParentClassesForAtomics, returnField, simpleParametricType, staticImportDeclaration, translateQueueName, visit, visit, visit

Methods inherited from class com.github.javaparser.ast.visitor.VoidVisitorAdapter

visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class Object

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

Methods inherited from interface JCToolsGenerator

visit

Field Details

mpscLinkedQueueName

private final String mpscLinkedQueueName

Constructor Details

JavaParsingAtomicLinkedQueueGenerator

public JavaParsingAtomicLinkedQueueGenerator(String sourceFileName)

Method Details

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

visit

public void visit(com.github.javaparser.ast.body.ConstructorDeclaration n,
 Void arg)

Specified by:

visit in interface com.github.javaparser.ast.visitor.VoidVisitor<Void>

Overrides:

visit in class com.github.javaparser.ast.visitor.VoidVisitorAdapter<Void>

atomicQueueName

private String atomicQueueName()

visit

public void visit(com.github.javaparser.ast.body.ClassOrInterfaceDeclaration node,
 Void arg)

Specified by:

visit in interface com.github.javaparser.ast.visitor.VoidVisitor<Void>

Overrides:

visit in class com.github.javaparser.ast.visitor.VoidVisitorAdapter<Void>

visit

public void visit(com.github.javaparser.ast.expr.CastExpr n,
 Void arg)

Specified by:

visit in interface com.github.javaparser.ast.visitor.VoidVisitor<Void>

Overrides:

visit in class com.github.javaparser.ast.visitor.VoidVisitorAdapter<Void>

visit

public void visit(com.github.javaparser.ast.body.MethodDeclaration n,
 Void arg)

Specified by:

visit in interface com.github.javaparser.ast.visitor.VoidVisitor<Void>

Overrides:

visit in class com.github.javaparser.ast.visitor.VoidVisitorAdapter<Void>

visit

public void visit(com.github.javaparser.ast.expr.ObjectCreationExpr n,
 Void arg)

Specified by:

visit in interface com.github.javaparser.ast.visitor.VoidVisitor<Void>

Overrides:

visit in class com.github.javaparser.ast.visitor.VoidVisitorAdapter<Void>

fieldUpdaterFieldName

String fieldUpdaterFieldName(String fieldName)

Specified by:

fieldUpdaterFieldName in class JavaParsingAtomicQueueGenerator

processSpecialNodeTypes

void processSpecialNodeTypes(com.github.javaparser.ast.nodeTypes.NodeWithType<?, com.github.javaparser.ast.type.Type> node,
 String name)

Given a variable declaration of some sort, check it's name and type and if it looks like any of the key type changes between unsafe and atomic queues, perform the conversion to change it's type.

Specified by:

processSpecialNodeTypes in class JavaParsingAtomicQueueGenerator

patchAtomicFieldUpdaterAccessorMethods

private void patchAtomicFieldUpdaterAccessorMethods(com.github.javaparser.ast.body.ClassOrInterfaceDeclaration n)

For each method accessor to a field, add in the calls necessary to AtomicFieldUpdaters. Only methods start with so/cas/sv/lv/lp/sp/xchg followed by the field name are processed. Clearly lv, lp and sv are simple field accesses with only so and cas using the AtomicFieldUpdaters.

Parameters:

n - the AST node for the containing class

fieldUpdaterGetAndSet

private com.github.javaparser.ast.stmt.BlockStmt fieldUpdaterGetAndSet(String fieldUpdaterFieldName,
 String newValueName)

Generates something like return P_INDEX_UPDATER.getAndSet(this, newValue)

declareRefFieldUpdater

private com.github.javaparser.ast.body.FieldDeclaration declareRefFieldUpdater(String className,
 String variableName)

Generates something like private static final AtomicReferenceFieldUpdater P_NODE_UPDATER = AtomicReferenceFieldUpdater.newUpdater(MpmcAtomicArrayQueueProducerNodeField.class, "producerNode");

newAtomicRefFieldUpdater

private com.github.javaparser.ast.expr.MethodCallExpr newAtomicRefFieldUpdater(String className,
 String variableName)

atomicRefArrayType

private com.github.javaparser.ast.type.ClassOrInterfaceType atomicRefArrayType(com.github.javaparser.ast.type.ArrayType in)