SourceFormat Enforcement

[thirdparty/squid.git] / src / ipc / mem / Pages.h

diff --git a/src/ipc/mem/Pages.h b/src/ipc/mem/Pages.h
index bbd2023e4b9b5900590fe4106dce2bed35069efa..3ad47e4c2b53834f0d5a433c82e5655719ab8a96 100644 (file)
--- a/src/ipc/mem/Pages.h
+++ b/src/ipc/mem/Pages.h
@@ -1,52 +1,64 @@
 /*
- * $Id$
+ * Copyright (C) 1996-2017 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_IPC_MEM_PAGES_H
 #define SQUID_IPC_MEM_PAGES_H
 
-namespace Ipc {
+#include "ipc/mem/Page.h"
 
-namespace Mem {
-
-class PageId;
-
-/// initializes and configures shared memory [pools] for all kids
-void Init();
-
-/// attaches this kid to the already configured shared memory [pools]
-void Attach();
+namespace Ipc
+{
 
+namespace Mem
+{
 
 /* Single page manipulation */
 
 /// sets page ID and returns true unless no free pages are found
-bool GetPage(PageId &page);
+bool GetPage(const PageId::Purpose purpose, PageId &page);
 
 /// makes identified page available as a free page to future GetPage() callers
 void PutPage(PageId &page);
 
 /// converts page handler into a temporary writeable shared memory pointer
-void *PagePointer(const PageId &page);
-
+char *PagePointer(const PageId &page);
 
 /* Limits and statistics */
 
-/// the total number of shared memory bytes that can be in use at any time
-size_t Limit();
+/// the total number of shared memory pages that can be in use at any time
+size_t PageLimit();
+
+/// the total number of shared memory pages that can be in use at any
+/// time for given purpose
+size_t PageLimit(const int purpose);
 
-/// approximate total number of shared memory bytes used now
-size_t Level();
+/// approximate total number of shared memory pages used now
+size_t PageLevel();
 
-/// approximate total number of shared memory bytes we can allocate now
-inline size_t Available() { return Limit() - Level(); }
+/// approximate total number of shared memory pages used now for given purpose
+size_t PageLevel(const int purpose);
+
+/// approximate total number of shared memory pages we can allocate now
+inline size_t PagesAvailable() { return PageLimit() - PageLevel(); }
+
+/// approximate total number of shared memory pages we can allocate
+/// now for given purpose
+inline size_t PagesAvailable(const int purpose) { return PageLimit(purpose) - PageLevel(purpose); }
 
 /// returns page size in bytes; all pages are assumed to be the same size
 size_t PageSize();
 
+/// claim the need for a number of pages for a given purpose
+void NotePageNeed(const int purpose, const int count);
+
 } // namespace Mem
 
 } // namespace Ipc
 
 #endif // SQUID_IPC_MEM_PAGES_H
+