CompilationOptions.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.
 */

#ifndef QUERYENGINE_COMPILATIONOPTIONS_H
#define QUERYENGINE_COMPILATIONOPTIONS_H

#include <vector>
#ifndef __CUDACC__
#include <ostream>
#endif

enum class ExecutorDeviceType { CPU = 0, GPU };
#ifndef __CUDACC__
inline std::ostream& operator<<(std::ostream& os, ExecutorDeviceType const dt) {
  constexpr char const* strings[]{"CPU", "GPU"};
  return os << strings[static_cast<int>(dt)];
}

inline std::string toString(const ExecutorDeviceType& device_type) {
  return (device_type == ExecutorDeviceType::CPU) ? "CPU" : "GPU";
}
#endif

enum class ExecutorOptLevel { Default, ReductionJIT };

enum class ExecutorExplainType { Default, Optimized };

enum class ExecutorDispatchMode { KernelPerFragment, MultifragmentKernel };

struct CompilationOptions {
  ExecutorDeviceType device_type;
  bool hoist_literals;
  ExecutorOptLevel opt_level;
  bool with_dynamic_watchdog;
  bool allow_lazy_fetch;
  bool filter_on_deleted_column{true};  // if false, ignore the delete column during table
                                        // scans. Primarily disabled for delete queries.
  ExecutorExplainType explain_type{ExecutorExplainType::Default};
  bool register_intel_jit_listener{false};

  static CompilationOptions makeCpuOnly(const CompilationOptions& in) {
    return CompilationOptions{ExecutorDeviceType::CPU,
                              in.hoist_literals,
                              in.opt_level,
                              in.with_dynamic_watchdog,
                              in.allow_lazy_fetch,
                              in.filter_on_deleted_column,
                              in.explain_type,
                              in.register_intel_jit_listener};
  }

  static CompilationOptions defaults(
      const ExecutorDeviceType device_type = ExecutorDeviceType::GPU) {
    return CompilationOptions{device_type,
                              /*hoist_literals=*/true,
                              /*opt_level=*/ExecutorOptLevel::Default,
                              /*with_dynamic_watchdog=*/false,
                              /*allow_lazy_fetch=*/true,
                              /*filter_on_delted_column=*/true,
                              /*explain_type=*/ExecutorExplainType::Default,
                              /*register_intel_jit_listener=*/false};
  }
};

enum class ExecutorType { Native, Extern, TableFunctions };

struct ExecutionOptions {
  bool output_columnar_hint;
  bool keep_result;
  bool allow_multifrag;
  bool just_explain;  // return the generated IR for the first step
  bool allow_loop_joins;
  bool with_watchdog;  // Per work unit, not global.
  bool jit_debug;
  bool just_validate;
  bool with_dynamic_watchdog;            // Per work unit, not global.
  unsigned dynamic_watchdog_time_limit;  // Dynamic watchdog time limit, in milliseconds.
  bool find_push_down_candidates;
  bool just_calcite_explain;
  double gpu_input_mem_limit_percent;  // punt to CPU if input memory exceeds this
  bool allow_runtime_query_interrupt;
  double running_query_interrupt_freq;
  unsigned pending_query_interrupt_freq;
  bool optimize_cuda_block_and_grid_sizes;
  size_t max_join_hash_table_size = std::numeric_limits<size_t>::max();
  ExecutorType executor_type = ExecutorType::Native;
  std::vector<size_t> outer_fragment_indices{};

  static ExecutionOptions defaults() {
    return ExecutionOptions{/*output_columnar_hint=*/false,
                            /*keep_result=*/false,
                            /*allow_multifrag=*/true,
                            /*just_explain=*/false,
                            /*allow_loop_joins=*/false,
                            /*with_watchdog=*/true,
                            /*jit_debug=*/false,
                            /*just_validate=*/false,
                            /*with_dynamic_watchdog=*/false,
                            /*dynamic_watchdog_time_limit=*/0,
                            /*find_push_down_candidates=*/false,
                            /*just_calcite_explain=*/false,
                            /*=gpu_input_mem_limit_percent=*/1.0,
                            /*allow_runtime_query_interrupt=*/false,
                            /*running_query_interrupt_freq=*/0.5,
                            /*pending_query_interrupt_freq=*/1000,
                            /*optimize_cuda_block_and_grid_sizes*/ false};
  }
  void setNoExplainExecutionOptions(bool no_validation = false) {
    just_explain = false;
    just_calcite_explain = false;
    if (no_validation) {
      just_validate = false;
    }
  }
};

#endif  // QUERYENGINE_COMPILATIONOPTIONS_H