源自最近遇到一个的问题,先介绍一下背景。项目中混用了C与C++编程范式,鉴于项目成员背景不一,每个模块的负责人可以自行2选1。同时为了提高效率,C范式的模块被允许使用STL库的部分容器(其实也就仅仅大量使用了vector而已)。开发环境是visual studio 2005 wiht sp1。
那么问题来了,在部分模块中,纯C结构体和包含C++类的结构体共存,但它们的内存布局是不同的,所需要的初始化方式、内存操作函数均不同(malloc、new、memset....)。
巧合的是,在vs2005下包含vector类的结构体可以使用C的内存操作函数,而不会出错。比如用malloc申请结构体内存,用memset清空整个结构体都没有问题,程序可以正确运行。所以使用C规范的模块很开心的无脑使用malloc,且都是全局变量也不涉及free的问题。
悲剧的是因为外部原因,开发环境要升级到vs2010,上面的巧合不复存在,程序会崩溃,并且因为各模块大量使用了memset的方式来初始化包含vector的结构体,还需要解决这类结构体的初始化问题,比如非vector的结构体成员要求清零。
从程序的角度来说,这是一个POD问题,以下是维基百科的POD介绍:Plain old data structure, 缩写为POD, 是C++语言的标准中定义的一类数据结构,POD适用于需要明确的数据底层操作的系统中。POD通常被用在系统的边界处,即指不同系统之间只能以底层数据的形式进行交互,系统的高层逻辑不能互相兼容。比如当对象的字段值是从外部数据中构建时,系统还没有办法对对象进行语义检查和解释,这时就适用POD来存储数据。
简单来说就是POD类型在源代码兼容于ANSI C时非常重要。POD对象与C语言的对应对象具有共同的一些特性,包括初始化、复制、内存布局、寻址。
我们的目标不仅仅是清除现有隐患,而且要建立一个机制避免后续类似问题,因为一旦将来有人误用内存操作,由于错误地点和崩溃地点完全不同,定位会非常麻烦。总的来说有以下几点需求:
- 清理现有的POD内存申请和释放操作,并为POD内存申请提供检查机制,在误用POD内存申请的时候报错,比如用malloc申请了非POD内存。
- 清理现有的memset操作,并为memset提供检查机制,不允许对非POD内存执行memset操作。
- 支持对非POD内存块的内存清零操作
具体操作的思路是清理所有使用malloc的地方,替换为新封装的内存申请函数,然后回归测试,失败的地方肯定就是有非法POD操作,视具体情况逐个解决即可。
- C内存布局(POD类型)的操作
1)动态申请和释放
封装的MemAlloc函数会检查申请的类型是否符合POD要求。释放操作比较简单,封装的MemFree函数直接调用C语言的free。
在vs2005和2008的标准库中没有is_pod函数,此时可以使用boost库的is_pod函数替代。
template<typename T>
T* MemAlloc(size_t a = 1)
{
assert(std::is_pod<T>::value == true && "MemAlloc POD error");
T* mem = (T*)malloc(a*sizeof(T));
return mem;
}
例:
TEST_STRU* pPdu = MemAlloc<TEST_STRU>(); //申请单个MAC_PDU内存块
TEST_STRU* pPduS = MemAlloc<TEST_STRU>(10); //申请10个MAC_PDU内存块
MemFree(pPdu);
MemFree(pPduS);
2)内存置位操作
用封装的置位函数替换标准memset函数,新函数会检查操作的类型是否符合POD要求。采用宏替换,简单粗暴,注意控制宏的生效范围。
template<typename T>
void pod_memset(T* p,int val, size_t size)
{
assert(std::is_pod<T>::value== true && "pod_memset POD error");
::memset(p, val, size);
}
#define memset pod_memset
- C++内存布局(非POD类型)的操作
1)动态申请与释放
对于需要内存清零的申请操作,分别被封装为MemNew函数和MemNewMulti函数,函数中使用了不太常用的operator new和placement new,相关知识点这里就不介绍了。相应的释放函数为MemDel和MemDelMulti。
对于不需要内存清零的动态内存操作,请使用语言自带的new和delete。
template<typename T>
T* MemNew()
{
T *p = (T*)operator new(sizeof(T));
::memset(p,0,sizeof(T));
new (p) T;
return p;
}
template<typename T>
void MemDel(T* p)
{
p->~T();
operator delete(p);
}
template<typename T>
T* MemNewMulti(size_t cnt)
{
T *p = (T*)operator new(sizeof(T)*cnt);
::memset(p,0,sizeof(T)*cnt);
for(size_t i=0; i < cnt; ++i)
{
new (&p[i]) T;
}
return p;
}
template<typename T>
void MemDelMulti(T* p, size_t cnt)
{
for(size_t i=0; i < cnt; ++i)
{
p[i].~T();
}
operator delete( p);
}
例:
TEST_STRUCT* pUser = MemNew<TEST_STRUCT>(); //申请单个TEST_STRUCT内存块,并清零
TEST_STRUCT* pUsers = MemNewMulti<TEST_STRUCT>(3); //申请3个TEST_STRUCT内存块,并清零
MemDel(pUser);
MemDelMulti(pUsers, 3); //释放3个USER内存块,注意需要额外输入释放的个数
2)内存置位操作
因为上面已经禁用了非POD的置位操作,误用替换后的memset会触发断言保护。
对于动态申请的非POD类型的内存清零用上面的申请函数即可,对于栈上定义的非POD结构体可以用以下方式来完成结构体成员的清零操作。
//假设parent下的ueInfo是包含C++类成员的结构体(TEST_STRUCT),需要将其中的其他POD成员初始化为0
TEST_STRUCT temp={0}; //临时变量,要求保证TEST_STRUCT的第一个成员可以用0进行初始化,如果第一个成员也是结构体或者是数组,可以写成{{0}}
parent.ueInfo = temp;