PF_RING实现分析

原贴:http://www.cppblog.com/jerryma/archive/2012/10/22/193670.aspx


http://bbs.chinaunix.net/thread-1943951-1-1.html
版权所有,转载请注明出处

独孤九贱

内核版本:Linux 2.6.30.9

PF_RING版本:4.1.0

最近看了一个PF_RING的实现,看了个大概,发上来大家讨论讨论,共同学习。

一、什么是PF_RING
PF_RING是一个第三方的内核数据包捕获接口,类似于libpcap,它的官方网址是:http://www.ntop.org/PF_RING.html

二、为什么需要PF_RING
一切为了效率,按照其官方网站上的测试数据,在Linux平台之上,其效率至少高于libpcap 50% - 60%,甚至是一倍。更好的是,PF_RING提供了一个修改版本的libpcap,使之建立在PF_RING接口之上。这样,原来使用libpcap的程序,就可以自然过渡了。

三、声明
1、这不是“零拷贝”,研究“零拷贝”的估计要失望,如果继续看下去的话;
2、这不是包截获接口,如果需要拦截、修改内核数据包,请转向Netfilter;
3、本文只分析了PF_RING最基础的部份。关于DNA、TNAPI,BPF等内容不包含在内。

四、源码的获取
svn co https://svn.ntop.org/svn/ntop/trunk/PF_RING/ 

最近好像全流行svn了。

五、编译和使用
接口分为两部份,一个是内核模块,一个是用户态的库
cd my_pf_ring_goes_here 
cd kernel 
make 
sudo insmod ./pf_ring.ko 
cd ../userland 
make 

在源码目录中,关于用户态的库有使用的现成的例子,很容易依葫芦画瓢。后文也会提到用户态库的实现的简单分析,可以两相比照,很容易上手。而且源码目录中有一个PDF文档,有详细的API介绍,建议使用前阅读。

六、实现分析初步
1、核心思路
A、在内核队列层注册Hook,获取数据帧。
B、在内核创建一个环形队列(这也是叫RING的原因),用于存储数据,并使用mmap映射到用户空间。这样,避免用户态的系统调用,也是提高性能的关键所在。
C、创建了一个新的套接字类型PF_RING,用户态通过它与内核通信。

2、模块初始化
模块源码只有一个文件,在目录树kernel/pf_ring.c,嗯,还有一个头文件,在kernel/linux下
  1. static int __init ring_init(void)
  2. {
  3.   int i, rc;

  4.   printk("[PF_RING] Welcome to PF_RING %s ($Revision: 4012 $)\n"
  5.          "(C) 2004-09 L.Deri <[email]deri@ntop.org[/email]>\n", RING_VERSION);
  6.         
  7.         //注册名为PF_RING的新协议
  8.   if((rc = proto_register(&ring_proto, 0)) != 0)
  9.     return(rc);
复制代码


ring_proto的定义为
  1. #if(LINUX_VERSION_CODE > KERNEL_VERSION(2,6,11))
  2. static struct proto ring_proto = {
  3.   .name = "PF_RING",
  4.   .owner = THIS_MODULE,
  5.   .obj_size = sizeof(struct ring_sock),
  6. };
  7. #endif
复制代码


初始化四个链表,它们的作用,后文会分析到:
  1.         //初始化四个链表
  2.   INIT_LIST_HEAD(&ring_table);                                        /* List of all ring sockets. */
  3.   INIT_LIST_HEAD(&ring_cluster_list);                        /* List of all clusters */
  4.   INIT_LIST_HEAD(&ring_aware_device_list);                /* List of all devices on which PF_RING has been registered */
  5.   INIT_LIST_HEAD(&ring_dna_devices_list);                /* List of all dna (direct nic access) devices */
复制代码


device_ring_list是一个指针数组,它的每一个元素对应一个网络设备,后文也会分析它的使用:
  1. /*
  2.   For each device, pf_ring keeps a list of the number of
  3.   available ring socket slots. So that a caller knows in advance whether
  4.   there are slots available (for rings bound to such device)
  5.   that can potentially host the packet
  6. */
  7.   for (i = 0; i < MAX_NUM_DEVICES; i++)
  8.     INIT_LIST_HEAD(&device_ring_list[i]);
复制代码

  1.         //为新协议注册sock
  2.   sock_register(&ring_family_ops);
复制代码


ring_family_ops定义为
  1. static struct net_proto_family ring_family_ops = {
  2.   .family = PF_RING,
  3.   .create = ring_create,
  4.   .owner = THIS_MODULE,
  5. };
复制代码

这样,当用户空间创建PF_RING时,例如,
  1. fd = socket(PF_RING, SOCK_RAW, htons(ETH_P_ALL));
复制代码

ring_create将会被调用

  1.   //注册通知链表  
  2.   register_netdevice_notifier(&ring_netdev_notifier);

  3.   /* 工作模式语法检查 */
  4.   if(transparent_mode > driver2pf_ring_non_transparent)
  5.     transparent_mode = standard_linux_path;
复制代码


PF_RING一共有三种工作模式:
  1. typedef enum {
  2.   standard_linux_path = 0, /* Business as usual */
  3.   driver2pf_ring_transparent = 1, /* Packets are still delivered to the kernel */
  4.   driver2pf_ring_non_transparent = 2 /* Packets not delivered to the kernel */
  5. } direct2pf_ring;
复制代码

第一种最简单,这里仅分析第一种

  1.         //输出工作信息参数
  2.   printk("[PF_RING] Ring slots       %d\n", num_slots);
  3.   printk("[PF_RING] Slot version     %d\n",
  4.          RING_FLOWSLOT_VERSION);
  5.   printk("[PF_RING] Capture TX       %s\n",
  6.          enable_tx_capture ? "Yes [RX+TX]" : "No [RX only]");
  7.   printk("[PF_RING] Transparent Mode %d\n",
  8.          transparent_mode);
  9.   printk("[PF_RING] IP Defragment    %s\n",
  10.          enable_ip_defrag ? "Yes" : "No");
  11.   printk("[PF_RING] Initialized correctly\n");
复制代码


num_slots为槽位总数,系统采用数组来实现双向环形队列,它也就代表数组的最大元素。
版本信息:不用多说了。不过我的版本在2.6.18及以下都没有编译成功,后来使用2.6.30.9搞定之。
enable_tx_capture:是否启用发送时的数据捕获,对于大多数应用而言,都是在接收时处理。
enable_ip_defrag:为用户提供一个接口,是否在捕获最重组IP分片。

  1.         //创建/proc目录
  2.   ring_proc_init();
  3.   
  4.   //注册设备句柄
  5.   register_device_handler();

  6.   pfring_enabled = 1;                //工作标志
  7.   return 0;
  8. }
复制代码


register_device_handler注册了一个协议,用于数据包的获取:
  1. /* Protocol hook */
  2. static struct packet_type prot_hook;

  3. void register_device_handler(void) {
  4.         //只有在第一种模式下,才用这种方式接收数据
  5.   if(transparent_mode != standard_linux_path) return;

  6.   prot_hook.func = packet_rcv;
  7.   prot_hook.type = htons(ETH_P_ALL);
  8.   dev_add_pack(&prot_hook);
  9. }

  10. void register_device_handler(void) {
  11.   if(transparent_mode != standard_linux_path) return;

  12.   prot_hook.func = packet_rcv;
  13.   prot_hook.type = htons(ETH_P_ALL);
  14.   dev_add_pack(&prot_hook);
  15. }
复制代码


2、创建套接字
Linux的套按字的内核接口,使用了两个重要的数据结构:
struct socket和struct sock,这本来并没有什么,不过令人常常迷惑的是,前者常常被缩写为sock,即:
struct socket *sock;
这样,“sock”就容易造成混淆了。还好,后者常常被缩写为sk……
我这里写sock指前者,sk指后者,如果不小心写混了,请参考上下文区分 。

关于这两个结构的含义,使用等等,可以参考相关资料以获取详细信息,如《Linux情景分析》。我的个人网站www.skynet.org.cn上也分析了Linux socket的实现。可以参考。这里关于socket的进一步信息,就不详细分析了。

这里的创建套接字,内核已经在系统调用过程中,准备好了sock,主要就是分析sk,并为sk指定一系列的操作函数,如bind、mmap、poll等等。
如前所述,套接字的创建,是通过调用ring_create函数来完成的:
  1. static int ring_create(
  2. #if(LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24))
  3.                        struct net *net,
  4. #endif
  5.                        struct socket *sock, int protocol)
  6. {
  7.   struct sock *sk;
  8.   struct ring_opt *pfr;
  9.   int err;

  10. #if defined(RING_DEBUG)
  11.   printk("[PF_RING] ring_create()\n");
  12. #endif

  13.   /* 权限验证 ? */
  14.   if(!capable(CAP_NET_ADMIN))
  15.     return -EPERM;

  16.   //协议簇验证
  17.   if(sock->type != SOCK_RAW)
  18.     return -ESOCKTNOSUPPORT;

  19.   //协议验证
  20.   if(protocol != htons(ETH_P_ALL))
  21.     return -EPROTONOSUPPORT;

  22.   err = -ENOMEM;

  23.   // 分配sk
  24.   // options are.
  25. #if(LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,11))
  26.   sk = sk_alloc(PF_RING, GFP_KERNEL, 1, NULL);
  27. #else
  28. #if(LINUX_VERSION_CODE < KERNEL_VERSION(2,6,24))
  29.     // BD: API changed in 2.6.12, ref:
  30.     // [url]http://svn.clkao.org/svnweb/linux/revision/?rev=28201[/url]
  31.     sk = sk_alloc(PF_RING, GFP_ATOMIC, &ring_proto, 1);
  32. #else
  33.     sk = sk_alloc(net, PF_INET, GFP_KERNEL, &ring_proto);
  34. #endif
  35. #endif

  36.   //分配失败
  37.   if(sk == NULL)
  38.     goto out;
  39.   
  40.   //这里很重要,设定sock的ops,即对应用户态的bind、connect诸如此类操作的动作
  41.   sock->ops = &ring_ops;

  42.   //初始化sock结构(即sk)各成员,并设定与套接字socket(即sock)的关联
  43.   sock_init_data(sock, sk);
  44. #if(LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,11))
  45.   sk_set_owner(sk, THIS_MODULE);
  46. #endif

  47.   err = -ENOMEM;

  48. #define ring_sk_datatype(__sk) ((struct ring_opt *)__sk)
  49. #define ring_sk(__sk) ((__sk)->sk_protinfo)

  50. //作者喜欢用小写的宏
  51. //这里分配一个struct ring_opt结构,这个结构比较重要,其记录了ring的选项信息。
  52. 在sk中,使用sk_protinfo成员指向之,这样就建立了sock->sk->ring_opt的关联。可以通过套接字很容易获取Ring的信息。
  53.   ring_sk(sk) = ring_sk_datatype(kmalloc(sizeof(*pfr), GFP_KERNEL));
  54.   //分配失败
  55.   if(!(pfr = ring_sk(sk))) {
  56.     sk_free(sk);
  57.     goto out;
  58.   }

  59.   //初始化各成员
  60.   memset(pfr, 0, sizeof(*pfr));
  61. //激活标志
  62.   pfr->ring_active = 0;        /* We activate as soon as somebody waits for packets */
  63.   //通道ID
  64.   pfr->channel_id = RING_ANY_CHANNEL;
  65.   //RING的每个槽位的桶的大小,其用来存储捕获的数据帧,这个值,用户态也可以使用setsocketopt来调整
  66.   pfr->bucket_len = DEFAULT_BUCKET_LEN;
  67. //过滤器hash桶
  68.   pfr->handle_hash_rule = handle_filtering_hash_bucket;
  69.   //初始化等待队列
  70.   init_waitqueue_head(&pfr->ring_slots_waitqueue);
  71.   //初始化RING的锁
  72.   rwlock_init(&pfr->ring_index_lock);
  73.   rwlock_init(&pfr->ring_rules_lock);
  74.   //初始化使用计数器
  75.   atomic_set(&pfr->num_ring_users, 0);
  76.   INIT_LIST_HEAD(&pfr->rules);
  77.   //设定协议簇
  78.   sk->sk_family = PF_RING;
  79. //设定sk的destuct函数
  80.   sk->sk_destruct = ring_sock_destruct;

  81.   //sk入队
  82.   ring_insert(sk);

  83. #if defined(RING_DEBUG)
  84.   printk("[PF_RING] ring_create() - created\n");
  85. #endif

  86.   return(0);
  87. out:
  88.   return err;
复制代码


在模块初始化中,初始化过四个链表。其中一个是ring_table,ring_insert将刚刚创建的套接字插入其中。其封装引进了一个struct ring_element 结构:
  1. /*
  2. * ring_insert()
  3. *
  4. * store the sk in a new element and add it
  5. * to the head of the list.
  6. */
  7. static inline void ring_insert(struct sock *sk)
  8. {
  9.   struct ring_element *next;
  10.   struct ring_opt *pfr;

  11. #if defined(RING_DEBUG)
  12.   printk("[PF_RING] ring_insert()\n");
  13. #endif

  14. //分配element
  15.   next = kmalloc(sizeof(struct ring_element), GFP_ATOMIC);
  16.   if(next != NULL) {
  17.     //记录sk
  18.     next->sk = sk;
  19.     write_lock_bh(&ring_mgmt_lock);
  20.     //入队
  21.     list_add(&next->list, &ring_table);
  22.     write_unlock_bh(&ring_mgmt_lock);
  23.   } else {
  24.     if(net_ratelimit())
  25.       printk("[PF_RING] net_ratelimit() failure\n");
  26.   }

  27.   //累计使用计数器
  28.   ring_table_size++;
  29.   //ring_proc_add(ring_sk(sk));
  30.   //记录进程PID
  31.   pfr = (struct ring_opt *)ring_sk(sk);
  32.   pfr->ring_pid = current->pid;
  33. }
复制代码


3 、分配队列空间
用户态在创建了套接字后,接下来就调用bind函数,绑定套接字,而PF_RING实际做的就是为RING分配相应的空间。也就是说,一个套接字,都有一个与之对应的RING。这样,有多个进程同时使用PF_RING,也没有问题:
  1.                 sa.sa_family   = PF_RING;
  2.                 snprintf(sa.sa_data, sizeof(sa.sa_data), "%s", device_name);
  3.                 rc = bind(ring->fd, (struct sockaddr *)&sa, sizeof(sa));
复制代码


因为前一步创建套接字时,为sk指定了其ops:
  1. static struct proto_ops ring_ops = {
  2.   .family = PF_RING,
  3.   .owner = THIS_MODULE,

  4.   /* Operations that make no sense on ring sockets. */
  5.   .connect = sock_no_connect,
  6.   .socketpair = sock_no_socketpair,
  7.   .accept = sock_no_accept,
  8.   .getname = sock_no_getname,
  9.   .listen = sock_no_listen,
  10.   .shutdown = sock_no_shutdown,
  11.   .sendpage = sock_no_sendpage,
  12.   .sendmsg = sock_no_sendmsg,

  13.   /* Now the operations that really occur. */
  14.   .release = ring_release,
  15.   .bind = ring_bind,
  16.   .mmap = ring_mmap,
  17.   .poll = ring_poll,
  18.   .setsockopt = ring_setsockopt,
  19.   .getsockopt = ring_getsockopt,
  20.   .ioctl = ring_ioctl,
  21.   .recvmsg = ring_recvmsg,
  22. };
复制代码


这样,当bing系统调用触发时,ring_bind函数将被调用:

  1. * Bind to a device */
  2. static int ring_bind(struct socket *sock, struct sockaddr *sa, int addr_len)
  3. {
  4.   struct sock *sk = sock->sk;
  5.   struct net_device *dev = NULL;

  6. #if defined(RING_DEBUG)
  7.   printk("[PF_RING] ring_bind() called\n");
  8. #endif

  9.   /*
  10.    *      Check legality
  11.    */
  12.   if(addr_len != sizeof(struct sockaddr))
  13.     return -EINVAL;
  14.   if(sa->sa_family != PF_RING)
  15.     return -EINVAL;
  16.   if(sa->sa_data == NULL)
  17.     return -EINVAL;

  18.   /* Safety check: add trailing zero if missing */
  19.   sa->sa_data[sizeof(sa->sa_data) - 1] = '\0';

  20. #if defined(RING_DEBUG)
  21.   printk("[PF_RING] searching device %s\n", sa->sa_data);
  22. #endif

  23.   if((dev = __dev_get_by_name(
  24. #if(LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24))
  25.                                &init_net,
  26. #endif
  27.                                sa->sa_data)) == NULL) {
  28. #if defined(RING_DEBUG)
  29.     printk("[PF_RING] search failed\n");
  30. #endif
  31.     return(-EINVAL);
  32.   } else
  33.     return(packet_ring_bind(sk, dev));
  34. }
复制代码


在做了一些必要的语法检查后,函数转向packet_ring_bind:
  1. /*
  2. * We create a ring for this socket and bind it to the specified device
  3. */
  4. static int packet_ring_bind(struct sock *sk, struct net_device *dev)
  5. {
  6.   u_int the_slot_len;
  7.   u_int32_t tot_mem;
  8.   struct ring_opt *pfr = ring_sk(sk);
  9.   // struct page *page, *page_end;

  10.   if(!dev)
  11.     return(-1);

  12. #if defined(RING_DEBUG)
  13.   printk("[PF_RING] packet_ring_bind(%s) called\n", dev->name);
  14. #endif

  15.   /* **********************************************

  16.    * *************************************
  17.    * *                                   *
  18.    * *        FlowSlotInfo               *
  19.    * *                                   *
  20.    * ************************************* <-+
  21.    * *        FlowSlot                   *   |
  22.    * *************************************   |
  23.    * *        FlowSlot                   *   |
  24.    * *************************************   +- num_slots
  25.    * *        FlowSlot                   *   |
  26.    * *************************************   |
  27.    * *        FlowSlot                   *   |
  28.    * ************************************* <-+
  29.    *
  30.    * ********************************************** */

  31.         //计算每一个槽位所需的内存空间
  32.   the_slot_len = sizeof(u_char)        /* flowSlot.slot_state */
  33. #ifdef RING_MAGIC
  34.     + sizeof(u_char)
  35. #endif
  36.     + sizeof(struct pfring_pkthdr)
  37.     + pfr->bucket_len /* flowSlot.bucket */ ;
  38. /*    
  39.         对于槽位空间的计算,有意思的是
  40. typedef struct flowSlot {
  41. #ifdef RING_MAGIC
  42.   u_char     magic;      /* It must alwasy be zero */
  43. #endif
  44.   u_char     slot_state; /* 0=empty, 1=full   */
  45.   u_char     bucket;     /* bucket[bucketLen] */
  46. } FlowSlot;
  47. 对照结构定义和上面的计算公式:
  48. 1、作者好像把magic和slog_state的顺序给搞反了,不过还好,它们都是u_char,对结果不影响
  49. 2、bucket,桶的大小,这个桶就是拿来装要捕获的数据包了,虽然它在结构中定义是一个成员,事实上,
  50. 它由两个部份组成,一个是包的首部信息,这个结构的定义同libpcap很接近。另一个才是包的空间。
  51. */

  52.         //总共的环形队列内存所需空间,包含一个队列控制信息FlowSlotInfo和若干个(由变量num_slots决定)槽位空间
  53.   tot_mem = sizeof(FlowSlotInfo) + num_slots * the_slot_len;
  54.   
  55.   //确保按整数页分配,mmap也要求这样
  56.   if(tot_mem % PAGE_SIZE)
  57.     tot_mem += PAGE_SIZE - (tot_mem % PAGE_SIZE);

  58.         //分配内存空间
  59.   pfr->ring_memory = rvmalloc(tot_mem);

  60.   if(pfr->ring_memory != NULL) {
  61.     printk("[PF_RING] successfully allocated %lu bytes at 0x%08lx\n",
  62.            (unsigned long)tot_mem, (unsigned long)pfr->ring_memory);
  63.   } else {
  64.     printk("[PF_RING] ERROR: not enough memory for ring\n");
  65.     return(-1);
  66.   }

  67.   // memset(pfr->ring_memory, 0, tot_mem); // rvmalloc does the memset already
  68.   //初始化各成员
  69.         //内存指定,因为分配的内存开始部份是sizeof(FlowSlotInfo),所以可以做这样的强制转换,很容易互相取值
  70.   pfr->slots_info = (FlowSlotInfo *) pfr->ring_memory;
  71.   //跳过控制信息,指向槽位指针.事实上,它就是一个一维数组了,可以计算出合适的索引值,取到数组(RING)中的任意槽位值
  72.   pfr->ring_slots = (char *)(pfr->ring_memory + sizeof(FlowSlotInfo));

  73.   //版本信息
  74.   pfr->slots_info->version = RING_FLOWSLOT_VERSION;
  75.   //登记单个槽的大小
  76.   pfr->slots_info->slot_len = the_slot_len;
  77.   //登记bucket大小,从前面特别注释的bucket的分配看,bucket_len这个大小并不代表bucket成员的实际大小——它不包含struct pfring_pkthdr
  78.   pfr->slots_info->data_len = pfr->bucket_len;
  79.   //登记实际分配到的槽位数量,这里不用num_slots,难道是怕rvmalloc偷吃?
  80.   pfr->slots_info->tot_slots =
  81.     (tot_mem - sizeof(FlowSlotInfo)) / the_slot_len;
  82.   //登记实际分配的内存总数  
  83.   pfr->slots_info->tot_mem = tot_mem;
  84.   //采样速率??
  85.   pfr->slots_info->sample_rate = 1;

  86.   printk("[PF_RING] allocated %d slots [slot_len=%d][tot_mem=%u]\n",
  87.          pfr->slots_info->tot_slots, pfr->slots_info->slot_len,
  88.          pfr->slots_info->tot_mem);

  89. #ifdef RING_MAGIC
  90.   {
  91.     int i;

  92.     for (i = 0; i < pfr->slots_info->tot_slots; i++) {
  93.       unsigned long idx = i * pfr->slots_info->slot_len;
  94.       FlowSlot *slot = (FlowSlot *) & pfr->ring_slots[idx];
  95.       slot->magic = RING_MAGIC_VALUE;
  96.       slot->slot_state = 0;
  97.     }
  98.   }
  99. #endif
  100.   //这些控制变量可以在环的入队操作中看到它们的作用
  101.   pfr->sample_rate = 1;        /* No sampling */
  102.   pfr->insert_page_id = 1, pfr->insert_slot_id = 0;
  103.   pfr->rules_default_accept_policy = 1, pfr->num_filtering_rules = 0;
  104.   ring_proc_add(ring_sk(sk), dev);

  105.   //记录与之相应的设备信息,例如,如果在eth0上打开了5 个PF_RING, bind
  106.   //被调用5次,分配了5个环形队列空间。eth0上随之分配5个elem,它们指向与
  107.   //之对应的ring,然后根据设备索引号民全部加入至了device_ring_list
  108.   //当有数据报文从指定接口进入时,可以很容易地在device_ring_list中找到相应的设备
  109.   //然后再遍历链表,再找到与之相应的ring
  110.   if(dev->ifindex < MAX_NUM_DEVICES) {
  111.     device_ring_list_element *elem;

  112.     /* printk("[PF_RING] Adding ring to device index %d\n", dev->ifindex); */

  113.     elem = kmalloc(sizeof(device_ring_list_element), GFP_ATOMIC);
  114.     if(elem != NULL) {
  115.       elem->the_ring = pfr;
  116.       INIT_LIST_HEAD(&elem->list);
  117.       write_lock(&ring_list_lock);
  118.       list_add(&elem->list, &device_ring_list[dev->ifindex]);
  119.       write_unlock(&ring_list_lock);
  120.       /* printk("[PF_RING] Added ring to device index %d\n", dev->ifindex); */
  121.     }
  122.   }

  123.   /*
  124.     IMPORTANT
  125.     Leave this statement here as last one. In fact when
  126.     the ring_netdev != NULL the socket is ready to be used.
  127.   */
  128.   pfr->ring_netdev = dev;

  129.   return(0);
  130. }
复制代码

这个函数中,最重要的三点:
1、整个空间的详细构成,作者画了一个简单的草图,清晰明了。
2、如果取得某个槽位。
3、device_ring_list链表的使用。

一些作者有详细注释的地方,我就不再重重了。

这一步进行完了后,就有一块内存了(系统将其看成一个数组),用来存储捕获的数据帧。接下来要做的事情。就是把它映射到用户态。

4、mmap操作
用户态的接下来调用:
  1.                         ring->buffer = (char *)mmap(NULL, PAGE_SIZE, PROT_READ|PROT_WRITE,
  2.                                 MAP_SHARED, ring->fd, 0);
复制代码

进行内存映射。
同样地,内核调用相应的ring_mmap进行处理。
Ring选项结构通过ring_sk宏与sk 建立关联
  1. struct ring_opt *pfr = ring_sk(sk);
复制代码

pfr->ring_memory 即为分配的环形队列空间。所以,要mmap操作,实际上就是调用remap_pfn_range函数把pfr->ring_memory 映射到用户空间即可。这个函数的原型为:
  1. /**
  2. * remap_pfn_range - remap kernel memory to userspace
  3. * @vma: user vma to map to
  4. * @addr: target user address to start at
  5. * @pfn: physical address of kernel memory
  6. * @size: size of map area
  7. * @prot: page protection flags for this mapping
  8. *
  9. *  Note: this is only safe if the mm semaphore is held when called.
  10. */
  11. int remap_pfn_range(struct vm_area_struct *vma, unsigned long addr,
  12.                     unsigned long pfn, unsigned long size, pgprot_t prot)
  13. {
复制代码

关于remap_pfn_range函数的进一步说明,可以参考LDD3,上面有详细说明和现成的例子。

  1. static int ring_mmap(struct file *file,
  2.                      struct socket *sock, struct vm_area_struct *vma)
  3. {
  4.   struct sock *sk = sock->sk;
  5.   struct ring_opt *pfr = ring_sk(sk);                //取得pfr指针,也就是相应取得环形队列的内存空间地址指针
  6.   int rc;
  7.   unsigned long size = (unsigned long)(vma->vm_end - vma->vm_start);

  8.   if(size % PAGE_SIZE) {
  9. #if defined(RING_DEBUG)
  10.     printk("[PF_RING] ring_mmap() failed: "
  11.            "len is not multiple of PAGE_SIZE\n");
  12. #endif
  13.     return(-EINVAL);
  14.   }
  15. #if defined(RING_DEBUG)
  16.   printk("[PF_RING] ring_mmap() called, size: %ld bytes\n", size);
  17. #endif

  18.   if((pfr->dna_device == NULL) && (pfr->ring_memory == NULL)) {
  19. #if defined(RING_DEBUG)
  20.     printk("[PF_RING] ring_mmap() failed: "
  21.            "mapping area to an unbound socket\n");
  22. #endif
  23.     return -EINVAL;
  24.   }

  25.   //dns设备为空,即没有使用dns技术
  26.   if(pfr->dna_device == NULL) {
  27.     /* if userspace tries to mmap beyond end of our buffer, fail */
  28.     //映射空间超限
  29.     if(size > pfr->slots_info->tot_mem) {
  30. #if defined(RING_DEBUG)
  31.       printk("[PF_RING] ring_mmap() failed: "
  32.              "area too large [%ld > %d]\n",
  33.              size, pfr->slots_info->tot_mem);
  34. #endif
  35.       return(-EINVAL);
  36.     }
  37. #if defined(RING_DEBUG)
  38.     printk("[PF_RING] mmap [slot_len=%d]"
  39.            "[tot_slots=%d] for ring on device %s\n",
  40.            pfr->slots_info->slot_len, pfr->slots_info->tot_slots,
  41.            pfr->ring_netdev->name);
  42. #endif
  43.         //进行内存映射
  44.     if((rc =
  45.          do_memory_mmap(vma, size, pfr->ring_memory, VM_LOCKED,
  46.                         0)) < 0)
  47.       return(rc);
  48.   } else {
  49.     /* DNA Device */
  50.     if(pfr->dna_device == NULL)
  51.       return(-EAGAIN);

  52.     switch (pfr->mmap_count) {
  53.     case 0:
  54.       if((rc = do_memory_mmap(vma, size,
  55.                                (void *)pfr->dna_device->
  56.                                packet_memory, VM_LOCKED,
  57.                                1)) < 0)
  58.         return(rc);
  59.       break;

  60.     case 1:
  61.       if((rc = do_memory_mmap(vma, size,
  62.                                (void *)pfr->dna_device->
  63.                                descr_packet_memory, VM_LOCKED,
  64.                                1)) < 0)
  65.         return(rc);
  66.       break;

  67.     case 2:
  68.       if((rc = do_memory_mmap(vma, size,
  69.                                (void *)pfr->dna_device->
  70.                                phys_card_memory,
  71.                                (VM_RESERVED | VM_IO), 2)) < 0)
  72.         return(rc);
  73.       break;

  74.     default:
  75.       return(-EAGAIN);
  76.     }

  77.     pfr->mmap_count++;
  78.   }

  79. #if defined(RING_DEBUG)
  80.   printk("[PF_RING] ring_mmap succeeded\n");
  81. #endif

  82.   return 0;
  83. }
复制代码


实际上的内存映射工作,是由do_memory_mmap来完成的,这个函数实际上基本就是remap_pfn_range的包裹函数。
不过因为系统支持dna等技术,相应的mode参数有些变化,这里只分析了最基本的方法:mode == 0

  1. static int do_memory_mmap(struct vm_area_struct *vma,
  2.                           unsigned long size, char *ptr, u_int flags, int mode)
  3. {
  4.   unsigned long start;
  5.   unsigned long page;

  6.   /* we do not want to have this area swapped out, lock it */
  7.   vma->vm_flags |= flags;
  8.   start = vma->vm_start;

  9.   while (size > 0) {
  10.     int rc;

  11.     if(mode == 0) {
  12. #if(LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,11))
  13.           //根据地址,计算要映射的页帧
  14.       page = vmalloc_to_pfn(ptr);
  15.       //进行内存映射
  16.       rc = remap_pfn_range(vma, start, page, PAGE_SIZE,
  17.                            PAGE_SHARED);
  18. #else
  19.       page = vmalloc_to_page(ptr);
  20.       page = kvirt_to_pa(ptr);
  21.       rc = remap_page_range(vma, start, page, PAGE_SIZE,
  22.                             PAGE_SHARED);
  23. #endif
  24.     } else if(mode == 1) {
  25.       rc = remap_pfn_range(vma, start,
  26.                            __pa(ptr) >> PAGE_SHIFT,
  27.                            PAGE_SIZE, PAGE_SHARED);
  28.     } else {
  29.       rc = remap_pfn_range(vma, start,
  30.                            ((unsigned long)ptr) >> PAGE_SHIFT,
  31.                            PAGE_SIZE, PAGE_SHARED);
  32.     }

  33.     if(rc) {
  34. #if defined(RING_DEBUG)
  35.       printk("[PF_RING] remap_pfn_range() failed\n");
  36. #endif
  37.       return(-EAGAIN);
  38.     }

  39.     start += PAGE_SIZE;
  40.     ptr += PAGE_SIZE;
  41.     if(size > PAGE_SIZE) {
  42.       size -= PAGE_SIZE;
  43.     } else {
  44.       size = 0;
  45.     }
  46.   }

  47.   return(0);
  48. }
复制代码


嗯,跳过了太多的细节,不过其mmap最核心的东东已经呈现出来。
如果要共享内核与用户空间内存,这倒是个现成的可借鉴的例子。

5、数据包的入队操作

做到这一步,准备工作基本上就完成了。因为PF_RING在初始化中,注册了prot_hook。其func指针指向packet_rcv函数:
当数据报文进入Linux网络协议栈队列时,netif_receive_skb会遍历这些注册的Hook:
  1. int netif_receive_skb(struct sk_buff *skb)
  2. {
  3.         list_for_each_entry_rcu(ptype, &ptype_all, list) {
  4.                 if (ptype->dev == null_or_orig || ptype->dev == skb->dev ||
  5.                     ptype->dev == orig_dev) {
  6.                         if (pt_prev)
  7.                                 ret = deliver_skb(skb, pt_prev, orig_dev);
  8.                         pt_prev = ptype;
  9.                 }
  10.         }
  11. }
复制代码


相应的Hook函数得到调用:

  1. static inline int deliver_skb(struct sk_buff *skb,
  2.                               struct packet_type *pt_prev,
  3.                               struct net_device *orig_dev)
  4. {
  5.         atomic_inc(&skb->users);        //注意,这里引用计数器被增加了
  6.         return pt_prev->func(skb, skb->dev, pt_prev, orig_dev);
  7. }
复制代码


packet_rcv随之执行环形队列的入队操作:
  1. static int packet_rcv(struct sk_buff *skb, struct net_device *dev,
  2.                       struct packet_type *pt, struct net_device *orig_dev)
  3. {
  4.   int rc;

  5.   //忽略本地环回报文
  6.   if(skb->pkt_type != PACKET_LOOPBACK) {
  7.           //进一步转向,最后一个参数直接使用-1,从上下文来看,写为RING_ANY_CHANNEL(其实也是-1)似乎可读性更强,
  8.           //这里表示,如果从packet_rcv进入队列,由通道ID是“未指定的”,由skb_ring_handler来处理
  9.     rc = skb_ring_handler(skb,
  10.                           (skb->pkt_type == PACKET_OUTGOING) ? 0 : 1,
  11.                           1, -1 /* unknown channel */);

  12.   } else
  13.     rc = 0;

  14.   kfree_skb(skb);                                //所以,这里要做相应的减少
  15.   return(rc);
  16. }
复制代码



static int skb_ring_handler(struct sk_buff *skb,                                //要捕获的数据包
                            u_char recv_packet,                                                                //数据流方向,>0表示是进入(接收)方向
                            u_char real_skb /* 1=real skb, 0=faked skb */ ,
                            short channel_id)                                                                //通道ID
{
  struct sock *skElement;
  int rc = 0, is_ip_pkt;
  struct list_head *ptr;
  struct pfring_pkthdr hdr;
  int displ;
  struct sk_buff *skk = NULL;
  struct sk_buff *orig_skb = skb;

#ifdef PROFILING
  uint64_t rdt = _rdtsc(), rdt1, rdt2;
#endif

  //skb合法检查,包括数据流的方向
  if((!skb)                /* Invalid skb */
      ||((!enable_tx_capture) && (!recv_packet))) {
    /*
      An outgoing packet is about to be sent out
      but we decided not to handle transmitted
      packets.
    */
    return(0);
  }
#if defined(RING_DEBUG)
  if(1) {
    struct timeval tv;

    skb_get_timestamp(skb, &tv);
    printk
      ("[PF_RING] skb_ring_handler() [skb=%p][%u.%u][len=%d][dev=%s][csum=%u]\n",
       skb, (unsigned int)tv.tv_sec, (unsigned int)tv.tv_usec,
       skb->len,
       skb->dev->name == NULL ? "<NULL>" : skb->dev->name,
       skb->csum);
  }
#endif

        //如果通道ID未指定,根据进入的报文设备索引,设定之
#if(LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,21))
  if(channel_id == RING_ANY_CHANNEL /* Unknown channel */ )
    channel_id = skb->iif;        /* Might have been set by the driver */
#endif

#if defined (RING_DEBUG)
  /* printk("[PF_RING] channel_id=%d\n", channel_id); */
#endif

#ifdef PROFILING
  rdt1 = _rdtsc();
#endif

  if(recv_packet) {
    /* Hack for identifying a packet received by the e1000 */
    if(real_skb)
      displ = SKB_DISPLACEMENT;
    else
      displ = 0;        /* Received by the e1000 wrapper */
  } else
    displ = 0;
        
  //解析数据报文,并判断是否为IP报文
  is_ip_pkt = parse_pkt(skb, displ, &hdr);

  //分片处理,是一个可选的功能项,事实上,对大多数包捕获工具而言,它们好像都不使用底层库来完成这一功能
  /* (de)Fragmentation <fusco@ntop.org> */
  if(enable_ip_defrag
      && real_skb && is_ip_pkt && recv_packet && (ring_table_size > 0)) {
    } else {
#if defined (RING_DEBUG)
        printk("[PF_RING] Do not seems to be a fragmented ip_pkt[iphdr=%p]\n",
               iphdr);
#endif
      }
    }
  }

  //按惯例,在报文的捕获首部信息中记录捕获的时间戳
  /* BD - API changed for time keeping */
#if(LINUX_VERSION_CODE < KERNEL_VERSION(2,6,14))
  if(skb->stamp.tv_sec == 0)
    do_gettimeofday(&skb->stamp);
  hdr.ts.tv_sec = skb->stamp.tv_sec, hdr.ts.tv_usec = skb->stamp.tv_usec;
#elif(LINUX_VERSION_CODE < KERNEL_VERSION(2,6,22))
  if(skb->tstamp.off_sec == 0)
    __net_timestamp(skb);
  hdr.ts.tv_sec = skb->tstamp.off_sec, hdr.ts.tv_usec =
    skb->tstamp.off_usec;
#else /* 2.6.22 and above */
  if(skb->tstamp.tv64 == 0)
    __net_timestamp(skb);
  hdr.ts = ktime_to_timeval(skb->tstamp);
#endif

  //除了时间,还有长度,熟悉libpcap的话,这些操作应该很眼熟
  hdr.len = hdr.caplen = skb->len + displ;

  /* Avoid the ring to be manipulated while playing with it */
  read_lock_bh(&ring_mgmt_lock);

  /* 前面在创建sk时,已经看过ring_insert的入队操作了,现在要检查它的成员
  * 它们的关系是,通过ring_table的成员,获取到element,它里面封装了sk,
  *通过ring_sk宏,就可以得到ring_opt指针
   */
  list_for_each(ptr, &ring_table) {
    struct ring_opt *pfr;
    struct ring_element *entry;

    entry = list_entry(ptr, struct ring_element, list);

    skElement = entry->sk;
    pfr = ring_sk(skElement);
        
        //看来要加入社团,条件还是满多的,pfr不能为空,未指定集群cluster_id,槽位不能为空,方向要正确,绑定的网络设备
        //得对上号
        //另一种可能就是对bonding的支持,如果设备是从属设备,则应校验其主设备
    if((pfr != NULL)
        && (pfr->cluster_id == 0 /* No cluster */ )
        && (pfr->ring_slots != NULL)
        && is_valid_skb_direction(pfr->direction, recv_packet)
        && ((pfr->ring_netdev == skb->dev)
            || ((skb->dev->flags & IFF_SLAVE)
                && (pfr->ring_netdev == skb->dev->master)))) {
      /* We've found the ring where the packet can be stored */
      /* 从新计算捕获帧长度,是因为可能因为巨型帧的出现——超过了桶能容纳的长度 */
      int old_caplen = hdr.caplen;        /* Keep old lenght */
      hdr.caplen = min(hdr.caplen, pfr->bucket_len);
      /* 入队操作 */
      add_skb_to_ring(skb, pfr, &hdr, is_ip_pkt, displ, channel_id);
      hdr.caplen = old_caplen;
      rc = 1;        /* Ring found: we've done our job */
    }
  }

  /* [2] Check socket clusters */
  list_for_each(ptr, &ring_cluster_list) {
    ring_cluster_element *cluster_ptr;
    struct ring_opt *pfr;

    cluster_ptr = list_entry(ptr, ring_cluster_element, list);

    if(cluster_ptr->cluster.num_cluster_elements > 0) {
      u_int skb_hash = hash_pkt_cluster(cluster_ptr, &hdr);

      skElement = cluster_ptr->cluster.sk[skb_hash];

      if(skElement != NULL) {
        pfr = ring_sk(skElement);

        if((pfr != NULL)
            && (pfr->ring_slots != NULL)
            && ((pfr->ring_netdev == skb->dev)
                || ((skb->dev->flags & IFF_SLAVE)
                    && (pfr->ring_netdev ==
                        skb->dev->master)))
            && is_valid_skb_direction(pfr->direction, recv_packet)
            ) {
          /* We've found the ring where the packet can be stored */
          add_skb_to_ring(skb, pfr, &hdr,
                          is_ip_pkt, displ,
                          channel_id);
          rc = 1;        /* Ring found: we've done our job */
        }
      }
    }
  }

  read_unlock_bh(&ring_mgmt_lock);

#ifdef PROFILING
  rdt1 = _rdtsc() - rdt1;
#endif

#ifdef PROFILING
  rdt2 = _rdtsc();
#endif

  /* Fragment handling */
  if(skk != NULL)
    kfree_skb(skk);

  if(rc == 1) {
    if(transparent_mode != driver2pf_ring_non_transparent) {
      rc = 0;
    } else {
      if(recv_packet && real_skb) {
#if defined(RING_DEBUG)
        printk("[PF_RING] kfree_skb()\n");
#endif

        kfree_skb(orig_skb);
      }
    }
  }
#ifdef PROFILING
  rdt2 = _rdtsc() - rdt2;
  rdt = _rdtsc() - rdt;

#if defined(RING_DEBUG)
  printk
    ("[PF_RING] # cycles: %d [lock costed %d %d%%][free costed %d %d%%]\n",
     (int)rdt, rdt - rdt1,
     (int)((float)((rdt - rdt1) * 100) / (float)rdt), rdt2,
     (int)((float)(rdt2 * 100) / (float)rdt));
#endif
#endif

  //printk("[PF_RING] Returned %d\n", rc);
  return(rc);                /*  0 = packet not handled */
}

上面跳过了对cluster(集群)的分析,PF_RING允许同时对多个接口捕获报文,而并不是一个。这就是集群。看一下它用户态的注释就一目了然了:
  1.                         /* Syntax
  2.                         ethX@1,5       channel 1 and 5
  3.                         ethX@1-5       channel 1,2...5
  4.                         ethX@1-3,5-7   channel 1,2,3,5,6,7
  5.                         */
复制代码

进一步的入队操作,是通过add_skb_to_ring来完成的:

  1. static int add_skb_to_ring(struct sk_buff *skb,
  2.                            struct ring_opt *pfr,
  3.                            struct pfring_pkthdr *hdr,
  4.                            int is_ip_pkt, int displ, short channel_id)
  5. {
  6.       //add_skb_to_ring函数比较复杂,因为它要处理过滤器方面的问题。
  7.       //关于PF_RING的过滤器,可以参考[url]http://luca.ntop.org/Blooms.pdf[/url]
  8.       //获取更多内容。这里不做详细讨论了。或者留到下回分解吧。
  9.       
  10.       //最终入队操作,是通过调用dd_pkt_to_ring来实现的。
  11.       add_pkt_to_ring(skb, pfr, hdr, displ, channel_id,
  12.                       offset, mem);        
  13. }
复制代码

  1. static void add_pkt_to_ring(struct sk_buff *skb,
  2.                             struct ring_opt *pfr,
  3.                             struct pfring_pkthdr *hdr,
  4.                             int displ, short channel_id,
  5.                             int offset, void *plugin_mem)
  6. {
  7.   char *ring_bucket;
  8.   int idx;
  9.   FlowSlot *theSlot;
  10.   int32_t the_bit = 1 << channel_id;

  11. #if defined(RING_DEBUG)
  12.   printk("[PF_RING] --> add_pkt_to_ring(len=%d) [pfr->channel_id=%d][channel_id=%d]\n",
  13.          hdr->len, pfr->channel_id, channel_id);
  14. #endif

  15.   //检查激活标志
  16.   if(!pfr->ring_active)
  17.     return;

  18.   if((pfr->channel_id != RING_ANY_CHANNEL)
  19.       && (channel_id != RING_ANY_CHANNEL)
  20.       && ((pfr->channel_id & the_bit) != the_bit))
  21.     return; /* Wrong channel */

  22.   //写锁
  23.   write_lock_bh(&pfr->ring_index_lock);
  24.   //获取前一次插入的位置索引
  25.   idx = pfr->slots_info->insert_idx;
  26.   //调用get_insert_slot获取当前要捕获数据报文的合适的槽位
  27.   //这里idx++后,指向了下一次插入的位置索引
  28.   idx++, theSlot = get_insert_slot(pfr);
  29.   //累计计数器
  30.   pfr->slots_info->tot_pkts++;

  31.   //没位子了,累计丢包计数器,返回之
  32.   if((theSlot == NULL) || (theSlot->slot_state != 0)) {
  33.     /* No room left */
  34.     pfr->slots_info->tot_lost++;
  35.     write_unlock_bh(&pfr->ring_index_lock);
  36.     return;
  37.   }

  38.   //获取当前槽位的桶
  39.   ring_bucket = &theSlot->bucket;

  40.   //支持插件??在最开始处记录插件信息??
  41.   if((plugin_mem != NULL) && (offset > 0))
  42.     memcpy(&ring_bucket[sizeof(struct pfring_pkthdr)], plugin_mem, offset);  

  43.   if(skb != NULL) {
  44.           //重新计算捕获帧长度
  45.     hdr->caplen = min(pfr->bucket_len - offset, hdr->caplen);

  46.     if(hdr->caplen > 0) {
  47. #if defined(RING_DEBUG)
  48.       printk("[PF_RING] --> [caplen=%d][len=%d][displ=%d][parsed_header_len=%d][bucket_len=%d][sizeof=%d]\n",
  49.          hdr->caplen, hdr->len, displ,
  50.              hdr->parsed_header_len, pfr->bucket_len,
  51.              sizeof(struct pfring_pkthdr));
  52. #endif
  53.       //拷贝捕获的数据报文,前面空了两个栏位:一个是pkthdr首部,一个是插件offset长度
  54.       //这里经过了一次数据拷贝,对于完美主义者,这并不是一个好的方法。但是PF_RING定位于一个
  55.       //通用的接口库,似乎只有这么做了。否则,追求“零拷贝”,为了避免这一次拷贝,只有逐个修改网卡驱动了。
  56.       skb_copy_bits(skb, -displ,
  57.                     &ring_bucket[sizeof(struct pfring_pkthdr) + offset], hdr->caplen);
  58.     } else {
  59.       if(hdr->parsed_header_len >= pfr->bucket_len) {
  60.         static u_char print_once = 0;

  61.         if(!print_once) {
  62.           printk("[PF_RING] WARNING: the bucket len is [%d] shorter than the plugin parsed header [%d]\n",
  63.              pfr->bucket_len, hdr->parsed_header_len);
  64.           print_once = 1;
  65.         }
  66.       }
  67.     }
  68.   }

  69.   //记录首部
  70.   memcpy(ring_bucket, hdr, sizeof(struct pfring_pkthdr)); /* Copy extended packet header */

  71.   //前面idx已经自加过了,判断是否队列已满,若满,归零,否则更新插入索引
  72.   if(idx == pfr->slots_info->tot_slots)
  73.     pfr->slots_info->insert_idx = 0;
  74.   else
  75.     pfr->slots_info->insert_idx = idx;

  76. #if defined(RING_DEBUG)
  77.   printk("[PF_RING] ==> insert_idx=%d\n", pfr->slots_info->insert_idx);
  78. #endif

  79.   //累计插入计数器
  80.   pfr->slots_info->tot_insert++;
  81.   //槽位就绪标记,用户空间可以来取了
  82.   theSlot->slot_state = 1;
  83.   write_unlock_bh(&pfr->ring_index_lock);

  84.   //有的时候会出现,用户空间取不到的情况,如队列为空。这样,用户空间调用poll等待数据。这里做相应的唤醒处理
  85.   /* wakeup in case of poll() */
  86.   if(waitqueue_active(&pfr->ring_slots_waitqueue))
  87.     wake_up_interruptible(&pfr->ring_slots_waitqueue);
  88. }
复制代码


槽位的计算:

  1. 在ring_bind函数中,分配空间后,使用ring_slots做为槽位指针。事实上,这里要计算槽位,就是通过索引号 * 槽位长度来得到:
  2. static inline FlowSlot *get_insert_slot(struct ring_opt *pfr)
  3. {
  4.   if(pfr->ring_slots != NULL) {
  5.     FlowSlot *slot =
  6.       (FlowSlot *) & (pfr->
  7.                       ring_slots[pfr->slots_info->insert_idx *
  8.                                  pfr->slots_info->slot_len]);
  9. #if defined(RING_DEBUG)
  10.     printk
  11.       ("[PF_RING] get_insert_slot(%d): returned slot [slot_state=%d]\n",
  12.        pfr->slots_info->insert_idx, slot->slot_state);
  13. #endif
  14.     return(slot);
  15.   } else {
  16. #if defined(RING_DEBUG)
  17.     printk("[PF_RING] get_insert_slot(%d): NULL slot\n",
  18.            pfr->slots_info->insert_idx);
  19. #endif
  20.     return(NULL);
  21.   }
  22. }

阅读更多
个人分类: 网络
想对作者说点什么? 我来说一句

<em>PF_RING</em>中文用户指南

2018年05月07日 0B 下载

<em>PF_RING</em> 5.6.x破解过程

2018年05月09日 0B 下载

没有更多推荐了,返回首页

加入CSDN,享受更精准的内容推荐,与500万程序员共同成长!
关闭
关闭