cmake中的find_package()

flying_music

已于 2024-08-19 15:22:19 修改

阅读量795

点赞数 15

文章标签： linux 运维服务器

于 2024-08-16 16:49:34 首次发布

本文链接：https://blog.csdn.net/cyfcsd/article/details/141262773

版权

1. 问题来源

问题的来源是当在编译一个库或者可执行文件的时候，可能需要使用其他库或者头文件。如果是自己写的小demo，那手动把这些路径写到gcc的参数项里就可以了：

g++ test.cpp -o test -I./include -L./lib -lmylib

但正式的项目这样肯定是不行的，一是库太多，要挨个指定太麻烦。二是一些三方库，你根本不知道它的安装路径，也不知道库的名字，所以就有了库管理的机制。

2. pkg-config

在最开始(现在也在用)，unix系统采用pkg-config的方式来管理库。其实现方式是在安装一个三方库的时候，会在对应lib目录下的pkgconfig里产生一个xxx.pc文件。这个文件里保存了这个库相关的编译选项，开发者调用pkg-config，然后pkg-config通过读这个文件，就可以知道怎么使用这个库了。

[xxx@VM_0_14_centos ~]$ which openssl #定位库的大致路径，.pc文件一般在跟bin同级目录下的lib或lib64里
/usr/bin/openssl
[xxx@VM_0_14_centos ~]$ ll /usr/lib64/pkgconfig/ #下面这些都是已经安装好的库
com_err.pc            krb5.pc               libpcreposix.pc       ncurses++.pc          tic.pc                xcb.pc                xcb-xfixes.pc
expat.pc              libcrypto.pc          libpng15.pc           ncurses++w.pc         tinfo.pc              xcb-present.pc        xcb-xinerama.pc
fontconfig.pc         libcurl.pc            libpng.pc             ncursesw.pc           uuid.pc               xcb-randr.pc          xcb-xinput.pc
fontutil.pc           libevent_openssl.pc   libselinux.pc         openssl.pc            x11.pc                xcb-record.pc         xcb-xkb.pc
form.pc               libevent.pc           libsepol.pc           panel.pc              x11-xcb.pc            xcb-render.pc         xcb-xselinux.pc
formw.pc              libevent_pthreads.pc  libssl.pc             panelw.pc             xau.pc                xcb-res.pc            xcb-xtest.pc
freetype2.pc          libffi.pc             libverto.pc           pthread-stubs.pc      xcb-composite.pc      xcb-screensaver.pc    xcb-xvmc.pc
gssrpc.pc             liblzma.pc            menu.pc               python-2.7.pc         xcb-damage.pc         xcb-shape.pc          xcb-xv.pc
kadm-client.pc        libpcre16.pc          menuw.pc              python2.pc            xcb-dpms.pc           xcb-shm.pc            xft.pc
kadm-server.pc        libpcre32.pc          mit-krb5-gssapi.pc    python.pc             xcb-dri2.pc           xcb-sync.pc           xrender.pc
kdb.pc                libpcrecpp.pc         mit-krb5.pc           sqlite3.pc            xcb-dri3.pc           xcb-xevie.pc          zlib.pc
krb5-gssapi.pc        libpcre.pc            ncurses.pc            systemd.pc            xcb-glx.pc            xcb-xf86dri.pc
[xxx@VM_0_14_centos ~]$ cat /usr/lib64/pkgconfig/openssl.pc #查看内容
prefix=/usr
exec_prefix=${prefix}
libdir=${exec_prefix}/lib64
includedir=${prefix}/include

Name: OpenSSL
Description: Secure Sockets Layer and cryptography libraries and tools
Version: 1.0.2k
Requires: libssl libcrypto
[xxx@VM_0_14_centos ~]$
[xxx@VM_0_14_centos ~]$ pkg-config --list-all | grep openssl #用 pkg-config查看支持的库，其实就是读上面那些pc文件出来的
openssl           OpenSSL - Secure Sockets Layer and cryptography libraries and tools
libevent_openssl  libevent_openssl - libevent_openssl adds openssl-based TLS support to libevent
[xxx@VM_0_14_centos ~]$
[xxx@VM_0_14_centos ~]$ pkg-config --libs openssl #查看特定库的链接选项
-lssl -lcrypto
[xxx@VM_0_14_centos ~]$ gcc myprogram.c -o myprogram `pkg-config --cflags --libs openssl` #最后这样用就可以了，前提是库路径已经导入PATH了

3. MakeFile

链接选项获得后，当然可以通过命令行设置给gcc，不过这个时候已经有MakeFile了，编译选项一般在MakeFile里指定，然后通过MakeFile将其设置给编译选项。

GTK_CFLAGS := $(shell pkg-config --cflags gtk+-3.0)

这种方式来自动调用pkg-config，但现在看来这显然还是太原始了。

4. cmake

2000年左右，cmake出现了，相当于在makefile的基础上又封装了一层，更像一门语言了。而find_package，就是对上面那句话的封装。
它的运行机制大概是这样的：
1. cmake在安装的时候，会提供常见库的.cmake文件（注意即使这些库你还没安装），这些文件的路径可以在cmake里输出CMAKE_ROOT查看(在里面的Modules下面)。

[xxx@VM_0_14_centos cmake]$ cmake .
-- The C compiler identification is GNU 9.3.1
......
-- Detecting CXX compile features - done
-- cmake root: /opt/cmake/cmake-3.14.5-Linux-x86_64/share/cmake-3.14
-- Configuring done
-- Generating done
-- Build files have been written to: /home/xxx/code/cmake
[xxx@VM_0_14_centos ~]$ ls /opt/cmake/cmake-3.14.5-Linux-x86_64/share/cmake-3.14/
completions/ editors/     Help/        include/     Licenses/    Modules/     Templates/
[xxx@VM_0_14_centos ~]$ ls /opt/cmake/cmake-3.14.5-Linux-x86_64/share/cmake-3.14/Modules/
AddFileDependencies.cmake                                       CMakeSystemSpecificInformation.cmake  FindOpenGL.cmake
AndroidTestUtilities                                            CMakeSystemSpecificInitialize.cmake   FindOpenMP.cmake
AndroidTestUtilities.cmake                                      CMakeTestASM-ATTCompiler.cmake        FindOpenSceneGraph.cmake
BasicConfigVersion-AnyNewerVersion.cmake.in                     CMakeTestASMCompiler.cmake            FindOpenSSL.cmake
BasicConfigVersion-ExactVersion.cmake.in                        CMakeTestASM_MASMCompiler.cmake       FindOpenThreads.cmake
BasicConfigVersion-SameMajorVersion.cmake.in                    CMakeTestASM_NASMCompiler.cmake       FindosgAnimation.cmake
BasicConfigVersion-SameMinorVersion.cmake.in                    CMakeTestCCompiler.cmake              Findosg.cmake
BundleUtilities.cmake                                           CMakeTestCompilerCommon.cmake         FindosgDB.cmake
CheckCCompilerFlag.cmake                                        CMakeTestCSharpCompiler.cmake         Findosg_functions.cmake
CheckCSourceCompiles.cmake                                      CMakeTestCUDACompiler.cmake           FindosgFX.cmake
CheckCSourceRuns.cmake                                          CMakeTestCXXCompiler.cmake            FindosgGA.cmake
......

2. 用户使用的时候，直接find_package就可以了，cmake会去找对应的.cmake文件，然后执行它。
3. cmake文件的作用是执行pkg-config，然后将对应的值赋值给固定名字的变量，再find_package执行完后就可以用这些变量。

对于一些不常见的库，或者干脆用户自定义的模块。也可以自己写一个.cmake文件，然后使用find_package机制，对于这些文件，可以放到CMAKE_ROOT下，但显然不是最佳实践，因为这是个全局的路径。所以cmake又提供了一个变量CMAKE_MODULE_PATH，可以在cmake中将我们“定制版”的.cmake文件路径设置给它，然后调用find_package就可以了。

最佳实践：

要通过find_package()引用三方库，要确认下面两点：
1. cmake是支持的
就是看有没有对应的.cmake文件，如果没有，要么不用find_package了，要么自己写一个。
对于正常人，这两种方式都比较难受，还有一种偷懒方式是安装库的时候，库的作者会自己给你带一个.cmake让你使用（可以在安装目录下找找）。
2. 确定pkg-config支持，
一般比较正式的库，只要你正确安装了（注意不是命令行里用那个，是带后缀devl的）,都会带.pc文件，pkg-config都支持。
TIPS: 如果确认安装好了呢：
which curl
可以看到curl可执行文件的路径，然后
ldd /path/to/curl
可以看到libcurl.so的路径，然后去这个库路径下找对应的pkgconfig文件夹，看里面有没有对应的（类似curl.pc）的文件，如果有说明安装好了。