OmniSciDB  2e3a973ef4
CommandLineOptions.h
Go to the documentation of this file.
1 /*
2  * Copyright 2020 OmniSci, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #pragma once
18 
19 #include <blosc.h>
20 #include <cstddef>
21 
22 #include <boost/algorithm/string.hpp>
23 #include <boost/algorithm/string/trim.hpp>
24 #include <boost/filesystem.hpp>
25 #include <boost/locale/generator.hpp>
26 #include <boost/make_shared.hpp>
27 #include <boost/program_options.hpp>
28 
29 #include "Catalog/AuthMetadata.h"
34 
35 namespace po = boost::program_options;
36 
37 class LeafHostInfo;
38 
40  public:
41  CommandLineOptions(char const* argv0, bool dist_v5_ = false)
42  : log_options_(argv0), dist_v5_(dist_v5_) {
43  fillOptions();
45  }
46  int http_port = 6278;
47  size_t reserved_gpu_mem = 384 * 1024 * 1024;
48  std::string base_path;
50  std::string cluster_file = {"cluster.conf"};
51  std::string cluster_topology_file = {"cluster_topology.conf"};
52  std::string license_path = {""};
53  std::string encryption_key_store_path = {};
54  bool cpu_only = false;
55  bool verbose_logging = false;
56  bool jit_debug = false;
57  bool intel_jit_profile = false;
58  bool allow_multifrag = true;
59  bool read_only = false;
60  bool allow_loop_joins = false;
61  bool enable_legacy_syntax = true;
62  bool log_user_origin = true;
64 
66  bool enable_rendering = false;
68  int render_oom_retry_threshold = 0; // in milliseconds
69  size_t render_mem_bytes = 1000000000;
73 
74  bool enable_runtime_udf = false;
75 
76  bool enable_watchdog = true;
80  unsigned runtime_query_interrupt_frequency = 1000; // in milliseconds
81  unsigned dynamic_watchdog_time_limit = 10000;
82  std::string disk_cache_level = "";
83 
88  int num_gpus = -1;
89  int start_gpu = 0;
93  size_t num_reader_threads = 0;
97  std::string db_query_file = {""};
101  bool exit_after_warmup = false;
111  std::string udf_file_name = {""};
112  std::string udf_compiler_path = {""};
113  std::vector<std::string> udf_compiler_options;
114 
115 #ifdef ENABLE_GEOS
116  std::string libgeos_so_filename = {"libgeos_c.so"};
117 #endif
118 
119  void fillOptions();
120  void fillAdvancedOptions();
121 
122  std::string compressor = std::string(BLOSC_LZ4HC_COMPNAME);
123 
124  po::options_description help_desc;
125  po::options_description developer_desc;
127  po::positional_options_description positional_options;
128 
129  public:
130  std::vector<LeafHostInfo> db_leaves;
131  std::vector<LeafHostInfo> string_leaves;
132  po::variables_map vm;
133  std::string clusterIds_arg;
134 
135  std::string getNodeIds();
136  std::vector<std::string> getNodeIdsArray();
137  static const std::string nodeIds_token;
138 
139  boost::optional<int> parse_command_line(int argc,
140  char const* const* argv,
141  const bool should_init_logging = false);
142  void validate();
143  void validate_base_path();
144  void init_logging();
145  const bool dist_v5_;
146 };
147 
148 extern bool g_enable_watchdog;
149 extern bool g_enable_dynamic_watchdog;
150 extern unsigned g_dynamic_watchdog_time_limit;
151 extern unsigned g_trivial_loop_join_threshold;
152 extern bool g_from_table_reordering;
153 extern bool g_enable_filter_push_down;
154 extern bool g_allow_cpu_retry;
155 extern bool g_null_div_by_zero;
156 extern bool g_bigint_count;
158 extern float g_filter_push_down_low_frac;
159 extern float g_filter_push_down_high_frac;
161 extern bool g_enable_columnar_output;
162 extern bool g_enable_overlaps_hashjoin;
164 extern size_t g_overlaps_max_table_size_bytes;
165 extern bool g_strip_join_covered_quals;
166 extern size_t g_constrained_by_in_threshold;
167 extern size_t g_big_group_threshold;
168 extern bool g_enable_window_functions;
169 extern bool g_enable_table_functions;
170 extern size_t g_max_memory_allocation_size;
171 extern double g_bump_allocator_step_reduction;
175 extern size_t g_gpu_smem_threshold;
178 extern bool g_use_estimator_result_cache;
179 
180 extern int64_t g_omni_kafka_seek;
181 extern size_t g_leaf_count;
182 extern size_t g_compression_limit_bytes;
183 extern bool g_skip_intermediate_count;
184 extern bool g_enable_bump_allocator;
186 extern size_t g_min_memory_allocation_size;
189 extern bool g_enable_fsi;
190 extern bool g_enable_interop;
191 extern bool g_enable_union;
192 extern bool g_use_tbb_pool;
193 extern bool g_enable_filter_function;
bool g_enable_runtime_query_interrupt
Definition: Execute.cpp:108
CommandLineOptions(char const *argv0, bool dist_v5_=false)
bool g_enable_filter_push_down
Definition: Execute.cpp:87
size_t g_constrained_by_in_threshold
Definition: Execute.cpp:96
float g_filter_push_down_high_frac
Definition: Execute.cpp:89
size_t g_gpu_smem_threshold
Definition: Execute.cpp:111
logger::LogOptions log_options_
bool g_enable_watchdog
Definition: Execute.cpp:74
bool g_enable_table_functions
unsigned runtime_query_interrupt_frequency
std::vector< LeafHostInfo > string_leaves
size_t g_leaf_count
Definition: ParserNode.cpp:68
std::string udf_compiler_path
po::options_description help_desc
bool g_strip_join_covered_quals
Definition: Execute.cpp:95
DiskCacheConfig disk_cache_config
bool g_from_table_reordering
Definition: Execute.cpp:82
bool g_enable_bump_allocator
Definition: Execute.cpp:104
bool g_enable_hashjoin_many_to_many
Definition: Execute.cpp:93
bool g_use_estimator_result_cache
Definition: Execute.cpp:109
static constexpr int64_t kMinsPerHour
bool g_null_div_by_zero
Definition: Execute.cpp:80
size_t g_compression_limit_bytes
Definition: Compressor.cpp:36
boost::optional< int > parse_command_line(int argc, char const *const *argv, const bool should_init_logging=false)
bool g_enable_direct_columnarization
Definition: Execute.cpp:106
bool g_enable_fsi
Definition: Catalog.cpp:91
std::string encryption_key_store_path
size_t g_filter_push_down_passing_row_ubound
Definition: Execute.cpp:90
bool g_enable_smem_grouped_non_count_agg
Definition: Execute.cpp:116
bool g_skip_intermediate_count
static constexpr int64_t kMinsPerMonth
bool g_enable_overlaps_hashjoin
Definition: Execute.cpp:92
bool g_enable_smem_non_grouped_agg
Definition: Execute.cpp:119
size_t max_concurrent_render_sessions
bool g_use_tbb_pool
Definition: Execute.cpp:76
std::string getNodeIds()
unsigned g_dynamic_watchdog_time_limit
Definition: Execute.cpp:78
bool g_bigint_count
std::vector< LeafHostInfo > db_leaves
std::vector< std::string > getNodeIdsArray()
size_t g_max_memory_allocation_size
size_t g_overlaps_max_table_size_bytes
Definition: Execute.cpp:94
bool g_allow_cpu_retry
Definition: Execute.cpp:79
bool g_enable_interop
AuthMetadata authMetadata
bool g_enable_union
size_t g_big_group_threshold
Definition: Execute.cpp:97
bool g_enable_filter_function
Definition: Execute.cpp:77
bool g_inner_join_fragment_skipping
Definition: Execute.cpp:83
std::vector< std::string > udf_compiler_options
static const std::string nodeIds_token
bool g_enable_experimental_string_functions
size_t g_min_memory_allocation_size
Definition: Execute.cpp:101
int64_t g_omni_kafka_seek
bool g_enable_dynamic_watchdog
Definition: Execute.cpp:75
po::positional_options_description positional_options
Functions used to work with HyperLogLog records.
po::options_description developer_desc
std::string disk_cache_level
po::variables_map vm
unsigned g_trivial_loop_join_threshold
Definition: Execute.cpp:81
float g_filter_push_down_low_frac
Definition: Execute.cpp:88
bool g_enable_window_functions
Definition: Execute.cpp:98
double g_bump_allocator_step_reduction
Definition: Execute.cpp:105
unsigned g_runtime_query_interrupt_frequency
Definition: Execute.cpp:110
std::string cluster_topology_file
bool g_enable_columnar_output
Definition: Execute.cpp:91
unsigned dynamic_watchdog_time_limit
SystemParameters system_parameters