FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
fa_node.h
Go to the documentation of this file.
1 #ifndef _FA_NODE_H_
2 #define _FA_NODE_H_
3 
4 #include <stddef.h>
5 #include <vppinfra/bihash_40_8.h>
6 
7 #define TCP_FLAG_FIN 0x01
8 #define TCP_FLAG_SYN 0x02
9 #define TCP_FLAG_RST 0x04
10 #define TCP_FLAG_PUSH 0x08
11 #define TCP_FLAG_ACK 0x10
12 #define TCP_FLAG_URG 0x20
13 #define TCP_FLAG_ECE 0x40
14 #define TCP_FLAG_CWR 0x80
15 #define TCP_FLAGS_RSTFINACKSYN (TCP_FLAG_RST + TCP_FLAG_FIN + TCP_FLAG_SYN + TCP_FLAG_ACK)
16 #define TCP_FLAGS_ACKSYN (TCP_FLAG_SYN + TCP_FLAG_ACK)
17 
18 #define ACL_FA_CONN_TABLE_DEFAULT_HASH_NUM_BUCKETS (64 * 1024)
19 #define ACL_FA_CONN_TABLE_DEFAULT_HASH_MEMORY_SIZE (1<<30)
20 #define ACL_FA_CONN_TABLE_DEFAULT_MAX_ENTRIES 1000000
21 
22 typedef union {
24  struct {
28  u8 tcp_flags_valid:1;
29  u8 is_input:1;
30  u8 l4_valid:1;
31  u8 is_nonfirst_fragment:1;
32  u8 is_ip6:1;
33  u8 flags_reserved:3;
34  };
36 
37 typedef union {
39  struct {
40  u16 port[2];
43  };
45 
46 typedef union {
47  struct {
48  ip46_address_t addr[2];
50  /* This field should align with u64 value in bihash_40_8 keyvalue struct */
52  };
54 } fa_5tuple_t;
55 
56 
57 typedef struct {
58  fa_5tuple_t info; /* (5+1)*8 = 48 bytes */
59  u64 last_active_time; /* +8 bytes = 56 */
60  u32 sw_if_index; /* +4 bytes = 60 */
61  union {
62  u8 as_u8[2];
64  } tcp_flags_seen; ; /* +2 bytes = 62 */
65  u16 thread_index; /* +2 bytes = 64 */
66  u64 link_enqueue_time; /* 8 byte = 8 */
67  u32 link_prev_idx; /* +4 bytes = 12 */
68  u32 link_next_idx; /* +4 bytes = 16 */
69  u8 link_list_id; /* +1 bytes = 17 */
70  u8 reserved1[7]; /* +7 bytes = 24 */
71  u64 reserved2[5]; /* +5*8 bytes = 64 */
72 } fa_session_t;
73 
74 
75 /* This structure is used to fill in the u64 value
76  in the per-sw-if-index hash table */
77 typedef struct {
78  union {
80  struct {
84  };
85  };
87 
88 /*
89  * A few compile-time constraints on the size and the layout of the union, to ensure
90  * it makes sense both for bihash and for us.
91  */
92 
93 #define CT_ASSERT_EQUAL(name, x,y) typedef int assert_ ## name ## _compile_time_assertion_failed[((x) == (y))-1]
94 CT_ASSERT_EQUAL(fa_l3_key_size_is_40, offsetof(fa_5tuple_t, pkt), offsetof(clib_bihash_kv_40_8_t, value));
95 CT_ASSERT_EQUAL(fa_l4_key_t_is_8, sizeof(fa_session_l4_key_t), sizeof(u64));
96 CT_ASSERT_EQUAL(fa_packet_info_t_is_8, sizeof(fa_packet_info_t), sizeof(u64));
97 CT_ASSERT_EQUAL(fa_l3_kv_size_is_48, sizeof(fa_5tuple_t), sizeof(clib_bihash_kv_40_8_t));
98 
99 /* Let's try to fit within two cachelines */
100 CT_ASSERT_EQUAL(fa_session_t_size_is_128, sizeof(fa_session_t), 128);
101 
102 /* Session ID MUST be the same as u64 */
103 CT_ASSERT_EQUAL(fa_full_session_id_size_is_64, sizeof(fa_full_session_id_t), sizeof(u64));
104 #undef CT_ASSERT_EQUAL
105 
106 typedef struct {
107  /* The pool of sessions managed by this worker */
109  /* per-worker ACL_N_TIMEOUTS of conn lists */
112  /* adds and deletes per-worker-per-interface */
115  /* Vector of expired connections retrieved from lists */
117  /* the earliest next expiry time */
119  /* if not zero, look at all the elements until their enqueue timestamp is after below one */
121  /* Current time between the checks */
123  /* Counter of how many sessions we did delete */
125  /* Counter of already deleted sessions being deleted - should not increment unless a bug */
127  /* Number of times we requeued a session to a head of the list */
129  /* swipe up to this enqueue time, rather than following the timeouts */
131  /* bitmap of sw_if_index serviced by this worker */
133  /* bitmap of sw_if_indices to clear. set by main thread, cleared by worker */
135  /* atomic, indicates that the swipe-deletion of connections is in progress */
137  /* Interrupt is pending from main thread */
139  /*
140  * Interrupt node on the worker thread sets this if it knows there is
141  * more work to do, but it has to finish to avoid hogging the
142  * core for too long.
143  */
145  /*
146  * Set to indicate that the interrupt node wants to get less interrupts
147  * because there is not enough work for the current rate.
148  */
150  /*
151  * Set to copy of a "generation" counter in main thread so we can sync the interrupts.
152  */
155 
156 
157 typedef enum {
160 } acl_fa_next_t;
161 
162 
163 enum
164 {
168 
169 void acl_fa_enable_disable(u32 sw_if_index, int is_input, int enable_disable);
170 
171 void show_fa_sessions_hash(vlib_main_t * vm, u32 verbose);
172 
173 u8 *format_acl_plugin_5tuple (u8 * s, va_list * args);
174 
175 #endif
uword * pending_clear_sw_if_index_bitmap
Definition: fa_node.h:134
fa_session_l4_key_t l4
Definition: fa_node.h:49
fa_packet_info_t pkt
Definition: fa_node.h:51
fa_5tuple_t info
Definition: fa_node.h:58
#define CT_ASSERT_EQUAL(name, x, y)
Definition: fa_node.h:93
fa_session_t * fa_sessions_pool
Definition: fa_node.h:108
u8 link_list_id
Definition: fa_node.h:69
u16 lsb_of_sw_if_index
Definition: fa_node.h:42
u32 link_prev_idx
Definition: fa_node.h:67
unsigned long u64
Definition: types.h:89
clib_bihash_kv_40_8_t kv
Definition: fa_node.h:53
u64 last_active_time
Definition: fa_node.h:59
u64 * fa_session_adds_by_sw_if_index
Definition: fa_node.h:114
u64 * fa_session_dels_by_sw_if_index
Definition: fa_node.h:113
vlib_main_t * vm
Definition: buffer.c:283
void acl_fa_enable_disable(u32 sw_if_index, int is_input, int enable_disable)
Definition: fa_node.c:1665
acl_fa_next_t
Definition: fa_node.h:157
u32 sw_if_index
Definition: fa_node.h:60
unsigned int u32
Definition: types.h:88
uword * serviced_sw_if_index_bitmap
Definition: fa_node.h:132
u32 link_next_idx
Definition: fa_node.h:68
u64 uword
Definition: types.h:112
u16 as_u16
Definition: fa_node.h:63
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56
u8 * format_acl_plugin_5tuple(u8 *s, va_list *args)
Definition: fa_node.c:62
u16 thread_index
Definition: fa_node.h:64
void show_fa_sessions_hash(vlib_main_t *vm, u32 verbose)
Definition: fa_node.c:1720
vhost_vring_addr_t addr
Definition: vhost-user.h:83
u16 mask_type_index_lsb
Definition: fa_node.h:26
enum @304 acl_fa_cleaner_process_event_e
u64 link_enqueue_time
Definition: fa_node.h:66