src/plugins/nat/nat44_handoff.c

   1 /*
   2  * Copyright (c) 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 /**
  16  * @file
  17  * @brief NAT44 worker handoff
  18  */
  19
  20 #include <vlib/vlib.h>
  21 #include <vnet/vnet.h>
  22 #include <vnet/handoff.h>
  23 #include <vnet/fib/ip4_fib.h>
  24 #include <vppinfra/error.h>
  25 #include <nat/nat.h>
  26
  27 typedef struct
  28 {
  29   u32 next_worker_index;
  30   u8 in2out;
  31 } nat44_handoff_trace_t;
  32
  33 #define foreach_nat44_handoff_error                       \
  34 _(CONGESTION_DROP, "congestion drop")                     \
  35 _(SAME_WORKER, "same worker")                             \
  36 _(DO_HANDOFF, "do handoff")
  37
  38 typedef enum
  39 {
  40 #define _(sym,str) NAT44_HANDOFF_ERROR_##sym,
  41   foreach_nat44_handoff_error
  42 #undef _
  43     NAT44_HANDOFF_N_ERROR,
  44 } nat44_handoff_error_t;
  45
  46 static char *nat44_handoff_error_strings[] = {
  47 #define _(sym,string) string,
  48   foreach_nat44_handoff_error
  49 #undef _
  50 };
  51
  52
  53 vlib_node_registration_t snat_in2out_worker_handoff_node;
  54 vlib_node_registration_t snat_in2out_output_worker_handoff_node;
  55 vlib_node_registration_t snat_out2in_worker_handoff_node;
  56
  57 static u8 *
  58 format_nat44_handoff_trace (u8 * s, va_list * args)
  59 {
  60   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  61   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  62   nat44_handoff_trace_t *t = va_arg (*args, nat44_handoff_trace_t *);
  63   char *tag;
  64
  65   tag = t->in2out ? "IN2OUT" : "OUT2IN";
  66   s =
  67     format (s, "NAT44_%s_WORKER_HANDOFF: next-worker %d", tag,
  68             t->next_worker_index);
  69
  70   return s;
  71 }
  72
  73 static inline uword
  74 nat44_worker_handoff_fn_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
  75                                 vlib_frame_t * frame, u8 is_output,
  76                                 u8 is_in2out)
  77 {
  78   snat_main_t *sm = &snat_main;
  79   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
  80   u32 n_enq, n_left_from, *from;
  81   u16 thread_indices[VLIB_FRAME_SIZE], *ti;
  82   u32 fq_index;
  83   snat_get_worker_function_t *get_worker;
  84   u32 thread_index = vm->thread_index;
  85   u32 do_handoff = 0, same_worker = 0;
  86
  87   from = vlib_frame_vector_args (frame);
  88   n_left_from = frame->n_vectors;
  89   vlib_get_buffers (vm, from, bufs, n_left_from);
  90
  91   b = bufs;
  92   ti = thread_indices;
  93
  94   ASSERT (vec_len (sm->workers));
  95
  96   if (is_in2out)
  97     {
  98       get_worker = sm->worker_in2out_cb;
  99       if (is_output)
 100         fq_index = sm->fq_in2out_output_index;
 101       else
 102         fq_index = sm->fq_in2out_index;
 103     }
 104   else
 105     {
 106       fq_index = sm->fq_out2in_index;
 107       get_worker = sm->worker_out2in_cb;
 108     }
 109
 110   while (n_left_from > 0)
 111     {
 112       u32 sw_if_index0;
 113       u32 rx_fib_index0;
 114       ip4_header_t *ip0;
 115
 116       sw_if_index0 = vnet_buffer (b[0])->sw_if_index[VLIB_RX];
 117       rx_fib_index0 = ip4_fib_table_get_index_for_sw_if_index (sw_if_index0);
 118       ip0 = vlib_buffer_get_current (b[0]);
 119       ti[0] = get_worker (ip0, rx_fib_index0);
 120
 121       if (ti[0] != thread_index)
 122         do_handoff++;
 123       else
 124         same_worker++;
 125
 126       if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
 127                          && (b[0]->flags & VLIB_BUFFER_IS_TRACED)))
 128         {
 129           nat44_handoff_trace_t *t =
 130             vlib_add_trace (vm, node, b[0], sizeof (*t));
 131           t->next_worker_index = ti[0];
 132           t->in2out = is_in2out;
 133         }
 134
 135       n_left_from -= 1;
 136       ti += 1;
 137       b += 1;
 138     }
 139
 140   n_enq =
 141     vlib_buffer_enqueue_to_thread (vm, fq_index, from, thread_indices,
 142                                    frame->n_vectors, 1);
 143
 144   if (n_enq < frame->n_vectors)
 145     vlib_node_increment_counter (vm, node->node_index,
 146                                  NAT44_HANDOFF_ERROR_CONGESTION_DROP,
 147                                  frame->n_vectors - n_enq);
 148   vlib_node_increment_counter (vm, node->node_index,
 149                                NAT44_HANDOFF_ERROR_SAME_WORKER, same_worker);
 150   vlib_node_increment_counter (vm, node->node_index,
 151                                NAT44_HANDOFF_ERROR_DO_HANDOFF, do_handoff);
 152   return frame->n_vectors;
 153 }
 154
 155 static uword
 156 snat_in2out_worker_handoff_fn (vlib_main_t * vm,
 157                                vlib_node_runtime_t * node,
 158                                vlib_frame_t * frame)
 159 {
 160   return nat44_worker_handoff_fn_inline (vm, node, frame, 0, 1);
 161 }
 162
 163 /* *INDENT-OFF* */
 164 VLIB_REGISTER_NODE (snat_in2out_worker_handoff_node) = {
 165   .function = snat_in2out_worker_handoff_fn,
 166   .name = "nat44-in2out-worker-handoff",
 167   .vector_size = sizeof (u32),
 168   .format_trace = format_nat44_handoff_trace,
 169   .type = VLIB_NODE_TYPE_INTERNAL,
 170   .n_errors = ARRAY_LEN(nat44_handoff_error_strings),
 171   .error_strings = nat44_handoff_error_strings,
 172   .n_next_nodes = 1,
 173   .next_nodes = {
 174     [0] = "error-drop",
 175   },
 176 };
 177 /* *INDENT-ON* */
 178
 179 VLIB_NODE_FUNCTION_MULTIARCH (snat_in2out_worker_handoff_node,
 180                               snat_in2out_worker_handoff_fn);
 181
 182 static uword
 183 snat_in2out_output_worker_handoff_fn (vlib_main_t * vm,
 184                                       vlib_node_runtime_t * node,
 185                                       vlib_frame_t * frame)
 186 {
 187   return nat44_worker_handoff_fn_inline (vm, node, frame, 1, 1);
 188 }
 189
 190 /* *INDENT-OFF* */
 191 VLIB_REGISTER_NODE (snat_in2out_output_worker_handoff_node) = {
 192   .function = snat_in2out_output_worker_handoff_fn,
 193   .name = "nat44-in2out-output-worker-handoff",
 194   .vector_size = sizeof (u32),
 195   .format_trace = format_nat44_handoff_trace,
 196   .type = VLIB_NODE_TYPE_INTERNAL,
 197   .n_errors = ARRAY_LEN(nat44_handoff_error_strings),
 198   .error_strings = nat44_handoff_error_strings,
 199   .n_next_nodes = 1,
 200   .next_nodes = {
 201     [0] = "error-drop",
 202   },
 203 };
 204 /* *INDENT-ON* */
 205
 206 VLIB_NODE_FUNCTION_MULTIARCH (snat_in2out_output_worker_handoff_node,
 207                               snat_in2out_output_worker_handoff_fn);
 208
 209 static uword
 210 snat_out2in_worker_handoff_fn (vlib_main_t * vm,
 211                                vlib_node_runtime_t * node,
 212                                vlib_frame_t * frame)
 213 {
 214   return nat44_worker_handoff_fn_inline (vm, node, frame, 0, 0);
 215 }
 216
 217 /* *INDENT-OFF* */
 218 VLIB_REGISTER_NODE (snat_out2in_worker_handoff_node) = {
 219   .function = snat_out2in_worker_handoff_fn,
 220   .name = "nat44-out2in-worker-handoff",
 221   .vector_size = sizeof (u32),
 222   .format_trace = format_nat44_handoff_trace,
 223   .type = VLIB_NODE_TYPE_INTERNAL,
 224   .n_errors = ARRAY_LEN(nat44_handoff_error_strings),
 225   .error_strings = nat44_handoff_error_strings,
 226   .n_next_nodes = 1,
 227   .next_nodes = {
 228     [0] = "error-drop",
 229   },
 230 };
 231 /* *INDENT-ON* */
 232
 233 VLIB_NODE_FUNCTION_MULTIARCH (snat_out2in_worker_handoff_node,
 234                               snat_out2in_worker_handoff_fn);
 235
 236 /*
 237  * fd.io coding-style-patch-verification: ON
 238  *
 239  * Local Variables:
 240  * eval: (c-set-style "gnu")
 241  * End:
 242  */