PagePool.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 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_IPC_MEM_PAGEPOOL_H
#define SQUID_SRC_IPC_MEM_PAGEPOOL_H
 
#include "ipc/mem/Page.h"
#include "ipc/mem/PageStack.h"
#include "ipc/mem/Pointer.h"
 
namespace Ipc
{
 
namespace Mem
{
 
class PagePool
{
public:
    typedef Ipc::Mem::Owner<PageStack> Owner;
 
    static Owner *Init(const char *const shmId, const Ipc::Mem::PoolId stackId, const unsigned int capacity, const size_t pageSize);
 
    PagePool(const char *const id);
 
    unsigned int capacity() const { return pageIndex->capacity(); }
    size_t pageSize() const { return pageIndex->pageSize(); }
    unsigned int size() const { return pageIndex->size(); }
    size_t level() const { return capacity() - size(); }
    size_t level(const int purpose) const;
 
    bool get(const PageId::Purpose purpose, PageId &page);
    void put(PageId &page);
    char *pagePointer(const PageId &page);
 
private:
    Ipc::Mem::Pointer<PageStack> pageIndex; 
    using Levels_t = PageStack::Levels_t;
 
    Levels_t * const theLevels;
    char *const theBuf; 
};
 
} // namespace Mem
 
} // namespace Ipc
 
#endif /* SQUID_SRC_IPC_MEM_PAGEPOOL_H */