Pages.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_PAGES_H
#define SQUID_SRC_IPC_MEM_PAGES_H
 
#include "ipc/mem/Page.h"
 
namespace Ipc
{
 
namespace Mem
{
 
/* Single page manipulation */
 
bool GetPage(const PageId::Purpose purpose, PageId &page);
 
void PutPage(PageId &page);
 
char *PagePointer(const PageId &page);
 
/* Limits and statistics */
 
size_t PageLimit();
 
size_t PageLimit(const int purpose);
 
size_t PageLevel();
 
size_t PageLevel(const int purpose);
 
inline size_t PagesAvailable() { return PageLimit() - PageLevel(); }
 
inline size_t PagesAvailable(const int purpose) { return PageLimit(purpose) - PageLevel(purpose); }
 
size_t PageSize();
 
void NotePageNeed(const int purpose, const int count);
 
} // namespace Mem
 
} // namespace Ipc
 
#endif /* SQUID_SRC_IPC_MEM_PAGES_H */