mirror/lwip
1
0
Fork 0
mirror of https://github.com/lwip-tcpip/lwip.git synced 2024-08-23 22:56:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added documentation / minor code layout changes

Browse Source
This commit is contained in:
goldsimon 2007-11-25 10:43:28 +00:00
parent c7a0f32c98
commit 4ac4d56b53
1 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/core/memp.c
View File

@ -2,6 +2,8 @@
* @file * @file
* Dynamic pool memory manager * Dynamic pool memory manager
* *
* lwIP has dedicated pools for many structures (netconn, protocol control blocks,
* packet buffers, ...). All these pools are managed here.
*/ */
/* /*
@ -62,8 +64,6 @@ struct memp {
#endif /* MEMP_OVERFLOW_CHECK */ #endif /* MEMP_OVERFLOW_CHECK */
}; };
static struct memp *memp_tab[MEMP_MAX];
#if MEMP_OVERFLOW_CHECK #if MEMP_OVERFLOW_CHECK
/* if MEMP_OVERFLOW_CHECK is turned on, we reserve some bytes at the beginning /* if MEMP_OVERFLOW_CHECK is turned on, we reserve some bytes at the beginning
* and at the end of each element, initialize them as 0xcd and check * and at the end of each element, initialize them as 0xcd and check
@ -105,6 +105,11 @@ static struct memp *memp_tab[MEMP_MAX];
#endif /* MEMP_OVERFLOW_CHECK */ #endif /* MEMP_OVERFLOW_CHECK */
/** This array holds the first free element of each pool.
* Elements form a linked list. */
static struct memp *memp_tab[MEMP_MAX];
/** This array holds the element sizes of each pool. */
#if !MEM_USE_POOLS #if !MEM_USE_POOLS
static static
#endif #endif
@ -113,11 +118,13 @@ const u16_t memp_sizes[MEMP_MAX] = {
#include "lwip/memp_std.h" #include "lwip/memp_std.h"
}; };
/** This array holds the number of elements in each pool. */
static const u16_t memp_num[MEMP_MAX] = { static const u16_t memp_num[MEMP_MAX] = {
#define LWIP_MEMPOOL(name,num,size,desc) (num), #define LWIP_MEMPOOL(name,num,size,desc) (num),
#include "lwip/memp_std.h" #include "lwip/memp_std.h"
}; };
/** This array holds a textual description of each pool. */
#ifdef LWIP_DEBUG #ifdef LWIP_DEBUG
static const char *memp_desc[MEMP_MAX] = { static const char *memp_desc[MEMP_MAX] = {
#define LWIP_MEMPOOL(name,num,size,desc) (desc), #define LWIP_MEMPOOL(name,num,size,desc) (desc),
@ -125,6 +132,7 @@ static const char *memp_desc[MEMP_MAX] = {
}; };
#endif /* LWIP_DEBUG */ #endif /* LWIP_DEBUG */
/** This is the actual memory used by the pools. */
static u8_t memp_memory[MEM_ALIGNMENT - 1 static u8_t memp_memory[MEM_ALIGNMENT - 1
#define LWIP_MEMPOOL(name,num,size,desc) + ( (num) * (MEMP_SIZE + MEMP_ALIGN_SIZE(size) ) ) #define LWIP_MEMPOOL(name,num,size,desc) + ( (num) * (MEMP_SIZE + MEMP_ALIGN_SIZE(size) ) )
#include "lwip/memp_std.h" #include "lwip/memp_std.h"
@ -183,6 +191,7 @@ memp_overflow_check_element(struct memp *p, u16_t memp_size)
} }
#endif #endif
} }
/** /**
* Do an overflow check for all elements in every pool. * Do an overflow check for all elements in every pool.
* *
@ -203,6 +212,7 @@ memp_overflow_check_all(void)
} }
} }
} }
/** /**
* Initialize the restricted areas of all memp elements in every pool. * Initialize the restricted areas of all memp elements in every pool.
*/ */
@ -272,14 +282,18 @@ memp_init(void)
* Get an element from a specific pool. * Get an element from a specific pool.
* *
* @param type the pool to get an element from * @param type the pool to get an element from
*
* the debug version has two more parameters:
* @param file file name calling this function * @param file file name calling this function
* @param line number of line where this function is called * @param line number of line where this function is called
*
* @return a pointer to the allocated memory or a NULL pointer on error
*/ */
void * void *
#if MEMP_OVERFLOW_CHECK #if !MEMP_OVERFLOW_CHECK
memp_malloc_fn(memp_t type, const char* file, const int line)
#else
memp_malloc(memp_t type) memp_malloc(memp_t type)
#else
memp_malloc_fn(memp_t type, const char* file, const int line)
#endif #endif
{ {
struct memp *memp; struct memp *memp;