src/vnet/handoff.c

   1
   2 /*
   3  * Copyright (c) 2016 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <vnet/vnet.h>
  18 #include <vnet/hash/hash.h>
  19 #include <vlib/threads.h>
  20 #include <vnet/feature/feature.h>
  21
  22 typedef struct
  23 {
  24   vnet_hash_fn_t hash_fn;
  25   uword *workers_bitmap;
  26   u32 *workers;
  27 } per_inteface_handoff_data_t;
  28
  29 typedef struct
  30 {
  31   u32 cached_next_index;
  32   u32 num_workers;
  33   u32 first_worker_index;
  34
  35   per_inteface_handoff_data_t *if_data;
  36
  37   /* Worker handoff index */
  38   u32 frame_queue_index;
  39 } handoff_main_t;
  40
  41 extern handoff_main_t handoff_main;
  42
  43 #ifndef CLIB_MARCH_VARIANT
  44
  45 handoff_main_t handoff_main;
  46
  47 #endif /* CLIB_MARCH_VARIANT */
  48
  49 typedef struct
  50 {
  51   u32 sw_if_index;
  52   u32 next_worker_index;
  53   u32 buffer_index;
  54 } worker_handoff_trace_t;
  55
  56 #define foreach_worker_handoff_error                    \
  57   _(CONGESTION_DROP, "congestion drop")
  58
  59 typedef enum
  60 {
  61 #define _(sym,str) WORKER_HANDOFF_ERROR_##sym,
  62   foreach_worker_handoff_error
  63 #undef _
  64     WORKER_HANDOFF_N_ERROR,
  65 } worker_handoff_error_t;
  66
  67 static char *worker_handoff_error_strings[] = {
  68 #define _(sym,string) string,
  69   foreach_worker_handoff_error
  70 #undef _
  71 };
  72
  73 /* packet trace format function */
  74 static u8 *
  75 format_worker_handoff_trace (u8 * s, va_list * args)
  76 {
  77   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  78   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  79   worker_handoff_trace_t *t = va_arg (*args, worker_handoff_trace_t *);
  80
  81   s = format (s, "worker-handoff: sw_if_index %d, next_worker %d, buffer 0x%x",
  82               t->sw_if_index, t->next_worker_index, t->buffer_index);
  83   return s;
  84 }
  85
  86 static void
  87 worker_handoff_trace_frame (vlib_main_t *vm, vlib_node_runtime_t *node,
  88                             vlib_buffer_t **bufs, u16 *threads, u32 n_vectors)
  89 {
  90   worker_handoff_trace_t *t;
  91   vlib_buffer_t **b;
  92   u16 *ti;
  93
  94   b = bufs;
  95   ti = threads;
  96
  97   while (n_vectors)
  98     {
  99       t = vlib_add_trace (vm, node, b[0], sizeof (*t));
 100       t->sw_if_index = vnet_buffer (b[0])->sw_if_index[VLIB_RX];
 101       t->next_worker_index = ti[0];
 102       t->buffer_index = vlib_get_buffer_index (vm, b[0]);
 103
 104       b += 1;
 105       ti += 1;
 106       n_vectors -= 1;
 107     }
 108 }
 109
 110 VLIB_NODE_FN (worker_handoff_node) (vlib_main_t * vm,
 111                                     vlib_node_runtime_t * node,
 112                                     vlib_frame_t * frame)
 113 {
 114   handoff_main_t *hm = &handoff_main;
 115   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
 116   u32 n_enq, n_left_from, *from;
 117   u16 thread_indices[VLIB_FRAME_SIZE], *ti;
 118
 119   from = vlib_frame_vector_args (frame);
 120   n_left_from = frame->n_vectors;
 121   vlib_get_buffers (vm, from, bufs, n_left_from);
 122
 123   b = bufs;
 124   ti = thread_indices;
 125
 126   while (n_left_from > 0)
 127     {
 128       per_inteface_handoff_data_t *ihd0;
 129       u32 sw_if_index0, hash, index0;
 130       void *data;
 131
 132       sw_if_index0 = vnet_buffer (b[0])->sw_if_index[VLIB_RX];
 133       ihd0 = vec_elt_at_index (hm->if_data, sw_if_index0);
 134
 135       /* Compute ingress LB hash */
 136       data = vlib_buffer_get_current (b[0]);
 137       ihd0->hash_fn (&data, &hash, 1);
 138
 139       /* if input node did not specify next index, then packet
 140          should go to ethernet-input */
 141
 142       if (PREDICT_TRUE (is_pow2 (vec_len (ihd0->workers))))
 143         index0 = hash & (vec_len (ihd0->workers) - 1);
 144       else
 145         index0 = hash % vec_len (ihd0->workers);
 146
 147       ti[0] = hm->first_worker_index + ihd0->workers[index0];
 148
 149       /* next */
 150       n_left_from -= 1;
 151       ti += 1;
 152       b += 1;
 153     }
 154
 155   if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
 156     worker_handoff_trace_frame (vm, node, bufs, thread_indices,
 157                                 frame->n_vectors);
 158
 159   n_enq = vlib_buffer_enqueue_to_thread (vm, node, hm->frame_queue_index, from,
 160                                          thread_indices, frame->n_vectors, 1);
 161
 162   if (n_enq < frame->n_vectors)
 163     vlib_node_increment_counter (vm, node->node_index,
 164                                  WORKER_HANDOFF_ERROR_CONGESTION_DROP,
 165                                  frame->n_vectors - n_enq);
 166   return frame->n_vectors;
 167 }
 168
 169 VLIB_REGISTER_NODE (worker_handoff_node) = {
 170   .name = "worker-handoff",
 171   .vector_size = sizeof (u32),
 172   .format_trace = format_worker_handoff_trace,
 173   .type = VLIB_NODE_TYPE_INTERNAL,
 174   .n_errors = ARRAY_LEN(worker_handoff_error_strings),
 175   .error_strings = worker_handoff_error_strings,
 176
 177   .n_next_nodes = 1,
 178   .next_nodes = {
 179     [0] = "error-drop",
 180   },
 181 };
 182
 183 #ifndef CLIB_MARCH_VARIANT
 184
 185 int
 186 interface_handoff_enable_disable (vlib_main_t *vm, u32 sw_if_index,
 187                                   uword *bitmap, u8 is_sym, int is_l4,
 188                                   int enable_disable)
 189 {
 190   handoff_main_t *hm = &handoff_main;
 191   vnet_sw_interface_t *sw;
 192   vnet_main_t *vnm = vnet_get_main ();
 193   per_inteface_handoff_data_t *d;
 194   int i, rv = 0;
 195
 196   if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
 197     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
 198
 199   sw = vnet_get_sw_interface (vnm, sw_if_index);
 200   if (sw->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
 201     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
 202
 203   if (clib_bitmap_last_set (bitmap) >= hm->num_workers)
 204     return VNET_API_ERROR_INVALID_WORKER;
 205
 206   if (hm->frame_queue_index == ~0)
 207     {
 208       vlib_node_t *n = vlib_get_node_by_name (vm, (u8 *) "ethernet-input");
 209       hm->frame_queue_index = vlib_frame_queue_main_init (n->index, 0);
 210     }
 211
 212   vec_validate (hm->if_data, sw_if_index);
 213   d = vec_elt_at_index (hm->if_data, sw_if_index);
 214
 215   vec_free (d->workers);
 216   vec_free (d->workers_bitmap);
 217
 218   if (enable_disable)
 219     {
 220       d->workers_bitmap = bitmap;
 221       clib_bitmap_foreach (i, bitmap)
 222         {
 223           vec_add1(d->workers, i);
 224         }
 225
 226       if (is_sym)
 227         {
 228           if (is_l4)
 229             return VNET_API_ERROR_UNIMPLEMENTED;
 230
 231           d->hash_fn = vnet_hash_function_from_name (
 232             "handoff-eth-sym", VNET_HASH_FN_TYPE_ETHERNET);
 233         }
 234       else
 235         {
 236           if (is_l4)
 237             d->hash_fn =
 238               vnet_hash_default_function (VNET_HASH_FN_TYPE_ETHERNET);
 239           else
 240             d->hash_fn = vnet_hash_function_from_name (
 241               "handoff-eth", VNET_HASH_FN_TYPE_ETHERNET);
 242         }
 243     }
 244
 245   vnet_feature_enable_disable ("device-input", "worker-handoff",
 246                                sw_if_index, enable_disable, 0, 0);
 247   vnet_feature_enable_disable ("port-rx-eth", "worker-handoff", sw_if_index,
 248                                enable_disable, 0, 0);
 249   return rv;
 250 }
 251
 252 static clib_error_t *
 253 set_interface_handoff_command_fn (vlib_main_t * vm,
 254                                   unformat_input_t * input,
 255                                   vlib_cli_command_t * cmd)
 256 {
 257   u32 sw_if_index = ~0, is_sym = 0, is_l4 = 0;
 258   int enable_disable = 1;
 259   uword *bitmap = 0;
 260   int rv = 0;
 261
 262   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 263     {
 264       if (unformat (input, "disable"))
 265         enable_disable = 0;
 266       else if (unformat (input, "workers %U", unformat_bitmap_list, &bitmap))
 267         ;
 268       else if (unformat (input, "%U", unformat_vnet_sw_interface,
 269                          vnet_get_main (), &sw_if_index))
 270         ;
 271       else if (unformat (input, "symmetrical"))
 272         is_sym = 1;
 273       else if (unformat (input, "asymmetrical"))
 274         is_sym = 0;
 275       else if (unformat (input, "l4"))
 276         is_l4 = 1;
 277       else
 278         break;
 279     }
 280
 281   if (sw_if_index == ~0)
 282     return clib_error_return (0, "Please specify an interface...");
 283
 284   if (bitmap == 0)
 285     return clib_error_return (0, "Please specify list of workers...");
 286
 287   rv = interface_handoff_enable_disable (vm, sw_if_index, bitmap, is_sym,
 288                                          is_l4, enable_disable);
 289
 290   switch (rv)
 291     {
 292     case 0:
 293       break;
 294
 295     case VNET_API_ERROR_INVALID_SW_IF_INDEX:
 296       return clib_error_return (0, "Invalid interface");
 297       break;
 298
 299     case VNET_API_ERROR_INVALID_WORKER:
 300       return clib_error_return (0, "Invalid worker(s)");
 301       break;
 302
 303     case VNET_API_ERROR_UNIMPLEMENTED:
 304       return clib_error_return (0,
 305                                 "Device driver doesn't support redirection");
 306       break;
 307
 308     default:
 309       return clib_error_return (0, "unknown return value %d", rv);
 310     }
 311
 312   return 0;
 313 }
 314
 315 VLIB_CLI_COMMAND (set_interface_handoff_command, static) = {
 316   .path = "set interface handoff",
 317   .short_help = "set interface handoff <interface-name> workers <workers-list>"
 318                 " [symmetrical|asymmetrical]",
 319   .function = set_interface_handoff_command_fn,
 320 };
 321
 322 clib_error_t *
 323 handoff_init (vlib_main_t * vm)
 324 {
 325   handoff_main_t *hm = &handoff_main;
 326   vlib_thread_main_t *tm = vlib_get_thread_main ();
 327   clib_error_t *error;
 328   uword *p;
 329
 330   if ((error = vlib_call_init_function (vm, threads_init)))
 331     return error;
 332
 333   vlib_thread_registration_t *tr;
 334   /* Only the standard vnet worker threads are supported */
 335   p = hash_get_mem (tm->thread_registrations_by_name, "workers");
 336   if (p)
 337     {
 338       tr = (vlib_thread_registration_t *) p[0];
 339       if (tr)
 340         {
 341           hm->num_workers = tr->count;
 342           hm->first_worker_index = tr->first_index;
 343         }
 344     }
 345
 346   hm->frame_queue_index = ~0;
 347
 348   return 0;
 349 }
 350
 351 VLIB_INIT_FUNCTION (handoff_init);
 352
 353 #endif /* CLIB_MARCH_VARIANT */
 354 /*
 355  * fd.io coding-style-patch-verification: ON
 356  *
 357  * Local Variables:
 358  * eval: (c-set-style "gnu")
 359  * End:
 360  */