DPDK flow_classify 源码阅读

代码部分

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2017 Intel Corporation
 */
#include <stdint.h>
#include <inttypes.h>
#include <getopt.h>
 
#include <rte_eal.h>
#include <rte_ethdev.h>
#include <rte_cycles.h>
#include <rte_lcore.h>
#include <rte_mbuf.h>
#include <rte_flow.h>
#include <rte_flow_classify.h>
#include <rte_table_acl.h>
 
#define RX_RING_SIZE 1024
#define TX_RING_SIZE 1024
 
#define NUM_MBUFS 8191
#define MBUF_CACHE_SIZE 250
#define BURST_SIZE 32
 
#define MAX_NUM_CLASSIFY 30
#define FLOW_CLASSIFY_MAX_RULE_NUM 91
#define FLOW_CLASSIFY_MAX_PRIORITY 8
#define FLOW_CLASSIFIER_NAME_SIZE 64
 
#define COMMENT_LEAD_CHAR	('#')
#define OPTION_RULE_IPV4	"rule_ipv4"
#define RTE_LOGTYPE_FLOW_CLASSIFY	RTE_LOGTYPE_USER3
#define flow_classify_log(format, ...) \
		RTE_LOG(ERR, FLOW_CLASSIFY, format, ##__VA_ARGS__)
 
#define uint32_t_to_char(ip, a, b, c, d) do {\
		*a = (unsigned char)(ip >> 24 & 0xff);\
		*b = (unsigned char)(ip >> 16 & 0xff);\
		*c = (unsigned char)(ip >> 8 & 0xff);\
		*d = (unsigned char)(ip & 0xff);\
	} while (0)
 
enum {
	CB_FLD_SRC_ADDR,     // 0
	CB_FLD_DST_ADDR,     // 1
	CB_FLD_SRC_PORT,	 // 2
	CB_FLD_SRC_PORT_DLM, // 3 
	CB_FLD_SRC_PORT_MASK,// 4 
	CB_FLD_DST_PORT,	 // 5 
	CB_FLD_DST_PORT_DLM, // 6
	CB_FLD_DST_PORT_MASK,// 7 
	CB_FLD_PROTO,		 // 8
	CB_FLD_PRIORITY,	 // 9 
	CB_FLD_NUM,			 // 10 
};
 
static struct{
	const char *rule_ipv4_name;
} parm_config; // 用于文件访问的。
 
const char cb_port_delim[] = ":";
 
static const struct rte_eth_conf port_conf_default = {
	.rxmode = {
		.max_rx_pkt_len = ETHER_MAX_LEN,
		.ignore_offload_bitfield = 1,
	},
};
 
struct flow_classifier { 
	struct rte_flow_classifier *cls;
};
// flow_classifer 的结构要看 sample guide
 
/*
struct rte_flow_classifier {
 
    // classifier的参数，要 create() 时传入结构体。
    char name[RTE_FLOW_CLASSIFIER_MAX_NAME_SZ];
    int socket_id;
 
    // 其余的内部字段
    // n tuple 过滤器，也就是流规则的匹配项目了。
    struct rte_eth_ntuple_filter ntuple_filter;
 
    // tables
    struct rte_cls_table tables[RTE_FLOW_CLASSIFY_TABLE_MAX];
    uint32_t table_mask;
    uint32_t num_tables;
 
    uint16_t nb_pkts;
    struct rte_flow_classify_table_entry
        *entries[RTE_PORT_IN_BURST_SIZE_MAX];
} __rte_cache_aligned;
*/
 
struct flow_classifier_acl {
	struct flow_classifier cls;
} __rte_cache_aligned;
 
/* ACL field definitions for IPv4 5 tuple rule */
 
enum {
	PROTO_FIELD_IPV4, // 0
	SRC_FIELD_IPV4,   // 1
	DST_FIELD_IPV4,   // 2
	SRCP_FIELD_IPV4,  // 3
	DSTP_FIELD_IPV4,  // 4 
	NUM_FIELDS_IPV4   // 5
};
 
enum {
	PROTO_INPUT_IPV4,
	SRC_INPUT_IPV4,
	DST_INPUT_IPV4,
	SRCP_DESTP_INPUT_IPV4
};
 
 
/* 数据结构 rte_acl_field_def：ACL 访问控制表的字段的定义
ACL规则中的每个字段都有一个关联定义。有五个，分别是：
字段的类型 type，
字段的字节数大小 size，
字段的索引（指示哪一个字段）field_index 一个0开始的值，用来指定字段在规则内部的位置，0~n-1表示n个字段。
输入索引 input_index（0-N）  所有输入字段，除了第一个，其他必须以4个连续字节分组，这个input_index就是来指定字段在那个组
偏移量offset 定义了字段的偏移量，为查找指定从缓冲区的起始位置的偏移。
*/
 
/* 
rule “规则” 有一些独有规则：
	1. 规则定义的第一个字段必须是一个字节的长度
	2. 之后的字段必须以4个连续的字节分组
	这主要是为性能考虑，查找函数处理第一个输入字节做为这个流的设置的一部分，然后这查找函数的内部循环被展开来同时处理4字节的输入。
*/
 
static struct rte_acl_field_def ipv4_defs[NUM_FIELDS_IPV4] = { // 共 5 个字段，每个字段都要有一个关联的五个定义
	/* first input field - always one byte long. */ // 第一个字段 1个字节
	{
		.type = RTE_ACL_FIELD_TYPE_BITMASK, // type 字段的类型，有3种选项，见https://www.cnblogs.com/danxi/p/6650757.html
		.size = sizeof(uint8_t), // 1个字节
		.field_index = PROTO_FIELD_IPV4, // 两个 index 都是 enum
		.input_index = PROTO_INPUT_IPV4,
		.offset = sizeof(struct ether_hdr) + // todo ：数据结构
			offsetof(struct ipv4_hdr, next_proto_id),
	},
	/* next input field (IPv4 source address) - 4 consecutive bytes. */
	{   // 第二个字段 源IP地址
		/* rte_flow uses a bit mask for IPv4 addresses */
		.type = RTE_ACL_FIELD_TYPE_BITMASK, 
		.size = sizeof(uint32_t),
		.field_index = SRC_FIELD_IPV4,
		.input_index = SRC_INPUT_IPV4,
		.offset = sizeof(struct ether_hdr) +
			offsetof(struct ipv4_hdr, src_addr),
	},
	/* next input field (IPv4 destination address) - 4 consecutive bytes. */
	{   // 第三个字段 目的IP地址
		/* rte_flow uses a bit mask for IPv4 addresses */
		.type = RTE_ACL_FIELD_TYPE_BITMASK,
		.size = sizeof(uint32_t),
		.field_index = DST_FIELD_IPV4,
		.input_index = DST_INPUT_IPV4,
		.offset = sizeof(struct ether_hdr) +
			offsetof(struct ipv4_hdr, dst_addr),
	},
	/*
	 * Next 2 fields (src & dst ports) form 4 consecutive bytes.
	 * They share the same input index.
	 */
	// 接下来的 两个端口号 才组成一个 4 字节，所以共享同样的一个 input index
	{
		/* rte_flow uses a bit mask for protocol ports */
		.type = RTE_ACL_FIELD_TYPE_BITMASK, 
		.size = sizeof(uint16_t),
		.field_index = SRCP_FIELD_IPV4,
		.input_index = SRCP_DESTP_INPUT_IPV4,
		.offset = sizeof(struct ether_hdr) + // (todo)
			sizeof(struct ipv4_hdr) +
			offsetof(struct tcp_hdr, src_port),
	},
	{
		/* rte_flow uses a bit mask for protocol ports */
		.type = RTE_ACL_FIELD_TYPE_BITMASK,
		.size = sizeof(uint16_t),
		.field_index = DSTP_FIELD_IPV4,
		.input_index = SRCP_DESTP_INPUT_IPV4,
		.offset = sizeof(struct ether_hdr) +
			sizeof(struct ipv4_hdr) +
			offsetof(struct tcp_hdr, dst_port),
	},
};
 
/* flow classify data */
static int num_classify_rules; // rules数组的下标
static struct rte_flow_classify_rule *rules[MAX_NUM_CLASSIFY]; // rules 数组
static struct rte_flow_classify_ipv4_5tuple_stats ntuple_stats;  // stats 结构体 （todo）
static struct rte_flow_classify_stats classify_stats = { // 有计数功能
		.stats = (void **)&ntuple_stats
};
 
/* parameters for rte_flow_classify_validate and
 * rte_flow_classify_table_entry_add functions
 */
/* rte_flow_item 四个字段：
1. type，是 enum 定义。见 rte_flow.h：http://doc.dpdk.org/api/rte__flow_8h_source.html
2. spec，指向相关项类型结构的有效指针，在许多情况下，可以设置成 NULL以请求广泛（非特定）匹配。在此情况下，last 和 mask 也要设置成 NULL
3. last，可以指向相同类型的结构，以定义包含范围。
4. Mask，是在解释spec和last的内容之前应用的简单位掩码
*/
static struct rte_flow_item  eth_item = { RTE_FLOW_ITEM_TYPE_ETH,
	0, 0, 0 };
static struct rte_flow_item  end_item = { RTE_FLOW_ITEM_TYPE_END,
	0, 0, 0 };
 
/* sample actions:
 * "actions count / end"
 */
struct rte_flow_query_count count = { // 计数器查询的结构体
	.reset = 1, // Reset counters after query
	.hits_set = 1, // 启用 hits 字段
	.bytes_set = 1, // 启用 bytes 字段
	.hits = 0, // Number of hits for this rule
	.bytes = 0, // Number of bytes through this rule
};
static struct rte_flow_action count_action = { RTE_FLOW_ACTION_TYPE_COUNT, &count};
static struct rte_flow_action end_action = { RTE_FLOW_ACTION_TYPE_END, 0}; // 本程序就用到了计数和end 两种 action
 
static struct rte_flow_action actions[2]; 
// rte_flow_action 见 programmers’ guides 的第九章 ：http://doc.dpdk.org/guides/prog_guide/rte_flow.html
// actions 数组代表当 pkt 被 pattern 匹配时要执行的一系列操作。
// 在这个例子里，数组长度为二，actions[0] 就是计数，actions[1] 就是用来提示结尾。
 
// rte_flow_action的具体定义不清楚
// 估计第一个字段是 enum rte_flow_action_type ，具体的 enum 定义见：http://doc.dpdk.org/api/rte__flow_8h.html#a78f0386e683cfc491462a771df8b971a
// 第二个字段计数器查询的