cpp/src/gandiva/compiled_expr.h

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

#ifndef GANDIVA_COMPILED_EXPR_H
#define GANDIVA_COMPILED_EXPR_H

#include <vector>
#include "gandiva/llvm_includes.h"
#include "gandiva/selection_vector.h"
#include "gandiva/value_validity_pair.h"

namespace gandiva {

using EvalFunc = int (*)(uint8_t** buffers, uint8_t** local_bitmaps,
                         const uint8_t* selection_buffer, int64_t execution_ctx_ptr,
                         int64_t record_count);

/// \brief Tracks the compiled state for one expression.
class CompiledExpr {
 public:
  CompiledExpr(ValueValidityPairPtr value_validity, FieldDescriptorPtr output)
      : value_validity_(value_validity), output_(output) {}

  ValueValidityPairPtr value_validity() const { return value_validity_; }

  FieldDescriptorPtr output() const { return output_; }

  void SetIRFunction(SelectionVector::Mode mode, llvm::Function* ir_function) {
    ir_functions_[static_cast<int>(mode)] = ir_function;
  }

  llvm::Function* GetIRFunction(SelectionVector::Mode mode) const {
    return ir_functions_[static_cast<int>(mode)];
  }

  void SetJITFunction(SelectionVector::Mode mode, EvalFunc jit_function) {
    jit_functions_[static_cast<int>(mode)] = jit_function;
  }

  EvalFunc GetJITFunction(SelectionVector::Mode mode) const {
    return jit_functions_[static_cast<int>(mode)];
  }

 private:
  // value & validities for the expression tree (root)
  ValueValidityPairPtr value_validity_;

  // output field
  FieldDescriptorPtr output_;

  // IR functions for various modes in the generated code
  std::array<llvm::Function*, SelectionVector::kNumModes> ir_functions_;

  // JIT functions in the generated code (set after the module is optimised and finalized)
  std::array<EvalFunc, SelectionVector::kNumModes> jit_functions_;
};

}  // namespace gandiva

#endif  // GANDIVA_COMPILED_EXPR_H