编写安全代码：小心使用realloc

本文的copyleft归[e-mail]所有，使用GPL发布，可以自由拷贝，转载。但转载请保持文档的完整性，注明原作者及原链接，严禁用于任何商业用途。
作者：[e-mail]
博客：linuxfocus.blog.chinaunix.net    

在良好的代码风格中，其中有一项要求就是，一个函数只做一件事情。如果该函数实现了多个功能，那基本上可以说这不是一个设计良好的函数。

今天看C库中的函数realloc。其原型是void *realloc(void *ptr, size_t size);函数说明如下：

realloc() changes the size of the memory block pointed to by ptr to size bytes. The contents will be unchanged to the minimum of the old and new sizes; newly allocated memory will be uninitialized. If ptr is NULL, the call is equivalent to malloc(size); if sizeis equal to zero, the call is equivalent to free(ptr). Unless ptr is NULL, it must have been returned by an earlier call to malloc(), calloc() or realloc(). If the area pointed to was moved, a free(ptr) is done.

总结一下，有以下几种行为：

1. 与名字相符，真正的realloc，参数ptr和size均不为NULL，重新调整内存大小，并将新的内存指针返回，并保证最小的size的内容不变；

2. 参数ptr为NULL，但size不为0，那么行为就等于malloc(size)；

3. 参数size为0，则realloc的行为为free(ptr)；

看，一个简单C库函数，却赋予了三种行为，所以这个realloc并不是设计良好的库函数。估计也是为了兼容性，才容忍这个函数一直在C库中。虽然在编码中，realloc会提供一定的方便，但是也很容易引发bug。

下面就举两个例子，来说明一下。

1. realloc第一种行为引发的bug

void *ptr = realloc(ptr, new_size);
if (!ptr) {
    错误处理
}

这里就引出了一个内存泄露的问题，当realloc分配失败的时候，会返回NULL。但是参数中的ptr的内存是没有被释放的。如果直接将realloc的返回值赋给ptr。那么当申请内存失败时，就会造成ptr原来指向的内存丢失，造成泄露。

正确的处理应该是这样

void *new_ptr = realloc(ptr, new_size);
if (!new_ptr) {
    错误处理。
}
ptr = new_ptr

2. 第三种行为引发的bug

大家应该知道，malloc(0)实际上是合法的语句，会返还一个合法的指针，且该指针可以通过free去释放。这就造成了很多人对realloc的错误理解，认为当size为0时，实际上realloc也会返回一个合法的指针，后面依然需要使用free去释放该内存。

void *new_ptr = realloc(old_ptr, new_size);

 //其它代码

 ...... ......

free(new_ptr);

由于错误的认识，不去检验new_size是否为0，还是按照new_size不为0的逻辑处理，最后并free(new_ptr）。这里就引入了double free的问题，造成程序崩溃。

从上面可以看出，在面对这个设计并非良好的API时，我们需要小心小心再小心。上面只是举了两个例子，其实还有一些其它的小问题。