// 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 <gen_cpp/internal_service.pb.h>

#include <condition_variable>

#include <functional>

#include <map>

#include <memory>

#include <mutex>

#include <semaphore>

#include <string>

#include <utility>

#include <vector>

#include "common/status.h"

#include "core/block/block.h"

#include "core/data_type/data_type.h"

#include "storage/id_manager.h"

#include "storage/tablet/tablet_schema.h"

namespace doris {

class RuntimeProfile;

class RuntimeState;

class TQueryOptions;

class TupleDescriptor;

class ScannerScheduler;

namespace io {

enum class FileCacheMissPolicy : uint8_t;

}

struct FileMapping;

struct SegKey;

struct SegItem;

struct HashOfSegKey;

struct IteratorKey;

struct IteratorItem;

struct HashOfIteratorKey;

class MutableBlock;

struct RowStoreReadStruct {

    RowStoreReadStruct(std::string& buffer) : row_store_buffer(buffer) {};

    std::string& row_store_buffer;

    DataTypeSerDeSPtrs serdes;

    std::unordered_map<uint32_t, uint32_t> col_uid_to_idx;

    std::vector<std::string> default_values;

};

class RowIdStorageReader {

public:

    //external profile info key.

    static const std::string ScannersRunningTimeProfile;

    static const std::string InitReaderAvgTimeProfile;

    static const std::string GetBlockAvgTimeProfile;

    static const std::string FileReadLinesProfile;

    static const std::string LanceDatasetOpenTimeProfile;

    static const std::string LanceRowIdTakeReadTimeProfile;

    static const std::string LanceArrowToDorisBlockTimeProfile;

    static const std::string LanceRowIdFetchTotalTimeProfile;

    static const std::map<std::string, TUnit::type> LanceFetchCountersProfile;

    static const std::string TopNLazyMaterializationSecondPhaseLocalIOCount;

    static const std::string TopNLazyMaterializationSecondPhaseLocalIOBytes;

    static const std::string TopNLazyMaterializationSecondPhaseRemoteIOCount;

    static const std::string TopNLazyMaterializationSecondPhaseRemoteIOBytes;

    static const std::string TopNLazyMaterializationSecondPhaseSkipCacheIOCount;

    static const std::string TopNLazyMaterializationSecondPhaseWriteCacheBytes;

    static const std::string TopNLazyMaterializationSecondPhaseLocalIOTime;

    static const std::string TopNLazyMaterializationSecondPhaseRemoteIOTime;

    static const std::string TopNLazyMaterializationSecondPhaseWriteCacheIOTime;

    static const std::string TopNLazyMaterializationSecondPhaseRowsRead;

    static const std::string TopNLazyMaterializationSecondPhaseSegmentsRead;

    static Status read_by_rowids(const PMultiGetRequestV2& request, PMultiGetResponseV2* response);

    // Runs read_by_rowids() for the multiget_data_v2 RPC and serializes the outcome into the

    // response status. The remote scan scheduler runs the RPC callback on a plain ThreadPool

    // worker, which has no exception boundary of its own, so a doris::Exception thrown while

    // reading (for example by a slot of the request whose PTypeNode this BE does not know) is

    // converted into an error status here instead of terminating the process.

    static void read_by_rowids_for_rpc(const PMultiGetRequestV2& request,

                                       PMultiGetResponseV2* response);

private:

    static bool should_use_file_scanner_v2(const TQueryOptions& query_options,

                                           const TFileScanRangeParams& scan_params,

                                           const TFileRangeDesc& range);

    struct ExternalFetchStatistics;

    static Status read_doris_format_row(

            const std::shared_ptr<IdFileMap>& id_file_map,

            const std::shared_ptr<FileMapping>& file_mapping, const std::vector<uint32_t>& row_id,

            std::vector<SlotDescriptor>& slots, const std::vector<TabletColumn>& fetch_columns,

            RowStoreReadStruct& row_store_read_struct, OlapReaderStatistics& stats,

            int64_t* acquire_tablet_ms, int64_t* acquire_rowsets_ms, int64_t* acquire_segments_ms,

            int64_t* lookup_row_data_ms, std::unordered_map<SegKey, SegItem, HashOfSegKey>& seg_map,

            std::unordered_map<IteratorKey, IteratorItem, HashOfIteratorKey>& iterator_map,

            io::FileCacheMissPolicy file_cache_miss_policy, Block& result_block);

    static Status read_batch_doris_format_row(

            const PRequestBlockDesc& request_block_desc, std::shared_ptr<IdFileMap> id_file_map,

            std::vector<SlotDescriptor>& slots, const TUniqueId& query_id, Block& result_block,

            OlapReaderStatistics& stats, int64_t* acquire_tablet_ms, int64_t* acquire_rowsets_ms,

            int64_t* acquire_segments_ms, int64_t* lookup_row_data_ms,

            io::FileCacheMissPolicy file_cache_miss_policy);

    static Status read_batch_external_row(

            const uint64_t workload_group_id, const PRequestBlockDesc& request_block_desc,

            std::shared_ptr<IdFileMap> id_file_map, std::vector<SlotDescriptor>& slots,

            std::shared_ptr<FileMapping> first_file_mapping, const TUniqueId& query_id,

            Block& result_block, PRuntimeProfileTree* pprofile, int64_t* init_reader_avg_ms,

            int64_t* get_block_avg_ms, size_t* scan_range_cnt);

    static Status read_lance_rows_by_row_ids(const TFileRangeDesc& scan_range_desc,

                                             const std::vector<uint64_t>& row_ids,

                                             const std::vector<SlotDescriptor>& slots,

                                             RuntimeState* runtime_state,

                                             RuntimeProfile* runtime_profile,

                                             const TFileScanRangeParams& scan_params, Block* block,

                                             ExternalFetchStatistics* fetch_statistics);

    static Status read_external_row_from_file_mapping(

            size_t idx, const std::multimap<uint64_t, size_t>& row_ids,

            const std::shared_ptr<FileMapping>& file_mapping,

            const std::vector<SlotDescriptor>& scan_slots, const TUniqueId& query_id,

            const std::shared_ptr<RuntimeState>& runtime_state, std::vector<Block>& scan_blocks,

            std::vector<std::pair<size_t, size_t>>& row_id_block_idx,

            std::vector<ExternalFetchStatistics>& fetch_statistics,

            const TFileScanRangeParams& rpc_scan_params,

            const std::unordered_map<std::string, int>& colname_to_slot_id,

            std::counting_semaphore<>& semaphore, TupleDescriptor& tuple_desc);

    static TFileRangeDesc build_external_fetch_range(const TFileRangeDesc& source_range);

    static TFileScanRangeParams build_external_scan_params(

            const TFileScanRangeParams& source_params, const TFileRangeDesc& range,

            const std::vector<SlotDescriptor>& scan_slots,

            const std::vector<uint32_t>& scan_column_idxs);

    static std::string source_column_key(const SlotDescriptor& slot, uint32_t column_idx);

    friend class RowIdStorageReaderTest;

    static Status submit_external_scan_tasks(ScannerScheduler* scheduler,

                                             std::counting_semaphore<>& semaphore,

                                             size_t task_count,

                                             const std::function<std::string(size_t)>& make_task_id,

                                             const std::function<Status(size_t)>& run_task);

    // Reports InitReaderAvgTime and GetBlockAvgTime of one request block: the mean reader-init

    // and block-read times over its scan ranges, e.g. 20ms and 200ms for two ranges that took

    // 10/100 ms and 30/300 ms. Both outputs are overwritten rather than accumulated, because an

    // RPC that fetches two lazily materialized tables reads its two request blocks into the same

    // caller variables.

    static void add_external_fetch_avg_time_profile(

            const std::vector<ExternalFetchStatistics>& fetch_statistics,

            RuntimeProfile* runtime_profile, int64_t* init_reader_avg_ms,

            int64_t* get_block_avg_ms);

    struct ExternalFetchStatistics {

        int64_t init_reader_ms = 0;

        int64_t get_block_ms = 0;

        std::map<std::string, int64_t> lance_fetch_times_ns;

        std::map<std::string, int64_t> lance_fetch_counters;

        std::string file_read_bytes;

        std::string file_read_times;

    };

};

template <typename Func>

auto scope_timer_run(Func fn, int64_t* cost) -> decltype(fn()) {

    MonotonicStopWatch watch;

    watch.start();

    auto res = fn();

    *cost += watch.elapsed_time() / 1000 / 1000;

    return res;

}

unity_9_cxx.cxx:_ZN5doris15scope_timer_runIZNS_11FileScanner21read_lines_from_rangeERKNS_14TFileRangeDescERKNSt7__cxx114listIlSaIlEEEPNS_5BlockERKNS_23ExternalFileMappingInfoEPlSG_E3$_0EEDTclfp_EET_SG_

Line

Count

Source

188

26

auto scope_timer_run(Func fn, int64_t* cost) -> decltype(fn()) {

189

26

    MonotonicStopWatch watch;

190

26

    watch.start();

191

26

    auto res = fn();

192

26

    *cost += watch.elapsed_time() / 1000 / 1000;

193

26

    return res;

194

26

}

unity_9_cxx.cxx:_ZN5doris15scope_timer_runIZNS_11FileScanner21read_lines_from_rangeERKNS_14TFileRangeDescERKNSt7__cxx114listIlSaIlEEEPNS_5BlockERKNS_23ExternalFileMappingInfoEPlSG_E3$_1EEDTclfp_EET_SG_

Line

Count

Source

188

26

auto scope_timer_run(Func fn, int64_t* cost) -> decltype(fn()) {

189

26

    MonotonicStopWatch watch;

190

26

    watch.start();

191

26

    auto res = fn();

192

26

    *cost += watch.elapsed_time() / 1000 / 1000;

193

26

    return res;

194

26

}

Unexecuted instantiation: unity_8_cxx.cxx:_ZN5doris15scope_timer_runIZNS_18RowIdStorageReader26read_lance_rows_by_row_idsERKNS_14TFileRangeDescERKSt6vectorImSaImEERKS5_INS_14SlotDescriptorESaISA_EEPNS_12RuntimeStateEPNS_14RuntimeProfileERKNS_20TFileScanRangeParamsEPNS_5BlockEPNS1_23ExternalFetchStatisticsEE3$_0EEDTclfp_EET_Pl

Unexecuted instantiation: unity_8_cxx.cxx:_ZN5doris15scope_timer_runIZNS_18RowIdStorageReader26read_lance_rows_by_row_idsERKNS_14TFileRangeDescERKSt6vectorImSaImEERKS5_INS_14SlotDescriptorESaISA_EEPNS_12RuntimeStateEPNS_14RuntimeProfileERKNS_20TFileScanRangeParamsEPNS_5BlockEPNS1_23ExternalFetchStatisticsEE3$_1EEDTclfp_EET_Pl

Unexecuted instantiation: unity_8_cxx.cxx:_ZN5doris15scope_timer_runIZNS_18RowIdStorageReader23read_batch_external_rowEmRKNS_17PRequestBlockDescESt10shared_ptrINS_9IdFileMapEERSt6vectorINS_14SlotDescriptorESaIS9_EES5_INS_11FileMappingEERKNS_9TUniqueIdERNS_5BlockEPNS_19PRuntimeProfileTreeEPlSM_PmE3$_0EEDTclfp_EET_SM_

Unexecuted instantiation: unity_8_cxx.cxx:_ZN5doris15scope_timer_runIZNS_18RowIdStorageReader21read_doris_format_rowERKSt10shared_ptrINS_9IdFileMapEERKS2_INS_11FileMappingEERKSt6vectorIjSaIjEERSB_INS_14SlotDescriptorESaISG_EERKSB_INS_12TabletColumnESaISK_EERNS_18RowStoreReadStructERNS_20OlapReaderStatisticsEPlST_ST_ST_RSt13unordered_mapINS_6SegKeyENS_7SegItemENS_12HashOfSegKeyESt8equal_toISV_ESaISt4pairIKSV_SW_EEERSU_INS_11IteratorKeyENS_12IteratorItemENS_17HashOfIteratorKeyESY_IS16_ESaIS10_IKS16_S17_EEENS_2io19FileCacheMissPolicyERNS_5BlockEE3$_1EEDTclfp_EET_ST_

Unexecuted instantiation: unity_8_cxx.cxx:_ZN5doris15scope_timer_runIZNS_18RowIdStorageReader21read_doris_format_rowERKSt10shared_ptrINS_9IdFileMapEERKS2_INS_11FileMappingEERKSt6vectorIjSaIjEERSB_INS_14SlotDescriptorESaISG_EERKSB_INS_12TabletColumnESaISK_EERNS_18RowStoreReadStructERNS_20OlapReaderStatisticsEPlST_ST_ST_RSt13unordered_mapINS_6SegKeyENS_7SegItemENS_12HashOfSegKeyESt8equal_toISV_ESaISt4pairIKSV_SW_EEERSU_INS_11IteratorKeyENS_12IteratorItemENS_17HashOfIteratorKeyESY_IS16_ESaIS10_IKS16_S17_EEENS_2io19FileCacheMissPolicyERNS_5BlockEE3$_2EEDTclfp_EET_ST_

Unexecuted instantiation: unity_8_cxx.cxx:_ZN5doris15scope_timer_runIZNS_18RowIdStorageReader21read_doris_format_rowERKSt10shared_ptrINS_9IdFileMapEERKS2_INS_11FileMappingEERKSt6vectorIjSaIjEERSB_INS_14SlotDescriptorESaISG_EERKSB_INS_12TabletColumnESaISK_EERNS_18RowStoreReadStructERNS_20OlapReaderStatisticsEPlST_ST_ST_RSt13unordered_mapINS_6SegKeyENS_7SegItemENS_12HashOfSegKeyESt8equal_toISV_ESaISt4pairIKSV_SW_EEERSU_INS_11IteratorKeyENS_12IteratorItemENS_17HashOfIteratorKeyESY_IS16_ESaIS10_IKS16_S17_EEENS_2io19FileCacheMissPolicyERNS_5BlockEE3$_3EEDTclfp_EET_ST_

Unexecuted instantiation: unity_8_cxx.cxx:_ZN5doris15scope_timer_runIZNS_18RowIdStorageReader21read_doris_format_rowERKSt10shared_ptrINS_9IdFileMapEERKS2_INS_11FileMappingEERKSt6vectorIjSaIjEERSB_INS_14SlotDescriptorESaISG_EERKSB_INS_12TabletColumnESaISK_EERNS_18RowStoreReadStructERNS_20OlapReaderStatisticsEPlST_ST_ST_RSt13unordered_mapINS_6SegKeyENS_7SegItemENS_12HashOfSegKeyESt8equal_toISV_ESaISt4pairIKSV_SW_EEERSU_INS_11IteratorKeyENS_12IteratorItemENS_17HashOfIteratorKeyESY_IS16_ESaIS10_IKS16_S17_EEENS_2io19FileCacheMissPolicyERNS_5BlockEE3$_4EEDTclfp_EET_ST_

} // namespace doris