/*
 * Copyright (c) 2005, Raphael Manfredi
 *
 *----------------------------------------------------------------------
 * This file is part of gtk-gnutella.
 *
 *  gtk-gnutella is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  gtk-gnutella is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with gtk-gnutella; if not, write to the Free Software
 *  Foundation, Inc.:
 *      51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *----------------------------------------------------------------------
 */

/**
 * @ingroup lib
 * @file
 *
 * Memory pool, keeping track of malloc()'ed blocks of fixed size and
 * thereby avoiding too frequent malloc()/free()..  This is to be used
 * for large enough blocks, otherwise walloc() or even zalloc() should
 * be preferred.
 *
 * @author Raphael Manfredi
 * @date 2005
 */

#ifndef _palloc_h_
#define _palloc_h_

#include "common.h"

typedef void *(*pool_alloc_t)(size_t len);
typedef void (*pool_free_t)(void *addr, size_t len, bool fragment);
typedef bool (*pool_frag_t)(void *addr, size_t len);

typedef struct pool pool_t;

enum pool_info_magic { POOL_INFO_MAGIC = 0x467df483 };

/**
 * Pool information that can be retrieved.
 */
typedef struct {
	enum pool_info_magic magic;
	const char *name;				/**< Pool name (atom) */
	size_t size;					/**< Object size */
	size_t allocated;				/**< Amount of allocated objects */
	size_t available;				/**< Amount of available objects */
	uint64 allocations;				/**< Total amount of allocations */
	uint64 freeings;				/**< Total amount of freeings */
	uint64 alloc_pool;				/**< Allocations served from pool */
	uint64 alloc_core;				/**< Allocations that needed new memory */
	uint64 free_fragments;			/**< Objects freed as they were fragments */
	uint64 free_collected;			/**< Objects collected by the GC */
} pool_info_t;

static inline void
pool_info_check(const pool_info_t * const pi)
{
	g_assert(pi != NULL);
	g_assert(POOL_INFO_MAGIC == pi->magic);
}

/*
 * Public interface
 */

pool_t *pool_create(const char *name,
	size_t size, pool_alloc_t alloc, pool_free_t dealloc, pool_frag_t is_frag);
void pool_free(pool_t *pool);
size_t pool_count(const pool_t *p);
size_t pool_capacity(const pool_t *p);

void *palloc(pool_t *pool) G_NON_NULL;
void pfree(pool_t *pool, void *obj);
void pgc(void);

struct sha1;
void palloc_stats_digest(struct sha1 *digest);

void set_palloc_debug(uint32 level);

struct pslist *pool_info_list(void);
void pool_info_list_free_null(struct pslist **sl_ptr);
void palloc_dump_stats_log(logagent_t *la, unsigned options);
void palloc_dump_pool_log(logagent_t *la);
void palloc_dump_stats(void);

#endif	/* _palloc_h_ */

/* vi: set ts=4 sw=4 cindent: */
