org.apache.flink.api.java.sca

Class UdfAnalyzer

java.lang.Object

org.apache.flink.api.java.sca.UdfAnalyzer

@Internal
public class UdfAnalyzer
extends Object

Implements a Static Code Analyzer (SCA) that uses the ASM framework for interpreting Java bytecode of Flink UDFs. The analyzer is build on top of ASM's BasicInterpreter. Instead of ASM's BasicValues, it introduces TaggedValues which extend BasicValue and allows for appending interesting information to values. Interesting values such as inputs, collectors, or constants are tagged such that a tracking of atomic input fields through the entire UDF (until the function returns or calls collect()) is possible.

The implementation is as conservative as possible meaning that for cases or bytecode instructions that haven't been considered the analyzer will fallback to the ASM library (which removes TaggedValues).

Constructor Summary

Constructors

Constructor and Description
UdfAnalyzer(Class<?> baseClass, Class<?> udfClass, String externalUdfName, TypeInformation<?> in1Type, TypeInformation<?> in2Type, TypeInformation<?> outType, Keys<?> keys1, Keys<?> keys2, boolean throwErrorExceptions)

Method Summary

Modifier and Type	Method and Description
void	addSemanticPropertiesHints()
boolean	analyze()
void	applyIteratorTrueAssumption()
List<TaggedValue>	getCollectorValues()
TaggedValue	getInput1AsTaggedValue()
TaggedValue	getInput2AsTaggedValue()
String	getInternalUdfClassName()
SemanticProperties	getSemanticProperties()
int	getState()
void	handleInvalidTupleAccess()
void	handleNullReturn()
void	handlePutStatic()
boolean	hasUdfCollector()
boolean	hasUdfIterableInput()
void	incrNewOperationCounters(boolean topLevel)
boolean	isIteratorTrueAssumptionApplied()
boolean	isUdfBinary()
boolean	isUdfReduceFunction()
void	printToLogger(org.slf4j.Logger log)
void	setState(int state)

Methods inherited from class java.lang.Object

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

Constructor Detail

UdfAnalyzer

public UdfAnalyzer(Class<?> baseClass,
                   Class<?> udfClass,
                   String externalUdfName,
                   TypeInformation<?> in1Type,
                   TypeInformation<?> in2Type,
                   TypeInformation<?> outType,
                   Keys<?> keys1,
                   Keys<?> keys2,
                   boolean throwErrorExceptions)

Method Detail

getState

public int getState()

setState

public void setState(int state)

isUdfBinary

public boolean isUdfBinary()

isIteratorTrueAssumptionApplied

public boolean isIteratorTrueAssumptionApplied()

applyIteratorTrueAssumption

public void applyIteratorTrueAssumption()

incrNewOperationCounters

public void incrNewOperationCounters(boolean topLevel)

hasUdfCollector

public boolean hasUdfCollector()

hasUdfIterableInput

public boolean hasUdfIterableInput()

isUdfReduceFunction

public boolean isUdfReduceFunction()

getInternalUdfClassName

public String getInternalUdfClassName()

getCollectorValues

public List<TaggedValue> getCollectorValues()

analyze

public boolean analyze()
                throws CodeAnalyzerException

Throws:

CodeAnalyzerException

getSemanticProperties

public SemanticProperties getSemanticProperties()

addSemanticPropertiesHints

public void addSemanticPropertiesHints()

printToLogger

public void printToLogger(org.slf4j.Logger log)

getInput1AsTaggedValue

public TaggedValue getInput1AsTaggedValue()

getInput2AsTaggedValue

public TaggedValue getInput2AsTaggedValue()

handleNullReturn

public void handleNullReturn()

handlePutStatic

public void handlePutStatic()

handleInvalidTupleAccess

public void handleInvalidTupleAccess()