memp.h File Reference

#include "lwip/opt.h"
#include "lwip/priv/memp_std.h"
#include "lwip/priv/memp_priv.h"
#include "lwip/stats.h"

Go to the source code of this file.

Macros
#define	LWIP_MEMPOOL(name, num, size, desc)
#define	LWIP_MEMPOOL(name, num, size, desc)   MEMP_##name,
#define	LWIP_MEMPOOL_PROTOTYPE(name)   extern const struct memp_desc memp_ ## name
#define	LWIP_MEMPOOL_DECLARE(name, num, size, desc)
#define	LWIP_MEMPOOL_INIT(name)   memp_init_pool(&memp_ ## name)
#define	LWIP_MEMPOOL_ALLOC(name)   memp_malloc_pool(&memp_ ## name)
#define	LWIP_MEMPOOL_FREE(name, x)   memp_free_pool(&memp_ ## name, (x))

Enumerations
enum	memp_t { MEMP_MAX }

Functions
void	memp_init (void)
void *	memp_malloc (memp_t type)
void	memp_free (memp_t type, void *mem)

Variables
const struct memp_desc *const	memp_pools [MEMP_MAX]

Detailed Description

Memory pool API

Macro Definition Documentation

LWIP_MEMPOOL [1/2]

#define LWIP_MEMPOOL	(		name,
			num,
			size,
			desc
	)

LWIP_MEMPOOL [2/2]

#define LWIP_MEMPOOL	(		name,
			num,
			size,
			desc
	)		MEMP_##name,

Enumeration Type Documentation

memp_t

enum memp_t

Create the list of all memory pools managed by memp. MEMP_MAX represents a NULL pool at the end

Enumerator
MEMP_MAX

             {
#define LWIP_MEMPOOL(name,num,size,desc)  MEMP_##name,
#include "lwip/priv/memp_std.h"
  MEMP_MAX
} memp_t;

Function Documentation

memp_init()

void memp_init

(

void

)

Initializes lwIP built-in pools. Related functions: memp_malloc, memp_free

Carves out memp_memory into linked lists for each pool-type.

{
  u16_t i;
 
  /* for every pool: */
  for (i = 0; i < LWIP_ARRAYSIZE(memp_pools); i++) {
    memp_init_pool(memp_pools[i]);
 
#if LWIP_STATS && MEMP_STATS
    lwip_stats.memp[i] = memp_pools[i]->stats;
#endif
  }
 
#if MEMP_OVERFLOW_CHECK >= 2
  /* check everything a first time to see if it worked */
  memp_overflow_check_all();
#endif /* MEMP_OVERFLOW_CHECK >= 2 */
}

Here is the call graph for this function:

Here is the caller graph for this function:

memp_malloc()

void* memp_malloc

(

memp_t

type

)

Get an element from a specific pool.

Parameters

type	the pool to get an element from

Returns

a pointer to the allocated memory or a NULL pointer on error

{
  void *memp;
  LWIP_ERROR("memp_malloc: type < MEMP_MAX", (type < MEMP_MAX), return NULL;);
 
#if MEMP_OVERFLOW_CHECK >= 2
  memp_overflow_check_all();
#endif /* MEMP_OVERFLOW_CHECK >= 2 */
 
#if !MEMP_OVERFLOW_CHECK
  memp = do_memp_malloc_pool(memp_pools[type]);
#else
  memp = do_memp_malloc_pool_fn(memp_pools[type], file, line);
#endif
 
  return memp;
}

Here is the call graph for this function:

Here is the caller graph for this function:

memp_free()

void memp_free	(	memp_t	type,
		void *	mem
	)

Put an element back into its pool.

Parameters

type	the pool where to put mem
mem	the memp element to free

{
#ifdef LWIP_HOOK_MEMP_AVAILABLE
  struct memp *old_first;
#endif
 
  LWIP_ERROR("memp_free: type < MEMP_MAX", (type < MEMP_MAX), return;);
 
  if (mem == NULL) {
    return;
  }
 
#if MEMP_OVERFLOW_CHECK >= 2
  memp_overflow_check_all();
#endif /* MEMP_OVERFLOW_CHECK >= 2 */
 
#ifdef LWIP_HOOK_MEMP_AVAILABLE
  old_first = *memp_pools[type]->tab;
#endif
 
  do_memp_free_pool(memp_pools[type], mem);
 
#ifdef LWIP_HOOK_MEMP_AVAILABLE
  if (old_first == NULL) {
    LWIP_HOOK_MEMP_AVAILABLE(type);
  }
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

memp_pools

const struct memp_desc* const memp_pools[MEMP_MAX]