Maintenance: automate header guards 2/3 (#1655)

[thirdparty/squid.git] / src / mem / forward.h

diff --git a/src/mem/forward.h b/src/mem/forward.h
index 65d95e6bd5aa034750156147bb93ba1703a5760a..8a0b287fa14dd0fea5d3a163e4eec952bd35177c 100644 (file)
--- a/src/mem/forward.h
+++ b/src/mem/forward.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1996-2014 The Squid Software Foundation and contributors
+ * 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.
@@ -8,47 +8,69 @@
 
 /* DEBUG: section 13    High Level Memory Pool Management */
 
-#ifndef _SQUID_SRC_MEM_FORWARD_H
-#define _SQUID_SRC_MEM_FORWARD_H
+#ifndef SQUID_SRC_MEM_FORWARD_H
+#define SQUID_SRC_MEM_FORWARD_H
 
-/* for mem_type */
-#include "enums.h"
 #include "mem/AllocatorProxy.h"
-/* for FREE */
-#include "typedefs.h"
 
 #include <iosfwd>
 
 class StoreEntry;
-class MemPoolStats;
-class MemPoolMeter;
 
+/// Memory Management
 namespace Mem
 {
-    void Init();
-    void Report();
-    void Stats(StoreEntry *);
-    void CleanIdlePools(void *unused);
-    void Report(std::ostream &);
-    void PoolReport(const MemPoolStats * mp_st, const MemPoolMeter * AllMeter, std::ostream &);
+class Meter;
+class PoolMeter;
+class PoolStats;
+
+void Init();
+void Stats(StoreEntry *);
+void CleanIdlePools(void *unused);
+void Report(std::ostream &);
+void PoolReport(const PoolStats *, const PoolMeter *, std::ostream &);
 };
 
 extern const size_t squidSystemPageSize;
 
+/// \deprecated use MEMPROXY_CLASS instead.
+typedef void FREE(void *);
+
+/// Types of memory pool which do not yet use MEMPROXY_CLASS() API
+typedef enum {
+    MEM_NONE,
+    MEM_32B_BUF,
+    MEM_64B_BUF,
+    MEM_128B_BUF,
+    MEM_256B_BUF,
+    MEM_512B_BUF,
+    MEM_1K_BUF,
+    MEM_2K_BUF,
+    MEM_4K_BUF,
+    MEM_8K_BUF,
+    MEM_16K_BUF,
+    MEM_32K_BUF,
+    MEM_64K_BUF,
+    MEM_DREAD_CTRL,
+    MEM_DWRITE_Q,
+    MEM_MD5_DIGEST,
+    MEM_MAX
+} mem_type;
+
+/// Main cleanup handler.
 void memClean(void);
 void memInitModule(void);
 void memCleanModule(void);
 void memConfigure(void);
+/// Allocate one element from the typed pool
 void *memAllocate(mem_type);
-void *memAllocString(size_t net_size, size_t * gross_size);
 void *memAllocBuf(size_t net_size, size_t * gross_size);
 void *memReallocBuf(void *buf, size_t net_size, size_t * gross_size);
+/// Free a element allocated by memAllocate()
 void memFree(void *, int type);
-void memFreeString(size_t size, void *);
 void memFreeBuf(size_t size, void *);
 FREE *memFreeBufFunc(size_t size);
 int memInUse(mem_type);
-void memDataInit(mem_type, const char *, size_t, int, bool doZero = true);
-void memCheckInit(void);
 
-#endif /* _SQUID_SRC_MEM_FORWARD_H */
+#endif /* SQUID_SRC_MEM_FORWARD_H */
+