【C语言】linux内核napi_gro_receive和netif_napi_add

napi_gro_receive

一、注释

// napi_gro_receive是网络设备接口的一个函数，它被NAPI（New API）网络轮询机制使用，用于接收和处理接收到的数据包。
// 这个函数通过通用接收分组（GRO，Generic Receive Offload）技术来合并多个接收到的数据包，以减少CPU的使用率并提高吞吐量。
gro_result_t napi_gro_receive(struct napi_struct *napi, struct sk_buff *skb)
{
    // 将skb（socket buffer，数据包缓冲区）关联到当前的napi结构
    skb_mark_napi_id(skb, napi);
    // 记录跟踪点，通知开始接收GRO数据包的操作（若系统编译时启用了跟踪点的话）
    trace_napi_gro_receive_entry(skb);

    // 重置数据包的GRO偏移量，准备对其进行GRO处理
    skb_gro_reset_offset(skb);

    // 调用dev_gro_receive函数来处理具体的GRO逻辑
    // 并使用napi_skb_finish来处理dev_gro_receive返回的结果，完成GRO处理
    return napi_skb_finish(dev_gro_receive(napi, skb), skb);
}
// 导出napi_gro_receive符号，使得它可以被模块化的内核代码使用
EXPORT_SYMBOL(napi_gro_receive);

这个函数的作用是将一个接收到的`skb`（数据包缓冲区）与一个`napi`结构（代表网络设备的轮询机制）相关联，并对数据包进行处理以适配GRO。处理后，数据包可能会被合并（分组到一起）以提高网络的处理效率。其中涉及到的跟踪点（如`trace_napi_gro_receive_entry`）用于网络调试和性能分析，如果内核配置支持ftrace或其他调试工具时会生成相应的跟踪信息。最后，`EXPORT_SYMBOL`宏确保了该函数可以被其他内核模块调用。

二、讲解

这段代码是Linux内核网络栈中处理接收包的函数，其主要作用是进行通用接收分段（Generic Receive Offload，简称GRO）的处理。以下是对该函数的中文讲解：

// 定义函数napi_gro_receive，gro_result_t是GRO处理结果的类型，该函数用于处理接收到的网络包
gro_result_t napi_gro_receive(struct napi_struct *napi, struct sk_buff *skb)
{
    // 将此skb（socket缓冲区）与当前的NAPI（New API，一种提高网络接收性能的接口）上下文关联起来
    skb_mark_napi_id(skb, napi);

    // 跟踪函数napi_gro_receive起始的相关信息，用于事件调试
    trace_napi_gro_receive_entry(skb);

    // 重置skb中用于GRO处理的偏移指示，准备进行聚合处理
    skb_gro_reset_offset(skb);

    // 将skb传递给dev_gro_receive函数进行具体的GRO处理，并通过napi_skb_finish函数处理dev_gro_receive的结果
    // dev_gro_receive函数负责将多个分段的数据包聚合成一个大的数据包，以提高处理效率
    return napi_skb_finish(dev_gro_receive(napi, skb), skb);
}
// 通过EXPORT_SYMBOL宏导出napi_gro_receive符号，允许其他模块调用这个函数
EXPORT_SYMBOL(napi_gro_receive);

大致流程为：
1. 当网络包通过napi结构接收时，首先标记该网络包与napi的关联，这一步有助于后续处理该包时保持上下文信息。
2. 如果内核配置了事件追踪，记录接收事件的起始状态，以便于开发者调试。
3. 重置网络包的GRO偏移量，准备进行后续的聚合处理。
4. 然后将网络包传递给`dev_gro_receive`实现GRO处理，这个函数的工作是尝试把多个类似的数据包合并为一个大的数据包，从而减少每个数据包的处理开销，提高整体性能。
5. 最后处理聚合结果，并使用`napi_skb_finish`返回处理后的网络包。
此函数通常被网络设备驱动在其NAPI轮询函数中调用，用来处理数据包的接收和聚合工作。通过这种方式，可以显著提高数据包接收的效率，特别是在高速网络接口上。

netif_napi_add

一、中文注释

/**
 * netif_napi_add - 将NAPI结构添加到网络设备中
 * @dev: 指向与NAPI关联的网络设备结构体的指针
 * @napi: 指向要添加的NAPI结构体的指针
 * @poll: 指向在轮询模式下处理网络数据包的函数的指针
 * @weight: 定义在单个poll调用中NAPI结构体可以处理的网络数据包的最大数量
 *
 * 此函数初始化NAPI结构体并将其添加到网络设备的napi_list中。
 * 在网络设备注册期间，通常需要调用此函数以为设备设置轮询模式处理。
 */
void netif_napi_add(struct net_device *dev, struct napi_struct *napi,
            int (*poll)(struct napi_struct *, int), int weight)
{
    // 初始化NAPI结构体的poll_list
    INIT_LIST_HEAD(&napi->poll_list);
    
    // 初始化高精度定时器
    hrtimer_init(&napi->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL_PINNED);
    
    // 设置定时器触发的函数为napi_watchdog
    napi->timer.function = napi_watchdog;
    
    // 初始化NAPI的GRO（Generic Receive Offload）散列
    init_gro_hash(napi);
    
    // 将NAPI结构体的skb成员初始化为NULL
    napi->skb = NULL;
    
    // 设置NAPI结构体的轮询函数
    napi->poll = poll;
    
    // 检查传入的weight值是否超过了NAPI_POLL_WEIGHT的最大值
    if (weight > NAPI_POLL_WEIGHT)
        pr_err_once("netif_napi_add() called with weight %d on device %s\n",
                weight, dev->name);
    
    // 设置NAPI结构体的权重
    napi->weight = weight;
    
    // 将NAPI结构体添加到网络设备的napi_list中
    list_add(&napi->dev_list, &dev->napi_list);
    
    // 将NAPI结构体与网络设备关联
    napi->dev = dev;

#ifdef CONFIG_NETPOLL
    // 初始化poll_owner字段，用于网络轮询控制
    napi->poll_owner = -1;
#endif
    
    // 设置NAPI结构体的状态为SCHED（表示已经安排了轮询）
    set_bit(NAPI_STATE_SCHED, &napi->state);
    
    // 将NAPI结构体添加到全局的hash表中
    napi_hash_add(napi);
}

二、讲解

这个`netif_napi_add`函数是Linux网络驱动程序中使用的，用来初始化和添加一个NAPI结构到指定的网络设备中。NAPI是“New API”的简称，是用来改善网络驱动处理高速数据包的一种机制。下面是该函数的讲解：

void netif_napi_add(struct net_device *dev, struct napi_struct *napi,
            int (*poll)(struct napi_struct *, int), int weight)
{
    // 初始化napi结构中的poll_list链表头
    INIT_LIST_HEAD(&napi->poll_list);
    
    // 初始化napi结构中的高分辨率定时器
    hrtimer_init(&napi->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL_PINNED);
    
    // 设置高分辨率定时器的回调函数为napi_watchdog
    napi->timer.function = napi_watchdog;
    
    // 初始化接收分组的散列表（用于GRO, 即通用接收分组）
    init_gro_hash(napi);
    
    // 把napi结构中的skb指针置为空
    napi->skb = NULL;
    
    // 设置NAPI结构的poll回调函数
    napi->poll = poll;
    
    // 如果权重大于NAPI_POLL_WEIGHT（定义的最大权重），打印错误信息。权重用来限制poll函数一次处理的最大数据包数量
    if (weight > NAPI_POLL_WEIGHT)
        pr_err_once("netif_napi_add() called with weight %d on device %s\n",
                weight, dev->name);
    // 设置NAPI结构的权重
    napi->weight = weight;
    
    // 将这个NAPI结构添加到网络设备napi_list的末尾
    list_add(&napi->dev_list, &dev->napi_list);
    
    // 将网络设备指针保存到NAPI结构中
    napi->dev = dev;
    
    // 如果有配置NETPOLL（一种网络轮询模式），则初始化poll_owner为-1
#ifdef CONFIG_NETPOLL
    napi->poll_owner = -1;
#endif
    
    // 设置NAPI状态为"已调度"（表示这个NAPI结构已经被加入到系统中并且可以被调度执行）
    set_bit(NAPI_STATE_SCHED, &napi->state);
    
    // 将NAPI结构添加到全局的哈希表中，这样它就可以被网络子系统正确地管理和调度了
    napi_hash_add(napi);
}

总的来说，此函数用于设置网络设备的NAPI结构，配置必要的参数和函数指针，并将其注册到系统中，使得在接收网络数据包时，可以使用这个NAPI结构来调用相关函数处理数据包。这可以降低中断频率，提升网络吞吐性能。

相关链接：

【C语言】linux内核ipoib模块 - ipoib_napi_add-CSDN博客