Coverage Report

Created: 2026-05-24 06:10

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
be/src/exec/common/util.hpp
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
#pragma once
19
20
#include <thrift/protocol/TJSONProtocol.h>
21
22
#include <boost/shared_ptr.hpp>
23
24
#include "core/block/block.h"
25
#include "core/column/column.h"
26
#include "core/column/column_nullable.h"
27
#include "exprs/vexpr.h"
28
#include "exprs/vexpr_context.h"
29
#include "runtime/descriptors.h"
30
#include "util/simd/bits.h"
31
32
namespace doris {
33
class VectorizedUtils {
34
public:
35
131k
    static Block create_empty_columnswithtypename(const RowDescriptor& row_desc) {
36
        // Block block;
37
131k
        return create_columns_with_type_and_name(row_desc);
38
131k
    }
39
    static ScopedMutableBlock build_scoped_mutable_mem_reuse_block(Block* block,
40
494k
                                                                   const RowDescriptor& row_desc) {
41
494k
        if (!block->mem_reuse()) {
42
184k
            MutableBlock tmp(VectorizedUtils::create_columns_with_type_and_name(row_desc));
43
184k
            block->swap(tmp.to_block());
44
184k
        }
45
494k
        return ScopedMutableBlock(block);
46
494k
    }
47
    static ScopedMutableBlock build_scoped_mutable_mem_reuse_block(Block* block,
48
382k
                                                                   const Block& other) {
49
382k
        if (!block->mem_reuse()) {
50
350k
            MutableBlock tmp(other.clone_empty());
51
350k
            block->swap(tmp.to_block());
52
350k
        }
53
382k
        return ScopedMutableBlock(block);
54
382k
    }
55
    static ScopedMutableBlock build_scoped_mutable_mem_reuse_block(
56
8.15k
            Block* block, const std::vector<SlotDescriptor*>& slots) {
57
8.15k
        if (!block->mem_reuse()) {
58
5.20k
            size_t column_size = slots.size();
59
5.20k
            MutableColumns columns(column_size);
60
23.4k
            for (size_t i = 0; i < column_size; i++) {
61
18.2k
                columns[i] = slots[i]->get_empty_mutable_column();
62
18.2k
            }
63
5.20k
            int n_columns = 0;
64
18.2k
            for (const auto slot_desc : slots) {
65
18.2k
                block->insert(ColumnWithTypeAndName(std::move(columns[n_columns++]),
66
18.2k
                                                    slot_desc->get_data_type_ptr(),
67
18.2k
                                                    slot_desc->col_name()));
68
18.2k
            }
69
5.20k
        }
70
8.15k
        return ScopedMutableBlock(block);
71
8.15k
    }
72
73
360k
    static ColumnsWithTypeAndName create_columns_with_type_and_name(const RowDescriptor& row_desc) {
74
360k
        ColumnsWithTypeAndName columns_with_type_and_name;
75
360k
        for (const auto& tuple_desc : row_desc.tuple_descriptors()) {
76
1.40M
            for (const auto& slot_desc : tuple_desc->slots()) {
77
1.40M
                columns_with_type_and_name.emplace_back(nullptr, slot_desc->get_data_type_ptr(),
78
1.40M
                                                        slot_desc->col_name());
79
1.40M
            }
80
360k
        }
81
360k
        return columns_with_type_and_name;
82
360k
    }
83
84
425k
    static NameAndTypePairs create_name_and_data_types(const RowDescriptor& row_desc) {
85
425k
        NameAndTypePairs name_with_types;
86
425k
        for (const auto& tuple_desc : row_desc.tuple_descriptors()) {
87
2.55M
            for (const auto& slot_desc : tuple_desc->slots()) {
88
2.55M
                name_with_types.emplace_back(slot_desc->col_name(), slot_desc->get_data_type_ptr());
89
2.55M
            }
90
425k
        }
91
425k
        return name_with_types;
92
425k
    }
93
94
290k
    static ColumnsWithTypeAndName create_empty_block(const RowDescriptor& row_desc) {
95
290k
        ColumnsWithTypeAndName columns_with_type_and_name;
96
296k
        for (const auto& tuple_desc : row_desc.tuple_descriptors()) {
97
1.10M
            for (const auto& slot_desc : tuple_desc->slots()) {
98
1.10M
                columns_with_type_and_name.emplace_back(
99
1.10M
                        slot_desc->get_data_type_ptr()->create_column(),
100
1.10M
                        slot_desc->get_data_type_ptr(), slot_desc->col_name());
101
1.10M
            }
102
296k
        }
103
290k
        return columns_with_type_and_name;
104
290k
    }
105
106
    // Helper function to extract null map from column (including ColumnConst cases)
107
11.3k
    static const NullMap* get_null_map(const ColumnPtr& col) {
108
11.3k
        if (col->is_nullable()) {
109
5.32k
            return &static_cast<const ColumnNullable&>(*col).get_null_map_data();
110
5.32k
        }
111
        // Handle Const(Nullable) case
112
6.05k
        if (const auto* const_col = check_and_get_column<ColumnConst>(col.get());
113
6.05k
            const_col != nullptr && const_col->is_concrete_nullable()) {
114
35
            return &static_cast<const ColumnNullable&>(const_col->get_data_column())
115
35
                            .get_null_map_data();
116
35
        }
117
6.02k
        return nullptr;
118
6.05k
    };
119
120
    // is_single: whether src is null map of a ColumnConst
121
225k
    static void update_null_map(NullMap& dst, const NullMap& src, bool is_single = false) {
122
225k
        size_t size = dst.size();
123
225k
        auto* __restrict l = dst.data();
124
225k
        auto* __restrict r = src.data();
125
225k
        if (is_single) {
126
37
            if (r[0]) {
127
0
                for (size_t i = 0; i < size; ++i) {
128
0
                    l[i] = 1;
129
0
                }
130
0
            }
131
225k
        } else {
132
132M
            for (size_t i = 0; i < size; ++i) {
133
132M
                l[i] |= r[i];
134
132M
            }
135
225k
        }
136
225k
    }
137
138
72.5k
    static DataTypes get_data_types(const RowDescriptor& row_desc) {
139
72.5k
        DataTypes data_types;
140
72.5k
        for (const auto& tuple_desc : row_desc.tuple_descriptors()) {
141
181k
            for (const auto& slot_desc : tuple_desc->slots()) {
142
181k
                data_types.push_back(slot_desc->get_data_type_ptr());
143
181k
            }
144
72.5k
        }
145
72.5k
        return data_types;
146
72.5k
    }
147
148
33.7k
    static std::vector<std::string> get_column_names(const RowDescriptor& row_desc) {
149
33.7k
        std::vector<std::string> column_names;
150
33.7k
        for (const auto& tuple_desc : row_desc.tuple_descriptors()) {
151
70.4k
            for (const auto& slot_desc : tuple_desc->slots()) {
152
70.4k
                column_names.push_back(slot_desc->col_name());
153
70.4k
            }
154
33.7k
        }
155
33.7k
        return column_names;
156
33.7k
    }
157
158
1.90M
    static bool all_arguments_are_constant(const Block& block, const ColumnNumbers& args) {
159
2.08M
        for (const auto& arg : args) {
160
2.08M
            if (!is_column_const(*block.get_by_position(arg).column)) {
161
1.81M
                return false;
162
1.81M
            }
163
2.08M
        }
164
92.1k
        return true;
165
1.90M
    }
166
167
    // SIMD helper: find the first not null in the null map
168
95
    static size_t find_first_valid_simd(const NullMap& null_map, size_t start_pos, size_t end_pos) {
169
95
#ifdef __AVX2__
170
        // search by simd
171
95
        for (size_t pos = start_pos; pos + 31 < end_pos; pos += 32) {
172
1
            __m256i null_vec = _mm256_loadu_si256(reinterpret_cast<const __m256i*>(&null_map[pos]));
173
1
            __m256i zero_vec = _mm256_setzero_si256();
174
1
            __m256i cmp_result = _mm256_cmpeq_epi8(null_vec, zero_vec);
175
176
1
            int mask = _mm256_movemask_epi8(cmp_result);
177
1
            if (mask != 0) {
178
                // find the first not null
179
1
                return pos + __builtin_ctz(mask);
180
1
            }
181
1
        }
182
183
        // handle the rest elements
184
128
        for (size_t pos = start_pos + ((end_pos - start_pos) / 32) * 32; pos < end_pos; ++pos) {
185
111
            if (!null_map[pos]) {
186
77
                return pos;
187
77
            }
188
111
        }
189
#else
190
        // standard implementation
191
        for (size_t pos = start_pos; pos < end_pos; ++pos) {
192
            if (!null_map[pos]) {
193
                return pos;
194
            }
195
        }
196
#endif
197
17
        return end_pos;
198
94
    }
199
200
    // SIMD helper: batch set non-null value with [start, end) to 1
201
    static void range_set_nullmap_to_true_simd(NullMap& null_map, size_t start_pos,
202
95
                                               size_t end_pos) {
203
95
#ifdef __AVX2__
204
        // batch set null map to 1 using SIMD (32 bytes at a time)
205
95
        for (size_t pos = start_pos; pos + 31 < end_pos; pos += 32) {
206
0
            __m256i ones_vec = _mm256_set1_epi8(1);
207
0
            _mm256_storeu_si256(reinterpret_cast<__m256i*>(&null_map[pos]), ones_vec);
208
0
        }
209
210
        // handle the rest elements (less than 32 bytes)
211
129
        for (size_t pos = start_pos + ((end_pos - start_pos) / 32) * 32; pos < end_pos; ++pos) {
212
34
            null_map[pos] = 1;
213
34
        }
214
#else
215
        // standard implementation
216
        for (size_t pos = start_pos; pos < end_pos; ++pos) {
217
            null_map[pos] = 1;
218
        }
219
#endif
220
95
    }
221
};
222
223
6.82k
inline bool match_suffix(const std::string& name, const std::string& suffix) {
224
6.82k
    if (name.length() < suffix.length()) {
225
0
        return false;
226
0
    }
227
6.82k
    return name.substr(name.length() - suffix.length()) == suffix;
228
6.82k
}
229
230
867
inline std::string remove_suffix(const std::string& name, const std::string& suffix) {
231
18.4E
    CHECK(match_suffix(name, suffix))
232
18.4E
            << ", suffix not match, name=" << name << ", suffix=" << suffix;
233
867
    return name.substr(0, name.length() - suffix.length());
234
867
};
235
236
16.3k
inline ColumnPtr create_always_true_column(size_t size, bool is_nullable) {
237
16.3k
    ColumnPtr res_data_column = ColumnUInt8::create(1, 1);
238
16.3k
    if (is_nullable) {
239
16.3k
        auto null_map = ColumnUInt8::create(1, 0);
240
16.3k
        res_data_column = ColumnNullable::create(res_data_column, std::move(null_map));
241
16.3k
    }
242
16.3k
    return ColumnConst::create(std::move(res_data_column), size);
243
16.3k
}
244
245
// change null element to true element
246
147k
inline void change_null_to_true(MutableColumnPtr column, ColumnPtr argument = nullptr) {
247
147k
    size_t rows = column->size();
248
147k
    if (is_column_const(*column)) {
249
78
        change_null_to_true(
250
78
                assert_cast<ColumnConst*>(column.get())->get_data_column_ptr()->assert_mutable());
251
147k
    } else if (column->has_null()) {
252
116k
        auto* nullable = assert_cast<ColumnNullable*>(column.get());
253
116k
        auto* __restrict data = assert_cast<ColumnUInt8*>(nullable->get_nested_column_ptr().get())
254
116k
                                        ->get_data()
255
116k
                                        .data();
256
116k
        const NullMap& null_map = nullable->get_null_map_data();
257
4.62M
        for (size_t i = 0; i < rows; ++i) {
258
4.50M
            data[i] |= null_map[i];
259
4.50M
        }
260
116k
        nullable->fill_false_to_nullmap(rows);
261
116k
    } else if (argument && argument->has_null()) {
262
11
        const auto* __restrict null_map =
263
11
                assert_cast<const ColumnNullable*>(argument.get())->get_null_map_data().data();
264
11
        auto* __restrict data = assert_cast<ColumnUInt8*>(column.get())->get_data().data();
265
50
        for (size_t i = 0; i < rows; ++i) {
266
39
            data[i] |= null_map[i];
267
39
        }
268
11
    }
269
147k
}
270
271
543
inline size_t calculate_false_number(ColumnPtr column) {
272
543
    size_t rows = column->size();
273
543
    if (is_column_const(*column)) {
274
57
        return calculate_false_number(
275
57
                       assert_cast<const ColumnConst*>(column.get())->get_data_column_ptr()) *
276
57
               rows;
277
486
    } else if (column->is_nullable()) {
278
338
        const auto* nullable = assert_cast<const ColumnNullable*>(column.get());
279
338
        const auto* data = assert_cast<const ColumnUInt8*>(nullable->get_nested_column_ptr().get())
280
338
                                   ->get_data()
281
338
                                   .data();
282
338
        const auto* __restrict null_map = nullable->get_null_map_data().data();
283
338
        return simd::count_zero_num(reinterpret_cast<const int8_t* __restrict>(data), null_map,
284
338
                                    rows);
285
338
    } else {
286
148
        const auto* data = assert_cast<const ColumnUInt8*>(column.get())->get_data().data();
287
148
        return simd::count_zero_num(reinterpret_cast<const int8_t* __restrict>(data), rows);
288
148
    }
289
543
}
290
291
template <typename T>
292
T read_from_json(std::string& json_str) {
293
    auto memBufferIn = std::make_shared<apache::thrift::transport::TMemoryBuffer>(
294
            reinterpret_cast<uint8_t*>(json_str.data()), static_cast<uint32_t>(json_str.size()));
295
    auto jsonProtocolIn = std::make_shared<apache::thrift::protocol::TJSONProtocol>(memBufferIn);
296
    T params;
297
    params.read(jsonProtocolIn.get());
298
    return params;
299
}
300
301
} // namespace doris
302
303
namespace apache::thrift {
304
template <typename ThriftStruct>
305
ThriftStruct from_json_string(const std::string& json_val) {
306
    using namespace apache::thrift::transport;
307
    using namespace apache::thrift::protocol;
308
    ThriftStruct ts;
309
    std::shared_ptr<TTransport> trans =
310
            std::make_shared<TMemoryBuffer>((uint8_t*)json_val.c_str(), (uint32_t)json_val.size());
311
    TJSONProtocol protocol(trans);
312
    ts.read(&protocol);
313
    return ts;
314
}
315
316
} // namespace apache::thrift