f_malloc.h

/*
 * simple, very fast, malloc library
 *
 * Copyright (C) 2001-2003 FhG Fokus
 *
 * This file is part of opensips, a free SIP server.
 *
 * opensips 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
 *
 * opensips 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
 *
 * History:
 * --------
 *  2003-05-21  on sparc64 roundto 8 even in debugging mode (so malloc'ed
 *               long longs will be 64 bit aligned) (andrei)
 *  2004-07-19  support for 64 bit (2^64 mem. block) and more info
 *               for the future de-fragmentation support (andrei)
 *  2004-11-10  support for > 4Gb mem., switched to long (andrei)
 */


#if !defined(f_malloc_h) && !defined(QM_MALLOC) && !defined(HP_MALLOC)
#define f_malloc_h

#include "meminfo.h"

/* defs*/

#ifdef DBG_MALLOC
#if defined(__CPU_sparc64) || defined(__CPU_sparc)
/* tricky, on sun in 32 bits mode long long must be 64 bits aligned
 * but long can be 32 bits aligned => malloc should return long long
 * aligned memory */
	#define ROUNDTO		sizeof(long long)
#else
	#define ROUNDTO		sizeof(void*) /* size we round to, must be = 2^n, and
                      sizeof(fm_frag) must be multiple of ROUNDTO !*/
#endif
#else /* DBG_MALLOC */
	#define ROUNDTO 8UL
#endif
#define MIN_FRAG_SIZE	ROUNDTO



#define F_MALLOC_OPTIMIZE_FACTOR 14UL /*used below */
#define F_MALLOC_OPTIMIZE  (1UL<<F_MALLOC_OPTIMIZE_FACTOR)
								/* size to optimize for,
									(most allocs <= this size),
									must be 2^k */

#define F_HASH_SIZE (F_MALLOC_OPTIMIZE/ROUNDTO + \
		(sizeof(long)*8-F_MALLOC_OPTIMIZE_FACTOR)+1)

/* hash structure:
 * 0 .... F_MALLOC_OPTIMIZE/ROUNDTO  - small buckets, size increases with
 *                            ROUNDTO from bucket to bucket
 * +1 .... end -  size = 2^k, big buckets */

#define FRAG_OVERHEAD	(sizeof(struct fm_frag))
#define frag_is_free(_f) ((_f)->prev)

#define FRAG_NEXT(f) \
	((struct fm_frag *)((char *)(f) + sizeof(struct fm_frag) + (f)->size))

/* get the fragment which corresponds to a pointer */
#define FRAG_OF(p) \
	((struct fm_frag *)((char *)(p) - sizeof(struct fm_frag)))

struct fm_frag{
	unsigned long size;
	union{
		struct fm_frag* nxt_free;
		long reserved;
	}u;
        struct fm_frag ** prev;
#ifdef DBG_MALLOC
	const char* file;
	const char* func;
	unsigned long line;
	unsigned long check;
#endif

#if (defined DBG_MALLOC) || (defined SHM_EXTRA_STATS)
	char is_free;
#endif

#ifdef SHM_EXTRA_STATS
	unsigned long statistic_index;
#endif
};

struct fm_frag_lnk{
	struct fm_frag* first;
	unsigned long no;
};

struct fm_block{
	char *name; /* purpose of this memory block */

	unsigned long size; /* total size */
        unsigned long large_space;
        unsigned long large_limit;
    unsigned long fragments; /* number of fragments in use */
#if defined(DBG_MALLOC) || defined(STATISTICS)
	unsigned long used; /* alloc'ed size*/
	unsigned long real_used; /* used+malloc overhead*/
	unsigned long max_real_used;
#endif

	struct fm_frag* first_frag;
	struct fm_frag* last_frag;

	struct fm_frag_lnk free_hash[F_HASH_SIZE];
};


unsigned long frag_size(void* p);
struct fm_block* fm_malloc_init(char* address, unsigned long size, char* name);

#ifdef DBG_MALLOC
void *fm_malloc(struct fm_block* qm, unsigned long size,
                const char* file, const char* func, unsigned int line);
void fm_free(struct fm_block* qm, void* p, const char* file,
             const char* func, unsigned int line);
void *fm_realloc(struct fm_block* qm, void* p, unsigned long size,
                 const char* file, const char* func, unsigned int line);
#ifndef INLINE_ALLOC
void *fm_malloc_dbg(struct fm_block* qm, unsigned long size,
                    const char* file, const char* func, unsigned int line);
void fm_free_dbg(struct fm_block* qm, void* p, const char* file,
                 const char* func, unsigned int line);
void *fm_realloc_dbg(struct fm_block* qm, void* p, unsigned long size,
                     const char* file, const char* func, unsigned int line);
#endif
#else
void *fm_malloc(struct fm_block* qm, unsigned long size);
void fm_free(struct fm_block* qm, void* p);
void *fm_realloc(struct fm_block* qm, void* p, unsigned long size);
#endif

void fm_status(struct fm_block*);
void fm_info(struct fm_block*, struct mem_info*);

#ifdef SHM_EXTRA_STATS
void set_stat_index (void *ptr, unsigned long idx);
unsigned long get_stat_index(void *ptr);
void set_indexes(int core_index);
#endif

#ifdef DBG_MALLOC
	#define _FRAG_FILE(_p) ((struct fm_frag*)((char *)_p - sizeof(struct fm_frag)))->file
	#define _FRAG_FUNC(_p) ((struct fm_frag*)((char *)_p - sizeof(struct fm_frag)))->func
	#define _FRAG_LINE(_p) ((struct fm_frag*)((char *)_p - sizeof(struct fm_frag)))->line
#endif

#ifdef STATISTICS
static inline unsigned long fm_get_size(struct fm_block* qm)
{
	return qm->size;
}
static inline unsigned long fm_get_used(struct fm_block* qm)
{
	return qm->used;
}
static inline unsigned long fm_get_free(struct fm_block* qm)
{
	return qm->size-qm->real_used;
}
static inline unsigned long fm_get_real_used(struct fm_block* qm)
{
	return qm->real_used;
}
static inline unsigned long fm_get_max_real_used(struct fm_block* qm)
{
	return qm->max_real_used;
}
static inline unsigned long fm_get_frags(struct fm_block* qm)
{
	return qm->fragments;
}
#endif /*STATISTICS*/


#endif