glibc fread函数源码剖析

最近看APUE，看到了fread函数，就把之前想分析的一个函数借这个机会研究一下。

先写个程序，调用一下fread函数。

#include <stdio.h>

int main()
{
	char strbuf[12];
	FILE* fp;
	fp = fopen("./temp","r");
	fread(strbuf,sizeof(char),11,fp);
	return 0;
}

好了，还是咱们的老套路，通过gdb可以直接定位到fread的源码，源码如下，位于./libio/iofread.c。

_IO_size_t
_IO_fread (void *buf, _IO_size_t size, _IO_size_t count, _IO_FILE *fp)
{
  _IO_size_t bytes_requested = size * count;
  _IO_size_t bytes_read;
  CHECK_FILE (fp, 0);
  if (bytes_requested == 0)
    return 0;
  _IO_acquire_lock (fp);
  bytes_read = _IO_sgetn (fp, (char *) buf, bytes_requested);
  _IO_release_lock (fp);
  return bytes_requested == bytes_read ? count : bytes_read / size;
}
libc_hidden_def (_IO_fread)

#ifdef weak_alias
weak_alias (_IO_fread, fread)

# ifndef _IO_MTSAFE_IO
strong_alias (_IO_fread, __fread_unlocked)
libc_hidden_def (__fread_unlocked)
weak_alias (_IO_fread, fread_unlocked)
# endif
#endif

还是一样的套路，弱符号机制，不管该函数最后的导出名是什么，我们的注意力都聚焦到了_IO_fread，这个函数就是fread的函数体。一行一行的分析。

先看头两个变量：

  _IO_size_t bytes_requested = size * count;
  _IO_size_t bytes_read;

通过变量名基本可以确定，“bytes_requested”应该就是要读入的字节数，而“bytes_read”我估计是已经读出的字节数，这一点可通过我们接下来的源码分析进行验证。

CHECK_FILE (fp, 0);

这个看起来像函数调用的语句，我估计又是通过宏实现的，先在头文件里找一下。

果然没错：

# define CHECK_FILE(FILE, RET) COERCE_FILE (FILE)
# define COERCE_FILE(FILE) \
  (((FILE)->_IO_file_flags & _IO_MAGIC_MASK) == _OLD_MAGIC_MASK \
    && (FILE) = *(FILE**)&((int*)fp)[1])

在分析这么一个简单的宏函数过程中，我就遇到了非常多的问题，首先是第一点：

(FILE)->_IO_file_flags

我刚刚又看了一下struct _IO_FILE的定义，其中根本就没有_IO_file_flags成员，与之相关的定义倒是有一个：

#define _IO_file_flags _flags

不过这也不对头，这个define的作用也是把“_IO_file_flags”换成“_flags”。

关于这个问题暂且先存下吧，也许是咱们之前的某些分析不对，导致这一步理解的有问题。

((FILE)->_IO_file_flags & _IO_MAGIC_MASK)

这一句倒是没什么问题了，就是当前的文件标志与_IO_MAGIC_MASK做与运算。_IO_MAGIC_MASK的定义位于./libio/libio.h，值为0xFFFF0000，这一步的作用就是把所有文件标志位关闭，然后保留IO的魔数，这个IO魔数的值为0xFBAD0000，定义同样位于./libio/libio.h。但_OLD_MAGIC_MASK的值我就没有找到了。不过这一步的结果也比较明确不是0就是1。

第二句的功能我根本就没有分析出来。

&((int*)fp)[1])

首先将fp转化为int指针（此处的fp应该是某个全局变量），然后再取fp指针所在地址的第一项的地址。此时fp指针是一个int**类型的指针。

*(FILE**)&((int*)fp)[1])

再转化为FILE**类型，再取其第一个元素，对于这一系列操作的功能，我实在不能理解其深意，不过FILE指针结果还是两个不是指向一个地址，就是为NULL，与上一步的结果进行与运算，得到的结果不是1就是0，但我们的程序中并没有利用这一结果。

所以这一语句的功能我就不得而知了。

if (bytes_requested == 0)
    return 0;

没什么说的，如果需要读入的字节为0，则直接返回。

_IO_acquire_lock (fp);
  bytes_read = _IO_sgetn (fp, (char *) buf, bytes_requested);
  _IO_release_lock (fp);

这才是fread函数的主要功能，获取与释放所就不说了，直奔主题：_IO_sgetn函数。

_IO_size_t
_IO_sgetn (_IO_FILE *fp, void *data, _IO_size_t n)
{
  /* FIXME handle putback buffer here! */
  return _IO_XSGETN (fp, data, n);
}
libc_hidden_def (_IO_sgetn) //定义位于./libio/genops.c

#define _IO_XSGETN(FP, DATA, N) JUMP2 (__xsgetn, FP, DATA, N) //定义位于./libio/libioP.h

#define JUMP2(FUNC, THIS, X1, X2) (_IO_JUMPS_FUNC(THIS)->FUNC) (THIS, X1, X2) //定义位于./libio/libioP.h

相关的定义查找至此已经可以进行分析了，关于“_IO_JUMPS_FUNC”，定义太复杂了，就不展开来看了，通过这一宏定义的基本形式可以推断FUNC就是实际执行功能的函数。

所以又回到了“__xsgetn”这个函数上，在libioP.h有一个结构体的定义如下：

struct _IO_jump_t
{
    JUMP_FIELD(size_t, __dummy);
    JUMP_FIELD(size_t, __dummy2);
    JUMP_FIELD(_IO_finish_t, __finish);
    JUMP_FIELD(_IO_overflow_t, __overflow);
    JUMP_FIELD(_IO_underflow_t, __underflow);
    JUMP_FIELD(_IO_underflow_t, __uflow);
    JUMP_FIELD(_IO_pbackfail_t, __pbackfail);
    /* showmany */
    JUMP_FIELD(_IO_xsputn_t, __xsputn);
    JUMP_FIELD(_IO_xsgetn_t, __xsgetn);
    JUMP_FIELD(_IO_seekoff_t, __seekoff);
    JUMP_FIELD(_IO_seekpos_t, __seekpos);
    JUMP_FIELD(_IO_setbuf_t, __setbuf);
    JUMP_FIELD(_IO_sync_t, __sync);
    JUMP_FIELD(_IO_doallocate_t, __doallocate);
    JUMP_FIELD(_IO_read_t, __read);
    JUMP_FIELD(_IO_write_t, __write);
    JUMP_FIELD(_IO_seek_t, __seek);
    JUMP_FIELD(_IO_close_t, __close);
    JUMP_FIELD(_IO_stat_t, __stat);
    JUMP_FIELD(_IO_showmanyc_t, __showmanyc);
    JUMP_FIELD(_IO_imbue_t, __imbue);
#if 0
    get_column;
    set_column;
#endif
};

其中有关于I/O操作的定义，JUMP_FIELD的功能比较简单：

#define JUMP_FIELD(TYPE, NAME) TYPE NAME

现在就需要看看_IO_xsgetn_t的类型了。定义如下：

typedef _IO_size_t (*_IO_xsgetn_t) (_IO_FILE *FP, void *DATA, _IO_size_t N);

原来是一个函数指针，至此我们的线索已经全部用完了，直接搜索“_IO_xsgetn_t”与“__xsgetn”已无法得到什么有效结果了。

不过可通过“_IO_xsgetn_t”的注释略知一二。

/* The 'xsgetn' hook reads upto N characters into buffer DATA.
   Returns the number of character actually read.
   It matches the streambuf::xsgetn virtual function. */

xsgetn函数的功能就是读n个字节到DATA中，并返回实际读的字节数。

到此就算是我们的fread函数的功能分析完了吧，其实肯定没有分析完，fread在底层上一定是通过read实现功能的，而read是通过文件描述符对文件进行标记，因此这之间肯定还涉及参数的转换问题，这一功能我们已知可以通过fileno实现。

好了fread功能的实现就先分析到这里。