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