src/plugins/acl/fa_node.h

   1 #ifndef _FA_NODE_H_
   2 #define _FA_NODE_H_
   3
   4 #include <stddef.h>
   5 #include <vppinfra/bihash_16_8.h>
   6 #include <vppinfra/bihash_40_8.h>
   7
   8 #include <plugins/acl/exported_types.h>
   9
  10 // #define FA_NODE_VERBOSE_DEBUG 3
  11
  12 #define TCP_FLAG_FIN    0x01
  13 #define TCP_FLAG_SYN    0x02
  14 #define TCP_FLAG_RST    0x04
  15 #define TCP_FLAG_PUSH   0x08
  16 #define TCP_FLAG_ACK    0x10
  17 #define TCP_FLAG_URG    0x20
  18 #define TCP_FLAG_ECE    0x40
  19 #define TCP_FLAG_CWR    0x80
  20 #define TCP_FLAGS_RSTFINACKSYN (TCP_FLAG_RST + TCP_FLAG_FIN + TCP_FLAG_SYN + TCP_FLAG_ACK)
  21 #define TCP_FLAGS_ACKSYN (TCP_FLAG_SYN + TCP_FLAG_ACK)
  22
  23 #define ACL_FA_CONN_TABLE_DEFAULT_HASH_NUM_BUCKETS (64 * 1024)
  24 #define ACL_FA_CONN_TABLE_DEFAULT_HASH_MEMORY_SIZE (1ULL<<30)
  25 #define ACL_FA_CONN_TABLE_DEFAULT_MAX_ENTRIES 500000
  26
  27 typedef union {
  28   u64 as_u64;
  29   struct {
  30     u32 lc_index;
  31     u16 mask_type_index_lsb;
  32     u8 tcp_flags;
  33     u8 tcp_flags_valid:1;
  34     u8 l4_valid:1;
  35     u8 is_nonfirst_fragment:1;
  36     u8 is_ip6:1;
  37     u8 flags_reserved:4;
  38   };
  39 } fa_packet_info_t;
  40
  41 typedef union {
  42   u64 as_u64;
  43   struct {
  44     u16 port[2];
  45     union {
  46       struct {
  47         u8 proto;
  48         u8 is_input: 1;
  49         u8 is_slowpath: 1;
  50         u8 reserved0: 6;
  51         u16 lsb_of_sw_if_index;
  52       };
  53       u32 non_port_l4_data;
  54     };
  55   };
  56 } fa_session_l4_key_t;
  57
  58 typedef union {
  59   struct {
  60     union {
  61       struct {
  62         /* we put the IPv4 addresses
  63            after padding so we can still
  64            use them as (shorter) key together with
  65            L4 info */
  66         u32 l3_zero_pad[6];
  67         ip4_address_t ip4_addr[2];
  68       };
  69       ip6_address_t ip6_addr[2];
  70     };
  71     fa_session_l4_key_t l4;
  72     /* This field should align with u64 value in bihash_40_8 and bihash_16_8 keyvalue struct */
  73     fa_packet_info_t pkt;
  74   };
  75   clib_bihash_kv_40_8_t kv_40_8;
  76   struct {
  77     u64 padding_for_kv_16_8[3];
  78     clib_bihash_kv_16_8_t kv_16_8;
  79   };
  80 } fa_5tuple_t;
  81
  82 typedef struct {
  83   fa_5tuple_t info; /* (5+1)*8 = 48 bytes */
  84   u64 last_active_time;   /* +8 bytes = 56 */
  85   u32 sw_if_index;        /* +4 bytes = 60 */
  86   union {
  87     u8 as_u8[2];
  88     u16 as_u16;
  89   } tcp_flags_seen; ;     /* +2 bytes = 62 */
  90   u16 thread_index;          /* +2 bytes = 64 */
  91   u64 link_enqueue_time;  /* 8 byte = 8 */
  92   u32 link_prev_idx;      /* +4 bytes = 12 */
  93   u32 link_next_idx;      /* +4 bytes = 16 */
  94   u8 link_list_id;        /* +1 bytes = 17 */
  95   u8 deleted;             /* +1 bytes = 18 */
  96   u8 is_ip6;              /* +1 bytes = 19 */
  97   u8 reserved1[5];        /* +5 bytes = 24 */
  98   u64 reserved2[5];       /* +5*8 bytes = 64 */
  99 } fa_session_t;
 100
 101 #define FA_POLICY_EPOCH_MASK 0x7fff
 102 /* input policy epochs have the MSB set */
 103 #define FA_POLICY_EPOCH_IS_INPUT 0x8000
 104
 105
 106 /* This structure is used to fill in the u64 value
 107    in the per-sw-if-index hash table */
 108 typedef struct {
 109   union {
 110     u64 as_u64;
 111     struct {
 112       u32 session_index;
 113       u16 thread_index;
 114       u16 intf_policy_epoch;
 115     };
 116   };
 117 } fa_full_session_id_t;
 118
 119 /*
 120  * A few compile-time constraints on the size and the layout of the union, to ensure
 121  * it makes sense both for bihash and for us.
 122  */
 123
 124 #define CT_ASSERT_EQUAL(name, x,y) typedef int assert_ ## name ## _compile_time_assertion_failed[((x) == (y))-1]
 125 CT_ASSERT_EQUAL(fa_l3_key_size_is_40, offsetof(fa_5tuple_t, pkt), offsetof(clib_bihash_kv_40_8_t, value));
 126 CT_ASSERT_EQUAL(fa_ip6_kv_val_at_pkt, offsetof(fa_5tuple_t, pkt), offsetof(fa_5tuple_t, kv_40_8.value));
 127 CT_ASSERT_EQUAL(fa_ip4_kv_val_at_pkt, offsetof(fa_5tuple_t, pkt), offsetof(fa_5tuple_t, kv_16_8.value));
 128 CT_ASSERT_EQUAL(fa_l4_key_t_is_8, sizeof(fa_session_l4_key_t), sizeof(u64));
 129 CT_ASSERT_EQUAL(fa_packet_info_t_is_8, sizeof(fa_packet_info_t), sizeof(u64));
 130 CT_ASSERT_EQUAL(fa_l3_kv_size_is_48, sizeof(fa_5tuple_t), sizeof(clib_bihash_kv_40_8_t));
 131 CT_ASSERT_EQUAL(fa_ip4_starts_at_kv16_key, offsetof(fa_5tuple_t, ip4_addr), offsetof(fa_5tuple_t, kv_16_8));
 132 CT_ASSERT_EQUAL(fa_ip4_and_ip6_kv_value_match, offsetof(fa_5tuple_t, kv_16_8.value), offsetof(fa_5tuple_t, kv_40_8.value));
 133
 134 /* Let's try to fit within two cachelines */
 135 CT_ASSERT_EQUAL(fa_session_t_size_is_128, sizeof(fa_session_t), 128);
 136
 137 /* Session ID MUST be the same as u64 */
 138 CT_ASSERT_EQUAL(fa_full_session_id_size_is_64, sizeof(fa_full_session_id_t), sizeof(u64));
 139
 140 CT_ASSERT_EQUAL(fa_5tuple_opaque_t_must_match_5tuple, sizeof(fa_5tuple_opaque_t), sizeof(fa_5tuple_t));
 141 #undef CT_ASSERT_EQUAL
 142
 143 #define FA_SESSION_BOGUS_INDEX ~0
 144
 145 typedef struct {
 146   /* The pool of sessions managed by this worker */
 147   fa_session_t *fa_sessions_pool;
 148   /* per-worker ACL_N_TIMEOUTS of conn lists */
 149   u32 *fa_conn_list_head;
 150   u32 *fa_conn_list_tail;
 151   /* expiry time set whenever an element is enqueued */
 152   u64 *fa_conn_list_head_expiry_time;
 153   /* adds and deletes per-worker-per-interface */
 154   u64 *fa_session_dels_by_sw_if_index;
 155   u64 *fa_session_adds_by_sw_if_index;
 156   /* sessions deleted due to epoch change */
 157   u64 *fa_session_epoch_change_by_sw_if_index;
 158   /* Vector of expired connections retrieved from lists */
 159   u32 *expired;
 160   /* the earliest next expiry time */
 161   u64 next_expiry_time;
 162   /* if not zero, look at all the elements until their enqueue timestamp is after below one */
 163   u64 requeue_until_time;
 164   /* Current time between the checks */
 165   u64 current_time_wait_interval;
 166   /* Counter of how many sessions we did delete */
 167   u64 cnt_deleted_sessions;
 168   /* Counter of already deleted sessions being deleted - should not increment unless a bug */
 169   u64 cnt_already_deleted_sessions;
 170   /* Number of times we requeued a session to a head of the list */
 171   u64 cnt_session_timer_restarted;
 172   /* swipe up to this enqueue time, rather than following the timeouts */
 173   u64 swipe_end_time;
 174   /* bitmap of sw_if_index serviced by this worker */
 175   uword *serviced_sw_if_index_bitmap;
 176   /* bitmap of sw_if_indices to clear. set by main thread, cleared by worker */
 177   uword *pending_clear_sw_if_index_bitmap;
 178   /* atomic, indicates that the swipe-deletion of connections is in progress */
 179   u32 clear_in_process;
 180   /* Interrupt is pending from main thread */
 181   int interrupt_is_pending;
 182   /*
 183    * Interrupt node on the worker thread sets this if it knows there is
 184    * more work to do, but it has to finish to avoid hogging the
 185    * core for too long.
 186    */
 187   int interrupt_is_needed;
 188   /*
 189    * Set to indicate that the interrupt node wants to get less interrupts
 190    * because there is not enough work for the current rate.
 191    */
 192   int interrupt_is_unwanted;
 193   /*
 194    * Set to copy of a "generation" counter in main thread so we can sync the interrupts.
 195    */
 196   int interrupt_generation;
 197 } acl_fa_per_worker_data_t;
 198
 199
 200 typedef enum {
 201   ACL_FA_ERROR_DROP,
 202   ACL_FA_N_NEXT,
 203 } acl_fa_next_t;
 204
 205
 206 enum
 207 {
 208   ACL_FA_CLEANER_RESCHEDULE = 1,
 209   ACL_FA_CLEANER_DELETE_BY_SW_IF_INDEX,
 210 } acl_fa_cleaner_process_event_e;
 211
 212 void acl_fa_enable_disable(u32 sw_if_index, int is_input, int enable_disable);
 213
 214 void show_fa_sessions_hash(vlib_main_t * vm, u32 verbose);
 215
 216 u8 *format_acl_plugin_5tuple (u8 * s, va_list * args);
 217
 218 /* use like: elog_acl_maybe_trace_X1(am, "foobar: %d", "i4", int32_value); */
 219
 220 #define elog_acl_maybe_trace_X1(am, acl_elog_trace_format_label, acl_elog_trace_format_args, acl_elog_val1)              \
 221 do {                                                                                                                     \
 222   if (am->trace_sessions) {                                                                                              \
 223     CLIB_UNUSED(struct { u8 available_space[18 - sizeof(acl_elog_val1)]; } *static_check);                               \
 224     u16 thread_index = os_get_thread_index ();                                                                           \
 225     vlib_worker_thread_t * w = vlib_worker_threads + thread_index;                                                       \
 226     ELOG_TYPE_DECLARE (e) =                                                                                              \
 227       {                                                                                                                  \
 228         .format = "(%02d) " acl_elog_trace_format_label,                                                                 \
 229         .format_args = "i2" acl_elog_trace_format_args,                                                                  \
 230       };                                                                                                                 \
 231     CLIB_PACKED(struct                                                                                                   \
 232       {                                                                                                                  \
 233         u16 thread;                                                                                                      \
 234         typeof(acl_elog_val1) val1;                                                                                      \
 235       }) *ed;                                                                                                            \
 236     ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e, w->elog_track);                                                \
 237     ed->thread = thread_index;                                                                                           \
 238     ed->val1 = acl_elog_val1;                                                                                            \
 239   }                                                                                                                      \
 240 } while (0)
 241
 242
 243 /* use like: elog_acl_maybe_trace_X2(am, "foobar: %d some u64: %lu", "i4i8", int32_value, int64_value); */
 244
 245 #define elog_acl_maybe_trace_X2(am, acl_elog_trace_format_label, acl_elog_trace_format_args,                             \
 246                                                                                            acl_elog_val1, acl_elog_val2) \
 247 do {                                                                                                                     \
 248   if (am->trace_sessions) {                                                                                              \
 249     CLIB_UNUSED(struct { u8 available_space[18 - sizeof(acl_elog_val1) - sizeof(acl_elog_val2)]; } *static_check);       \
 250     u16 thread_index = os_get_thread_index ();                                                                           \
 251     vlib_worker_thread_t * w = vlib_worker_threads + thread_index;                                                       \
 252     ELOG_TYPE_DECLARE (e) =                                                                                              \
 253       {                                                                                                                  \
 254         .format = "(%02d) " acl_elog_trace_format_label,                                                                 \
 255         .format_args = "i2" acl_elog_trace_format_args,                                                                  \
 256       };                                                                                                                 \
 257     CLIB_PACKED(struct                                                                                                   \
 258       {                                                                                                                  \
 259         u16 thread;                                                                                                      \
 260         typeof(acl_elog_val1) val1;                                                                                      \
 261         typeof(acl_elog_val2) val2;                                                                                      \
 262       }) *ed;                                                                                                            \
 263     ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e, w->elog_track);                                                \
 264     ed->thread = thread_index;                                                                                           \
 265     ed->val1 = acl_elog_val1;                                                                                            \
 266     ed->val2 = acl_elog_val2;                                                                                            \
 267   }                                                                                                                      \
 268 } while (0)
 269
 270
 271 /* use like: elog_acl_maybe_trace_X3(am, "foobar: %d some u64 %lu baz: %d", "i4i8i4", int32_value, u64_value, int_value); */
 272
 273 #define elog_acl_maybe_trace_X3(am, acl_elog_trace_format_label, acl_elog_trace_format_args, acl_elog_val1,              \
 274                                                                                            acl_elog_val2, acl_elog_val3) \
 275 do {                                                                                                                     \
 276   if (am->trace_sessions) {                                                                                              \
 277     CLIB_UNUSED(struct { u8 available_space[18 - sizeof(acl_elog_val1) - sizeof(acl_elog_val2)                           \
 278                                                - sizeof(acl_elog_val3)]; } *static_check);                               \
 279     u16 thread_index = os_get_thread_index ();                                                                           \
 280     vlib_worker_thread_t * w = vlib_worker_threads + thread_index;                                                       \
 281     ELOG_TYPE_DECLARE (e) =                                                                                              \
 282       {                                                                                                                  \
 283         .format = "(%02d) " acl_elog_trace_format_label,                                                                 \
 284         .format_args = "i2" acl_elog_trace_format_args,                                                                  \
 285       };                                                                                                                 \
 286     CLIB_PACKED(struct                                                                                                   \
 287       {                                                                                                                  \
 288         u16 thread;                                                                                                      \
 289         typeof(acl_elog_val1) val1;                                                                                      \
 290         typeof(acl_elog_val2) val2;                                                                                      \
 291         typeof(acl_elog_val3) val3;                                                                                      \
 292       }) *ed;                                                                                                            \
 293     ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e, w->elog_track);                                                \
 294     ed->thread = thread_index;                                                                                           \
 295     ed->val1 = acl_elog_val1;                                                                                            \
 296     ed->val2 = acl_elog_val2;                                                                                            \
 297     ed->val3 = acl_elog_val3;                                                                                            \
 298   }                                                                                                                      \
 299 } while (0)
 300
 301
 302 /* use like: elog_acl_maybe_trace_X4(am, "foobar: %d some int %d baz: %d bar: %d", "i4i4i4i4", int32_value, int32_value2, int_value, int_value); */
 303
 304 #define elog_acl_maybe_trace_X4(am, acl_elog_trace_format_label, acl_elog_trace_format_args, acl_elog_val1,              \
 305                                                                             acl_elog_val2, acl_elog_val3, acl_elog_val4) \
 306 do {                                                                                                                     \
 307   if (am->trace_sessions) {                                                                                              \
 308     CLIB_UNUSED(struct { u8 available_space[18 - sizeof(acl_elog_val1) - sizeof(acl_elog_val2)                           \
 309                                                - sizeof(acl_elog_val3) -sizeof(acl_elog_val4)]; } *static_check);        \
 310     u16 thread_index = os_get_thread_index ();                                                                           \
 311     vlib_worker_thread_t * w = vlib_worker_threads + thread_index;                                                       \
 312     ELOG_TYPE_DECLARE (e) =                                                                                              \
 313       {                                                                                                                  \
 314         .format = "(%02d) " acl_elog_trace_format_label,                                                                 \
 315         .format_args = "i2" acl_elog_trace_format_args,                                                                  \
 316       };                                                                                                                 \
 317     CLIB_PACKED(struct                                                                                                   \
 318       {                                                                                                                  \
 319         u16 thread;                                                                                                      \
 320         typeof(acl_elog_val1) val1;                                                                                      \
 321         typeof(acl_elog_val2) val2;                                                                                      \
 322         typeof(acl_elog_val3) val3;                                                                                      \
 323         typeof(acl_elog_val4) val4;                                                                                      \
 324       }) *ed;                                                                                                            \
 325     ed = ELOG_TRACK_DATA (&vlib_global_main.elog_main, e, w->elog_track);                                                \
 326     ed->thread = thread_index;                                                                                           \
 327     ed->val1 = acl_elog_val1;                                                                                            \
 328     ed->val2 = acl_elog_val2;                                                                                            \
 329     ed->val3 = acl_elog_val3;                                                                                            \
 330     ed->val4 = acl_elog_val4;                                                                                            \
 331   }                                                                                                                      \
 332 } while (0)
 333
 334
 335 #endif