memp_priv.h File Reference

#include "lwip/opt.h"
#include "lwip/mem.h"

Go to the source code of this file.

Classes
struct	memp
struct	memp_desc

Macros
#define	MEMP_SIZE   0
#define	MEMP_ALIGN_SIZE(x)   (LWIP_MEM_ALIGN_SIZE(x))
#define	DECLARE_LWIP_MEMPOOL_DESC(desc)
#define	LWIP_MEMPOOL_DECLARE_STATS_INSTANCE(name)
#define	LWIP_MEMPOOL_DECLARE_STATS_REFERENCE(name)

Functions
void	memp_init_pool (const struct memp_desc *desc)
void *	memp_malloc_pool (const struct memp_desc *desc)
void	memp_free_pool (const struct memp_desc *desc, void *mem)

Detailed Description

memory pools lwIP internal implementations (do not use in application code)

Macro Definition Documentation

MEMP_SIZE

#define MEMP_SIZE   0

MEMP_ALIGN_SIZE

#define MEMP_ALIGN_SIZE

(

x

)

(LWIP_MEM_ALIGN_SIZE(x))

DECLARE_LWIP_MEMPOOL_DESC

#define DECLARE_LWIP_MEMPOOL_DESC

(

desc

)

LWIP_MEMPOOL_DECLARE_STATS_INSTANCE

#define LWIP_MEMPOOL_DECLARE_STATS_INSTANCE

(

name

)

LWIP_MEMPOOL_DECLARE_STATS_REFERENCE

#define LWIP_MEMPOOL_DECLARE_STATS_REFERENCE

(

name

)

Function Documentation

memp_init_pool()

void memp_init_pool

(

const struct memp_desc *

desc

)

Initialize custom memory pool. Related functions: memp_malloc_pool, memp_free_pool

Parameters

desc	pool to initialize

{
#if MEMP_MEM_MALLOC
  LWIP_UNUSED_ARG(desc);
#else
  int i;
  struct memp *memp;
 
  *desc->tab = NULL;
  memp = (struct memp*)LWIP_MEM_ALIGN(desc->base);
  /* create a linked list of memp elements */
  for (i = 0; i < desc->num; ++i) {
    memp->next = *desc->tab;
    *desc->tab = memp;
#if MEMP_OVERFLOW_CHECK
    memp_overflow_init_element(memp, desc);
#endif /* MEMP_OVERFLOW_CHECK */
   /* cast through void* to get rid of alignment warnings */
   memp = (struct memp *)(void *)((u8_t *)memp + MEMP_SIZE + desc->size
#if MEMP_OVERFLOW_CHECK
      + MEMP_SANITY_REGION_AFTER_ALIGNED
#endif
    );
  }
#if MEMP_STATS
  desc->stats->avail = desc->num;
#endif /* MEMP_STATS */
#endif /* !MEMP_MEM_MALLOC */
 
#if MEMP_STATS && (defined(LWIP_DEBUG) || LWIP_STATS_DISPLAY)
  desc->stats->name  = desc->desc;
#endif /* MEMP_STATS && (defined(LWIP_DEBUG) || LWIP_STATS_DISPLAY) */
}

Here is the caller graph for this function:

memp_malloc_pool()

void* memp_malloc_pool

(

const struct memp_desc *

desc

)

Get an element from a custom pool.

Parameters

desc	the pool to get an element from

Returns

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

{
  LWIP_ASSERT("invalid pool desc", desc != NULL);
  if (desc == NULL) {
    return NULL;
  }
 
#if !MEMP_OVERFLOW_CHECK
  return do_memp_malloc_pool(desc);
#else
  return do_memp_malloc_pool_fn(desc, file, line);
#endif
}

Here is the call graph for this function:

memp_free_pool()

void memp_free_pool	(	const struct memp_desc *	desc,
		void *	mem
	)

Put a custom pool element back into its pool.

Parameters

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

{
  LWIP_ASSERT("invalid pool desc", desc != NULL);
  if ((desc == NULL) || (mem == NULL)) {
    return;
  }
 
  do_memp_free_pool(desc, mem);
}

Here is the call graph for this function: