#include "lwip/opt.h"
#include "lwip/memp.h"
#include "lwip/pbuf.h"
#include "lwip/udp.h"
#include "lwip/raw.h"
#include "lwip/tcp.h"
#include "lwip/igmp.h"
#include "lwip/api.h"
#include "lwip/api_msg.h"
#include "lwip/tcpip.h"
#include "lwip/sys.h"
#include "lwip/stats.h"
#include "netif/etharp.h"
#include "lwip/ip_frag.h"
#include <string.h>
#if !MEMP_MEM_MALLOC /* don't build if not configured for use in lwipopts.h */
//MEMP_MEM_MALLOC 这个的意思是以内存堆的方式实现内存池函数,
//这个值为1就说明memp.c里面的函数不会编译了
struct memp {
struct memp *next;//
#if MEMP_OVERFLOW_CHECK
const char *file;// 发生溢出时调用函数的文件名
int line; // 发生溢出时调用函数的行号
#endif /* MEMP_OVERFLOW_CHECK */
};
#if MEMP_OVERFLOW_CHECK
/* 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
* them later. */
//如果溢出检测打开,我们在每一个元素的开始和结尾处预留一些字节,初始化他们并且在
//后面检测他们。
/* If MEMP_OVERFLOW_CHECK is >= 2, on every call to memp_malloc or memp_free,
* every single element in each pool is checked!
* This is VERY SLOW but also very helpful. */
//如果定义的检测值大于1,将会在每次调用memp_malloc 或者 memp_free,
//在每一个内存池中的每一个元素都需要被检测,但是这样的运行速度会很慢,但是很有效果。
/* MEMP_SANITY_REGION_BEFORE and MEMP_SANITY_REGION_AFTER can be overridden in
* lwipopts.h to change the amount reserved for checking. */
//可以在lwipopt.h中重新定义
//MEMP_SANITY_REGION_BEFORE and MEMP_SANITY_REGION_AFTER(元素首尾为溢出检测预留的字节)
#ifndef MEMP_SANITY_REGION_BEFORE
#define MEMP_SANITY_REGION_BEFORE 16
#endif /* MEMP_SANITY_REGION_BEFORE*/
#if MEMP_SANITY_REGION_BEFORE > 0
#define MEMP_SANITY_REGION_BEFORE_ALIGNED LWIP_MEM_ALIGN_SIZE(MEMP_SANITY_REGION_BEFORE)
#else
#define MEMP_SANITY_REGION_BEFORE_ALIGNED 0
#endif /* MEMP_SANITY_REGION_BEFORE 为预留空间的内存进行对齐*/
#ifndef MEMP_SANITY_REGION_AFTER
#define MEMP_SANITY_REGION_AFTER 16
#endif /* MEMP_SANITY_REGION_AFTER*/
#if MEMP_SANITY_REGION_AFTER > 0
#define MEMP_SANITY_REGION_AFTER_ALIGNED LWIP_MEM_ALIGN_SIZE(MEMP_SANITY_REGION_AFTER)
#else
#define MEMP_SANITY_REGION_AFTER_ALIGNED 0
#endif /* MEMP_SANITY_REGION_AFTER 为预留空间的内存进行对齐*/
/* MEMP_SIZE: save space for struct memp and for sanity check */
//为memp结构体和合理性检测节约空间,
//(定义memp_size为对齐后的memp结构体大小,和前预留字节)
//(定义MEMP_ALIGN_SIZE(x)为对齐后的x字节大小,再加上元素结尾预留的字节)
#define MEMP_SIZE (LWIP_MEM_ALIGN_SIZE(sizeof(struct memp)) + MEMP_SANITY_REGION_BEFORE_ALIGNED)
#define MEMP_ALIGN_SIZE(x) (LWIP_MEM_ALIGN_SIZE(x) + MEMP_SANITY_REGION_AFTER_ALIGNED)
#else /* MEMP_OVERFLOW_CHECK */
/* No sanity checks
* We don't need to preserve the struct memp while not allocated, so we
* can save a little space and set MEMP_SIZE to 0.
*/
//不进行可行性检测,当没有分配的时候,我们不需要为struct memp结构体预留空间
//因此节约一些空间,并且设置memp_size为0
#define MEMP_SIZE 0
#define MEMP_ALIGN_SIZE(x) (LWIP_MEM_ALIGN_SIZE(x))
#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];
#else /* MEMP_MEM_MALLOC */
#define MEMP_ALIGN_SIZE(x) (LWIP_MEM_ALIGN_SIZE(x))
#endif /* MEMP_MEM_MALLOC */
/** This array holds the element sizes of each pool. */
#if !MEM_USE_POOLS && !MEMP_MEM_MALLOC
static//static 定义的为静态变量,只能在本地函数里面使用,不能跨函数调用
//看一下上面的条件,一个是需要内存池的实现,一个是用内存池的方式代替内存堆
//也就是内存堆部分的函数都不会被定义,这种情况下,
//需要将保存各部分的内存大小的变量只用在本函数
#endif
//这边的#endif是预处理,会在预处理阶段就会被编译器去掉,所以在真正编译的时候会被去掉
const u16_t memp_sizes[MEMP_MAX] = {
#define LWIP_MEMPOOL(name,num,size,desc) LWIP_MEM_ALIGN_SIZE(size),
#include "lwip/memp_std.h"
};
#if !MEMP_MEM_MALLOC /* don't build if not configured for use in lwipopts.h */
//下面的两个只有在使用内存池的时候会被定义
/** This array holds the number of elements in each pool. */
//这个是用在定义不同内存池大小的的组
//memp_max是相关的枚举型变量的最后一个变量
//这一部分可以百度下老衲的内存管理部分的内容
//有相当详细的解释
static const u16_t memp_num[MEMP_MAX] = {
#define LWIP_MEMPOOL(name,num,size,desc) (num),
#include "lwip/memp_std.h"
};
/** This array holds a textual description of each pool. */
//这个数组里面的是被定义为使用的模块的函数名,用于调试信息的输出
#ifdef LWIP_DEBUG
static const char *memp_desc[MEMP_MAX] = {
#define LWIP_MEMPOOL(name,num,size,desc) (desc),
#include "lwip/memp_std.h"
};
#endif /* LWIP_DEBUG */
/** This is the actual memory used by the pools. */
//定义用的内存池空间,这里可以没有被预定义,但是可以想象一下,如果
//前面的num部分没有被编译,那么,这里的每一个num就不存在,所以
//如果内存池不被建立的话,这里就只被定义了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) ) )
#include "lwip/memp_std.h"
];
#if MEMP_SANITY_CHECK
/**
* Check that memp-lists don't form a circle
*///这里就是做的可行性测试
//这里比较有疑惑,也好理解,
//看代码,最外面的i的循环是很好理解的,有多少个种类的内存池
//就进行多少次的检测。
static int
memp_sanity(void)
{
s16_t i, c;
struct memp *m, *n;
for (i = 0; i < MEMP_MAX; i++)
{//内存池的种类
for (m = memp_tab[i]; m != NULL; m = m->next)
{//这里有点乱哈!相当于先保存首地址在m,然后用n来循环一下,检测有没有循环
//当然啦,个人感觉木有必要。在新版本的里面已经改掉了。
c = 1;//c的作用是这样的,如果循环的话,而且是在最后面,那么就有A->B->A->B
//这样的话,构成循环的基本就是至少检测了两次
for (n = memp_tab[i]; n != NULL; n = n->next)
{
if (n == m && --c < 0)return 0;
}
}
}
return 1;
}
#endif /* MEMP_SANITY_CHECK*/
#if MEMP_OVERFLOW_CHECK
/**
* Check if a memp element was victim of an overflow
* (e.g. the restricted area after it has been altered)
*
* @param p the memp element to check
* @param memp_size the element size of the pool p comes from
*/
//这里就是检测数据溢出的地方,
//输入的就是要检测的元素(包的地址)和包的长度
//检测的办法了,就是如果前或者尾部的用于校验长度大于0
//就分析里面的数据
static void
memp_overflow_check_element(struct memp *p, u16_t memp_size)
{
u16_t k;
u8_t *m;
#if MEMP_SANITY_REGION_BEFORE_ALIGNED > 0
m = (u8_t*)p + MEMP_SIZE - MEMP_SANITY_REGION_BEFORE_ALIGNED;
//这里的话(MEMP_SIZE=sizeof(struct memp)+MEMP_SANITY_REGION_BEFORE_ALIGNED)
//所以这里的操作就很容易明白了,就是偏移sizeof(struct memp)来指向校验部分的起始地址
//在下面的内存池释放中会将首地址传递进来
for (k = 0; k < MEMP_SANITY_REGION_BEFORE_ALIGNED; k++) {
if (m[k] != 0xcd) {
LWIP_ASSERT("detected memp underflow!", 0);//这里就是检测用虞校验的段里面的数据是不是0xcd;
}
}
#endif
#if MEMP_SANITY_REGION_AFTER_ALIGNED > 0
m = (u8_t*)p + MEMP_SIZE + memp_size;
//这里和前面的功能都是一样的,只不过这里是将地址偏移到结尾的校验首部
for (k = 0; k < MEMP_SANITY_REGION_AFTER_ALIGNED; k++) {
if (m[k] != 0xcd) {//同样的也是检测里面的数据
LWIP_ASSERT("detected memp overflow!", 0);
}
}
#endif
}
/**
* Do an overflow check for all elements in every pool.
*
* [url=home.php?mod=space&uid=8537]@see[/url] memp_overflow_check_element for a description of the check
*/
//这里的就是全部的检测啦,里面的程序还是很简单的。
//不过前题是要知道memp_num[],和memp_sizes[]
// num表示的是每一个类型,或者是功能吧
//MEMP_NUM_RAW_PCB
//MEMP_NUM_UDP_PCB
//MEMP_NUM_TCP_PCB
//这些的pcb申请都有几个,这些的pcb的个数,就是num
//size就很好理解了啦,就是表示每一个PCB的大小
static void
memp_overflow_check_all(void)
{
u16_t i, j;
struct memp *p;
p = LWIP_MEM_ALIGN(memp_memory);//这是我们的对齐后的内存池的首地址啦啦啦啦
for (i = 0; i < MEMP_MAX; ++i) {
p = p;//这里不是很理解
for (j = 0; j < memp_num[i]; ++j) {//看到memp_num[i]里面的i了吗?????
memp_overflow_check_element(p, memp_sizes[i]);//这里的就是上面的具体检测的函数
p = (struct memp*)((u8_t*)p + MEMP_SIZE + memp_sizes[i] + MEMP_SANITY_REGION_AFTER_ALIGNED);
//下面的这个地址的偏移计算还是很好理解的,括号里面的现在地址p,加上校验部分的前端的长度(包括memp结构体)
//再加上每一个类的元素的长度,再加上结尾的校验,最后就是将得到的偏移的首部强制转换一下,继续循环
}
}
}
/**
* Initialize the restricted areas of all memp elements in every pool.
*/
//终于要到分配了,最后一个函数!!加油加油!!
static void
memp_overflow_init(void)
{
u16_t i, j;
struct memp *p;
u8_t *m;
p = LWIP_MEM_ALIGN(memp_memory);//首地址
for (i = 0; i < MEMP_MAX; ++i) {
p = p;
for (j = 0; j < memp_num[i]; ++j) {
#if MEMP_SANITY_REGION_BEFORE_ALIGNED > 0
m = (u8_t*)p + MEMP_SIZE - MEMP_SANITY_REGION_BEFORE_ALIGNED;
memset(m, 0xcd, MEMP_SANITY_REGION_BEFORE_ALIGNED);
#endif
//大伙发现没有,这个和前面的检测的函数的结构域非常相似啊啊啊!!
//就是轮X一下每一个元素的首尾,将预留的,大于0个空间的校验区填入0xcd
#if MEMP_SANITY_REGION_AFTER_ALIGNED > 0
m = (u8_t*)p + MEMP_SIZE + memp_sizes[i];
memset(m, 0xcd, MEMP_SANITY_REGION_AFTER_ALIGNED);
#endif
p = (struct memp*)((u8_t*)p + MEMP_SIZE + memp_sizes[i] + MEMP_SANITY_REGION_AFTER_ALIGNED);
}
}
}
#endif /* MEMP_OVERFLOW_CHECK */
//结束啦啦啦
/**
* Initialize this module.
*
* Carves out memp_memory into linked lists for each pool-type.
*/
void
memp_init(void)
{
struct memp *memp;
u16_t i, j;
for (i = 0; i < MEMP_MAX; ++i) {//用于Lwip资源的统计
MEMP_STATS_AVAIL(used, i, 0);
MEMP_STATS_AVAIL(max, i, 0);
MEMP_STATS_AVAIL(err, i, 0);
MEMP_STATS_AVAIL(avail, i, memp_num[i]);//不过他居然跑到mem里面去了
}
memp = LWIP_MEM_ALIGN(memp_memory);//将对齐后的首地址移交
/* for every pool: */
for (i = 0; i < MEMP_MAX; ++i) {//这里的memp_max是在枚举内型的最后一个参数,代表了需要包含的
memp_tab[i] = NULL;
/* create a linked list of memp elements */
for (j = 0; j < memp_num[i]; ++j) {
memp->next = memp_tab[i];//做成链表!这里不好说,大家只能慢慢分析了,就是理顺过程,怎样构成一个链表的
memp_tab[i] = memp;
memp = (struct memp *)((u8_t *)memp + MEMP_SIZE + memp_sizes[i]
#if MEMP_OVERFLOW_CHECK
+ MEMP_SANITY_REGION_AFTER_ALIGNED//又是一句没头没尾的屁话。。。。。
//但是,但是,如果我们去掉预编译的地方,就会发现
//memp = (struct memp *)((u8_t *)memp + MEMP_SIZE + memp_sizes[i] + MEMP_SANITY_REGION_AFTER_ALIGNED
//所以。。。。。
//不解释。。。。。
#endif
);
}
}
#if MEMP_OVERFLOW_CHECK
memp_overflow_init();//初始化溢出校验
/* check everything a first time to see if it worked */
memp_overflow_check_all();//全部检测一遍
#endif /* MEMP_OVERFLOW_CHECK */
}
/**
* Get an element from a specific pool.
*
* @param type the pool to get an element from
*
* the debug version has two more parameters:
* @param file file name calling this function
* @param line number of line where this function is called
*
* [url=home.php?mod=space&uid=266161]@return[/url] a pointer to the allocated memory or a NULL pointer on error
*/
void *
#if !MEMP_OVERFLOW_CHECK
memp_malloc(memp_t type)//这里也没有啥好说的,type代表了申请的类型
#else
memp_malloc_fn(memp_t type, const char* file, const int line)//type一样,后面的是调用的文件名和行号(不清楚的继续向下看)
//file
#endif
{
struct memp *memp;
SYS_ARCH_DECL_PROTECT(old_level);
LWIP_ERROR("memp_malloc: type < MEMP_MAX", (type < MEMP_MAX), return NULL;);
SYS_ARCH_PROTECT(old_level);//上面的两句话表示的是在申请的过程中不被任何事情打断
#if MEMP_OVERFLOW_CHECK >= 2
memp_overflow_check_all();//当定义的溢出保护为最高级别时,每一次的申请都会检测一次
#endif /* MEMP_OVERFLOW_CHECK >= 2 */
memp = memp_tab[type];//获取当前类型空间的第一个空闲空间的地址
if (memp != NULL) {
memp_tab[type] = memp->next;
//不为空的话,说明有,将地址缓存的对应地址更新到下一个空闲的空间
//当前的空闲空间被申请
#if MEMP_OVERFLOW_CHECK
memp->next = NULL;//这个next字段对于被分配出去的内存来说,毫无意义、所以可能根本不用关心它是什么值
memp->file = file;//这里会有疑问!可以在memp.h文件里面看到
//#define memp_malloc(t) memp_malloc_fn((t), __FILE__, __LINE__)
//在C语言里面__FILE__,和__LINE__有特殊的含义,
//__FILE__ :返回当前执行文件的完整路径和文件名,包含一个绝对路径
//__LINE__ :返回当前执行程序的行
memp->line = line;
#endif /* MEMP_OVERFLOW_CHECK */
MEMP_STATS_INC_USED(used, type);//统计
LWIP_ASSERT("memp_malloc: memp properly aligned", ((mem_ptr_t)memp % MEM_ALIGNMENT) == 0);
//(字节对齐判断,跟踪到后面是这个)
memp = (struct memp*)((u8_t*)memp + MEMP_SIZE);//直接定位到实际的数据区,跳过前面的溢出校验
}
else
{
LWIP_DEBUGF(MEMP_DEBUG | LWIP_DBG_LEVEL_SERIOUS, ("memp_malloc: out of memory in pool %s\n", memp_desc[type]));
MEMP_STATS_INC(err, type);//统计,跳过
}
SYS_ARCH_UNPROTECT(old_level);//关闭保护
return memp;
}
/**
* Put an element back into its pool.
*
* @param type the pool where to put mem
* @param mem the memp element to free
*/
//释放的话就很简单了
//输出一些调试信息。开启保护,将存放空闲首地址的数组更新一下
void
memp_free(memp_t type, void *mem)
{
struct memp *memp;
SYS_ARCH_DECL_PROTECT(old_level);
if (mem == NULL) {
return;
}
LWIP_ASSERT("memp_free: mem properly aligned",
((mem_ptr_t)mem % MEM_ALIGNMENT) == 0);
memp = (struct memp *)((u8_t*)mem - MEMP_SIZE);
SYS_ARCH_PROTECT(old_level);
#if MEMP_OVERFLOW_CHECK
#if MEMP_OVERFLOW_CHECK >= 2
memp_overflow_check_all();
#else
memp_overflow_check_element(memp, memp_sizes[type]);//这边的都是防止溢出的
#endif /* MEMP_OVERFLOW_CHECK >= 2 */
#endif /* MEMP_OVERFLOW_CHECK */
MEMP_STATS_DEC(used, type); //用于统计的
memp->next = memp_tab[type];
memp_tab[type] = memp;//更新数组
#if MEMP_SANITY_CHECK
LWIP_ASSERT("memp sanity", memp_sanity());//检测是否循环释放后的空间是否存在循环链表
#endif /* MEMP_SANITY_CHECK */
SYS_ARCH_UNPROTECT(old_level);
}
#endif /* MEMP_MEM_MALLOC */