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

#include <cstring>

#include <functional>

#include <memory>

#include <vector>

#include "common/status.h"

#include "core/arena.h"

#include "core/block/block.h"

#include "core/custom_allocator.h"

#include "exprs/aggregate/aggregate_function.h"

#include "runtime/memory/mem_tracker.h"

#include "runtime/thread_context.h"

#include "storage/partial_update_info.h"

#include "storage/tablet/tablet_schema.h"

namespace doris {

class Schema;

class SlotDescriptor;

class TabletSchema;

struct TabletAddRowsPayload;

class TupleDescriptor;

enum KeysType : int;

// Active: the memtable is currently used by writer to insert into blocks

// Write_finished: the memtable finished write blocks and in the queue waiting for flush

// FLUSH: the memtable is under flushing, write segment to disk.

enum MemType { ACTIVE = 0, WRITE_FINISHED = 1, FLUSH = 2 };

// row pos in _input_mutable_block

struct RowInBlock {

    size_t _row_pos;

    int64_t _row_binlog_lsn = 0;

    char* _agg_mem = nullptr;

    size_t* _agg_state_offset = nullptr;

    bool _has_init_agg;

    RowInBlock(size_t row) : _row_pos(row), _has_init_agg(false) {}

    RowInBlock(size_t row, int64_t row_binlog_lsn)

            : _row_pos(row), _row_binlog_lsn(row_binlog_lsn), _has_init_agg(false) {}

    void init_agg_places(char* agg_mem, size_t* agg_state_offset) {

        _has_init_agg = true;

        _agg_mem = agg_mem;

        _agg_state_offset = agg_state_offset;

    }

    char* agg_places(size_t offset) const { return _agg_mem + _agg_state_offset[offset]; }

    inline bool has_init_agg() const { return _has_init_agg; }

    inline void remove_init_agg() { _has_init_agg = false; }

};

class RowInBlockComparator {

public:

    RowInBlockComparator(std::shared_ptr<TabletSchema> tablet_schema)

            : _tablet_schema(tablet_schema) {}

    // call set_block before operator().

    // only first time insert block to create _input_mutable_block,

    // so can not Comparator of construct to set pblock

    void set_block(MutableBlock* pblock) { _pblock = pblock; }

    int operator()(const RowInBlock* left, const RowInBlock* right) const;

private:

    std::shared_ptr<TabletSchema> _tablet_schema;

    MutableBlock* _pblock = nullptr; //  corresponds to Memtable::_input_mutable_block

};

class MemTableStat {

public:

    MemTableStat& operator+=(const MemTableStat& stat) {

        raw_rows += stat.raw_rows;

        merged_rows += stat.merged_rows;

        sort_ns += stat.sort_ns;

        agg_ns += stat.agg_ns;

        put_into_output_ns += stat.put_into_output_ns;

        duration_ns += stat.duration_ns;

        sort_times += stat.sort_times;

        agg_times += stat.agg_times;

        return *this;

    }

    std::atomic<int64_t> raw_rows = 0;

    std::atomic<int64_t> merged_rows = 0;

    int64_t sort_ns = 0;

    int64_t agg_ns = 0;

    int64_t put_into_output_ns = 0;

    int64_t duration_ns = 0;

    std::atomic<int64_t> sort_times = 0;

    std::atomic<int64_t> agg_times = 0;

};

class MemTable {

public:

    MemTable(int64_t tablet_id, std::shared_ptr<TabletSchema> tablet_schema,

             const std::vector<SlotDescriptor*>* slot_descs, TupleDescriptor* tuple_desc,

             bool enable_unique_key_mow, PartialUpdateInfo* partial_update_info,

             const std::shared_ptr<ResourceContext>& resource_ctx,

             bool need_row_binlog_lsn = false);

    ~MemTable();

    int64_t tablet_id() const { return _tablet_id; }

    size_t memory_usage() const { return _mem_tracker->consumption(); }

    size_t get_flush_reserve_memory_size() const;

    // insert tuple from (row_pos) to (row_pos+num_rows)

    Status insert(const Block* block, const TabletAddRowsPayload& rows);

    void shrink_memtable_by_agg();

    bool need_flush() const;

    bool need_agg() const;

    Status to_block(std::unique_ptr<Block>* res);

    const DorisVector<int64_t>& row_binlog_lsns() const { return _output_row_binlog_lsns; }

    bool empty() const { return _input_mutable_block.rows() == 0; }

    const MemTableStat& stat() { return _stat; }

    std::shared_ptr<ResourceContext> resource_ctx() { return _resource_ctx; }

    std::shared_ptr<MemTracker> mem_tracker() { return _mem_tracker; }

    void set_flush_success() { _is_flush_success = true; }

    MemType get_mem_type() { return _mem_type; }

    void update_mem_type(MemType memtype) { _mem_type = memtype; }

    int64_t raw_rows() { return _stat.raw_rows.load(); }

private:

    // for vectorized

    template <bool has_skip_bitmap_col>

    void _aggregate_two_row_in_block(MutableBlock& mutable_block, RowInBlock* new_row,

                                     RowInBlock* row_in_skiplist);

    // Merge row-binlog LSN sidecar only when MemTable merges two RowInBlock objects.

    // Table models that require complex merge semantics, such as AGG tables and unique key

    // merge-on-read tables, do not support row-binlog LSN now and are rejected in insert().

    void _merge_row_binlog_lsn(RowInBlock* src_row, RowInBlock* dst_row);

    void _append_output_row_binlog_lsn(RowInBlock* row);

    void _aggregate_two_row_with_sequence_map(MutableBlock& mutable_block, RowInBlock* new_row,

                                              RowInBlock* row_in_skiplist);

    // Used to wrapped by to_block to do exception handle logic

    Status _to_block(std::unique_ptr<Block>* res);

    int64_t _adaptive_write_buffer_size() const;

private:

    std::atomic<MemType> _mem_type;

    int64_t _tablet_id;

    bool _enable_unique_key_mow = false;

    bool _is_flush_success = false;

    UniqueKeyUpdateModePB _partial_update_mode {UniqueKeyUpdateModePB::UPSERT};

    const KeysType _keys_type;

    std::shared_ptr<TabletSchema> _tablet_schema;

    std::shared_ptr<RowInBlockComparator> _vec_row_comparator;

    std::shared_ptr<ResourceContext> _resource_ctx;

    std::shared_ptr<MemTracker> _mem_tracker;

    // Only the rows will be inserted into block can allocate memory from _arena.

    // In this way, we can make MemTable::memory_usage() to be more accurate, and eventually

    // reduce the number of segment files that are generated by current load

    Arena _arena;

    int64_t _load_mem_limit = -1;

    void _init_columns_offset_by_slot_descs(const std::vector<SlotDescriptor*>* slot_descs,

                                            const TupleDescriptor* tuple_desc);

    std::vector<int> _column_offset;

    // Number of rows inserted to this memtable.

    // This is not the rows in this memtable, because rows may be merged

    // in unique or aggregate key model.

    MemTableStat _stat;

    //for vectorized

    MutableBlock _input_mutable_block;

    MutableBlock _output_mutable_block;

    DorisVector<int64_t> _output_row_binlog_lsns;

    bool _need_row_binlog_lsn = false;

    size_t _last_sorted_pos = 0;

    size_t _last_agg_pos = 0;

    // Sorts `perm` (row positions into `block`) by `key_col_idx`, reusing the

    // vectorized ColumnSorter the query engine uses, then stabilises rows with

    // an equal key on ascending row position.

    // Returns the number of rows that share their key with a neighbour.

    static size_t _sort_permutation_by_key_columns(MutableBlock& block,

                                                   const std::vector<int>& key_col_idx,

                                                   IColumn::Permutation& perm);

    //return number of same keys

    size_t _sort();

    Status _sort_by_cluster_keys();

    template <bool is_final>

    void _finalize_one_row(RowInBlock* row, MutableBlock& mutable_block, int row_pos);

    void _init_row_for_agg(RowInBlock* row, MutableBlock& mutable_block);

    void _clear_row_agg(RowInBlock* row);

    template <bool is_final, bool has_skip_bitmap_col = false>

    void _aggregate();

    template <bool is_final>

    void _aggregate_for_flexible_partial_update_without_seq_col(

            MutableBlock& mutable_block,

            DorisVector<std::shared_ptr<RowInBlock>>& temp_row_in_blocks);

    template <bool is_final>

    void _aggregate_for_flexible_partial_update_with_seq_col(

            MutableBlock& mutable_block,

            DorisVector<std::shared_ptr<RowInBlock>>& temp_row_in_blocks);

    Status _put_into_output(Block& in_block);

    bool _is_first_insertion;

    void _init_agg_functions(const Block* block);

    std::vector<AggregateFunctionPtr> _agg_functions;

    std::vector<size_t> _offsets_of_aggregate_states;

    size_t _total_size_of_aggregate_states;

    std::unique_ptr<DorisVector<std::shared_ptr<RowInBlock>>> _row_in_blocks;

    size_t _num_columns;

    int32_t _seq_col_idx_in_block {-1};

    int32_t _skip_bitmap_col_idx {-1};

    int32_t _delete_sign_col_idx {-1};

    int32_t _delete_sign_col_unique_id {-1};

    int32_t _seq_col_unique_id {-1};

    bool _is_partial_update_and_auto_inc = false;

}; // class MemTable

} // namespace doris