// 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/segment/segment_writer.h"

#include <assert.h>

#include <gen_cpp/segment_v2.pb.h>

#include <parallel_hashmap/phmap.h>

#include <algorithm>

// IWYU pragma: no_include <opentelemetry/common/threadlocal.h>

#include <crc32c/crc32c.h>

#include "cloud/config.h"

#include "common/cast_set.h"

#include "common/compiler_util.h" // IWYU pragma: keep

#include "common/config.h"

#include "common/logging.h" // LOG

#include "common/status.h"

#include "core/block/block.h"

#include "core/block/column_with_type_and_name.h"

#include "core/column/column_nullable.h"

#include "core/data_type/primitive_type.h"

#include "core/field.h"

#include "core/types.h"

#include "core/value/vdatetime_value.h"

#include "exec/common/variant_util.h"

#include "io/cache/block_file_cache.h"

#include "io/cache/block_file_cache_factory.h"

#include "io/fs/file_system.h"

#include "io/fs/file_writer.h"

#include "io/fs/local_file_system.h"

#include "runtime/exec_env.h"

#include "runtime/memory/mem_tracker.h"

#include "service/point_query_executor.h"

#include "storage/data_dir.h"

#include "storage/index/index_file_writer.h"

#include "storage/index/index_writer.h"

#include "storage/index/inverted/inverted_index_fs_directory.h"

#include "storage/index/primary_key_index.h"

#include "storage/index/short_key_index.h"

#include "storage/iterator/olap_data_convertor.h"

#include "storage/key_coder.h"

#include "storage/olap_common.h"

#include "storage/olap_define.h"

#include "storage/partial_update_info.h"

#include "storage/rowset/rowset_writer_context.h" // RowsetWriterContext

#include "storage/rowset/segment_creator.h"

#include "storage/segment/column_writer.h" // ColumnWriter

#include "storage/segment/external_col_meta_util.h"

#include "storage/segment/historical_row_retriever.h"

#include "storage/segment/page_io.h"

#include "storage/segment/page_pointer.h"

#include "storage/segment/segment_loader.h"

#include "storage/segment/variant/variant_ext_meta_writer.h"

#include "storage/segment/variant_stats_calculator.h"

#include "storage/storage_engine.h"

#include "storage/tablet/tablet_schema.h"

#include "storage/utils.h"

#include "util/coding.h"

#include "util/faststring.h"

#include "util/jsonb/serialize.h"

#include "util/simd/bits.h"

namespace doris {

namespace segment_v2 {

using namespace ErrorCode;

using namespace KeyConsts;

const char* k_segment_magic = "D0R1";

const uint32_t k_segment_magic_length = 4;

inline std::string segment_mem_tracker_name(uint32_t segment_id) {

    return "SegmentWriter:Segment-" + std::to_string(segment_id);

}

SegmentWriter::SegmentWriter(io::FileWriter* file_writer, uint32_t segment_id,

                             TabletSchemaSPtr tablet_schema, BaseTabletSPtr tablet,

                             DataDir* data_dir, const SegmentWriterOptions& opts,

                             IndexFileWriter* index_file_writer)

        : _segment_id(segment_id),

          _tablet_schema(std::move(tablet_schema)),

          _tablet(std::move(tablet)),

          _data_dir(data_dir),

          _opts(opts),

          _file_writer(file_writer),

          _index_file_writer(index_file_writer),

          _mem_tracker(std::make_unique<MemTracker>(segment_mem_tracker_name(segment_id))),

          _mow_context(std::move(opts.mow_ctx)) {

    CHECK_NOTNULL(file_writer);

    _num_sort_key_columns = _tablet_schema->num_key_columns();

    _num_short_key_columns = _tablet_schema->num_short_key_columns();

    if (!_is_mow_with_cluster_key()) {

        DCHECK(_num_sort_key_columns >= _num_short_key_columns)

                << ", table_id=" << _tablet_schema->table_id()

                << ", num_key_columns=" << _num_sort_key_columns

                << ", num_short_key_columns=" << _num_short_key_columns

                << ", cluster_key_columns=" << _tablet_schema->cluster_key_uids().size();

    }

    for (size_t cid = 0; cid < _num_sort_key_columns; ++cid) {

        const auto& column = _tablet_schema->column(cid);

        _key_coders.push_back(get_key_coder(column.type()));

        _key_index_size.push_back(cast_set<uint16_t>(column.index_length()));

    }

    if (_is_mow()) {

        // encode the sequence id into the primary key index

        if (_tablet_schema->has_sequence_col()) {

            const auto& column = _tablet_schema->column(_tablet_schema->sequence_col_idx());

            _seq_coder = get_key_coder(column.type());

        }

        // encode the rowid into the primary key index

        if (_is_mow_with_cluster_key()) {

            _rowid_coder = get_key_coder(FieldType::OLAP_FIELD_TYPE_UNSIGNED_INT);

            // primary keys

            _primary_key_coders.swap(_key_coders);

            // cluster keys

            _key_coders.clear();

            _key_index_size.clear();

            _num_sort_key_columns = _tablet_schema->cluster_key_uids().size();

            for (auto cid : _tablet_schema->cluster_key_uids()) {

                const auto& column = _tablet_schema->column_by_uid(cid);

                _key_coders.push_back(get_key_coder(column.type()));

                _key_index_size.push_back(cast_set<uint16_t>(column.index_length()));

            }

        }

    }

}

SegmentWriter::~SegmentWriter() {

    _mem_tracker->release(_mem_tracker->consumption());

}

void SegmentWriter::init_column_meta(ColumnMetaPB* meta, uint32_t column_id,

                                     const TabletColumn& column, TabletSchemaSPtr tablet_schema) {

    meta->set_column_id(column_id);

    meta->set_type(int(column.type()));

    meta->set_length(column.length());

    meta->set_encoding(DEFAULT_ENCODING);

    meta->set_compression(_opts.compression_type);

    meta->set_is_nullable(column.is_nullable());

    meta->set_default_value(column.default_value());

    meta->set_precision(column.precision());

    meta->set_frac(column.frac());

    if (column.has_path_info()) {

        column.path_info_ptr()->to_protobuf(meta->mutable_column_path_info(),

                                            column.parent_unique_id());

    }

    meta->set_unique_id(column.unique_id());

    for (uint32_t i = 0; i < column.get_subtype_count(); ++i) {

        init_column_meta(meta->add_children_columns(), column_id, column.get_sub_column(i),

                         tablet_schema);

    }

    meta->set_result_is_nullable(column.get_result_is_nullable());

    meta->set_function_name(column.get_aggregation_name());

    meta->set_be_exec_version(column.get_be_exec_version());

    if (column.is_variant_type()) {

        meta->set_variant_max_subcolumns_count(column.variant_max_subcolumns_count());

        meta->set_variant_enable_doc_mode(column.variant_enable_doc_mode());

    }

}

Status SegmentWriter::init() {

    std::vector<uint32_t> column_ids;

    auto column_cnt = cast_set<int>(_tablet_schema->num_columns());

    for (uint32_t i = 0; i < column_cnt; ++i) {

        column_ids.emplace_back(i);

    }

    return init(column_ids, true);

}

Status SegmentWriter::_create_column_writer(uint32_t cid, const TabletColumn& column,

                                            const TabletSchemaSPtr& schema) {

    ColumnWriterOptions opts;

    opts.meta = _footer.add_columns();

    init_column_meta(opts.meta, cid, column, schema);

    // now we create zone map for key columns in AGG_KEYS or all column in UNIQUE_KEYS or DUP_KEYS

    // except for columns whose type don't support zone map.

    opts.need_zone_map = column.is_key() || schema->keys_type() != KeysType::AGG_KEYS;

    opts.need_bloom_filter = column.is_bf_column();

    if (opts.need_bloom_filter) {

        opts.bf_options.fpp = schema->has_bf_fpp() ? schema->bloom_filter_fpp() : 0.05;

    }

    auto* tablet_index = schema->get_ngram_bf_index(column.unique_id());

    if (tablet_index) {

        opts.need_bloom_filter = true;

        opts.is_ngram_bf_index = true;

        //narrow convert from int32_t to uint8_t and uint16_t which is dangerous

        auto gram_size = tablet_index->get_gram_size();

        auto gram_bf_size = tablet_index->get_gram_bf_size();

        if (gram_size > 256 || gram_size < 1) {

            return Status::NotSupported("Do not support ngram bloom filter for ngram_size: ",

                                        gram_size);

        }

        if (gram_bf_size > 65535 || gram_bf_size < 64) {

            return Status::NotSupported("Do not support ngram bloom filter for bf_size: ",

                                        gram_bf_size);

        }

        opts.gram_size = cast_set<uint8_t>(gram_size);

        opts.gram_bf_size = cast_set<uint16_t>(gram_bf_size);

    }

    bool skip_inverted_index = false;

    if (_opts.rowset_ctx != nullptr) {

        // skip write inverted index for index compaction column

        skip_inverted_index =

                _opts.rowset_ctx->columns_to_do_index_compaction.count(column.unique_id()) > 0;

    }

    // skip write inverted index on load if skip_write_index_on_load is true

    if (_opts.write_type == DataWriteType::TYPE_DIRECT && schema->skip_write_index_on_load()) {

        skip_inverted_index = true;

    }

    // indexes for this column

    if (!skip_inverted_index) {

        auto inverted_indexs = schema->inverted_indexs(column);

        if (!inverted_indexs.empty()) {

            opts.inverted_indexes = inverted_indexs;

            opts.need_inverted_index = true;

            DCHECK(_index_file_writer != nullptr);

        }

    }

    // indexes for this column

    if (const auto& index = schema->ann_index(column); index != nullptr) {

        opts.ann_index = index;

        opts.need_ann_index = true;

        DCHECK(_index_file_writer != nullptr);

    }

    opts.index_file_writer = _index_file_writer;

#define DISABLE_INDEX_IF_FIELD_TYPE(TYPE)                     \

    if (column.type() == FieldType::OLAP_FIELD_TYPE_##TYPE) { \

        opts.need_zone_map = false;                           \

        opts.need_bloom_filter = false;                       \

    }

    DISABLE_INDEX_IF_FIELD_TYPE(STRUCT)

    DISABLE_INDEX_IF_FIELD_TYPE(ARRAY)

    DISABLE_INDEX_IF_FIELD_TYPE(JSONB)

    DISABLE_INDEX_IF_FIELD_TYPE(AGG_STATE)

    DISABLE_INDEX_IF_FIELD_TYPE(MAP)

    DISABLE_INDEX_IF_FIELD_TYPE(BITMAP)

    DISABLE_INDEX_IF_FIELD_TYPE(HLL)

    DISABLE_INDEX_IF_FIELD_TYPE(QUANTILE_STATE)

    DISABLE_INDEX_IF_FIELD_TYPE(VARIANT)

#undef DISABLE_INDEX_IF_FIELD_TYPE

    int64_t storage_page_size = _tablet_schema->storage_page_size();

    // storage_page_size must be between 4KB and 10MB.

    if (storage_page_size >= 4096 && storage_page_size <= 10485760) {

        opts.data_page_size = storage_page_size;

    }

    opts.dict_page_size = _tablet_schema->storage_dict_page_size();

    DBUG_EXECUTE_IF("VerticalSegmentWriter._create_column_writer.storage_page_size", {

        auto table_id = DebugPoints::instance()->get_debug_param_or_default<int64_t>(

                "VerticalSegmentWriter._create_column_writer.storage_page_size", "table_id",

                INT_MIN);

        auto target_data_page_size = DebugPoints::instance()->get_debug_param_or_default<int64_t>(

                "VerticalSegmentWriter._create_column_writer.storage_page_size",

                "storage_page_size", INT_MIN);

        if (table_id == INT_MIN || target_data_page_size == INT_MIN) {

            return Status::Error<ErrorCode::INTERNAL_ERROR>(

                    "Debug point parameters missing: either 'table_id' or 'storage_page_size' not "

                    "set.");

        }

        if (table_id == _tablet_schema->table_id() &&

            opts.data_page_size != target_data_page_size) {

            return Status::Error<ErrorCode::INTERNAL_ERROR>(

                    "Mismatch in 'storage_page_size': expected size does not match the current "

                    "data page size. "

                    "Expected: " +

                    std::to_string(target_data_page_size) +

                    ", Actual: " + std::to_string(opts.data_page_size) + ".");

        }

    })

    if (column.is_row_store_column()) {

        // smaller page size for row store column

        auto page_size = _tablet_schema->row_store_page_size();

        opts.data_page_size =

                (page_size > 0) ? page_size : segment_v2::ROW_STORE_PAGE_SIZE_DEFAULT_VALUE;

        // Row store data is already serialized as a single blob. Keep it on plain pages

        // to avoid introducing dictionary pages for the hidden row store column.

        opts.meta->set_encoding(_tablet_schema->binary_plain_encoding_default_impl() ==

                                                BinaryPlainEncodingTypePB::BINARY_PLAIN_ENCODING_V2

                                        ? PLAIN_ENCODING_V2

                                        : PLAIN_ENCODING);

    }

    opts.rowset_ctx = _opts.rowset_ctx;

    opts.file_writer = _file_writer;

    opts.compression_type = _opts.compression_type;

    opts.footer = &_footer;

    if (_opts.rowset_ctx != nullptr) {

        opts.input_rs_readers = _opts.rowset_ctx->input_rs_readers;

    }

    opts.encoding_preference = {.integer_type_default_use_plain_encoding =

                                        _tablet_schema->integer_type_default_use_plain_encoding(),

                                .binary_plain_encoding_default_impl =

                                        _tablet_schema->binary_plain_encoding_default_impl()};

    std::unique_ptr<ColumnWriter> writer;

    RETURN_IF_ERROR(ColumnWriter::create(opts, &column, _file_writer, &writer));

    RETURN_IF_ERROR(writer->init());

    _column_writers.push_back(std::move(writer));

    _olap_data_convertor->add_column_data_convertor(column);

    return Status::OK();

}

Status SegmentWriter::init(const std::vector<uint32_t>& col_ids, bool has_key) {

    DCHECK(_column_writers.empty());

    DCHECK(_column_ids.empty());

    _has_key = has_key;

    _column_writers.reserve(_tablet_schema->columns().size());

    _column_ids.insert(_column_ids.end(), col_ids.begin(), col_ids.end());

    _olap_data_convertor = std::make_unique<OlapBlockDataConvertor>();

    if (_opts.compression_type == UNKNOWN_COMPRESSION) {

        _opts.compression_type = _tablet_schema->compression_type();

    }

    // Vertical compaction calls init() multiple times against the same writer; the footer accumulates entries

    // across calls, so this init()'s slice of footer columns starts at the current size.

    const int variant_stats_footer_offset = _footer.columns_size();

    RETURN_IF_ERROR(_create_writers(_tablet_schema, col_ids));

    // Initialize variant statistics calculator

    _variant_stats_calculator = std::make_unique<VariantStatsCaculator>(

            &_footer, _tablet_schema, col_ids, variant_stats_footer_offset);

    // we don't need the short key index for unique key merge on write table.

    if (_has_key) {

        if (_is_mow()) {

            size_t seq_col_length = 0;

            if (_tablet_schema->has_sequence_col()) {

                seq_col_length =

                        _tablet_schema->column(_tablet_schema->sequence_col_idx()).length() + 1;

            }

            size_t rowid_length = 0;

            if (_is_mow_with_cluster_key()) {

                rowid_length = PrimaryKeyIndexReader::ROW_ID_LENGTH;

                _short_key_index_builder.reset(

                        new ShortKeyIndexBuilder(_segment_id, _opts.num_rows_per_block));

            }

            _primary_key_index_builder.reset(

                    new PrimaryKeyIndexBuilder(_file_writer, seq_col_length, rowid_length));

            RETURN_IF_ERROR(_primary_key_index_builder->init());

        } else {

            _short_key_index_builder.reset(

                    new ShortKeyIndexBuilder(_segment_id, _opts.num_rows_per_block));

        }

    }

    return Status::OK();

}

Status SegmentWriter::_create_writers(const TabletSchemaSPtr& tablet_schema,

                                      const std::vector<uint32_t>& col_ids) {

    _olap_data_convertor->reserve(col_ids.size());

    for (auto& cid : col_ids) {

        RETURN_IF_ERROR(_create_column_writer(cid, tablet_schema->column(cid), tablet_schema));

    }

    return Status::OK();

}

void SegmentWriter::_maybe_invalid_row_cache(const std::string& key) {

    // Just invalid row cache for simplicity, since the rowset is not visible at present.

    // If we update/insert cache, if load failed rowset will not be visible but cached data

    // will be visible, and lead to inconsistency.

    if (!config::disable_storage_row_cache && _tablet_schema->has_row_store_for_all_columns() &&

        _opts.write_type == DataWriteType::TYPE_DIRECT) {

        // invalidate cache

        RowCache::instance()->erase({_opts.rowset_ctx->tablet_id, key});

    }

}

void SegmentWriter::_serialize_block_to_row_column(const Block& block) {

    if (block.rows() == 0) {

        return;

    }

    MonotonicStopWatch watch;

    watch.start();

    int row_column_id = 0;

    for (int i = 0; i < _tablet_schema->num_columns(); ++i) {

        if (_tablet_schema->column(i).is_row_store_column()) {

            auto* row_store_column = static_cast<ColumnString*>(

                    block.get_by_position(i).column->assume_mutable_ref().assume_mutable().get());

            row_store_column->clear();

            DataTypeSerDeSPtrs serdes = create_data_type_serdes(block.get_data_types());

            JsonbSerializeUtil::block_to_jsonb(*_tablet_schema, block, *row_store_column,

                                               cast_set<int>(_tablet_schema->num_columns()), serdes,

                                               {_tablet_schema->row_columns_uids().begin(),

                                                _tablet_schema->row_columns_uids().end()});

            break;

        }

    }

    VLOG_DEBUG << "serialize , num_rows:" << block.rows() << ", row_column_id:" << row_column_id

               << ", total_byte_size:" << block.allocated_bytes() << ", serialize_cost(us)"

               << watch.elapsed_time() / 1000;

}

Status SegmentWriter::probe_key_for_mow(

        std::string key, std::size_t segment_pos, bool have_input_seq_column, bool have_delete_sign,

        const std::vector<RowsetSharedPtr>& specified_rowsets,

        std::vector<std::unique_ptr<SegmentCacheHandle>>& segment_caches,

        bool& has_default_or_nullable, std::vector<bool>& use_default_or_null_flag,

        const std::function<void(const RowLocation& loc)>& found_cb,

        const std::function<Status()>& not_found_cb, PartialUpdateStats& stats) {

    RowLocation loc;

    // save rowset shared ptr so this rowset wouldn't delete

    RowsetSharedPtr rowset;

    auto st = _tablet->lookup_row_key(

            key, _tablet_schema.get(), have_input_seq_column, specified_rowsets, &loc,

            cast_set<uint32_t>(_mow_context->max_version), segment_caches, &rowset);

    if (st.is<KEY_NOT_FOUND>()) {

        if (!have_delete_sign) {

            RETURN_IF_ERROR(not_found_cb());

        }

        ++stats.num_rows_new_added;

        has_default_or_nullable = true;

        use_default_or_null_flag.emplace_back(true);

        return Status::OK();

    }

    if (!st.ok() && !st.is<KEY_ALREADY_EXISTS>()) {

        LOG(WARNING) << "failed to lookup row key, error: " << st;

        return st;

    }

    // 1. if the delete sign is marked, it means that the value columns of the row will not

    //    be read. So we don't need to read the missing values from the previous rows.

    // 2. the one exception is when there are sequence columns in the table, we need to read

    //    the sequence columns, otherwise it may cause the merge-on-read based compaction

    //    policy to produce incorrect results

    // TODO(bobhan1): only read seq col rather than all columns in this situation for

    // partial update and flexible partial update

    // TODO(bobhan1): handle sequence column here

    if (st.is<KEY_ALREADY_EXISTS>() || (have_delete_sign && !_tablet_schema->has_sequence_col())) {

        has_default_or_nullable = true;

        use_default_or_null_flag.emplace_back(true);

    } else {

        // partial update should not contain invisible columns

        use_default_or_null_flag.emplace_back(false);

        _rsid_to_rowset.emplace(rowset->rowset_id(), rowset);

        found_cb(loc);

    }

    if (st.is<KEY_ALREADY_EXISTS>()) {

        // although we need to mark delete current row, we still need to read missing columns

        // for this row, we need to ensure that each column is aligned

        _mow_context->delete_bitmap->add(

                {_opts.rowset_ctx->rowset_id, _segment_id, DeleteBitmap::TEMP_VERSION_COMMON},

                cast_set<uint32_t>(segment_pos));

        ++stats.num_rows_deleted;

    } else {

        _mow_context->delete_bitmap->add(

                {loc.rowset_id, loc.segment_id, DeleteBitmap::TEMP_VERSION_COMMON}, loc.row_id);

        ++stats.num_rows_updated;

    }

    return Status::OK();

}

Status SegmentWriter::partial_update_preconditions_check(size_t row_pos) {

    if (!_is_mow()) {

        auto msg = fmt::format(

                "Can only do partial update on merge-on-write unique table, but found: "

                "keys_type={}, _opts.enable_unique_key_merge_on_write={}, tablet_id={}",

                _tablet_schema->keys_type(), _opts.enable_unique_key_merge_on_write,

                _tablet->tablet_id());

        DCHECK(false) << msg;

        return Status::InternalError<false>(msg);

    }

    if (_opts.rowset_ctx->partial_update_info == nullptr) {

        auto msg =

                fmt::format("partial_update_info should not be nullptr, please check, tablet_id={}",

                            _tablet->tablet_id());

        DCHECK(false) << msg;

        return Status::InternalError<false>(msg);

    }

    if (!_opts.rowset_ctx->partial_update_info->is_fixed_partial_update()) {

        auto msg = fmt::format(

                "in fixed partial update code, but update_mode={}, please check, tablet_id={}",

                _opts.rowset_ctx->partial_update_info->update_mode(), _tablet->tablet_id());

        DCHECK(false) << msg;

        return Status::InternalError<false>(msg);

    }

    if (row_pos != 0) {

        auto msg = fmt::format("row_pos should be 0, but found {}, tablet_id={}", row_pos,

                               _tablet->tablet_id());

        DCHECK(false) << msg;

        return Status::InternalError<false>(msg);

    }

    return Status::OK();

}

// for partial update, we should do following steps to fill content of block:

// 1. set block data to data convertor, and get all key_column's converted slice

// 2. get pk of input block, and read missing columns

//       2.1 first find key location{rowset_id, segment_id, row_id}

//       2.2 build read plan to read by batch

//       2.3 fill block

// 3. set columns to data convertor and then write all columns

Status SegmentWriter::append_block_with_partial_content(const Block* block, size_t row_pos,

                                                        size_t num_rows) {

    if (block->columns() < _tablet_schema->num_key_columns() ||

        block->columns() >= _tablet_schema->num_columns()) {

        return Status::InvalidArgument(

                fmt::format("illegal partial update block columns: {}, num key columns: {}, total "

                            "schema columns: {}",

                            block->columns(), _tablet_schema->num_key_columns(),

                            _tablet_schema->num_columns()));

    }

    RETURN_IF_ERROR(partial_update_preconditions_check(row_pos));

    // find missing column cids

    const auto& missing_cids = _opts.rowset_ctx->partial_update_info->missing_cids;

    const auto& including_cids = _opts.rowset_ctx->partial_update_info->update_cids;

    // create full block and fill with input columns

    auto full_block = _tablet_schema->create_block();

    size_t input_id = 0;

    for (auto i : including_cids) {

        full_block.replace_by_position(i, block->get_by_position(input_id++).column);

    }

    if (_opts.rowset_ctx->write_type != DataWriteType::TYPE_COMPACTION &&

        _tablet_schema->num_variant_columns() > 0) {

        RETURN_IF_ERROR(variant_util::parse_and_materialize_variant_columns(

                full_block, *_tablet_schema, including_cids));

    }

    RETURN_IF_ERROR(_olap_data_convertor->set_source_content_with_specifid_columns(

            &full_block, row_pos, num_rows, including_cids));

    bool have_input_seq_column = false;

    // write including columns

    std::vector<IOlapColumnDataAccessor*> key_columns;

    IOlapColumnDataAccessor* seq_column = nullptr;

    size_t segment_start_pos = 0;

    for (auto cid : including_cids) {

        // here we get segment column row num before append data.

        segment_start_pos = _column_writers[cid]->get_next_rowid();

        // olap data convertor alway start from id = 0

        auto converted_result = _olap_data_convertor->convert_column_data(cid);

        if (!converted_result.first.ok()) {

            return converted_result.first;

        }

        if (cid < _num_sort_key_columns) {

            key_columns.push_back(converted_result.second);

        } else if (_tablet_schema->has_sequence_col() &&

                   cid == _tablet_schema->sequence_col_idx()) {

            seq_column = converted_result.second;

            have_input_seq_column = true;

        }

        RETURN_IF_ERROR(_column_writers[cid]->append(converted_result.second->get_nullmap(),

                                                     converted_result.second->get_data(),

                                                     num_rows));

    }

    bool has_default_or_nullable = false;

    std::vector<bool> use_default_or_null_flag;

    use_default_or_null_flag.reserve(num_rows);

    const auto* delete_signs =

            BaseTablet::get_delete_sign_column_data(full_block, row_pos + num_rows);

    const std::vector<RowsetSharedPtr>& specified_rowsets = _mow_context->rowset_ptrs;

    std::vector<std::unique_ptr<SegmentCacheHandle>> segment_caches(specified_rowsets.size());

    FixedReadPlan read_plan;

    // locate rows in base data

    PartialUpdateStats stats;

    for (size_t block_pos = row_pos; block_pos < row_pos + num_rows; block_pos++) {

        // block   segment

        //   2   ->   0

        //   3   ->   1

        //   4   ->   2

        //   5   ->   3

        // here row_pos = 2, num_rows = 4.

        size_t delta_pos = block_pos - row_pos;

        size_t segment_pos = segment_start_pos + delta_pos;

        std::string key = _full_encode_keys(key_columns, delta_pos);

        _maybe_invalid_row_cache(key);

        if (have_input_seq_column) {

            _encode_seq_column(seq_column, delta_pos, &key);

        }

        // If the table have sequence column, and the include-cids don't contain the sequence

        // column, we need to update the primary key index builder at the end of this method.

        // At that time, we have a valid sequence column to encode the key with seq col.

        if (!_tablet_schema->has_sequence_col() || have_input_seq_column) {

            RETURN_IF_ERROR(_primary_key_index_builder->add_item(key));

        }

        // mark key with delete sign as deleted.

        bool have_delete_sign = (delete_signs != nullptr && delete_signs[block_pos] != 0);

        auto not_found_cb = [&]() {

            return _opts.rowset_ctx->partial_update_info->handle_new_key(

                    *_tablet_schema, [&]() -> std::string {

                        return block->dump_one_line(block_pos,

                                                    cast_set<int>(_num_sort_key_columns));

                    });

        };

        auto update_read_plan = [&](const RowLocation& loc) {

            read_plan.prepare_to_read(loc, segment_pos);

        };

        RETURN_IF_ERROR(probe_key_for_mow(std::move(key), segment_pos, have_input_seq_column,

                                          have_delete_sign, specified_rowsets, segment_caches,

                                          has_default_or_nullable, use_default_or_null_flag,

                                          update_read_plan, not_found_cb, stats));

    }

    CHECK_EQ(use_default_or_null_flag.size(), num_rows);

    if (config::enable_merge_on_write_correctness_check) {

        _tablet->add_sentinel_mark_to_delete_bitmap(_mow_context->delete_bitmap.get(),

                                                    *_mow_context->rowset_ids);

    }

    // read to fill full block

    RETURN_IF_ERROR(read_plan.fill_missing_columns(

            _opts.rowset_ctx->make_historical_row_retriever_context(), _rsid_to_rowset,

            *_tablet_schema, full_block, use_default_or_null_flag, has_default_or_nullable,

            cast_set<uint32_t>(segment_start_pos), block));

    if (_tablet_schema->num_variant_columns() > 0) {

        RETURN_IF_ERROR(variant_util::parse_and_materialize_variant_columns(

                full_block, *_tablet_schema, missing_cids));

    }

    // convert block to row store format

    _serialize_block_to_row_column(full_block);

    // convert missing columns and send to column writer

    RETURN_IF_ERROR(_olap_data_convertor->set_source_content_with_specifid_columns(

            &full_block, row_pos, num_rows, missing_cids));

    for (auto cid : missing_cids) {

        auto converted_result = _olap_data_convertor->convert_column_data(cid);

        if (!converted_result.first.ok()) {

            return converted_result.first;

        }

        if (_tablet_schema->has_sequence_col() && !have_input_seq_column &&

            cid == _tablet_schema->sequence_col_idx()) {

            DCHECK_EQ(seq_column, nullptr);

            seq_column = converted_result.second;

        }

        RETURN_IF_ERROR(_column_writers[cid]->append(converted_result.second->get_nullmap(),

                                                     converted_result.second->get_data(),

                                                     num_rows));

    }

    _num_rows_updated += stats.num_rows_updated;

    _num_rows_deleted += stats.num_rows_deleted;

    _num_rows_new_added += stats.num_rows_new_added;

    _num_rows_filtered += stats.num_rows_filtered;

    if (_tablet_schema->has_sequence_col() && !have_input_seq_column) {

        DCHECK_NE(seq_column, nullptr);

        if (_num_rows_written != row_pos ||

            _primary_key_index_builder->num_rows() != _num_rows_written) {

            return Status::InternalError(

                    "Correctness check failed, _num_rows_written: {}, row_pos: {}, primary key "

                    "index builder num rows: {}",

                    _num_rows_written, row_pos, _primary_key_index_builder->num_rows());

        }

        RETURN_IF_ERROR(

                _generate_primary_key_index(_key_coders, key_columns, seq_column, num_rows, false));

    }

    _num_rows_written += num_rows;

    DCHECK_EQ(_primary_key_index_builder->num_rows(), _num_rows_written)

            << "primary key index builder num rows(" << _primary_key_index_builder->num_rows()

            << ") not equal to segment writer's num rows written(" << _num_rows_written << ")";

    _olap_data_convertor->clear_source_content();

    return Status::OK();

}

Status SegmentWriter::append_block(const Block* block, size_t row_pos, size_t num_rows) {

    if (_opts.rowset_ctx->partial_update_info &&

        _opts.rowset_ctx->partial_update_info->is_partial_update() &&

        _opts.write_type == DataWriteType::TYPE_DIRECT &&

        !_opts.rowset_ctx->is_transient_rowset_writer) {

        if (_opts.rowset_ctx->partial_update_info->is_fixed_partial_update()) {

            RETURN_IF_ERROR(append_block_with_partial_content(block, row_pos, num_rows));

        } else {

            return Status::NotSupported<false>(

                    "SegmentWriter doesn't support flexible partial update, please set "

                    "enable_vertical_segment_writer=true in be.conf on all BEs to use "

                    "VerticalSegmentWriter.");

        }

        return Status::OK();

    }

    if (block->columns() < _column_writers.size()) {

        return Status::InternalError(

                "block->columns() < _column_writers.size(), block->columns()=" +

                std::to_string(block->columns()) +

                ", _column_writers.size()=" + std::to_string(_column_writers.size()) +

                ", _tablet_schema->dump_structure()=" + _tablet_schema->dump_structure());

    }

    CHECK(block->columns() >= _column_writers.size())

            << ", block->columns()=" << block->columns()

            << ", _column_writers.size()=" << _column_writers.size()

            << ", _tablet_schema->dump_structure()=" << _tablet_schema->dump_structure();

    // Row column should be filled here when it's a directly write from memtable

    // or it's schema change write(since column data type maybe changed, so we should reubild)

    if (_opts.write_type == DataWriteType::TYPE_DIRECT ||

        _opts.write_type == DataWriteType::TYPE_SCHEMA_CHANGE) {

        _serialize_block_to_row_column(*block);

    }

    if (_opts.rowset_ctx->write_type != DataWriteType::TYPE_COMPACTION &&

        _tablet_schema->num_variant_columns() > 0) {

        RETURN_IF_ERROR(variant_util::parse_and_materialize_variant_columns(

                const_cast<Block&>(*block), *_tablet_schema, _column_ids));

    }

    _olap_data_convertor->set_source_content(block, row_pos, num_rows);

    // convert column data from engine format to storage layer format

    std::vector<IOlapColumnDataAccessor*> key_columns;

    IOlapColumnDataAccessor* seq_column = nullptr;

    for (size_t id = 0; id < _column_writers.size(); ++id) {

        // olap data convertor alway start from id = 0

        auto converted_result = _olap_data_convertor->convert_column_data(id);

        if (!converted_result.first.ok()) {

            return converted_result.first;

        }

        auto cid = _column_ids[id];

        if (_has_key && cid < _tablet_schema->num_key_columns()) {

            key_columns.push_back(converted_result.second);

        } else if (_has_key && _tablet_schema->has_sequence_col() &&

                   cid == _tablet_schema->sequence_col_idx()) {

            seq_column = converted_result.second;

        }

        RETURN_IF_ERROR(_column_writers[id]->append(converted_result.second->get_nullmap(),

                                                    converted_result.second->get_data(), num_rows));

    }

    if (_opts.write_type == DataWriteType::TYPE_COMPACTION) {

        RETURN_IF_ERROR(

                _variant_stats_calculator->calculate_variant_stats(block, row_pos, num_rows));

    }

    RETURN_IF_ERROR(build_key_index(key_columns, seq_column, num_rows));

    _num_rows_written += num_rows;

    _olap_data_convertor->clear_source_content();

    return Status::OK();

}

Status SegmentWriter::build_key_index(std::vector<IOlapColumnDataAccessor*>& key_columns,

                                      IOlapColumnDataAccessor* seq_column, size_t num_rows) {

    if (!_has_key) {

        return Status::OK();

    }

    // find all row pos for short key indexes

    std::vector<size_t> short_key_pos;

    if (UNLIKELY(_short_key_row_pos == 0 && _num_rows_written == 0)) {

        short_key_pos.push_back(0);

    }

    while (_short_key_row_pos + _opts.num_rows_per_block < _num_rows_written + num_rows) {

        _short_key_row_pos += _opts.num_rows_per_block;

        short_key_pos.push_back(_short_key_row_pos - _num_rows_written);

    }

    if (_is_mow_with_cluster_key()) {

        // For CLUSTER BY tables:

        // 1) generate primary key index (unique keys)

        RETURN_IF_ERROR(_generate_primary_key_index(_primary_key_coders, key_columns, seq_column,

                                                    num_rows, true));

        // 2) generate short key index (cluster keys)

        key_columns.clear();

        for (const auto& cid : _tablet_schema->cluster_key_uids()) {

            auto cluster_key_index = _tablet_schema->field_index(cid);

            if (cluster_key_index == -1) {

                return Status::InternalError("could not find cluster key column with unique_id=" +

                                             std::to_string(cid) + " in tablet schema");

            }

            bool found = false;

            for (auto i = 0; i < _column_ids.size(); ++i) {

                if (_column_ids[i] == cluster_key_index) {

                    auto converted_result = _olap_data_convertor->convert_column_data(i);

                    if (!converted_result.first.ok()) {

                        return converted_result.first;

                    }

                    key_columns.push_back(converted_result.second);

                    found = true;

                    break;

                }

            }

            if (!found) {

                return Status::InternalError(

                        "could not found cluster key column with unique_id=" + std::to_string(cid) +

                        ", tablet schema index=" + std::to_string(cluster_key_index));

            }

        }

        return _generate_short_key_index(key_columns, num_rows, short_key_pos);

    }

    if (_is_mow()) {

        return _generate_primary_key_index(_key_coders, key_columns, seq_column, num_rows, false);

    }

    return _generate_short_key_index(key_columns, num_rows, short_key_pos);

}

int64_t SegmentWriter::max_row_to_add(size_t row_avg_size_in_bytes) {

    auto segment_size = estimate_segment_size();

    if (segment_size >= MAX_SEGMENT_SIZE || _num_rows_written >= _opts.max_rows_per_segment)

            [[unlikely]] {

        return 0;

    }

    int64_t size_rows = ((int64_t)MAX_SEGMENT_SIZE - (int64_t)segment_size) / row_avg_size_in_bytes;

    int64_t count_rows = (int64_t)_opts.max_rows_per_segment - _num_rows_written;

    return std::min(size_rows, count_rows);

}

std::string SegmentWriter::_full_encode_keys(

        const std::vector<IOlapColumnDataAccessor*>& key_columns, size_t pos, bool null_first) {

    assert(_key_index_size.size() == _num_sort_key_columns);

    assert(key_columns.size() == _num_sort_key_columns &&

           _key_coders.size() == _num_sort_key_columns);

    return _full_encode_keys(_key_coders, key_columns, pos, null_first);

}

std::string SegmentWriter::_full_encode_keys(

        const std::vector<const KeyCoder*>& key_coders,

        const std::vector<IOlapColumnDataAccessor*>& key_columns, size_t pos, bool null_first) {

    assert(key_columns.size() == key_coders.size());

    std::string encoded_keys;

    size_t cid = 0;

    for (const auto& column : key_columns) {

        auto field = column->get_data_at(pos);

        if (UNLIKELY(!field)) {

            if (null_first) {

                encoded_keys.push_back(KEY_NULL_FIRST_MARKER);

            } else {

                encoded_keys.push_back(KEY_NORMAL_MARKER);

            }

            ++cid;

            continue;

        }

        encoded_keys.push_back(KEY_NORMAL_MARKER);

        DCHECK(key_coders[cid] != nullptr);

        key_coders[cid]->full_encode_ascending(field, &encoded_keys);

        ++cid;

    }

    return encoded_keys;

}

void SegmentWriter::_encode_seq_column(const IOlapColumnDataAccessor* seq_column, size_t pos,

                                       std::string* encoded_keys) {

    auto field = seq_column->get_data_at(pos);

    // To facilitate the use of the primary key index, encode the seq column

    // to the minimum value of the corresponding length when the seq column

    // is null

    if (UNLIKELY(!field)) {

        encoded_keys->push_back(KEY_NULL_FIRST_MARKER);

        size_t seq_col_length = _tablet_schema->column(_tablet_schema->sequence_col_idx()).length();

        encoded_keys->append(seq_col_length, KEY_MINIMAL_MARKER);

        return;

    }

    encoded_keys->push_back(KEY_NORMAL_MARKER);

    _seq_coder->full_encode_ascending(field, encoded_keys);

}

void SegmentWriter::_encode_rowid(const uint32_t rowid, std::string* encoded_keys) {

    encoded_keys->push_back(KEY_NORMAL_MARKER);

    _rowid_coder->full_encode_ascending(&rowid, encoded_keys);

}

std::string SegmentWriter::_encode_keys(const std::vector<IOlapColumnDataAccessor*>& key_columns,

                                        size_t pos) {

    assert(key_columns.size() == _num_short_key_columns);

    std::string encoded_keys;

    size_t cid = 0;

    for (const auto& column : key_columns) {

        auto field = column->get_data_at(pos);

        if (UNLIKELY(!field)) {

            encoded_keys.push_back(KEY_NULL_FIRST_MARKER);

            ++cid;

            continue;

        }

        encoded_keys.push_back(KEY_NORMAL_MARKER);

        _key_coders[cid]->encode_ascending(field, _key_index_size[cid], &encoded_keys);

        ++cid;

    }

    return encoded_keys;

}

// TODO(lingbin): Currently this function does not include the size of various indexes,

// We should make this more precise.

// NOTE: This function will be called when any row of data is added, so we need to

// make this function efficient.

uint64_t SegmentWriter::estimate_segment_size() {

    // footer_size(4) + checksum(4) + segment_magic(4)

    uint64_t size = 12;

    for (auto& column_writer : _column_writers) {

        size += column_writer->estimate_buffer_size();

    }

    if (_is_mow_with_cluster_key()) {

        size += _primary_key_index_builder->size() + _short_key_index_builder->size();

    } else if (_is_mow()) {

        size += _primary_key_index_builder->size();

    } else {

        size += _short_key_index_builder->size();

    }

    // update the mem_tracker of segment size

    _mem_tracker->consume(size - _mem_tracker->consumption());

    return size;

}

Status SegmentWriter::finalize_columns_data() {

    if (_has_key) {

        _row_count = _num_rows_written;

    } else {

        DCHECK(_row_count == _num_rows_written)

                << "_row_count != _num_rows_written:" << _row_count << " vs. " << _num_rows_written;

        if (_row_count != _num_rows_written) {

            std::stringstream ss;

            ss << "_row_count != _num_rows_written:" << _row_count << " vs. " << _num_rows_written;

            LOG(WARNING) << ss.str();

            return Status::InternalError(ss.str());

        }

    }

    _num_rows_written = 0;

    for (auto& column_writer : _column_writers) {

        RETURN_IF_ERROR(column_writer->finish());

    }

    RETURN_IF_ERROR(_write_data());

    return Status::OK();

}

Status SegmentWriter::finalize_columns_index(uint64_t* index_size) {

    uint64_t index_start = _file_writer->bytes_appended();

    RETURN_IF_ERROR(_write_ordinal_index());

    RETURN_IF_ERROR(_write_zone_map());

    RETURN_IF_ERROR(_write_inverted_index());

    RETURN_IF_ERROR(_write_ann_index());

    RETURN_IF_ERROR(_write_bloom_filter_index());

    *index_size = _file_writer->bytes_appended() - index_start;

    if (_has_key) {

        if (_is_mow_with_cluster_key()) {

            // 1. sort primary keys

            std::sort(_primary_keys.begin(), _primary_keys.end());

            // 2. write primary keys index

            std::string last_key;

            for (const auto& key : _primary_keys) {

                DCHECK(key.compare(last_key) > 0)

                        << "found duplicate key or key is not sorted! current key: " << key

                        << ", last key: " << last_key;