SystemParameters.h

Go to the documentation of this file.

/*
 * Copyright 2022 HEAVY.AI, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include <string>

struct SystemParameters {
  bool cpu_only = false;       // cpu-only execution
  int num_gpus = -1;           // number of gpus to use
  int start_gpu = 0;           // first gpu to use
  size_t cuda_block_size = 0;  // block size for the kernel execution
  size_t cuda_grid_size = 0;   // grid size multiplier (by # SMs) for the kernel execution
  size_t calcite_max_mem = 1024;    // max memory for calcite jvm in MB
  int omnisci_server_port = 6274;   // default port heavydb runs on
  int calcite_port = 6279;          // default port for calcite server to run on
  std::string ha_group_id;          // name of the HA group this server is in
  std::string ha_unique_server_id;  // name of the HA unique id for this server
  std::string ha_brokers;           // name of the HA broker
  std::string ha_shared_data;       // name of shared data directory base
  std::string master_address;       // address the RW master node is located
  int master_port = 6274;           // port the RW master node is listening on
  bool is_decr_start_epoch;         // are we doing a start epoch decrement?
  size_t cpu_buffer_mem_bytes = 0;  // max size of memory reserved for CPU buffers [bytes]
  size_t gpu_buffer_mem_bytes = 0;  // max size of memory reserved for GPU buffers [bytes]
  // min size of CPU buffer pool memory allocations [bytes], default=256MB
  size_t min_cpu_slab_size = size_t(1) << 28;
  // min size of GPU buffer pool memory allocations [bytes], default=256MB
  size_t min_gpu_slab_size = size_t(1) << 28;
  // max size of CPU buffer pool memory allocations [bytes], default=4GB
  size_t max_cpu_slab_size = size_t(1) << 32;
  // max size of GPU buffer pool memory allocations [bytes], default=4GB
  size_t max_gpu_slab_size = size_t(1) << 32;
  double gpu_input_mem_limit = 0.9;  // Punt query to CPU if input mem exceeds % GPU mem
  std::string config_file = "";
  std::string ssl_cert_file = "";    // file path to server's certified PKI certificate
  std::string ssl_key_file = "";     // file path to server's' private PKI key
  std::string ssl_trust_store = "";  // file path to java jks version of ssl_key_fle
  std::string ssl_trust_password = "";
  std::string ssl_keystore = "";
  std::string ssl_keystore_password = "";  // pass phrae for java jks trust store.
  std::string ssl_trust_ca_file = "";
  bool ssl_transport_client_auth = false;
  bool aggregator = false;
  bool enable_calcite_view_optimize =
      true;  // allow calcite to optimize the relalgebra for a view query
  size_t calcite_timeout = 5000;     // calcite connect/send/receive timeout
  size_t calcite_keepalive = false;  // calcite keepalive connection
  int num_executors = 4;
  int num_sessions = -1;  // maximum number of user sessions
  size_t buffer_page_size = 512;
  enum class RuntimeUdfRegistrationPolicy {
    DISALLOWED,
    ALLOWED_SUPERUSERS_ONLY,
    ALLOWED_ALL_USERS
  };
  RuntimeUdfRegistrationPolicy runtime_udf_registration_policy =
      RuntimeUdfRegistrationPolicy::DISALLOWED;

  SystemParameters() : cuda_block_size(0), cuda_grid_size(0), calcite_max_mem(1024) {}
};