cpp/src/gandiva/gdv_function_stubs.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.

#pragma once

#include <cstdint>

#include "gandiva/visibility.h"

/// Stub functions that can be accessed from LLVM.
extern "C" {

using gdv_boolean = bool;
using gdv_int8 = int8_t;
using gdv_int16 = int16_t;
using gdv_int32 = int32_t;
using gdv_int64 = int64_t;
using gdv_uint8 = uint8_t;
using gdv_uint16 = uint16_t;
using gdv_uint32 = uint32_t;
using gdv_uint64 = uint64_t;
using gdv_float32 = float;
using gdv_float64 = double;
using gdv_date64 = int64_t;
using gdv_date32 = int32_t;
using gdv_time32 = int32_t;
using gdv_timestamp = int64_t;
using gdv_utf8 = char*;
using gdv_binary = char*;
using gdv_day_time_interval = int64_t;
using gdv_month_interval = int32_t;

#ifdef GANDIVA_UNIT_TEST
// unit tests may be compiled without O2, so inlining may not happen.
#  define GDV_FORCE_INLINE
#else
#  ifdef _MSC_VER
#    define GDV_FORCE_INLINE __forceinline
#  else
#    define GDV_FORCE_INLINE inline __attribute__((always_inline))
#  endif
#endif

GANDIVA_EXPORT
int64_t gdv_fn_crc_32_utf8(int64_t ctx, const char* input, int32_t input_len);

bool gdv_fn_like_utf8_utf8(int64_t ptr, const char* data, int data_len,
                           const char* pattern, int pattern_len);

bool gdv_fn_like_utf8_utf8_utf8(int64_t ptr, const char* data, int data_len,
                                const char* pattern, int pattern_len,
                                const char* escape_char, int escape_char_len);

bool gdv_fn_ilike_utf8_utf8(int64_t ptr, const char* data, int data_len,
                            const char* pattern, int pattern_len);

int64_t gdv_fn_to_date_utf8_utf8_int32(int64_t context, int64_t ptr, const char* data,
                                       int data_len, bool in1_validity,
                                       const char* pattern, int pattern_len,
                                       bool in2_validity, int32_t suppress_errors,
                                       bool in3_validity, bool* out_valid);

GANDIVA_EXPORT
void gdv_fn_context_set_error_msg(int64_t context_ptr, const char* err_msg);

GANDIVA_EXPORT
uint8_t* gdv_fn_context_arena_malloc(int64_t context_ptr, int32_t data_len);

void gdv_fn_context_arena_reset(int64_t context_ptr);

bool in_expr_lookup_int32(int64_t ptr, int32_t value, bool in_validity);

bool in_expr_lookup_int64(int64_t ptr, int64_t value, bool in_validity);

bool in_expr_lookup_utf8(int64_t ptr, const char* data, int data_len, bool in_validity);

int gdv_fn_time_with_zone(int* time_fields, const char* zone, int zone_len,
                          int64_t* ret_time);

GANDIVA_EXPORT
const char* gdv_fn_base64_encode_binary(int64_t context, const char* in, int32_t in_len,
                                        int32_t* out_len);

GANDIVA_EXPORT
const char* gdv_fn_base64_decode_utf8(int64_t context, const char* in, int32_t in_len,
                                      int32_t* out_len);

GANDIVA_EXPORT
const char* gdv_fn_castVARBINARY_int32_int64(int64_t context, gdv_int32 value,
                                             int64_t out_len, int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_castVARBINARY_int64_int64(int64_t context, gdv_int64 value,
                                             int64_t out_len, int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha512_decimal128(int64_t context, int64_t x_high, uint64_t x_low,
                                     int32_t x_precision, int32_t x_scale,
                                     gdv_boolean x_isvalid, int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha256_decimal128(int64_t context, int64_t x_high, uint64_t x_low,
                                     int32_t x_precision, int32_t x_scale,
                                     gdv_boolean x_isvalid, int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_md5_decimal128(int64_t context, int64_t x_high, uint64_t x_low,
                                  int32_t x_precision, int32_t x_scale,
                                  gdv_boolean x_isvalid, int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha1_decimal128(int64_t context, int64_t x_high, uint64_t x_low,
                                   int32_t x_precision, int32_t x_scale,
                                   gdv_boolean x_isvalid, int32_t* out_length);

int32_t gdv_fn_dec_from_string(int64_t context, const char* in, int32_t in_length,
                               int32_t* precision_from_str, int32_t* scale_from_str,
                               int64_t* dec_high_from_str, uint64_t* dec_low_from_str);

char* gdv_fn_dec_to_string(int64_t context, int64_t x_high, uint64_t x_low,
                           int32_t x_scale, int32_t* dec_str_len);

GANDIVA_EXPORT
int32_t gdv_fn_castINT_utf8(int64_t context, const char* data, int32_t data_len);

GANDIVA_EXPORT
int64_t gdv_fn_castBIGINT_utf8(int64_t context, const char* data, int32_t data_len);

GANDIVA_EXPORT
float gdv_fn_castFLOAT4_utf8(int64_t context, const char* data, int32_t data_len);

GANDIVA_EXPORT
double gdv_fn_castFLOAT8_utf8(int64_t context, const char* data, int32_t data_len);

GANDIVA_EXPORT
const char* gdv_fn_castVARCHAR_int32_int64(int64_t context, int32_t value, int64_t len,
                                           int32_t* out_len);
GANDIVA_EXPORT
const char* gdv_fn_castVARCHAR_date64_int64(int64_t context, gdv_date64 value,
                                            int64_t len, int32_t* out_len);
GANDIVA_EXPORT
const char* gdv_fn_castVARCHAR_int64_int64(int64_t context, int64_t value, int64_t len,
                                           int32_t* out_len);
GANDIVA_EXPORT
const char* gdv_fn_castVARCHAR_float32_int64(int64_t context, float value, int64_t len,
                                             int32_t* out_len);
GANDIVA_EXPORT
const char* gdv_fn_castVARCHAR_float64_int64(int64_t context, double value, int64_t len,
                                             int32_t* out_len);

GANDIVA_EXPORT
int32_t gdv_fn_utf8_char_length(char c);

GANDIVA_EXPORT
const char* gdv_fn_upper_utf8(int64_t context, const char* data, int32_t data_len,
                              int32_t* out_len);

GANDIVA_EXPORT
const char* gdv_fn_lower_utf8(int64_t context, const char* data, int32_t data_len,
                              int32_t* out_len);

GANDIVA_EXPORT
const char* gdv_fn_initcap_utf8(int64_t context, const char* data, int32_t data_len,
                                int32_t* out_len);

GANDIVA_EXPORT
int32_t gdv_fn_castINT_varbinary(gdv_int64 context, const char* in, int32_t in_len);

GANDIVA_EXPORT
int64_t gdv_fn_castBIGINT_varbinary(gdv_int64 context, const char* in, int32_t in_len);

GANDIVA_EXPORT
float gdv_fn_castFLOAT4_varbinary(gdv_int64 context, const char* in, int32_t in_len);

GANDIVA_EXPORT
double gdv_fn_castFLOAT8_varbinary(gdv_int64 context, const char* in, int32_t in_len);

GANDIVA_EXPORT
const char* gdv_fn_aes_encrypt(int64_t context, const char* data, int32_t data_len,
                               const char* key_data, int32_t key_data_len,
                               int32_t* out_len);
GANDIVA_EXPORT
const char* gdv_fn_aes_decrypt(int64_t context, const char* data, int32_t data_len,
                               const char* key_data, int32_t key_data_len,
                               int32_t* out_len);

GANDIVA_EXPORT
const char* gdv_mask_first_n_utf8_int32(int64_t context, const char* data,
                                        int32_t data_len, int32_t n_to_mask,
                                        int32_t* out_len);

GANDIVA_EXPORT
const char* gdv_mask_last_n_utf8_int32(int64_t context, const char* data,
                                       int32_t data_len, int32_t n_to_mask,
                                       int32_t* out_len);

GANDIVA_EXPORT
const char* gdv_fn_sha512_int8(int64_t context, gdv_int8 value, bool validity,
                               int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha512_int16(int64_t context, gdv_int16 value, bool validity,
                                int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha512_int32(int64_t context, gdv_int32 value, bool validity,
                                int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha512_int64(int64_t context, gdv_int64 value, bool validity,
                                int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha512_uint8(int64_t context, gdv_uint8 value, bool validity,
                                int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha512_uint16(int64_t context, gdv_uint16 value, bool validity,
                                 int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha512_uint32(int64_t context, gdv_uint32 value, bool validity,
                                 int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha512_uint64(int64_t context, gdv_uint64 value, bool validity,
                                 int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha512_float32(int64_t context, gdv_float32 value, bool validity,
                                  int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha512_float64(int64_t context, gdv_float64 value, bool validity,
                                  int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha512_boolean(int64_t context, gdv_boolean value, bool validity,
                                  int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha512_date64(int64_t context, gdv_date64 value, bool validity,
                                 int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha512_date32(int64_t context, gdv_date32 value, bool validity,
                                 int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha512_time32(int64_t context, gdv_time32 value, bool validity,
                                 int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha512_timestamp(int64_t context, gdv_timestamp value, bool validity,
                                    int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha512_utf8(int64_t context, gdv_utf8 value, int32_t value_length,
                               bool value_validity, int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha256_int8(int64_t context, gdv_int8 value, bool validity,
                               int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha256_int16(int64_t context, gdv_int16 value, bool validity,
                                int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha256_int32(int64_t context, gdv_int32 value, bool validity,
                                int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha256_int64(int64_t context, gdv_int64 value, bool validity,
                                int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha256_uint8(int64_t context, gdv_uint8 value, bool validity,
                                int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha256_uint16(int64_t context, gdv_uint16 value, bool validity,
                                 int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha256_uint32(int64_t context, gdv_uint32 value, bool validity,
                                 int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha256_uint64(int64_t context, gdv_uint64 value, bool validity,
                                 int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha256_float32(int64_t context, gdv_float32 value, bool validity,
                                  int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha256_float64(int64_t context, gdv_float64 value, bool validity,
                                  int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha256_boolean(int64_t context, gdv_boolean value, bool validity,
                                  int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha256_date64(int64_t context, gdv_date64 value, bool validity,
                                 int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha256_date32(int64_t context, gdv_date32 value, bool validity,
                                 int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha256_time32(int64_t context, gdv_time32 value, bool validity,
                                 int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha256_timestamp(int64_t context, gdv_timestamp value, bool validity,
                                    int32_t* out_length);

GANDIVA_EXPORT
const char* gdv_fn_sha256_utf8(int64_t context, gdv_utf8 value, int32_t value_length,
                               bool value_validity, int32_t* out_length);

GANDIVA_EXPORT
const char* translate_utf8_utf8_utf8(int64_t context, const char* in, int32_t in_len,
                                     const char* from, int32_t from_len, const char* to,
                                     int32_t to_len, int32_t* out_len);

GANDIVA_EXPORT
gdv_timestamp to_utc_timezone_timestamp(int64_t context, gdv_timestamp time_milliseconds,
                                        const char* timezone, int32_t length);

GANDIVA_EXPORT
gdv_timestamp from_utc_timezone_timestamp(int64_t context,
                                          gdv_timestamp time_milliseconds,
                                          const char* timezone, int32_t length);

GANDIVA_EXPORT
const char* gdv_mask_show_first_n_utf8_int32(int64_t context, const char* data,
                                             int32_t data_len, int32_t n_to_show,
                                             int32_t* out_len);

GANDIVA_EXPORT
const char* gdv_mask_show_last_n_utf8_int32(int64_t context, const char* data,
                                            int32_t data_len, int32_t n_to_show,
                                            int32_t* out_len);

GANDIVA_EXPORT
const char* gdv_fn_substring_index(int64_t context, const char* txt, int32_t txt_len,
                                   const char* pat, int32_t pat_len, int32_t cnt,
                                   int32_t* out_len);

GANDIVA_EXPORT
const char* mask_utf8_utf8_utf8_utf8(int64_t context, const char* in, int32_t length,
                                     const char* upper, int32_t upper_length,
                                     const char* lower, int32_t lower_length,
                                     const char* num, int32_t num_length,
                                     int32_t* out_len);

GANDIVA_EXPORT
const char* mask_utf8_utf8_utf8(int64_t context, const char* in, int32_t length,
                                const char* upper, int32_t upper_length,
                                const char* lower, int32_t lower_length,
                                int32_t* out_len);

GANDIVA_EXPORT
const char* mask_utf8_utf8(int64_t context, const char* in, int32_t length,
                           const char* upper, int32_t upper_length, int32_t* out_len);

GANDIVA_EXPORT
const char* mask_utf8(int64_t context, const char* in, int32_t length, int32_t* out_len);
}