memp.h File Reference

#include "lwip/priv/memp_std.h"
#include "lwip/priv/memp_priv.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 *	memp_pools [MEMP_MAX]

Macro Definition Documentation

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

Definition at line 46 of file memp.h.

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

Definition at line 46 of file memp.h.

#define LWIP_MEMPOOL_ALLOC

(

name

)

memp_malloc_pool(&memp_ ## name)

Definition at line 102 of file memp.h.

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

Value:

u8_t memp_memory_ ## name ## _base \
    [((num) * (MEMP_SIZE + MEMP_ALIGN_SIZE(size)))]; \
    \
  static struct memp *memp_tab_ ## name; \
    \
  const struct memp_desc memp_ ## name = { \
    LWIP_MEM_ALIGN_SIZE(size), \
    (num), \
    DECLARE_LWIP_MEMPOOL_DESC(desc) \
    memp_memory_ ## name ## _base, \
    &memp_tab_ ## name \
  };

Definition at line 88 of file memp.h.

#define LWIP_MEMPOOL_FREE	(		name,
			x
	)		memp_free_pool(&memp_ ## name, (x))

Definition at line 103 of file memp.h.

#define LWIP_MEMPOOL_INIT

(

name

)

memp_init_pool(&memp_ ## name)

Definition at line 101 of file memp.h.

#define LWIP_MEMPOOL_PROTOTYPE

(

name

)

extern const struct memp_desc memp_ ## name

Definition at line 67 of file memp.h.

Enumeration Type Documentation

enum memp_t

Enumerator
MEMP_MAX

Definition at line 45 of file memp.h.

Function Documentation

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

Definition at line 399 of file memp.c.

void memp_init

(

void

)

Initialize this module.

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

Definition at line 232 of file memp.c.

void* memp_malloc

(

memp_t

type

)

Get an element from a specific pool.

Parameters

type	the pool to get an element from

the debug version has two more parameters:

Parameters

file	file name calling this function
line	number of line where this function is called

Returns

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

Definition at line 303 of file memp.c.

Variable Documentation

const struct memp_desc* memp_pools[MEMP_MAX]

Definition at line 75 of file memp.c.