net_device 结构详情

   从事网络开发多年，一直游走在上层，虽然熟悉 TCP/IP 原理，阅读过协议栈源码，也干过 IP 分片重组、TCP 流重组等活儿，但是一直未深入到驱动层面。好奇心驱使，加上最近工作有涉及，终于决定潜下心来研究。net_device 作为网络驱动程序的核心，自然是首先要啃下的硬骨头。研究了一番后发现，绝大部分参考都在版本升级后失去了意义。以下的详情以 2.6.32 为参考，主要会是自己的理解。

   源码的注释一开头就提到了：

   "Actually, this whole structure is a big mistake......"

   原因在于将 I/O 数据与高层的协议相混合，例如结构中存在若干 procotol specific pointer，包括 ip_ptr，ip6_ptr 等。从这一点上来说，的确不符合分层的原则。新版本中是否修改暂不关注，主流版本先理解透再说。

char name[IFNAMSIZ];

   这个好理解，对应 ifconfig 输出的网卡名称，例如 eth0，字母代表网络设备的类型，数字代表此类网络设备的数量。如果每个字段都这么 easy，生活将多美好！

struct hlist_node name_hlist;
struct list_head  dev_list;
struct hlist_node index_hlist;

   以上 3 个字段是为了管理多个 net_device 结构并提供多个查询方式，支持依据 name 和 index 从 hash 表中查找。毕竟服务器上可能不只一块网卡，再加上虚拟的网络设备，数量就更多了。

char *ifalias;

   别名，用于 SNMP 协议。

   以下是网络设备的硬件信息：

/* 网络设备内存映射时在主机中的内存区域 */
unsigned long       mem_end;
unsigned long       mem_start;
/*网络设备I/O基地址 */
unsigned long       base_addr;
/* 中断号 */
unsigned int        irq;
/* 传输介质，如双绞线、同轴电缆等，在多端口设备中指定使用哪个端口 */
/* 可能的取值如下：
enum {
    IF_PORT_UNKNOWN = 0,
    IF_PORT_10BASE2,
    IF_PORT_10BASET,
    IF_PORT_AUI,
    IF_PORT_100BASET,
    IF_PORT_100BASETX,
    IF_PORT_100BASEFX
}; */
unsigned char           if_port;
/* dma 通道 */
unsigned char       dma;
/* 最大传输单元，以太网数据帧最大为 1500 字节 */
unsigned int            mtu;
/* 网络设备硬件类型，如 10Mbps 以太网 ARPHRD_ETHER */
unsigned short          type;
/* 硬件数据帧头的长度，以太网为14字节 */
unsigned short          hard_header_len;
/* 广播地址 */
unsigned char           broadcast[MAX_ADDR_LEN];
/* 硬件(如MAC)地址长度以及设备的硬件地址 */
unsigned char   addr_len; 
unsigned char   *dev_addr; 
unsigned char   perm_addr[MAX_ADDR_LEN]; 
unsigned char   addr_assign_type;

unsigned long state;

设备状态. 这个成员包括几个标志. 驱动正常情况下不直接操作这些标志; 相反, 提供了一套实用函数. 这些函数在我们进入驱动操作后马上讨论这些函数.

struct net_device *next;

全局列表中指向下一个设备的指针. 这个成员驱动不能动.

17.3.2. 硬件信息

下面的成员包含了相对简单设备的低层硬件信息. 它们是早期 Linux 网络的延续; 大部分现代驱动确实使用它们(可能的例外是 if_port ). 我们为完整起见在这里列出.

unsigned long mem_end;

unsigned long mem_start;

设备内存信息. 这些成员持有设备使用的共享内存的开始和结束地址. 如果设备有不同的接收和发送内存, mem 成员由发送内存使用, rmem 成员由接收内存使用. rmem 成员在驱动之外从不被引用. 惯例上, 设置 end 成员, 所以 end - start 是可用的板上内存的数量.

unsigned long base_addr;

网络接口的 I/O 基地址. 这个成员, 如同前面的, 由驱动在设备探测时赋值. ifconfig 目录可用来显示或修改当前值. base_addr 可以当系统启动时在内核命令行中显式赋值( 通过 netdev= 参数), 或者在模块加载时. 这个成员, 象上面描述过的内存成员, 内核不使用它们.

unsigned char irq;

安排的中断号. 当接口被列出时 ifconfig 打印出 dev->irq 的值. 这个值常常在启动或者加载时间设置并且在后来由 ifconfig 打印.

unsigned char if_port;

在多端口设备中使用的端口. 例如, 这个成员用在同时支持同轴线(IF_PORT_10BASE2)和双绞线(IF_PORT_100BSAET)以太网连接. 完整的已知端口类型设置定义在 <linux/netdevie.h>.

unsigned char dma;

设备分配的 DMA 通道. 这个成员只在某些外设总线时有意义, 例如 ISA. 它不在设备驱动自身以外使用, 只是为了信息目的( 在 ifconfig ) 中.

17.3.3. 接口信息

有关接口的大部分信息由 ether_setup 函数正确设置(或者任何其他对给定硬件类型适合的设置函数). 以太网卡可以依赖这个通用的函数设置大部分这些成员, 但是 flags 和 dev_addr 成员是特定设备的, 必须在初始化时间明确指定.

一些非以太网接口可以使用类似 ether_setup 的帮助函数. deviers/net/net_init.c 输出了一些类似的函数, 包括下列:

大部分设备会归于这些类别中的一类. 如果你的是全新和不同的, 但是, 你需要手工赋值下面的成员:

unsigned short hard_header_len;

硬件头部长度, 就是, 被发送报文前面在 IP 头之前的字节数, 或者别的协议信息. 对于以太网接口 hard_header_len 值是 14 (ETH_HLEN).

unsigned mtu;

最大传输单元 (MTU). 这个成员是网络层用作驱动报文传输. 以太网有一个 1500 字节的 MTU (ETH_DATA_LEN). 这个值可用 ifconfig 改变.

unsigned long tx_queue_len;

设备发送队列中可以排队的最大帧数. 这个值由 ether_setup 设置为 1000, 但是你可以改它. 例如, plip 使用 10 来避免浪费系统内存( 相比真实以太网接口, plip 有一个低些的吞吐量).

unsigned short type;

接口的硬件类型. 这个 type 成员由 ARP 用来决定接口支持什么样的硬件地址. 对以太网接口正确的值是 ARPHRD_ETHER, 这是由 ether_setup 设置的值. 可认识的类型定义于 <linux/if_arp.h>.

unsigned char addr_len;

unsigned char broadcast[MAX_ADDR_LEN];

unsigned char dev_addr[MAX_ADDR_LEN];

硬件 (MAC) 地址长度和设备硬件地址. 以太网地址长度是 6 个字节( 我们指的是接口板的硬件 ID ), 广播地址由 6 个 0xff 字节组成; ether_setup 安排成正确的值. 设备地址, 另外, 必须以特定于设备的方式从接口板读出, 驱动应当将它拷贝到 dev_addr. 硬件地址用来产生正确的以太网头, 在报文传递给驱动发送之前. snull 设备不使用物理接口, 它创造自己的硬件接口.

unsigned short flags;

int features;

接口标志(下面详述)

这个 flags 成员是一个位掩码, 包括下面的位值. IFF_ 前缀代表 "interface flags". 有些标志由内核管理, 有些由接口在初始化时设置来表明接口的能力和其他特性. 有效的标志, 对应于 <linux/if.h>, 有:

IFF_UP

对驱动这个标志是只读的. 内核打开它当接口激活并准备号传送报文时.

IFF_BROADCAST

这个标志(由网络代码维护)说明接口允许广播. 以太网板是这样.

IFF_DEBUG

这个标识了调试模式. 这个标志用来控制你的 printk 调用的复杂性或者用于其他调试目的. 尽管当前没有 in-tree 驱动使用这个标志, 它可以通过 ioctl 来设置和重置, 你的驱动可用它. misc-progs/netifdebug 程序可以用来打开或关闭这个标志.

IFF_LOOPBACK

这个标志应当只在环回接口中设置. 内核检查 IFF_LOOPBACK , 以代替硬连线 lo 名子作为一个特殊接口.

IFF_POINTOPOINT

这个标志说明接口连接到一个点对点链路. 它由驱动设置或者, 有时, 由 ifconfig. 例如, plip 和 PPP 驱动设置它.

IFF_NOARP

这个说明接口不能进行 ARP. 例如, 点对点接口不需要运行 ARP, 它只能增加额外的流量却没有任何有用的信息. snull 在没有 ARP 能力的情况下运行, 因此它设置这个标志.

IFF_PROMISC

这个标志设置(由网络代码)来激活混杂操作. 缺省地, 以太网接口使用硬件过滤器来保证它们只接收广播报文和直接到接口硬件地址的报文. 报文嗅探器, 例如 tcpdump, 在接口上设置混杂模式来存取在接口发送介质上经过的所有报文.

IFF_MULTICAST

驱动设置这个标志来表示接口能够组播发送. ether_setup 设置 IFF_MULTICAST 缺省地, 因此如果你的驱动不支持组播, 必须在初始化时清除这个标志.

IFF_ALLMULTI

这个标志告知接口接收所有的组播报文. 内核在主机进行组播路由时设置它, 前提是 IFF_MULTICAST 置位. IFF_ALLMULTI 对驱动是只读的. 组播标志在本章后面的"组播"一节中用到.

IFF_MASTER

IFF_SLAVE

这些标志由负载均衡代码使用. 接口驱动不需要知道它们.

IFF_PORTSEL

IFF_AUTOMEDIA

这些标志指出设备可以在多个介质类型间切换; 例如, 无屏蔽双绞线 (UTP) 和 同轴以太网电缆. 如果 IFF_AUTOMEDIA 设置了, 设备自动选择正确的介质. 特别地, 内核一个也不使用这 2 个标志.

IFF_DYNAMIC

这个标志, 由驱动设置, 指出接口的地址能够变化. 目前内核没有使用.

IFF_RUNNING

这个标志指出接口已启动并在运行. 它大部分是因为和 BSD 兼容; 内核很少用它. 大部分网络驱动不需要担心 IFF_RUNNING.

IFF_NOTRAILERS

在 Linux 中不用这个标志, 为了 BSD 兼容才存在.

当一个程序改变 IFF_UP, open 或者 stop 设备方法被调用. 进而, 当 IFF_UP 或者任何别的标志修改了, set_multicast_list 方法被调用. 如果驱动需要进行某些动作来响应标志的修改, 它必须在 set_multicast_list 中采取动作. 例如, 当 IFF_PROMISC 被置位或者复位, set_multicast_list 必须通知板上的硬件过滤器. 这个设备方法的责任在"组播"一节中讲解.

结构 net_device 的特性成员由驱动设置来告知内核关于任何的接口拥有的特别硬件能力. 我们将谈论一些这些特性; 别的就超出了本书范围. 完整的集合是:

NETIF_F_SG

NETIF_F_FRAGLIST

2 个标志控制发散/汇聚 I/O 的使用. 如果你的接口可以发送一个报文, 它由几个不同的内存段组成, 你应当设置 NETIF_F_SG. 当然, 你不得不实际实现发散/汇聚 I/O( 我们在"发散/汇聚"一节中描述如何做 ). NETIF_F_FRAGLIST 表明你的接口能够处理分段的报文; 在 2.6 中只有环回驱动做这一点.

注意内核不对你的设备进行发散/汇聚 I/O 操作, 如果它没有同时提供某些校验和形式. 理由是, 如果内核不得不跨过一个分片的("非线性")的报文来计算校验和, 它可能也拷贝数据并同时接合报文.

NETIF_F_IP_CSUM

NETIF_F_NO_CSUM

NETIF_F_HW_CSUM

这些标志都是告知内核, 不需要给一些或所有的通过这个接口离开系统的报文进行校验. 如果你的接口可以校验 IP 报文但是别的不行, 就设置 NETIF_F_IP_CSUM. 如果这个接口不曾要求校验和, 就设置 NETIF_F_NO_CSUM. 环回驱动设置了这个标志, snull 也设置; 因为报文只通过系统内存传送, 对它们来说没有机会( 1 跳 )被破坏, 没有必要校验它们. 如果你的硬件自己做校验, 设置 NETIF_F_HW_CWSUM.

NETIF_F_HIGHDMA

设置这个标志, 如果你的设备能够对高端内存进行 DMA. 没有这个标志, 所有提供给你的驱动的报文在低端内存分配.

NETIF_F_HW_VLAN_TX

NETIF_F_HW_VLAN_RX

NETIF_F_HW_VLAN_FILTER

NETIF_F_VLAN_CHALLENGED

这些选项描述你的硬件对 802.1q VLAN 报文的支持. VLAN 支持超出我们本章的内容. 如果 VLAN 报文使你的设备混乱( 其实不应该 ), 设置标志 NETIF_F_VLAN_CHALLENGED.

NETIF_F_TSO

如果你的设备能够进行 TCP 分段卸载, 设置这个标志. TSO 是一个我们在这不涉及的高级特性.

17.3.4. 设备方法

如同在字符和块驱动的一样, 每个网络设备声明能操作它的函数. 本节列出能够对网络接口进行的操作. 有些操作可以留作 NULL, 别的常常是不被触动的, 因为 ether_setup 给它们安排了合适的方法.

网络接口的设备方法可分为 2 组: 基本的和可选的. 基本方法包括那些必需的能够使用接口的; 可选的方法实现更多高级的不是严格要求的功能. 下列是基本方法:

int (*open)(struct net_device *dev);

打开接口. 任何时候 ifconfig 激活它, 接口被打开. open 方法应当注册它需要的任何系统资源( I/O 口, IRQ, DMA, 等等), 打开硬件, 进行任何别的你的设备要求的设置.

int (*stop)(struct net_device *dev);

停止接口. 接口停止当它被关闭. 这个函数应当恢复在打开时进行的操作.

int (*hard_start_xmit) (struct sk_buff *skb, struct net_device *dev);

起始报文的发送的方法. 完整的报文(协议头和所有)包含在一个 socket 缓存区( sk_buff ) 结构. socket 缓存在本章后面介绍.

int (*hard_header) (struct sk_buff *skb, struct net_device *dev, unsigned short type, void *daddr, void *saddr, unsigned len);

用之前取到的源和目的硬件地址来建立硬件头的函数(在 hard_start_xmit 前调用). 它的工作是将作为参数传给它的信息组织成一个合适的特定于设备的硬件头. eth_header 是以太网类型接口的缺省函数, ether_setup 针对性地对这个成员赋值.

int (*rebuild_header)(struct sk_buff *skb);

用来在 ARP 解析完成后但是在报文发送前重建硬件头的函数. 以太网设备使用的缺省的函数使用 ARP 支持代码来填充报文缺失的信息.

void (*tx_timeout)(struct net_device *dev);

由网络代码在一个报文发送没有在一个合理的时间内完成时调用的方法, 可能是丢失一个中断或者接口被锁住. 它应当处理这个问题并恢复报文发送.

struct net_device_stats *(*get_stats)(struct net_device *dev);

任何时候当一个应用程序需要获取接口的统计信息, 调用这个方法. 例如, 当 ifconfig 或者 netstat -i 运行时. snull 的一个例子实现在"统计信息"一节中介绍.

int (*set_config)(struct net_device *dev, struct ifmap *map);

改变接口配置. 这个方法是配置驱动的入口点. 设备的 I/O 地址和中断号可以在运行时使用 set_config 来改变. 这种能力可由系统管理员在接口没有探测到时使用. 现代硬件正常的驱动一般不需要实现这个方法.

剩下的设备操作是可选的:

int weight;

int (*poll)(struct net_device *dev; int *quota);

由适应 NAPI 的驱动提供的方法, 用来在查询模式下操作接口, 中断关闭着. NAPI ( 以及 weight 成员) 在"接收中断缓解"一节中涉及.

void (*poll_controller)(struct net_device *dev);

在中断关闭的情况下, 要求驱动检查接口上的事件的函数. 它用于特殊的内核中的网络任务, 例如远程控制台和使用网络的内核调试.

int (*do_ioctl)(struct net_device *dev, struct ifreq *ifr, int cmd);

处理特定于接口的 ioctl 命令. (这些命令的实现在"定制 ioclt 命令"一节中描述)相应的 net_device 结构中的成员可留为 NULL, 如果接口不需要任何特定于接口的命令.

void (*set_multicast_list)(struct net_device *dev);

当设备的组播列表改变和当标志改变时调用的方法. 详情见"组播"一节, 以及一个例子实现.

int (*set_mac_address)(struct net_device *dev, void *addr);

如果接口支持改变它的硬件地址的能力, 可以实现这个函数. 很多接口根本不支持这个能力. 其他的使用缺省的 eth_mac_adr 实现(在 deivers/net/net_init.c). eth_mac_addr 只拷贝新地址到 dev->dev_addr, 只在接口没有运行时作这件事. 使用 eth_mac_addr 的驱动应当在它们的 open 方法中自 dev->dev_addr 里设置硬件 MAC 地址.

int (*change_mtu)(struct net_device *dev, int new_mtu);

当接口的最大传输单元 (MTU) 改变时动作的函数. 如果用户改变 MTU 时驱动需要做一些特殊的事情, 它应当声明它的自己的函数; 否则, 缺省的会将事情做对. snull 有对这个函数的一个模板, 如果你有兴趣.

int (*header_cache) (struct neighbour *neigh, struct hh_cache *hh);

header_cache 被调用来填充 hh_cache 结构, 使用一个 ARP 请求的结果. 几乎全部类似以太网的驱动可以使用缺省的 eth_header_cache 实现.

int (*header_cache_update) (struct hh_cache *hh, struct net_device *dev, unsigned char *haddr);

在响应一个变化中, 更新 hh_cache 结构中的目的地址的方法. 以太网设备使用 eth_header_cache_update.

int (*hard_header_parse) (struct sk_buff *skb, unsigned char *haddr);

hard_header_parse 方法从包含在 skb 中的报文中抽取源地址, 拷贝到 haddr 的缓存区. 函数的返回值是地址的长度. 以太网设备通常使用 eth_header_parse.

17.3.5. 公用成员

结构 net_device 剩下的数据成员由接口使用来持有有用的状态信息. 有些是 ifconfig 和 netstat 用来提供给用户关于当前配置的信息. 因此, 接口应当给这些成员赋值:

unsigned long trans_start;

unsigned long last_rx;

保存一个 jiffy 值的成员. 驱动负责分别更新这些值, 当开始发送和收到一个报文时. trans_start 值被网络子系统用来探测发送器加锁. last_rx 目前没有用到, 但是驱动应当尽量维护这个成员以备将来使用.

int watchdog_timeo;

网络层认为一个传送超时发生前应当过去的最小时间(按 jiffy 计算), 调用驱动的 tx_timeout 函数.

void *priv;

filp->private_data 的对等者. 在现代的驱动里, 这个成员由 alloc_netdev 设置, 不应当直接存取; 使用 netdev_priv 代替.

struct dev_mc_list *mc_list;

int mc_count;

处理组播发送的成员. mc_count 是 mc_list 中的项数目. 更多细节见"组播"一节.

spinlock_t xmit_lock;

int xmit_lock_owner;

xmit_lock 用来避免对驱动的 hard_start_xmit 函数多个同时调用. xmit_lock_owner 是已获得 xmit_lock 的CPU号. 驱动应当不改变这些成员的值.

   结构 net_device 中有其他的成员，但是网络驱动用不着它们。