f_malloc.h

Go to the documentation of this file.

/* $Id: f_malloc.h 5720 2009-03-18 12:55:53Z henningw $
 *
 * simple, very fast, malloc library
 *
 * Copyright (C) 2001-2003 FhG Fokus
 *
 * This file is part of Kamailio, a free SIP server.
 *
 * Kamailio 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
 *
 * Kamailio 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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)
 *  2007-06-23  added hash bitmap (andrei)
 */


#if !defined(f_malloc_h)
#define f_malloc_h

#ifdef DBG_QM_MALLOC
#define DBG_F_MALLOC
#endif

#include "meminfo.h"

/* defs*/

/* use a bitmap to quickly find free fragments, should speed up
 * especially startup (non-warmed-up malloc) */
#define F_MALLOC_HASH_BITMAP

#ifdef DBG_F_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_F_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)

#ifdef F_MALLOC_HASH_BITMAP
typedef unsigned long fm_hash_bitmap_t;
#define FM_HASH_BMP_BITS  (sizeof(fm_hash_bitmap_t)*8)
#define FM_HASH_BMP_SIZE  \
   ((F_HASH_SIZE+FM_HASH_BMP_BITS-1)/FM_HASH_BMP_BITS)
#endif

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

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

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

struct fm_block{
   unsigned long size; /* total size */
#if defined(DBG_F_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;
#ifdef F_MALLOC_HASH_BITMAP
   fm_hash_bitmap_t free_bitmap[FM_HASH_BMP_SIZE];
#endif
   
   struct fm_frag_lnk free_hash[F_HASH_SIZE];
};



struct fm_block* fm_malloc_init(char* address, unsigned long size);

#ifdef DBG_F_MALLOC
void* fm_malloc(struct fm_block*, unsigned long size,
               const char* file, const char* func, unsigned int line);
#else
void* fm_malloc(struct fm_block*, unsigned long size);
#endif

#ifdef DBG_F_MALLOC
void  fm_free(struct fm_block*, void* p, const char* file, const char* func, 
            unsigned int line);
#else
void  fm_free(struct fm_block*, void* p);
#endif

#ifdef DBG_F_MALLOC
void*  fm_realloc(struct fm_block*, void* p, unsigned long size, 
               const char* file, const char* func, unsigned int line);
#else
void*  fm_realloc(struct fm_block*, void* p, unsigned long size);
#endif

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

unsigned long fm_available(struct fm_block*);

#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)
{
   unsigned long frags;
   unsigned int r;
   for(r=0,frags=0;r<F_HASH_SIZE; r++){
      frags+=qm->free_hash[r].no;
   }
   return frags;
}
#endif /*STATISTICS*/

#endif