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

#include <stdint.h>

#include <memory>

#include <string>

#include <vector>

#include "common/config.h"

#include "storage/rowset/rowset.h"

#include "storage/rowset/rowset_meta.h"

namespace doris {

class Tablet;

struct Version;

inline constexpr std::string_view CUMULATIVE_SIZE_BASED_POLICY = "size_based";

/// This class CumulativeCompactionPolicy is the base class of cumulative compaction policy.

/// It defines the policy to do cumulative compaction. It has different derived classes, which implements

/// concrete cumulative compaction algorithm. The policy is configured by conf::cumulative_compaction_policy.

/// The policy functions is the main steps to do cumulative compaction. For example, how to pick candidate

/// rowsets from tablet using current policy, how to calculate the cumulative point and how to calculate

/// the tablet cumulative compaction score and so on.

class CumulativeCompactionPolicy {

public:

    /// Constructor function of CumulativeCompactionPolicy,

    /// it needs tablet pointer to access tablet method.

    /// param tablet, the shared pointer of tablet

    CumulativeCompactionPolicy() {}

    /// Destructor function of CumulativeCompactionPolicy.

    virtual ~CumulativeCompactionPolicy() {}

    /// Calculate the cumulative compaction score of the tablet. This function uses rowsets meta and current

    /// cumulative point to calculative the score of tablet. The score depends on the concrete algorithm of policy.

    /// In general, the score represents the segments nums to do cumulative compaction in total rowsets. The more

    /// score tablet gets, the earlier it can do  cumulative compaction.

    /// param all_rowsets, all rowsets in tablet.

    /// param current_cumulative_point, current cumulative point value.

    /// return score, the result score after calculate.

    virtual uint32_t calc_cumulative_compaction_score(Tablet* tablet) = 0;

    /// Pick input rowsets from candidate rowsets for compaction. This function is pure virtual function.

    /// Its implementation depends on concrete compaction policy.

    /// param candidate_rowsets, the candidate_rowsets vector container to pick input rowsets

    /// return input_rowsets, the vector container as return

    /// return last_delete_version, if has delete rowset, record the delete version from input_rowsets

    /// return compaction_score, calculate the compaction score of picked input rowset

    virtual int pick_input_rowsets(Tablet* tablet,

                                   const std::vector<RowsetSharedPtr>& candidate_rowsets,

                                   const int64_t max_compaction_score,

                                   const int64_t min_compaction_score,

                                   std::vector<RowsetSharedPtr>* input_rowsets,

                                   Version* last_delete_version, size_t* compaction_score,

                                   bool allow_delete = false) = 0;

    /// Update tablet's cumulative point after cumulative compaction finished. This function is pure virtual function.

    /// Each derived has its own update policy which depends on its concrete algorithm. When the cumulative point moves

    /// after output rowset, then output rowset will do base compaction next time.

    /// param input_rowsets, the picked input rowset to do compaction just now

    /// param output_rowset, the result rowset after compaction

    virtual void update_cumulative_point(Tablet* tablet,

                                         const std::vector<RowsetSharedPtr>& input_rowsets,

                                         RowsetSharedPtr output_rowset,

                                         Version& last_delete_version) = 0;

    /// Calculate tablet's cumulative point before compaction. This calculation just executes once when the tablet compacts

    /// first time after BE initialization and then motion of cumulative point depends on update_cumulative_point policy.

    /// This function is pure virtual function. In general, the cumulative point splits the rowsets into two parts:

    /// base rowsets, cumulative rowsets.

    /// param all_rowsets, all rowsets in the tablet

    /// param current_cumulative_point, current cumulative position

    /// return cumulative_point, the result of calculating cumulative point position

    virtual void calculate_cumulative_point(Tablet* tablet,

                                            const RowsetMetaMapContainer& all_rowsets,

                                            int64_t current_cumulative_point,

                                            int64_t* cumulative_point) = 0;

    // Updates the compaction level of a tablet after a compaction operation.

    virtual int64_t get_compaction_level(Tablet* tablet,

                                         const std::vector<RowsetSharedPtr>& input_rowsets,

                                         RowsetSharedPtr output_rowset) = 0;

    /// Fetch cumulative policy name

    virtual std::string_view name() = 0;

};

/// SizeBased cumulative compaction policy implementation. SizeBased policy which derives CumulativeCompactionPolicy is a optimized

/// version of num based cumulative compaction policy. This policy also uses linear structure to compact rowsets. The cumulative rowsets

/// can do compaction when they are in same level size. And when output rowset exceeds the promotion radio of base size or min promotion

/// size, it will do base compaction. This policy is targeting the use cases requiring lower write amplification, trading off read

/// amplification and space amplification.

class SizeBasedCumulativeCompactionPolicy final : public CumulativeCompactionPolicy {

public:

    /// Constructor function of SizeBasedCumulativeCompactionPolicy,

    /// it needs tablet pointer to access tablet method.

    /// param tablet, the shared pointer of tablet

    SizeBasedCumulativeCompactionPolicy(

            int64_t promotion_size = config::compaction_promotion_size_mbytes * 1024 * 1024,

            double promotion_ratio = config::compaction_promotion_ratio,

            int64_t promotion_min_size = config::compaction_promotion_min_size_mbytes * 1024 * 1024,

            int64_t promotion_version_count = config::compaction_promotion_version_count,

            int64_t compaction_min_size = config::compaction_min_size_mbytes * 1024 * 1024);

    /// Destructor function of SizeBasedCumulativeCompactionPolicy.

    ~SizeBasedCumulativeCompactionPolicy() {}

    /// SizeBased cumulative compaction policy implements calculate cumulative point function.

    /// When the first time the tablet does compact, this calculation is executed. Its main policy is to find first rowset

    /// which does not satisfied the promotion conditions.

    void calculate_cumulative_point(Tablet* tablet, const RowsetMetaMapContainer& all_rowsets,

                                    int64_t current_cumulative_point,

                                    int64_t* cumulative_point) override;

    /// SizeBased cumulative compaction policy implements pick input rowsets function.

    /// Its main policy is picking rowsets from candidate rowsets by comparing accumulative compaction_score,

    /// max_cumulative_compaction_num_singleton_deltas or checking whether there is delete version rowset,

    /// and choose those rowset in the same level to do cumulative compaction.

    int pick_input_rowsets(Tablet* tablet, const std::vector<RowsetSharedPtr>& candidate_rowsets,

                           const int64_t max_compaction_score, const int64_t min_compaction_score,

                           std::vector<RowsetSharedPtr>* input_rowsets,

                           Version* last_delete_version, size_t* compaction_score,

                           bool allow_delete = false) override;

    /// SizeBased cumulative compaction policy implements update cumulative point function.

    /// Its main policy is judging the output rowset size whether satisfied the promotion size.

    /// If it satisfied, this policy will update the cumulative point.

    void update_cumulative_point(Tablet* tablet, const std::vector<RowsetSharedPtr>& input_rowsets,

                                 RowsetSharedPtr _output_rowset,

                                 Version& last_delete_version) override;

    /// Num based cumulative compaction policy implements calc cumulative compaction score function.

    /// Its main policy is calculating the accumulative compaction score after current cumulative_point in tablet.

    uint32_t calc_cumulative_compaction_score(Tablet* tablet) override;

    int64_t get_compaction_level(Tablet* tablet, const std::vector<RowsetSharedPtr>& input_rowsets,

                                 RowsetSharedPtr output_rowset) override {

        return 0;

    }

    std::string_view name() override { return CUMULATIVE_SIZE_BASED_POLICY; }

private:

    /// calculate promotion size using current base rowset meta size and promotion configs

    void _calc_promotion_size(Tablet* tablet, RowsetMetaSharedPtr base_rowset_meta,

                              int64_t* promotion_size);

    /// calculate the disk size belong to which level, the level is divide by power of 2

    /// between compaction_promotion_size_mbytes and 1KB

    int64_t _level_size(const int64_t size);

    /// when policy calculate cumulative_compaction_score, update promotion size at the same time

    void _refresh_tablet_promotion_size(Tablet* tablet, int64_t promotion_size);

private:

    /// cumulative compaction promotion size, unit is byte.

    int64_t _promotion_size;

    /// cumulative compaction promotion ratio of base rowset total disk size.

    double _promotion_ratio;

    /// cumulative compaction promotion min size, unit is byte.

    int64_t _promotion_min_size;

    // cululative compaction promotion version count, only works for unique key MoW table

    int64_t _promotion_version_count;

    /// lower bound size to do compaction compaction.

    int64_t _compaction_min_size;

};

/// The factory of CumulativeCompactionPolicy, it can product different policy according to the `policy` parameter.

class CumulativeCompactionPolicyFactory {

public:

    /// Static factory function. It can product different policy according to the `policy` parameter and use tablet ptr

    /// to construct the policy. Now it can product size based and num based policies.

    static std::shared_ptr<CumulativeCompactionPolicy> create_cumulative_compaction_policy(

            const std::string_view& compaction_policy);

};

} // namespace doris