tests: fix test-help formatting
[vpp.git] / src / plugins / lb / lb.c
index 75ca40f..c6f5a0a 100644 (file)
@@ -17,7 +17,8 @@
 #include <vnet/plugin/plugin.h>
 #include <vpp/app/version.h>
 #include <vnet/api_errno.h>
-#include <vnet/udp/udp.h>
+#include <vnet/udp/udp_local.h>
+#include <vppinfra/lock.h>
 
 //GC runs at most once every so many seconds
 #define LB_GARBAGE_RUN 60
 //After so many seconds. It is assumed that inter-core race condition will not occur.
 #define LB_CONCURRENCY_TIMEOUT 10
 
+// FIB source for adding routes
+static fib_source_t lb_fib_src;
+
 lb_main_t lb_main;
 
-#define lb_get_writer_lock() do {} while(clib_atomic_test_and_set (lb_main.writer_lock))
-#define lb_put_writer_lock() clib_atomic_release (lb_main.writer_lock)
+#define lb_get_writer_lock() clib_spinlock_lock (&lb_main.writer_lock)
+#define lb_put_writer_lock() clib_spinlock_unlock (&lb_main.writer_lock)
 
 static void lb_as_stack (lb_as_t *as);
 
@@ -89,6 +93,78 @@ const static char* const * const lb_dpo_nat6_port_nodes[DPO_PROTO_NUM] =
         [DPO_PROTO_IP6]  = lb_dpo_nat6_ip6_port,
     };
 
+const static char *const lb_dpo_gre4_ip4_sticky[] = { "lb4-gre4-sticky",
+                                                     NULL };
+const static char *const lb_dpo_gre4_ip6_sticky[] = { "lb6-gre4-sticky",
+                                                     NULL };
+const static char *const *const lb_dpo_gre4_sticky_nodes[DPO_PROTO_NUM] = {
+  [DPO_PROTO_IP4] = lb_dpo_gre4_ip4_sticky,
+  [DPO_PROTO_IP6] = lb_dpo_gre4_ip6_sticky,
+};
+
+const static char *const lb_dpo_gre6_ip4_sticky[] = { "lb4-gre6-sticky",
+                                                     NULL };
+const static char *const lb_dpo_gre6_ip6_sticky[] = { "lb6-gre6-sticky",
+                                                     NULL };
+const static char *const *const lb_dpo_gre6_sticky_nodes[DPO_PROTO_NUM] = {
+  [DPO_PROTO_IP4] = lb_dpo_gre6_ip4_sticky,
+  [DPO_PROTO_IP6] = lb_dpo_gre6_ip6_sticky,
+};
+
+const static char *const lb_dpo_gre4_ip4_port_sticky[] = {
+  "lb4-gre4-port-sticky", NULL
+};
+const static char *const lb_dpo_gre4_ip6_port_sticky[] = {
+  "lb6-gre4-port-sticky", NULL
+};
+const static char *const
+  *const lb_dpo_gre4_port_sticky_nodes[DPO_PROTO_NUM] = {
+    [DPO_PROTO_IP4] = lb_dpo_gre4_ip4_port_sticky,
+    [DPO_PROTO_IP6] = lb_dpo_gre4_ip6_port_sticky,
+  };
+
+const static char *const lb_dpo_gre6_ip4_port_sticky[] = {
+  "lb4-gre6-port-sticky", NULL
+};
+const static char *const lb_dpo_gre6_ip6_port_sticky[] = {
+  "lb6-gre6-port-sticky", NULL
+};
+const static char *const
+  *const lb_dpo_gre6_port_sticky_nodes[DPO_PROTO_NUM] = {
+    [DPO_PROTO_IP4] = lb_dpo_gre6_ip4_port_sticky,
+    [DPO_PROTO_IP6] = lb_dpo_gre6_ip6_port_sticky,
+  };
+
+const static char *const lb_dpo_l3dsr_ip4_sticky[] = { "lb4-l3dsr-sticky",
+                                                      NULL };
+const static char *const *const lb_dpo_l3dsr_sticky_nodes[DPO_PROTO_NUM] = {
+  [DPO_PROTO_IP4] = lb_dpo_l3dsr_ip4_sticky,
+};
+
+const static char *const lb_dpo_l3dsr_ip4_port_sticky[] = {
+  "lb4-l3dsr-port-sticky", NULL
+};
+const static char *const
+  *const lb_dpo_l3dsr_port_sticky_nodes[DPO_PROTO_NUM] = {
+    [DPO_PROTO_IP4] = lb_dpo_l3dsr_ip4_port_sticky,
+  };
+
+const static char *const lb_dpo_nat4_ip4_port_sticky[] = {
+  "lb4-nat4-port-sticky", NULL
+};
+const static char *const
+  *const lb_dpo_nat4_port_sticky_nodes[DPO_PROTO_NUM] = {
+    [DPO_PROTO_IP4] = lb_dpo_nat4_ip4_port_sticky,
+  };
+
+const static char *const lb_dpo_nat6_ip6_port_sticky[] = {
+  "lb6-nat6-port-sticky", NULL
+};
+const static char *const
+  *const lb_dpo_nat6_port_sticky_nodes[DPO_PROTO_NUM] = {
+    [DPO_PROTO_IP6] = lb_dpo_nat6_ip6_port_sticky,
+  };
+
 u32 lb_hash_time_now(vlib_main_t * vm)
 {
   return (u32) (vlib_time_now(vm) + 10000);
@@ -194,15 +270,18 @@ u8 *format_lb_vip_detailed (u8 * s, va_list * args)
   lb_vip_t *vip = va_arg (*args, lb_vip_t *);
   u32 indent = format_get_indent (s);
 
-  s = format(s, "%U %U [%lu] %U%s\n"
+  /* clang-format off */
+  s = format(s, "%U %U [%lu] %U%s%s\n"
                    "%U  new_size:%u\n",
                   format_white_space, indent,
                   format_lb_vip_type, vip->type,
                   vip - lbm->vips,
                   format_ip46_prefix, &vip->prefix, (u32) vip->plen, IP46_TYPE_ANY,
+                  lb_vip_is_src_ip_sticky (vip) ? " src_ip_sticky" : "",
                   (vip->flags & LB_VIP_FLAGS_USED)?"":" removed",
                   format_white_space, indent,
                   vip->new_flow_table_mask + 1);
+  /* clang-format on */
 
   if (vip->port != 0)
     {
@@ -251,7 +330,7 @@ u8 *format_lb_vip_detailed (u8 * s, va_list * args)
 
   lb_as_t *as;
   u32 *as_index;
-  pool_foreach(as_index, vip->as_indexes, {
+  pool_foreach (as_index, vip->as_indexes) {
       as = &lbm->ass[*as_index];
       s = format(s, "%U    %U %u buckets   %Lu flows  dpo:%u %s\n",
                    format_white_space, indent,
@@ -260,7 +339,7 @@ u8 *format_lb_vip_detailed (u8 * s, va_list * args)
                    vlib_refcount_get(&lbm->as_refcount, as - lbm->ass),
                    as->dpo.dpoi_index,
                    (as->flags & LB_AS_FLAGS_USED)?"used":" removed");
-  });
+  }
 
   vec_free(count);
   return s;
@@ -289,7 +368,7 @@ static void lb_vip_garbage_collection(lb_vip_t *vip)
   lb_snat6_key_t m_key6;
   clib_bihash_kv_24_8_t kv6, value6;
   lb_snat_mapping_t *m = 0;
-  ASSERT (lbm->writer_lock[0]);
+  CLIB_SPINLOCK_ASSERT_LOCKED (&lbm->writer_lock);
 
   u32 now = (u32) vlib_time_now(vlib_get_main());
   if (!clib_u32_loop_gt(now, vip->last_garbage_collection + LB_GARBAGE_RUN))
@@ -298,7 +377,7 @@ static void lb_vip_garbage_collection(lb_vip_t *vip)
   vip->last_garbage_collection = now;
   lb_as_t *as;
   u32 *as_index;
-  pool_foreach(as_index, vip->as_indexes, {
+  pool_foreach (as_index, vip->as_indexes) {
       as = &lbm->ass[*as_index];
       if (!(as->flags & LB_AS_FLAGS_USED) && //Not used
           clib_u32_loop_gt(now, as->last_used + LB_CONCURRENCY_TIMEOUT) &&
@@ -347,7 +426,7 @@ static void lb_vip_garbage_collection(lb_vip_t *vip)
           pool_put(vip->as_indexes, as_index);
           pool_put(lbm->ass, as);
         }
-  });
+  }
 }
 
 void lb_garbage_collection()
@@ -356,14 +435,14 @@ void lb_garbage_collection()
   lb_get_writer_lock();
   lb_vip_t *vip;
   u32 *to_be_removed_vips = 0, *i;
-  pool_foreach(vip, lbm->vips, {
+  pool_foreach (vip, lbm->vips) {
       lb_vip_garbage_collection(vip);
 
       if (!(vip->flags & LB_VIP_FLAGS_USED) &&
           (pool_elts(vip->as_indexes) == 0)) {
         vec_add1(to_be_removed_vips, vip - lbm->vips);
       }
-  });
+  }
 
   vec_foreach(i, to_be_removed_vips) {
     vip = &lbm->vips[*i];
@@ -384,17 +463,17 @@ static void lb_vip_update_new_flow_table(lb_vip_t *vip)
   lb_as_t *as;
   lb_pseudorand_t *pr, *sort_arr = 0;
 
-  ASSERT (lbm->writer_lock[0]); //We must have the lock
+  CLIB_SPINLOCK_ASSERT_LOCKED (&lbm->writer_lock); // We must have the lock
 
   //Check if some AS is configured or not
   i = 0;
-  pool_foreach(as_index, vip->as_indexes, {
+  pool_foreach (as_index, vip->as_indexes) {
       as = &lbm->ass[*as_index];
       if (as->flags & LB_AS_FLAGS_USED) { //Not used anymore
         i = 1;
         goto out; //Not sure 'break' works in this macro-loop
       }
-  });
+  }
 
 out:
   if (i == 0) {
@@ -407,18 +486,18 @@ out:
   }
 
   //First, let's sort the ASs
-  vec_alloc(sort_arr, pool_elts(vip->as_indexes));
+  vec_validate (sort_arr, pool_elts (vip->as_indexes) - 1);
 
   i = 0;
-  pool_foreach(as_index, vip->as_indexes, {
+  pool_foreach (as_index, vip->as_indexes) {
       as = &lbm->ass[*as_index];
       if (!(as->flags & LB_AS_FLAGS_USED)) //Not used anymore
         continue;
 
       sort_arr[i].as_index = as - lbm->ass;
       i++;
-  });
-  _vec_len(sort_arr) = i;
+  }
+  vec_set_len (sort_arr, i);
 
   vec_sort_with_function(sort_arr, lb_pseudorand_compare);
 
@@ -496,9 +575,10 @@ int lb_vip_port_find_index(ip46_address_t *prefix, u8 plen,
 {
   lb_main_t *lbm = &lb_main;
   lb_vip_t *vip;
-  ASSERT (lbm->writer_lock[0]); //This must be called with the lock owned
+  /* This must be called with the lock owned */
+  CLIB_SPINLOCK_ASSERT_LOCKED (&lbm->writer_lock);
   ip46_prefix_normalize(prefix, plen);
-  pool_foreach(vip, lbm->vips, {
+  pool_foreach (vip, lbm->vips) {
       if ((vip->flags & LB_AS_FLAGS_USED) &&
           vip->plen == plen &&
           vip->prefix.as_u64[0] == prefix->as_u64[0] &&
@@ -517,7 +597,7 @@ int lb_vip_port_find_index(ip46_address_t *prefix, u8 plen,
               return 0;
             }
         }
-  });
+  }
   return VNET_API_ERROR_NO_SUCH_ENTRY;
 }
 
@@ -560,10 +640,11 @@ int lb_vip_find_index(ip46_address_t *prefix, u8 plen, u8 protocol,
 static int lb_as_find_index_vip(lb_vip_t *vip, ip46_address_t *address, u32 *as_index)
 {
   lb_main_t *lbm = &lb_main;
-  ASSERT (lbm->writer_lock[0]); //This must be called with the lock owned
+  /* This must be called with the lock owned */
+  CLIB_SPINLOCK_ASSERT_LOCKED (&lbm->writer_lock);
   lb_as_t *as;
   u32 *asi;
-  pool_foreach(asi, vip->as_indexes, {
+  pool_foreach (asi, vip->as_indexes) {
       as = &lbm->ass[*asi];
       if (as->vip_index == (vip - lbm->vips) &&
           as->address.as_u64[0] == address->as_u64[0] &&
@@ -572,7 +653,7 @@ static int lb_as_find_index_vip(lb_vip_t *vip, ip46_address_t *address, u32 *as_
         *as_index = as - lbm->ass;
         return 0;
       }
-  });
+  }
   return -1;
 }
 
@@ -857,7 +938,7 @@ static int
 lb_vip_prefix_index_alloc (lb_main_t *lbm)
 {
   /*
-   * Check for dynamically allocaetd instance number.
+   * Check for dynamically allocated instance number.
    */
   u32 bit;
 
@@ -900,6 +981,8 @@ static void lb_vip_add_adjacency(lb_main_t *lbm, lb_vip_t *vip,
       if (!lb_vip_port_find_diff_port(&(vip->prefix), vip->plen,
                                       vip->protocol, vip->port, &vip_idx))
         {
+          lb_vip_t *exists_vip = lb_vip_get_by_index(vip_idx);
+          *vip_prefix_index = exists_vip ? exists_vip->vip_prefix_index : ~0;
           return;
         }
 
@@ -941,11 +1024,27 @@ static void lb_vip_add_adjacency(lb_main_t *lbm, lb_vip_t *vip,
     dpo_type = lbm->dpo_nat4_port_type;
   else if (lb_vip_is_nat6_port(vip))
     dpo_type = lbm->dpo_nat6_port_type;
+  else if (lb_vip_is_gre4_sticky (vip))
+    dpo_type = lbm->dpo_gre4_sticky_type;
+  else if (lb_vip_is_gre6_sticky (vip))
+    dpo_type = lbm->dpo_gre6_sticky_type;
+  else if (lb_vip_is_gre4_port_sticky (vip))
+    dpo_type = lbm->dpo_gre4_port_sticky_type;
+  else if (lb_vip_is_gre6_port_sticky (vip))
+    dpo_type = lbm->dpo_gre6_port_sticky_type;
+  else if (lb_vip_is_l3dsr_sticky (vip))
+    dpo_type = lbm->dpo_l3dsr_sticky_type;
+  else if (lb_vip_is_l3dsr_port_sticky (vip))
+    dpo_type = lbm->dpo_l3dsr_port_sticky_type;
+  else if (lb_vip_is_nat4_port_sticky (vip))
+    dpo_type = lbm->dpo_nat4_port_sticky_type;
+  else if (lb_vip_is_nat6_port_sticky (vip))
+    dpo_type = lbm->dpo_nat6_port_sticky_type;
 
   dpo_set(&dpo, dpo_type, proto, *vip_prefix_index);
   fib_table_entry_special_dpo_add(0,
                                   &pfx,
-                                  FIB_SOURCE_PLUGIN_HI,
+                                  lb_fib_src,
                                   FIB_ENTRY_FLAG_EXCLUSIVE,
                                   &dpo);
   dpo_reset(&dpo);
@@ -1034,7 +1133,7 @@ static void lb_vip_del_adjacency(lb_main_t *lbm, lb_vip_t *vip)
       pfx.fp_len = vip->plen;
       pfx.fp_proto = FIB_PROTOCOL_IP6;
   }
-  fib_table_entry_special_remove(0, &pfx, FIB_SOURCE_PLUGIN_HI);
+  fib_table_entry_special_remove(0, &pfx, lb_fib_src);
 }
 
 int lb_vip_add(lb_vip_add_args_t args, u32 *vip_index)
@@ -1139,6 +1238,10 @@ int lb_vip_add(lb_vip_add_args_t args, u32 *vip_index)
     }
 
   vip->flags = LB_VIP_FLAGS_USED;
+  if (args.src_ip_sticky)
+    {
+      vip->flags |= LB_VIP_FLAGS_SRC_IP_STICKY;
+    }
   vip->as_indexes = 0;
 
   //Validate counters
@@ -1216,10 +1319,10 @@ int lb_vip_del(u32 vip_index)
     lb_as_t *as;
     u32 *as_index;
 
-    pool_foreach(as_index, vip->as_indexes, {
+    pool_foreach (as_index, vip->as_indexes) {
         as = &lbm->ass[*as_index];
         vec_add1(ass, as->address);
-    });
+    }
     if (vec_len(ass))
       lb_vip_del_ass_withlock(vip_index, ass, vec_len(ass), 0);
     vec_free(ass);
@@ -1303,6 +1406,22 @@ lb_as_stack (lb_as_t *as)
     dpo_type = lbm->dpo_nat4_port_type;
   else if (lb_vip_is_nat6_port(vip))
     dpo_type = lbm->dpo_nat6_port_type;
+  else if (lb_vip_is_gre4_sticky (vip))
+    dpo_type = lbm->dpo_gre4_sticky_type;
+  else if (lb_vip_is_gre6_sticky (vip))
+    dpo_type = lbm->dpo_gre6_sticky_type;
+  else if (lb_vip_is_gre4_port_sticky (vip))
+    dpo_type = lbm->dpo_gre4_port_sticky_type;
+  else if (lb_vip_is_gre6_port_sticky (vip))
+    dpo_type = lbm->dpo_gre6_port_sticky_type;
+  else if (lb_vip_is_l3dsr_sticky (vip))
+    dpo_type = lbm->dpo_l3dsr_sticky_type;
+  else if (lb_vip_is_l3dsr_port_sticky (vip))
+    dpo_type = lbm->dpo_l3dsr_port_sticky_type;
+  else if (lb_vip_is_nat4_port_sticky (vip))
+    dpo_type = lbm->dpo_nat4_port_sticky_type;
+  else if (lb_vip_is_nat6_port_sticky (vip))
+    dpo_type = lbm->dpo_nat6_port_sticky_type;
 
   dpo_stack(dpo_type,
             lb_vip_is_ip4(vip->type)?DPO_PROTO_IP4:DPO_PROTO_IP6,
@@ -1384,8 +1503,7 @@ lb_init (vlib_main_t * vm)
 
   lbm->per_cpu = 0;
   vec_validate(lbm->per_cpu, tm->n_vlib_mains - 1);
-  lbm->writer_lock = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,  CLIB_CACHE_LINE_BYTES);
-  lbm->writer_lock[0] = 0;
+  clib_spinlock_init (&lbm->writer_lock);
   lbm->per_cpu_sticky_buckets = LB_DEFAULT_PER_CPU_STICKY_BUCKETS;
   lbm->flow_timeout = LB_DEFAULT_FLOW_TIMEOUT;
   lbm->ip4_src_address.as_u32 = 0xffffffff;
@@ -1405,7 +1523,23 @@ lb_init (vlib_main_t * vm)
                                                   lb_dpo_nat4_port_nodes);
   lbm->dpo_nat6_port_type = dpo_register_new_type(&lb_vft,
                                                   lb_dpo_nat6_port_nodes);
-  lbm->fib_node_type = fib_node_register_new_type(&lb_fib_node_vft);
+  lbm->dpo_gre4_sticky_type =
+    dpo_register_new_type (&lb_vft, lb_dpo_gre4_sticky_nodes);
+  lbm->dpo_gre6_sticky_type =
+    dpo_register_new_type (&lb_vft, lb_dpo_gre6_sticky_nodes);
+  lbm->dpo_gre4_port_sticky_type =
+    dpo_register_new_type (&lb_vft, lb_dpo_gre4_port_sticky_nodes);
+  lbm->dpo_gre6_port_sticky_type =
+    dpo_register_new_type (&lb_vft, lb_dpo_gre6_port_sticky_nodes);
+  lbm->dpo_l3dsr_sticky_type =
+    dpo_register_new_type (&lb_vft, lb_dpo_l3dsr_sticky_nodes);
+  lbm->dpo_l3dsr_port_sticky_type =
+    dpo_register_new_type (&lb_vft, lb_dpo_l3dsr_port_sticky_nodes);
+  lbm->dpo_nat4_port_sticky_type =
+    dpo_register_new_type (&lb_vft, lb_dpo_nat4_port_sticky_nodes);
+  lbm->dpo_nat6_port_sticky_type =
+    dpo_register_new_type (&lb_vft, lb_dpo_nat6_port_sticky_nodes);
+  lbm->fib_node_type = fib_node_register_new_type ("lb", &lb_fib_node_vft);
 
   //Init AS reference counters
   vlib_refcount_init(&lbm->as_refcount);
@@ -1443,6 +1577,11 @@ lb_init (vlib_main_t * vm)
 #define _(a,b,c) lbm->vip_counters[c].name = b;
   lb_foreach_vip_counter
 #undef _
+
+  lb_fib_src = fib_source_allocate("lb",
+                                   FIB_SOURCE_PRIORITY_HI,
+                                   FIB_SOURCE_BH_SIMPLE);
+
   return NULL;
 }