src/plugins/acl/fa_node.c

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 #include <stddef.h>
  16 #include <netinet/in.h>
  17
  18 #include <vlib/vlib.h>
  19 #include <vnet/vnet.h>
  20 #include <vnet/pg/pg.h>
  21 #include <vppinfra/error.h>
  22 #include <acl/acl.h>
  23 #include "bihash_40_8.h"
  24
  25 #include <vppinfra/bihash_template.h>
  26 #include <vppinfra/bihash_template.c>
  27
  28 #include "fa_node.h"
  29
  30 typedef struct
  31 {
  32   u32 next_index;
  33   u32 sw_if_index;
  34   u32 match_acl_in_index;
  35   u32 match_rule_index;
  36   u64 packet_info[6];
  37   u32 trace_bitmap;
  38   u8 action;
  39 } acl_fa_trace_t;
  40
  41 /* packet trace format function */
  42 static u8 *
  43 format_acl_fa_trace (u8 * s, va_list * args)
  44 {
  45   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  46   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  47   acl_fa_trace_t *t = va_arg (*args, acl_fa_trace_t *);
  48
  49   s =
  50     format (s,
  51             "acl-plugin: sw_if_index %d, next index %d, action: %d, match: acl %d rule %d trace_bits %08x\n"
  52             "  pkt info %016llx %016llx %016llx %016llx %016llx %016llx",
  53             t->sw_if_index, t->next_index, t->action, t->match_acl_in_index,
  54             t->match_rule_index, t->trace_bitmap,
  55             t->packet_info[0], t->packet_info[1], t->packet_info[2],
  56             t->packet_info[3], t->packet_info[4], t->packet_info[5]);
  57   return s;
  58 }
  59
  60 /* *INDENT-OFF* */
  61 #define foreach_acl_fa_error \
  62 _(ACL_DROP, "ACL deny packets")  \
  63 _(ACL_PERMIT, "ACL permit packets")  \
  64 _(ACL_NEW_SESSION, "new sessions added") \
  65 _(ACL_EXIST_SESSION, "existing session packets") \
  66 _(ACL_CHECK, "checked packets") \
  67 _(ACL_RESTART_SESSION_TIMER, "restart session timer") \
  68 _(ACL_TOO_MANY_SESSIONS, "too many sessions to add new") \
  69 /* end  of errors */
  70
  71 typedef enum
  72 {
  73 #define _(sym,str) ACL_FA_ERROR_##sym,
  74   foreach_acl_fa_error
  75 #undef _
  76     ACL_FA_N_ERROR,
  77 } acl_fa_error_t;
  78
  79 static char *acl_fa_error_strings[] = {
  80 #define _(sym,string) string,
  81   foreach_acl_fa_error
  82 #undef _
  83 };
  84 /* *INDENT-ON* */
  85
  86 static void *
  87 get_ptr_to_offset (vlib_buffer_t * b0, int offset)
  88 {
  89   u8 *p = vlib_buffer_get_current (b0) + offset;
  90   return p;
  91 }
  92
  93
  94 static int
  95 fa_acl_match_addr (ip46_address_t * addr1, ip46_address_t * addr2,
  96                    int prefixlen, int is_ip6)
  97 {
  98   if (prefixlen == 0)
  99     {
 100       /* match any always succeeds */
 101       return 1;
 102     }
 103   if (is_ip6)
 104     {
 105       if (memcmp (addr1, addr2, prefixlen / 8))
 106         {
 107           /* If the starting full bytes do not match, no point in bittwidling the thumbs further */
 108           return 0;
 109         }
 110       if (prefixlen % 8)
 111         {
 112           u8 b1 = *((u8 *) addr1 + 1 + prefixlen / 8);
 113           u8 b2 = *((u8 *) addr2 + 1 + prefixlen / 8);
 114           u8 mask0 = (0xff - ((1 << (8 - (prefixlen % 8))) - 1));
 115           return (b1 & mask0) == b2;
 116         }
 117       else
 118         {
 119           /* The prefix fits into integer number of bytes, so nothing left to do */
 120           return 1;
 121         }
 122     }
 123   else
 124     {
 125       uint32_t a1 = ntohl (addr1->ip4.as_u32);
 126       uint32_t a2 = ntohl (addr2->ip4.as_u32);
 127       uint32_t mask0 = 0xffffffff - ((1 << (32 - prefixlen)) - 1);
 128       return (a1 & mask0) == a2;
 129     }
 130 }
 131
 132 static int
 133 fa_acl_match_port (u16 port, u16 port_first, u16 port_last, int is_ip6)
 134 {
 135   return ((port >= port_first) && (port <= port_last));
 136 }
 137
 138 int
 139 acl_match_5tuple (acl_main_t * am, u32 acl_index, fa_5tuple_t * pkt_5tuple,
 140                   int is_ip6, u8 * r_action, u32 * r_acl_match_p,
 141                   u32 * r_rule_match_p, u32 * trace_bitmap)
 142 {
 143   int i;
 144   acl_list_t *a;
 145   acl_rule_t *r;
 146
 147   if (pool_is_free_index (am->acls, acl_index))
 148     {
 149       if (r_acl_match_p)
 150         *r_acl_match_p = acl_index;
 151       if (r_rule_match_p)
 152         *r_rule_match_p = -1;
 153       /* the ACL does not exist but is used for policy. Block traffic. */
 154       return 0;
 155     }
 156   a = am->acls + acl_index;
 157   for (i = 0; i < a->count; i++)
 158     {
 159       r = a->rules + i;
 160       if (is_ip6 != r->is_ipv6)
 161         {
 162           continue;
 163         }
 164       if (!fa_acl_match_addr
 165           (&pkt_5tuple->addr[1], &r->dst, r->dst_prefixlen, is_ip6))
 166         continue;
 167
 168 #ifdef FA_NODE_VERBOSE_DEBUG
 169       clib_warning
 170         ("ACL_FA_NODE_DBG acl %d rule %d pkt dst addr %U match rule addr %U/%d",
 171          acl_index, i, format_ip46_address, &pkt_5tuple->addr[1],
 172          IP46_TYPE_ANY, format_ip46_address, &r->dst, IP46_TYPE_ANY,
 173          r->dst_prefixlen);
 174 #endif
 175
 176       if (!fa_acl_match_addr
 177           (&pkt_5tuple->addr[0], &r->src, r->src_prefixlen, is_ip6))
 178         continue;
 179
 180 #ifdef FA_NODE_VERBOSE_DEBUG
 181       clib_warning
 182         ("ACL_FA_NODE_DBG acl %d rule %d pkt src addr %U match rule addr %U/%d",
 183          acl_index, i, format_ip46_address, &pkt_5tuple->addr[0],
 184          IP46_TYPE_ANY, format_ip46_address, &r->src, IP46_TYPE_ANY,
 185          r->src_prefixlen);
 186       clib_warning
 187         ("ACL_FA_NODE_DBG acl %d rule %d trying to match pkt proto %d with rule %d",
 188          acl_index, i, pkt_5tuple->l4.proto, r->proto);
 189 #endif
 190       if (r->proto)
 191         {
 192           if (pkt_5tuple->l4.proto != r->proto)
 193             continue;
 194           /* A sanity check just to ensure what we jave just matched was a valid L4 extracted from the packet */
 195           if (PREDICT_FALSE (!pkt_5tuple->pkt.l4_valid))
 196             continue;
 197
 198 #ifdef FA_NODE_VERBOSE_DEBUG
 199           clib_warning
 200             ("ACL_FA_NODE_DBG acl %d rule %d pkt proto %d match rule %d",
 201              acl_index, i, pkt_5tuple->l4.proto, r->proto);
 202 #endif
 203
 204           if (!fa_acl_match_port
 205               (pkt_5tuple->l4.port[0], r->src_port_or_type_first,
 206                r->src_port_or_type_last, is_ip6))
 207             continue;
 208
 209 #ifdef FA_NODE_VERBOSE_DEBUG
 210           clib_warning
 211             ("ACL_FA_NODE_DBG acl %d rule %d pkt sport %d match rule [%d..%d]",
 212              acl_index, i, pkt_5tuple->l4.port[0], r->src_port_or_type_first,
 213              r->src_port_or_type_last);
 214 #endif
 215
 216           if (!fa_acl_match_port
 217               (pkt_5tuple->l4.port[1], r->dst_port_or_code_first,
 218                r->dst_port_or_code_last, is_ip6))
 219             continue;
 220
 221 #ifdef FA_NODE_VERBOSE_DEBUG
 222           clib_warning
 223             ("ACL_FA_NODE_DBG acl %d rule %d pkt dport %d match rule [%d..%d]",
 224              acl_index, i, pkt_5tuple->l4.port[1], r->dst_port_or_code_first,
 225              r->dst_port_or_code_last);
 226 #endif
 227           if (pkt_5tuple->pkt.tcp_flags_valid
 228               && ((pkt_5tuple->pkt.tcp_flags & r->tcp_flags_mask) !=
 229                   r->tcp_flags_value))
 230             continue;
 231         }
 232       /* everything matches! */
 233 #ifdef FA_NODE_VERBOSE_DEBUG
 234       clib_warning ("ACL_FA_NODE_DBG acl %d rule %d FULL-MATCH, action %d",
 235                     acl_index, i, r->is_permit);
 236 #endif
 237       *r_action = r->is_permit;
 238       if (r_acl_match_p)
 239         *r_acl_match_p = acl_index;
 240       if (r_rule_match_p)
 241         *r_rule_match_p = i;
 242       return 1;
 243     }
 244   return 0;
 245 }
 246
 247 static u8
 248 full_acl_match_5tuple (u32 sw_if_index, fa_5tuple_t * pkt_5tuple, int is_l2,
 249                        int is_ip6, int is_input, u32 * acl_match_p,
 250                        u32 * rule_match_p, u32 * trace_bitmap)
 251 {
 252   acl_main_t *am = &acl_main;
 253   int i;
 254   u32 *acl_vector;
 255   u8 action = 0;
 256
 257   if (is_input)
 258     {
 259       vec_validate (am->input_acl_vec_by_sw_if_index, sw_if_index);
 260       acl_vector = am->input_acl_vec_by_sw_if_index[sw_if_index];
 261     }
 262   else
 263     {
 264       vec_validate (am->output_acl_vec_by_sw_if_index, sw_if_index);
 265       acl_vector = am->output_acl_vec_by_sw_if_index[sw_if_index];
 266     }
 267   for (i = 0; i < vec_len (acl_vector); i++)
 268     {
 269 #ifdef FA_NODE_VERBOSE_DEBUG
 270       clib_warning ("ACL_FA_NODE_DBG: Trying to match ACL: %d",
 271                     acl_vector[i]);
 272 #endif
 273       if (acl_match_5tuple
 274           (am, acl_vector[i], pkt_5tuple, is_ip6, &action,
 275            acl_match_p, rule_match_p, trace_bitmap))
 276         {
 277           return action;
 278         }
 279     }
 280   if (vec_len (acl_vector) > 0)
 281     {
 282       /* If there are ACLs and none matched, deny by default */
 283       return 0;
 284     }
 285 #ifdef FA_NODE_VERBOSE_DEBUG
 286   clib_warning ("ACL_FA_NODE_DBG: No ACL on sw_if_index %d", sw_if_index);
 287 #endif
 288   /* Deny by default. If there are no ACLs defined we should not be here. */
 289   return 0;
 290 }
 291
 292 static int
 293 offset_within_packet (vlib_buffer_t * b0, int offset)
 294 {
 295   /* For the purposes of this code, "within" means we have at least 8 bytes after it */
 296   return (offset < (b0->current_length - 8));
 297 }
 298
 299 static void
 300 acl_fill_5tuple (acl_main_t * am, vlib_buffer_t * b0, int is_ip6,
 301                  int is_input, int is_l2_path, fa_5tuple_t * p5tuple_pkt)
 302 {
 303   int l3_offset = 14;
 304   int l4_offset;
 305   u16 ports[2];
 306   u16 proto;
 307   /* IP4 and IP6 protocol numbers of ICMP */
 308   static u8 icmp_protos[] = { IP_PROTOCOL_ICMP, IP_PROTOCOL_ICMP6 };
 309
 310   if (is_input && !(is_l2_path))
 311     {
 312       l3_offset = 0;
 313     }
 314
 315
 316   if (is_ip6)
 317     {
 318       clib_memcpy (&p5tuple_pkt->addr,
 319                    get_ptr_to_offset (b0,
 320                                       offsetof (ip6_header_t,
 321                                                 src_address) + l3_offset),
 322                    sizeof (p5tuple_pkt->addr));
 323       proto =
 324         *(u8 *) get_ptr_to_offset (b0,
 325                                    offsetof (ip6_header_t,
 326                                              protocol) + l3_offset);
 327       l4_offset = l3_offset + sizeof (ip6_header_t);
 328 #ifdef FA_NODE_VERBOSE_DEBUG
 329       clib_warning ("ACL_FA_NODE_DBG: proto: %d, l4_offset: %d", proto,
 330                     l4_offset);
 331 #endif
 332       /* IP6 EH handling is here, increment l4_offset if needs to, update the proto */
 333       int need_skip_eh = clib_bitmap_get (am->fa_ipv6_known_eh_bitmap, proto);
 334       if (PREDICT_FALSE (need_skip_eh))
 335         {
 336           /* FIXME: add fragment header special handling. Currently causes treated as unknown header. */
 337           while (need_skip_eh && offset_within_packet (b0, l4_offset))
 338             {
 339               u8 nwords = *(u8 *) get_ptr_to_offset (b0, 1 + l4_offset);
 340               proto = *(u8 *) get_ptr_to_offset (b0, l4_offset);
 341               l4_offset += 8 * (1 + (u16) nwords);
 342 #ifdef FA_NODE_VERBOSE_DEBUG
 343               clib_warning ("ACL_FA_NODE_DBG: new proto: %d, new offset: %d",
 344                             proto, l4_offset);
 345 #endif
 346               need_skip_eh =
 347                 clib_bitmap_get (am->fa_ipv6_known_eh_bitmap, proto);
 348             }
 349         }
 350     }
 351   else
 352     {
 353       p5tuple_pkt->kv.key[0] = 0;
 354       p5tuple_pkt->kv.key[1] = 0;
 355       p5tuple_pkt->kv.key[2] = 0;
 356       p5tuple_pkt->kv.key[3] = 0;
 357       clib_memcpy (&p5tuple_pkt->addr[0].ip4,
 358                    get_ptr_to_offset (b0,
 359                                       offsetof (ip4_header_t,
 360                                                 src_address) + l3_offset),
 361                    sizeof (p5tuple_pkt->addr[0].ip4));
 362       clib_memcpy (&p5tuple_pkt->addr[1].ip4,
 363                    get_ptr_to_offset (b0,
 364                                       offsetof (ip4_header_t,
 365                                                 dst_address) + l3_offset),
 366                    sizeof (p5tuple_pkt->addr[1].ip4));
 367       proto =
 368         *(u8 *) get_ptr_to_offset (b0,
 369                                    offsetof (ip4_header_t,
 370                                              protocol) + l3_offset);
 371       l4_offset = l3_offset + sizeof (ip4_header_t);
 372     }
 373   /* Remainder of the key and per-packet non-key data */
 374   p5tuple_pkt->kv.key[4] = 0;
 375   p5tuple_pkt->kv.value = 0;
 376   if (PREDICT_TRUE (offset_within_packet (b0, l4_offset)))
 377     {
 378       p5tuple_pkt->l4.proto = proto;
 379       p5tuple_pkt->pkt.l4_valid = 1;
 380       if (icmp_protos[is_ip6] == proto)
 381         {
 382           /* type */
 383           p5tuple_pkt->l4.port[0] =
 384             *(u8 *) get_ptr_to_offset (b0,
 385                                        l4_offset + offsetof (icmp46_header_t,
 386                                                              type));
 387           /* code */
 388           p5tuple_pkt->l4.port[1] =
 389             *(u8 *) get_ptr_to_offset (b0,
 390                                        l4_offset + offsetof (icmp46_header_t,
 391                                                              code));
 392         }
 393       else if ((IPPROTO_TCP == proto) || (IPPROTO_UDP == proto))
 394         {
 395           clib_memcpy (&ports,
 396                        get_ptr_to_offset (b0,
 397                                           l4_offset + offsetof (tcp_header_t,
 398                                                                 src_port)),
 399                        sizeof (ports));
 400           p5tuple_pkt->l4.port[0] = ntohs (ports[0]);
 401           p5tuple_pkt->l4.port[1] = ntohs (ports[1]);
 402
 403           p5tuple_pkt->pkt.tcp_flags =
 404             *(u8 *) get_ptr_to_offset (b0,
 405                                        l4_offset + offsetof (tcp_header_t,
 406                                                              flags));
 407           p5tuple_pkt->pkt.tcp_flags_valid = (proto == IPPROTO_TCP);
 408         }
 409       /*
 410        * FIXME: rather than the above conditional, here could
 411        * be a nice generic mechanism to extract two L4 values:
 412        *
 413        * have a per-protocol array of 4 elements like this:
 414        *   u8 offset; to take the byte from, off L4 header
 415        *   u8 mask; to mask it with, before storing
 416        *
 417        * this way we can describe UDP, TCP and ICMP[46] semantics,
 418        * and add a sort of FPM-type behavior for other protocols.
 419        *
 420        * Of course, is it faster ? and is it needed ?
 421        *
 422        */
 423     }
 424 }
 425
 426
 427 /* Session keys match the packets received, and mirror the packets sent */
 428 static void
 429 acl_make_5tuple_session_key (int is_input, fa_5tuple_t * p5tuple_pkt,
 430                              fa_5tuple_t * p5tuple_sess)
 431 {
 432   int src_index = is_input ? 0 : 1;
 433   int dst_index = is_input ? 1 : 0;
 434   p5tuple_sess->addr[src_index] = p5tuple_pkt->addr[0];
 435   p5tuple_sess->addr[dst_index] = p5tuple_pkt->addr[1];
 436   p5tuple_sess->l4.as_u64 = p5tuple_pkt->l4.as_u64;
 437   p5tuple_sess->l4.port[src_index] = p5tuple_pkt->l4.port[0];
 438   p5tuple_sess->l4.port[dst_index] = p5tuple_pkt->l4.port[1];
 439 }
 440
 441
 442 static int
 443 acl_fa_ifc_has_sessions (acl_main_t * am, int sw_if_index0)
 444 {
 445   int has_sessions =
 446     clib_bitmap_get (am->fa_sessions_on_sw_if_index, sw_if_index0);
 447   return has_sessions;
 448 }
 449
 450 static int
 451 acl_fa_ifc_has_in_acl (acl_main_t * am, int sw_if_index0)
 452 {
 453   int it_has = clib_bitmap_get (am->fa_in_acl_on_sw_if_index, sw_if_index0);
 454   return it_has;
 455 }
 456
 457 static int
 458 acl_fa_ifc_has_out_acl (acl_main_t * am, int sw_if_index0)
 459 {
 460   int it_has = clib_bitmap_get (am->fa_out_acl_on_sw_if_index, sw_if_index0);
 461   return it_has;
 462 }
 463
 464
 465 static int
 466 fa_session_get_timeout_type (acl_main_t * am, fa_session_t * sess)
 467 {
 468   /* seen both SYNs and ACKs but not FINs means we are in establshed state */
 469   u16 masked_flags =
 470     sess->tcp_flags_seen.as_u16 & ((TCP_FLAGS_RSTFINACKSYN << 8) +
 471                                    TCP_FLAGS_RSTFINACKSYN);
 472   switch (sess->info.l4.proto)
 473     {
 474     case IPPROTO_TCP:
 475       if (((TCP_FLAGS_ACKSYN << 8) + TCP_FLAGS_ACKSYN) == masked_flags)
 476         {
 477           return ACL_TIMEOUT_TCP_IDLE;
 478         }
 479       else
 480         {
 481           return ACL_TIMEOUT_TCP_TRANSIENT;
 482         }
 483       break;
 484     case IPPROTO_UDP:
 485       return ACL_TIMEOUT_UDP_IDLE;
 486       break;
 487     default:
 488       return ACL_TIMEOUT_UDP_IDLE;
 489     }
 490 }
 491
 492
 493 static u64
 494 fa_session_get_timeout (acl_main_t * am, fa_session_t * sess)
 495 {
 496   u64 timeout = am->vlib_main->clib_time.clocks_per_second;
 497   int timeout_type = fa_session_get_timeout_type (am, sess);
 498   timeout *= am->session_timeout_sec[timeout_type];
 499   return timeout;
 500 }
 501
 502 static void
 503 acl_fa_ifc_init_sessions (acl_main_t * am, int sw_if_index0)
 504 {
 505 #ifdef FA_NODE_VERBOSE_DEBUG
 506   clib_warning
 507     ("Initializing bihash for sw_if_index %d num buckets %lu memory size %llu",
 508      sw_if_index0, am->fa_conn_table_hash_num_buckets,
 509      am->fa_conn_table_hash_memory_size);
 510 #endif
 511   vec_validate (am->fa_sessions_by_sw_if_index, sw_if_index0);
 512   BV (clib_bihash_init) (&am->fa_sessions_by_sw_if_index
 513                          [sw_if_index0], "ACL plugin FA session bihash",
 514                          am->fa_conn_table_hash_num_buckets,
 515                          am->fa_conn_table_hash_memory_size);
 516   am->fa_sessions_on_sw_if_index =
 517     clib_bitmap_set (am->fa_sessions_on_sw_if_index, sw_if_index0, 1);
 518 }
 519
 520 static void
 521 acl_fa_conn_list_add_session (acl_main_t * am, u32 sess_id)
 522 {
 523   fa_session_t *sess = am->fa_sessions_pool + sess_id;
 524   u8 list_id = fa_session_get_timeout_type(am, sess);
 525   sess->link_list_id = list_id;
 526   sess->link_next_idx = ~0;
 527   sess->link_prev_idx = am->fa_conn_list_tail[list_id];
 528   if (~0 != am->fa_conn_list_tail[list_id]) {
 529     fa_session_t *prev_sess = am->fa_sessions_pool + am->fa_conn_list_tail[list_id];
 530     prev_sess->link_next_idx = sess_id;
 531   }
 532   am->fa_conn_list_tail[list_id] = sess_id;
 533
 534   if (~0 == am->fa_conn_list_head[list_id]) {
 535     am->fa_conn_list_head[list_id] = sess_id;
 536     /* If it is a first conn in any list, kick off the cleaner */
 537     vlib_process_signal_event (am->vlib_main, am->fa_cleaner_node_index,
 538                                  ACL_FA_CLEANER_RESCHEDULE, 0);
 539
 540   }
 541 }
 542
 543 static void
 544 acl_fa_conn_list_delete_session (acl_main_t *am, u32 sess_id)
 545 {
 546   fa_session_t *sess = am->fa_sessions_pool + sess_id;
 547   if (~0 != sess->link_prev_idx) {
 548     fa_session_t *prev_sess = am->fa_sessions_pool + sess->link_prev_idx;
 549     prev_sess->link_next_idx = sess->link_next_idx;
 550     if (prev_sess->link_list_id != sess->link_list_id)
 551       clib_warning("(prev_sess->link_list_id != sess->link_list_id)");
 552   }
 553   if (~0 != sess->link_next_idx) {
 554     fa_session_t *next_sess = am->fa_sessions_pool + sess->link_next_idx;
 555     next_sess->link_prev_idx = sess->link_prev_idx;
 556     if (next_sess->link_list_id != sess->link_list_id)
 557       clib_warning("(next_sess->link_list_id != sess->link_list_id)");
 558   }
 559   if (am->fa_conn_list_head[sess->link_list_id] == sess_id) {
 560     am->fa_conn_list_head[sess->link_list_id] = sess->link_next_idx;
 561   }
 562   if (am->fa_conn_list_tail[sess->link_list_id] == sess_id) {
 563     am->fa_conn_list_tail[sess->link_list_id] = sess->link_prev_idx;
 564   }
 565 }
 566
 567
 568 int
 569 acl_fa_session_is_dead (acl_main_t * am, u32 sw_if_index, u64 now,
 570                         u32 sess_id)
 571 {
 572   return 0;
 573 }
 574
 575 static void
 576 acl_fa_restart_timer_for_session (acl_main_t * am, u64 now, u32 sess_id)
 577 {
 578   // fa_session_t *sess = am->fa_sessions_pool + sess_id;
 579   acl_fa_conn_list_delete_session(am, sess_id);
 580   acl_fa_conn_list_add_session(am, sess_id);
 581 }
 582
 583
 584 static u8
 585 acl_fa_track_session (acl_main_t * am, int is_input, u32 sw_if_index, u64 now,
 586                       fa_session_t * sess, fa_5tuple_t * pkt_5tuple)
 587 {
 588   sess->last_active_time = now;
 589   if (pkt_5tuple->pkt.tcp_flags_valid)
 590     {
 591       sess->tcp_flags_seen.as_u8[is_input] |= pkt_5tuple->pkt.tcp_flags;
 592     }
 593   return 3;
 594 }
 595
 596
 597 static void
 598 acl_fa_delete_session (acl_main_t * am, u32 sw_if_index, u32 sess_id)
 599 {
 600   fa_session_t *sess = (fa_session_t *) am->fa_sessions_pool + sess_id;
 601   BV (clib_bihash_add_del) (&am->fa_sessions_by_sw_if_index[sw_if_index],
 602                             &sess->info.kv, 0);
 603   pool_put_index (am->fa_sessions_pool, sess_id);
 604   /* Deleting from timer wheel not needed, as the cleaner deals with the timers. */
 605   vec_validate (am->fa_session_dels_by_sw_if_index, sw_if_index);
 606   am->fa_session_dels_by_sw_if_index[sw_if_index]++;
 607 }
 608
 609 static int
 610 acl_fa_can_add_session (acl_main_t * am, int is_input, u32 sw_if_index)
 611 {
 612   u64 curr_sess;
 613   vec_validate (am->fa_session_adds_by_sw_if_index, sw_if_index);
 614   vec_validate (am->fa_session_dels_by_sw_if_index, sw_if_index);
 615   curr_sess =
 616     am->fa_session_adds_by_sw_if_index[sw_if_index] -
 617     am->fa_session_dels_by_sw_if_index[sw_if_index];
 618   return (curr_sess < am->fa_conn_table_max_entries);
 619 }
 620
 621 always_inline void
 622 acl_fa_try_recycle_session (acl_main_t * am, int is_input, u32 sw_if_index)
 623 {
 624   /* try to recycle a TCP transient session */
 625   u8 timeout_type = ACL_TIMEOUT_TCP_TRANSIENT;
 626   u32 sess_id = am->fa_conn_list_head[timeout_type];
 627   if (~0 != sess_id) {
 628     acl_fa_conn_list_delete_session(am, sess_id);
 629     acl_fa_delete_session(am, sw_if_index, sess_id);
 630   }
 631 }
 632
 633 static void
 634 acl_fa_add_session (acl_main_t * am, int is_input, u32 sw_if_index, u64 now,
 635                     fa_5tuple_t * p5tuple)
 636 {
 637   clib_bihash_kv_40_8_t *pkv = &p5tuple->kv;
 638   clib_bihash_kv_40_8_t kv;
 639   u32 sess_id;
 640   fa_session_t *sess;
 641
 642   pool_get (am->fa_sessions_pool, sess);
 643   sess_id = sess - am->fa_sessions_pool;
 644
 645
 646   kv.key[0] = pkv->key[0];
 647   kv.key[1] = pkv->key[1];
 648   kv.key[2] = pkv->key[2];
 649   kv.key[3] = pkv->key[3];
 650   kv.key[4] = pkv->key[4];
 651   kv.value = sess_id;
 652
 653   memcpy (sess, pkv, sizeof (pkv->key));
 654   sess->last_active_time = now;
 655   sess->sw_if_index = sw_if_index;
 656   sess->tcp_flags_seen.as_u16 = 0;
 657   sess->reserved1 = 0;
 658   sess->link_list_id = ~0;
 659   sess->link_prev_idx = ~0;
 660   sess->link_next_idx = ~0;
 661
 662
 663
 664   if (!acl_fa_ifc_has_sessions (am, sw_if_index))
 665     {
 666       acl_fa_ifc_init_sessions (am, sw_if_index);
 667     }
 668
 669   BV (clib_bihash_add_del) (&am->fa_sessions_by_sw_if_index[sw_if_index],
 670                             &kv, 1);
 671   acl_fa_conn_list_add_session(am, sess_id);
 672
 673   vec_validate (am->fa_session_adds_by_sw_if_index, sw_if_index);
 674   am->fa_session_adds_by_sw_if_index[sw_if_index]++;
 675 }
 676
 677 static int
 678 acl_fa_find_session (acl_main_t * am, u32 sw_if_index0, fa_5tuple_t * p5tuple,
 679                      clib_bihash_kv_40_8_t * pvalue_sess)
 680 {
 681   return (BV (clib_bihash_search)
 682           (&am->fa_sessions_by_sw_if_index[sw_if_index0], &p5tuple->kv,
 683            pvalue_sess) == 0);
 684 }
 685
 686
 687 always_inline uword
 688 acl_fa_node_fn (vlib_main_t * vm,
 689                 vlib_node_runtime_t * node, vlib_frame_t * frame, int is_ip6,
 690                 int is_input, int is_l2_path, u32 * l2_feat_next_node_index,
 691                 vlib_node_registration_t * acl_fa_node)
 692 {
 693   u32 n_left_from, *from, *to_next;
 694   acl_fa_next_t next_index;
 695   u32 pkts_acl_checked = 0;
 696   u32 pkts_new_session = 0;
 697   u32 pkts_exist_session = 0;
 698   u32 pkts_acl_permit = 0;
 699   u32 pkts_restart_session_timer = 0;
 700   u32 trace_bitmap = 0;
 701   u32 feature_bitmap0;
 702   acl_main_t *am = &acl_main;
 703   fa_5tuple_t fa_5tuple, kv_sess;
 704   clib_bihash_kv_40_8_t value_sess;
 705   vlib_node_runtime_t *error_node;
 706   u64 now = clib_cpu_time_now ();
 707
 708   from = vlib_frame_vector_args (frame);
 709   n_left_from = frame->n_vectors;
 710   next_index = node->cached_next_index;
 711
 712   error_node = vlib_node_get_runtime (vm, acl_fa_node->index);
 713
 714   while (n_left_from > 0)
 715     {
 716       u32 n_left_to_next;
 717
 718       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 719
 720       while (n_left_from > 0 && n_left_to_next > 0)
 721         {
 722           u32 bi0;
 723           vlib_buffer_t *b0;
 724           u32 next0 = 0;
 725           u8 action = 0;
 726           u32 sw_if_index0;
 727           int acl_check_needed = 1;
 728           u32 match_acl_in_index = ~0;
 729           u32 match_rule_index = ~0;
 730           u8 error0 = 0;
 731
 732           /* speculatively enqueue b0 to the current next frame */
 733           bi0 = from[0];
 734           to_next[0] = bi0;
 735           from += 1;
 736           to_next += 1;
 737           n_left_from -= 1;
 738           n_left_to_next -= 1;
 739
 740           b0 = vlib_get_buffer (vm, bi0);
 741
 742           if (is_input)
 743             sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
 744           else
 745             sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
 746           if (is_l2_path)
 747             feature_bitmap0 = vnet_buffer (b0)->l2.feature_bitmap;
 748
 749           /*
 750            * Extract the L3/L4 matching info into a 5-tuple structure,
 751            * then create a session key whose layout is independent on forward or reverse
 752            * direction of the packet.
 753            */
 754
 755           acl_fill_5tuple (am, b0, is_ip6, is_input, is_l2_path, &fa_5tuple);
 756           acl_make_5tuple_session_key (is_input, &fa_5tuple, &kv_sess);
 757 #ifdef FA_NODE_VERBOSE_DEBUG
 758           clib_warning
 759             ("ACL_FA_NODE_DBG: session 5-tuple %016llx %016llx %016llx %016llx %016llx : %016llx",
 760              kv_sess.kv.key[0], kv_sess.kv.key[1], kv_sess.kv.key[2],
 761              kv_sess.kv.key[3], kv_sess.kv.key[4], kv_sess.kv.value);
 762           clib_warning
 763             ("ACL_FA_NODE_DBG: packet 5-tuple %016llx %016llx %016llx %016llx %016llx : %016llx",
 764              fa_5tuple.kv.key[0], fa_5tuple.kv.key[1], fa_5tuple.kv.key[2],
 765              fa_5tuple.kv.key[3], fa_5tuple.kv.key[4], fa_5tuple.kv.value);
 766 #endif
 767
 768           /* Try to match an existing session first */
 769
 770           if (acl_fa_ifc_has_sessions (am, sw_if_index0))
 771             {
 772               if (acl_fa_find_session
 773                   (am, sw_if_index0, &kv_sess, &value_sess))
 774                 {
 775                   trace_bitmap |= 0x80000000;
 776                   error0 = ACL_FA_ERROR_ACL_EXIST_SESSION;
 777                   // FIXME assert(value_sess.value == (0xffffffff & value_sess.value));
 778                   u32 sess_id = value_sess.value;
 779                   fa_session_t *sess = am->fa_sessions_pool + sess_id;
 780                   int old_timeout_type =
 781                     fa_session_get_timeout_type (am, sess);
 782                   action =
 783                     acl_fa_track_session (am, is_input, sw_if_index0, now,
 784                                           sess, &fa_5tuple);
 785                   /* expose the session id to the tracer */
 786                   match_rule_index = sess_id;
 787                   int new_timeout_type =
 788                     fa_session_get_timeout_type (am, sess);
 789                   acl_check_needed = 0;
 790                   pkts_exist_session += 1;
 791                   /* Tracking might have changed the session timeout type, e.g. from transient to established */
 792                   if (PREDICT_FALSE (old_timeout_type != new_timeout_type))
 793                     {
 794                       acl_fa_restart_timer_for_session (am, now, sess_id);
 795                       pkts_restart_session_timer++;
 796                       trace_bitmap |=
 797                         0x00010000 + ((0xff & old_timeout_type) << 8) +
 798                         (0xff & new_timeout_type);
 799                     }
 800                 }
 801             }
 802
 803           if (acl_check_needed)
 804             {
 805               action =
 806                 full_acl_match_5tuple (sw_if_index0, &fa_5tuple, is_l2_path,
 807                                        is_ip6, is_input, &match_acl_in_index,
 808                                        &match_rule_index, &trace_bitmap);
 809               error0 = action;
 810               if (1 == action)
 811                 pkts_acl_permit += 1;
 812               if (2 == action)
 813                 {
 814                   if (!acl_fa_can_add_session (am, is_input, sw_if_index0))
 815                     acl_fa_try_recycle_session (am, is_input, sw_if_index0);
 816
 817                   if (acl_fa_can_add_session (am, is_input, sw_if_index0))
 818                     {
 819                       acl_fa_add_session (am, is_input, sw_if_index0, now,
 820                                           &kv_sess);
 821                       pkts_new_session += 1;
 822                     }
 823                   else
 824                     {
 825                       action = 0;
 826                       error0 = ACL_FA_ERROR_ACL_TOO_MANY_SESSIONS;
 827                     }
 828                 }
 829             }
 830
 831
 832
 833           if (action > 0)
 834             {
 835               if (is_l2_path)
 836                 next0 =
 837                   feat_bitmap_get_next_node_index (l2_feat_next_node_index,
 838                                                    feature_bitmap0);
 839               else
 840                 vnet_feature_next (sw_if_index0, &next0, b0);
 841             }
 842
 843           if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
 844                              && (b0->flags & VLIB_BUFFER_IS_TRACED)))
 845             {
 846               acl_fa_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
 847               t->sw_if_index = sw_if_index0;
 848               t->next_index = next0;
 849               t->match_acl_in_index = match_acl_in_index;
 850               t->match_rule_index = match_rule_index;
 851               t->packet_info[0] = fa_5tuple.kv.key[0];
 852               t->packet_info[1] = fa_5tuple.kv.key[1];
 853               t->packet_info[2] = fa_5tuple.kv.key[2];
 854               t->packet_info[3] = fa_5tuple.kv.key[3];
 855               t->packet_info[4] = fa_5tuple.kv.key[4];
 856               t->packet_info[5] = fa_5tuple.kv.value;
 857               t->action = action;
 858               t->trace_bitmap = trace_bitmap;
 859             }
 860
 861           next0 = next0 < node->n_next_nodes ? next0 : 0;
 862           if (0 == next0)
 863             b0->error = error_node->errors[error0];
 864
 865           pkts_acl_checked += 1;
 866
 867           /* verify speculative enqueue, maybe switch current next frame */
 868           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 869                                            to_next, n_left_to_next, bi0,
 870                                            next0);
 871         }
 872
 873       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 874     }
 875
 876   vlib_node_increment_counter (vm, acl_fa_node->index,
 877                                ACL_FA_ERROR_ACL_CHECK, pkts_acl_checked);
 878   vlib_node_increment_counter (vm, acl_fa_node->index,
 879                                ACL_FA_ERROR_ACL_PERMIT, pkts_acl_permit);
 880   vlib_node_increment_counter (vm, acl_fa_node->index,
 881                                ACL_FA_ERROR_ACL_NEW_SESSION,
 882                                pkts_new_session);
 883   vlib_node_increment_counter (vm, acl_fa_node->index,
 884                                ACL_FA_ERROR_ACL_EXIST_SESSION,
 885                                pkts_exist_session);
 886   vlib_node_increment_counter (vm, acl_fa_node->index,
 887                                ACL_FA_ERROR_ACL_RESTART_SESSION_TIMER,
 888                                pkts_restart_session_timer);
 889   return frame->n_vectors;
 890 }
 891
 892
 893 vlib_node_registration_t acl_in_l2_ip6_node;
 894 static uword
 895 acl_in_ip6_l2_node_fn (vlib_main_t * vm,
 896                        vlib_node_runtime_t * node, vlib_frame_t * frame)
 897 {
 898   acl_main_t *am = &acl_main;
 899   return acl_fa_node_fn (vm, node, frame, 1, 1, 1,
 900                          am->fa_acl_in_ip6_l2_node_feat_next_node_index,
 901                          &acl_in_l2_ip6_node);
 902 }
 903
 904 vlib_node_registration_t acl_in_l2_ip4_node;
 905 static uword
 906 acl_in_ip4_l2_node_fn (vlib_main_t * vm,
 907                        vlib_node_runtime_t * node, vlib_frame_t * frame)
 908 {
 909   acl_main_t *am = &acl_main;
 910   return acl_fa_node_fn (vm, node, frame, 0, 1, 1,
 911                          am->fa_acl_in_ip4_l2_node_feat_next_node_index,
 912                          &acl_in_l2_ip4_node);
 913 }
 914
 915 vlib_node_registration_t acl_out_l2_ip6_node;
 916 static uword
 917 acl_out_ip6_l2_node_fn (vlib_main_t * vm,
 918                         vlib_node_runtime_t * node, vlib_frame_t * frame)
 919 {
 920   acl_main_t *am = &acl_main;
 921   return acl_fa_node_fn (vm, node, frame, 1, 0, 1,
 922                          am->fa_acl_out_ip6_l2_node_feat_next_node_index,
 923                          &acl_out_l2_ip6_node);
 924 }
 925
 926 vlib_node_registration_t acl_out_l2_ip4_node;
 927 static uword
 928 acl_out_ip4_l2_node_fn (vlib_main_t * vm,
 929                         vlib_node_runtime_t * node, vlib_frame_t * frame)
 930 {
 931   acl_main_t *am = &acl_main;
 932   return acl_fa_node_fn (vm, node, frame, 0, 0, 1,
 933                          am->fa_acl_out_ip4_l2_node_feat_next_node_index,
 934                          &acl_out_l2_ip4_node);
 935 }
 936
 937
 938 /**** L3 processing path nodes ****/
 939
 940
 941 vlib_node_registration_t acl_in_fa_ip6_node;
 942 static uword
 943 acl_in_ip6_fa_node_fn (vlib_main_t * vm,
 944                        vlib_node_runtime_t * node, vlib_frame_t * frame)
 945 {
 946   return acl_fa_node_fn (vm, node, frame, 1, 1, 0, 0, &acl_in_fa_ip6_node);
 947 }
 948
 949 vlib_node_registration_t acl_in_fa_ip4_node;
 950 static uword
 951 acl_in_ip4_fa_node_fn (vlib_main_t * vm,
 952                        vlib_node_runtime_t * node, vlib_frame_t * frame)
 953 {
 954   return acl_fa_node_fn (vm, node, frame, 0, 1, 0, 0, &acl_in_fa_ip4_node);
 955 }
 956
 957 vlib_node_registration_t acl_out_fa_ip6_node;
 958 static uword
 959 acl_out_ip6_fa_node_fn (vlib_main_t * vm,
 960                         vlib_node_runtime_t * node, vlib_frame_t * frame)
 961 {
 962   return acl_fa_node_fn (vm, node, frame, 1, 0, 0, 0, &acl_out_fa_ip6_node);
 963 }
 964
 965 vlib_node_registration_t acl_out_fa_ip4_node;
 966 static uword
 967 acl_out_ip4_fa_node_fn (vlib_main_t * vm,
 968                         vlib_node_runtime_t * node, vlib_frame_t * frame)
 969 {
 970   return acl_fa_node_fn (vm, node, frame, 0, 0, 0, 0, &acl_out_fa_ip4_node);
 971 }
 972
 973 /*
 974  * This process performs all the connection clean up - both for idle connections,
 975  * as well as receiving the signals to clean up the connections in case of sw_if_index deletion,
 976  * or (maybe in the future) the connection deletion due to policy reasons.
 977  *
 978  * The previous iteration (l2sess) attempted to clean up the connections in small increments,
 979  * in-band, but the problem it tried to preemptively address (process starvation) is yet to be seen.
 980  *
 981  * The approach with a single thread deleting the connections is simpler, thus we use it until
 982  * there is a real starvation problem to solve.
 983  *
 984  */
 985
 986
 987 /* *INDENT-OFF* */
 988 #define foreach_acl_fa_cleaner_error \
 989 _(UNKNOWN_EVENT, "unknown event received")  \
 990 /* end  of errors */
 991
 992 typedef enum
 993 {
 994 #define _(sym,str) ACL_FA_CLEANER_ERROR_##sym,
 995   foreach_acl_fa_cleaner_error
 996 #undef _
 997     ACL_FA_CLEANER_N_ERROR,
 998 } acl_fa_cleaner_error_t;
 999
1000 static char *acl_fa_cleaner_error_strings[] = {
1001 #define _(sym,string) string,
1002   foreach_acl_fa_cleaner_error
1003 #undef _
1004 };
1005
1006 static int
1007 acl_fa_clean_sessions_by_sw_if_index (acl_main_t *am, u32 sw_if_index, u32 *count)
1008 {
1009
1010   int undeleted = 0;
1011   fa_session_t *sess;
1012   uword *dv = NULL;
1013   uword *ii;
1014
1015   pool_foreach(sess, am->fa_sessions_pool, ({
1016     if ( (~0 == sw_if_index) || (sw_if_index == sess->sw_if_index) )
1017       vec_add1(dv, sess-am->fa_sessions_pool);
1018   }));
1019   vec_foreach(ii, dv)
1020   {
1021     sess =  pool_elt_at_index(am->fa_sessions_pool, *ii);
1022     acl_fa_delete_session(am, sess->sw_if_index, *ii);
1023     (*count)++;
1024   }
1025
1026   pool_foreach(sess, am->fa_sessions_pool, ({
1027     if ( (~0 == sw_if_index) || (sw_if_index == sess->sw_if_index) )
1028       undeleted++;
1029   }));
1030   if (undeleted == 0)
1031     {
1032       if (~0 == sw_if_index)
1033         {
1034           /* FIXME: clean-up tables ? */
1035         }
1036       else
1037         {
1038           /* FIXME: clean-up tables ? */
1039         }
1040     }
1041   return (undeleted == 0);
1042 }
1043 /* *INDENT-ON* */
1044
1045 static vlib_node_registration_t acl_fa_session_cleaner_process_node;
1046
1047 static int
1048 acl_fa_conn_has_timed_out (acl_main_t *am, u64 now, u32 session_index)
1049 {
1050   fa_session_t *sess = am->fa_sessions_pool + session_index;
1051   u64 sess_timeout_time =
1052               sess->last_active_time + fa_session_get_timeout (am, sess);
1053   return (sess_timeout_time < now);
1054 }
1055
1056
1057 static uword
1058 acl_fa_session_cleaner_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1059                                 vlib_frame_t * f)
1060 {
1061   acl_main_t *am = &acl_main;
1062   u64 now = clib_cpu_time_now ();
1063   f64 cpu_cps = vm->clib_time.clocks_per_second;
1064   u64 next_expire;
1065   /* We should call timer wheel at least twice a second */
1066   u64 max_timer_wait_interval = cpu_cps / 2;
1067   am->fa_current_cleaner_timer_wait_interval = max_timer_wait_interval;
1068
1069   u32 *expired = NULL;
1070   uword event_type, *event_data = 0;
1071
1072   am->fa_cleaner_node_index = acl_fa_session_cleaner_process_node.index;
1073
1074   while (1)
1075     {
1076       u32 count_deleted_sessions = 0;
1077       u32 count_already_deleted = 0;
1078       now = clib_cpu_time_now ();
1079       next_expire = now + am->fa_current_cleaner_timer_wait_interval;
1080       int has_pending_conns = 0;
1081       u8 tt;
1082       for(tt = 0; tt < ACL_N_TIMEOUTS; tt++)
1083         {
1084           if (~0 != am->fa_conn_list_head[tt])
1085             has_pending_conns = 1;
1086         }
1087
1088       /* If no pending connections then no point in timing out */
1089       if (!has_pending_conns)
1090         {
1091           am->fa_cleaner_cnt_wait_without_timeout++;
1092           (void) vlib_process_wait_for_event (vm);
1093           event_type = vlib_process_get_events (vm, &event_data);
1094         }
1095       else
1096         {
1097           f64 timeout = ((i64) next_expire - (i64) now) / cpu_cps;
1098           if (timeout <= 0)
1099             {
1100               /* skip waiting altogether */
1101               event_type = ~0;
1102             }
1103           else
1104             {
1105               /* Timing wheel code is happier if it is called regularly */
1106               if (timeout > 0.5)
1107                 timeout = 0.5;
1108               am->fa_cleaner_cnt_wait_with_timeout++;
1109               (void) vlib_process_wait_for_event_or_clock (vm, timeout);
1110               event_type = vlib_process_get_events (vm, &event_data);
1111             }
1112         }
1113
1114       now = clib_cpu_time_now ();
1115       switch (event_type)
1116         {
1117         case ~0:
1118           /* nothing to do */
1119           break;
1120         case ACL_FA_CLEANER_RESCHEDULE:
1121           /* Nothing to do. */
1122           break;
1123         case ACL_FA_CLEANER_DELETE_BY_SW_IF_INDEX:
1124           {
1125             uword *sw_if_index0;
1126             vec_foreach (sw_if_index0, event_data)
1127             {
1128               am->fa_cleaner_cnt_delete_by_sw_index++;
1129 #ifdef FA_NODE_VERBOSE_DEBUG
1130               clib_warning
1131                 ("ACL_FA_NODE_CLEAN: ACL_FA_CLEANER_DELETE_BY_SW_IF_INDEX: %d",
1132                  *sw_if_index0);
1133 #endif
1134               u32 count = 0;
1135               int result =
1136                 acl_fa_clean_sessions_by_sw_if_index (am, *sw_if_index0,
1137                                                       &count);
1138               count_deleted_sessions += count;
1139               am->fa_cleaner_cnt_delete_by_sw_index_ok += result;
1140             }
1141           }
1142           break;
1143         default:
1144 #ifdef FA_NODE_VERBOSE_DEBUG
1145           clib_warning ("ACL plugin connection cleaner: unknown event %u",
1146                         event_type);
1147 #endif
1148           vlib_node_increment_counter (vm,
1149                                        acl_fa_session_cleaner_process_node.
1150                                        index,
1151                                        ACL_FA_CLEANER_ERROR_UNKNOWN_EVENT, 1);
1152           am->fa_cleaner_cnt_unknown_event++;
1153           break;
1154         }
1155
1156       {
1157         u8 tt = 0;
1158         for(tt = 0; tt < ACL_N_TIMEOUTS; tt++) {
1159           while((vec_len(expired) < 2*am->fa_max_deleted_sessions_per_interval)
1160                 && (~0 != am->fa_conn_list_head[tt])
1161                 && (acl_fa_conn_has_timed_out(am, now,
1162                                               am->fa_conn_list_head[tt]))) {
1163             u32 sess_id = am->fa_conn_list_head[tt];
1164             vec_add1(expired, sess_id);
1165             acl_fa_conn_list_delete_session(am, sess_id);
1166           }
1167         }
1168       }
1169
1170       u32 *psid = NULL;
1171       vec_foreach (psid, expired)
1172       {
1173         u32 session_index = *psid;
1174         if (!pool_is_free_index (am->fa_sessions_pool, session_index))
1175           {
1176             fa_session_t *sess = am->fa_sessions_pool + session_index;
1177             u32 sw_if_index = sess->sw_if_index;
1178             u64 sess_timeout_time =
1179               sess->last_active_time + fa_session_get_timeout (am, sess);
1180             if (now < sess_timeout_time)
1181               {
1182                 /* clib_warning ("ACL_FA_NODE_CLEAN: Restarting timer for session %d",
1183                    (int) session_index); */
1184
1185                 /* There was activity on the session, so the idle timeout
1186                    has not passed. Enqueue for another time period. */
1187
1188                 acl_fa_conn_list_add_session(am, session_index);
1189
1190                 /* FIXME: When/if moving to timer wheel,
1191                    pretend we did this in the past,
1192                    at last_active moment, so the timer is accurate */
1193                 am->fa_cleaner_cnt_timer_restarted++;
1194               }
1195             else
1196               {
1197                 /* clib_warning ("ACL_FA_NODE_CLEAN: Deleting session %d",
1198                    (int) session_index); */
1199                 acl_fa_delete_session (am, sw_if_index, session_index);
1200                 count_deleted_sessions++;
1201               }
1202           }
1203         else
1204           {
1205             count_already_deleted++;
1206           }
1207       }
1208       if (expired)
1209         _vec_len (expired) = 0;
1210       if (event_data)
1211         _vec_len (event_data) = 0;
1212
1213       if (count_deleted_sessions > am->fa_max_deleted_sessions_per_interval) {
1214         /* if there was too many sessions to delete, do less waiting around next time */
1215         am->fa_current_cleaner_timer_wait_interval /= 2;
1216       } else if (count_deleted_sessions < am->fa_min_deleted_sessions_per_interval) {
1217         /* Too few deleted sessions, slowly increase the amount of sleep up to a limit */
1218         if (am->fa_current_cleaner_timer_wait_interval < max_timer_wait_interval)
1219           am->fa_current_cleaner_timer_wait_interval += cpu_cps * am->fa_cleaner_wait_time_increment;
1220       }
1221       am->fa_cleaner_cnt_event_cycles++;
1222       am->fa_cleaner_cnt_deleted_sessions += count_deleted_sessions;
1223       am->fa_cleaner_cnt_already_deleted += count_already_deleted;
1224     }
1225   /* NOT REACHED */
1226   return 0;
1227 }
1228
1229
1230 void
1231 acl_fa_enable_disable (u32 sw_if_index, int is_input, int enable_disable)
1232 {
1233   acl_main_t *am = &acl_main;
1234   if (is_input)
1235     {
1236       vnet_feature_enable_disable ("ip4-unicast", "acl-plugin-in-ip4-fa",
1237                                    sw_if_index, enable_disable, 0, 0);
1238       vnet_feature_enable_disable ("ip6-unicast", "acl-plugin-in-ip6-fa",
1239                                    sw_if_index, enable_disable, 0, 0);
1240       am->fa_in_acl_on_sw_if_index =
1241         clib_bitmap_set (am->fa_in_acl_on_sw_if_index, sw_if_index,
1242                          enable_disable);
1243     }
1244   else
1245     {
1246       vnet_feature_enable_disable ("ip4-output", "acl-plugin-out-ip4-fa",
1247                                    sw_if_index, enable_disable, 0, 0);
1248       vnet_feature_enable_disable ("ip6-output", "acl-plugin-out-ip6-fa",
1249                                    sw_if_index, enable_disable, 0, 0);
1250       am->fa_out_acl_on_sw_if_index =
1251         clib_bitmap_set (am->fa_out_acl_on_sw_if_index, sw_if_index,
1252                          enable_disable);
1253     }
1254   if ((!enable_disable) && (!acl_fa_ifc_has_in_acl (am, sw_if_index))
1255       && (!acl_fa_ifc_has_out_acl (am, sw_if_index)))
1256     {
1257       vlib_process_signal_event (am->vlib_main, am->fa_cleaner_node_index,
1258                                  ACL_FA_CLEANER_DELETE_BY_SW_IF_INDEX,
1259                                  sw_if_index);
1260     }
1261 }
1262
1263
1264
1265 /* *INDENT-OFF* */
1266
1267
1268 VLIB_REGISTER_NODE (acl_fa_session_cleaner_process_node, static) = {
1269   .function = acl_fa_session_cleaner_process,
1270   .type = VLIB_NODE_TYPE_PROCESS,
1271   .name = "acl-plugin-fa-cleaner-process",
1272   .n_errors = ARRAY_LEN (acl_fa_cleaner_error_strings),
1273   .error_strings = acl_fa_cleaner_error_strings,
1274   .n_next_nodes = 0,
1275   .next_nodes = {},
1276 };
1277
1278
1279 VLIB_REGISTER_NODE (acl_in_l2_ip6_node) =
1280 {
1281   .function = acl_in_ip6_l2_node_fn,
1282   .name = "acl-plugin-in-ip6-l2",
1283   .vector_size = sizeof (u32),
1284   .format_trace = format_acl_fa_trace,
1285   .type = VLIB_NODE_TYPE_INTERNAL,
1286   .n_errors = ARRAY_LEN (acl_fa_error_strings),
1287   .error_strings = acl_fa_error_strings,
1288   .n_next_nodes = ACL_FA_N_NEXT,
1289   .next_nodes =
1290   {
1291     [ACL_FA_ERROR_DROP] = "error-drop",
1292   }
1293 };
1294
1295 VLIB_REGISTER_NODE (acl_in_l2_ip4_node) =
1296 {
1297   .function = acl_in_ip4_l2_node_fn,
1298   .name = "acl-plugin-in-ip4-l2",
1299   .vector_size = sizeof (u32),
1300   .format_trace = format_acl_fa_trace,
1301   .type = VLIB_NODE_TYPE_INTERNAL,
1302   .n_errors = ARRAY_LEN (acl_fa_error_strings),
1303   .error_strings = acl_fa_error_strings,
1304   .n_next_nodes = ACL_FA_N_NEXT,
1305   .next_nodes =
1306   {
1307     [ACL_FA_ERROR_DROP] = "error-drop",
1308   }
1309 };
1310
1311 VLIB_REGISTER_NODE (acl_out_l2_ip6_node) =
1312 {
1313   .function = acl_out_ip6_l2_node_fn,
1314   .name = "acl-plugin-out-ip6-l2",
1315   .vector_size = sizeof (u32),
1316   .format_trace = format_acl_fa_trace,
1317   .type = VLIB_NODE_TYPE_INTERNAL,
1318   .n_errors = ARRAY_LEN (acl_fa_error_strings),
1319   .error_strings = acl_fa_error_strings,
1320   .n_next_nodes = ACL_FA_N_NEXT,
1321   .next_nodes =
1322   {
1323     [ACL_FA_ERROR_DROP] = "error-drop",
1324   }
1325 };
1326
1327 VLIB_REGISTER_NODE (acl_out_l2_ip4_node) =
1328 {
1329   .function = acl_out_ip4_l2_node_fn,
1330   .name = "acl-plugin-out-ip4-l2",
1331   .vector_size = sizeof (u32),
1332   .format_trace = format_acl_fa_trace,
1333   .type = VLIB_NODE_TYPE_INTERNAL,
1334   .n_errors = ARRAY_LEN (acl_fa_error_strings),
1335   .error_strings = acl_fa_error_strings,
1336   .n_next_nodes = ACL_FA_N_NEXT,
1337   .next_nodes =
1338   {
1339     [ACL_FA_ERROR_DROP] = "error-drop",
1340   }
1341 };
1342
1343
1344 VLIB_REGISTER_NODE (acl_in_fa_ip6_node) =
1345 {
1346   .function = acl_in_ip6_fa_node_fn,
1347   .name = "acl-plugin-in-ip6-fa",
1348   .vector_size = sizeof (u32),
1349   .format_trace = format_acl_fa_trace,
1350   .type = VLIB_NODE_TYPE_INTERNAL,
1351   .n_errors = ARRAY_LEN (acl_fa_error_strings),
1352   .error_strings = acl_fa_error_strings,
1353   .n_next_nodes = ACL_FA_N_NEXT,
1354   .next_nodes =
1355   {
1356     [ACL_FA_ERROR_DROP] = "error-drop",
1357   }
1358 };
1359
1360 VNET_FEATURE_INIT (acl_in_ip6_fa_feature, static) =
1361 {
1362   .arc_name = "ip6-unicast",
1363   .node_name = "acl-plugin-in-ip6-fa",
1364   .runs_before = VNET_FEATURES ("ip6-flow-classify"),
1365 };
1366
1367 VLIB_REGISTER_NODE (acl_in_fa_ip4_node) =
1368 {
1369   .function = acl_in_ip4_fa_node_fn,
1370   .name = "acl-plugin-in-ip4-fa",
1371   .vector_size = sizeof (u32),
1372   .format_trace = format_acl_fa_trace,
1373   .type = VLIB_NODE_TYPE_INTERNAL,
1374   .n_errors = ARRAY_LEN (acl_fa_error_strings),
1375   .error_strings = acl_fa_error_strings,
1376   .n_next_nodes = ACL_FA_N_NEXT,
1377   .next_nodes =
1378   {
1379     [ACL_FA_ERROR_DROP] = "error-drop",
1380   }
1381 };
1382
1383 VNET_FEATURE_INIT (acl_in_ip4_fa_feature, static) =
1384 {
1385   .arc_name = "ip4-unicast",
1386   .node_name = "acl-plugin-in-ip4-fa",
1387   .runs_before = VNET_FEATURES ("ip4-flow-classify"),
1388 };
1389
1390
1391 VLIB_REGISTER_NODE (acl_out_fa_ip6_node) =
1392 {
1393   .function = acl_out_ip6_fa_node_fn,
1394   .name = "acl-plugin-out-ip6-fa",
1395   .vector_size = sizeof (u32),
1396   .format_trace = format_acl_fa_trace,
1397   .type = VLIB_NODE_TYPE_INTERNAL,
1398   .n_errors = ARRAY_LEN (acl_fa_error_strings),
1399   .error_strings = acl_fa_error_strings,
1400   .n_next_nodes = ACL_FA_N_NEXT,
1401   .next_nodes =
1402   {
1403     [ACL_FA_ERROR_DROP] = "error-drop",
1404   }
1405 };
1406
1407 VNET_FEATURE_INIT (acl_out_ip6_fa_feature, static) =
1408 {
1409   .arc_name = "ip6-output",
1410   .node_name = "acl-plugin-out-ip6-fa",
1411   .runs_before = VNET_FEATURES ("interface-output"),
1412 };
1413
1414 VLIB_REGISTER_NODE (acl_out_fa_ip4_node) =
1415 {
1416   .function = acl_out_ip4_fa_node_fn,
1417   .name = "acl-plugin-out-ip4-fa",
1418   .vector_size = sizeof (u32),
1419   .format_trace = format_acl_fa_trace,
1420   .type = VLIB_NODE_TYPE_INTERNAL,
1421   .n_errors = ARRAY_LEN (acl_fa_error_strings),
1422   .error_strings = acl_fa_error_strings,
1423   .n_next_nodes = ACL_FA_N_NEXT,
1424     /* edit / add dispositions here */
1425   .next_nodes =
1426   {
1427     [ACL_FA_ERROR_DROP] = "error-drop",
1428   }
1429 };
1430
1431 VNET_FEATURE_INIT (acl_out_ip4_fa_feature, static) =
1432 {
1433   .arc_name = "ip4-output",
1434   .node_name = "acl-plugin-out-ip4-fa",
1435   .runs_before = VNET_FEATURES ("interface-output"),
1436 };
1437
1438
1439 /* *INDENT-ON* */