be/src/pipeline/exec/exchange_source_operator.h

// 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 <stdint.h>

#include "operator.h"

namespace doris {
#include "common/compile_check_begin.h"
class ExecNode;
} // namespace doris

namespace vectorized {
class VDataStreamRecvr;
class Block;
} // namespace vectorized

namespace doris::pipeline {

class ExchangeSourceOperatorX;
class ExchangeLocalState : public PipelineXLocalState<> {
    ENABLE_FACTORY_CREATOR(ExchangeLocalState);

public:
    using Base = PipelineXLocalState<>;
    ExchangeLocalState(RuntimeState* state, OperatorXBase* parent);

    ~ExchangeLocalState() override;

    Status init(RuntimeState* state, LocalStateInfo& info) override;
    Status open(RuntimeState* state) override;
    Status close(RuntimeState* state) override;
    std::string debug_string(int indentation_level) const override;

    Status reset(RuntimeState* state) {
        if (stream_recvr) {
            stream_recvr->close();
        }
        create_stream_recvr(state);

        is_ready = false;
        num_rows_skipped = 0;

        const auto& queues = stream_recvr->sender_queues();
        for (size_t i = 0; i < queues.size(); i++) {
            deps[i]->block();
            queues[i]->set_dependency(deps[i]);
        }
        return Status::OK();
    }

    std::vector<Dependency*> dependencies() const override {
        std::vector<Dependency*> dep_vec;
        std::for_each(deps.begin(), deps.end(),
                      [&](std::shared_ptr<Dependency> dep) { dep_vec.push_back(dep.get()); });
        return dep_vec;
    }

    MOCK_FUNCTION void create_stream_recvr(RuntimeState* state);
    std::shared_ptr<doris::vectorized::VDataStreamRecvr> stream_recvr;
    doris::vectorized::VSortExecExprs vsort_exec_exprs;
    int64_t num_rows_skipped;
    bool is_ready;

    std::vector<std::shared_ptr<Dependency>> deps;

    std::vector<RuntimeProfile::Counter*> metrics;
    RuntimeProfile::Counter* get_data_from_recvr_timer = nullptr;
    RuntimeProfile::Counter* filter_timer = nullptr;
    RuntimeProfile::Counter* create_merger_timer = nullptr;
};

class ExchangeSourceOperatorX final : public OperatorX<ExchangeLocalState> {
public:
    ExchangeSourceOperatorX(ObjectPool* pool, const TPlanNode& tnode, int operator_id,
                            const DescriptorTbl& descs, int num_senders);
#ifdef BE_TEST
    ExchangeSourceOperatorX(int num_senders, bool is_merging, int offset)
            : _num_senders(num_senders),
              _is_merging(is_merging),
              _partition_type(TPartitionType::UNPARTITIONED),
              _offset(offset) {}
#endif
    Status init(const TPlanNode& tnode, RuntimeState* state) override;
    Status prepare(RuntimeState* state) override;

    Status reset(RuntimeState* state);

    Status get_block(RuntimeState* state, vectorized::Block* block, bool* eos) override;

    std::string debug_string(int indentation_level = 0) const override;

    Status close(RuntimeState* state) override;
    [[nodiscard]] bool is_source() const override { return true; }

    [[nodiscard]] int num_senders() const { return _num_senders; }
    [[nodiscard]] bool is_merging() const { return _is_merging; }

    DataDistribution required_data_distribution(RuntimeState* /*state*/) const override {
        if (OperatorX<ExchangeLocalState>::is_serial_operator()) {
            return {ExchangeType::NOOP};
        }
        return _partition_type == TPartitionType::HASH_PARTITIONED
                       ? DataDistribution(ExchangeType::HASH_SHUFFLE)
               : _partition_type == TPartitionType::BUCKET_SHFFULE_HASH_PARTITIONED
                       ? DataDistribution(ExchangeType::BUCKET_HASH_SHUFFLE)
                       : DataDistribution(ExchangeType::NOOP);
    }

private:
    friend class ExchangeLocalState;
    const int _num_senders;
    const bool _is_merging;
    const TPartitionType::type _partition_type;

    // use in merge sort
    size_t _offset;
    doris::vectorized::VSortExecExprs _vsort_exec_exprs;
    std::vector<bool> _is_asc_order;
    std::vector<bool> _nulls_first;
};

#include "common/compile_check_end.h"
} // namespace doris::pipeline