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

#include <gen_cpp/olap_file.pb.h>

#include <stdint.h>

#include <atomic>

#include <cstddef>

#include <limits>

#include <map>

#include <memory>

#include <mutex>

#include <optional>

#include <ostream>

#include <roaring/roaring.hh>

#include <shared_mutex>

#include <string>

#include <tuple>

#include <unordered_map>

#include <utility>

#include <vector>

#include "common/logging.h"

#include "common/status.h"

#include "gutil/stringprintf.h"

#include "io/fs/file_system.h"

#include "olap/binlog_config.h"

#include "olap/lru_cache.h"

#include "olap/metadata_adder.h"

#include "olap/olap_common.h"

#include "olap/rowset/rowset_meta.h"

#include "olap/tablet_schema.h"

#include "runtime/memory/lru_cache_policy.h"

#include "util/uid_util.h"

namespace json2pb {

struct Pb2JsonOptions;

} // namespace json2pb

namespace doris {

class TColumn;

// Lifecycle states that a Tablet can be in. Legal state transitions for a

// Tablet object:

//

//   NOTREADY -> RUNNING -> TOMBSTONED -> STOPPED -> SHUTDOWN

//      |           |            |          ^^^

//      |           |            +----------++|

//      |           +------------------------+|

//      +-------------------------------------+

enum TabletState {

    // Tablet is under alter table, rollup, clone

    TABLET_NOTREADY,

    TABLET_RUNNING,

    // Tablet integrity has been violated, such as missing versions.

    // In this state, tablet will not accept any incoming request.

    // Report this state to FE, scheduling BE to drop tablet.

    TABLET_TOMBSTONED,

    // Tablet is shutting down, files in disk still remained.

    TABLET_STOPPED,

    // Files have been removed, tablet has been shutdown completely.

    TABLET_SHUTDOWN

};

class DataDir;

class TabletMeta;

class DeleteBitmap;

class TBinlogConfig;

// Class encapsulates meta of tablet.

// The concurrency control is handled in Tablet Class, not in this class.

class TabletMeta : public MetadataAdder<TabletMeta> {

public:

    static TabletMetaSharedPtr create(

            const TCreateTabletReq& request, const TabletUid& tablet_uid, uint64_t shard_id,

            uint32_t next_unique_id,

            const std::unordered_map<uint32_t, uint32_t>& col_ordinal_to_unique_id);

    TabletMeta();

    ~TabletMeta() override;

    TabletMeta(int64_t table_id, int64_t partition_id, int64_t tablet_id, int64_t replica_id,

               int32_t schema_hash, uint64_t shard_id, const TTabletSchema& tablet_schema,

               uint32_t next_unique_id,

               const std::unordered_map<uint32_t, uint32_t>& col_ordinal_to_unique_id,

               TabletUid tablet_uid, TTabletType::type tabletType,

               TCompressionType::type compression_type, int64_t storage_policy_id = 0,

               bool enable_unique_key_merge_on_write = false,

               std::optional<TBinlogConfig> binlog_config = {},

               std::string compaction_policy = "size_based",

               int64_t time_series_compaction_goal_size_mbytes = 1024,

               int64_t time_series_compaction_file_count_threshold = 2000,

               int64_t time_series_compaction_time_threshold_seconds = 3600,

               int64_t time_series_compaction_empty_rowsets_threshold = 5,

               TInvertedIndexStorageFormat::type inverted_index_storage_format =

                       TInvertedIndexStorageFormat::V1,

               int64_t time_series_compaction_level_threshold = 1);

    // If need add a filed in TableMeta, filed init copy in copy construct function

    TabletMeta(const TabletMeta& tablet_meta);

    TabletMeta(TabletMeta&& tablet_meta) = delete;

// UT

#ifdef BE_TEST

    TabletMeta(TabletSchemaSPtr tablet_schema) : _schema(tablet_schema) {}

#endif

    // Function create_from_file is used to be compatible with previous tablet_meta.

    // Previous tablet_meta is a physical file in tablet dir, which is not stored in rocksdb.

    Status create_from_file(const std::string& file_path);

    Status save(const std::string& file_path);

    Status save_as_json(const string& file_path, DataDir* dir);

    static Status save(const std::string& file_path, const TabletMetaPB& tablet_meta_pb);

    static std::string construct_header_file_path(const std::string& schema_hash_path,

                                                  int64_t tablet_id);

    Status save_meta(DataDir* data_dir);

    void serialize(std::string* meta_binary);

    Status deserialize(const std::string& meta_binary);

    void init_from_pb(const TabletMetaPB& tablet_meta_pb);

    // Init `RowsetMeta._fs` if rowset is local.

    void init_rs_metas_fs(const io::FileSystemSPtr& fs);

    void to_meta_pb(TabletMetaPB* tablet_meta_pb);

    void to_json(std::string* json_string, json2pb::Pb2JsonOptions& options);

    // Don't use.

    // TODO: memory size of TabletSchema cannot be accurately tracked.

    // In some places, temporarily use num_columns() as TabletSchema size.

    int64_t mem_size() const;

    size_t tablet_columns_num() const { return _schema->num_columns(); }

    TabletTypePB tablet_type() const { return _tablet_type; }

    TabletUid tablet_uid() const;

    void set_tablet_uid(TabletUid uid) { _tablet_uid = uid; }

    int64_t table_id() const;

    int64_t partition_id() const;

    int64_t tablet_id() const;

    int64_t replica_id() const;

    void set_replica_id(int64_t replica_id) { _replica_id = replica_id; }

    int32_t schema_hash() const;

    int16_t shard_id() const;

    void set_shard_id(int32_t shard_id);

    int64_t creation_time() const;

    void set_creation_time(int64_t creation_time);

    int64_t cumulative_layer_point() const;

    void set_cumulative_layer_point(int64_t new_point);

    size_t num_rows() const;

    // Disk space occupied by tablet, contain local and remote.

    size_t tablet_footprint() const;

    // Local disk space occupied by tablet.

    size_t tablet_local_size() const;

    // Remote disk space occupied by tablet.

    size_t tablet_remote_size() const;

    size_t version_count() const;

    size_t stale_version_count() const;

    size_t version_count_cross_with_range(const Version& range) const;

    Version max_version() const;

    TabletState tablet_state() const;

    void set_tablet_state(TabletState state);

    bool in_restore_mode() const;

    void set_in_restore_mode(bool in_restore_mode);

    const TabletSchemaSPtr& tablet_schema() const;

    TabletSchema* mutable_tablet_schema();

    const std::vector<RowsetMetaSharedPtr>& all_rs_metas() const;

    std::vector<RowsetMetaSharedPtr>& all_mutable_rs_metas();

    Status add_rs_meta(const RowsetMetaSharedPtr& rs_meta);

    void delete_rs_meta_by_version(const Version& version,

                                   std::vector<RowsetMetaSharedPtr>* deleted_rs_metas);

    // If same_version is true, the rowset in "to_delete" will not be added

    // to _stale_rs_meta, but to be deleted from rs_meta directly.

    void modify_rs_metas(const std::vector<RowsetMetaSharedPtr>& to_add,

                         const std::vector<RowsetMetaSharedPtr>& to_delete,

                         bool same_version = false);

    void revise_rs_metas(std::vector<RowsetMetaSharedPtr>&& rs_metas);

    void revise_delete_bitmap_unlocked(const DeleteBitmap& delete_bitmap);

    const std::vector<RowsetMetaSharedPtr>& all_stale_rs_metas() const;

    RowsetMetaSharedPtr acquire_rs_meta_by_version(const Version& version) const;

    void delete_stale_rs_meta_by_version(const Version& version);

    RowsetMetaSharedPtr acquire_stale_rs_meta_by_version(const Version& version) const;

    Status set_partition_id(int64_t partition_id);

    RowsetTypePB preferred_rowset_type() const { return _preferred_rowset_type; }

    void set_preferred_rowset_type(RowsetTypePB preferred_rowset_type) {

        _preferred_rowset_type = preferred_rowset_type;

    }

    // used for after tablet cloned to clear stale rowset

    void clear_stale_rowset() { _stale_rs_metas.clear(); }

    bool all_beta() const;

    int64_t storage_policy_id() const { return _storage_policy_id; }

    void set_storage_policy_id(int64_t id) {

        VLOG_NOTICE << "set tablet_id : " << _table_id << " storage policy from "

                    << _storage_policy_id << " to " << id;

        _storage_policy_id = id;

    }

    UniqueId cooldown_meta_id() const { return _cooldown_meta_id; }

    void set_cooldown_meta_id(UniqueId uid) { _cooldown_meta_id = uid; }

    static void init_column_from_tcolumn(uint32_t unique_id, const TColumn& tcolumn,

                                         ColumnPB* column);

    DeleteBitmap& delete_bitmap() { return *_delete_bitmap; }

    bool enable_unique_key_merge_on_write() const { return _enable_unique_key_merge_on_write; }

    // TODO(Drogon): thread safety

    const BinlogConfig& binlog_config() const { return _binlog_config; }

    void set_binlog_config(BinlogConfig binlog_config) {

        _binlog_config = std::move(binlog_config);

    }

    void set_compaction_policy(std::string compaction_policy) {

        _compaction_policy = compaction_policy;

    }

    std::string compaction_policy() const { return _compaction_policy; }

    void set_time_series_compaction_goal_size_mbytes(int64_t goal_size_mbytes) {

        _time_series_compaction_goal_size_mbytes = goal_size_mbytes;

    }

    int64_t time_series_compaction_goal_size_mbytes() const {

        return _time_series_compaction_goal_size_mbytes;

    }

    void set_time_series_compaction_file_count_threshold(int64_t file_count_threshold) {

        _time_series_compaction_file_count_threshold = file_count_threshold;

    }

    int64_t time_series_compaction_file_count_threshold() const {

        return _time_series_compaction_file_count_threshold;

    }

    void set_time_series_compaction_time_threshold_seconds(int64_t time_threshold) {

        _time_series_compaction_time_threshold_seconds = time_threshold;

    }

    int64_t time_series_compaction_time_threshold_seconds() const {

        return _time_series_compaction_time_threshold_seconds;

    }

    void set_time_series_compaction_empty_rowsets_threshold(int64_t empty_rowsets_threshold) {

        _time_series_compaction_empty_rowsets_threshold = empty_rowsets_threshold;

    }

    int64_t time_series_compaction_empty_rowsets_threshold() const {

        return _time_series_compaction_empty_rowsets_threshold;

    }

    void set_time_series_compaction_level_threshold(int64_t level_threshold) {

        _time_series_compaction_level_threshold = level_threshold;

    }

    int64_t time_series_compaction_level_threshold() const {

        return _time_series_compaction_level_threshold;

    }

    int64_t avg_rs_meta_serialize_size() const { return _avg_rs_meta_serialize_size; }

private:

    Status _save_meta(DataDir* data_dir);

    // _del_predicates is ignored to compare.

    friend bool operator==(const TabletMeta& a, const TabletMeta& b);

    friend bool operator!=(const TabletMeta& a, const TabletMeta& b);

private:

    int64_t _table_id = 0;

    int64_t _partition_id = 0;

    int64_t _tablet_id = 0;

    int64_t _replica_id = 0;

    int32_t _schema_hash = 0;

    int32_t _shard_id = 0;

    int64_t _creation_time = 0;

    int64_t _cumulative_layer_point = 0;

    TabletUid _tablet_uid;

    TabletTypePB _tablet_type = TabletTypePB::TABLET_TYPE_DISK;

    TabletState _tablet_state = TABLET_NOTREADY;

    // the reference of _schema may use in tablet, so here need keep

    // the lifetime of tablemeta and _schema is same with tablet

    TabletSchemaSPtr _schema;

    Cache::Handle* _handle = nullptr;

    std::vector<RowsetMetaSharedPtr> _rs_metas;

    // This variable _stale_rs_metas is used to record these rowsets‘ meta which are be compacted.

    // These stale rowsets meta are been removed when rowsets' pathVersion is expired,

    // this policy is judged and computed by TimestampedVersionTracker.

    std::vector<RowsetMetaSharedPtr> _stale_rs_metas;

    bool _in_restore_mode = false;

    RowsetTypePB _preferred_rowset_type = BETA_ROWSET;

    // meta for cooldown

    int64_t _storage_policy_id = 0; // <= 0 means no storage policy

    UniqueId _cooldown_meta_id;

    // For unique key data model, the feature Merge-on-Write will leverage a primary

    // key index and a delete-bitmap to mark duplicate keys as deleted in load stage,

    // which can avoid the merging cost in read stage, and accelerate the aggregation

    // query performance significantly.

    bool _enable_unique_key_merge_on_write = false;

    std::shared_ptr<DeleteBitmap> _delete_bitmap;

    // binlog config

    BinlogConfig _binlog_config {};

    // meta for compaction

    std::string _compaction_policy;

    int64_t _time_series_compaction_goal_size_mbytes = 0;

    int64_t _time_series_compaction_file_count_threshold = 0;

    int64_t _time_series_compaction_time_threshold_seconds = 0;

    int64_t _time_series_compaction_empty_rowsets_threshold = 0;

    int64_t _time_series_compaction_level_threshold = 0;

    int64_t _avg_rs_meta_serialize_size = 0;

    mutable std::shared_mutex _meta_lock;

};

/**

 * Wraps multiple bitmaps for recording rows (row id) that are deleted or

 * overwritten. For now, it's only used when unique key merge-on-write property

 * enabled.

 *

 * RowsetId and SegmentId are for locating segment, Version here is a single

 * uint32_t means that at which "version" of the load causes the delete or

 * overwrite.

 *

 * The start and end version of a load is the same, it's ok and straightforward

 * to use a single uint32_t.

 *

 * e.g.

 * There is a key "key1" in rowset id 1, version [1,1], segment id 1, row id 1.

 * A new load also contains "key1", the rowset id 2, version [2,2], segment id 1

 * the delete bitmap will be `{1,1,2} -> 1`, which means the "row id 1" in

 * "rowset id 1, segment id 1" is deleted/overitten by some loads at "version 2"

 */

class DeleteBitmap {

public:

    mutable std::shared_mutex lock;

    using SegmentId = uint32_t;

    using Version = uint64_t;

    using BitmapKey = std::tuple<RowsetId, SegmentId, Version>;

    std::map<BitmapKey, roaring::Roaring> delete_bitmap; // Ordered map

    constexpr static inline uint32_t INVALID_SEGMENT_ID = std::numeric_limits<uint32_t>::max() - 1;

    constexpr static inline uint32_t ROWSET_SENTINEL_MARK =

            std::numeric_limits<uint32_t>::max() - 1;

    // When a delete bitmap is merged into tablet's delete bitmap, the version of entries in the delete bitmap

    // will be replaced to the correspoding correct version. So before we finally merge a delete bitmap into

    // tablet's delete bitmap we can use arbitary version number in BitmapKey. Here we define some version numbers

    // for specific usage during this periods to avoid conflicts

    constexpr static inline uint64_t TEMP_VERSION_COMMON = 0;

    /**

     * 

     * @param tablet_id the tablet which this delete bitmap associates with

     */

    DeleteBitmap(int64_t tablet_id);

    /**

     * Copy c-tor for making delete bitmap snapshot on read path

     */

    DeleteBitmap(const DeleteBitmap& r);

    DeleteBitmap& operator=(const DeleteBitmap& r);

    /**

     * Move c-tor for making delete bitmap snapshot on read path

     */

    DeleteBitmap(DeleteBitmap&& r);

    DeleteBitmap& operator=(DeleteBitmap&& r);

    /**

     * Makes a snapshot of delete bitmap, read lock will be acquired in this

     * process

     */

    DeleteBitmap snapshot() const;

    /**

     * Makes a snapshot of delete bitmap on given version, read lock will be

     * acquired temporary in this process

     */

    DeleteBitmap snapshot(Version version) const;

    /**

     * Marks the specific row deleted

     */

    void add(const BitmapKey& bmk, uint32_t row_id);

    /**

     * Clears the deletetion mark specific row

     *

     * @return non-zero if the associated delete bitmap does not exist

     */

    int remove(const BitmapKey& bmk, uint32_t row_id);

    /**

     * Clears bitmaps in range [lower_key, upper_key)

     */

    void remove(const BitmapKey& lower_key, const BitmapKey& upper_key);

    /**

     * Checks if the given row is marked deleted

     *

     * @return true if marked deleted

     */

    bool contains(const BitmapKey& bmk, uint32_t row_id) const;

    /**

     * Checks if this delete bitmap is empty

     *

     * @return true if empty

     */

    bool empty() const;

    /**

     * return the total cardinality of the Delete Bitmap

     */

    uint64_t cardinality() const;

    uint64_t get_delete_bitmap_count() const;

    /**

     * Sets the bitmap of specific segment, it's may be insertion or replacement

     *

     * @return 1 if the insertion took place, 0 if the assignment took place

     */

    int set(const BitmapKey& bmk, const roaring::Roaring& segment_delete_bitmap);

    /**

     * Gets a copy of specific delete bmk

     *

     * @param segment_delete_bitmap output param

     * @return non-zero if the associated delete bitmap does not exist

     */

    int get(const BitmapKey& bmk, roaring::Roaring* segment_delete_bitmap) const;

    /**

     * Gets reference to a specific delete map, DO NOT use this function on a

     * mutable DeleteBitmap object

     * @return nullptr if the given bitmap does not exist

     */

    const roaring::Roaring* get(const BitmapKey& bmk) const;

    /**

     * Gets subset of delete_bitmap with given range [start, end)

     *

     * @parma start start

     * @parma end end

     * @parma subset_delete_map output param

     */

    void subset(const BitmapKey& start, const BitmapKey& end,

                DeleteBitmap* subset_delete_map) const;

    /**

     * Merges the given segment delete bitmap into *this

     *

     * @param bmk

     * @param segment_delete_bitmap

     */

    void merge(const BitmapKey& bmk, const roaring::Roaring& segment_delete_bitmap);

    /**

     * Merges the given delete bitmap into *this

     *

     * @param other

     */

    void merge(const DeleteBitmap& other);

    /**

     * Checks if the given row is marked deleted in bitmap with the condition:

     * all the bitmaps that

     * RowsetId and SegmentId are the same as the given ones,

     * and Version <= the given Version

     *

     * Note: aggregation cache may be used.

     *

     * @return true if marked deleted

     */

    bool contains_agg(const BitmapKey& bitmap, uint32_t row_id) const;

    bool contains_agg_without_cache(const BitmapKey& bmk, uint32_t row_id) const;

    /**

     * Gets aggregated delete_bitmap on rowset_id and version, the same effect:

     * `select sum(roaring::Roaring) where RowsetId=rowset_id and SegmentId=seg_id and Version <= version`

     *

     * @return shared_ptr to a bitmap, which may be empty

     */

    std::shared_ptr<roaring::Roaring> get_agg(const BitmapKey& bmk) const;

    bool has_calculated_for_multi_segments(const RowsetId& rowset_id) const;

    void traverse_rowset_id_prefix(

            const std::function<void(const DeleteBitmap&, const RowsetId& rowsetId)>& func) const;

    uint64_t count_key_with_rowset_id_unlocked(const RowsetId& rowset_id) const;

    class AggCachePolicy : public LRUCachePolicyTrackingManual {

    public:

        AggCachePolicy(size_t capacity)

                : LRUCachePolicyTrackingManual(CachePolicy::CacheType::DELETE_BITMAP_AGG_CACHE,

                                               capacity, LRUCacheType::SIZE,

                                               config::delete_bitmap_agg_cache_stale_sweep_time_sec,

                                               256) {}

    };

    class AggCache {

    public:

        class Value : public LRUCacheValueBase {

        public:

            roaring::Roaring bitmap;

        };

        AggCache(size_t size_in_bytes) {

            static std::once_flag once;

            std::call_once(once, [size_in_bytes] {

                auto* tmp = new AggCachePolicy(size_in_bytes);

                AggCache::s_repr.store(tmp, std::memory_order_release);

            });

            while (!s_repr.load(std::memory_order_acquire)) {

            }

        }

        static LRUCachePolicy* repr() { return s_repr.load(std::memory_order_acquire); }

        static std::atomic<AggCachePolicy*> s_repr;

    };

private:

    mutable std::shared_ptr<AggCache> _agg_cache;

    int64_t _tablet_id;

};

static const std::string SEQUENCE_COL = "__DORIS_SEQUENCE_COL__";

inline TabletUid TabletMeta::tablet_uid() const {

    return _tablet_uid;

}

inline int64_t TabletMeta::table_id() const {

    return _table_id;

}

inline int64_t TabletMeta::partition_id() const {

    return _partition_id;

}

inline int64_t TabletMeta::tablet_id() const {

    return _tablet_id;

}

inline int64_t TabletMeta::replica_id() const {

    return _replica_id;

}

inline int32_t TabletMeta::schema_hash() const {

    return _schema_hash;

}

inline int16_t TabletMeta::shard_id() const {

    return _shard_id;

}

inline void TabletMeta::set_shard_id(int32_t shard_id) {

    _shard_id = shard_id;

}

inline int64_t TabletMeta::creation_time() const {

    return _creation_time;

}

inline void TabletMeta::set_creation_time(int64_t creation_time) {

    _creation_time = creation_time;

}

inline int64_t TabletMeta::cumulative_layer_point() const {

    return _cumulative_layer_point;

}

inline void TabletMeta::set_cumulative_layer_point(int64_t new_point) {

    _cumulative_layer_point = new_point;

}

inline size_t TabletMeta::num_rows() const {

    size_t num_rows = 0;

    for (auto& rs : _rs_metas) {

        num_rows += rs->num_rows();

    }

    return num_rows;

}

inline size_t TabletMeta::tablet_footprint() const {

    size_t total_size = 0;

    for (auto& rs : _rs_metas) {

        total_size += rs->data_disk_size();

    }

    return total_size;

}

inline size_t TabletMeta::tablet_local_size() const {

    size_t total_size = 0;

    for (auto& rs : _rs_metas) {

        if (rs->is_local()) {

            total_size += rs->data_disk_size();

        }

    }

    return total_size;

}

inline size_t TabletMeta::tablet_remote_size() const {

    size_t total_size = 0;

    for (auto& rs : _rs_metas) {

        if (!rs->is_local()) {

            total_size += rs->data_disk_size();

        }

    }

    return total_size;

}

inline size_t TabletMeta::version_count() const {

    return _rs_metas.size();

}

inline size_t TabletMeta::stale_version_count() const {

    return _rs_metas.size();

}

inline TabletState TabletMeta::tablet_state() const {

    return _tablet_state;

}

inline void TabletMeta::set_tablet_state(TabletState state) {

    _tablet_state = state;

}

inline bool TabletMeta::in_restore_mode() const {

    return _in_restore_mode;

}

inline void TabletMeta::set_in_restore_mode(bool in_restore_mode) {

    _in_restore_mode = in_restore_mode;

}

inline const TabletSchemaSPtr& TabletMeta::tablet_schema() const {

    return _schema;

}

inline TabletSchema* TabletMeta::mutable_tablet_schema() {

    return _schema.get();

}

inline const std::vector<RowsetMetaSharedPtr>& TabletMeta::all_rs_metas() const {

    return _rs_metas;

}

inline std::vector<RowsetMetaSharedPtr>& TabletMeta::all_mutable_rs_metas() {

    return _rs_metas;

}

inline const std::vector<RowsetMetaSharedPtr>& TabletMeta::all_stale_rs_metas() const {

    return _stale_rs_metas;

}

inline bool TabletMeta::all_beta() const {

    for (auto& rs : _rs_metas) {

        if (rs->rowset_type() != RowsetTypePB::BETA_ROWSET) {

            return false;

        }

    }

    for (auto& rs : _stale_rs_metas) {

        if (rs->rowset_type() != RowsetTypePB::BETA_ROWSET) {

            return false;

        }

    }

    return true;

}

std::string tablet_state_name(TabletState state);

// Only for unit test now.

bool operator==(const TabletMeta& a, const TabletMeta& b);

bool operator!=(const TabletMeta& a, const TabletMeta& b);

} // namespace doris