import quincy 17.2.0

[ceph.git] / ceph / src / arrow / cpp / src / gandiva / engine.h

diff --git a/ceph/src/arrow/cpp/src/gandiva/engine.h b/ceph/src/arrow/cpp/src/gandiva/engine.h
new file mode 100644 (file)
index 0000000..d26b8aa
--- /dev/null
+++ b/ceph/src/arrow/cpp/src/gandiva/engine.h
@@ -0,0 +1,104 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you 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 <memory>
+#include <set>
+#include <string>
+#include <vector>
+
+#include "arrow/util/macros.h"
+
+#include "arrow/util/logging.h"
+#include "gandiva/configuration.h"
+#include "gandiva/llvm_includes.h"
+#include "gandiva/llvm_types.h"
+#include "gandiva/visibility.h"
+
+namespace gandiva {
+
+/// \brief LLVM Execution engine wrapper.
+class GANDIVA_EXPORT Engine {
+ public:
+  llvm::LLVMContext* context() { return context_.get(); }
+  llvm::IRBuilder<>* ir_builder() { return ir_builder_.get(); }
+  LLVMTypes* types() { return &types_; }
+  llvm::Module* module() { return module_; }
+
+  /// Factory method to create and initialize the engine object.
+  ///
+  /// \param[in] config the engine configuration
+  /// \param[out] engine the created engine
+  static Status Make(const std::shared_ptr<Configuration>& config,
+                     std::unique_ptr<Engine>* engine);
+
+  /// Add the function to the list of IR functions that need to be compiled.
+  /// Compiling only the functions that are used by the module saves time.
+  void AddFunctionToCompile(const std::string& fname) {
+    DCHECK(!module_finalized_);
+    functions_to_compile_.push_back(fname);
+  }
+
+  /// Optimise and compile the module.
+  Status FinalizeModule();
+
+  /// Get the compiled function corresponding to the irfunction.
+  void* CompiledFunction(llvm::Function* irFunction);
+
+  // Create and add a mapping for the cpp function to make it accessible from LLVM.
+  void AddGlobalMappingForFunc(const std::string& name, llvm::Type* ret_type,
+                               const std::vector<llvm::Type*>& args, void* func);
+
+  /// Return the generated IR for the module.
+  std::string DumpIR();
+
+ private:
+  Engine(const std::shared_ptr<Configuration>& conf,
+         std::unique_ptr<llvm::LLVMContext> ctx,
+         std::unique_ptr<llvm::ExecutionEngine> engine, llvm::Module* module);
+
+  // Post construction init. This _must_ be called after the constructor.
+  Status Init();
+
+  static void InitOnce();
+
+  llvm::ExecutionEngine& execution_engine() { return *execution_engine_; }
+
+  /// load pre-compiled IR modules from precompiled_bitcode.cc and merge them into
+  /// the main module.
+  Status LoadPreCompiledIR();
+
+  // Create and add mappings for cpp functions that can be accessed from LLVM.
+  void AddGlobalMappings();
+
+  // Remove unused functions to reduce compile time.
+  Status RemoveUnusedFunctions();
+
+  std::unique_ptr<llvm::LLVMContext> context_;
+  std::unique_ptr<llvm::ExecutionEngine> execution_engine_;
+  std::unique_ptr<llvm::IRBuilder<>> ir_builder_;
+  llvm::Module* module_;
+  LLVMTypes types_;
+
+  std::vector<std::string> functions_to_compile_;
+
+  bool optimize_ = true;
+  bool module_finalized_ = false;
+};
+
+}  // namespace gandiva