snprintf 招致的bug

snprintf 导致的bug

 

以下代码是有bug的, 不知到你看出来了否?

#include <stdio.h>
#include <unistd.h>
#include <set>
#include <vector>
#include <fstream>

using namespace std;

int main(int argc, char *argv[])
{
    const char* str_arr[] = {
        "1234567890",
        "abcdefghij",
        "oooooooooo"
    }; 
   
    char buf[10] = {0};

    int pos = 0;
    for (size_t i=0; i<sizeof(str_arr)/sizeof(char*); ++i)
    {  
        pos += snprintf(buf+pos, sizeof(buf)-pos, str_arr[i]); // bug
    }  
    printf("buf:%s\n", buf);
       
    return 0;
}

以上代码运行会core.

存在bug的原因在于snprintf的陷阱
1) 函数的第二个参数是 size_t, 所以, 如果传入负数, 后果很严重! 可能会导致写越界
2) 函数的返回值是欲写入的字节数, 而不是实际写入的字节数!!!

所以, 正确的写法应该是:

int main(int argc, char *argv[])
{
const char* str_arr[] = {
"1234567890",
"abcdefghij",
"oooooooooo"
};

char buf[20] = {0};

int ret = 0;
int pos = 0;
for (size_t i=0; i<sizeof(str_arr)/sizeof(char*); ++i)
{
ret = snprintf(buf+pos, sizeof(buf)-pos, str_arr[i]);

// 如果出错,或者返回值>=buf容量(意味着本次snprintf被截断)
if (ret==-1 || ret>=(int)(sizeof(buf)-pos))
{
break;
}

pos += ret;
}
printf("buf:%s\n", buf);

return 0;
}

以上代码运行结果:
buf:1234567890abcdefghi