嵌入式Linux应用开发基础-现有动态库so的使用

前言

最近做嵌入式Linux项目，需要调用客户提供的现成的动态库(so文件，包含对应头文件)，我这边用的是cmake来构建。
此篇文章主要是记录一下嵌入式Linux的动态库的使用，与君共勉！

一、通过cmake使用so库和对应的头文件
1.包含so库对应的头文件目录：
(1)当你调用了so库对应的头文件，为了编译通过，需要把so库对应的头文件的目录包含进去
(2)cmake通过include_directories指令包含目录，这个指令必须在生成可执行文件add_executable指令之前
(3)${PROJECT_SOURCE_DIR}是相对地址前缀，代表此CMakeLists.txt所在的目录
(4)目录2和目录4为需要包含的头文件的目录

#包含目录的例子
include_directories(
	${PROJECT_SOURCE_DIR}/目录1/目录2
	${PROJECT_SOURCE_DIR}/目录3/目录4
)

2.链接so库文件：
(1)动态库只有在调用它的进程启动的时候才会被加载，因此在编译的时候，这个so库甚至不需要在工程里，只要对应的头文件目录包含了，就能编译通过，生成可执行文件
(2)生成可执行文件后，要把可执行文件用到的动态库进行链接，可执行文件运行的时候才知道要加载哪些动态库(能不能找到库另说)
(3)camke通过target_link_libraries指令链接库，这个指令必须在生成可执行文件add_executable指令之后
(link_libraries指令也是链接库，但是必须在生成可执行文件add_executable指令之前。因为静态库需要编译时加载，因此静态库一般都用这个指令，这也是使用静态库的可执行文件比使用动态库的可执行文件更大的原因)
(4)AAA是生成的可执行文件名；BBB是动态库名字的简写：动态库的名字必须是libXXX.so，填名字时省略"lib"和".so"，只填XXX就行

#可执行文件名：AAA，动态库名字：libBBB.so
#链接动态库
target_link_libraries(AAA BBB)

二、通过cmake安装so库到target目录
通过以上步骤，可执行文件已经编译完成，并且可执行文件运行的时候需要加载哪些动态库了。接下来我们要让可执行文件能正确地搜索到需要的库！

1.安装so库到target目录：
(1)可执行文件运行的时候，是在target目录里搜索库的
(2)嵌入式Linux 系统把 target目录里的/lib 和 /usr/lib 两个目录作为默认的库搜索路径
(3)camke通过install指令进行安装。它可以用来安装很多内容，可以包括目标二进制、动态库、静态库以及文件、目录、脚本等。其中，so库可以通过目标二进制(TARGETS)和普通文件(FILES)来进行安装

install(TARGETS <target>... [...])
install({FILES | PROGRAMS} <file>... [...])
install(DIRECTORY <dir>... [...])
install(SCRIPT <file> [...])
install(CODE <code> [...])
install(EXPORT <export-name> [...])

(4)如果是别人提供的so库，按照普通文件(FILES)来安装，其中${PROJECT_SOURCE_DIR}是相对地址前缀，代表此CMakeLists.txt所在的目录；DESTINATION是target文件夹

#动态库名字：libAAA.so
#目标安装位置：target/usr/lib
#在target安装动态库
install(FILES ${PROJECT_SOURCE_DIR}/目录1/.../目录N/libAAA.so DESTINATION /usr/lib)

(5)如果是自己生产的so库，按照目标二进制(TARGETS)来安装，先通过add_library生成动态库，再把动态库名字作为TARGETS名进行安装

#源文件名字：AAA.c，生成的动态库名字：libAAA.so
#生成动态库
add_library(AAA SHARED ${PROJECT_SOURCE_DIR}/AAA.c)

#目标安装位置：target/usr/lib
#在target安装动态库
INSTALL(TARGETS AAA
       LIBRARY DESTINATION /usr/lib
)

三、代码里调用so库(显示调用/隐式调用)
1.隐式调用
(1)隐式调用由系统完成，对程序员是不可感知的
(2)写代码时使用方法和静态库一样，包含头文件，直接使用数据结构和接口函数即可

2.显式调用
(1)显式调用的so库，如果只需要用到接口函数，不需要数据结构的话，连头文件的都不需要包含就能用
(2)显式调用则要求程序员在调用时，指明要加载的动态库的名称和要调用的函数名称
(3)显式调用是在调用so库时才申请空间，使用结束可释放，会相对更省空间
(4)函数介绍：

dlopen
函数原型：void *dlopen(const char *libname,int flag);
功能描述：dlopen必须在dlerror，dlsym和dlclose之前调用，表示要将库装载到内存，准备使用。如果要装载的库依赖于其它库，必须首先装载依赖库。如果dlopen操作失败，返回NULL值；如果库已经被装载过，则dlopen会返回同样的句柄。

参数中的libname一般是库的全路径，这样dlopen会直接装载该文件；如果只是指定了库名称，在dlopen会按照下面的机制去搜寻：

a.根据环境变量LD_LIBRARY_PATH查找

b.根据/etc/ld.so.cache查找

c.查找依次在/lib和/usr/lib目录查找。

flag参数表示处理未定义函数的方式，可以使用RTLD_LAZY或RTLD_NOW。RTLD_LAZY表示暂时不去处理未定义函数，先把库装载到内存，等用到没定义的函数再说；RTLD_NOW表示马上检查是否存在未定义的函数，若存在，则dlopen以失败告终。

dlerror
函数原型：char *dlerror(void);
功能描述：dlerror可以获得最近一次dlopen,dlsym或dlclose操作的错误信息，返回NULL表示无错误。dlerror在返回错误信息的同时，也会清除错误信息。

dlsym
函数原型：void *dlsym(void *handle,const char *symbol);
功能描述：在dlopen之后，库被装载到内存。dlsym可以获得指定函数(symbol)在内存中的位置(指针)。如果找不到指定函数，则dlsym会返回NULL值。但判断函数是否存在最好的方法是使用dlerror函数，

dlclose
函数原型：int dlclose(void *);
功能描述：将已经装载的库句柄减一，如果句柄减至零，则该库会被卸载。如果存在析构函数，则在dlclose之后，析构函数会被调用。

//显式调用例程
typedef struct
{
	void *pd;
	int (*Init_func)(void* param);
	int (*getData_func)(unsigned char* buff, int bufflen);	
}func_t;

func_t fun;
//打开动态链接库，其中./usr/lib/libAAA.so"为库在target的位置
fun.pd=dlopen("./usr/lib/libAAA.so",RTLD_LAZY);
if (fun.pd==NULL) /* 若打开失败则退出 */ 
{
	perror(dlerror()); 
	perror(stderr);
	return -2;
}

//动态链接接口函数，其中AAA_Init为库里的接口函数
fun.Init_func=dlsym(fun.pd,"AAA_Init");
error=dlerror();
if (error) /* 若出错则退出 */ 
{ 
	//perror(error,stderr); 
	perror(error);
	perror(stderr);
	return -3; 
}

//动态链接接口函数，其中AAA_Get_ModuleData为库里的接口函数
fun.getData_func=dlsym(fun.pd,"AAA_Get_ModuleData");  /* 动态链接接口函数 */ 
error=dlerror();
if (error) /* 若出错则退出 */ 
{ 
	//perror(error,stderr); 
	perror(error);
	perror(stderr);
	return -3; 
}

//调用链接的接口
uint8_t buf[2]={0};
if (fun.Init_func(buf) < 0)
{
	perror("Init_funcfailed!\n");
	return -4;
}

//调用链接的接口
uint8_t dataBuf[256]={0};
if(fun.getData_func(dataBuf,sizeof(dataBuf))>0)
{
	...
}

//关闭链接，释放内存
dlclose(fun.pd);