Files
doris/be/src/vec/functions/function_case.h
Adonis Ling e412dd12e8 [chore](build) Use include-what-you-use to optimize includes (PART II) (#18761)
Currently, there are some useless includes in the codebase. We can use a tool named include-what-you-use to optimize these includes. By using a strict include-what-you-use policy, we can get lots of benefits from it.
2023-04-19 23:11:48 +08:00

411 lines
16 KiB
C++

// 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 <string.h>
#include <algorithm>
#include <cstdint>
#include <memory>
#include <optional>
#include <utility>
#include <vector>
#include "common/status.h"
#include "gutil/integral_types.h"
#include "vec/aggregate_functions/aggregate_function.h"
#include "vec/columns/column.h"
#include "vec/columns/column_complex.h"
#include "vec/columns/column_nullable.h"
#include "vec/columns/columns_number.h"
#include "vec/core/block.h"
#include "vec/core/column_numbers.h"
#include "vec/core/column_with_type_and_name.h"
#include "vec/core/types.h"
#include "vec/data_types/data_type.h"
#include "vec/data_types/data_type_nullable.h"
#include "vec/functions/function.h"
#include "vec/utils/template_helpers.hpp"
namespace doris {
class FunctionContext;
namespace vectorized {
class ColumnArray;
class ColumnMap;
class ColumnString;
class ColumnStruct;
} // namespace vectorized
} // namespace doris
namespace doris::vectorized {
template <bool has_case, bool has_else>
struct FunctionCaseName;
template <>
struct FunctionCaseName<false, false> {
static constexpr auto name = "case";
};
template <>
struct FunctionCaseName<true, false> {
static constexpr auto name = "case_has_case";
};
template <>
struct FunctionCaseName<false, true> {
static constexpr auto name = "case_has_else";
};
template <>
struct FunctionCaseName<true, true> {
static constexpr auto name = "case_has_case_has_else";
};
struct CaseWhenColumnHolder {
using OptionalPtr = std::optional<ColumnPtr>;
std::vector<OptionalPtr> when_ptrs; // case, when, when...
std::vector<OptionalPtr> then_ptrs; // else, then, then...
size_t pair_count;
size_t rows_count;
CaseWhenColumnHolder(Block& block, const ColumnNumbers& arguments, size_t input_rows_count,
bool has_case, bool has_else, bool when_null, bool then_null)
: rows_count(input_rows_count) {
when_ptrs.emplace_back(has_case ? OptionalPtr(block.get_by_position(arguments[0]).column)
: std::nullopt);
then_ptrs.emplace_back(
has_else
? OptionalPtr(block.get_by_position(arguments[arguments.size() - 1]).column)
: std::nullopt);
int begin = 0 + has_case;
int end = arguments.size() - has_else;
pair_count = (end - begin) / 2 + 1; // when/then at [1: pair_count)
for (int i = begin; i < end; i += 2) {
when_ptrs.emplace_back(OptionalPtr(block.get_by_position(arguments[i]).column));
then_ptrs.emplace_back(OptionalPtr(block.get_by_position(arguments[i + 1]).column));
}
// if case_column/when_column is nullable. cast all case_column/when_column to nullable.
if (when_null) {
for (OptionalPtr& column_ptr : when_ptrs) {
cast_to_nullable(column_ptr);
}
}
// if else_column/then_column is nullable. cast all else_column/then_column to nullable.
if (then_null) {
for (OptionalPtr& column_ptr : then_ptrs) {
cast_to_nullable(column_ptr);
}
}
}
void cast_to_nullable(OptionalPtr& column_ptr) {
if (!column_ptr.has_value() || column_ptr.value()->is_nullable()) {
return;
}
column_ptr.emplace(make_nullable(column_ptr.value()));
}
};
template <bool has_case, bool has_else>
class FunctionCase : public IFunction {
public:
static constexpr auto name = FunctionCaseName<has_case, has_else>::name;
static FunctionPtr create() { return std::make_shared<FunctionCase>(); }
String get_name() const override { return name; }
size_t get_number_of_arguments() const override { return 0; }
bool is_variadic() const override { return true; }
DataTypePtr get_return_type_impl(const DataTypes& arguments) const override {
int loop_start = has_case ? 2 : 1;
int loop_end = has_else ? arguments.size() - 1 : arguments.size();
bool is_nullable = false;
if (!has_else || arguments[loop_end].get()->is_nullable()) {
is_nullable = true;
}
for (int i = loop_start; !is_nullable && i < loop_end; i += 2) {
if (arguments[i].get()->is_nullable()) {
is_nullable = true;
}
}
if (is_nullable) {
return make_nullable(arguments[loop_start]);
} else {
return arguments[loop_start];
}
}
bool use_default_implementation_for_nulls() const override { return false; }
template <typename ColumnType, bool when_null, bool then_null>
Status execute_short_circuit(const DataTypePtr& data_type, Block& block, size_t result,
CaseWhenColumnHolder column_holder) {
auto case_column_ptr = column_holder.when_ptrs[0].value_or(nullptr);
int rows_count = column_holder.rows_count;
// `then` data index corresponding to each row of results, 0 represents `else`.
int then_idx[rows_count];
int* __restrict then_idx_ptr = then_idx;
memset(then_idx_ptr, 0, sizeof(then_idx));
for (int row_idx = 0; row_idx < column_holder.rows_count; row_idx++) {
for (int i = 1; i < column_holder.pair_count; i++) {
auto when_column_ptr = column_holder.when_ptrs[i].value();
if constexpr (has_case) {
if (!case_column_ptr->is_null_at(row_idx) &&
case_column_ptr->compare_at(row_idx, row_idx, *when_column_ptr, -1) == 0) {
then_idx_ptr[row_idx] = i;
break;
}
} else {
if constexpr (when_null) {
if (!then_idx_ptr[row_idx] && when_column_ptr->get_bool(row_idx)) {
then_idx_ptr[row_idx] = i;
break;
}
} else {
if (!then_idx_ptr[row_idx]) {
then_idx_ptr[row_idx] = i;
break;
}
}
}
}
}
auto result_column_ptr = data_type->create_column();
update_result_normal(result_column_ptr, then_idx, column_holder);
block.replace_by_position(result, std::move(result_column_ptr));
return Status::OK();
}
template <typename ColumnType, bool when_null, bool then_null>
Status execute_impl(const DataTypePtr& data_type, Block& block, size_t result,
CaseWhenColumnHolder column_holder) {
if (column_holder.pair_count > UINT8_MAX) {
return execute_short_circuit<ColumnType, when_null, then_null>(data_type, block, result,
column_holder);
}
int rows_count = column_holder.rows_count;
// `then` data index corresponding to each row of results, 0 represents `else`.
uint8_t then_idx[rows_count];
uint8_t* __restrict then_idx_ptr = then_idx;
memset(then_idx_ptr, 0, sizeof(then_idx));
auto case_column_ptr = column_holder.when_ptrs[0].value_or(nullptr);
for (uint8_t i = 1; i < column_holder.pair_count; i++) {
auto when_column_ptr = column_holder.when_ptrs[i].value();
if constexpr (has_case) {
// TODO: need simd
for (int row_idx = 0; row_idx < rows_count; row_idx++) {
if (!then_idx_ptr[row_idx] && !case_column_ptr->is_null_at(row_idx) &&
case_column_ptr->compare_at(row_idx, row_idx, *when_column_ptr, -1) == 0) {
then_idx_ptr[row_idx] = i;
}
}
} else {
if constexpr (when_null) {
// TODO: need simd
for (int row_idx = 0; row_idx < rows_count; row_idx++) {
if (!then_idx_ptr[row_idx] && when_column_ptr->get_bool(row_idx)) {
then_idx_ptr[row_idx] = i;
}
}
} else {
auto* __restrict cond_raw_data =
reinterpret_cast<const ColumnUInt8*>(when_column_ptr.get())
->get_data()
.data();
// simd automatically
for (int row_idx = 0; row_idx < rows_count; row_idx++) {
then_idx_ptr[row_idx] |=
(!then_idx_ptr[row_idx]) * cond_raw_data[row_idx] * i;
}
}
}
}
return execute_update_result<ColumnType, then_null>(data_type, result, block, then_idx,
column_holder);
}
template <typename ColumnType, bool then_null>
Status execute_update_result(const DataTypePtr& data_type, size_t result, Block& block,
uint8* then_idx, CaseWhenColumnHolder& column_holder) {
auto result_column_ptr = data_type->create_column();
if constexpr (std::is_same_v<ColumnType, ColumnString> ||
std::is_same_v<ColumnType, ColumnBitmap> ||
std::is_same_v<ColumnType, ColumnArray> ||
std::is_same_v<ColumnType, ColumnMap> ||
std::is_same_v<ColumnType, ColumnStruct> ||
std::is_same_v<ColumnType, ColumnHLL>) {
// result_column and all then_column is not nullable.
// can't simd when type is string.
update_result_normal(result_column_ptr, then_idx, column_holder);
} else if constexpr (then_null) {
// result_column and all then_column is nullable.
// TODO: make here simd automatically.
update_result_normal(result_column_ptr, then_idx, column_holder);
} else {
update_result_auto_simd<ColumnType>(result_column_ptr, then_idx, column_holder);
}
block.replace_by_position(result, std::move(result_column_ptr));
return Status::OK();
}
template <typename IndexType>
void update_result_normal(MutableColumnPtr& result_column_ptr, IndexType* then_idx,
CaseWhenColumnHolder& column_holder) {
for (int row_idx = 0; row_idx < column_holder.rows_count; row_idx++) {
if constexpr (!has_else) {
if (!then_idx[row_idx]) {
result_column_ptr->insert_default();
continue;
}
}
result_column_ptr->insert_from(*column_holder.then_ptrs[then_idx[row_idx]].value(),
row_idx);
}
}
template <typename ColumnType>
void update_result_auto_simd(MutableColumnPtr& result_column_ptr,
const uint8* __restrict then_idx,
CaseWhenColumnHolder& column_holder) {
size_t rows_count = column_holder.rows_count;
result_column_ptr->resize(rows_count);
auto* __restrict result_raw_data =
reinterpret_cast<ColumnType*>(result_column_ptr.get())->get_data().data();
// set default value
for (int i = 0; i < rows_count; i++) {
result_raw_data[i] = 0;
}
// some types had simd automatically, but some not.
for (uint8_t i = (has_else ? 0 : 1); i < column_holder.pair_count; i++) {
auto* __restrict column_raw_data =
reinterpret_cast<ColumnType*>(
column_holder.then_ptrs[i].value()->assume_mutable().get())
->get_data()
.data();
for (int row_idx = 0; row_idx < rows_count; row_idx++) {
result_raw_data[row_idx] += (then_idx[row_idx] == i) * column_raw_data[row_idx];
}
}
}
template <typename ColumnType, bool when_null>
Status execute_get_then_null(const DataTypePtr& data_type, Block& block,
const ColumnNumbers& arguments, size_t result,
size_t input_rows_count) {
bool then_null = false;
for (int i = 1 + has_case; i < arguments.size() - has_else; i += 2) {
auto then_column_ptr = block.get_by_position(arguments[i]).column;
if (then_column_ptr->is_nullable()) {
then_null = true;
}
}
if constexpr (has_else) {
auto else_column_ptr = block.get_by_position(arguments[arguments.size() - 1]).column;
if (else_column_ptr->is_nullable()) {
then_null = true;
}
} else {
then_null = true;
}
CaseWhenColumnHolder column_holder = CaseWhenColumnHolder(
block, arguments, input_rows_count, has_case, has_else, when_null, then_null);
if (then_null) {
return execute_impl<ColumnType, when_null, true>(data_type, block, result,
column_holder);
} else {
return execute_impl<ColumnType, when_null, false>(data_type, block, result,
column_holder);
}
}
template <typename ColumnType>
Status execute_get_when_null(const DataTypePtr& data_type, Block& block,
const ColumnNumbers& arguments, size_t result,
size_t input_rows_count) {
bool when_null = false;
if constexpr (has_case) {
auto case_column_ptr = block.get_by_position(arguments[0]).column;
if (case_column_ptr->is_nullable()) {
when_null = true;
}
}
for (int i = has_case; i < arguments.size() - has_else; i += 2) {
auto when_column_ptr = block.get_by_position(arguments[i]).column;
if (when_column_ptr->is_nullable()) {
when_null = true;
}
}
if (when_null) {
return execute_get_then_null<ColumnType, true>(data_type, block, arguments, result,
input_rows_count);
} else {
return execute_get_then_null<ColumnType, false>(data_type, block, arguments, result,
input_rows_count);
}
}
Status execute_get_type(const DataTypePtr& data_type, Block& block,
const ColumnNumbers& arguments, size_t result,
size_t input_rows_count) {
WhichDataType which(data_type->is_nullable()
? reinterpret_cast<const DataTypeNullable*>(data_type.get())
->get_nested_type()
: data_type);
#define DISPATCH(TYPE, COLUMN_TYPE) \
if (which.idx == TypeIndex::TYPE) \
return execute_get_when_null<COLUMN_TYPE>(data_type, block, arguments, result, \
input_rows_count);
TYPE_TO_COLUMN_TYPE(DISPATCH)
#undef DISPATCH
return Status::NotSupported("argument_type {} not supported", data_type->get_name());
}
Status execute_impl(FunctionContext* context, Block& block, const ColumnNumbers& arguments,
size_t result, size_t input_rows_count) override {
return execute_get_type(block.get_by_position(result).type, block, arguments, result,
input_rows_count);
}
};
} // namespace doris::vectorized