[系统技巧] Linux内核的 EXPORT_SYMBOL 和 EXPORT_SYMBOL_GPL 的作用

一、EXPORT_SYMBOL 的作用

1. 在一个模块中使用 EXPORT_SYMBOL(name)。name 表示函数或者变量等符号，它是对全部内核代码公开的，因此在您的内核模块中可以直接调用 name，即使用 EXPORT_SYMBOL 可以将一个函数以符号的方式导出给其他模块使用。

2. 这里要和 System.map 做一下对比：
   System.map 中的是连接时的函数地址。连接完成以后，在2.6内核运行过程中，是不知道哪个符号在哪个地址的。

3. EXPORT_SYMBOL 的符号，是把这些符号和对应的地址保存起来，在内核运行的过程中，可以找到这些符号对应的地址。而模块在加载过程中，其本质就是能动态连接到内核，

4. 如果在模块中引用了内核或其它模块的符号，就要 EXPORT_SYMBOL 这些符号，这样才能找到对应的地址连接。

二、EXPORT_SYMBOL 和 EXPORT_SYMBOL_GPL 的区别

EXPORT_SYMBOL(name);
EXPORT_SYMBOL_GPL(name);
这两个宏均用于将给定的符号导出到模块外, _GPL版本的宏定义只能使符号对GPL许可的模块可用。 符号必须在模块文件的全局部分导出,不能在函数中导出,
这是因为上述这两个宏将被扩展成一个特殊用途的声明，而该变量必须是全局的。这个变量存储于模块的一个特殊的可执行部分(一个"ELF段" ),在装载时，内核通过这个段来寻找模块导出的变量
(具体可以看 <linux/module.h> 获知更详细的信息)。

三、EXPORT_SYMBOL 和 EXPORT_SYMBOL_GPL 使用方法

3.1 EXPORT_SYMBOL 使用方法

1. 在模块函数定义之后使用 EXPORT_SYMBOL(函数名);

2. 在调用该函数的模块中使用 extern 对它声明，才可以开始调用函数;

3. 首先加载（insmod mod1.ko）定义该函数的模块，再加载（insmod mod2.ko）调用该函数的模块;
   举例简要说明：

   在模块（mod1）中使用 EXPORT_SYMBOL(func1);
   在模块（mod2）中声明 extern int func1();
   如此就可以在（mod2）中调用 func1 了。

   例如，在一个驱动中 drivers/net/ethernet/stmmac/tnkhw.c 定义了函数 tnkhw_bonding_setcurr_active_slave，然后在另外的.c文件中可以直接extern来使用：

   void tnkhw_bonding_setcurr_active_slave(int curr_slave){
   	uint32_t data;unsigned long flags;spin_lock_irqsave(&tnkhw_reg_lock, flags);
   	data = readl(tnkhw_ioaddr + TNK_REG_TOE_BONDING_CTRL);if (curr_slave) {TNKBD_DBG("%s curr_slave = eth1\n", __func__);writel((0x00000004 | data),
   				tnkhw_ioaddr + TNK_REG_TOE_BONDING_CTRL);} else {TNKBD_DBG("%s curr_slave = eth0\n", __func__);writel((0xfffffffb & data),
   				tnkhw_ioaddr + TNK_REG_TOE_BONDING_CTRL);}spin_unlock_irqrestore(&tnkhw_reg_lock, flags);}EXPORT_SYMBOL(tnkhw_bonding_setcurr_active_slave);

   使用 extern 来声明：

   extern void tnkhw_bonding_setcurr_active_slave(int curr_slave);void bond_select_active_slave(struct bonding *bond){struct slave *best_slave;int rv;
   
   	best_slave = bond_find_best_slave(bond);if (best_slave != bond->curr_active_slave) {bond_change_active_slave(bond, best_slave);#ifdef TNK_BONDINGif (hitoe && bond->curr_active_slave) {int slave_dev_id = 0;/* set bond current active slave */
   			slave_dev_id =select_slave_dev(bond->curr_active_slave->dev);TNKB_DBG(" %s bond->curr_active_dev->name = %s\n",__func__, bond->curr_active_slave->dev->name);TNKB_DBG("slave_dev_id = %d\n", slave_dev_id);tnkhw_bonding_setcurr_active_slave(slave_dev_id);}#endif
   		rv = bond_set_carrier(bond);if (!rv)return;if (netif_carrier_ok(bond->dev)) {pr_info("%s: first active interface up!\n",
   				bond->dev->name);} else {pr_info("%s: now running without any active interface !\n",
   				bond->dev->name);}}}

3.2 EXPORT_SYMBOL_GPL 使用方法

• EXPORT_SYMBOL_GPL 使用方法基本与 EXPORT_SYMBOL 相同，但是也有差异。

1. 在模块函数定义之后使用 EXPORT_SYMBOL_GPL(函数名);

2. 在调用该函数的模块中使用 extern 对它声明，然后必须使用 MODULE_LICENSE(“GPL”) 或者 MODULE_LICENSE(“Dual BSD/GPL”)，才可以开始调用函数（这是因为 EXPORT_SYMBOL_GPL 主要是给有GPL认证的模块使用的）;

3. 首先加载（insmod mod1.ko）定义该函数的模块，再加载（insmod mod2.ko）调用该函数的模块;
   举例简要说明：

   在模块（mod1）中使用 EXPORT_SYMBOL_GPL (func1);
   在模块（mod2）中先声明 extern int func1()，然后使用宏 MODULE_LICENSE(“GPL”) ;
   如此就可以在（mod2）中调用 func1 了。

   例如，在一个驱动中 drivers/usb/core/urb.c 定义了函数 usb_scuttle_anchored_urbs，然后在另外的.c文件中可以直接extern来使用：

   void usb_scuttle_anchored_urbs(struct usb_anchor *anchor){struct urb *victim;unsigned long flags;spin_lock_irqsave(&anchor->lock, flags);while (!list_empty(&anchor->urb_list)) {
   		victim = list_entry(anchor->urb_list.prev, struct urb,
   				    anchor_list);__usb_unanchor_urb(victim, anchor);}spin_unlock_irqrestore(&anchor->lock, flags);}EXPORT_SYMBOL_GPL(usb_scuttle_anchored_urbs);

   使用 extern 来声明：

   extern void usb_scuttle_anchored_urbs(struct usb_anchor *anchor);MODULE_LICENSE("GPL");static void carl9170_usb_cancel_urbs(struct ar9170 *ar){int err;carl9170_set_state(ar, CARL9170_UNKNOWN_STATE);
   
   	err = carl9170_usb_flush(ar);if (err)dev_err(&ar->udev->dev, "stuck tx urbs!\n");usb_poison_anchored_urbs(&ar->tx_anch);carl9170_usb_handle_tx_err(ar);usb_poison_anchored_urbs(&ar->rx_anch);tasklet_kill(&ar->usb_tasklet);usb_scuttle_anchored_urbs(&ar->rx_work);usb_scuttle_anchored_urbs(&ar->rx_pool);usb_scuttle_anchored_urbs(&ar->tx_cmd);}

四、如何查看 EXPORT_SYMBOL 和 EXPORT_SYMBOL_GPL 内核"导出"的符号表

• EXPORT_SYMBOL(符号名)、 EXPORT_SYMBOL_GPL(符号名) 主要作之一： 内核"导出"的符号表，这个表在 insmod 时候会用到。

• cat /proc/kallsyms 会打印出内核当前的符号表,例如:

  bf00d8c0 T tnkhw_bonding_setcurr_active_slave   [stmmac]bf00b460 t tnk_tcp_set_thin_linear_timeouts     [stmmac]bf014764 t tnkhw_check_vlan     [stmmac]bf0134c0 t tnkhw_tx_err_dump_info       [stmmac]bf00a43c t tnk_proc_init        [stmmac]bf01cfd8 b syscfg_base_ioaddr   [stmmac]bf0110b4 t tnk_set_thin_linear_timeouts [stmmac]bf017094 r ndesc_ops    [stmmac]bf01595c t tnkhw_set_txadvwnd_scale     [stmmac]bf0095d0 t tnk_ct_link_state_update     [stmmac]bf015724 t tnkhw_send_ack       [stmmac]bf00f790 t tnkhw_lro_free_skb   [stmmac]bf004f20 t dwmac_dma_stop_rx    [stmmac]bf00fad0 t tnkhw_rx_lro_recycle_skb     [stmmac]bf00d868 T tnkhw_bonding_setmode        [stmmac]bf015b68 t tnkhw_lookup_access  [stmmac]bf01c53c d stmmac_irq_num       [stmmac]bf00a95c t tnk_tcp_disable_rcv  [stmmac]bf0041e8 t stmmac_proc  [stmmac]bf0124a4 t curr_bonding_dev     [stmmac]bf01659c t cleanup_module       [stmmac]

• 上述列表信息具体含义解释：

  第一列，是该符号在内核地址空间中的地址;
  第二列，是符号属性，小写表示局部符号，大写表示全局符号（具体含义参考man nm）;
  第三列，表示符号字符串（即函数名或变量等）;
  第四列，表示加载的驱动名称;

• man nm 符号含义：

  “A” 符号的值是绝对值，不会因进一步链接而更改。
  “B”
  “b” 符号位于BSS数据部分。此部分通常包含初始化为零或未初始化的数据，但具体行为取决于系统。
  “C” 符号很常见。公共符号是未初始化的数据。链接时，可能会出现多个同名的通用符号。如果符号被定义在任意的地方，公共符号被视为未定义的引用。
  “D”
  “d” 符号位于初始化数据段中。
  “G”
  “g” 符号位于小对象的初始化数据段中。某些对象文件格式允许更有效地访问小数据对象，例如全局int变量，而不是大型全局数组。
  “i” 对于PE格式文件，这表示符号位于特定于DLL实现的节中。对于ELF格式文件，这表示符号是间接功能。这是ELF符号类型标准集的GNU扩展。它表示一个符号，如果被重新定位引用，该符号的值不会与其地址，但必须在运行时调用。然后，运行时执行将返回要在重新定位中使用的值。
  “I” 符号是对另一符号的间接引用。
  “N” 符号是调试符号。
  “p” 符号位于堆栈展开部分。
  “R”
  “r” 符号位于只读数据段中。
  “S”
  “s” 符号位于小对象的未初始化或零初始化数据段中。
  “T”
  “t” 符号位于文本（代码）部分。
  “U” 符号未定义。
  “u” 符号是唯一的全局符号。这是ELF符号绑定标准集的GNU扩展。对于这样的符号，动态链接器将确保在在整个过程中，只有一个符号使用此名称和类型。
  “V”
  “v” 符号是一个弱对象。当弱定义符号与正常定义符号链接时，使用正常定义符号时不会出错。当弱未定义符号被链接并且符号未被定义，则弱符号的值变为零，没有错误。在某些系统上，大写表示默认值具有已指定。
  “W”
  “w” 符号是一个弱符号，未被明确标记为弱对象符号。当弱定义符号与正常定义符号链接时使用定义的符号时没有错误。当弱未定义符号被链接且未定义该符号时，该符号的值将在特定系统中确定没有错误的方式。在某些系统上，大写表示已指定默认值。
  “-” 符号是a.out对象文件中的刺符号。在这种情况下，接下来打印的值是插入其他字段、插入描述字段和插入类型。Stabs符号用于保存调试信息。
  “?” 符号类型未知，或特定于对象文件格式。