org.elasticsearch.painless

Class CompilerSettings

java.lang.Object

org.elasticsearch.painless.CompilerSettings

public final class CompilerSettings
extends java.lang.Object

Settings to use when compiling a script.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INITIAL_CALL_SITE_DEPTH Hack to set the initial "depth" for the DefBootstrap.PIC and DefBootstrap.MIC.
static java.lang.String	MAX_LOOP_COUNTER Constant to be used when specifying the maximum loop counter when compiling a script.
static java.lang.String	PICKY Constant to be used for enabling additional internal compilation checks (slower).
static <any>	REGEX_ENABLED Are regexes enabled? This is a node level setting because regexes break out of painless's lovely sandbox and can cause stack overflows and we can't analyze the regex to be sure it won't.

Constructor Summary

Constructors

Constructor and Description
CompilerSettings()

Method Summary

Modifier and Type	Method and Description
boolean	areRegexesEnabled() Are regexes enabled? They are currently disabled by default because they break out of the loop counter and even fairly simple looking regexes can cause stack overflows.
int	getInitialCallSiteDepth() Returns initial call site depth.
int	getMaxLoopCounter() Returns the value for the cumulative total number of statements that can be made in all loops in a script before an exception is thrown.
boolean	isPicky() Returns true if the compiler should be picky.
void	setInitialCallSiteDepth(int depth) For testing megamorphic fallbacks.
void	setMaxLoopCounter(int max) Set the cumulative total number of statements that can be made in all loops.
void	setPicky(boolean picky) Set to true if compilation should be picky.
void	setRegexesEnabled(boolean regexesEnabled) Are regexes enabled? They are currently disabled by default because they break out of the loop counter and even fairly simple looking regexes can cause stack overflows.

Methods inherited from class java.lang.Object

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

Field Detail

REGEX_ENABLED

public static final <any> REGEX_ENABLED

Are regexes enabled? This is a node level setting because regexes break out of painless's lovely sandbox and can cause stack overflows and we can't analyze the regex to be sure it won't.

MAX_LOOP_COUNTER

public static final java.lang.String MAX_LOOP_COUNTER

Constant to be used when specifying the maximum loop counter when compiling a script.

See Also:

Constant Field Values

PICKY

public static final java.lang.String PICKY

Constant to be used for enabling additional internal compilation checks (slower).

See Also:

Constant Field Values

INITIAL_CALL_SITE_DEPTH

public static final java.lang.String INITIAL_CALL_SITE_DEPTH

Hack to set the initial "depth" for the DefBootstrap.PIC and DefBootstrap.MIC. Only used for testing: do not overwrite.

See Also:

Constant Field Values

Constructor Detail

CompilerSettings

public CompilerSettings()

Method Detail

getMaxLoopCounter

public int getMaxLoopCounter()

Returns the value for the cumulative total number of statements that can be made in all loops in a script before an exception is thrown. This attempts to prevent infinite loops. Note if the counter is set to 0, no loop counter will be written.

setMaxLoopCounter

public void setMaxLoopCounter(int max)

Set the cumulative total number of statements that can be made in all loops.

See Also:

getMaxLoopCounter()

isPicky

public boolean isPicky()

Returns true if the compiler should be picky. This means it runs slower and enables additional runtime checks, throwing an exception if there are ambiguities in the grammar or other low level parsing problems.

setPicky

public void setPicky(boolean picky)

Set to true if compilation should be picky.

See Also:

isPicky()

getInitialCallSiteDepth

public int getInitialCallSiteDepth()

Returns initial call site depth. This means we pretend we've already seen N different types, to better exercise fallback code in tests.

setInitialCallSiteDepth

public void setInitialCallSiteDepth(int depth)

For testing megamorphic fallbacks. Do not use.

See Also:

getInitialCallSiteDepth()

areRegexesEnabled

public boolean areRegexesEnabled()

Are regexes enabled? They are currently disabled by default because they break out of the loop counter and even fairly simple looking regexes can cause stack overflows.

setRegexesEnabled

public void setRegexesEnabled(boolean regexesEnabled)

Are regexes enabled? They are currently disabled by default because they break out of the loop counter and even fairly simple looking regexes can cause stack overflows.