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

/*
 * Copyright (C) 1996-2014 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.
 */

/* DEBUG: section 13    High Level Memory Pool Management */

#ifndef _SQUID_SRC_MEM_FORWARD_H
#define _SQUID_SRC_MEM_FORWARD_H

#include "mem/AllocatorProxy.h"
/* for FREE */
#include "typedefs.h"

#include <iosfwd>

class StoreEntry;
class MemPoolStats;
class MemPoolMeter;

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 &);
};

extern const size_t squidSystemPageSize;

/// Types of memory pool which do not yet use MEMPROXY_CLASS() API
typedef enum {
    MEM_NONE,
    MEM_2K_BUF,
    MEM_4K_BUF,
    MEM_8K_BUF,
    MEM_16K_BUF,
    MEM_32K_BUF,
    MEM_64K_BUF,
    MEM_ACL_DENY_INFO_LIST,
    MEM_ACL_NAME_LIST,
#if USE_CACHE_DIGESTS
    MEM_CACHE_DIGEST,
#endif
    MEM_CLIENT_INFO,
    MEM_LINK_LIST,
    MEM_DLINK_NODE,
    MEM_DREAD_CTRL,
    MEM_DWRITE_Q,
    MEM_HTTP_HDR_CONTENT_RANGE,
    MEM_MD5_DIGEST,
    MEM_NETDBENTRY,
    MEM_NET_DB_NAME,
    MEM_RELIST,
    // IMPORTANT: leave this here. pools above are initialized early with memInit()
    MEM_DONTFREE,
    // following pools are initialized late by their component if needed (or never)
    MEM_FQDNCACHE_ENTRY,
    MEM_FWD_SERVER,
    MEM_IDNS_QUERY,
    MEM_IPCACHE_ENTRY,
    MEM_MAX
} mem_type;

void memClean(void);
void memInitModule(void);
void memCleanModule(void);
void memConfigure(void);
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);
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 */
Commit	Line	Data
528b2c61	1	/*
bbc27441	2	* Copyright (C) 1996-2014 The Squid Software Foundation and contributors
528b2c61	3	*
bbc27441 AJ	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.
528b2c61	7	*/
bbc27441 AJ	8
	9	/* DEBUG: section 13 High Level Memory Pool Management */
	10
ed6e9fb9 AJ	11	#ifndef _SQUID_SRC_MEM_FORWARD_H
ed6e9fb9 AJ	12	#define _SQUID_SRC_MEM_FORWARD_H
528b2c61	13
ed6e9fb9	14	#include "mem/AllocatorProxy.h"
8a89c28f FC	15	/* for FREE */
	16	#include "typedefs.h"
	17
427854fb	18	#include <iosfwd>
27e059d4	19
e1f7507e AJ	20	class StoreEntry;
	21	class MemPoolStats;
	22	class MemPoolMeter;
62ee09ca	23
ed6e9fb9	24	namespace Mem
62e76326	25	{
ed6e9fb9 AJ	26	void Init();
	27	void Report();
	28	void Stats(StoreEntry *);
	29	void CleanIdlePools(void *unused);
	30	void Report(std::ostream &);
	31	void PoolReport(const MemPoolStats * mp_st, const MemPoolMeter * AllMeter, std::ostream &);
528b2c61	32	};
528b2c61	33
43d1bbe4 FC	34	extern const size_t squidSystemPageSize;
43d1bbe4 FC	35
169a73ce AJ	36	/// Types of memory pool which do not yet use MEMPROXY_CLASS() API
	37	typedef enum {
	38	MEM_NONE,
	39	MEM_2K_BUF,
	40	MEM_4K_BUF,
	41	MEM_8K_BUF,
	42	MEM_16K_BUF,
	43	MEM_32K_BUF,
	44	MEM_64K_BUF,
	45	MEM_ACL_DENY_INFO_LIST,
	46	MEM_ACL_NAME_LIST,
	47	#if USE_CACHE_DIGESTS
	48	MEM_CACHE_DIGEST,
	49	#endif
	50	MEM_CLIENT_INFO,
	51	MEM_LINK_LIST,
	52	MEM_DLINK_NODE,
	53	MEM_DREAD_CTRL,
	54	MEM_DWRITE_Q,
	55	MEM_HTTP_HDR_CONTENT_RANGE,
	56	MEM_MD5_DIGEST,
	57	MEM_NETDBENTRY,
	58	MEM_NET_DB_NAME,
	59	MEM_RELIST,
	60	// IMPORTANT: leave this here. pools above are initialized early with memInit()
	61	MEM_DONTFREE,
	62	// following pools are initialized late by their component if needed (or never)
	63	MEM_FQDNCACHE_ENTRY,
	64	MEM_FWD_SERVER,
	65	MEM_IDNS_QUERY,
	66	MEM_IPCACHE_ENTRY,
	67	MEM_MAX
	68	} mem_type;
	69
8a648e8d FC	70	void memClean(void);
	71	void memInitModule(void);
	72	void memCleanModule(void);
	73	void memConfigure(void);
	74	void *memAllocate(mem_type);
	75	void memAllocString(size_t net_size, size_t gross_size);
	76	void memAllocBuf(size_t net_size, size_t gross_size);
	77	void memReallocBuf(void buf, size_t net_size, size_t * gross_size);
	78	void memFree(void *, int type);
	79	void memFreeString(size_t size, void *);
	80	void memFreeBuf(size_t size, void *);
	81	FREE *memFreeBufFunc(size_t size);
	82	int memInUse(mem_type);
3b08e399	83	void memDataInit(mem_type, const char *, size_t, int, bool doZero = true);
8a648e8d	84	void memCheckInit(void);
8a89c28f	85
ed6e9fb9	86	#endif /* _SQUID_SRC_MEM_FORWARD_H */