在 Linux 内核开发中,经常需要在动态链接库中使用到函数和变量。其中,导出这些数据的方法有很多种,而其中一个常用的方法是使用 export_symbol,这个函数可以帮助我们在对外开放接口时快速实现符号的导出。本文将介绍如何使用 export_symbol 导出函数或变量。
一、什么是 export_symbol?
export_symbol 是 Linux 内核中的一个函数,其作用是将一个符号导出到内核的符号表中,以便外部代码可以使用该符号(如函数、变量等)。它的定义在 include/linux/module.h 中:
void __attribute__((weak)) export_symbol(symbol_name)
其中,symbol_name 是要导出的符号名称。
需要注意的是,符号的导出只能在编译内核模块时完成。如果要导出的符号在内核中已经存在,那么导出操作将会失败。因此,我们一般会根据需要在模块初始化函数中调用 export_symbol。
二、如何使用 export_symbol 导出函数?
首先,我们需要定义一个要导出的函数,在本文中,我们以一个简单的示例函数为例:
```
#include
void say_hello(void)
{
printk(KERN_INFO "Hello, world!\n");
}
```
假设我们要在模块中导出这个函数,可以在模块初始化函数中使用 export_symbol 来完成:
```
#include
void say_hello(void); // 声明要导出的函数
static int __init hello_init(void)
{
printk(KERN_INFO "Hello, I'm a module.\n");
export_symbol(say_hello); // 导出函数
return 0;
}
static void __exit hello_exit(void)
{
printk(KERN_INFO "Goodbye, module.\n");
}
module_init(hello_init);
module_exit(hello_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("Your Name
MODULE_DESCRIPTION("A simple example Linux module.");
MODULE_VERSION("0.01");
```
上述代码中,我们首先声明了一个要导出的函数 say_hello。在模块初始化函数 hello_init 中,我们先打印一条信息,然后调用 export_symbol 函数将 say_hello 函数导出。另外,需要注意的是,我们还需要使用 MODULE_LICENSE 宏声明模块的许可证。
在编译完成后,我们可以将模块加载到内核中:
```
$ sudo insmod hello.ko
```
此时,我们可以通过 /proc/kallsyms 文件查看 hello 模块中导出的符号:
```
$ cat /proc/kallsyms | grep say_hello
ffffffffa0001010 T say_hello
```
可以看到,say_hello 函数已经被成功导出。
接下来,我们可以在另一个内核模块中使用刚刚导出的函数。
```
#include
extern void say_hello(void); // 声明导出的函数
static int __init hello_init(void)
{
printk(KERN_INFO "Hello, I'm another module.\n");
say_hello(); // 调用导出的函数
return 0;
}
static void __exit hello_exit(void)
{
printk(KERN_INFO "Goodbye, another module.\n");
}
module_init(hello_init);
module_exit(hello_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("Your Name
MODULE_DESCRIPTION("Another simple example Linux module.");
MODULE_VERSION("0.01");
```
在另一个模块中,我们使用 extern 关键字声明了 say_hello 函数,并在模块初始化函数中调用了它。
现在,我们可以一起编译这两个模块,并将它们加载到内核中:
```
$ make
$ sudo insmod hello.ko
$ sudo insmod another.ko
```
如果一切正常,你将会在内核消息日志中看到以下信息:
```
$ dmesg | grep Hello
[ 4923.307595] Hello, I'm a module.
[ 4923.307602] Hello, I'm another module.
[ 4923.307605] Hello, world!
```
可以看到,我们在另一个模块中成功地调用了导出的函数。
三、如何使用 export_symbol 导出变量?
除了函数,我们也可以使用 export_symbol 导出变量。同样以一个简单的示例变量为例:
```
#include
int my_variable = 42;
```
我们可以在模块初始化函数中使用 export_symbol 导出该变量:
```
#include
int my_variable = 42; // 声明要导出的变量
static int __init hello_init(void)
{
printk(KERN_INFO "Hello, I'm a module.\n");
export_symbol(my_variable); // 导出变量
return 0;
}
static void __exit hello_exit(void)
{
printk(KERN_INFO "Goodbye, module.\n");
}
module_init(hello_init);
module_exit(hello_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("Your Name
MODULE_DESCRIPTION("A simple example Linux module.");
MODULE_VERSION("0.01");
```
需要注意的是,在导出变量时,我们并不需要在其定义前使用 extern 关键字。同样,我们也需要在模块初始化函数中调用 export_symbol。
我们可以在另一个模块中使用刚刚导出的变量:
```
#include
extern int my_variable; // 声明导出的变量
static int __init hello_init(void)
{
printk(KERN_INFO "Hello, I'm another module.\n");
printk(KERN_INFO "my_variable is %d.\n", my_variable); // 使用导出的变量
return 0;
}
static void __exit hello_exit(void)
{
printk(KERN_INFO "Goodbye, another module.\n");
}
module_init(hello_init);
module_exit(hello_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("Your Name
MODULE_DESCRIPTION("Another simple example Linux module.");
MODULE_VERSION("0.01");
```
我们使用 extern 关键字声明了 my_variable,然后在模块初始化函数中打印出了该变量的值。
接下来,我们可以一起编译这两个模块,并将它们加载到内核中:
```
$ make
$ sudo insmod hello.ko
$ sudo insmod another.ko
```
如果一切正常,你将会在内核消息日志中看到以下信息:
```
$ dmesg | grep my_variable
[ 4923.307602] my_variable is 42.
```
可以看到,我们在另一个模块中成功地使用了导出的变量。
四、总结
在本文中,我们介绍了如何使用 export_symbol 导出函数或变量。需要注意的是,在使用 export_symbol 导出符号时,我们需要在模块初始化函数中调用该函数,并在模块定义中声明许可证等必要信息。这些步骤可以使我们更方便地对外开放接口,从而使内核模块的编写更加灵活和方便。