src/mem/forward.h

   1 /*
   2  * Copyright (C) 1996-2022 The Squid Software Foundation and contributors
   3  *
   4  * Squid software is distributed under GPLv2+ license and includes
   5  * contributions from numerous individuals and organizations.
   6  * Please see the COPYING and CONTRIBUTORS files for details.
   7  */
   8
   9 /* DEBUG: section 13    High Level Memory Pool Management */
  10
  11 #ifndef _SQUID_SRC_MEM_FORWARD_H
  12 #define _SQUID_SRC_MEM_FORWARD_H
  13
  14 #include "mem/AllocatorProxy.h"
  15
  16 #include <iosfwd>
  17
  18 class StoreEntry;
  19 class MemPoolStats;
  20 class MemPoolMeter;
  21
  22 /// Memory Management
  23 namespace Mem
  24 {
  25 void Init();
  26 void Report();
  27 void Stats(StoreEntry *);
  28 void CleanIdlePools(void *unused);
  29 void Report(std::ostream &);
  30 void PoolReport(const MemPoolStats * mp_st, const MemPoolMeter * AllMeter, std::ostream &);
  31 };
  32
  33 extern const size_t squidSystemPageSize;
  34
  35 /// \deprecated use MEMPROXY_CLASS instead.
  36 typedef void FREE(void *);
  37
  38 /// Types of memory pool which do not yet use MEMPROXY_CLASS() API
  39 typedef enum {
  40     MEM_NONE,
  41     MEM_2K_BUF,
  42     MEM_4K_BUF,
  43     MEM_8K_BUF,
  44     MEM_16K_BUF,
  45     MEM_32K_BUF,
  46     MEM_64K_BUF,
  47     MEM_DREAD_CTRL,
  48     MEM_DWRITE_Q,
  49     MEM_MD5_DIGEST,
  50     MEM_MAX
  51 } mem_type;
  52
  53 /// Main cleanup handler.
  54 void memClean(void);
  55 void memInitModule(void);
  56 void memCleanModule(void);
  57 void memConfigure(void);
  58 /// Allocate one element from the typed pool
  59 void *memAllocate(mem_type);
  60 void *memAllocString(size_t net_size, size_t * gross_size);
  61 void *memAllocBuf(size_t net_size, size_t * gross_size);
  62 void *memAllocRigid(size_t net_size);
  63 void *memReallocBuf(void *buf, size_t net_size, size_t * gross_size);
  64 /// Free a element allocated by memAllocate()
  65 void memFree(void *, int type);
  66 void memFreeString(size_t size, void *);
  67 void memFreeBuf(size_t size, void *);
  68 void memFreeRigid(void *, size_t net_size);
  69 FREE *memFreeBufFunc(size_t size);
  70 int memInUse(mem_type);
  71 void memDataInit(mem_type, const char *, size_t, int, bool doZero = true);
  72 void memCheckInit(void);
  73 size_t memStringCount();
  74
  75 #endif /* _SQUID_SRC_MEM_FORWARD_H */
  76