// 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 <butil/macros.h>

#include <gen_cpp/Types_types.h>

#include <gen_cpp/types.pb.h>

#include <stddef.h>

#include <stdint.h>

#include <boost/container/detail/std_fwd.hpp>

#include <map>

#include <memory>

#include <mutex>

#include <set>

#include <shared_mutex>

#include <unordered_map>

#include <unordered_set>

#include <utility>

#include <vector>

#include "common/status.h"

#include "core/block/block.h"

#include "runtime/memory/lru_cache_policy.h"

#include "storage/olap_common.h"

#include "storage/rowset/pending_rowset_helper.h"

#include "storage/rowset/rowset.h"

#include "storage/rowset/rowset_meta.h"

#include "storage/segment/segment.h"

#include "storage/segment/segment_writer.h"

#include "storage/tablet/tablet.h"

#include "storage/tablet/tablet_meta.h"

#include "util/time.h"

namespace doris {

class OlapMeta;

struct TabletPublishStatistics;

struct PartialUpdateInfo;

enum class TxnState {

    NOT_FOUND = 0,

    PREPARED = 1,

    COMMITTED = 2,

    ROLLEDBACK = 3,

    ABORTED = 4,

    DELETED = 5,

};

enum class PublishStatus { INIT = 0, PREPARE = 1, SUCCEED = 2 };

// The row binlog rowset and its independent binlog tablet, carried through commit and publish.

struct RowBinlogTxnInfo {

    RowsetSharedPtr rowset;

    BaseTabletSPtr tablet;

    // Delete bitmap deltas that should be applied to the independent binlog tablet.

    DeleteBitmapPtr delete_bitmap;

};

struct TxnPublishInfo {

    int64_t publish_version {-1};

    int64_t base_compaction_cnt {-1};

    int64_t cumulative_compaction_cnt {-1};

    int64_t cumulative_point {-1};

};

struct TabletTxnInfo {

    PUniqueId load_id;

    RowsetSharedPtr rowset;

    // the row binlog committed along with this txn.

    RowBinlogTxnInfo attach_row_binlog;

    PendingRowsetGuard pending_rs_guard;

    bool unique_key_merge_on_write {false};

    DeleteBitmapPtr delete_bitmap;

    // records rowsets calc in commit txn

    RowsetIdUnorderedSet rowset_ids;

    int64_t creation_time;

    bool ingest {false};

    std::shared_ptr<PartialUpdateInfo> partial_update_info;

    // for cloud only, used to determine if a retry CloudTabletCalcDeleteBitmapTask

    // needs to re-calculate the delete bitmap

    std::shared_ptr<PublishStatus> publish_status;

    TxnPublishInfo publish_info;

    // for cloud only, used to calculate delete bitmap for txn load

    bool is_txn_load = false;

    std::vector<RowsetSharedPtr> invisible_rowsets;

    int64_t lock_id;

    int64_t next_visible_version;

    TxnState state {TxnState::PREPARED};

    TabletTxnInfo() = default;

    TabletTxnInfo(PUniqueId load_id, RowsetSharedPtr rowset)

            : load_id(std::move(load_id)),

              rowset(std::move(rowset)),

              creation_time(UnixSeconds()) {}

    TabletTxnInfo(PUniqueId load_id, RowsetSharedPtr rowset, bool ingest_arg)

            : load_id(std::move(load_id)),

              rowset(std::move(rowset)),

              creation_time(UnixSeconds()),

              ingest(ingest_arg) {}

    TabletTxnInfo(PUniqueId load_id, RowsetSharedPtr rowset, bool merge_on_write,

                  DeleteBitmapPtr delete_bitmap, RowsetIdUnorderedSet ids)

            : load_id(std::move(load_id)),

              rowset(std::move(rowset)),

              unique_key_merge_on_write(merge_on_write),

              delete_bitmap(std::move(delete_bitmap)),

              rowset_ids(std::move(ids)),

              creation_time(UnixSeconds()) {}

    void prepare() { state = TxnState::PREPARED; }

    void commit() { state = TxnState::COMMITTED; }

    void rollback() { state = TxnState::ROLLEDBACK; }

    void abort() {

        if (state == TxnState::PREPARED) {

            state = TxnState::ABORTED;

        }

    }

};

struct CommitTabletTxnInfo {

    TTransactionId transaction_id {0};

    TPartitionId partition_id {0};

    DeleteBitmapPtr delete_bitmap;

    RowsetIdUnorderedSet rowset_ids;

    std::shared_ptr<PartialUpdateInfo> partial_update_info;

};

using CommitTabletTxnInfoVec = std::vector<CommitTabletTxnInfo>;

// txn manager is used to manage mapping between tablet and txns

class TxnManager {

public:

    TxnManager(StorageEngine& engine, int32_t txn_map_shard_size, int32_t txn_shard_size);

    ~TxnManager() {

        delete[] _txn_tablet_maps;

        delete[] _txn_partition_maps;

        delete[] _txn_map_locks;

        delete[] _txn_mutex;

    }

    class CacheValue : public LRUCacheValueBase {

    public:

        int64_t value;

    };

    // add a txn to manager

    // partition id is useful in publish version stage because version is associated with partition

    Status prepare_txn(TPartitionId partition_id, const Tablet& tablet,

                       TTransactionId transaction_id, const PUniqueId& load_id,

                       bool is_ingest = false);

    // most used for ut

    Status prepare_txn(TPartitionId partition_id, TTransactionId transaction_id,

                       TTabletId tablet_id, TabletUid tablet_uid, const PUniqueId& load_id,

                       bool is_ingest = false);

    Status commit_txn(TPartitionId partition_id, const Tablet& tablet,

                      TTransactionId transaction_id, const PUniqueId& load_id,

                      const RowsetSharedPtr& rowset_ptr, PendingRowsetGuard guard, bool is_recovery,

                      std::shared_ptr<PartialUpdateInfo> partial_update_info = nullptr,

                      const RowBinlogTxnInfo& attach_row_binlog = {});

    Status publish_txn(TPartitionId partition_id, const TabletSharedPtr& tablet,

                       TTransactionId transaction_id, const Version& version,

                       TabletPublishStatistics* stats,

                       std::shared_ptr<TabletTxnInfo>& extend_tablet_txn_info,

                       const int64_t commit_tso = -1);

    // delete the txn from manager if it is not committed(not have a valid rowset)

    Status rollback_txn(TPartitionId partition_id, const Tablet& tablet,

                        TTransactionId transaction_id);

    Status delete_txn(TPartitionId partition_id, const TabletSharedPtr& tablet,

                      TTransactionId transaction_id);

    Status commit_txn(OlapMeta* meta, TPartitionId partition_id, TTransactionId transaction_id,

                      TTabletId tablet_id, TabletUid tablet_uid, const PUniqueId& load_id,

                      const RowsetSharedPtr& rowset_ptr, PendingRowsetGuard guard, bool is_recovery,

                      std::shared_ptr<PartialUpdateInfo> partial_update_info = nullptr,

                      const RowBinlogTxnInfo& attach_row_binlog = {});

    // remove a txn from txn manager

    // not persist rowset meta because

    Status publish_txn(OlapMeta* meta, TPartitionId partition_id, TTransactionId transaction_id,

                       TTabletId tablet_id, TabletUid tablet_uid, const Version& version,

                       TabletPublishStatistics* stats,

                       std::shared_ptr<TabletTxnInfo>& extend_tablet_txn_info,

                       const int64_t commit_tso = -1);

    // only abort not committed txn

    void abort_txn(TPartitionId partition_id, TTransactionId transaction_id, TTabletId tablet_id,

                   TabletUid tablet_uid);

    // delete the txn from manager if it is not committed(not have a valid rowset)

    Status rollback_txn(TPartitionId partition_id, TTransactionId transaction_id,

                        TTabletId tablet_id, TabletUid tablet_uid);

    // remove the txn from txn manager

    // delete the related rowset if it is not null

    // delete rowset related data if it is not null

    Status delete_txn(OlapMeta* meta, TPartitionId partition_id, TTransactionId transaction_id,

                      TTabletId tablet_id, TabletUid tablet_uid);

    void get_tablet_related_txns(TTabletId tablet_id, TabletUid tablet_uid, int64_t* partition_id,

                                 std::set<int64_t>* transaction_ids);

    void get_txn_related_tablets(

            const TTransactionId transaction_id, TPartitionId partition_ids,

            std::map<TabletInfo, RowsetSharedPtr>* tablet_infos,

            std::map<TabletInfo, std::shared_ptr<TabletTxnInfo>>* tablet_txn_infos = nullptr);

    void get_all_related_tablets(std::set<TabletInfo>* tablet_infos);

    // Get all expired txns and save them in expire_txn_map.

    // This is currently called before reporting all tablet info, to avoid iterating txn map for every tablets.

    void build_expire_txn_map(std::map<TabletInfo, std::vector<int64_t>>* expire_txn_map);

    void force_rollback_tablet_related_txns(OlapMeta* meta, TTabletId tablet_id,

                                            TabletUid tablet_uid);

    void get_partition_ids(const TTransactionId transaction_id,

                           std::vector<TPartitionId>* partition_ids);

    void set_txn_related_delete_bitmap(TPartitionId partition_id, TTransactionId transaction_id,

                                       TTabletId tablet_id, TabletUid tablet_uid,

                                       bool unique_key_merge_on_write,

                                       DeleteBitmapPtr delete_bitmap,

                                       const RowsetIdUnorderedSet& rowset_ids,

                                       std::shared_ptr<PartialUpdateInfo> partial_update_info);

    void get_all_commit_tablet_txn_info_by_tablet(

            const Tablet& tablet, CommitTabletTxnInfoVec* commit_tablet_txn_info_vec);

    int64_t get_txn_by_tablet_version(int64_t tablet_id, int64_t version);

    void update_tablet_version_txn(int64_t tablet_id, int64_t version, int64_t txn_id);

    TxnState get_txn_state(TPartitionId partition_id, TTransactionId transaction_id,

                           TTabletId tablet_id, TabletUid tablet_uid);

    void remove_txn_tablet_info(TPartitionId partition_id, TTransactionId transaction_id,

                                TTabletId tablet_id, TabletUid tablet_uid);

private:

    using TxnKey = std::pair<int64_t, int64_t>; // partition_id, transaction_id;

    // Implement TxnKey hash function to support TxnKey as a key for `unordered_map`.

    struct TxnKeyHash {

        template <typename T, typename U>

        size_t operator()(const std::pair<T, U>& e) const {

            return std::hash<T>()(e.first) ^ std::hash<U>()(e.second);

        }

    };

    // Implement TxnKey equal function to support TxnKey as a key for `unordered_map`.

    struct TxnKeyEqual {

        template <class T, typename U>

        bool operator()(const std::pair<T, U>& l, const std::pair<T, U>& r) const {

            return l.first == r.first && l.second == r.second;

        }

    };

    using txn_tablet_map_t =

            std::unordered_map<TxnKey, std::map<TabletInfo, std::shared_ptr<TabletTxnInfo>>,

                               TxnKeyHash, TxnKeyEqual>;

    using txn_partition_map_t = std::unordered_map<int64_t, std::unordered_set<int64_t>>;

    std::shared_mutex& _get_txn_map_lock(TTransactionId transactionId);

    txn_tablet_map_t& _get_txn_tablet_map(TTransactionId transactionId);

    txn_partition_map_t& _get_txn_partition_map(TTransactionId transactionId);

    inline std::shared_mutex& _get_txn_lock(TTransactionId transactionId);

    // Insert or remove (transaction_id, partition_id) from _txn_partition_map

    // get _txn_map_lock before calling.

    void _insert_txn_partition_map_unlocked(int64_t transaction_id, int64_t partition_id);

    void _clear_txn_partition_map_unlocked(int64_t transaction_id, int64_t partition_id);

    void _remove_txn_tablet_info_unlocked(TPartitionId partition_id, TTransactionId transaction_id,

                                          TTabletId tablet_id, TabletUid tablet_uid,

                                          std::lock_guard<std::shared_mutex>& txn_lock,

                                          std::lock_guard<std::shared_mutex>& wrlock);

    class TabletVersionCache : public LRUCachePolicy {

    public:

        TabletVersionCache(size_t capacity)

                : LRUCachePolicy(CachePolicy::CacheType::TABLET_VERSION_CACHE, capacity,

                                 LRUCacheType::NUMBER, /*sweeptime*/ -1,

                                 /*num_shards*/ 32,

                                 /*element_count_capacity*/ 0, /*enable_prune*/ false,

                                 /*is_lru_k*/ false) {}

    };

private:

    StorageEngine& _engine;

    const int32_t _txn_map_shard_size;

    const int32_t _txn_shard_size;

    // _txn_map_locks[i] protect _txn_tablet_maps[i], i=0,1,2...,and i < _txn_map_shard_size

    txn_tablet_map_t* _txn_tablet_maps = nullptr;

    // transaction_id -> corresponding partition ids

    // This is mainly for the clear txn task received from FE, which may only has transaction id,

    // so we need this map to find out which partitions are corresponding to a transaction id.

    // The _txn_partition_maps[i] should be constructed/deconstructed/modified alongside with '_txn_tablet_maps[i]'

    txn_partition_map_t* _txn_partition_maps = nullptr;

    std::shared_mutex* _txn_map_locks = nullptr;

    std::shared_mutex* _txn_mutex = nullptr;

    std::unique_ptr<TabletVersionCache> _tablet_version_cache;

    DISALLOW_COPY_AND_ASSIGN(TxnManager);

}; // TxnManager

inline std::shared_mutex& TxnManager::_get_txn_map_lock(TTransactionId transactionId) {

    return _txn_map_locks[transactionId & (_txn_map_shard_size - 1)];

}

inline TxnManager::txn_tablet_map_t& TxnManager::_get_txn_tablet_map(TTransactionId transactionId) {

    return _txn_tablet_maps[transactionId & (_txn_map_shard_size - 1)];

}

inline TxnManager::txn_partition_map_t& TxnManager::_get_txn_partition_map(

        TTransactionId transactionId) {

    return _txn_partition_maps[transactionId & (_txn_map_shard_size - 1)];

}

inline std::shared_mutex& TxnManager::_get_txn_lock(TTransactionId transactionId) {

    return _txn_mutex[transactionId & (_txn_shard_size - 1)];

}

} // namespace doris