AllocatorProxy.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2023 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
#ifndef _SQUID_SRC_MEM_ALLOCATORPROXY_H
#define _SQUID_SRC_MEM_ALLOCATORPROXY_H
 
// XXX: remove AllocatorProxy.h include from mem/forward.h
namespace Mem {
class Allocator;
class PoolStats;
}
 
#define MEMPROXY_CLASS(CLASS) \
    private: \
    static inline Mem::AllocatorProxy &Pool() { \
        static Mem::AllocatorProxy thePool(#CLASS, sizeof(CLASS), false); \
        return thePool; \
    } \
    public: \
    void *operator new(size_t byteCount) { \
        /* derived classes with different sizes must implement their own new */ \
        assert(byteCount == sizeof(CLASS)); \
        return Pool().alloc(); \
    } \
    void operator delete(void *address) { \
        if (address) \
            Pool().freeOne(address); \
    } \
    static int UseCount() { return Pool().inUseCount(); } \
    private:
 
namespace Mem
{
 
class PoolMeter;
 
class AllocatorProxy
{
public:
    AllocatorProxy(char const *aLabel, size_t const &aSize, bool doZeroBlocks = true):
        label(aLabel),
        size(aSize),
        theAllocator(nullptr),
        doZero(doZeroBlocks)
    {}
 
    void *alloc();
 
    void freeOne(void *);
 
    int inUseCount() const;
    size_t objectSize() const {return size;}
    char const * objectType() const {return label;}
 
    PoolMeter const &getMeter() const;
 
    size_t getStats(PoolStats &stats);
 
    void zeroBlocks(bool doIt);
 
    void relabel(const char * const aLabel);
 
private:
    Allocator *getAllocator() const;
 
    const char *label;
    size_t size;
    mutable Allocator *theAllocator;
    bool doZero;
};
 
} // namespace Mem
 
#endif /* _SQUID_SRC_MEM_ALLOCATORPROXY_H */