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

#include "storage/compaction/cumulative_compaction.h"

#include <cpp/sync_point.h>

#include <gen_cpp/AgentService_types.h>

#include <gen_cpp/Types_types.h>

#include <memory>

#include <mutex>

#include <ostream>

#include <vector>

#include "common/config.h"

#include "common/logging.h"

#include "common/metrics/doris_metrics.h"

#include "runtime/exec_env.h"

#include "runtime/thread_context.h"

#include "storage/compaction/cumulative_compaction_policy.h"

#include "storage/compaction/cumulative_compaction_time_series_policy.h"

#include "storage/olap_define.h"

#include "storage/rowset/rowset_meta.h"

#include "storage/storage_engine.h"

#include "storage/tablet/tablet.h"

#include "util/time.h"

#include "util/trace.h"

namespace doris {

using namespace ErrorCode;

CumulativeCompaction::CumulativeCompaction(StorageEngine& engine, const TabletSharedPtr& tablet)

        : CompactionMixin(engine, tablet,

                          "CumulativeCompaction:" + std::to_string(tablet->tablet_id())) {}

CumulativeCompaction::~CumulativeCompaction() = default;

Status CumulativeCompaction::prepare_compact() {

    Status st;

    Defer defer_set_st([&] {

        if (!st.ok()) {

            tablet()->set_last_cumu_compaction_status(st.to_string());

        }

    });

    if (!tablet()->init_succeeded()) {

        st = Status::Error<CUMULATIVE_INVALID_PARAMETERS, false>("_tablet init failed");

        return st;

    }

    std::unique_lock<std::mutex> lock(tablet()->get_cumulative_compaction_lock(), std::try_to_lock);

    if (!lock.owns_lock()) {

        st = Status::Error<TRY_LOCK_FAILED, false>(

                "The tablet is under cumulative compaction. tablet={}", _tablet->tablet_id());

        return st;

    }

    tablet()->calculate_cumulative_point();

    VLOG_CRITICAL << "after calculate, current cumulative point is "

                  << tablet()->cumulative_layer_point() << ", tablet=" << _tablet->tablet_id();

    st = pick_rowsets_to_compact();

    RETURN_IF_ERROR(st);

    COUNTER_UPDATE(_input_rowsets_counter, _input_rowsets.size());

    st = Status::OK();

    return st;

}

Status CumulativeCompaction::execute_compact() {

    DBUG_EXECUTE_IF("CumulativeCompaction::execute_compact.block", {

        auto target_tablet_id = dp->param<int64_t>("tablet_id", -1);

        if (target_tablet_id == _tablet->tablet_id()) {

            LOG(INFO) << "start debug block "

                      << "CumulativeCompaction::execute_compact.block";

            while (DebugPoints::instance()->is_enable(

                    "CumulativeCompaction::execute_compact.block")) {

                std::this_thread::sleep_for(std::chrono::milliseconds(200));

            }

            LOG(INFO) << "end debug block "

                      << "CumulativeCompaction::execute_compact.block";

        }

    })

    Status st;

    Defer defer_set_st([&] {

        tablet()->set_last_cumu_compaction_status(st.to_string());

        if (!st.ok()) {

            tablet()->set_last_cumu_compaction_failure_time(UnixMillis());

        } else {

            // TIME_SERIES_POLICY, generating an empty rowset doesn't need to update the timestamp.

            if (!(tablet()->tablet_meta()->compaction_policy() == CUMULATIVE_TIME_SERIES_POLICY &&

                  _output_rowset->num_segments() == 0)) {

                tablet()->set_last_cumu_compaction_success_time(UnixMillis());

            }

        }

    });

    std::unique_lock<std::mutex> lock(tablet()->get_cumulative_compaction_lock(), std::try_to_lock);

    if (!lock.owns_lock()) {

        st = Status::Error<TRY_LOCK_FAILED, false>(

                "The tablet is under cumulative compaction. tablet={}", _tablet->tablet_id());

        return st;

    }

    SCOPED_ATTACH_TASK(_mem_tracker);

    st = CompactionMixin::execute_compact();

    RETURN_IF_ERROR(st);

    TEST_SYNC_POINT_RETURN_WITH_VALUE(

            "cumulative_compaction::CumulativeCompaction::execute_compact", Status::OK());

    DCHECK_EQ(_state, CompactionState::SUCCESS);

    tablet()->cumulative_compaction_policy()->update_cumulative_point(

            tablet(), _input_rowsets, _output_rowset, _last_delete_version);

    VLOG_CRITICAL << "after cumulative compaction, current cumulative point is "

                  << tablet()->cumulative_layer_point() << ", tablet=" << _tablet->tablet_id();

    DorisMetrics::instance()->cumulative_compaction_deltas_total->increment(_input_rowsets.size());

    DorisMetrics::instance()->cumulative_compaction_bytes_total->increment(

            _input_rowsets_total_size);

    st = Status::OK();

    return st;

}

Status CumulativeCompaction::pick_rowsets_to_compact() {

    auto candidate_rowsets = tablet()->pick_candidate_rowsets_to_cumulative_compaction();

    if (candidate_rowsets.empty()) {

        return Status::Error<CUMULATIVE_NO_SUITABLE_VERSION>("candidate_rowsets is empty");

    }

    // candidate_rowsets may not be continuous

    // So we need to choose the longest continuous path from it.

    std::vector<Version> missing_versions;

    find_longest_consecutive_version(&candidate_rowsets, &missing_versions);

    if (!missing_versions.empty()) {

        DCHECK(missing_versions.size() % 2 == 0);

        LOG(WARNING) << "There are missed versions among rowsets. "

                     << "total missed version size: " << missing_versions.size() / 2

                     << ", first missed version prev rowset verison=" << missing_versions[0]

                     << ", first missed version next rowset version=" << missing_versions[1]

                     << ", tablet=" << _tablet->tablet_id();

        if (config::enable_auto_clone_on_compaction_missing_version) {

            int64_t max_version = tablet()->max_version_unlocked();

            LOG_INFO("cumulative compaction submit missing rowset clone task.")

                    .tag("tablet_id", _tablet->tablet_id())

                    .tag("max_version", max_version)

                    .tag("replica_id", tablet()->replica_id())

                    .tag("partition_id", _tablet->partition_id())

                    .tag("table_id", _tablet->table_id());

            Status st = _engine.submit_clone_task(tablet(), max_version);

            if (!st) {

                LOG_WARNING("cumulative compaction failed to submit missing rowset clone task.")

                        .tag("st", st.msg())

                        .tag("tablet_id", _tablet->tablet_id())

                        .tag("max_version", max_version)

                        .tag("replica_id", tablet()->replica_id())

                        .tag("partition_id", _tablet->partition_id())

                        .tag("table_id", _tablet->table_id());

            }

        }

    }

    int64_t max_score = config::cumulative_compaction_max_deltas;

    int64_t process_memory_usage = doris::GlobalMemoryArbitrator::process_memory_usage();

    bool memory_usage_high = process_memory_usage > MemInfo::soft_mem_limit() * 8 / 10;

    if (tablet()->last_compaction_status.is<ErrorCode::MEM_LIMIT_EXCEEDED>() || memory_usage_high) {

        max_score = std::max(config::cumulative_compaction_max_deltas /

                                     config::cumulative_compaction_max_deltas_factor,

                             config::cumulative_compaction_min_deltas + 1);

    }

    size_t compaction_score = 0;

    tablet()->cumulative_compaction_policy()->pick_input_rowsets(

            tablet(), candidate_rowsets, max_score, config::cumulative_compaction_min_deltas,

            &_input_rowsets, &_last_delete_version, &compaction_score,

            _allow_delete_in_cumu_compaction);

    // Cumulative compaction will process with at least 1 rowset.

    // So when there is no rowset being chosen, we should return Status::Error<CUMULATIVE_NO_SUITABLE_VERSION>():

    if (_input_rowsets.empty()) {

        if (_last_delete_version.first != -1) {

            // we meet a delete version, should increase the cumulative point to let base compaction handle the delete version.

            // plus 1 to skip the delete version.

            // NOTICE: after that, the cumulative point may be larger than max version of this tablet, but it doesn't matter.

            tablet()->set_cumulative_layer_point(_last_delete_version.first + 1);

            LOG_INFO(

                    "cumulative compaction meet delete rowset, increase cumu point without "

                    "other "

                    "operation.")

                    .tag("tablet id:", tablet()->tablet_id())

                    .tag("after cumulative compaction, cumu point:",

                         tablet()->cumulative_layer_point());

            return Status::Error<CUMULATIVE_MEET_DELETE_VERSION>(

                    "cumulative compaction meet delete version");

        }

        // we did not meet any delete version. which means compaction_score is not enough to do cumulative compaction.

        // We should wait until there are more rowsets to come, and keep the cumulative point unchanged.

        // But in order to avoid the stall of compaction because no new rowset arrives later, we should increase

        // the cumulative point after waiting for a long time, to ensure that the base compaction can continue.

        // check both last success time of base and cumulative compaction

        int64_t now = UnixMillis();

        int64_t last_cumu = tablet()->last_cumu_compaction_success_time();

        int64_t last_base = tablet()->last_base_compaction_success_time();

        if (last_cumu != 0 || last_base != 0) {

            int64_t interval_threshold = config::pick_rowset_to_compact_interval_sec * 1000;

            int64_t cumu_interval = now - last_cumu;

            int64_t base_interval = now - last_base;

            if (cumu_interval > interval_threshold && base_interval > interval_threshold) {

                // before increasing cumulative point, we should make sure all rowsets are non-overlapping.

                // if at least one rowset is overlapping, we should compact them first.

                for (auto& rs : candidate_rowsets) {

                    if (rs->rowset_meta()->is_segments_overlapping()) {

                        _input_rowsets = candidate_rowsets;

                        return Status::OK();

                    }

                }

                // all candidate rowsets are non-overlapping, increase the cumulative point

                tablet()->set_cumulative_layer_point(candidate_rowsets.back()->start_version() + 1);

            }

        } else {

            // init the compaction success time for first time

            if (last_cumu == 0) {

                tablet()->set_last_cumu_compaction_success_time(now);

            }

            if (last_base == 0) {

                tablet()->set_last_base_compaction_success_time(now);

            }

        }

        return Status::Error<CUMULATIVE_NO_SUITABLE_VERSION>("_input_rowsets is empty");

    }

    return Status::OK();

}

} // namespace doris