MemoryManagerStatistic.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        Open3D: www.open3d.org                            -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.open3d.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
#include <cstddef>
#include <map>
#include <mutex>
#include <unordered_map>
 
#include "open3d/core/Device.h"
 
namespace open3d {
namespace core {
 
class MemoryManagerStatistic {
public:
    enum class PrintLevel {
        All = 0,
        Unbalanced = 1,
        None = 2,
    };
 
    static MemoryManagerStatistic& GetInstance();
 
    MemoryManagerStatistic(const MemoryManagerStatistic&) = delete;
    MemoryManagerStatistic& operator=(MemoryManagerStatistic&) = delete;
 
    ~MemoryManagerStatistic();

    void SetPrintLevel(PrintLevel level);

    void SetPrintAtProgramEnd(bool print);

    void SetPrintAtMallocFree(bool print);

    void Print() const;

    bool HasLeaks() const;

    void CountMalloc(void* ptr, size_t byte_size, const Device& device);

    void CountFree(void* ptr, const Device& device);

    void Reset();
 
private:
    MemoryManagerStatistic() = default;
 
    struct MemoryStatistics {
        bool IsBalanced() const;
 
        int64_t count_malloc_ = 0;
        int64_t count_free_ = 0;
        std::unordered_map<void*, size_t> active_allocations_;
    };

    PrintLevel level_ = PrintLevel::Unbalanced;

    bool print_at_program_end_ = true;

    bool print_at_malloc_free_ = false;
 
    std::mutex statistics_mutex_;
    std::map<Device, MemoryStatistics> statistics_;
};
 
}  // namespace core
}  // namespace open3d