be/src/runtime/memory/memory_profile.h

// 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 <common/multi_version.h>

#include "util/runtime_profile.h"

namespace doris {
#include "common/compile_check_begin.h"

class MemoryProfile {
public:
    MemoryProfile();

    void refresh_memory_overview_profile();
    void refresh_tasks_memory_profile();

    void make_memory_profile(RuntimeProfile* profile) const;

    std::string print_memory_overview_profile() const {
        return _memory_overview_profile->pretty_print();
    }

    std::string print_global_memory_profile() const {
        return _global_memory_profile.get()->pretty_print();
    }

    std::string print_metadata_memory_profile() const {
        return _metadata_memory_profile.get()->pretty_print();
    }

    std::string print_cache_memory_profile() const {
        return _cache_memory_profile.get()->pretty_print();
    }

    std::string print_top_memory_tasks_profile() const {
        return _top_memory_tasks_profile.get()->pretty_print();
    }

    std::string print_tasks_memory_profile() const {
        return _tasks_memory_profile.get()->pretty_print();
    }

    static int64_t query_current_usage();
    static int64_t load_current_usage();
    static int64_t compaction_current_usage();
    static int64_t schema_change_current_usage();
    static int64_t other_current_usage();

    // process memory changes more than 256M, or the GC ends
    void enable_print_log_process_usage() { _enable_print_log_process_usage = true; }
    void print_log_process_usage();
    std::string process_memory_detail_str() const;

private:
    void init_memory_overview_counter();

    std::unique_ptr<RuntimeProfile> _memory_overview_profile;
    MultiVersion<RuntimeProfile> _global_memory_profile;
    MultiVersion<RuntimeProfile> _metadata_memory_profile;
    MultiVersion<RuntimeProfile> _cache_memory_profile;
    MultiVersion<RuntimeProfile> _top_memory_tasks_profile;
    MultiVersion<RuntimeProfile> _tasks_memory_profile;

    // process memory counter
    RuntimeProfile::HighWaterMarkCounter* _process_physical_memory_usage_counter;
    RuntimeProfile::HighWaterMarkCounter* _process_virtual_memory_usage_counter;

    // untracked/tracked memory counter
    RuntimeProfile::HighWaterMarkCounter* _untracked_memory_usage_counter;
    RuntimeProfile::HighWaterMarkCounter* _tracked_memory_usage_counter;

    // Jemalloc memory counter
    RuntimeProfile::HighWaterMarkCounter* _jemalloc_memory_usage_counter;
    RuntimeProfile::HighWaterMarkCounter* _jemalloc_cache_usage_counter;
    RuntimeProfile::HighWaterMarkCounter* _jemalloc_metadata_usage_counter;

    // JVM memory counter
    RuntimeProfile::HighWaterMarkCounter* _jvm_heap_memory_usage_counter;
    RuntimeProfile::HighWaterMarkCounter* _jvm_non_heap_memory_usage_counter;

    // global/metadata/cache memory counter
    RuntimeProfile::HighWaterMarkCounter* _global_usage_counter;
    RuntimeProfile::HighWaterMarkCounter* _metadata_usage_counter;
    RuntimeProfile::HighWaterMarkCounter* _cache_usage_counter;

    // tasks memory counter
    RuntimeProfile::HighWaterMarkCounter* _tasks_memory_usage_counter;

    // Memtable memory counter
    RuntimeProfile::HighWaterMarkCounter* _memtable_memory_usage_counter;

    // reserved memory is the sum of all task reserved memory, is duplicated with all task memory counter.
    RuntimeProfile::HighWaterMarkCounter* _reserved_memory_usage_counter;
    RuntimeProfile::HighWaterMarkCounter* _query_usage_counter;
    RuntimeProfile::HighWaterMarkCounter* _load_usage_counter;
    RuntimeProfile::HighWaterMarkCounter* _compaction_usage_counter;
    RuntimeProfile::HighWaterMarkCounter* _schema_change_usage_counter;
    RuntimeProfile::HighWaterMarkCounter* _other_usage_counter;

    std::atomic<bool> _enable_print_log_process_usage {true};
};

#include "common/compile_check_end.h"
} // namespace doris