文档章节

《CMake实践》笔记三:构建静态库(.a) 与 动态库(.so) 及 如何使用外部共享库和头文件

shzwork
 shzwork
发布于 03/30 16:45
字数 3890
阅读 41
收藏 1

《CMake实践》笔记一:PROJECT/MESSAGE/ADD_EXECUTABLE

《CMake实践》笔记二:INSTALL/CMAKE_INSTALL_PREFIX

《CMake实践》笔记三:构建静态库与动态库 及 如何使用外部共享库和头文件

 

五、静态库与动态库构建

读者云,太能罗唆了,一个Hello World就折腾了两个大节。OK,从本节开始,我们不再折腾Hello World了,我们来折腾Hello World的共享库。

本节的任务:

1、建立一个静态库和动态库,提供HelloFunc函数供其他程序编程使用,HelloFunc向终端输出Hello World字符串。

2、安装头文件与共享库。

 

(一)、准备工作:

在/backup/cmake目录建立t3目录,用于存放本节涉及到的工程

 

(二)、建立共享库

cd /backup/cmake/t3
mkdir lib

在t3目录下建立CMakeLists.txt,内容如下:

PROJECT(HELLOLIB)
ADD_SUBDIRECTORY(lib)

在lib目录下建立两个源文件hello.c与hello.h

hello.c内容如下:

#include "hello.h"
void HelloFunc()
{
    printf("Hello World\n");
}

hello.h内容如下:

#ifndef HELLO_H
#define HELLO_H
#include <stdio.h>
void HelloFunc();
#endif

在lib目录下建立CMakeLists.txt,内容如下:

SET(LIBHELLO_SRC hello.c)
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})

 

(三)、编译共享库

仍然采用 out-of-source 编译的方式,按照习惯,我们建立一个build目录,在build目录中

cmake ..
make

这时,你就可以在lib目录得到一个libhello.so,这就是我们期望的共享库。

如果你要指定libhello.so生成的位置,可以通过在主工程文件CMakeLists.txt中修改ADD_SUBDIRECTORY(lib)指令来指定一个编译输出位置或者在lib/CMakeLists.txt中添加SET(LIBRARY_OUTPUT_PATH <路径>)来指定一个新的位置。这两者的区别我们上一节已经提到了,所以,这里不再赘述,下面,我们解释一下一个新的指令ADD_LIBRARY:

ADD_LIBRARY(libname [SHARED|STATIC|MODULE][EXCLUDE_FROM_ALL]source1 source2 ... sourceN)

你不需要写全libhello.so,只需要填写hello即可,cmake系统会自动为你生成libhello.X。类型有三种:

  • SHARED,动态库(扩展名为.so)
  • STATIC,静态库(扩展名为.a)
  • MODULE,在使用dyld的系统有效,如果不支持dyld,则被当作SHARED对待。
  • EXCLUDE_FROM_ALL 参数的意思是这个库不会被默认构建,除非有其他的组件依赖或者手工构建。

C/C++ 静态链接库(.a) 与 动态链接库(.so)库

Linux C 静态库(.a) 与 动态库(.so)的详解

 

(四)、添加静态库

同样使用上面的指令,我们在支持动态库的基础上再为工程添加一个静态库,按照一般的习惯,静态库名字跟动态库名字应该是一致的,只不过后缀是.a罢了。下面我们用这个指令再来添加静态库:

ADD_LIBRARY(hello STATIC ${LIBHELLO_SRC})

然后再在build目录进行外部编译,我们会发现,静态库根本没有被构建,仍然只生成了一个动态库。因为hello作为一个target是不能重名的,所以,静态库构建指令无效。

如果我们把上面的hello修改为hello_static:

ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})

就可以构建一个libhello_static.a的静态库了。这种结果显示不是我们想要的,我们需要的是名字相同的静态库和动态库,因为target名称是唯一的,所以,我们肯定不能通过ADD_LIBRARY指令来实现了。这时候我们需要用到另外一个指令:

SET_TARGET_PROPERTIES,其基本语法是:
SET_TARGET_PROPERTIES(target1 target2 ...PROPERTIES prop1 value1prop2 value2 ...)

这条指令可以用来设置输出的名称,对于动态库,还可以用来指定动态库版本和API版本。在本例中,我们需要作的是向lib/CMakeLists.txt中添加一条:

SET_TARGET_PROPERTIES(hello_static PROPERTIES OUTPUT_NAME "hello")

这样,我们就可以同时得到libhello.so/libhello.a两个库了。与他对应的指令是:

GET_TARGET_PROPERTY(VAR target property)

具体用法如下例,我们向lib/CMakeListst.txt中添加:

GET_TARGET_PROPERTY(OUTPUT_VALUE hello_static OUTPUT_NAME)
MESSAGE(STATUS  "This is the hello_static OUTPUT_NAME:" ${OUTPUT_VALUE})

如果没有这个属性定义,则返回 NOTFOUND。

让我们来检查一下最终的构建结果,我们发现,libhello.a已经构建完成,位于build/lib目录中,但是libhello.so去消失了。这个问题的原因是:cmake在构建一个新的target时,会尝试清理掉其他使用这个名字的库,因为,在构建libhello.a时,就会清理掉libhello.so.为了回避这个问题,比如再次使用SET_TARGET_PROPERTIES定义

CLEAN_DIRECT_OUTPUT属性。向lib/CMakeLists.txt中添加:

SET_TARGET_PROPERTIES(hello PROPERTIES CLEAN_DIRECT_OUTPUT 1)
SET_TARGET_PROPERTIES(hello_static PROPERTIES CLEAN_DIRECT_OUTPUT 1)

这时候,我们再次进行构建,会发现build/lib目录中同时生成了 libhello.so 和 libhello.a

 

(五)、动态库版本号

按照规则,动态库是应该包含一个版本号的,我们可以看一下系统的动态库,一般情况是

libhello.so.1.2
libhello.so ->libhello.so.1
libhello.so.1->libhello.so.1.2

为了实现动态库版本号,我们仍然需要使用SET_TARGET_PROPERTIES指令。具体使用方法如下:

SET_TARGET_PROPERTIES(hello PROPERTIES VERSION 1.2 SOVERSION 1)

VERSION指代动态库版本,SOVERSION指代API版本。将上述指令加入lib/CMakeLists.txt中,重新构建看看结果。

在build/lib目录会生成:

libhello.so.1.2
libhello.so.1->libhello.so.1.2
libhello.so ->libhello.so.1

 

(六)、安装共享库和头文件

以上面的例子,我们需要将libhello.a, libhello.so.x以及hello.h安装到系统目录,才能真正让其他人开发使用,在本例中我们将hello的共享库安装到<prefix>/lib目录,将hello.h安装到<prefix>/include/hello目录。

利用上一节了解到的INSTALL指令,我们向lib/CMakeLists.txt中添加如下指令:

INSTALL(TARGETS hello hello_static
LIBRARY DESTINATION lib
ARCHIVE DESTINATION lib)
INSTALL(FILES hello.h DESTINATION include/hello)

注意,静态库要使用ARCHIVE关键字通过:

cmake -DCMAKE_INSTALL_PREFIX=/usr ..
make
make install

我们就可以将头文件和共享库安装到系统目录/usr/lib和/usr/include/hello中了。

 

(七)、小结

本小节,我们谈到了:

如何通过 ADD_LIBRARY 指令构建动态库和静态库。

如何通过 SET_TARGET_PROPERTIES 同时构建同名的动态库和静态库。

如何通过 SET_TARGET_PROPERTIES 控制动态库版本

最终使用上一节谈到的 INSTALL 指令来安装头文件和动态、静态库。

在下一节,我们需要编写另一个高级一点的Hello World来演示怎么使用我们已经构建的构建的共享库libhello和外部头文件。

 


 

以下是我跟着做的截图,确实很方便:(这里有点失误,设置了个CC的环境变量,所以这里找的是arm-linux-gcc去了。。本意是用gcc编译的)

 


 

六、如何使用外部共享库和头文件

抱歉,本节仍然继续折腾Hello World。

上一节我们已经完成了libhello动态库的构建以及安装,本节我们的任务很简单:

编写一个程序使用我们上一节构建的共享库。

1、准备工作:

请在/backup/cmake目录建立t4目录,本节所有资源将存储在t4目录。

 

2、重复以前的步骤,建立src目录,编写源文件main.c,内容如下:

#include <hello.h>
int main()
{
    HelloFunc();
    return 0;
}

编写工程主文件CMakeLists.txt

PROJECT(NEWHELLO)
ADD_SUBDIRECTORY(src)

编写src/CMakeLists.txt

ADD_EXECUTABLE(main main.c)

上述工作已经严格按照我们前面季节提到的内容完成了。

 

3、外部构建

按照习惯,仍然建立build目录,使用cmake ..方式构建。

过程:

cmake ..
make

构建失败,如果需要查看细节,可以使用第一节提到的方法

make VERBOSE=1

来构建

错误输出为是:

/backup/cmake/t4/src/main.c:1:19: error: hello.h: 没有那个文件或目录

 

4、引入头文件搜索路径

hello.h位于/usr/include/hello目录中,并没有位于系统标准的头文件路径,(有人会说了,白痴啊,你就不会include <hello/hello.h>,同志,要这么干,我这一节就没什么可写了,只能选择一个glib或者libX11来写了,这些代码写出来很多同志是看不懂的)

为了让我们的工程能够找到hello.h头文件,我们需要引入一个新的指令

INCLUDE_DIRECTORIES,其完整语法为:

INCLUDE_DIRECTORIES([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)

这条指令可以用来向工程添加多个特定的头文件搜索路径,路径之间用空格分割,如果路径中包含了空格,可以使用双引号将它括起来,默认的行为是追加到当前的头文件搜索路径的后面,你可以通过两种方式来进行控制搜索路径添加的方式:

(1)、CMAKE_INCLUDE_DIRECTORIES_BEFORE,通过SET这个cmake变量为on,可以将添加的头文件搜索路径放在已有路径的前面。

(2)、通过AFTER或者BEFORE参数,也可以控制是追加还是置前。现在我们在src/CMakeLists.txt中添加一个头文件搜索路径,方式很简单,加入:INCLUDE_DIRECTORIES(/usr/include/hello)

进入build目录,重新进行构建,这是找不到hello.h的错误已经消失,但是出现了一个新的错误:

main.c:(.text+0x12): undefined reference to `HelloFunc'

因为我们并没有link到共享库libhello上。

 

5、为target添加共享库

我们现在需要完成的任务是将目标文件链接到libhello,这里我们需要引入两个新的指令

LINK_DIRECTORIES和TARGET_LINK_LIBRARIES
LINK_DIRECTORIES的全部语法是:
LINK_DIRECTORIES(directory1 directory2 ...)

这个指令非常简单,添加非标准的共享库搜索路径,比如,在工程内部同时存在共享库和可执行二进制,在编译时就需要指定一下这些共享库的路径。这个例子中我们没有用到这个指令。

TARGET_LINK_LIBRARIES的全部语法是:
TARGET_LINK_LIBRARIES(target library1<debug | optimized> library2...)

这个指令可以用来为target添加需要链接的共享库,本例中是一个可执行文件,但是同样可以用于为自己编写的共享库添加共享库链接。为了解决我们前面遇到的HelloFunc未定义错误,我们需要作的是向src/CMakeLists.txt中添加如下指令:

TARGET_LINK_LIBRARIES(main hello)

也可以写成

TARGET_LINK_LIBRARIES(main libhello.so)

这里的hello指的是我们上一节构建的共享库libhello.

进入build目录重新进行构建。

cmake ..
make

这是我们就得到了一个连接到libhello的可执行程序main,位于build/src目录,运行main的结果是输出:

Hello World

让我们来检查一下main的链接情况:

ldd src/main
linux-gate.so.1 => (0xb7ee7000)
libhello.so.1 => /usr/lib/libhello.so.1 (0xb7ece000)
libc.so.6 => /lib/libc.so.6 (0xb7d77000)
/lib/ld-linux.so.2 (0xb7ee8000)

可以清楚的看到main确实链接了共享库libhello,而且链接的是动态库libhello.so.1

那如何链接到静态库呢?

方法很简单:

将TARGET_LINK_LIBRRARIES指令修改为:

TARGET_LINK_LIBRARIES(main libhello.a)

重新构建后再来看一下main的链接情况

ldd src/main
linux-gate.so.1 => (0xb7fa8000)
libc.so.6 => /lib/libc.so.6 (0xb7e3a000)
/lib/ld-linux.so.2 (0xb7fa9000)

说明,main确实链接到了静态库libhello.a

 

6、特殊的环境变量 CMAKE_INCLUDE_PATH 和 CMAKE_LIBRARY_PATH

务必注意,这两个是环境变量而不是cmake变量。使用方法是要在bash中用export或者在csh中使用set命令设置或者CMAKE_INCLUDE_PATH=/home/include cmake ..等方式。

这两个变量主要是用来解决以前autotools工程中--extra-include-dir等参数的支持的。也就是,如果头文件没有存放在常规路径(/usr/include, /usr/local/include等),则可以通过这些变量就行弥补。我们以本例中的hello.h为例,它存放在/usr/include/hello目录,所以直接查找肯定是找不到的。前面我们直接使用了绝对路径INCLUDE_DIRECTORIES(/usr/include/hello)告诉工程这个头文件目录。为了将程序更智能一点,我们可以使用CMAKE_INCLUDE_PATH来进行,使用bash的方法如下:

export CMAKE_INCLUDE_PATH=/usr/include/hello然后在头文件中将INCLUDE_DIRECTORIES(/usr/include/hello)替换为:

FIND_PATH(myHeader hello.h)
IF(myHeader)
INCLUDE_DIRECTORIES(${myHeader})
ENDIF(myHeader)

上述的一些指令我们在后面会介绍。这里简单说明一下,FIND_PATH用来在指定路径中搜索文件名,比如:

FIND_PATH(myHeader NAMES hello.h PATHS /usr/include/usr/include/hello)

这里我们没有指定路径,但是,cmake仍然可以帮我们找到hello.h存放的路径,就是因为我们设置了环境变量CMAKE_INCLUDE_PATH。如果你不使用FIND_PATH,CMAKE_INCLUDE_PATH变量的设置是没有作用的,你不能指望它会直接为编译器命令添加参数-I<CMAKE_INCLUDE_PATH>。以此为例,CMAKE_LIBRARY_PATH可以用在FIND_LIBRARY中。同样,因为这些变量直接为FIND_指令所使用,所以所有使用FIND_指令的cmake模块都会受益。

 

7、小节

本节我们探讨了:

如何通过INCLUDE_DIRECTORIES指令加入非标准的头文件搜索路径。

如何通过LINK_DIRECTORIES指令加入非标准的库文件搜索路径。

如果通过TARGET_LINK_LIBRARIES为库或可执行二进制加入库链接。

并解释了如果链接到静态库。

到这里为止,您应该基本可以使用cmake工作了,但是还有很多高级的话题没有探讨,比如编译条件检查、编译器定义、平台判断、如何跟pkgconfig配合使用等等。

到这里,或许你可以理解前面讲到的“cmake的使用过程其实就是学习cmake语言并编写cmake程序的过程”,既然是“cmake语言”,自然涉及到变量、语法等。

下一节,我们将抛开程序的话题,看看常用的CMAKE变量以及一些基本的控制语法规则。

未完,待续。。。。

 


 

这里关于LINK_DIRECTORIES似乎有个bug。基本上按照上述所写方法,只是我没有将测试用的hello.h和libhello.so安装在系统的usr/lib目录下。于是我就需要用到这个LINK_DIRECTORIES指定我的库文件的目录。main.c的CMakeLists.txt如下:

ADD_EXECUTABLE(main main.c)
FIND_PATH(myHeader hello.h)
IF(myHeader)
INCLUDE_DIRECTORIES(${myHeader})
ENDIF(myHeader)
TARGET_LINK_LIBRARIES(main libhello.so)
LINK_DIRECTORIES(/home/wideking/cmakeDemo/libhello/bulid)

在编译的时候它就是找不到我的libhello.so文件。goole了一下,有人试过将ADD_EXECUTABLE和LINK_DIRECTORIES互换了下位置就行了。我也试了试,提示错误,必须先有main,才能有库的链接,确实也应该这样。于是再在后面增加一行ADD_EXECUTABLE就变成了这样:

ADD_EXECUTABLE(main main.c)
FIND_PATH(myHeader hello.h)
IF(myHeader)
INCLUDE_DIRECTORIES(${myHeader})
ENDIF(myHeader)
TARGET_LINK_LIBRARIES(main libhello.so)
LINK_DIRECTORIES(/home/wideking/cmakeDemo/libhello/bulid)
ADD_EXECUTABLE(main main.c)

虽然有构建的时候有warning,但是这样才能正常的使用。我是在cmake2.6版本中测试的。不知道这个是我没理解对还是咋的。。。。

那个warning就是不得不多添加了一次ADD_EXECUTABLE出来的

 


 

cmake中lib库的路径设置

比如目录结构如下

project/utils

project/bin/lib

project/login/remote/control/src

project/login/remote/control/build

构造control工程

LINK_DIRECTORIES(../../../bin/lib)

这里的相对路径并不是相对于源码路径(CMakeLists.txt路径),而是相对于执行命令的路径(build目录),向上三层目录结构。

 

src目录下是源代码,在build目录下执行make,那么这个相对路径就是相对于build目录。

 

而头文件的路径则是相对于源码的路径(CMakeLists.txt路径)

INCLUDE_DIRECTORIES(../../utils)向上2层目录

 指定头文件搜索路径
    INCLUDE_DIRECTORIES( "../../xxxx" )   // 注意:括号里的相对路径是相对CMakeLists.txt的。

指定库的连接路径
   LINK_DIRECTORIES(" ../../xxxx ")    // 括号里的相对路径是相对执行make动作的目录为基准的。

 

本文转载自:https://www.cnblogs.com/52php/p/5681755.html

shzwork
粉丝 13
博文 744
码字总数 10605
作品 0
厦门
私信 提问
《CMake实践》笔记二:INSTALL/CMAKE_INSTALL_PREFIX

《CMake实践》笔记一:PROJECT/MESSAGE/ADD_EXECUTABLE 《CMake实践》笔记二:INSTALL/CMAKEINSTALLPREFIX 《CMake实践》笔记三:构建静态库与动态库 及 如何使用外部共享库和头文件 四、更好...

shzwork
03/31
20
0
《CMake实践》笔记一:PROJECT/MESSAGE/ADD_EXECUTABLE

《CMake实践》笔记一:PROJECT/MESSAGE/ADD_EXECUTABLE 《CMake实践》笔记二:INSTALL/CMAKEINSTALLPREFIX 《CMake实践》笔记三:构建静态库与动态库 及 如何使用外部共享库和头文件 前言: ...

shzwork
03/31
20
1
cmake 学习笔记(一)

最大的Qt4程序群(KDE4)采用cmake作为构建系统 Qt4的python绑定(pyside)采用了cmake作为构建系统 开源的图像处理库 opencv 采用cmake 作为构建系统 ... 看来不学习一下cmake是不行了,一点一点...

晨曦之光
2012/05/08
768
0
工程系列-CMakeLists.txt

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/googler_offer/article/details/86422237 1、cmakeminimumrequired(VERSION 2.8) cmake最低版本,如果CMake的...

googler_offer
01/13
0
0
AndroidStudio用Cmake方式编译NDK代码(cmake配置.a库)

AndroidStudio用Cmake方式编译NDK代码(cmake配置.a库) 1.cmake是什么? CMake是一个跨平台的安装(编译)工具,可以用简单的语句来描述所有平台的安装(编译过程)。他能够输出各种各样的mak...

shzwork
06/05
64
0

没有更多内容

加载失败,请刷新页面

加载更多

c++ 内联函数调用快的原因

见图片分析

天王盖地虎626
43分钟前
4
0
JS--function

一、声明提前(hoist) 在js程序开始执行前,引擎会查找所有var声明的变量和function声明的函数,集中到当前作用域顶部集中创建,赋值留在原地 二、三种创建函数的方式 1、声明方式创建函数-...

wytao1995
今天
5
0
微服务之间调用控制器注解类型的差异

今天在一个业务服务通过Feign调用文件服务上传文件时遇到了几个问题: 1. 提示http请求头过大的问题; 此时需要修改bootstrap.yml,加入 server: max-http-header-size: 10000000 用以放大...

不再熬夜
今天
7
0
用 4G 工作是什么体验

七月开始,因为工作原因,在公司附近租了个住处,方便工作。离公司近了,感觉就是不一样,之前每天 5:30 就要起床赶地铁,现在可以睡到自然醒,一看才 7 点,悠闲的起床洗漱,踱步到公司,都...

zzxworld
今天
6
0
sonar报错volatile

问题发生 原先代码如下: //认证授权码private static volatile String AUTHORIZATION_CODE = "init"; git push 之后,sonar认为这是个bug检测报告截图如下: 分析排查 解释说明: Markin...

开源小菜鸟2333
今天
5
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部