getline使用过程详解

背景

最近做文本文件解析，需要按行解析，自然就想到了标准C函数getline，该函数定义如下:

#include <stdio.h>

ssize_t getline(char **lineptr, size_t *n, FILE *stream);

使用中出现一些问题，记录下来以供后续参考。

问题

参照函数定义编写如下代码:

#include <stdio.h>

#define MAX_SIZE_PER_LINE 128
static int parserTextFile(const char* fileNmae)
{
	FILE* file = fopen(fileNmae, "r");
	if(!file)
		return -1;

	char line[MAX_SIZE_PER_LINE];
	size_t len = MAX_SIZE_PER_LINE;
	
	while(!feof(file))
	{
		ssize_t size = getline(&line, &len, file);
		printf("%03ld %lu: %s\n", size, len, line);
	}

	fclose(file);

	return 0;
}

int main(int argc, char* argv[])
{
	if(argc > 1)
		parserTextFile(argv[1]);
	return 0;
}

运行该程序，直接出现如错误,
Segmentation fault (core dumped)

解决

通过分析发现编译时会有如下警告:

getline1.c:16:26: warning: passing argument 1 of ‘getline’ from incompatible pointer type [-Wincompatible-pointer-types]
   16 |   ssize_t size = getline(&line, &len, file);
      |                          ^~~~~
      |                          |
      |                          char (*)[128]
In file included from getline1.c:1:
/usr/include/stdio.h:616:45: note: expected ‘char ** restrict’ but argument is of type ‘char (*)[128]’

原来是类型不对，代码如下修改后编译警告没有了。

#include <stdio.h>

#define MAX_SIZE_PER_LINE 128
static int parserTextFile(const char* fileNmae)
{
	FILE* file = fopen(fileNmae, "r");
	if(!file)
		return -1;

	char data[MAX_SIZE_PER_LINE];
	char* line = data;
	size_t len = MAX_SIZE_PER_LINE;
	
	while(!feof(file))
	{
		ssize_t size = getline(&line, &len, file);
		printf("%03ld %lu: %s\n", size, len, line);
	}

	fclose(file);

	return 0;
}

int main(int argc, char* argv[])
{
	if(argc > 1)
		parserTextFile(argv[1]);
	return 0;
}

运行程序结果正确，但解析文件单行字符超过128时程序出现如下错误:

realloc(): invalid pointer
Aborted (core dumped)

到这里可以看出getline函数内部会重新分配内存，这里line指向的是栈内存，重新分配时出错导程序Aborted.

总结

上面程序如果想继续使用数组就需要将MAX_SIZE_PER_LINE设置的足够大,但还是不够健壮。有没有更好的解决调用方式呢？通过查看getline手册说明，可以让getline来分配内存来完美解决这个问题。
代码如下：

#include <stdio.h>
#include <stdlib.h>

static int parserTextFile(const char* fileNmae)
{
	FILE* file = fopen(fileNmae, "r");
	if(!file)
		return -1;

	char* line = NULL;
	size_t len = 0;
	
	while(!feof(file))
	{
		ssize_t size = getline(&line, &len, file);
		printf("%03ld %lu: %s\n", size, len, line);
	}
	free(line);
	fclose(file);

	return 0;
}

int main(int argc, char* argv[])
{
	if(argc > 1)
		parserTextFile(argv[1]);
	return 0;
}

总结：

• getline可以传递静态数组，不过数组需要定义的足够大,这种情况适用嵌入式系统（不适合频繁分配内存）。
• getline也可以传递空指针，让getline内部根据需要动态分配内存，使用完毕后需要外部释放内存。