Coverage Report

Created: 2026-03-12 17:06

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
#include "common/compile_check_begin.h"
44
class Arena;
45
class BufferReadable;
46
class BufferWritable;
47
} // namespace doris
48
49
namespace doris {
50
struct RetentionState {
51
    static constexpr size_t MAX_EVENTS = 32;
52
    uint8_t events[MAX_EVENTS] = {0};
53
54
367
    RetentionState() = default;
55
56
40
    void reset() {
57
1.32k
        for (int64_t i = 0; i < MAX_EVENTS; i++) {
58
1.28k
            events[i] = 0;
59
1.28k
        }
60
40
    }
61
62
108
    void set(int event) { events[event] = 1; }
63
64
118
    void merge(const RetentionState& other) {
65
3.89k
        for (int64_t i = 0; i < MAX_EVENTS; i++) {
66
3.77k
            events[i] |= other.events[i];
67
3.77k
        }
68
118
    }
69
70
156
    void write(BufferWritable& out) const {
71
156
        int64_t serialized_events = 0;
72
5.14k
        for (int64_t i = 0; i < MAX_EVENTS; i++) {
73
4.99k
            serialized_events |= events[i];
74
4.99k
            serialized_events <<= 1;
75
4.99k
        }
76
156
        write_var_int(serialized_events, out);
77
156
    }
78
79
117
    void read(BufferReadable& in) {
80
117
        int64_t serialized_events = 0;
81
117
        uint64_t u_serialized_events = 0;
82
117
        read_var_int(serialized_events, in);
83
117
        u_serialized_events = serialized_events;
84
85
117
        u_serialized_events >>= 1;
86
3.86k
        for (int64_t i = MAX_EVENTS - 1; i >= 0; i--) {
87
3.74k
            events[i] = (uint8_t)(1 & u_serialized_events);
88
3.74k
            u_serialized_events >>= 1;
89
3.74k
        }
90
117
    }
91
92
86
    void insert_result_into(IColumn& to, size_t events_size, const uint8_t* arg_events) const {
93
86
        auto& data_to = assert_cast<ColumnUInt8&>(to).get_data();
94
95
86
        ColumnArray::Offset64 current_offset = data_to.size();
96
86
        data_to.resize(current_offset + events_size);
97
98
86
        bool first_flag = arg_events[0];
99
86
        data_to[current_offset] = first_flag;
100
86
        ++current_offset;
101
102
191
        for (size_t i = 1; i < events_size; ++i) {
103
105
            data_to[current_offset] = (first_flag && arg_events[i]);
104
105
            ++current_offset;
105
105
        }
106
86
    }
107
};
108
109
class AggregateFunctionRetention
110
        : public IAggregateFunctionDataHelper<RetentionState, AggregateFunctionRetention>,
111
          VarargsExpression,
112
          NullableAggregateFunction {
113
public:
114
    AggregateFunctionRetention(const DataTypes& argument_types_)
115
442
            : IAggregateFunctionDataHelper<RetentionState, AggregateFunctionRetention>(
116
442
                      argument_types_) {}
117
118
31
    String get_name() const override { return "retention"; }
119
120
65
    DataTypePtr get_return_type() const override {
121
65
        return std::make_shared<DataTypeArray>(make_nullable(std::make_shared<DataTypeUInt8>()));
122
65
    }
123
124
40
    void reset(AggregateDataPtr __restrict place) const override { this->data(place).reset(); }
125
    void add(AggregateDataPtr __restrict place, const IColumn** columns, const ssize_t row_num,
126
264
             Arena&) const override {
127
930
        for (int i = 0; i < get_argument_types().size(); i++) {
128
666
            auto event = assert_cast<const ColumnUInt8*, TypeCheckOnRelease::DISABLE>(columns[i])
129
666
                                 ->get_data()[row_num];
130
666
            if (event) {
131
108
                this->data(place).set(i);
132
108
            }
133
666
        }
134
264
    }
135
136
    void merge(AggregateDataPtr __restrict place, ConstAggregateDataPtr rhs,
137
118
               Arena&) const override {
138
118
        this->data(place).merge(this->data(rhs));
139
118
    }
140
141
156
    void serialize(ConstAggregateDataPtr __restrict place, BufferWritable& buf) const override {
142
156
        this->data(place).write(buf);
143
156
    }
144
145
    void deserialize(AggregateDataPtr __restrict place, BufferReadable& buf,
146
117
                     Arena&) const override {
147
117
        this->data(place).read(buf);
148
117
    }
149
150
86
    void insert_result_into(ConstAggregateDataPtr __restrict place, IColumn& to) const override {
151
86
        auto& to_arr = assert_cast<ColumnArray&>(to);
152
86
        auto& to_nested_col = to_arr.get_data();
153
86
        if (to_nested_col.is_nullable()) {
154
80
            auto col_null = reinterpret_cast<ColumnNullable*>(&to_nested_col);
155
80
            this->data(place).insert_result_into(col_null->get_nested_column(),
156
80
                                                 get_argument_types().size(),
157
80
                                                 this->data(place).events);
158
80
            col_null->get_null_map_data().resize_fill(col_null->get_nested_column().size(), 0);
159
80
        } else {
160
6
            this->data(place).insert_result_into(to_nested_col, get_argument_types().size(),
161
6
                                                 this->data(place).events);
162
6
        }
163
86
        to_arr.get_offsets().push_back(to_nested_col.size());
164
86
    }
165
};
166
} // namespace doris
167
#include "common/compile_check_end.h"