函数库学习入门指引

在学习某一函数库的时候，我们经常做的第一件事，就是把该函数库的源码下载回来进行编译和安装(一般是这三步：./configure -> make -> make install)，然后写一些调用库函数的小用例，看其能否正常运行以及运行后的效果。完成库函数安装，当我们满心期待地使用GCC进行用例编译的时候，却经常遇到以下问题：

test.c:X:XX: fatal error: XXXX.h: No such file or directory
compilation terminated.

又或者

test.c:(.text+0XX): undefined reference to `XXXX'
collect2: ld returned 1 exit status

一些同学遇到这样的问题后，倒腾几个小时没能找到解决问题的方法，心生畏难情绪，最终倒在库函数学习的入门门槛上。

下文通过分析问题出现的原因，结合glib函数库实例，提出解决方法，一步步地引导初学者进行函数库入门学习（这篇文章以C/C++源码作为讨论的基础，默认的编辑器是GNU下的GCC和CC）。

1.原因分析

首先分析以上问题出现的原因，我们先要了解这些知识：编译和链接原理，GCC头文件和库文件的查找路径。

程序的编译和链接：在进行程序编译时，编译器会检查语法是否正确，检查函数与变量的声明，这需要我们告知编译器我们的函数和变量声明在哪个头文件。语法正确并且相关头文件的路径都给到编译器后，编译器将编译出中间目标文件（.o或是.obj文件）。

在进行程序链接时，链接器会在所有中间目标文件或者库文件（它由中间目标文件打包而成）中查找函数的实现，如果链接器未查找到函数实现，它将返回链接失败消息。

知道这些之后，对照文章开头列出的出错消息，出错原因就很明显了。第一种出错情况是程序编译时未找到某个头文件；第二种是由于链接器未找到某函数所依赖的库文件或者该函数压根就没有实现。

GCC去哪找头文件和库文件呢？GCC有其默认的查找路径，对头文件的查找在/usr/include,/usr/local/include等目录下，编译时可以通过GCC的-I选项指定头文件的查找目录；对库文件的查找在/usr/lib,/usr/local/lib等目录下，编译时可以通过GCC的-L选项指定库文件的查找目录。

显然，上面错误消息里的头文件/库文件并不在GCC默认的头文件/库文件查找路径里。它们被安装到了哪里？

2.解决方法

通过查看函数库源码文件中的Makefile我们可以知道函数库的头文件和库文件安装的路径，以glib函数库为例，这里我们只看其Makefile(由./configure命令生成）中的几个字段。

prefix = /usr/local

exec_prefix = ${prefix}

includedir = ${prefix}/include

libdir = ${exec_prefix}/lib

这几个值指定了glib函数库的头文件/库文件的安装路径，在执行make install命令后，头文件和库文件将被分别安装到指定路径。

另外，我们可以使用locate命令定位头文件和库文件的路径，例如locate glib，包含"glib“字段的文件名的完整路径将被列出来，再自行定位库文件和头文件的路径。

假设我们已经从源码安装好了glib函数库，我们试着跑个Hello word小程序验证安装结果。

 #include <stdio.h>
 #include <glib.h>
  
 int main(void)
 {
      g_printf("hello world!\n");
  
      return 0;
 }

执行

gcc -I /usr/local/include/glib-2.0/ -I /usr/local/lib/glib-2.0/include/ -lglib-2.0 -o hello hello.c


由于glib库文件已被安装在GCC默认的库文件链接目录下（/usr/local/lib/），所以这里没有指定库文件搜索路径。

试试执行

gcc -o hello hello.c

gcc -I /usr/local/include/glib-2.0/ -I /usr/local/lib/glib-2.0/include/  -o hello hello.c

看有什么结果：）

另一个能帮助我们解决头文件或库文件路径问题的工具是pkg-config，许多函数库都支持pkg-config命令，在glib的Makefile中，有该条语句：pkgconfigdir = $(libdir)/pkgconfig，它指示了glib对应的.pc文件（即glib-2.0.pc）安装路径。我们来看glib-2.0.pc文件里有哪些主要内容：

prefix=/usr/local

exec_prefix=${prefix}

libdir=${exec_prefix}/lib

includedir=${prefix}/include

Libs: -L${libdir} -lglib-2.0

Cflags: -I${includedir}/glib-2.0 -I${libdir}/glib-2.0/include

Cflags给出编译时所需的选项，Libs给出了链接时所需的选项，然后这样使用pkg-config命令：

gcc `pkg-config --cflags --libs glib-2.0` -o hello hello.c

知道问题出现原因和解决方法，下次编译时再遇到“No such file or directory”或者“undefined reference to `XXXX'”，就不怕了吧？

本文参考了以下文章：《跟我一起写Makefile》by陈皓

                《Makefile好帮手：pkgconfig》by李先静