CommandLineOptions Class Reference

#include <CommandLineOptions.h>

Collaboration diagram for CommandLineOptions:

Public Member Functions
	CommandLineOptions (char const *argv0, bool dist_v5_=false)
void	fillOptions ()
void	fillAdvancedOptions ()
std::string	getNodeIds ()
std::vector< std::string >	getNodeIdsArray ()
boost::optional< int >	parse_command_line (int argc, char const *const *argv, const bool should_init_logging=false)
void	validate ()
void	validate_base_path ()
void	init_logging ()

Public Attributes
int	http_port = 6278
size_t	reserved_gpu_mem = 384 * 1024 * 1024
std::string	base_path
DiskCacheConfig	disk_cache_config
std::string	cluster_file = {"cluster.conf"}
std::string	cluster_topology_file = {"cluster_topology.conf"}
std::string	license_path = {""}
std::string	encryption_key_store_path = {}
bool	cpu_only = false
bool	verbose_logging = false
bool	jit_debug = false
bool	intel_jit_profile = false
bool	allow_multifrag = true
bool	read_only = false
bool	allow_loop_joins = false
bool	enable_legacy_syntax = true
bool	log_user_origin = true
AuthMetadata	authMetadata
SystemParameters	system_parameters
bool	enable_rendering = false
bool	enable_auto_clear_render_mem = false
int	render_oom_retry_threshold = 0
size_t	render_mem_bytes = 1000000000
size_t	max_concurrent_render_sessions = 500
bool	render_compositor_use_last_gpu = true
bool	renderer_use_vulkan_driver = false
bool	enable_runtime_udf = false
bool	enable_watchdog = true
bool	enable_dynamic_watchdog = false
bool	enable_runtime_query_interrupt = false
bool	use_estimator_result_cache = true
double	running_query_interrupt_freq = 0.5
unsigned	pending_query_interrupt_freq = 1000
unsigned	dynamic_watchdog_time_limit = 10000
std::string	disk_cache_level = ""
int	num_gpus = -1
int	start_gpu = 0
size_t	num_reader_threads = 0
std::string	db_query_file = {""}
bool	exit_after_warmup = false
int	idle_session_duration = kMinsPerHour
int	max_session_duration = kMinsPerMonth
std::string	udf_file_name = {""}
std::string	udf_compiler_path = {""}
std::vector< std::string >	udf_compiler_options
std::string	compressor = std::string(BLOSC_LZ4HC_COMPNAME)
po::options_description	help_desc
po::options_description	developer_desc
logger::LogOptions	log_options_
po::positional_options_description	positional_options
std::vector< LeafHostInfo >	db_leaves
std::vector< LeafHostInfo >	string_leaves
po::variables_map	vm
std::string	clusterIds_arg
const bool	dist_v5_

Static Public Attributes
static const std::string	nodeIds_token = {"node_id"}

Detailed Description

Definition at line 39 of file CommandLineOptions.h.

Constructor & Destructor Documentation

CommandLineOptions()

CommandLineOptions::CommandLineOptions ( char const *  argv0, bool  dist_v5_ = false  )

inline

Definition at line 41 of file CommandLineOptions.h.

References fillAdvancedOptions(), and fillOptions().

      : log_options_(argv0), dist_v5_(dist_v5_) {
    fillOptions();
    fillAdvancedOptions();
  }

Here is the call graph for this function:

Member Function Documentation

fillAdvancedOptions()

void CommandLineOptions::fillAdvancedOptions

(

)

Definition at line 396 of file CommandLineOptions.cpp.

References g_approx_quantile_buffer, g_approx_quantile_centroids, g_bitmap_memory_limit, g_enable_bump_allocator, g_enable_calcite_ddl_parser, g_enable_columnar_output, g_enable_direct_columnarization, g_enable_filter_function, g_enable_seconds_refresh, g_enable_smem_group_by, g_enable_smem_grouped_non_count_agg, g_enable_smem_non_grouped_agg, g_enable_table_functions, g_enable_window_functions, g_fraction_code_cache_to_evict, g_gpu_smem_threshold, g_large_ndv_multiplier, g_large_ndv_threshold, g_max_memory_allocation_size, g_min_memory_allocation_size, g_skip_intermediate_count, g_strip_join_covered_quals, g_use_table_device_offset, and g_use_tbb_pool.

Referenced by CommandLineOptions().

                                             {
  developer_desc.add_options()("dev-options", "Print internal developer options.");
  developer_desc.add_options()(
      "enable-calcite-view-optimize",
      po::value<bool>(&system_parameters.enable_calcite_view_optimize)
          ->default_value(system_parameters.enable_calcite_view_optimize)
          ->implicit_value(true),
      "Enable additional calcite (query plan) optimizations when a view is part of the "
      "query.");
  developer_desc.add_options()(
      "enable-columnar-output",
      po::value<bool>(&g_enable_columnar_output)
          ->default_value(g_enable_columnar_output)
          ->implicit_value(true),
      "Enable columnar output for intermediate/final query steps.");
  developer_desc.add_options()("enable-legacy-syntax",
                               po::value<bool>(&enable_legacy_syntax)
                                   ->default_value(enable_legacy_syntax)
                                   ->implicit_value(true),
                               "Enable legacy syntax.");
  developer_desc.add_options()(
      "enable-multifrag",
      po::value<bool>(&allow_multifrag)
          ->default_value(allow_multifrag)
          ->implicit_value(true),
      "Enable execution over multiple fragments in a single round-trip to GPU.");
  developer_desc.add_options()(
      "enable-shared-mem-group-by",
      po::value<bool>(&g_enable_smem_group_by)
          ->default_value(g_enable_smem_group_by)
          ->implicit_value(true),
      "Enable using GPU shared memory for some GROUP BY queries.");
  developer_desc.add_options()("num-executors",
                               po::value<int>(&system_parameters.num_executors)
                                   ->default_value(system_parameters.num_executors),
                               "Number of executors to run in parallel.");
  developer_desc.add_options()(
      "gpu-shared-mem-threshold",
      po::value<size_t>(&g_gpu_smem_threshold)->default_value(g_gpu_smem_threshold),
      "GPU shared memory threshold (in bytes). If query requires larger buffers than "
      "this threshold, we disable those optimizations. 0 (default) means no static cap.");
  developer_desc.add_options()(
      "enable-shared-mem-grouped-non-count-agg",
      po::value<bool>(&g_enable_smem_grouped_non_count_agg)
          ->default_value(g_enable_smem_grouped_non_count_agg)
          ->implicit_value(true),
      "Enable using GPU shared memory for grouped non-count aggregate queries.");
  developer_desc.add_options()(
      "enable-shared-mem-non-grouped-agg",
      po::value<bool>(&g_enable_smem_non_grouped_agg)
          ->default_value(g_enable_smem_non_grouped_agg)
          ->implicit_value(true),
      "Enable using GPU shared memory for non-grouped aggregate queries.");
  developer_desc.add_options()("enable-direct-columnarization",
                               po::value<bool>(&g_enable_direct_columnarization)
                                   ->default_value(g_enable_direct_columnarization)
                                   ->implicit_value(true),
                               "Enables/disables a more optimized columnarization method "
                               "for intermediate steps in multi-step queries.");
  developer_desc.add_options()(
      "offset-device-by-table-id",
      po::value<bool>(&g_use_table_device_offset)
          ->default_value(g_use_table_device_offset)
          ->implicit_value(true),
      "Enables/disables offseting the chosen device ID by the table ID for a given "
      "fragment. This improves balance of fragments across GPUs.");
  developer_desc.add_options()("enable-window-functions",
                               po::value<bool>(&g_enable_window_functions)
                                   ->default_value(g_enable_window_functions)
                                   ->implicit_value(true),
                               "Enable experimental window function support.");
  developer_desc.add_options()("enable-table-functions",
                               po::value<bool>(&g_enable_table_functions)
                                   ->default_value(g_enable_table_functions)
                                   ->implicit_value(true),
                               "Enable experimental table functions support.");
  developer_desc.add_options()(
      "jit-debug-ir",
      po::value<bool>(&jit_debug)->default_value(jit_debug)->implicit_value(true),
      "Enable runtime debugger support for the JIT. Note that this flag is "
      "incompatible "
      "with the `ENABLE_JIT_DEBUG` build flag. The generated code can be found at "
      "`/tmp/mapdquery`.");
  developer_desc.add_options()(
      "intel-jit-profile",
      po::value<bool>(&intel_jit_profile)
          ->default_value(intel_jit_profile)
          ->implicit_value(true),
      "Enable runtime support for the JIT code profiling using Intel VTune.");
  developer_desc.add_options()(
      "enable-modern-thread-pool",
      po::value<bool>(&g_use_tbb_pool)
          ->default_value(g_use_tbb_pool)
          ->implicit_value(true),
      "Enable a new thread pool implementation for queuing kernels for execution.");
  developer_desc.add_options()(
      "skip-intermediate-count",
      po::value<bool>(&g_skip_intermediate_count)
          ->default_value(g_skip_intermediate_count)
          ->implicit_value(true),
      "Skip pre-flight counts for intermediate projections with no filters.");
  developer_desc.add_options()(
      "strip-join-covered-quals",
      po::value<bool>(&g_strip_join_covered_quals)
          ->default_value(g_strip_join_covered_quals)
          ->implicit_value(true),
      "Remove quals from the filtered count if they are covered by a "
      "join condition (currently only ST_Contains).");

  developer_desc.add_options()(
      "min-cpu-slab-size",
      po::value<size_t>(&system_parameters.min_cpu_slab_size)
          ->default_value(system_parameters.min_cpu_slab_size),
      "Min slab size (size of memory allocations) for CPU buffer pool.");
  developer_desc.add_options()(
      "max-cpu-slab-size",
      po::value<size_t>(&system_parameters.max_cpu_slab_size)
          ->default_value(system_parameters.max_cpu_slab_size),
      "Max CPU buffer pool slab size (size of memory allocations). Note if "
      "there is not enough free memory to accomodate the target slab size, smaller "
      "slabs will be allocated, down to the minimum size specified by "
      "min-cpu-slab-size.");
  developer_desc.add_options()(
      "min-gpu-slab-size",
      po::value<size_t>(&system_parameters.min_gpu_slab_size)
          ->default_value(system_parameters.min_gpu_slab_size),
      "Min slab size (size of memory allocations) for GPU buffer pools.");
  developer_desc.add_options()(
      "max-gpu-slab-size",
      po::value<size_t>(&system_parameters.max_gpu_slab_size)
          ->default_value(system_parameters.max_gpu_slab_size),
      "Max GPU buffer pool slab size (size of memory allocations). Note if "
      "there is not enough free memory to accomodate the target slab size, smaller "
      "slabs will be allocated, down to the minimum size speified by "
      "min-gpu-slab-size.");

  developer_desc.add_options()(
      "max-output-projection-allocation-bytes",
      po::value<size_t>(&g_max_memory_allocation_size)
          ->default_value(g_max_memory_allocation_size),
      "Maximum allocation size for a fixed output buffer allocation for projection "
      "queries with no pre-flight count. Default is the maximum slab size (sizes "
      "greater "
      "than the maximum slab size have no affect). Requires bump allocator.");
  developer_desc.add_options()(
      "min-output-projection-allocation-bytes",
      po::value<size_t>(&g_min_memory_allocation_size)
          ->default_value(g_min_memory_allocation_size),
      "Minimum allocation size for a fixed output buffer allocation for projection "
      "queries with no pre-flight count. If an allocation of this size cannot be "
      "obtained, the query will be retried with different execution parameters and/or "
      "on "
      "CPU (if allow-cpu-retry is enabled). Requires bump allocator.");
  developer_desc.add_options()("enable-bump-allocator",
                               po::value<bool>(&g_enable_bump_allocator)
                                   ->default_value(g_enable_bump_allocator)
                                   ->implicit_value(true),
                               "Enable the bump allocator for projection queries on "
                               "GPU. The bump allocator will "
                               "allocate a fixed size buffer for each query, track the "
                               "number of rows passing the "
                               "kernel during query execution, and copy back only the "
                               "rows that passed the kernel "
                               "to CPU after execution. When disabled, pre-flight "
                               "count queries are used to size "
                               "the output buffer for projection queries.");
  developer_desc.add_options()(
      "code-cache-eviction-percent",
      po::value<float>(&g_fraction_code_cache_to_evict)
          ->default_value(g_fraction_code_cache_to_evict),
      "Percentage of the GPU code cache to evict if an out of memory error is "
      "encountered while attempting to place generated code on the GPU.");

  developer_desc.add_options()("ssl-cert",
                               po::value<std::string>(&system_parameters.ssl_cert_file)
                                   ->default_value(std::string("")),
                               "SSL Validated public certficate.");

  developer_desc.add_options()("ssl-private-key",
                               po::value<std::string>(&system_parameters.ssl_key_file)
                                   ->default_value(std::string("")),
                               "SSL private key file.");
  // Note ssl_trust_store is passed through to Calcite via system_parameters
  // todo(jack): add ensure ssl-trust-store exists if cert and private key in use
  developer_desc.add_options()("ssl-trust-store",
                               po::value<std::string>(&system_parameters.ssl_trust_store)
                                   ->default_value(std::string("")),
                               "SSL public CA certifcates (java trust store) to validate "
                               "TLS connections (passed through to the Calcite server).");

  developer_desc.add_options()(
      "ssl-trust-password",
      po::value<std::string>(&system_parameters.ssl_trust_password)
          ->default_value(std::string("")),
      "SSL password for java trust store provided via --ssl-trust-store parameter.");

  developer_desc.add_options()(
      "ssl-trust-ca",
      po::value<std::string>(&system_parameters.ssl_trust_ca_file)
          ->default_value(std::string("")),
      "SSL public CA certificates to validate TLS connection(as a client).");

  developer_desc.add_options()(
      "ssl-trust-ca-server",
      po::value<std::string>(&authMetadata.ca_file_name)->default_value(std::string("")),
      "SSL public CA certificates to validate TLS connection(as a server).");

  developer_desc.add_options()("ssl-keystore",
                               po::value<std::string>(&system_parameters.ssl_keystore)
                                   ->default_value(std::string("")),
                               "SSL server credentials as a java key store (passed "
                               "through to the Calcite server).");

  developer_desc.add_options()(
      "ssl-keystore-password",
      po::value<std::string>(&system_parameters.ssl_keystore_password)
          ->default_value(std::string("")),
      "SSL password for java keystore, provide by via --ssl-keystore.");

  developer_desc.add_options()(
      "udf",
      po::value<std::string>(&udf_file_name),
      "Load user defined extension functions from this file at startup. The file is "
      "expected to be a C/C++ file with extension .cpp.");

  developer_desc.add_options()(
      "udf-compiler-path",
      po::value<std::string>(&udf_compiler_path),
      "Provide absolute path to clang++ used in udf compilation.");

  developer_desc.add_options()("udf-compiler-options",
                               po::value<std::vector<std::string>>(&udf_compiler_options),
                               "Specify compiler options to tailor udf compilation.");

#ifdef ENABLE_GEOS
  developer_desc.add_options()("libgeos-so-filename",
                               po::value<std::string>(&libgeos_so_filename),
                               "Specify libgeos shared object filename to be used for "
                               "geos-backed geo opertations.");
#endif
  developer_desc.add_options()(
      "large-ndv-threshold",
      po::value<int64_t>(&g_large_ndv_threshold)->default_value(g_large_ndv_threshold));
  developer_desc.add_options()(
      "large-ndv-multiplier",
      po::value<size_t>(&g_large_ndv_multiplier)->default_value(g_large_ndv_multiplier));
  developer_desc.add_options()("approx_quantile_buffer",
                               po::value<size_t>(&g_approx_quantile_buffer)
                                   ->default_value(g_approx_quantile_buffer));
  developer_desc.add_options()("approx_quantile_centroids",
                               po::value<size_t>(&g_approx_quantile_centroids)
                                   ->default_value(g_approx_quantile_centroids));
  developer_desc.add_options()(
      "bitmap-memory-limit",
      po::value<int64_t>(&g_bitmap_memory_limit)->default_value(g_bitmap_memory_limit),
      "Limit for count distinct bitmap memory use. The limit is computed by taking the "
      "size of the group by buffer (entry count in Query Memory Descriptor) and "
      "multiplying it by the number of count distinct expression and the size of bitmap "
      "required for each. For approx_count_distinct this is typically 8192 bytes.");
  developer_desc.add_options()(
      "enable-filter-function",
      po::value<bool>(&g_enable_filter_function)
          ->default_value(g_enable_filter_function)
          ->implicit_value(true),
      "Enable the filter function protection feature for the SQL JIT compiler. "
      "Normally should be on but techs might want to disable for troubleshooting.");
  developer_desc.add_options()(
      "enable-calcite-ddl",
      po::value<bool>(&g_enable_calcite_ddl_parser)
          ->default_value(g_enable_calcite_ddl_parser)
          ->implicit_value(true),
      "Enable using Calcite for supported DDL parsing when available.");
  developer_desc.add_options()(
      "enable-seconds-refresh-interval",
      po::value<bool>(&g_enable_seconds_refresh)
          ->default_value(g_enable_seconds_refresh)
          ->implicit_value(true),
      "Enable foreign table seconds refresh interval for testing purposes.");
}

Here is the caller graph for this function:

fillOptions()

void CommandLineOptions::fillOptions

(

)

Definition at line 67 of file CommandLineOptions.cpp.

References g_allow_cpu_retry, g_bigint_count, g_cache_string_hash, g_enable_debug_timer, g_enable_experimental_string_functions, g_enable_filter_push_down, g_enable_fsi, g_enable_hashjoin_many_to_many, g_enable_interop, g_enable_overlaps_hashjoin, g_enable_stringdict_parallel, g_enable_thrift_logs, g_enable_union, g_filter_push_down_high_frac, g_filter_push_down_low_frac, g_filter_push_down_passing_row_ubound, g_from_table_reordering, g_hll_precision_bits, g_inner_join_fragment_skipping, Catalog_Namespace::g_log_user_id, g_max_import_threads, g_null_div_by_zero, g_overlaps_max_table_size_bytes, g_trivial_loop_join_threshold, and run_benchmark_import::required.

Referenced by CommandLineOptions().

                                     {
  help_desc.add_options()("help,h", "Show available options.");
  help_desc.add_options()(
      "allow-cpu-retry",
      po::value<bool>(&g_allow_cpu_retry)
          ->default_value(g_allow_cpu_retry)
          ->implicit_value(true),
      R"(Allow the queries which failed on GPU to retry on CPU, even when watchdog is enabled.)");
  help_desc.add_options()("allow-loop-joins",
                          po::value<bool>(&allow_loop_joins)
                              ->default_value(allow_loop_joins)
                              ->implicit_value(true),
                          "Enable loop joins.");
  help_desc.add_options()("bigint-count",
                          po::value<bool>(&g_bigint_count)
                              ->default_value(g_bigint_count)
                              ->implicit_value(true),
                          "Use 64-bit count.");
  help_desc.add_options()("calcite-max-mem",
                          po::value<size_t>(&system_parameters.calcite_max_mem)
                              ->default_value(system_parameters.calcite_max_mem),
                          "Max memory available to calcite JVM.");
  if (!dist_v5_) {
    help_desc.add_options()("calcite-port",
                            po::value<int>(&system_parameters.calcite_port)
                                ->default_value(system_parameters.calcite_port),
                            "Calcite port number.");
  }
  help_desc.add_options()("config",
                          po::value<std::string>(&system_parameters.config_file),
                          "Path to server configuration file.");
  help_desc.add_options()("cpu-buffer-mem-bytes",
                          po::value<size_t>(&system_parameters.cpu_buffer_mem_bytes)
                              ->default_value(system_parameters.cpu_buffer_mem_bytes),
                          "Size of memory reserved for CPU buffers, in bytes.");

  help_desc.add_options()(
      "cpu-only",
      po::value<bool>(&cpu_only)->default_value(cpu_only)->implicit_value(true),
      "Run on CPU only, even if GPUs are available.");
  help_desc.add_options()("cuda-block-size",
                          po::value<size_t>(&system_parameters.cuda_block_size)
                              ->default_value(system_parameters.cuda_block_size),
                          "Size of block to use on GPU.");
  help_desc.add_options()("cuda-grid-size",
                          po::value<size_t>(&system_parameters.cuda_grid_size)
                              ->default_value(system_parameters.cuda_grid_size),
                          "Size of grid to use on GPU.");
  if (!dist_v5_) {
    help_desc.add_options()(
        "data",
        po::value<std::string>(&base_path)->required()->default_value("data"),
        "Directory path to OmniSci data storage (catalogs, raw data, log files, etc).");
    positional_options.add("data", 1);
  }
  help_desc.add_options()("db-query-list",
                          po::value<std::string>(&db_query_file),
                          "Path to file containing OmniSci warmup queries.");
  help_desc.add_options()(
      "exit-after-warmup",
      po::value<bool>(&exit_after_warmup)->default_value(false)->implicit_value(true),
      "Exit after OmniSci warmup queries.");
  help_desc.add_options()("dynamic-watchdog-time-limit",
                          po::value<unsigned>(&dynamic_watchdog_time_limit)
                              ->default_value(dynamic_watchdog_time_limit)
                              ->implicit_value(10000),
                          "Dynamic watchdog time limit, in milliseconds.");
  help_desc.add_options()("enable-debug-timer",
                          po::value<bool>(&g_enable_debug_timer)
                              ->default_value(g_enable_debug_timer)
                              ->implicit_value(true),
                          "Enable debug timer logging.");
  help_desc.add_options()("enable-dynamic-watchdog",
                          po::value<bool>(&enable_dynamic_watchdog)
                              ->default_value(enable_dynamic_watchdog)
                              ->implicit_value(true),
                          "Enable dynamic watchdog.");
  help_desc.add_options()("enable-filter-push-down",
                          po::value<bool>(&g_enable_filter_push_down)
                              ->default_value(g_enable_filter_push_down)
                              ->implicit_value(true),
                          "Enable filter push down through joins.");
  help_desc.add_options()("enable-overlaps-hashjoin",
                          po::value<bool>(&g_enable_overlaps_hashjoin)
                              ->default_value(g_enable_overlaps_hashjoin)
                              ->implicit_value(true),
                          "Enable the overlaps hash join framework allowing for range "
                          "join (e.g. spatial overlaps) computation using a hash table.");
  help_desc.add_options()("enable-hashjoin-many-to-many",
                          po::value<bool>(&g_enable_hashjoin_many_to_many)
                              ->default_value(g_enable_hashjoin_many_to_many)
                              ->implicit_value(true),
                          "Enable the overlaps hash join framework allowing for range "
                          "join (e.g. spatial overlaps) computation using a hash table.");
  help_desc.add_options()("enable-runtime-query-interrupt",
                          po::value<bool>(&enable_runtime_query_interrupt)
                              ->default_value(enable_runtime_query_interrupt)
                              ->implicit_value(true),
                          "Enable runtime query interrupt.");
  help_desc.add_options()("pending-query-interrupt-freq",
                          po::value<unsigned>(&pending_query_interrupt_freq)
                              ->default_value(pending_query_interrupt_freq)
                              ->implicit_value(1000),
                          "A frequency of checking the request of pending query "
                          "interrupt from user (in millisecond).");
  help_desc.add_options()(
      "running-query-interrupt-freq",
      po::value<double>(&running_query_interrupt_freq)
          ->default_value(running_query_interrupt_freq)
          ->implicit_value(0.5),
      "A frequency of checking the request of running query "
      "interrupt from user (0.0 (less frequent) ~ (more frequent) 1.0).");
  help_desc.add_options()("use-estimator-result-cache",
                          po::value<bool>(&use_estimator_result_cache)
                              ->default_value(use_estimator_result_cache)
                              ->implicit_value(true),
                          "Use estimator result cache.");
  if (!dist_v5_) {
    help_desc.add_options()(
        "enable-string-dict-hash-cache",
        po::value<bool>(&g_cache_string_hash)
            ->default_value(g_cache_string_hash)
            ->implicit_value(true),
        "Cache string hash values in the string dictionary server during import.");
  }
  help_desc.add_options()(
      "enable-thrift-logs",
      po::value<bool>(&g_enable_thrift_logs)
          ->default_value(g_enable_thrift_logs)
          ->implicit_value(true),
      "Enable writing messages directly from thrift to stdout/stderr.");
  help_desc.add_options()("enable-watchdog",
                          po::value<bool>(&enable_watchdog)
                              ->default_value(enable_watchdog)
                              ->implicit_value(true),
                          "Enable watchdog.");
  help_desc.add_options()(
      "filter-push-down-low-frac",
      po::value<float>(&g_filter_push_down_low_frac)
          ->default_value(g_filter_push_down_low_frac)
          ->implicit_value(g_filter_push_down_low_frac),
      "Lower threshold for selectivity of filters that are pushed down.");
  help_desc.add_options()(
      "filter-push-down-high-frac",
      po::value<float>(&g_filter_push_down_high_frac)
          ->default_value(g_filter_push_down_high_frac)
          ->implicit_value(g_filter_push_down_high_frac),
      "Higher threshold for selectivity of filters that are pushed down.");
  help_desc.add_options()("filter-push-down-passing-row-ubound",
                          po::value<size_t>(&g_filter_push_down_passing_row_ubound)
                              ->default_value(g_filter_push_down_passing_row_ubound)
                              ->implicit_value(g_filter_push_down_passing_row_ubound),
                          "Upperbound on the number of rows that should pass the filter "
                          "if the selectivity is less than "
                          "the high fraction threshold.");
  help_desc.add_options()("from-table-reordering",
                          po::value<bool>(&g_from_table_reordering)
                              ->default_value(g_from_table_reordering)
                              ->implicit_value(true),
                          "Enable automatic table reordering in FROM clause.");
  help_desc.add_options()("gpu-buffer-mem-bytes",
                          po::value<size_t>(&system_parameters.gpu_buffer_mem_bytes)
                              ->default_value(system_parameters.gpu_buffer_mem_bytes),
                          "Size of memory reserved for GPU buffers, in bytes, per GPU.");
  help_desc.add_options()("gpu-input-mem-limit",
                          po::value<double>(&system_parameters.gpu_input_mem_limit)
                              ->default_value(system_parameters.gpu_input_mem_limit),
                          "Force query to CPU when input data memory usage exceeds this "
                          "percentage of available GPU memory.");
  help_desc.add_options()(
      "hll-precision-bits",
      po::value<int>(&g_hll_precision_bits)
          ->default_value(g_hll_precision_bits)
          ->implicit_value(g_hll_precision_bits),
      "Number of bits used from the hash value used to specify the bucket number.");
  if (!dist_v5_) {
    help_desc.add_options()("http-port",
                            po::value<int>(&http_port)->default_value(http_port),
                            "HTTP port number.");
  }
  help_desc.add_options()(
      "idle-session-duration",
      po::value<int>(&idle_session_duration)->default_value(idle_session_duration),
      "Maximum duration of idle session.");
  help_desc.add_options()("inner-join-fragment-skipping",
                          po::value<bool>(&g_inner_join_fragment_skipping)
                              ->default_value(g_inner_join_fragment_skipping)
                              ->implicit_value(true),
                          "Enable/disable inner join fragment skipping. This feature is "
                          "considered stable and is enabled by default. This "
                          "parameter will be removed in a future release.");
  help_desc.add_options()(
      "max-session-duration",
      po::value<int>(&max_session_duration)->default_value(max_session_duration),
      "Maximum duration of active session.");
  help_desc.add_options()(
      "null-div-by-zero",
      po::value<bool>(&g_null_div_by_zero)
          ->default_value(g_null_div_by_zero)
          ->implicit_value(true),
      "Return null on division by zero instead of throwing an exception.");
  help_desc.add_options()(
      "num-reader-threads",
      po::value<size_t>(&num_reader_threads)->default_value(num_reader_threads),
      "Number of reader threads to use.");
  help_desc.add_options()(
      "max-import-threads",
      po::value<size_t>(&g_max_import_threads)->default_value(g_max_import_threads),
      "Max number of default import threads to use (num hardware threads will be used "
      "instead if lower). Can be overriden with copy statement threads option).");
  help_desc.add_options()(
      "overlaps-max-table-size-bytes",
      po::value<size_t>(&g_overlaps_max_table_size_bytes)
          ->default_value(g_overlaps_max_table_size_bytes),
      "The maximum size in bytes of the hash table for an overlaps hash join.");
  if (!dist_v5_) {
    help_desc.add_options()("port,p",
                            po::value<int>(&system_parameters.omnisci_server_port)
                                ->default_value(system_parameters.omnisci_server_port),
                            "TCP Port number.");
  }
  help_desc.add_options()("num-gpus",
                          po::value<int>(&num_gpus)->default_value(num_gpus),
                          "Number of gpus to use.");
  help_desc.add_options()(
      "read-only",
      po::value<bool>(&read_only)->default_value(read_only)->implicit_value(true),
      "Enable read-only mode.");

  help_desc.add_options()(
      "res-gpu-mem",
      po::value<size_t>(&reserved_gpu_mem)->default_value(reserved_gpu_mem),
      "Reduces GPU memory available to the OmniSci allocator by this amount. Used for "
      "compiled code cache and ancillary GPU functions and other processes that may also "
      "be using the GPU concurrent with OmniSciDB.");

  help_desc.add_options()("start-gpu",
                          po::value<int>(&start_gpu)->default_value(start_gpu),
                          "First gpu to use.");
  help_desc.add_options()("trivial-loop-join-threshold",
                          po::value<unsigned>(&g_trivial_loop_join_threshold)
                              ->default_value(g_trivial_loop_join_threshold)
                              ->implicit_value(1000),
                          "The maximum number of rows in the inner table of a loop join "
                          "considered to be trivially small.");
  help_desc.add_options()("verbose",
                          po::value<bool>(&verbose_logging)
                              ->default_value(verbose_logging)
                              ->implicit_value(true),
                          "Write additional debug log messages to server logs.");
  help_desc.add_options()(
      "enable-runtime-udf",
      po::value<bool>(&enable_runtime_udf)
          ->default_value(enable_runtime_udf)
          ->implicit_value(true),
      "Enable runtime UDF registration by passing signatures and corresponding LLVM IR "
      "to the `register_runtime_udf` endpoint. For use with the Python Remote Backend "
      "Compiler server, packaged separately.");
  help_desc.add_options()("version,v", "Print Version Number.");
  help_desc.add_options()("enable-experimental-string-functions",
                          po::value<bool>(&g_enable_experimental_string_functions)
                              ->default_value(g_enable_experimental_string_functions)
                              ->implicit_value(true),
                          "Enable experimental string functions.");
  help_desc.add_options()(
      "enable-fsi",
      po::value<bool>(&g_enable_fsi)->default_value(g_enable_fsi)->implicit_value(true),
      "Enable foreign storage interface.");
  help_desc.add_options()("disk-cache-path",
                          po::value<std::string>(&disk_cache_config.path),
                          "Specify the path for the disk cache.");

#ifdef ENABLE_GENERAL_DISK_CACHE
  help_desc.add_options()(
      "disk-cache-level",
      po::value<std::string>(&(disk_cache_level))->default_value("foreign_tables"),
      "Specify level of disk cache. Valid options are 'foreign_tables', "
      "'local_tables', 'none', and 'all'.");
#else
  help_desc.add_options()(
      "disk-cache-level",
      po::value<std::string>(&(disk_cache_level))->default_value("foreign_tables"),
      "Specify level of disk cache. Valid options are 'foreign_tables' "
      "and 'none'.");
#endif  // ENABLE_GENERAL_DISK_CACHE

  help_desc.add_options()(
      "enable-interoperability",
      po::value<bool>(&g_enable_interop)
          ->default_value(g_enable_interop)
          ->implicit_value(true),
      "Enable offloading of query portions to an external execution engine.");
  help_desc.add_options()("enable-union",
                          po::value<bool>(&g_enable_union)
                              ->default_value(g_enable_union)
                              ->implicit_value(true),
                          "Enable UNION ALL SQL clause.");
  help_desc.add_options()(
      "calcite-service-timeout",
      po::value<size_t>(&system_parameters.calcite_timeout)
          ->default_value(system_parameters.calcite_timeout),
      "Calcite server timeout (milliseconds). Increase this on systems with frequent "
      "schema changes or when running large numbers of parallel queries.");
  help_desc.add_options()("calcite-service-keepalive",
                          po::value<size_t>(&system_parameters.calcite_keepalive)
                              ->default_value(system_parameters.calcite_keepalive)
                              ->implicit_value(true),
                          "Enable keepalive on Calcite connections.");
  help_desc.add_options()(
      "stringdict-parallelizm",
      po::value<bool>(&g_enable_stringdict_parallel)
          ->default_value(g_enable_stringdict_parallel)
          ->implicit_value(true),
      "Allow StringDictionary to parallelize loads using multiple threads");
  help_desc.add_options()(
      "log-user-id",
      po::value<bool>(&Catalog_Namespace::g_log_user_id)
          ->default_value(Catalog_Namespace::g_log_user_id)
          ->implicit_value(true),
      "Log userId integer in place of the userName (when available).");
  help_desc.add_options()("log-user-origin",
                          po::value<bool>(&log_user_origin)
                              ->default_value(log_user_origin)
                              ->implicit_value(true),
                          "Lookup the origin of inbound connections by IP address/DNS "
                          "name, and print this information as part of stdlog.");
  help_desc.add(log_options_.get_options());
}

Here is the caller graph for this function:

getNodeIds()

std::string CommandLineOptions::getNodeIds

(

)

getNodeIdsArray()

std::vector<std::string> CommandLineOptions::getNodeIdsArray

(

)

init_logging()

void CommandLineOptions::init_logging

(

)

Definition at line 58 of file CommandLineOptions.cpp.

References logger::DEBUG1, and logger::init().

                                      {
  if (verbose_logging && logger::Severity::DEBUG1 < log_options_.severity_) {
    log_options_.severity_ = logger::Severity::DEBUG1;
  }
  validate_base_path();
  log_options_.set_base_path(base_path);
  logger::init(log_options_);
}

Here is the call graph for this function:

parse_command_line()

boost::optional< int > CommandLineOptions::parse_command_line	(	int	argc,
		char const *const *	argv,
		const bool	should_init_logging = false
	)

Definition at line 860 of file CommandLineOptions.cpp.

References logger::ERROR, g_dynamic_watchdog_time_limit, g_enable_dynamic_watchdog, g_enable_filter_push_down, g_enable_runtime_query_interrupt, g_enable_watchdog, g_from_table_reordering, g_max_import_threads, g_pending_query_interrupt_freq, g_running_query_interrupt_freq, g_use_estimator_result_cache, logger::INFO, LOG, MAPD_RELEASE, run, anonymous_namespace{CommandLineOptions.cpp}::sanitize_config_file(), and anonymous_namespace{CommandLineOptions.cpp}::trim_and_check_file_exists().

Referenced by main().

                                    {
  po::options_description all_desc("All options");
  all_desc.add(help_desc).add(developer_desc);

  try {
    po::store(po::command_line_parser(argc, argv)
                  .options(all_desc)
                  .positional(positional_options)
                  .run(),
              vm);
    po::notify(vm);

    if (vm.count("help")) {
      std::cerr << "Usage: omnisci_server <data directory path> [-p <port number>] "
                   "[--http-port <http port number>] [--flush-log] [--version|-v]"
                << std::endl
                << std::endl;
      std::cout << help_desc << std::endl;
      return 0;
    }
    if (vm.count("dev-options")) {
      std::cout << "Usage: omnisci_server <data directory path> [-p <port number>] "
                   "[--http-port <http port number>] [--flush-log] [--version|-v]"
                << std::endl
                << std::endl;
      std::cout << developer_desc << std::endl;
      return 0;
    }
    if (vm.count("version")) {
      std::cout << "OmniSci Version: " << MAPD_RELEASE << std::endl;
      return 0;
    }

    if (vm.count("config")) {
      std::ifstream settings_file(system_parameters.config_file);

      auto sanitized_settings = sanitize_config_file(settings_file);

      po::store(po::parse_config_file(sanitized_settings, all_desc, false), vm);
      po::notify(vm);
      settings_file.close();
    }

    if (should_init_logging) {
      init_logging();
    }

    if (!trim_and_check_file_exists(system_parameters.ssl_cert_file, "ssl cert file")) {
      return 1;
    }
    if (!trim_and_check_file_exists(authMetadata.ca_file_name, "ca file name")) {
      return 1;
    }
    if (!trim_and_check_file_exists(system_parameters.ssl_trust_store,
                                    "ssl trust store")) {
      return 1;
    }
    if (!trim_and_check_file_exists(system_parameters.ssl_keystore, "ssl key store")) {
      return 1;
    }
    if (!trim_and_check_file_exists(system_parameters.ssl_key_file, "ssl key file")) {
      return 1;
    }
    if (!trim_and_check_file_exists(system_parameters.ssl_trust_ca_file, "ssl ca file")) {
      return 1;
    }

    g_enable_watchdog = enable_watchdog;
    g_enable_dynamic_watchdog = enable_dynamic_watchdog;
    g_dynamic_watchdog_time_limit = dynamic_watchdog_time_limit;
    g_enable_runtime_query_interrupt = enable_runtime_query_interrupt;
    g_pending_query_interrupt_freq = pending_query_interrupt_freq;
    g_running_query_interrupt_freq = running_query_interrupt_freq;
    g_use_estimator_result_cache = use_estimator_result_cache;
  } catch (po::error& e) {
    std::cerr << "Usage Error: " << e.what() << std::endl;
    return 1;
  }

  if (g_hll_precision_bits < 1 || g_hll_precision_bits > 16) {
    std::cerr << "hll-precision-bits must be between 1 and 16." << std::endl;
    return 1;
  }

  if (!g_from_table_reordering) {
    LOG(INFO) << " From clause table reordering is disabled";
  }

  if (g_enable_filter_push_down) {
    LOG(INFO) << " Filter push down for JOIN is enabled";
  }

  if (vm.count("udf")) {
    boost::algorithm::trim_if(udf_file_name, boost::is_any_of("\"'"));

    if (!boost::filesystem::exists(udf_file_name)) {
      LOG(ERROR) << " User defined function file " << udf_file_name << " does not exist.";
      return 1;
    }

    LOG(INFO) << " User provided extension functions loaded from " << udf_file_name;
  }

  if (vm.count("udf-compiler-path")) {
    boost::algorithm::trim_if(udf_compiler_path, boost::is_any_of("\"'"));
  }

  auto trim_string = [](std::string& s) {
    boost::algorithm::trim_if(s, boost::is_any_of("\"'"));
  };

  if (vm.count("udf-compiler-options")) {
    std::for_each(udf_compiler_options.begin(), udf_compiler_options.end(), trim_string);
  }

  if (enable_runtime_udf) {
    LOG(INFO) << " Runtime user defined extension functions enabled globally.";
  }

  boost::algorithm::trim_if(system_parameters.ha_brokers, boost::is_any_of("\"'"));
  boost::algorithm::trim_if(system_parameters.ha_group_id, boost::is_any_of("\"'"));
  boost::algorithm::trim_if(system_parameters.ha_shared_data, boost::is_any_of("\"'"));
  boost::algorithm::trim_if(system_parameters.ha_unique_server_id,
                            boost::is_any_of("\"'"));

  if (!system_parameters.ha_group_id.empty()) {
    LOG(INFO) << " HA group id " << system_parameters.ha_group_id;
    if (system_parameters.ha_unique_server_id.empty()) {
      LOG(ERROR) << "Starting server in HA mode --ha-unique-server-id must be set ";
      return 5;
    } else {
      LOG(INFO) << " HA unique server id " << system_parameters.ha_unique_server_id;
    }
    if (system_parameters.ha_brokers.empty()) {
      LOG(ERROR) << "Starting server in HA mode --ha-brokers must be set ";
      return 6;
    } else {
      LOG(INFO) << " HA brokers " << system_parameters.ha_brokers;
    }
    if (system_parameters.ha_shared_data.empty()) {
      LOG(ERROR) << "Starting server in HA mode --ha-shared-data must be set ";
      return 7;
    } else {
      LOG(INFO) << " HA shared data is " << system_parameters.ha_shared_data;
    }
  }

  if (g_max_import_threads < 1) {
    std::cerr << "max-import-threads must be >= 1 (was set to " << g_max_import_threads
              << ")." << std::endl;
    return 8;
  } else {
    LOG(INFO) << " Max import threads " << g_max_import_threads;
  }

  LOG(INFO) << " cuda block size " << system_parameters.cuda_block_size;
  LOG(INFO) << " cuda grid size  " << system_parameters.cuda_grid_size;
  LOG(INFO) << " Min CPU buffer pool slab size " << system_parameters.min_cpu_slab_size;
  LOG(INFO) << " Max CPU buffer pool slab size " << system_parameters.max_cpu_slab_size;
  LOG(INFO) << " Min GPU buffer pool slab size " << system_parameters.min_gpu_slab_size;
  LOG(INFO) << " Max GPU buffer pool slab size " << system_parameters.max_gpu_slab_size;
  LOG(INFO) << " calcite JVM max memory  " << system_parameters.calcite_max_mem;
  LOG(INFO) << " OmniSci Server Port  " << system_parameters.omnisci_server_port;
  LOG(INFO) << " OmniSci Calcite Port  " << system_parameters.calcite_port;
  LOG(INFO) << " Enable Calcite view optimize "
            << system_parameters.enable_calcite_view_optimize;

  LOG(INFO) << " Allow Local Auth Fallback: "
            << (authMetadata.allowLocalAuthFallback ? "enabled" : "disabled");

  boost::algorithm::trim_if(authMetadata.distinguishedName, boost::is_any_of("\"'"));
  boost::algorithm::trim_if(authMetadata.uri, boost::is_any_of("\"'"));
  boost::algorithm::trim_if(authMetadata.ldapQueryUrl, boost::is_any_of("\"'"));
  boost::algorithm::trim_if(authMetadata.ldapRoleRegex, boost::is_any_of("\"'"));
  boost::algorithm::trim_if(authMetadata.ldapSuperUserRole, boost::is_any_of("\"'"));

  return boost::none;
}

Here is the call graph for this function:

Here is the caller graph for this function:

validate()

void CommandLineOptions::validate

(

)

Definition at line 721 of file CommandLineOptions.cpp.

References anonymous_namespace{CommandLineOptions.cpp}::addOptionalFileToBlacklist(), ddl_utils::FilePathBlacklist::addToBlacklist(), all, omnisci::close(), fsi, g_enable_debug_timer, g_enable_fsi, g_enable_s3_fsi, Catalog_Namespace::g_log_user_id, logger::INFO, ddl_utils::FilePathWhitelist::initializeFromConfigFile(), LOG, non_fsi, none, OMNISCI_SYSTEM_CATALOG, omnisci::open(), to_string(), and File_Namespace::write().

Referenced by main().

                                  {
  boost::algorithm::trim_if(base_path, boost::is_any_of("\"'"));
  const auto data_path = boost::filesystem::path(base_path) / "mapd_data";
  if (!boost::filesystem::exists(data_path)) {
    throw std::runtime_error("OmniSci data directory does not exist at '" + base_path +
                             "'");
  }

  {
    const auto lock_file = boost::filesystem::path(base_path) / "omnisci_server_pid.lck";
    auto pid = std::to_string(getpid());

    int pid_fd = open(lock_file.c_str(), O_RDWR | O_CREAT, 0644);
    if (pid_fd == -1) {
      auto err = std::string("Failed to open PID file ") + lock_file.c_str() + ". " +
                 strerror(errno) + ".";
      throw std::runtime_error(err);
    }
    if (lockf(pid_fd, F_TLOCK, 0) == -1) {
      close(pid_fd);
      auto err = std::string("Another OmniSci Server is using data directory ") +
                 base_path + ".";
      throw std::runtime_error(err);
    }
    if (ftruncate(pid_fd, 0) == -1) {
      close(pid_fd);
      auto err = std::string("Failed to truncate PID file ") + lock_file.c_str() + ". " +
                 strerror(errno) + ".";
      throw std::runtime_error(err);
    }
    if (write(pid_fd, pid.c_str(), pid.length()) == -1) {
      close(pid_fd);
      auto err = std::string("Failed to write PID file ") + lock_file.c_str() + ". " +
                 strerror(errno) + ".";
      throw std::runtime_error(err);
    }
  }
  boost::algorithm::trim_if(db_query_file, boost::is_any_of("\"'"));
  if (db_query_file.length() > 0 && !boost::filesystem::exists(db_query_file)) {
    throw std::runtime_error("File containing DB queries " + db_query_file +
                             " does not exist.");
  }
  const auto db_file =
      boost::filesystem::path(base_path) / "mapd_catalogs" / OMNISCI_SYSTEM_CATALOG;
  if (!boost::filesystem::exists(db_file)) {
    {  // check old system catalog existsense
      const auto db_file = boost::filesystem::path(base_path) / "mapd_catalogs/mapd";
      if (!boost::filesystem::exists(db_file)) {
        throw std::runtime_error("OmniSci system catalog " + OMNISCI_SYSTEM_CATALOG +
                                 " does not exist.");
      }
    }
  }
  if (license_path.length() == 0) {
    license_path = base_path + "/omnisci.license";
  }

  // add all parameters to be displayed on startup
  LOG(INFO) << "OmniSci started with data directory at '" << base_path << "'";
  if (vm.count("license-path")) {
    LOG(INFO) << "License key path set to '" << license_path << "'";
  }
  LOG(INFO) << " Watchdog is set to " << enable_watchdog;
  LOG(INFO) << " Dynamic Watchdog is set to " << enable_dynamic_watchdog;
  if (enable_dynamic_watchdog) {
    LOG(INFO) << " Dynamic Watchdog timeout is set to " << dynamic_watchdog_time_limit;
  }
  LOG(INFO) << " Runtime query interrupt is set to " << enable_runtime_query_interrupt;
  if (enable_runtime_query_interrupt) {
    LOG(INFO) << " A frequency of checking pending query interrupt request is set to "
              << pending_query_interrupt_freq << " (in ms.)";
    LOG(INFO) << " A frequency of checking running query interrupt request is set to "
              << running_query_interrupt_freq << " (0.0 ~ 1.0)";
  }

  LOG(INFO) << " Debug Timer is set to " << g_enable_debug_timer;
  LOG(INFO) << " LogUserId is set to " << Catalog_Namespace::g_log_user_id;
  LOG(INFO) << " Maximum Idle session duration " << idle_session_duration;
  LOG(INFO) << " Maximum active session duration " << max_session_duration;

  ddl_utils::FilePathWhitelist::initializeFromConfigFile(system_parameters.config_file);

  ddl_utils::FilePathBlacklist::addToBlacklist(base_path + "/mapd_catalogs");
  ddl_utils::FilePathBlacklist::addToBlacklist(base_path + "/mapd_data");
  ddl_utils::FilePathBlacklist::addToBlacklist(base_path + "/mapd_log");
  g_enable_s3_fsi = false;

  if (disk_cache_level == "foreign_tables") {
    if (g_enable_fsi) {
      disk_cache_config.enabled_level = DiskCacheLevel::fsi;
      LOG(INFO) << "Disk cache enabled for foreign tables only";
    } else {
      LOG(INFO) << "Cannot enable disk cache for fsi when fsi is disabled.  Defaulted to "
                   "disk cache disabled";
    }
#ifdef ENABLE_GENERAL_DISK_CACHE
  } else if (disk_cache_level == "all") {
    disk_cache_config.enabled_level = DiskCacheLevel::all;
    LOG(INFO) << "Disk cache enabled for all tables";
  } else if (disk_cache_level == "local_tables") {
    disk_cache_config.enabled_level = DiskCacheLevel::non_fsi;
    LOG(INFO) << "Disk cache enabled for non-FSI tables";
#endif  // ENABLE_GENERAL_DISK_CACHE
  } else if (disk_cache_level == "none") {
    disk_cache_config.enabled_level = DiskCacheLevel::none;
    LOG(INFO) << "Disk cache disabled";
  } else {
#ifdef ENABLE_GENERAL_DISK_CACHE
    throw std::runtime_error{
        "Unexpected \"disk-cache-level\" value: " + disk_cache_level +
        ". Valid options are 'foreign_tables', "
        "'local_tables', 'none', and 'all'."};
#else
    throw std::runtime_error{
        "Unexpected \"disk-cache-level\" value: " + disk_cache_level +
        ". Valid options are 'foreign_tables' and "
        "'none'."};
#endif  // ENABLE_GENERAL_DISK_CACHE
  }

  if (disk_cache_config.path.empty()) {
    disk_cache_config.path = base_path + "/omnisci_disk_cache";
  }
  ddl_utils::FilePathBlacklist::addToBlacklist(disk_cache_config.path);

  ddl_utils::FilePathBlacklist::addToBlacklist("/etc/passwd");
  ddl_utils::FilePathBlacklist::addToBlacklist("/etc/shadow");

  // If passed in, blacklist all security config files
  addOptionalFileToBlacklist(license_path);
  addOptionalFileToBlacklist(system_parameters.ssl_cert_file);
  addOptionalFileToBlacklist(authMetadata.ca_file_name);
  addOptionalFileToBlacklist(system_parameters.ssl_trust_store);
  addOptionalFileToBlacklist(system_parameters.ssl_keystore);
  addOptionalFileToBlacklist(system_parameters.ssl_key_file);
  addOptionalFileToBlacklist(system_parameters.ssl_trust_ca_file);
  addOptionalFileToBlacklist(cluster_file);
}

Here is the call graph for this function:

Here is the caller graph for this function:

validate_base_path()

void CommandLineOptions::validate_base_path

(

)

Definition at line 714 of file CommandLineOptions.cpp.

Referenced by main().

                                            {
  boost::algorithm::trim_if(base_path, boost::is_any_of("\"'"));
  if (!boost::filesystem::exists(base_path)) {
    throw std::runtime_error("OmniSci base directory does not exist at " + base_path);
  }
}

Here is the caller graph for this function:

Member Data Documentation

allow_loop_joins

bool CommandLineOptions::allow_loop_joins = false

Definition at line 60 of file CommandLineOptions.h.

Referenced by startMapdServer().

allow_multifrag

bool CommandLineOptions::allow_multifrag = true

Definition at line 58 of file CommandLineOptions.h.

Referenced by startMapdServer().

authMetadata

AuthMetadata CommandLineOptions::authMetadata

Definition at line 63 of file CommandLineOptions.h.

Referenced by startMapdServer().

base_path

std::string CommandLineOptions::base_path

Definition at line 48 of file CommandLineOptions.h.

Referenced by startMapdServer().

cluster_file

std::string CommandLineOptions::cluster_file = {"cluster.conf"}

Definition at line 50 of file CommandLineOptions.h.

cluster_topology_file

std::string CommandLineOptions::cluster_topology_file = {"cluster_topology.conf"}

Definition at line 51 of file CommandLineOptions.h.

clusterIds_arg

std::string CommandLineOptions::clusterIds_arg

Definition at line 134 of file CommandLineOptions.h.

compressor

std::string CommandLineOptions::compressor = std::string(BLOSC_LZ4HC_COMPNAME)

Definition at line 123 of file CommandLineOptions.h.

cpu_only

bool CommandLineOptions::cpu_only = false

Definition at line 54 of file CommandLineOptions.h.

Referenced by startMapdServer().

db_leaves

std::vector<LeafHostInfo> CommandLineOptions::db_leaves

Definition at line 131 of file CommandLineOptions.h.

Referenced by startMapdServer().

db_query_file

std::string CommandLineOptions::db_query_file = {""}

path to file containing warmup queries list

Definition at line 98 of file CommandLineOptions.h.

Referenced by startMapdServer().

developer_desc

po::options_description CommandLineOptions::developer_desc

Definition at line 126 of file CommandLineOptions.h.

disk_cache_config

DiskCacheConfig CommandLineOptions::disk_cache_config

Definition at line 49 of file CommandLineOptions.h.

Referenced by startMapdServer().

disk_cache_level

std::string CommandLineOptions::disk_cache_level = ""

Definition at line 83 of file CommandLineOptions.h.

dist_v5_

const bool CommandLineOptions::dist_v5_

Definition at line 146 of file CommandLineOptions.h.

dynamic_watchdog_time_limit

unsigned CommandLineOptions::dynamic_watchdog_time_limit = 10000

Definition at line 82 of file CommandLineOptions.h.

enable_auto_clear_render_mem

bool CommandLineOptions::enable_auto_clear_render_mem = false

Definition at line 67 of file CommandLineOptions.h.

Referenced by startMapdServer().

enable_dynamic_watchdog

bool CommandLineOptions::enable_dynamic_watchdog = false

Definition at line 77 of file CommandLineOptions.h.

enable_legacy_syntax

bool CommandLineOptions::enable_legacy_syntax = true

Definition at line 61 of file CommandLineOptions.h.

Referenced by startMapdServer().

enable_rendering

bool CommandLineOptions::enable_rendering = false

Definition at line 66 of file CommandLineOptions.h.

Referenced by startMapdServer().

enable_runtime_query_interrupt

bool CommandLineOptions::enable_runtime_query_interrupt = false

Definition at line 78 of file CommandLineOptions.h.

enable_runtime_udf

bool CommandLineOptions::enable_runtime_udf = false

Definition at line 74 of file CommandLineOptions.h.

Referenced by startMapdServer().

enable_watchdog

bool CommandLineOptions::enable_watchdog = true

Definition at line 76 of file CommandLineOptions.h.

encryption_key_store_path

std::string CommandLineOptions::encryption_key_store_path = {}

Definition at line 53 of file CommandLineOptions.h.

exit_after_warmup

bool CommandLineOptions::exit_after_warmup = false

exit after warmup

Definition at line 102 of file CommandLineOptions.h.

Referenced by startMapdServer().

help_desc

po::options_description CommandLineOptions::help_desc

Definition at line 125 of file CommandLineOptions.h.

http_port

int CommandLineOptions::http_port = 6278

Definition at line 46 of file CommandLineOptions.h.

Referenced by startMapdServer().

idle_session_duration

int CommandLineOptions::idle_session_duration = kMinsPerHour

Inactive session tolerance in mins (60 mins)

Definition at line 106 of file CommandLineOptions.h.

Referenced by startMapdServer().

intel_jit_profile

bool CommandLineOptions::intel_jit_profile = false

Definition at line 57 of file CommandLineOptions.h.

Referenced by startMapdServer().

jit_debug

bool CommandLineOptions::jit_debug = false

Definition at line 56 of file CommandLineOptions.h.

Referenced by startMapdServer().

license_path

std::string CommandLineOptions::license_path = {""}

Definition at line 52 of file CommandLineOptions.h.

log_options_

logger::LogOptions CommandLineOptions::log_options_

Definition at line 127 of file CommandLineOptions.h.

log_user_origin

bool CommandLineOptions::log_user_origin = true

Definition at line 62 of file CommandLineOptions.h.

Referenced by startMapdServer().

max_concurrent_render_sessions

size_t CommandLineOptions::max_concurrent_render_sessions = 500

Definition at line 70 of file CommandLineOptions.h.

Referenced by startMapdServer().

max_session_duration

int CommandLineOptions::max_session_duration = kMinsPerMonth

Maximum session life in mins (43,200 mins == 30 Days) (https://pages.nist.gov/800-63-3/sp800-63b.html#aal3reauth)

Definition at line 111 of file CommandLineOptions.h.

Referenced by startMapdServer().

nodeIds_token

const std::string CommandLineOptions::nodeIds_token = {"node_id"}

static

Definition at line 138 of file CommandLineOptions.h.

num_gpus

int CommandLineOptions::num_gpus = -1

Can be used to override the number of gpus detected on the system -1 means do not override

Definition at line 89 of file CommandLineOptions.h.

Referenced by startMapdServer().

num_reader_threads

size_t CommandLineOptions::num_reader_threads = 0

Number of threads used when loading data

Definition at line 94 of file CommandLineOptions.h.

Referenced by startMapdServer().

pending_query_interrupt_freq

unsigned CommandLineOptions::pending_query_interrupt_freq = 1000

Definition at line 81 of file CommandLineOptions.h.

positional_options

po::positional_options_description CommandLineOptions::positional_options

Definition at line 128 of file CommandLineOptions.h.

read_only

bool CommandLineOptions::read_only = false

Definition at line 59 of file CommandLineOptions.h.

Referenced by startMapdServer().

render_compositor_use_last_gpu

bool CommandLineOptions::render_compositor_use_last_gpu = true

Definition at line 71 of file CommandLineOptions.h.

Referenced by startMapdServer().

render_mem_bytes

size_t CommandLineOptions::render_mem_bytes = 1000000000

Definition at line 69 of file CommandLineOptions.h.

Referenced by startMapdServer().

render_oom_retry_threshold

int CommandLineOptions::render_oom_retry_threshold = 0

Definition at line 68 of file CommandLineOptions.h.

Referenced by startMapdServer().

renderer_use_vulkan_driver

bool CommandLineOptions::renderer_use_vulkan_driver = false

Definition at line 72 of file CommandLineOptions.h.

Referenced by startMapdServer().

reserved_gpu_mem

size_t CommandLineOptions::reserved_gpu_mem = 384 * 1024 * 1024

Definition at line 47 of file CommandLineOptions.h.

Referenced by startMapdServer().

running_query_interrupt_freq

double CommandLineOptions::running_query_interrupt_freq = 0.5

Definition at line 80 of file CommandLineOptions.h.

start_gpu

int CommandLineOptions::start_gpu = 0

Definition at line 90 of file CommandLineOptions.h.

Referenced by startMapdServer().

string_leaves

std::vector<LeafHostInfo> CommandLineOptions::string_leaves

Definition at line 132 of file CommandLineOptions.h.

Referenced by startMapdServer().

system_parameters

SystemParameters CommandLineOptions::system_parameters

Definition at line 65 of file CommandLineOptions.h.

Referenced by startMapdServer().

udf_compiler_options

std::vector<std::string> CommandLineOptions::udf_compiler_options

Definition at line 114 of file CommandLineOptions.h.

Referenced by startMapdServer().

udf_compiler_path

std::string CommandLineOptions::udf_compiler_path = {""}

Definition at line 113 of file CommandLineOptions.h.

Referenced by startMapdServer().

udf_file_name

std::string CommandLineOptions::udf_file_name = {""}

Definition at line 112 of file CommandLineOptions.h.

Referenced by startMapdServer().

use_estimator_result_cache

bool CommandLineOptions::use_estimator_result_cache = true

Definition at line 79 of file CommandLineOptions.h.

verbose_logging

bool CommandLineOptions::verbose_logging = false

Definition at line 55 of file CommandLineOptions.h.

vm

po::variables_map CommandLineOptions::vm

Definition at line 133 of file CommandLineOptions.h.

---

The documentation for this class was generated from the following files:

• /home/jenkins-slave/workspace/core-os-doxygen/ThriftHandler/CommandLineOptions.h
• /home/jenkins-slave/workspace/core-os-doxygen/ThriftHandler/CommandLineOptions.cpp