src/plugins/acl/sess_mgmt_node.c

   1 /*
   2  * Copyright (c) 2016-2018 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
  23
  24 #include <acl/acl.h>
  25 #include <vnet/ip/icmp46_packet.h>
  26
  27 #include <plugins/acl/fa_node.h>
  28 #include <plugins/acl/acl.h>
  29 #include <plugins/acl/lookup_context.h>
  30 #include <plugins/acl/public_inlines.h>
  31 #include <plugins/acl/session_inlines.h>
  32
  33
  34
  35 static_always_inline u8 *
  36 format_ip46_session_bihash_kv (u8 * s, va_list * args, int is_ip6)
  37 {
  38   fa_5tuple_t a5t;
  39   void *paddr0;
  40   void *paddr1;
  41   void *format_addr_func;
  42
  43   if (is_ip6)
  44     {
  45       clib_bihash_kv_40_8_t *kv_40_8 =
  46         va_arg (*args, clib_bihash_kv_40_8_t *);
  47       a5t.kv_40_8 = *kv_40_8;
  48       paddr0 = &a5t.ip6_addr[0];
  49       paddr1 = &a5t.ip6_addr[1];
  50       format_addr_func = format_ip6_address;
  51     }
  52   else
  53     {
  54       clib_bihash_kv_16_8_t *kv_16_8 =
  55         va_arg (*args, clib_bihash_kv_16_8_t *);
  56       a5t.kv_16_8 = *kv_16_8;
  57       paddr0 = &a5t.ip4_addr[0];
  58       paddr1 = &a5t.ip4_addr[1];
  59       format_addr_func = format_ip4_address;
  60     }
  61
  62   fa_full_session_id_t *sess = (fa_full_session_id_t *) & a5t.pkt;
  63
  64   return (format (s, "l3 %U -> %U %U | sess id %d thread id %d epoch %04x",
  65                   format_addr_func, paddr0,
  66                   format_addr_func, paddr1,
  67                   format_fa_session_l4_key, &a5t.l4,
  68                   sess->session_index, sess->thread_index,
  69                   sess->intf_policy_epoch));
  70 }
  71
  72 static u8 *
  73 format_ip6_session_bihash_kv (u8 * s, va_list * args)
  74 {
  75   return format_ip46_session_bihash_kv (s, args, 1);
  76 }
  77
  78 static u8 *
  79 format_ip4_session_bihash_kv (u8 * s, va_list * args)
  80 {
  81   return format_ip46_session_bihash_kv (s, args, 0);
  82 }
  83
  84
  85 static void
  86 acl_fa_verify_init_sessions (acl_main_t * am)
  87 {
  88   if (!am->fa_sessions_hash_is_initialized)
  89     {
  90       u16 wk;
  91       /* Allocate the per-worker sessions pools */
  92       for (wk = 0; wk < vec_len (am->per_worker_data); wk++)
  93         {
  94           acl_fa_per_worker_data_t *pw = &am->per_worker_data[wk];
  95
  96           /*
  97            * // In lieu of trying to preallocate the pool and its free bitmap, rather use pool_init_fixed
  98            * pool_alloc_aligned(pw->fa_sessions_pool, am->fa_conn_table_max_entries, CLIB_CACHE_LINE_BYTES);
  99            * clib_bitmap_validate(pool_header(pw->fa_sessions_pool)->free_bitmap, am->fa_conn_table_max_entries);
 100            */
 101           pool_init_fixed (pw->fa_sessions_pool,
 102                            am->fa_conn_table_max_entries);
 103         }
 104
 105       /* ... and the interface session hash table */
 106       clib_bihash_init_40_8 (&am->fa_ip6_sessions_hash,
 107                              "ACL plugin FA IPv6 session bihash",
 108                              am->fa_conn_table_hash_num_buckets,
 109                              am->fa_conn_table_hash_memory_size);
 110       clib_bihash_set_kvp_format_fn_40_8 (&am->fa_ip6_sessions_hash,
 111                                           format_ip6_session_bihash_kv);
 112
 113       clib_bihash_init_16_8 (&am->fa_ip4_sessions_hash,
 114                              "ACL plugin FA IPv4 session bihash",
 115                              am->fa_conn_table_hash_num_buckets,
 116                              am->fa_conn_table_hash_memory_size);
 117       clib_bihash_set_kvp_format_fn_16_8 (&am->fa_ip4_sessions_hash,
 118                                           format_ip4_session_bihash_kv);
 119
 120       am->fa_sessions_hash_is_initialized = 1;
 121     }
 122 }
 123
 124
 125 /*
 126  * Get the timeout of the session in a list since its enqueue time.
 127  */
 128
 129 static u64
 130 fa_session_get_list_timeout (acl_main_t * am, fa_session_t * sess)
 131 {
 132   u64 timeout = am->vlib_main->clib_time.clocks_per_second / 1000;
 133   timeout = fa_session_get_timeout (am, sess);
 134   /* for all user lists, check them twice per timeout */
 135   timeout >>= (sess->link_list_id != ACL_TIMEOUT_PURGATORY);
 136   return timeout;
 137 }
 138
 139 static u64
 140 acl_fa_get_list_head_expiry_time (acl_main_t * am,
 141                                   acl_fa_per_worker_data_t * pw, u64 now,
 142                                   u16 thread_index, int timeout_type)
 143 {
 144   return pw->fa_conn_list_head_expiry_time[timeout_type];
 145 }
 146
 147 static int
 148 acl_fa_conn_time_to_check (acl_main_t * am, acl_fa_per_worker_data_t * pw,
 149                            u64 now, u16 thread_index, u32 session_index)
 150 {
 151   if (session_index == FA_SESSION_BOGUS_INDEX)
 152     return 0;
 153   fa_session_t *sess = get_session_ptr (am, thread_index, session_index);
 154   u64 timeout_time =
 155     sess->link_enqueue_time + fa_session_get_list_timeout (am, sess);
 156   return (timeout_time < now)
 157     || (sess->link_enqueue_time <= pw->swipe_end_time);
 158 }
 159
 160 /*
 161  * see if there are sessions ready to be checked,
 162  * do the maintenance (requeue or delete), and
 163  * return the total number of sessions reclaimed.
 164  */
 165 static int
 166 acl_fa_check_idle_sessions (acl_main_t * am, u16 thread_index, u64 now)
 167 {
 168   acl_fa_per_worker_data_t *pw = &am->per_worker_data[thread_index];
 169   fa_full_session_id_t fsid;
 170   fsid.thread_index = thread_index;
 171   int total_expired = 0;
 172
 173   /* let the other threads enqueue more requests while we process, if they like */
 174   aclp_swap_wip_and_pending_session_change_requests (am, thread_index);
 175   u64 *psr = NULL;
 176
 177   vec_foreach (psr, pw->wip_session_change_requests)
 178   {
 179     acl_fa_sess_req_t op = *psr >> 32;
 180     fsid.session_index = *psr & 0xffffffff;
 181     switch (op)
 182       {
 183       case ACL_FA_REQ_SESS_RESCHEDULE:
 184         acl_fa_restart_timer_for_session (am, now, fsid);
 185         break;
 186       default:
 187         /* do nothing */
 188         break;
 189       }
 190   }
 191   if (pw->wip_session_change_requests)
 192     _vec_len (pw->wip_session_change_requests) = 0;
 193
 194
 195   {
 196     u8 tt = 0;
 197     int n_pending_swipes = 0;
 198     for (tt = 0; tt < ACL_N_TIMEOUTS; tt++)
 199       {
 200         int n_expired = 0;
 201         while (n_expired < am->fa_max_deleted_sessions_per_interval)
 202           {
 203             fsid.session_index = pw->fa_conn_list_head[tt];
 204             if (!acl_fa_conn_time_to_check
 205                 (am, pw, now, thread_index, pw->fa_conn_list_head[tt]))
 206               {
 207                 break;
 208               }
 209             if (am->trace_sessions > 3)
 210               {
 211                 elog_acl_maybe_trace_X3 (am,
 212                                          "acl_fa_check_idle_sessions: expire session %d in list %d on thread %d",
 213                                          "i4i4i4", (u32) fsid.session_index,
 214                                          (u32) tt, (u32) thread_index);
 215               }
 216             vec_add1 (pw->expired, fsid.session_index);
 217             n_expired++;
 218             acl_fa_conn_list_delete_session (am, fsid, now);
 219           }
 220       }
 221     for (tt = 0; tt < ACL_N_TIMEOUTS; tt++)
 222       {
 223         u32 session_index = pw->fa_conn_list_head[tt];
 224         if (session_index == FA_SESSION_BOGUS_INDEX)
 225           break;
 226         fa_session_t *sess =
 227           get_session_ptr (am, thread_index, session_index);
 228         n_pending_swipes += sess->link_enqueue_time <= pw->swipe_end_time;
 229       }
 230     if (n_pending_swipes == 0)
 231       {
 232         pw->swipe_end_time = 0;
 233       }
 234   }
 235
 236   u32 *psid = NULL;
 237   vec_foreach (psid, pw->expired)
 238   {
 239     fsid.session_index = *psid;
 240     if (!pool_is_free_index (pw->fa_sessions_pool, fsid.session_index))
 241       {
 242         fa_session_t *sess =
 243           get_session_ptr (am, thread_index, fsid.session_index);
 244         u32 sw_if_index = sess->sw_if_index;
 245         u64 sess_timeout_time =
 246           sess->last_active_time + fa_session_get_timeout (am, sess);
 247         int timeout_passed = (now >= sess_timeout_time);
 248         int clearing_interface =
 249           clib_bitmap_get (pw->pending_clear_sw_if_index_bitmap, sw_if_index);
 250         if (am->trace_sessions > 3)
 251           {
 252             elog_acl_maybe_trace_X2 (am,
 253                                      "acl_fa_check_idle_sessions: now %lu sess_timeout_time %lu",
 254                                      "i8i8", now, sess_timeout_time);
 255             elog_acl_maybe_trace_X4 (am,
 256                                      "acl_fa_check_idle_sessions: session %d sw_if_index %d timeout_passed %d clearing_interface %d",
 257                                      "i4i4i4i4", (u32) fsid.session_index,
 258                                      (u32) sess->sw_if_index,
 259                                      (u32) timeout_passed,
 260                                      (u32) clearing_interface);
 261           }
 262         if (timeout_passed || clearing_interface)
 263           {
 264             if (acl_fa_two_stage_delete_session (am, sw_if_index, fsid, now))
 265               {
 266                 if (am->trace_sessions > 3)
 267                   {
 268                     elog_acl_maybe_trace_X2 (am,
 269                                              "acl_fa_check_idle_sessions: deleted session %d sw_if_index %d",
 270                                              "i4i4", (u32) fsid.session_index,
 271                                              (u32) sess->sw_if_index);
 272                   }
 273                 /* the session has been put */
 274                 pw->cnt_deleted_sessions++;
 275               }
 276             else
 277               {
 278                 /* the connection marked as deleted and put to purgatory */
 279                 if (am->trace_sessions > 3)
 280                   {
 281                     elog_acl_maybe_trace_X2 (am,
 282                                              "acl_fa_check_idle_sessions: session %d sw_if_index %d marked as deleted, put to purgatory",
 283                                              "i4i4", (u32) fsid.session_index,
 284                                              (u32) sess->sw_if_index);
 285                   }
 286               }
 287           }
 288         else
 289
 290           {
 291             if (am->trace_sessions > 3)
 292               {
 293                 elog_acl_maybe_trace_X2 (am,
 294                                          "acl_fa_check_idle_sessions: restart timer for session %d sw_if_index %d",
 295                                          "i4i4", (u32) fsid.session_index,
 296                                          (u32) sess->sw_if_index);
 297               }
 298             /* There was activity on the session, so the idle timeout
 299                has not passed. Enqueue for another time period. */
 300
 301             acl_fa_conn_list_add_session (am, fsid, now);
 302             pw->cnt_session_timer_restarted++;
 303           }
 304       }
 305     else
 306       {
 307         pw->cnt_already_deleted_sessions++;
 308       }
 309   }
 310   total_expired = vec_len (pw->expired);
 311   /* zero out the vector which we have acted on */
 312   if (pw->expired)
 313     _vec_len (pw->expired) = 0;
 314   /* if we were advancing and reached the end
 315    * (no more sessions to recycle), reset the fast-forward timestamp */
 316
 317   if (pw->swipe_end_time && 0 == total_expired)
 318     pw->swipe_end_time = 0;
 319
 320   elog_acl_maybe_trace_X1 (am,
 321                            "acl_fa_check_idle_sessions: done, total sessions expired: %d",
 322                            "i4", (u32) total_expired);
 323   return (total_expired);
 324 }
 325
 326 /*
 327  * This process ensures the connection cleanup happens every so often
 328  * even in absence of traffic, as well as provides general orchestration
 329  * for requests like connection deletion on a given sw_if_index.
 330  */
 331
 332
 333 /* *INDENT-OFF* */
 334 #define foreach_acl_fa_cleaner_error \
 335 _(UNKNOWN_EVENT, "unknown event received")  \
 336 /* end  of errors */
 337
 338 typedef enum
 339 {
 340 #define _(sym,str) ACL_FA_CLEANER_ERROR_##sym,
 341   foreach_acl_fa_cleaner_error
 342 #undef _
 343     ACL_FA_CLEANER_N_ERROR,
 344 } acl_fa_cleaner_error_t;
 345
 346 static char *acl_fa_cleaner_error_strings[] = {
 347 #define _(sym,string) string,
 348   foreach_acl_fa_cleaner_error
 349 #undef _
 350 };
 351
 352 /* *INDENT-ON* */
 353
 354 static vlib_node_registration_t acl_fa_session_cleaner_process_node;
 355 static vlib_node_registration_t acl_fa_worker_session_cleaner_process_node;
 356
 357 static void
 358 send_one_worker_interrupt (vlib_main_t * vm, acl_main_t * am,
 359                            int thread_index)
 360 {
 361   acl_fa_per_worker_data_t *pw = &am->per_worker_data[thread_index];
 362   if (!pw->interrupt_is_pending)
 363     {
 364       pw->interrupt_is_pending = 1;
 365       vlib_node_set_interrupt_pending (vlib_mains[thread_index],
 366                                        acl_fa_worker_session_cleaner_process_node.index);
 367       elog_acl_maybe_trace_X1 (am,
 368                                "send_one_worker_interrupt: send interrupt to worker %u",
 369                                "i4", ((u32) thread_index));
 370       /* if the interrupt was requested, mark that done. */
 371       /* pw->interrupt_is_needed = 0; */
 372       CLIB_MEMORY_BARRIER ();
 373     }
 374 }
 375
 376 void
 377 aclp_post_session_change_request (acl_main_t * am, u32 target_thread,
 378                                   u32 target_session, u32 request_type)
 379 {
 380   acl_fa_per_worker_data_t *pw_me =
 381     &am->per_worker_data[os_get_thread_index ()];
 382   acl_fa_per_worker_data_t *pw = &am->per_worker_data[target_thread];
 383   clib_spinlock_lock_if_init (&pw->pending_session_change_request_lock);
 384   /* vec_add1 might cause a reallocation */
 385   vec_add1 (pw->pending_session_change_requests,
 386             (((u64) request_type) << 32) | target_session);
 387   pw->rcvd_session_change_requests++;
 388   pw_me->sent_session_change_requests++;
 389   if (vec_len (pw->pending_session_change_requests) == 1)
 390     {
 391       /* ensure the requests get processed */
 392       send_one_worker_interrupt (am->vlib_main, am, target_thread);
 393     }
 394   clib_spinlock_unlock_if_init (&pw->pending_session_change_request_lock);
 395 }
 396
 397 void
 398 aclp_swap_wip_and_pending_session_change_requests (acl_main_t * am,
 399                                                    u32 target_thread)
 400 {
 401   acl_fa_per_worker_data_t *pw = &am->per_worker_data[target_thread];
 402   u64 *tmp;
 403   clib_spinlock_lock_if_init (&pw->pending_session_change_request_lock);
 404   tmp = pw->pending_session_change_requests;
 405   pw->pending_session_change_requests = pw->wip_session_change_requests;
 406   pw->wip_session_change_requests = tmp;
 407   clib_spinlock_unlock_if_init (&pw->pending_session_change_request_lock);
 408 }
 409
 410
 411 static int
 412 purgatory_has_connections (vlib_main_t * vm, acl_main_t * am,
 413                            int thread_index)
 414 {
 415   acl_fa_per_worker_data_t *pw = &am->per_worker_data[thread_index];
 416
 417   return (FA_SESSION_BOGUS_INDEX !=
 418           pw->fa_conn_list_head[ACL_TIMEOUT_PURGATORY]);
 419
 420 }
 421
 422
 423 /*
 424  * Per-worker thread interrupt-driven cleaner thread
 425  * to clean idle connections if there are no packets
 426  */
 427 static uword
 428 acl_fa_worker_conn_cleaner_process (vlib_main_t * vm,
 429                                     vlib_node_runtime_t * rt,
 430                                     vlib_frame_t * f)
 431 {
 432   acl_main_t *am = &acl_main;
 433   u64 now = clib_cpu_time_now ();
 434   u16 thread_index = os_get_thread_index ();
 435   acl_fa_per_worker_data_t *pw = &am->per_worker_data[thread_index];
 436   int num_expired;
 437   elog_acl_maybe_trace_X1 (am,
 438                            "acl_fa_worker_conn_cleaner interrupt: now %lu",
 439                            "i8", now);
 440   /* allow another interrupt to be queued */
 441   pw->interrupt_is_pending = 0;
 442   if (pw->clear_in_process)
 443     {
 444       if (0 == pw->swipe_end_time)
 445         {
 446           /*
 447            * Someone has just set the flag to start clearing.
 448            * we do this by combing through the connections up to a "time T"
 449            * which is now, and requeueing everything except the expired
 450            * connections and those matching the interface(s) being cleared.
 451            */
 452
 453           /*
 454            * first filter the sw_if_index bitmap that they want from us, by
 455            * a bitmap of sw_if_index for which we actually have connections.
 456            */
 457           if ((pw->pending_clear_sw_if_index_bitmap == 0)
 458               || (pw->serviced_sw_if_index_bitmap == 0))
 459             {
 460               elog_acl_maybe_trace_X1 (am,
 461                                        "acl_fa_worker_conn_cleaner: now %lu, someone tried to call clear but one of the bitmaps are empty",
 462                                        "i8", now);
 463               clib_bitmap_zero (pw->pending_clear_sw_if_index_bitmap);
 464             }
 465           else
 466             {
 467 #ifdef FA_NODE_VERBOSE_DEBUG
 468               clib_warning
 469                 ("WORKER-CLEAR: (before and) swiping sw-if-index bitmap: %U, my serviced bitmap %U",
 470                  format_bitmap_hex, pw->pending_clear_sw_if_index_bitmap,
 471                  format_bitmap_hex, pw->serviced_sw_if_index_bitmap);
 472 #endif
 473               pw->pending_clear_sw_if_index_bitmap =
 474                 clib_bitmap_and (pw->pending_clear_sw_if_index_bitmap,
 475                                  pw->serviced_sw_if_index_bitmap);
 476             }
 477
 478           if (clib_bitmap_is_zero (pw->pending_clear_sw_if_index_bitmap))
 479             {
 480               /* if the cross-section is a zero vector, no need to do anything. */
 481               elog_acl_maybe_trace_X1 (am,
 482                                        "acl_fa_worker_conn_cleaner: now %lu, clearing done, nothing to do",
 483                                        "i8", now);
 484               pw->clear_in_process = 0;
 485               pw->swipe_end_time = 0;
 486             }
 487           else
 488             {
 489 #ifdef FA_NODE_VERBOSE_DEBUG
 490               clib_warning
 491                 ("WORKER-CLEAR: swiping sw-if-index bitmap: %U, my serviced bitmap %U",
 492                  format_bitmap_hex, pw->pending_clear_sw_if_index_bitmap,
 493                  format_bitmap_hex, pw->serviced_sw_if_index_bitmap);
 494 #endif
 495               elog_acl_maybe_trace_X1 (am,
 496                                        "acl_fa_worker_conn_cleaner: swiping until %lu",
 497                                        "i8", now);
 498               /* swipe through the connection lists until enqueue timestamps become above "now" */
 499               pw->swipe_end_time = now;
 500             }
 501         }
 502     }
 503   num_expired = acl_fa_check_idle_sessions (am, thread_index, now);
 504   // clib_warning("WORKER-CLEAR: checked %d sessions (clear_in_progress: %d)", num_expired, pw->clear_in_process);
 505   elog_acl_maybe_trace_X2 (am,
 506                            "acl_fa_worker_conn_cleaner: checked %d sessions (clear_in_process: %d)",
 507                            "i4i4", (u32) num_expired,
 508                            (u32) pw->clear_in_process);
 509   if (pw->clear_in_process)
 510     {
 511       if (pw->swipe_end_time == 0)
 512         {
 513           /* we were clearing but we could not process any more connections. time to stop. */
 514           clib_bitmap_zero (pw->pending_clear_sw_if_index_bitmap);
 515           pw->clear_in_process = 0;
 516           elog_acl_maybe_trace_X1 (am,
 517                                    "acl_fa_worker_conn_cleaner: now %lu, clearing done - all done",
 518                                    "i8", now);
 519         }
 520       else
 521         {
 522           elog_acl_maybe_trace_X1 (am,
 523                                    "acl_fa_worker_conn_cleaner: now %lu, more work to do - requesting interrupt",
 524                                    "i8", now);
 525           /* should continue clearing.. So could they please sent an interrupt again? */
 526           send_one_worker_interrupt (vm, am, thread_index);
 527           // pw->interrupt_is_needed = 1;
 528         }
 529     }
 530   else
 531     {
 532       if (num_expired > 0)
 533         {
 534           /* there was too much work, we should get an interrupt ASAP */
 535           // pw->interrupt_is_needed = 1;
 536           send_one_worker_interrupt (vm, am, thread_index);
 537           pw->interrupt_is_unwanted = 0;
 538         }
 539       else
 540         {
 541           /* the current rate of interrupts is ok */
 542           pw->interrupt_is_needed = 0;
 543           pw->interrupt_is_unwanted = 0;
 544         }
 545       elog_acl_maybe_trace_X3 (am,
 546                                "acl_fa_worker_conn_cleaner: now %lu, interrupt needed: %u, interrupt unwanted: %u",
 547                                "i8i4i4", now, ((u32) pw->interrupt_is_needed),
 548                                ((u32) pw->interrupt_is_unwanted));
 549     }
 550   /* be persistent about quickly deleting the connections from the purgatory */
 551   if (purgatory_has_connections (vm, am, thread_index))
 552     {
 553       send_one_worker_interrupt (vm, am, thread_index);
 554     }
 555   pw->interrupt_generation = am->fa_interrupt_generation;
 556   return 0;
 557 }
 558
 559 static void
 560 send_interrupts_to_workers (vlib_main_t * vm, acl_main_t * am)
 561 {
 562   int i;
 563   /* Can't use vec_len(am->per_worker_data) since the threads might not have come up yet; */
 564   int n_threads = vec_len (vlib_mains);
 565   for (i = 0; i < n_threads; i++)
 566     {
 567       send_one_worker_interrupt (vm, am, i);
 568     }
 569 }
 570
 571 /* centralized process to drive per-worker cleaners */
 572 static uword
 573 acl_fa_session_cleaner_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
 574                                 vlib_frame_t * f)
 575 {
 576   acl_main_t *am = &acl_main;
 577   u64 now;
 578   f64 cpu_cps = vm->clib_time.clocks_per_second;
 579   u64 next_expire;
 580   /* We should check if there are connections to clean up - at least twice a second */
 581   u64 max_timer_wait_interval = cpu_cps / 2;
 582   uword event_type, *event_data = 0;
 583   acl_fa_per_worker_data_t *pw0;
 584
 585   am->fa_current_cleaner_timer_wait_interval = max_timer_wait_interval;
 586   am->fa_cleaner_node_index = acl_fa_session_cleaner_process_node.index;
 587   am->fa_interrupt_generation = 1;
 588   while (1)
 589     {
 590       now = clib_cpu_time_now ();
 591       next_expire = now + am->fa_current_cleaner_timer_wait_interval;
 592       int has_pending_conns = 0;
 593       u16 ti;
 594       u8 tt;
 595
 596       /*
 597        * walk over all per-thread list heads of different timeouts,
 598        * and see if there are any connections pending.
 599        * If there aren't - we do not need to wake up until the
 600        * worker code signals that it has added a connection.
 601        *
 602        * Also, while we are at it, calculate the earliest we need to wake up.
 603        */
 604       for (ti = 0; ti < vec_len (vlib_mains); ti++)
 605         {
 606           if (ti >= vec_len (am->per_worker_data))
 607             {
 608               continue;
 609             }
 610           acl_fa_per_worker_data_t *pw = &am->per_worker_data[ti];
 611           for (tt = 0; tt < vec_len (pw->fa_conn_list_head); tt++)
 612             {
 613               u64 head_expiry =
 614                 acl_fa_get_list_head_expiry_time (am, pw, now, ti, tt);
 615               if ((head_expiry < next_expire) && !pw->interrupt_is_pending)
 616                 {
 617                   elog_acl_maybe_trace_X3 (am,
 618                                            "acl_fa_session_cleaner_process: now %lu, worker: %u tt: %u",
 619                                            "i8i2i2", now, ti, tt);
 620                   elog_acl_maybe_trace_X2 (am,
 621                                            "acl_fa_session_cleaner_process: head expiry: %lu, is earlier than curr next expire: %lu",
 622                                            "i8i8", head_expiry, next_expire);
 623                   next_expire = head_expiry;
 624                 }
 625               if (FA_SESSION_BOGUS_INDEX != pw->fa_conn_list_head[tt])
 626                 {
 627                   has_pending_conns = 1;
 628                 }
 629             }
 630         }
 631
 632       /* If no pending connections and no ACL applied then no point in timing out */
 633       if (!has_pending_conns && (0 == am->fa_total_enabled_count))
 634         {
 635           am->fa_cleaner_cnt_wait_without_timeout++;
 636           elog_acl_maybe_trace_X1 (am,
 637                                    "acl_conn_cleaner: now %lu entering wait without timeout",
 638                                    "i8", now);
 639           (void) vlib_process_wait_for_event (vm);
 640           event_type = vlib_process_get_events (vm, &event_data);
 641         }
 642       else
 643         {
 644           f64 timeout = ((i64) next_expire - (i64) now) / cpu_cps;
 645           if (timeout <= 0)
 646             {
 647               /* skip waiting altogether */
 648               event_type = ~0;
 649             }
 650           else
 651             {
 652               am->fa_cleaner_cnt_wait_with_timeout++;
 653               elog_acl_maybe_trace_X2 (am,
 654                                        "acl_conn_cleaner: now %lu entering wait with timeout %.6f sec",
 655                                        "i8f8", now, timeout);
 656               (void) vlib_process_wait_for_event_or_clock (vm, timeout);
 657               event_type = vlib_process_get_events (vm, &event_data);
 658             }
 659         }
 660
 661       switch (event_type)
 662         {
 663         case ~0:
 664           /* nothing to do */
 665           break;
 666         case ACL_FA_CLEANER_RESCHEDULE:
 667           /* Nothing to do. */
 668           break;
 669         case ACL_FA_CLEANER_DELETE_BY_SW_IF_INDEX:
 670           {
 671             uword *clear_sw_if_index_bitmap = 0;
 672             uword *sw_if_index0;
 673             int clear_all = 0;
 674             now = clib_cpu_time_now ();
 675             elog_acl_maybe_trace_X1 (am,
 676                                      "acl_fa_session_cleaner_process: now %lu, received ACL_FA_CLEANER_DELETE_BY_SW_IF_INDEX",
 677                                      "i8", now);
 678             vec_foreach (sw_if_index0, event_data)
 679             {
 680               am->fa_cleaner_cnt_delete_by_sw_index++;
 681               elog_acl_maybe_trace_X1 (am,
 682                                        "acl_fa_session_cleaner_process: ACL_FA_CLEANER_DELETE_BY_SW_IF_INDEX %u",
 683                                        "i4", *sw_if_index0);
 684               if (*sw_if_index0 == ~0)
 685                 {
 686                   clear_all = 1;
 687                 }
 688               else
 689                 {
 690                   if (!pool_is_free_index
 691                       (am->vnet_main->interface_main.sw_interfaces,
 692                        *sw_if_index0))
 693                     {
 694                       clear_sw_if_index_bitmap =
 695                         clib_bitmap_set (clear_sw_if_index_bitmap,
 696                                          *sw_if_index0, 1);
 697                     }
 698                 }
 699             }
 700             acl_log_info
 701               ("ACL_FA_CLEANER_DELETE_BY_SW_IF_INDEX bitmap: %U, clear_all: %u",
 702                format_bitmap_hex, clear_sw_if_index_bitmap, clear_all);
 703             vec_foreach (pw0, am->per_worker_data)
 704             {
 705               CLIB_MEMORY_BARRIER ();
 706               while (pw0->clear_in_process)
 707                 {
 708                   CLIB_MEMORY_BARRIER ();
 709                   elog_acl_maybe_trace_X1 (am,
 710                                            "ACL_FA_NODE_CLEAN: waiting previous cleaning cycle to finish on %u",
 711                                            "i4",
 712                                            (u32) (pw0 - am->per_worker_data));
 713                   vlib_process_suspend (vm, 0.0001);
 714                   if (pw0->interrupt_is_needed)
 715                     {
 716                       send_one_worker_interrupt (vm, am,
 717                                                  (pw0 - am->per_worker_data));
 718                     }
 719                 }
 720               if (pw0->clear_in_process)
 721                 {
 722                   acl_log_err
 723                     ("ERROR-BUG! Could not initiate cleaning on worker because another cleanup in progress");
 724                 }
 725               else
 726                 {
 727                   if (clear_all)
 728                     {
 729                       /* if we need to clear all, then just clear the interfaces that we are servicing */
 730                       pw0->pending_clear_sw_if_index_bitmap =
 731                         clib_bitmap_dup (pw0->serviced_sw_if_index_bitmap);
 732                     }
 733                   else
 734                     {
 735                       pw0->pending_clear_sw_if_index_bitmap =
 736                         clib_bitmap_dup (clear_sw_if_index_bitmap);
 737                     }
 738                   acl_log_info
 739                     ("ACL_FA_CLEANER: thread %u, pending clear bitmap: %U",
 740                      (am->per_worker_data - pw0), format_bitmap_hex,
 741                      pw0->pending_clear_sw_if_index_bitmap);
 742                   pw0->clear_in_process = 1;
 743                 }
 744             }
 745             /* send some interrupts so they can start working */
 746             send_interrupts_to_workers (vm, am);
 747
 748             /* now wait till they all complete */
 749             acl_log_info ("CLEANER mains len: %u per-worker len: %d",
 750                           vec_len (vlib_mains),
 751                           vec_len (am->per_worker_data));
 752             vec_foreach (pw0, am->per_worker_data)
 753             {
 754               CLIB_MEMORY_BARRIER ();
 755               while (pw0->clear_in_process)
 756                 {
 757                   CLIB_MEMORY_BARRIER ();
 758                   elog_acl_maybe_trace_X1 (am,
 759                                            "ACL_FA_NODE_CLEAN: waiting for my cleaning cycle to finish on %u",
 760                                            "i4",
 761                                            (u32) (pw0 - am->per_worker_data));
 762                   vlib_process_suspend (vm, 0.0001);
 763                   if (pw0->interrupt_is_needed)
 764                     {
 765                       send_one_worker_interrupt (vm, am,
 766                                                  (pw0 - am->per_worker_data));
 767                     }
 768                 }
 769             }
 770             acl_log_info ("ACL_FA_NODE_CLEAN: cleaning done");
 771             clib_bitmap_free (clear_sw_if_index_bitmap);
 772           }
 773           am->fa_cleaner_cnt_delete_by_sw_index_ok++;
 774           break;
 775         default:
 776 #ifdef FA_NODE_VERBOSE_DEBUG
 777           clib_warning ("ACL plugin connection cleaner: unknown event %u",
 778                         event_type);
 779 #endif
 780           vlib_node_increment_counter (vm,
 781                                        acl_fa_session_cleaner_process_node.
 782                                        index,
 783                                        ACL_FA_CLEANER_ERROR_UNKNOWN_EVENT, 1);
 784           am->fa_cleaner_cnt_unknown_event++;
 785           break;
 786         }
 787
 788       send_interrupts_to_workers (vm, am);
 789
 790       if (event_data)
 791         _vec_len (event_data) = 0;
 792
 793       /*
 794        * If the interrupts were not processed yet, ensure we wait a bit,
 795        * but up to a point.
 796        */
 797       int need_more_wait = 0;
 798       int max_wait_cycles = 100;
 799       do
 800         {
 801           need_more_wait = 0;
 802           vec_foreach (pw0, am->per_worker_data)
 803           {
 804             if (pw0->interrupt_generation != am->fa_interrupt_generation)
 805               {
 806                 need_more_wait = 1;
 807               }
 808           }
 809           if (need_more_wait)
 810             {
 811               vlib_process_suspend (vm, 0.0001);
 812             }
 813         }
 814       while (need_more_wait && (--max_wait_cycles > 0));
 815
 816       int interrupts_needed = 0;
 817       int interrupts_unwanted = 0;
 818
 819       vec_foreach (pw0, am->per_worker_data)
 820       {
 821         if (pw0->interrupt_is_needed)
 822           {
 823             interrupts_needed++;
 824             /* the per-worker value is reset when sending the interrupt */
 825           }
 826         if (pw0->interrupt_is_unwanted)
 827           {
 828             interrupts_unwanted++;
 829             pw0->interrupt_is_unwanted = 0;
 830           }
 831       }
 832       if (interrupts_needed)
 833         {
 834           /* they need more interrupts, do less waiting around next time */
 835           am->fa_current_cleaner_timer_wait_interval /= 2;
 836           /* never go into zero-wait either though - we need to give the space to others */
 837           am->fa_current_cleaner_timer_wait_interval += 1;
 838         }
 839       else if (interrupts_unwanted)
 840         {
 841           /* slowly increase the amount of sleep up to a limit */
 842           if (am->fa_current_cleaner_timer_wait_interval <
 843               max_timer_wait_interval)
 844             am->fa_current_cleaner_timer_wait_interval +=
 845               cpu_cps * am->fa_cleaner_wait_time_increment;
 846         }
 847       am->fa_cleaner_cnt_event_cycles++;
 848       am->fa_interrupt_generation++;
 849     }
 850   /* NOT REACHED */
 851   return 0;
 852 }
 853
 854
 855 void
 856 acl_fa_enable_disable (u32 sw_if_index, int is_input, int enable_disable)
 857 {
 858   acl_main_t *am = &acl_main;
 859   if (enable_disable)
 860     {
 861       acl_fa_verify_init_sessions (am);
 862       am->fa_total_enabled_count++;
 863       void *oldheap = clib_mem_set_heap (am->vlib_main->heap_base);
 864       vlib_process_signal_event (am->vlib_main, am->fa_cleaner_node_index,
 865                                  ACL_FA_CLEANER_RESCHEDULE, 0);
 866       clib_mem_set_heap (oldheap);
 867     }
 868   else
 869     {
 870       am->fa_total_enabled_count--;
 871     }
 872
 873   if (is_input)
 874     {
 875       ASSERT (clib_bitmap_get (am->fa_in_acl_on_sw_if_index, sw_if_index) !=
 876               enable_disable);
 877       void *oldheap = clib_mem_set_heap (am->vlib_main->heap_base);
 878       vnet_feature_enable_disable ("ip4-unicast", "acl-plugin-in-ip4-fa",
 879                                    sw_if_index, enable_disable, 0, 0);
 880       vnet_feature_enable_disable ("ip6-unicast", "acl-plugin-in-ip6-fa",
 881                                    sw_if_index, enable_disable, 0, 0);
 882       clib_mem_set_heap (oldheap);
 883       am->fa_in_acl_on_sw_if_index =
 884         clib_bitmap_set (am->fa_in_acl_on_sw_if_index, sw_if_index,
 885                          enable_disable);
 886     }
 887   else
 888     {
 889       ASSERT (clib_bitmap_get (am->fa_out_acl_on_sw_if_index, sw_if_index) !=
 890               enable_disable);
 891       void *oldheap = clib_mem_set_heap (am->vlib_main->heap_base);
 892       vnet_feature_enable_disable ("ip4-output", "acl-plugin-out-ip4-fa",
 893                                    sw_if_index, enable_disable, 0, 0);
 894       vnet_feature_enable_disable ("ip6-output", "acl-plugin-out-ip6-fa",
 895                                    sw_if_index, enable_disable, 0, 0);
 896       clib_mem_set_heap (oldheap);
 897       am->fa_out_acl_on_sw_if_index =
 898         clib_bitmap_set (am->fa_out_acl_on_sw_if_index, sw_if_index,
 899                          enable_disable);
 900     }
 901   if ((!enable_disable) && (!acl_fa_ifc_has_in_acl (am, sw_if_index))
 902       && (!acl_fa_ifc_has_out_acl (am, sw_if_index)))
 903     {
 904 #ifdef FA_NODE_VERBOSE_DEBUG
 905       clib_warning ("ENABLE-DISABLE: clean the connections on interface %d",
 906                     sw_if_index);
 907 #endif
 908       void *oldheap = clib_mem_set_heap (am->vlib_main->heap_base);
 909       vlib_process_signal_event (am->vlib_main, am->fa_cleaner_node_index,
 910                                  ACL_FA_CLEANER_DELETE_BY_SW_IF_INDEX,
 911                                  sw_if_index);
 912       clib_mem_set_heap (oldheap);
 913     }
 914 }
 915
 916 void
 917 show_fa_sessions_hash (vlib_main_t * vm, u32 verbose)
 918 {
 919   acl_main_t *am = &acl_main;
 920   if (am->fa_sessions_hash_is_initialized)
 921     {
 922       vlib_cli_output (vm, "\nIPv6 Session lookup hash table:\n%U\n\n",
 923                        format_bihash_40_8, &am->fa_ip6_sessions_hash,
 924                        verbose);
 925
 926       vlib_cli_output (vm, "\nIPv4 Session lookup hash table:\n%U\n\n",
 927                        format_bihash_16_8, &am->fa_ip4_sessions_hash,
 928                        verbose);
 929     }
 930   else
 931     {
 932       vlib_cli_output (vm,
 933                        "\nSession lookup hash table is not allocated.\n\n");
 934     }
 935 }
 936
 937
 938 /* *INDENT-OFF* */
 939
 940 VLIB_REGISTER_NODE (acl_fa_worker_session_cleaner_process_node, static) = {
 941   .function = acl_fa_worker_conn_cleaner_process,
 942   .name = "acl-plugin-fa-worker-cleaner-process",
 943   .type = VLIB_NODE_TYPE_INPUT,
 944   .state = VLIB_NODE_STATE_INTERRUPT,
 945 };
 946
 947 VLIB_REGISTER_NODE (acl_fa_session_cleaner_process_node, static) = {
 948   .function = acl_fa_session_cleaner_process,
 949   .type = VLIB_NODE_TYPE_PROCESS,
 950   .name = "acl-plugin-fa-cleaner-process",
 951   .n_errors = ARRAY_LEN (acl_fa_cleaner_error_strings),
 952   .error_strings = acl_fa_cleaner_error_strings,
 953   .n_next_nodes = 0,
 954   .next_nodes = {},
 955 };
 956
 957
 958 /* *INDENT-ON* */
 959
 960 /*
 961  * fd.io coding-style-patch-verification: ON
 962  *
 963  * Local Variables:
 964  * eval: (c-set-style "gnu")
 965  * End:
 966  */