Linux内核C文件中的常用符号

目录

1. #ifdef CONFIG_* 与 #if IS_ENABLED(CONFIG_*)

2. #include <***>与 #include "***"

3. MODULE_AUTHOR，MODULE_DESCRIPTION与MODULE_LICENSE

4. module_param

      5. EXPORT_SYMBOL与EXPORT_SYMBOL_GPL

---

1. #ifdef CONFIG_* 与 #if IS_ENABLED(CONFIG_*)

在阅读drivers\usb\storage\usb.c的时候，看到了如下两处定义：

//第一处
#ifdef CONFIG_USB_STORAGE_DEBUG
#define DEBUG
#endif
//第二处
#if IS_ENABLED(CONFIG_USB_UAS)
#include "uas-detect.h"
#endif

区别：

        如果CONFIG_*被设置为'Y'或'M'的时候,IS_ENABLED(CONFIG_*)就等于1；

        #ifdef CONFIG_*表示只要定义了CONFIG_*就行；

        #ifdef只关心宏是否被定义，而#if关心被定义的宏是否是真。

2. #include <***>与 #include "***"

头文件包含有两种形式，一种是尖括号，另一种是双引号，如usb.c中：

//尖括号
#include <linux/sched.h>
#include <linux/errno.h>
#include <linux/module.h>
//双引号
#include "usb.h"
#include "scsiglue.h"

区别：

        #include < >：
    一般用于包含标准的库头文件，编译器会去系统配置的库环境变量和者用户配置的路径去搜索，而不会在项目的当前目录去查找。

        #include " "：
    一般用于包含用户自己编写的头文件，编译器会先在项目的当前目录查找，找不到后才会去系统配置的库环境变量和用户配置的路径去搜索。

3. MODULE_AUTHOR，MODULE_DESCRIPTION与MODULE_LICENSE

 drivers\usb\storage\usb.c中有如下定义：

/* Some informational data */
MODULE_AUTHOR("Matthew Dharm <mdharm-usb@one-eyed-alien.net>");
MODULE_DESCRIPTION("USB Mass Storage driver for Linux");
MODULE_LICENSE("GPL");

这样的宏定义用来提供模块信息，按道理来说使用命令"modinfo usb-storage.ko"会输出上面定义的信息，但在openWRT下输出如下，原因有待研究。

 从网上搜索得到的信息是Linux操作系统下使用modinfo命令能显示全部信息，如下图所示：

4. module_param

static unsigned int delay_use = 1;
module_param(delay_use, uint, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(delay_use, "seconds to delay before using a new device");

使用insmod装载模块时可以传参，这些参数用module_param来定义，也就是说让那些全局变量对 insmod 可见，使模块装载时可重新赋值。如：

insmod usb-storage.ko delay=10

5. EXPORT_SYMBOL与EXPORT_SYMBOL_GPL

// 示例1
void usb_stor_disconnect(struct usb_interface *intf)
{
	struct us_data *us = usb_get_intfdata(intf);

	quiesce_and_remove_host(us);
	release_everything(us);
}
EXPORT_SYMBOL_GPL(usb_stor_disconnect);
// 示例2
void complete(struct completion *x)
{
	unsigned long flags;

	raw_spin_lock_irqsave(&x->wait.lock, flags);

	if (x->done != UINT_MAX)
		x->done++;
	swake_up_locked(&x->wait);
	raw_spin_unlock_irqrestore(&x->wait.lock, flags);
}
EXPORT_SYMBOL(complete);

两者均用于将本模块内的函数导出给其他模块使用。在调用该函数的模块中使用extern对之声明。

EXPORT_SYMBOL_GPL只能使函数对GPL许可的模块可用。