1.. SPDX-License-Identifier: GPL-2.0 2 3.. include:: ../disclaimer-zh_CN.rst 4 5:Original: Documentation/networking/driver.rst 6 7:翻译: 8 9 陈思为 Siwei Chen <businiaoanka@anka1.top> 10 11================ 12Softnet 驱动问题 13================ 14 15探测指南 16======== 17 18地址校验 19-------- 20 21为设备获取的任何硬件层地址都应进行校验。例如,以太网地址应使用 22linux/etherdevice.h 中的 is_valid_ether_addr() 进行检查。 23 24关闭/停止指南 25============= 26 27静默 28---- 29 30ndo_stop 例程被调用后,硬件不得再收发任何数据。所有在途报文都必须中止。 31如有必要,应轮询或等待任何复位命令完成。 32 33自动关闭 34-------- 35 36若设备仍处于 UP 状态,ndo_stop 例程将由 unregister_netdevice 调用。 37 38发送路径指南 39============ 40 41提前停止队列 42------------ 43 44ndo_start_xmit 方法在任何正常情况下都不得返回 NETDEV_TX_BUSY。 45除非设备确实无法预先判断其发送功能何时会繁忙,否则返回该值被视为严重错误。 46 47相反,驱动必须正确地维护队列。例如,对于实现分散-聚集 48(scatter-gather)的驱动,这意味着: 49 50.. code-block:: c 51 52 static u32 drv_tx_avail(struct drv_ring *dr) 53 { 54 u32 used = READ_ONCE(dr->prod) - READ_ONCE(dr->cons); 55 56 return dr->tx_ring_size - (used & dr->tx_ring_mask); 57 } 58 59 static netdev_tx_t drv_hard_start_xmit(struct sk_buff *skb, 60 struct net_device *dev) 61 { 62 struct drv *dp = netdev_priv(dev); 63 struct netdev_queue *txq; 64 struct drv_ring *dr; 65 int idx; 66 67 idx = skb_get_queue_mapping(skb); 68 dr = dp->tx_rings[idx]; 69 txq = netdev_get_tx_queue(dev, idx); 70 71 //... 72 /* 这应当是极为罕见的竞争——记录下来。 */ 73 if (drv_tx_avail(dr) <= skb_shinfo(skb)->nr_frags + 1) { 74 netif_tx_stop_queue(txq); 75 netdev_warn(dev, "Tx Ring full when queue awake!\n"); 76 return NETDEV_TX_BUSY; 77 } 78 79 //... 将报文排队到网卡 ... 80 81 netdev_tx_sent_queue(txq, skb->len); 82 83 //... 使用 WRITE_ONCE() 更新 tx 生产者索引 ... 84 85 if (!netif_txq_maybe_stop(txq, drv_tx_avail(dr), 86 MAX_SKB_FRAGS + 1, 2 * MAX_SKB_FRAGS)) 87 dr->stats.stopped++; 88 89 //... 90 return NETDEV_TX_OK; 91 } 92 93然后在 TX 回收事件处理的末尾: 94 95.. code-block:: c 96 97 //... 使用 WRITE_ONCE() 更新 tx 消费者索引 ... 98 99 netif_txq_completed_wake(txq, cmpl_pkts, cmpl_bytes, 100 drv_tx_avail(dr), 2 * MAX_SKB_FRAGS); 101 102无锁队列停止/唤醒辅助宏 103~~~~~~~~~~~~~~~~~~~~~~~ 104 105.. kernel-doc:: include/net/netdev_queues.h 106 :doc: Lockless queue stopping / waking helpers. 107 108netif_txq_maybe_stop()、netif_txq_try_stop() 等标准宏已经过充分测试, 109请优先使用它们,而非本地同步方案。 110 111无独占所有权 112------------ 113 114ndo_start_xmit 方法不得修改被克隆 SKB 的共享部分。 115 116及时完成 117-------- 118 119请谨记:一旦 ndo_start_xmit 方法返回 NETDEV_TX_OK, 120驱动就有责任在有限的时间内释放该 SKB。 121 122例如,这意味着不允许你的 TX 缓解方案在没有新 TX 报文发送时, 123让 TX 报文永远“滞留”在 TX 环中而不被回收。 124这种错误会使等待发送缓冲区空间释放的套接字发生死锁。 125 126若 ndo_start_xmit 方法返回 NETDEV_TX_BUSY, 127则不得保留对该 SKB 的任何引用,也不得尝试释放它。 128 129错误消息报告 130============ 131 132许多驱动配置接口会向驱动传递一个 Netlink 扩展 ACK(``extack``)对象 133(直接作为参数,或作为参数结构体的成员)。驱动应尽量通过 ``extack`` 对象 134报告大多数错误。表示系统或设备行为异常、处于不良状态的系统级异常,则应继续 135报告到系统日志。 136 137消息应 **要么** 通过 ``extack`` 传递, **要么** 写入系统日志。驱动不应 138试图将同一信息同时报告到两处。 139