Package oracle.pgx.config

Class EnterpriseSchedulerFlagsConfigBuilder

java.lang.Object
oracle.pgx.config.EnterpriseSchedulerFlagsConfigBuilder
@Generated({"common/config/src/templates/ConfigBuilder.stg","common/config/config.gradle"}) public final class EnterpriseSchedulerFlagsConfigBuilder extends Object
Builder for EnterpriseSchedulerFlagsConfig.

  • Constructor Details

    • EnterpriseSchedulerFlagsConfigBuilder

      public EnterpriseSchedulerFlagsConfigBuilder()
      Constructs an empty EnterpriseSchedulerFlagsConfigBuilder

    • EnterpriseSchedulerFlagsConfigBuilder

      public EnterpriseSchedulerFlagsConfigBuilder(Map<EnterpriseSchedulerFlagsConfig.Field,Object> values)
      Constructs a EnterpriseSchedulerFlagsConfigBuilder initialized with the values from the given map
      Parameters:
      values - a map containing configuration values

    • EnterpriseSchedulerFlagsConfigBuilder

      public EnterpriseSchedulerFlagsConfigBuilder(EnterpriseSchedulerFlagsConfig config)
      Constructs a EnterpriseSchedulerFlagsConfigBuilder initialized with the values from the given config
      Parameters:
      config - the configuration to take the values from

    • EnterpriseSchedulerFlagsConfigBuilder

      public EnterpriseSchedulerFlagsConfigBuilder(EnterpriseSchedulerFlagsConfigBuilder builder)
      Constructs a EnterpriseSchedulerFlagsConfigBuilder initialized with the values from the given builder
      Parameters:
      builder - the builder to take the values from

  • Method Details

    • buildEnterpriseSchedulerFlagsConfig

      public static EnterpriseSchedulerFlagsConfig buildEnterpriseSchedulerFlagsConfig(Consumer<EnterpriseSchedulerFlagsConfigBuilder> builderSetup)
      Builds a EnterpriseSchedulerFlagsConfig in-place
      Parameters:
      builderSetup - a consumer to setup a newly created EnterpriseSchedulerFlagsConfig

    • putAll

      public EnterpriseSchedulerFlagsConfigBuilder putAll(Map<EnterpriseSchedulerFlagsConfig.Field,Object> values)
      Puts all values from the given map into this builder.
      Parameters:
      values - the values to put in the builder

    • putAll

      public EnterpriseSchedulerFlagsConfigBuilder putAll(EnterpriseSchedulerFlagsConfig config)
      Puts all values from the given config into this builder
      Parameters:
      config - the config to take the values from

    • clear

      public EnterpriseSchedulerFlagsConfigBuilder clear()
      Clears all values from the builder

    • build

      public EnterpriseSchedulerFlagsConfig build(String parentPath)
      Builds the EnterpriseSchedulerFlagsConfig.
      Parameters:
      parentPath - if not null, resolves relative paths against this parentPath
      Returns:
      an instance of EnterpriseSchedulerFlagsConfig

    • build

      public EnterpriseSchedulerFlagsConfig build()
      Builds the EnterpriseSchedulerFlagsConfig with a parentPath of null.
      Returns:
      An instance of EnterpriseSchedulerFlagsConfig
      See Also:

    • toInputStream

      public InputStream toInputStream()
      Returns:
      an InputStream representing the config

    • getValues

      public Map<EnterpriseSchedulerFlagsConfig.Field,Object> getValues()
      Returns:
      the raw config values

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setShowLogging

      public EnterpriseSchedulerFlagsConfigBuilder setShowLogging(boolean showLogging)
      If true enable summary logging -- this is available even in non-debug builds and includes information such as the machine h/w information obtained at start-up, and per-job / per-loop* information about the workload.

    • setShowWarnings

      public EnterpriseSchedulerFlagsConfigBuilder setShowWarnings(boolean showWarnings)
      If true enable warnings. These are non-fatal errors -- e.g., if a NUMA-aware allocation cannot be placed on the intended socket.

    • setShowEnvironment

      public EnterpriseSchedulerFlagsConfigBuilder setShowEnvironment(boolean showEnvironment)
      If true show version numbers and main environment settings at startup.

    • setShowProfiling

      public EnterpriseSchedulerFlagsConfigBuilder setShowProfiling(boolean showProfiling)
      If true show profiling information.

    • setShowSchedulerState

      public EnterpriseSchedulerFlagsConfigBuilder setShowSchedulerState(boolean showSchedulerState)
      If true dump scheduler state on each update.

    • setShowAllocations

      public EnterpriseSchedulerFlagsConfigBuilder setShowAllocations(boolean showAllocations)
      If true show memory allocation information.

    • setLogToStderr

      public EnterpriseSchedulerFlagsConfigBuilder setLogToStderr(boolean logToStderr)
      If true log to stderr. If false log using PGX's default logging facility.

    • setShowDebug

      public EnterpriseSchedulerFlagsConfigBuilder setShowDebug(boolean showDebug)
      [Internal use only] If true enable debug output. This is only available in debug builds.

    • setUseOpenmpThreadPool

      public EnterpriseSchedulerFlagsConfigBuilder setUseOpenmpThreadPool(boolean useOpenmpThreadPool)
      [Internal use only] If true, use OpenMP based thread pool. If false use pthreads based thread pool.

    • setOverrideCoresPerSocket

      public EnterpriseSchedulerFlagsConfigBuilder setOverrideCoresPerSocket(int overrideCoresPerSocket)
      [Internal use only] Over-ride the core-to-socket allocation, treating a fixed number of cores as a socket for the purposes of the per-socket combining structures. This is for experimental use on processors like the M7 with core clusters. If 0 use h/w information

    • setOverrideMemoryPlacement

      public EnterpriseSchedulerFlagsConfigBuilder setOverrideMemoryPlacement(boolean overrideMemoryPlacement)
      [Internal use only] Over-ride memory placement tags and use the OS defaults instead. If true use OS defaults, if false use workload tags

    • setMarkLoopForProfiling

      public EnterpriseSchedulerFlagsConfigBuilder setMarkLoopForProfiling(String markLoopForProfiling)
      [Internal use only] ID for any additional loop to profile. If set, the format is name:idx, e.g. "FooBar:1" for the first execution of the FooBar loop, or "XXYZ" for all executions of the XXYZ loop.

    • setSelectPerformanceCounters

      public EnterpriseSchedulerFlagsConfigBuilder setSelectPerformanceCounters(String selectPerformanceCounters)
      [Internal use only] Perf counter configuration string.

    • setSelectRegionPerformanceCounters

      public EnterpriseSchedulerFlagsConfigBuilder setSelectRegionPerformanceCounters(String selectRegionPerformanceCounters)
      [Internal use only] Region perf counter configuration string.

    • setSelectPerformanceCountersLibrary

      public EnterpriseSchedulerFlagsConfigBuilder setSelectPerformanceCountersLibrary(int selectPerformanceCountersLibrary)
      [Internal use only] Perf counter library.

    • setSelectPerformanceCountersPcmShowCodes

      public EnterpriseSchedulerFlagsConfigBuilder setSelectPerformanceCountersPcmShowCodes(int selectPerformanceCountersPcmShowCodes)
      [Internal use only] Show PCM perf counter codes.

    • setSelectPerformanceCountersJobRegions

      public EnterpriseSchedulerFlagsConfigBuilder setSelectPerformanceCountersJobRegions(int selectPerformanceCountersJobRegions)
      [Internal use only] Issue a region per job automatically.

    • setSelectPerformanceCountersShowStats

      public EnterpriseSchedulerFlagsConfigBuilder setSelectPerformanceCountersShowStats(int selectPerformanceCountersShowStats)
      [Internal use only] Perf counter per-thread statistics.

    • setShowDeterministicOutput

      public EnterpriseSchedulerFlagsConfigBuilder setShowDeterministicOutput(boolean showDeterministicOutput)
      [Internal use only] If true omit thread IDs in debug output (set to true for determinism in regression tests)

    • setSpinOnExit

      public EnterpriseSchedulerFlagsConfigBuilder setSpinOnExit(boolean spinOnExit)
      [Internal use only] If true spin after execution, rather than exiting. This provides an opportunity to attach a debugger or to inspect the placement of threads or of memory.

    • setEnableDebugSignal

      public EnterpriseSchedulerFlagsConfigBuilder setEnableDebugSignal(boolean enableDebugSignal)
      [Internal use only] If true, outputs a dump of internal state upon receiving a SIGQUIT signal.

    • setFixThreadsUsedFromMain

      public EnterpriseSchedulerFlagsConfigBuilder setFixThreadsUsedFromMain(boolean fixThreadsUsedFromMain)
      [Internal use only] If true fix threads used by work spawned by the main thread so that 0..N are used for an N-thread job. This aids comparison with OpenMP. If this is not set then threads will be chosen dynamically by the runtime system.