Coverage Report

Created: 2026-05-22 06:40

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
be/src/exprs/aggregate/aggregate_function_retention.h
Line
Count
Source
1
// Licensed to the Apache Software Foundation (ASF) under one
2
// or more contributor license agreements.  See the NOTICE file
3
// distributed with this work for additional information
4
// regarding copyright ownership.  The ASF licenses this file
5
// to you under the Apache License, Version 2.0 (the
6
// "License"); you may not use this file except in compliance
7
// with the License.  You may obtain a copy of the License at
8
//
9
//   http://www.apache.org/licenses/LICENSE-2.0
10
//
11
// Unless required by applicable law or agreed to in writing,
12
// software distributed under the License is distributed on an
13
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
// KIND, either express or implied.  See the License for the
15
// specific language governing permissions and limitations
16
// under the License.
17
18
// This file is copied from
19
// https://github.com/ClickHouse/ClickHouse/blob/master/AggregateFunctionRetention.h
20
// and modified by Doris
21
22
#pragma once
23
24
#include <stddef.h>
25
#include <stdint.h>
26
27
#include <boost/iterator/iterator_facade.hpp>
28
#include <memory>
29
30
#include "core/assert_cast.h"
31
#include "core/column/column.h"
32
#include "core/column/column_array.h"
33
#include "core/column/column_nullable.h"
34
#include "core/column/column_vector.h"
35
#include "core/data_type/data_type_array.h"
36
#include "core/data_type/data_type_nullable.h"
37
#include "core/data_type/data_type_number.h"
38
#include "core/types.h"
39
#include "exprs/aggregate/aggregate_function.h"
40
#include "util/var_int.h"
41
42
namespace doris {
43
class Arena;
44
class BufferReadable;
45
class BufferWritable;
46
} // namespace doris
47
48
namespace doris {
49
struct RetentionState {
50
    static constexpr size_t MAX_EVENTS = 32;
51
    uint8_t events[MAX_EVENTS] = {0};
52
53
75
    RetentionState() = default;
54
55
14
    void reset() {
56
462
        for (int64_t i = 0; i < MAX_EVENTS; i++) {
57
448
            events[i] = 0;
58
448
        }
59
14
    }
60
61
80
    void set(int event) { events[event] = 1; }
62
63
5
    void merge(const RetentionState& other) {
64
165
        for (int64_t i = 0; i < MAX_EVENTS; i++) {
65
160
            events[i] |= other.events[i];
66
160
        }
67
5
    }
68
69
4
    void write(BufferWritable& out) const {
70
4
        int64_t serialized_events = 0;
71
132
        for (int64_t i = 0; i < MAX_EVENTS; i++) {
72
128
            serialized_events |= events[i];
73
128
            serialized_events <<= 1;
74
128
        }
75
4
        write_var_int(serialized_events, out);
76
4
    }
77
78
4
    void read(BufferReadable& in) {
79
4
        int64_t serialized_events = 0;
80
4
        uint64_t u_serialized_events = 0;
81
4
        read_var_int(serialized_events, in);
82
4
        u_serialized_events = serialized_events;
83
84
4
        u_serialized_events >>= 1;
85
132
        for (int64_t i = MAX_EVENTS - 1; i >= 0; i--) {
86
128
            events[i] = (uint8_t)(1 & u_serialized_events);
87
128
            u_serialized_events >>= 1;
88
128
        }
89
4
    }
90
91
55
    void insert_result_into(IColumn& to, size_t events_size, const uint8_t* arg_events) const {
92
55
        auto& data_to = assert_cast<ColumnUInt8&>(to).get_data();
93
94
55
        ColumnArray::Offset64 current_offset = data_to.size();
95
55
        data_to.resize(current_offset + events_size);
96
97
55
        bool first_flag = arg_events[0];
98
55
        data_to[current_offset] = first_flag;
99
55
        ++current_offset;
100
101
129
        for (size_t i = 1; i < events_size; ++i) {
102
74
            data_to[current_offset] = (first_flag && arg_events[i]);
103
74
            ++current_offset;
104
74
        }
105
55
    }
106
};
107
108
class AggregateFunctionRetention final
109
        : public IAggregateFunctionDataHelper<RetentionState, AggregateFunctionRetention>,
110
          VarargsExpression,
111
          NullableAggregateFunction {
112
public:
113
    AggregateFunctionRetention(const DataTypes& argument_types_)
114
25
            : IAggregateFunctionDataHelper<RetentionState, AggregateFunctionRetention>(
115
25
                      argument_types_) {}
116
117
10
    String get_name() const override { return "retention"; }
118
119
51
    DataTypePtr get_return_type() const override {
120
51
        return std::make_shared<DataTypeArray>(make_nullable(std::make_shared<DataTypeUInt8>()));
121
51
    }
122
123
14
    void reset(AggregateDataPtr __restrict place) const override { this->data(place).reset(); }
124
    void add(AggregateDataPtr __restrict place, const IColumn** columns, const ssize_t row_num,
125
103
             Arena&) const override {
126
447
        for (int i = 0; i < get_argument_types().size(); i++) {
127
344
            auto event = assert_cast<const ColumnUInt8*, TypeCheckOnRelease::DISABLE>(columns[i])
128
344
                                 ->get_data()[row_num];
129
344
            if (event) {
130
80
                this->data(place).set(i);
131
80
            }
132
344
        }
133
103
    }
134
135
    void merge(AggregateDataPtr __restrict place, ConstAggregateDataPtr rhs,
136
5
               Arena&) const override {
137
5
        this->data(place).merge(this->data(rhs));
138
5
    }
139
140
4
    void serialize(ConstAggregateDataPtr __restrict place, BufferWritable& buf) const override {
141
4
        this->data(place).write(buf);
142
4
    }
143
144
    void deserialize(AggregateDataPtr __restrict place, BufferReadable& buf,
145
4
                     Arena&) const override {
146
4
        this->data(place).read(buf);
147
4
    }
148
149
55
    void insert_result_into(ConstAggregateDataPtr __restrict place, IColumn& to) const override {
150
55
        auto& to_arr = assert_cast<ColumnArray&>(to);
151
55
        auto& to_nested_col = to_arr.get_data();
152
55
        if (to_nested_col.is_nullable()) {
153
49
            auto col_null = reinterpret_cast<ColumnNullable*>(&to_nested_col);
154
49
            this->data(place).insert_result_into(col_null->get_nested_column(),
155
49
                                                 get_argument_types().size(),
156
49
                                                 this->data(place).events);
157
49
            col_null->get_null_map_data().resize_fill(col_null->get_nested_column().size(), 0);
158
49
        } else {
159
6
            this->data(place).insert_result_into(to_nested_col, get_argument_types().size(),
160
6
                                                 this->data(place).events);
161
6
        }
162
55
        to_arr.get_offsets().push_back(to_nested_col.size());
163
55
    }
164
};
165
} // namespace doris