@Generated(value="config_generator.py") public class PgxConfig extends AbstractPgxConfig
| Modifier and Type | Class and Description |
|---|---|
static class |
PgxConfig.Field
Fields of PGX Engine Config
|
| Modifier and Type | Method and Description |
|---|---|
java.lang.Integer |
getAdminRequestCacheTimeout()
after how many seconds admin request results get removed from the cache.
|
ArrayFactoryStrategy |
getArrayFactoryStrategy()
java_arrays = use normal java arrays only (limited to 32bit in length)
java_2d_arrays = use Java 2D arrays only (achieve arrays of 64bit in length with the cost of indirection) off_heap_arrays = use arrays allocated off-heap (achieve 64bit in length without performance penalty, but with the price of breaking out of the JVM) dynamic = decide at run-time which allocation strategy to use based on the requested array length |
java.lang.Integer |
getBfsIterateQueTaskSize()
task size for BFS iterate QUE phase
|
java.lang.Integer |
getBfsThresholdReadBased()
threshold of BFS traversal level items to switch to read-based visiting strategy
|
java.lang.Integer |
getBfsThresholdSingleThreaded()
until what number of BFS traversal level items vertices are visited single-threaded
|
java.lang.Integer |
getBigPartitionThreshold()
the threshold for partitions to be considered 'big'.
|
java.lang.String |
getCc()
(only relevant if native analysis is enabled) C++ compiler executable (either absolute path or resolvable via
$PATH) |
java.lang.String |
getCflags()
(only relevant if native analysis is enabled) flags for C++ compiler
|
java.lang.String |
getCharacterSet()
standard charset to use throughout PGX, UTF-8 will be used as default.
|
java.lang.Integer |
getCniDiffFactorDefault()
default diff factor value used in the common neighbor iterator implementations.
|
java.lang.Integer |
getCniSmallDefault()
default value used in the common neighbor iterator implementations, to indicate below which threshold a subarray is considered small.
|
java.lang.Integer |
getCniStopRecursionDefault()
default value used in the common neighbor iterator implementations, to indicate the minimum size where the binary search approach is applied.
|
java.lang.Integer |
getDfsThresholdLarge()
value that determines at which number of visited vertices the DFS implementation will switch to data-structures that are more optimized for larger numbers of vertices.
|
java.util.List<java.lang.String> |
getGraphs()
list of paths to graph configs to be registered at start-up
|
java.util.List<java.lang.String> |
getInvokeableProviders()
list of invokeable providers to be loaded during startup
|
ArrayFactoryStrategy |
getLargeArrayStrategy()
[relevant for dynamic array factory only] array factory strategy to use when requested array size is exceeding large_array_threshold
|
java.lang.Integer |
getLargeArrayThreshold()
[relevant for dynamic array factory only] use large_array_strategy when requested array size is exceeding this number.
|
java.lang.String |
getLflags()
(only relevant if native analysis is enabled) linker flags for C++ compiler
|
java.lang.Integer |
getMaxActiveSessions()
the maximum number of sessions allowed to be active at a time
|
java.lang.Integer |
getMaxOffHeapSize()
maximum amount of off-heap memory PGX is allowed to allocate in megabytes, before an OutOfMemoryError will be thrown.
|
java.lang.Integer |
getMaxQueueSizePerSession()
the maximum number of pending tasks allowed to be in the queue, per session.
|
java.lang.Integer |
getMaxSnapshotCount()
Number of snapshots that may be loaded in the engine at the same time.
|
java.lang.Integer |
getMemoryCleanupInterval()
memory cleanup tick in seconds
|
FrontierTypeStrategy |
getMsBfsFrontierTypeStrategy()
the type strategy to use for MS-BFS frontiers
|
java.lang.Integer |
getNumSpinLocks()
how many spin locks each generated app will create at instantiation.
|
java.lang.Integer |
getNumWorkersAnalysis()
how many worker threads to use for analysis tasks
|
java.lang.Integer |
getNumWorkersFastTrackAnalysis()
how many worker threads to use for fast-track analysis tasks
|
java.lang.Integer |
getNumWorkersIo()
how many worker threads to use for I/O tasks (load/refresh/write from/to disk).
|
java.lang.Integer |
getParallelism()
number of worker threads to be used in thread pool.
|
ParallelizationStrategy |
getParallelizationStrategy()
which parallelization strategy to use.
|
java.lang.String |
getPathToGmCompiler()
if set, use this path to
gm_comp binary for dynamic compilations. |
PatternMatchingSemantic |
getPatternMatchingSemantic()
the graph pattern matching semantic which is either isomorphism or homomorphism
|
RandomGeneratorStrategy |
getRandomGeneratorStrategy()
method of generating random numbers in pgx
|
java.lang.Long |
getRandomSeed()
[relevant for deterministic random number generator only] seed for the deterministic random number generator used in pgx.
|
java.lang.Double |
getReleaseMemoryThreshold()
threshold percentage of used memory after which the engine starts freeing un-used graphs.
|
java.lang.Integer |
getSessionIdleTimeoutSecs()
timeout of idling sessions in seconds.
|
java.lang.Integer |
getSessionTaskTimeoutSecs()
timeout to interrupt long-running tasks submitted by sessions (algorithms, I/O tasks) in seconds.
|
java.lang.Integer |
getSmallTaskLength()
task length if total amount of work is small than default task length (only relevant for task-stealing strategies)
|
java.lang.Integer |
getTaskLength()
default task length (only relevant for task-stealing strategies).
|
java.lang.String |
getTmpDir()
Use this path as temporary directory to store compilation artifacts and other temporary data.
|
java.util.Map<PgxConfig.Field,java.lang.Object> |
getValues()
Gets the parsed values.
|
java.util.Map<PgxConfig.Field,java.lang.Object> |
getValuesWithoutDefaults()
Gets the values without defaults.
|
boolean |
hasDefaultValue(PgxConfig.Field field)
Checks for default value.
|
java.lang.Boolean |
isAllowIdleTimeoutOverwrite()
if
true, sessions can overwrite default idle timeout |
java.lang.Boolean |
isAllowTaskTimeoutOverwrite()
if
true, sessions can overwrite default task timeout |
java.lang.Boolean |
isAllowUserAutoRefresh()
if
true users may enable auto refresh for graphs they load. |
boolean |
isEmpty()
Checks if it's empty.
|
java.lang.Boolean |
isEnableCsrfTokenChecks()
if true, the PGX webapp will verify CSRF token cookie and request parameters sent by the client exist and match.
|
java.lang.Boolean |
isEnableGmCompiler()
if
true, enable dynamic compilation of Green-Marl code during runtime. |
java.lang.Boolean |
isExplicitSpinLocks()
true means spin explicitly in a loop until lock becomes available. |
java.lang.Boolean |
isLaunchWatchdogs()
(for debugging) if
true, additional watch-dog threads will be launched which monitor and log engine health stats |
java.lang.Boolean |
isStrictMode()
if
true, exceptions are thrown and logged with ERROR level whenever engine encounters configuration problems, such as invalid keys, mismatches and other potential errors. |
java.lang.Boolean |
isThrowOutOfMemoryErrorDuringAllocation()
(for debugging) if
true, engine will throw OutOfMemoryErrors on purpose when trying to allocate large memory chunks. |
java.lang.Boolean |
isThrowOutOfMemoryErrorDuringLoading()
(for debugging) if
true, engine will throw OutOfMemoryErrors on purpose when trying to load graphs from disk. |
java.lang.Boolean |
isThrowOutOfMemoryErrorDuringMutation()
(for debugging) if
true, engine will throw OutOfMemoryErrors on purpose when trying to mutate graphs. |
java.lang.Boolean |
isUnsafeAllowForeignSyntax()
(This flag reduces security, enable only if you know what you're doing!) Allow foreign syntax in user-provided Green-Marl programs
|
java.lang.Boolean |
isUnsafeAllowLocalFilesystem()
(This flag reduces security, enable only if you know what you're doing!) Allow loading from local filesystem, if in client/server mode.
|
java.lang.Boolean |
isUseNativeAnalysis()
execute analyses using Java (
false) or C++ (true) runtime |
java.lang.Boolean |
isUseNativeLoaders()
use Java (
false) or C++ (true) graph loader framework |
java.lang.Boolean |
isUseStringPool()
If
true, PGX will store string properties in a pool in order to consume less memory on string properties |
static PgxConfig |
parse(java.io.InputStream is, boolean strict, java.lang.String parentPath)
Parses an input stream.
|
static PgxConfig |
parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)
Parses a raw key/value mapping.
|
static PgxConfig |
parse(java.util.Properties props, boolean strict)
Parses a properties file.
|
java.lang.String |
toString() |
get, getConfigValues, init, isInitialized, reset, strictsetSerializablepublic java.lang.Integer getAdminRequestCacheTimeout()
public ArrayFactoryStrategy getArrayFactoryStrategy()
public java.lang.Integer getBfsIterateQueTaskSize()
public java.lang.Integer getBfsThresholdReadBased()
public java.lang.Integer getBfsThresholdSingleThreaded()
public java.lang.Integer getBigPartitionThreshold()
public java.lang.String getCc()
$PATH)public java.lang.String getCflags()
public java.lang.String getCharacterSet()
public java.lang.Integer getCniDiffFactorDefault()
public java.lang.Integer getCniSmallDefault()
public java.lang.Integer getCniStopRecursionDefault()
public java.lang.Integer getDfsThresholdLarge()
public java.util.List<java.lang.String> getGraphs()
public java.util.List<java.lang.String> getInvokeableProviders()
public ArrayFactoryStrategy getLargeArrayStrategy()
public java.lang.Integer getLargeArrayThreshold()
Integer.MAX_VALUE - 3)public java.lang.String getLflags()
public java.lang.Integer getMaxActiveSessions()
public java.lang.Integer getMaxOffHeapSize()
public java.lang.Integer getMaxQueueSizePerSession()
public java.lang.Integer getMaxSnapshotCount()
public java.lang.Integer getMemoryCleanupInterval()
public FrontierTypeStrategy getMsBfsFrontierTypeStrategy()
public java.lang.Integer getNumSpinLocks()
public java.lang.Integer getNumWorkersAnalysis()
public java.lang.Integer getNumWorkersFastTrackAnalysis()
public java.lang.Integer getNumWorkersIo()
public java.lang.Integer getParallelism()
public ParallelizationStrategy getParallelizationStrategy()
public java.lang.String getPathToGmCompiler()
gm_comp binary for dynamic compilations. If not set and enable_gm_compiler is true, PGX will try to utilize one of the built-in compiler binaries.public PatternMatchingSemantic getPatternMatchingSemantic()
public RandomGeneratorStrategy getRandomGeneratorStrategy()
public java.lang.Long getRandomSeed()
public java.lang.Double getReleaseMemoryThreshold()
0.0 means graphs get freed as soon as their reference count becomes zero. That is, all sessions which loaded that graph were destroyed/timed out. A value of 1.0 means graphs get never freed. Engine will throw OutOfMemoryErrors as soon as a graph is needed which doesn't fit in memory anymore. A value of 0.7 means the engine keeps all graphs in memory as long as total memory consumption is below 70% of total available memory, even if there is currently no session using them. Once the 70% are surpassed and another graph needs to get loaded, un-used graphs get freed until memory consumption is below 70% again.public java.lang.Integer getSessionIdleTimeoutSecs()
public java.lang.Integer getSessionTaskTimeoutSecs()
public java.lang.Integer getSmallTaskLength()
public java.lang.Integer getTaskLength()
public java.lang.String getTmpDir()
/tmp on Linux)public java.util.Map<PgxConfig.Field,java.lang.Object> getValues()
public java.util.Map<PgxConfig.Field,java.lang.Object> getValuesWithoutDefaults()
public boolean hasDefaultValue(PgxConfig.Field field)
field - the fieldpublic java.lang.Boolean isAllowIdleTimeoutOverwrite()
true, sessions can overwrite default idle timeoutpublic java.lang.Boolean isAllowTaskTimeoutOverwrite()
true, sessions can overwrite default task timeoutpublic java.lang.Boolean isAllowUserAutoRefresh()
true users may enable auto refresh for graphs they load. If false only graphs mentioned in graphs can have auto refresh enabledpublic boolean isEmpty()
public java.lang.Boolean isEnableCsrfTokenChecks()
public java.lang.Boolean isEnableGmCompiler()
true, enable dynamic compilation of Green-Marl code during runtime. Note: the built-in Green-Marl compilers don't support all platforms. You can also use your own version of the compiler by setting the path_to_gm_compiler field.public java.lang.Boolean isExplicitSpinLocks()
true means spin explicitly in a loop until lock becomes available. false means using JDK locks which rely on the JVM to decide whether to context switch or spin. Our experiments showed that setting this value to true results in better performance.public java.lang.Boolean isLaunchWatchdogs()
true, additional watch-dog threads will be launched which monitor and log engine health statspublic java.lang.Boolean isStrictMode()
true, exceptions are thrown and logged with ERROR level whenever engine encounters configuration problems, such as invalid keys, mismatches and other potential errors. If false, engine logs problems with ERROR/WARN level (depending on severity) and makes best guesses / uses sensible defaults instead of throwing exceptions.public java.lang.Boolean isThrowOutOfMemoryErrorDuringAllocation()
true, engine will throw OutOfMemoryErrors on purpose when trying to allocate large memory chunks.public java.lang.Boolean isThrowOutOfMemoryErrorDuringLoading()
true, engine will throw OutOfMemoryErrors on purpose when trying to load graphs from disk.public java.lang.Boolean isThrowOutOfMemoryErrorDuringMutation()
true, engine will throw OutOfMemoryErrors on purpose when trying to mutate graphs.public java.lang.Boolean isUnsafeAllowForeignSyntax()
public java.lang.Boolean isUnsafeAllowLocalFilesystem()
public java.lang.Boolean isUseNativeAnalysis()
false) or C++ (true) runtimepublic java.lang.Boolean isUseNativeLoaders()
false) or C++ (true) graph loader frameworkpublic java.lang.Boolean isUseStringPool()
true, PGX will store string properties in a pool in order to consume less memory on string propertiespublic static PgxConfig parse(java.io.InputStream is, boolean strict, java.lang.String parentPath) throws java.io.IOException
is - the input streamstrict - if true, parses in strict modeparentPath - if not null, resolves relative paths against this parentPathjava.io.IOException - Signals that an I/O exception has occurred.public static PgxConfig parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)
raw - the raw key/value mapping to parsestrict - if true, parses in strict modeparentPath - if not null, resolves relative paths against this parentPathpublic static PgxConfig parse(java.util.Properties props, boolean strict)
props - the properties to parsestrict - if true, parses in strict modepublic java.lang.String toString()
toString in class java.lang.ObjectCopyright © 2016, 2017 Oracle Corp. All Rights Reserved.