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