mempool.h

Go to the documentation of this file.

#pragma once
 
#include "backend/types.h"
 
#include <cstddef>
#include <memory>
#include <string>
#include <unordered_map>
#include <vector>
 
namespace fz {
 
struct AllocationInfo {
    void*       ptr;    
    size_t      size;   
    std::string tag;    
    bool        in_use; 
 
    AllocationInfo(void* p = nullptr, size_t s = 0, const std::string& t = "")
        : ptr(p), size(s), tag(t), in_use(true) {}
};
 
struct PersistentAllocInfo {
    void*       ptr;
    size_t      bytes;
    std::string tag;
    bool        is_pinned; 
};
 
struct MemoryPoolConfig {
    size_t input_data_size;      
    float  pool_size_multiplier; 
    int    device_id;            
    bool   enable_reuse;         
 
    bool force_fallback;          
 
    MemoryPoolConfig(
        size_t input_size    = 0,
        float  multiplier    = 3.0f,
        int    device        = 0,
        bool   reuse         = true,
        bool   force_fallback = false)
        : input_data_size(input_size),
          pool_size_multiplier(multiplier),
          device_id(device),
          enable_reuse(reuse),
          force_fallback(force_fallback) {}
 
    size_t getPoolSize() const {
        if (input_data_size == 0) return 1024ULL * 1024 * 1024;
        return static_cast<size_t>(input_data_size * pool_size_multiplier);
    }
};
 
class MemoryPool {
public:
    explicit MemoryPool(const MemoryPoolConfig& config = MemoryPoolConfig());
    ~MemoryPool();
 
    MemoryPool(const MemoryPool&)            = delete;
    MemoryPool& operator=(const MemoryPool&) = delete;
 
    // ── Stream-ordered allocation (I/O buffers) ───────────────────────────────
 
    void* allocate(size_t size, fz::stream_t stream,
                   const std::string& tag = "", bool persistent = false);
 
    void free(void* ptr, fz::stream_t stream);
 
    // ── Persistent allocation (stage-internal scratch) ────────────────────────
 
    void* allocatePersistentDevice(size_t bytes, const std::string& tag = "");
 
    void* allocatePersistentPinned(size_t bytes, const std::string& tag = "");
 
    void freePersistentDevice(void* ptr);
 
    void freePersistentPinned(void* ptr);
 
    // ── Lifecycle ─────────────────────────────────────────────────────────────
 
    void reset(fz::stream_t stream);
 
    void trim();
 
    void setReleaseThreshold(size_t bytes);
 
    void synchronize(fz::stream_t stream);
 
    // ── Stats & debug ─────────────────────────────────────────────────────────
 
    size_t getPersistentDeviceBytes() const { return persistent_device_bytes_; }
 
    size_t getPersistentPinnedBytes() const { return persistent_pinned_bytes_; }
 
    size_t getCurrentUsage() const {
        if (!mem_pool_) return current_allocated_bytes_;
        return fz::getPoolUsedMemCurrent(mem_pool_);
    }
 
    size_t getPeakUsage() const {
        if (!mem_pool_) return current_allocated_bytes_;
        return fz::getPoolUsedMemHigh(mem_pool_);
    }
 
    size_t getAllocationCount() const { return allocations_.size() + graph_allocations_.size(); }
 
    void printStats() const;
 
    size_t getConfiguredSize() const { return config_.getPoolSize(); }
 
    fz::mempool_t getMemPool() const { return mem_pool_; }
 
    bool isFallbackMode() const { return mem_pool_ == nullptr; }
 
    int getDeviceId() const { return config_.device_id; }
 
    // ── Lifetime token ────────────────────────────────────────────────────────
 
    std::weak_ptr<const void> lifetimeToken() const { return alive_; }
 
private:
    std::shared_ptr<const void> alive_ = std::make_shared<const char>('\0');
 
    MemoryPoolConfig config_;
    fz::mempool_t    mem_pool_;
 
    std::unordered_map<void*, AllocationInfo> allocations_;
    std::unordered_map<void*, AllocationInfo> graph_allocations_; 
 
    // Persistent allocations (device + pinned host) — freed individually or in destructor.
    std::vector<PersistentAllocInfo> persistent_allocs_;
    size_t persistent_device_bytes_ = 0;
    size_t persistent_pinned_bytes_ = 0;
 
    size_t total_allocations_;
    size_t total_frees_;
    // Host-side running total of live bytes — used for overflow detection without
    // querying a CUDA attribute on every hot-path allocation.
    size_t current_allocated_bytes_;
    // Set the first time current_allocated_bytes_ exceeds configured pool size
    // so the overflow warning fires only once per reset() cycle.
    bool   overflow_warned_;
    bool   initialized_;
 
    void initializeMemPool();
};
 
} // namespace fz