17.16. 快速参考

17.16. 快速参考

本节提供了本章中介绍的概念的参考. 也解释了每个驱动需要包含的头文件的角色. 在 net_device 和 sk_buff 结构中成员的列表, 但是, 这里没有重复.

#include <linux/netdevice.h>

定义 struct net_device 和 struct net_device_stats 的头文件, 包含了几个其他网络驱动需要的头文件.

struct net_device *alloc_netdev(int sizeof_priv, char *name, void (*setup)(struct net_device *);
struct net_device *alloc_etherdev(int sizeof_priv);
void free_netdev(struct net_device *dev);

分配和释放 net_device 结构的函数

int register_netdev(struct net_device *dev);
void unregister_netdev(struct net_device *dev);

注册和注销一个网络设备.

void *netdev_priv(struct net_device *dev);

获取网络设备结构的驱动私有区域的指针的函数.

struct net_device_stats;

持有设备统计的结构.

netif_start_queue(struct net_device *dev);
netif_stop_queue(struct net_device *dev);
netif_wake_queue(struct net_device *dev);

控制传送给驱动来发送的报文的函数. 没有报文被传送, 直到 netif_start_queue 被调用. netif_stop_queue 挂起发送, netif_wake_queue 重启队列并刺探网络层重启发送报文.

skb_shinfo(struct sk_buff *skb);

宏定义, 提供对报文缓存的"shared info"部分的存取.

void netif_rx(struct sk_buff *skb);

调用来通知内核一个报文已经收到并且封装到一个 socket 缓存中的函数.

void netif_rx_schedule(dev);

来告诉内核报文可用并且应当启动查询接口; 它只是被 NAPI 兼容的驱动使用.

int netif_receive_skb(struct sk_buff *skb);
void netif_rx_complete(struct net_device *dev);

应当只被 NAPI 兼容的驱动使用. netif_receive_skb 是对于 netif_rx 的 NAPI 对等函数; 它递交一个报文给内核. 当一个 NAPI 兼容的驱动已耗尽接收报文的供应, 它应当重开中断, 并且调用 netif_rx_complete 来停止查询.

#include <linux/if.h>

由 netdevice.h 包含, 这个文件声明接口标志( IFF_ 宏定义 )和 struct ifmap, 它在网络驱动的 ioctl 实现中有重要地位.

void netif_carrier_off(struct net_device *dev);
void netif_carrier_on(struct net_device *dev);
int netif_carrier_ok(struct net_device *dev);

前 2 个函数可用来告知内核是否接口上有载波信号. netif_carrier_ok 测试载波状态, 如同在设备结构中反映的.

#include <linux/if_ether.h>
ETH_ALENETH_P_IPstruct ethhdr;

由 netdevice.h 包含, ifether.h 定义所有的 ETH 宏定义, 用来代表字节长度( 例如地址长度 )以及网络协议(例如 IP). 它也定义 ethhdr 结构.

#include <linux/skbuff.h>

struct sk_buff 和相关结构的定义, 以及几个操作缓存的内联函数. 这个头文件由 netdevice.h 包含.

struct sk_buff *alloc_skb(unsigned int len, int priority);
struct sk_buff *dev_alloc_skb(unsigned int len);
void kfree_skb(struct sk_buff *skb);
void dev_kfree_skb(struct sk_buff *skb);
void dev_kfree_skb_irq(struct sk_buff *skb);
void dev_kfree_skb_any(struct sk_buff *skb);

处理 socket 缓存的分配和释放的函数. 通常驱动应当使用 dev_ 变体, 其意图就是此目的.

unsigned char *skb_put(struct sk_buff *skb, int len);
unsigned char *__skb_put(struct sk_buff *skb, int len);
unsigned char *skb_push(struct sk_buff *skb, int len);
unsigned char *__skb_push(struct sk_buff *skb, int len);

添加数据到一个 skb 的函数; skb_put 在 skb 的尾部放置数据, 而 skb_push 放在开始. 正常版本进行检查以确保有足够的空间; 双下划线版本不进行检查.

int skb_headroom(struct sk_buff *skb);
int skb_tailroom(struct sk_buff *skb);
void skb_reserve(struct sk_buff *skb, int len);

进行 skb 中的空间管理的函数. skb_headroom 和 skb_tailroom 说明在开始和结尾分别有多少空间可用. skb_reserve 可用来保留空间, 在一个必须为空的 skb 开始.

unsigned char *skb_pull(struct sk_buff *skb, int len);

skb_pull "去除" 数据从一个 skb, 通过调整内部指针.

int skb_is_nonlinear(struct sk_buff *skb);

如果这个 skb 是为发散/汇聚 I/O 分隔为几个片, 函数返回一个真值.

int skb_headlen(struct sk_buff *skb);

返回 skb 的第一个片的长度, 由 skb->data 指向.

void *kmap_skb_frag(skb_frag_t *frag);
void kunmap_skb_frag(void *vaddr);

提供对非线性 skb 中的片直接存取的函数.

#include <linux/etherdevice.h>
void ether_setup(struct net_device *dev);

为以太网驱动设置大部分方法为通用实现的函数. 它还设置 dev->flags 和安排下一个可用的 ethx 给 dev->name, 如果名子的第一个字符是一个空格或者 NULL 字符.

unsigned short eth_type_trans(struct sk_buff *skb, struct net_device *dev);

当一个以太网接口收到一个报文, 这个函数被调用来设置 skb->pkt_type. 返回值是一个协议号, 通常存储于 skb->protocol.

#include <linux/sockios.h>
SIOCDEVPRIVATE 

前 16 个 ioctl 命令, 每个驱动可为它们自己的私有用途而实现. 所有的网络 ioctl 命令都在 sockios.h 中定义.

#include <linux/mii.h>
struct mii_if_info;

声明和一个结构, 支持实现 MII 标准的设备的驱动.

#include <linux/ethtool.h>
struct ethtool_ops;

声明和结构, 使得设备与 ethtool 工具一起工作.