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