be/src/exprs/aggregate/helpers.h

Source
// 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.
// This file is copied from
// https://github.com/ClickHouse/ClickHouse/blob/master/src/AggregateFunctions/Helpers.h
// and modified by Doris

#pragma once

#include "core/call_on_type_index.h"
#include "core/data_type/data_type.h"
#include "core/data_type/define_primitive_type.h"
#include "exec/common/template_helpers.hpp"
#include "exprs/aggregate/aggregate_function.h"
#include "exprs/aggregate/aggregate_function_null.h"
#include "exprs/aggregate/aggregate_function_null_v2.h"

/** If the serialized type is not the default type(string),
 * aggregation function need to override these functions:
 * 1. serialize_to_column
 * 2. streaming_agg_serialize_to_column
 * 3. deserialize_and_merge_vec
 * 4. deserialize_and_merge_vec_selected
 * 5. serialize_without_key_to_column
 * 6. deserialize_and_merge_from_column
 */
#define CHECK_AGG_FUNCTION_SERIALIZED_TYPE(FunctionTemplate)                                       \
    do {                                                                                           \
        constexpr bool _is_new_serialized_type =                                                   \
                !std::is_same_v<decltype(&FunctionTemplate::get_serialized_type),                  \
                                decltype(&IAggregateFunction::get_serialized_type)>;               \
        if constexpr (_is_new_serialized_type) {                                                   \
            static_assert(!std::is_same_v<decltype(&FunctionTemplate::serialize_to_column),        \
                                          decltype(&IAggregateFunctionHelper<                      \
                                                   FunctionTemplate>::serialize_to_column)>,       \
                          "need to override serialize_to_column");                                 \
            static_assert(                                                                         \
                    !std::is_same_v<                                                               \
                            decltype(&FunctionTemplate::streaming_agg_serialize_to_column),        \
                            decltype(&IAggregateFunction::streaming_agg_serialize_to_column)>,     \
                    "need to override "                                                            \
                    "streaming_agg_serialize_to_column");                                          \
            static_assert(!std::is_same_v<decltype(&FunctionTemplate::deserialize_and_merge_vec),  \
                                          decltype(&IAggregateFunctionHelper<                      \
                                                   FunctionTemplate>::deserialize_and_merge_vec)>, \
                          "need to override deserialize_and_merge_vec");                           \
            static_assert(                                                                         \
                    !std::is_same_v<                                                               \
                            decltype(&FunctionTemplate::deserialize_and_merge_vec_selected),       \
                            decltype(&IAggregateFunctionHelper<                                    \
                                     FunctionTemplate>::deserialize_and_merge_vec_selected)>,      \
                    "need to override "                                                            \
                    "deserialize_and_merge_vec_selected");                                         \
            static_assert(                                                                         \
                    !std::is_same_v<decltype(&FunctionTemplate::serialize_without_key_to_column),  \
                                    decltype(&IAggregateFunctionHelper<                            \
                                             FunctionTemplate>::serialize_without_key_to_column)>, \
                    "need to override serialize_without_key_to_column");                           \
            static_assert(                                                                         \
                    !std::is_same_v<                                                               \
                            decltype(&FunctionTemplate::deserialize_and_merge_from_column_range),  \
                            decltype(&IAggregateFunctionHelper<                                    \
                                     FunctionTemplate>::deserialize_and_merge_from_column)>,       \
                    "need to override "                                                            \
                    "deserialize_and_merge_from_column");                                          \
        }                                                                                          \
    } while (false)

namespace doris {

struct creator_without_type {
    template <bool multi_arguments, bool f, typename T>
    using NullableT = std::conditional_t<multi_arguments, AggregateFunctionNullVariadicInline<T, f>,
                                         AggregateFunctionNullUnaryInline<T, f>>;

    template <bool multi_arguments, bool f, typename T>
    using NullableV2T =
            std::conditional_t<multi_arguments, AggregateFunctionNullVariadicInline<T, f>,
                               AggregateFunctionNullUnaryInlineV2<T, f>>;

    template <typename AggregateFunctionTemplate>
    static AggregateFunctionPtr creator(const std::string& name, const DataTypes& argument_types,
                                        const DataTypePtr& result_type,
                                        const bool result_is_nullable,
                                        const AggregateFunctionAttr& attr) {
        CHECK_AGG_FUNCTION_SERIALIZED_TYPE(AggregateFunctionTemplate);
        return create<AggregateFunctionTemplate>(argument_types, result_is_nullable, attr);
    }

    template <typename AggregateFunctionTemplate, typename... TArgs>
    static AggregateFunctionPtr create(const DataTypes& argument_types_,
                                       const bool result_is_nullable,
                                       const AggregateFunctionAttr& attr, TArgs&&... args) {
        // If there is a hit, it won't need to be determined at runtime, which can reduce some template instantiations.
        if constexpr (std::is_base_of_v<UnaryExpression, AggregateFunctionTemplate>) {
            if constexpr (std::is_base_of_v<NullableAggregateFunction, AggregateFunctionTemplate>) {
                return create_unary_arguments<AggregateFunctionTemplate>(
                        argument_types_, result_is_nullable, attr, std::forward<TArgs>(args)...);
            } else {
                return create_unary_arguments_return_not_nullable<AggregateFunctionTemplate>(
                        argument_types_, result_is_nullable, attr, std::forward<TArgs>(args)...);
            }
        } else if constexpr (std::is_base_of_v<MultiExpression, AggregateFunctionTemplate>) {
            if constexpr (std::is_base_of_v<NullableAggregateFunction, AggregateFunctionTemplate>) {
                return create_multi_arguments<AggregateFunctionTemplate>(
                        argument_types_, result_is_nullable, attr, std::forward<TArgs>(args)...);
            } else {
                return create_multi_arguments_return_not_nullable<AggregateFunctionTemplate>(
                        argument_types_, result_is_nullable, attr, std::forward<TArgs>(args)...);
            }
        } else if constexpr (std::is_base_of_v<VarargsExpression, AggregateFunctionTemplate>) {
            if constexpr (std::is_base_of_v<NullableAggregateFunction, AggregateFunctionTemplate>) {
                return create_varargs<AggregateFunctionTemplate>(
                        argument_types_, result_is_nullable, attr, std::forward<TArgs>(args)...);
            } else {
                return create_varargs_return_not_nullable<AggregateFunctionTemplate>(
                        argument_types_, result_is_nullable, attr, std::forward<TArgs>(args)...);
            }
        } else {
            static_assert(std::is_same_v<AggregateFunctionTemplate, void>,
                          "AggregateFunctionTemplate must have tag (UnaryExpression, "
                          "MultiExpression or VarargsExpression) , (NullableAggregateFunction , "
                          "NonNullableAggregateFunction)");
        }
        return nullptr;
    }

    // dispatch
    template <typename AggregateFunctionTemplate, typename... TArgs>
    static AggregateFunctionPtr create_varargs(const DataTypes& argument_types_,
                                               const bool result_is_nullable,
                                               const AggregateFunctionAttr& attr, TArgs&&... args) {
        std::unique_ptr<IAggregateFunction> result(std::make_unique<AggregateFunctionTemplate>(
                std::forward<TArgs>(args)..., remove_nullable(argument_types_)));
        if (have_nullable(argument_types_)) {
            std::visit(
                    [&](auto multi_arguments, auto result_is_nullable) {
                        if (attr.enable_aggregate_function_null_v2) {
                            result.reset(new NullableV2T<multi_arguments, result_is_nullable,
                                                         AggregateFunctionTemplate>(
                                    result.release(), argument_types_, attr.is_window_function));
                        } else {
                            result.reset(new NullableT<multi_arguments, result_is_nullable,
                                                       AggregateFunctionTemplate>(
                                    result.release(), argument_types_, attr.is_window_function));
                        }
                    },
                    make_bool_variant(argument_types_.size() > 1),
                    make_bool_variant(result_is_nullable));
        }

        CHECK_AGG_FUNCTION_SERIALIZED_TYPE(AggregateFunctionTemplate);
        return AggregateFunctionPtr(result.release());
    }

    template <typename AggregateFunctionTemplate, typename... TArgs>
    static AggregateFunctionPtr create_varargs_return_not_nullable(
            const DataTypes& argument_types_, const bool result_is_nullable,
            const AggregateFunctionAttr& attr, TArgs&&... args) {
        if (!attr.is_foreach && result_is_nullable) {
            throw doris::Exception(Status::InternalError(
                    "create_varargs_return_not_nullable: result_is_nullable must be false"));
        }
        std::unique_ptr<IAggregateFunction> result(std::make_unique<AggregateFunctionTemplate>(
                std::forward<TArgs>(args)..., remove_nullable(argument_types_)));
        if (have_nullable(argument_types_)) {
            if (argument_types_.size() > 1) {
                if (attr.enable_aggregate_function_null_v2) {
                    result.reset(new NullableV2T<true, false, AggregateFunctionTemplate>(
                            result.release(), argument_types_, attr.is_window_function));
                } else {
                    result.reset(new NullableT<true, false, AggregateFunctionTemplate>(
                            result.release(), argument_types_, attr.is_window_function));
                }
            } else {
                if (attr.enable_aggregate_function_null_v2) {
                    result.reset(new NullableV2T<false, false, AggregateFunctionTemplate>(
                            result.release(), argument_types_, attr.is_window_function));
                } else {
                    result.reset(new NullableT<false, false, AggregateFunctionTemplate>(
                            result.release(), argument_types_, attr.is_window_function));
                }
            }
        }

        CHECK_AGG_FUNCTION_SERIALIZED_TYPE(AggregateFunctionTemplate);
        return AggregateFunctionPtr(result.release());
    }

    template <typename AggregateFunctionTemplate, typename... TArgs>
    static AggregateFunctionPtr create_multi_arguments(const DataTypes& argument_types_,
                                                       const bool result_is_nullable,
                                                       const AggregateFunctionAttr& attr,
                                                       TArgs&&... args) {
        if (!(argument_types_.size() > 1)) {
            throw doris::Exception(Status::InternalError(
                    "create_multi_arguments: argument_types_ size must be > 1"));
        }
        std::unique_ptr<IAggregateFunction> result(std::make_unique<AggregateFunctionTemplate>(
                std::forward<TArgs>(args)..., remove_nullable(argument_types_)));
        if (have_nullable(argument_types_)) {
            std::visit(
                    [&](auto result_is_nullable) {
                        if (attr.enable_aggregate_function_null_v2) {
                            result.reset(new NullableV2T<true, result_is_nullable,
                                                         AggregateFunctionTemplate>(
                                    result.release(), argument_types_, attr.is_window_function));
                        } else {
                            result.reset(new NullableT<true, result_is_nullable,
                                                       AggregateFunctionTemplate>(
                                    result.release(), argument_types_, attr.is_window_function));
                        }
                    },
                    make_bool_variant(result_is_nullable));
        }
        CHECK_AGG_FUNCTION_SERIALIZED_TYPE(AggregateFunctionTemplate);
        return AggregateFunctionPtr(result.release());
    }

    template <typename AggregateFunctionTemplate, typename... TArgs>
    static AggregateFunctionPtr create_multi_arguments_return_not_nullable(
            const DataTypes& argument_types_, const bool result_is_nullable,
            const AggregateFunctionAttr& attr, TArgs&&... args) {
        if (!(argument_types_.size() > 1)) {
            throw doris::Exception(
                    Status::InternalError("create_multi_arguments_return_not_nullable: "
                                          "argument_types_ size must be > 1"));
        }
        if (!attr.is_foreach && result_is_nullable) {
            throw doris::Exception(
                    Status::InternalError("create_multi_arguments_return_not_nullable: "
                                          "result_is_nullable must be false"));
        }
        std::unique_ptr<IAggregateFunction> result(std::make_unique<AggregateFunctionTemplate>(
                std::forward<TArgs>(args)..., remove_nullable(argument_types_)));
        if (have_nullable(argument_types_)) {
            if (attr.enable_aggregate_function_null_v2) {
                result.reset(new NullableV2T<true, false, AggregateFunctionTemplate>(
                        result.release(), argument_types_, attr.is_window_function));
            } else {
                result.reset(new NullableT<true, false, AggregateFunctionTemplate>(
                        result.release(), argument_types_, attr.is_window_function));
            }
        }
        CHECK_AGG_FUNCTION_SERIALIZED_TYPE(AggregateFunctionTemplate);
        return AggregateFunctionPtr(result.release());
    }

    template <typename AggregateFunctionTemplate, typename... TArgs>
    static AggregateFunctionPtr create_unary_arguments(const DataTypes& argument_types_,
                                                       const bool result_is_nullable,
                                                       const AggregateFunctionAttr& attr,
                                                       TArgs&&... args) {
        if (!(argument_types_.size() == 1)) {
            throw doris::Exception(Status::InternalError(
                    "create_unary_arguments: argument_types_ size must be 1"));
        }
        std::unique_ptr<IAggregateFunction> result(std::make_unique<AggregateFunctionTemplate>(
                std::forward<TArgs>(args)..., remove_nullable(argument_types_)));
        if (have_nullable(argument_types_)) {
            std::visit(
                    [&](auto result_is_nullable) {
                        if (attr.enable_aggregate_function_null_v2) {
                            result.reset(new NullableV2T<false, result_is_nullable,
                                                         AggregateFunctionTemplate>(
                                    result.release(), argument_types_, attr.is_window_function));
                        } else {
                            result.reset(new NullableT<false, result_is_nullable,
                                                       AggregateFunctionTemplate>(
                                    result.release(), argument_types_, attr.is_window_function));
                        }
                    },
                    make_bool_variant(result_is_nullable));
        }
        CHECK_AGG_FUNCTION_SERIALIZED_TYPE(AggregateFunctionTemplate);
        return AggregateFunctionPtr(result.release());
    }

    template <typename AggregateFunctionTemplate, typename... TArgs>
    static AggregateFunctionPtr create_unary_arguments_return_not_nullable(
            const DataTypes& argument_types_, const bool result_is_nullable,
            const AggregateFunctionAttr& attr, TArgs&&... args) {
        if (!(argument_types_.size() == 1)) {
            throw doris::Exception(Status::InternalError(
                    "create_unary_arguments_return_not_nullable: argument_types_ size must be 1"));
        }
        if (!attr.is_foreach && result_is_nullable) {
            throw doris::Exception(
                    Status::InternalError("create_unary_arguments_return_not_nullable: "
                                          "result_is_nullable must be false"));
        }
        std::unique_ptr<IAggregateFunction> result(std::make_unique<AggregateFunctionTemplate>(
                std::forward<TArgs>(args)..., remove_nullable(argument_types_)));
        if (have_nullable(argument_types_)) {
            if (attr.enable_aggregate_function_null_v2) {
                result.reset(new NullableV2T<false, false, AggregateFunctionTemplate>(
                        result.release(), argument_types_, attr.is_window_function));
            } else {
                result.reset(new NullableT<false, false, AggregateFunctionTemplate>(
                        result.release(), argument_types_, attr.is_window_function));
            }
        }
        CHECK_AGG_FUNCTION_SERIALIZED_TYPE(AggregateFunctionTemplate);
        return AggregateFunctionPtr(result.release());
    }

    /// AggregateFunctionTemplate will handle the nullable arguments, no need to use
    /// AggregateFunctionNullVariadicInline/AggregateFunctionNullUnaryInline
    template <typename AggregateFunctionTemplate, typename... TArgs>
    static AggregateFunctionPtr create_ignore_nullable(const DataTypes& argument_types_,
                                                       const bool /*result_is_nullable*/,
                                                       const AggregateFunctionAttr& /*attr*/,
                                                       TArgs&&... args) {
        std::unique_ptr<IAggregateFunction> result = std::make_unique<AggregateFunctionTemplate>(
                std::forward<TArgs>(args)..., argument_types_);
        CHECK_AGG_FUNCTION_SERIALIZED_TYPE(AggregateFunctionTemplate);
        return AggregateFunctionPtr(result.release());
    }
};

template <template <PrimitiveType> class AggregateFunctionTemplate>
struct CurryDirect {
    template <PrimitiveType type>
    using T = AggregateFunctionTemplate<type>;
};
template <template <PrimitiveType, PrimitiveType> class AggregateFunctionTemplate>
struct CurryDirectWithResultType {
    template <PrimitiveType type, PrimitiveType result_type>
    using T = AggregateFunctionTemplate<type, result_type>;
};
template <template <typename> class AggregateFunctionTemplate, template <PrimitiveType> class Data>
struct CurryData {
    template <PrimitiveType Type>
    using T = AggregateFunctionTemplate<Data<Type>>;
};
template <template <typename> class AggregateFunctionTemplate, template <typename> class Data,
          template <PrimitiveType> class Impl>
struct CurryDataImpl {
    template <PrimitiveType Type>
    using T = AggregateFunctionTemplate<Data<Impl<Type>>>;
};
template <template <PrimitiveType, typename> class AggregateFunctionTemplate,
          template <PrimitiveType> class Data>
struct CurryDirectAndData {
    template <PrimitiveType Type>
    using T = AggregateFunctionTemplate<Type, Data<Type>>;
};

template <int define_index, PrimitiveType... AllowedTypes>
struct creator_with_type_list_base {
    template <typename Class, typename... TArgs>
    static AggregateFunctionPtr create_base(const DataTypes& argument_types,
                                            const bool result_is_nullable,
                                            const AggregateFunctionAttr& attr, TArgs&&... args) {
        auto create = [&]<PrimitiveType Ptype>() {
            return creator_without_type::create<typename Class::template T<Ptype>>(
                    argument_types, result_is_nullable, attr, std::forward<TArgs>(args)...);
        };
        AggregateFunctionPtr result = nullptr;
        auto type = argument_types[define_index]->get_primitive_type();
        if (type == PrimitiveType::TYPE_CHAR || type == PrimitiveType::TYPE_STRING ||
            type == PrimitiveType::TYPE_JSONB) {
            type = PrimitiveType::TYPE_VARCHAR;
        }

        (
                [&] {
                    if (type == AllowedTypes) {
                        result = create.template operator()<AllowedTypes>();
                    }
                }(),
                ...);

        return result;
    }

    template <typename Class, typename... TArgs>
    static AggregateFunctionPtr create_base_with_result_type(const std::string& name,
                                                             const DataTypes& argument_types,
                                                             const DataTypePtr& result_type,
                                                             const bool result_is_nullable,
                                                             const AggregateFunctionAttr& attr,
                                                             TArgs&&... args) {
        auto create = [&]<PrimitiveType InputType, PrimitiveType ResultType>() {
            if constexpr (is_decimalv3(InputType) && is_decimalv3(ResultType) &&
                          ResultType < InputType) {
                throw doris::Exception(ErrorCode::INTERNAL_ERROR,
                                       "agg function {} error, arg type {}, result type {}", name,
                                       argument_types[define_index]->get_name(),
                                       result_type->get_name());
                return nullptr;
            } else {
                return creator_without_type::create<
                        typename Class::template T<InputType, ResultType>>(
                        argument_types, result_is_nullable, attr, std::forward<TArgs>(args)...);
            }
        };
        AggregateFunctionPtr result = nullptr;
        auto type = argument_types[define_index]->get_primitive_type();

        (
                [&] {
                    if (type == AllowedTypes) {
                        static_assert(is_decimalv3(AllowedTypes));
                        auto call = [&](const auto& type) -> bool {
                            using DispatchType = std::decay_t<decltype(type)>;
                            result =
                                    create.template operator()<AllowedTypes, DispatchType::PType>();
                            return true;
                        };
                        if (!dispatch_switch_decimalv3(result_type->get_primitive_type(), call)) {
                            throw doris::Exception(
                                    ErrorCode::INTERNAL_ERROR,
                                    "agg function {} error, arg type {}, result type {}", name,
                                    argument_types[define_index]->get_name(),
                                    result_type->get_name());
                        }
                    }
                }(),
                ...);

        return result;
    }

    template <template <PrimitiveType> class AggregateFunctionTemplate>
    static AggregateFunctionPtr creator(const std::string& name, const DataTypes& argument_types,
                                        const DataTypePtr& result_type,
                                        const bool result_is_nullable,
                                        const AggregateFunctionAttr& attr) {
        return create_base<CurryDirect<AggregateFunctionTemplate>>(argument_types,
                                                                   result_is_nullable, attr);
    }

    // Create agg function with result type from FE.
    // Currently only used for decimalv3 sum and avg.
    template <template <PrimitiveType, PrimitiveType> class AggregateFunctionTemplate>
    static AggregateFunctionPtr creator_with_result_type(const std::string& name,
                                                         const DataTypes& argument_types,
                                                         const DataTypePtr& result_type,
                                                         const bool result_is_nullable,
                                                         const AggregateFunctionAttr& attr) {
        return create_base_with_result_type<CurryDirectWithResultType<AggregateFunctionTemplate>>(
                name, argument_types, result_type, result_is_nullable, attr);
    }

    template <template <PrimitiveType> class AggregateFunctionTemplate, typename... TArgs>
    static AggregateFunctionPtr create(TArgs&&... args) {
        return create_base<CurryDirect<AggregateFunctionTemplate>>(std::forward<TArgs>(args)...);
    }

    template <template <typename> class AggregateFunctionTemplate,
              template <PrimitiveType> class Data>
    static AggregateFunctionPtr creator(const std::string& name, const DataTypes& argument_types,
                                        const DataTypePtr& result_type,
                                        const bool result_is_nullable,
                                        const AggregateFunctionAttr& attr) {
        return create_base<CurryData<AggregateFunctionTemplate, Data>>(argument_types,
                                                                       result_is_nullable, attr);
    }

    template <template <typename> class AggregateFunctionTemplate,
              template <PrimitiveType> class Data, typename... TArgs>
    static AggregateFunctionPtr create(TArgs&&... args) {
        return create_base<CurryData<AggregateFunctionTemplate, Data>>(
                std::forward<TArgs>(args)...);
    }

    template <template <typename> class AggregateFunctionTemplate, template <typename> class Data,
              template <PrimitiveType> class Impl>
    static AggregateFunctionPtr creator(const std::string& name, const DataTypes& argument_types,
                                        const DataTypePtr& result_type,
                                        const bool result_is_nullable,
                                        const AggregateFunctionAttr& attr) {
        return create_base<CurryDataImpl<AggregateFunctionTemplate, Data, Impl>>(
                argument_types, result_is_nullable, attr);
    }

    template <template <typename> class AggregateFunctionTemplate, template <typename> class Data,
              template <PrimitiveType> class Impl, typename... TArgs>
    static AggregateFunctionPtr create(TArgs&&... args) {
        return create_base<CurryDataImpl<AggregateFunctionTemplate, Data, Impl>>(
                std::forward<TArgs>(args)...);
    }

    template <template <PrimitiveType, typename> class AggregateFunctionTemplate,
              template <PrimitiveType> class Data>
    static AggregateFunctionPtr creator(const std::string& name, const DataTypes& argument_types,
                                        const DataTypePtr& result_type,
                                        const bool result_is_nullable,
                                        const AggregateFunctionAttr& attr) {
        return create_base<CurryDirectAndData<AggregateFunctionTemplate, Data>>(
                argument_types, result_is_nullable, attr);
    }

    template <template <PrimitiveType, typename> class AggregateFunctionTemplate,
              template <PrimitiveType> class Data, typename... TArgs>
    static AggregateFunctionPtr create(TArgs&&... args) {
        return create_base<CurryDirectAndData<AggregateFunctionTemplate, Data>>(
                std::forward<TArgs>(args)...);
    }
};

template <PrimitiveType... AllowedTypes>
using creator_with_type_list = creator_with_type_list_base<0, AllowedTypes...>;

} // namespace  doris

Coverage Report

Created: 2026-09-11 10:55