src/plugins/nsim/nsim_input.c

   1 /*
   2  * nsim.c - skeleton vpp engine plug-in
   3  *
   4  * Copyright (c) <current-year> <your-organization>
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include <vlib/vlib.h>
  19 #include <vnet/vnet.h>
  20 #include <vnet/pg/pg.h>
  21 #include <vppinfra/error.h>
  22 #include <nsim/nsim.h>
  23
  24 typedef struct
  25 {
  26   f64 expired;
  27   u32 tx_sw_if_index;
  28 } nsim_tx_trace_t;
  29
  30 #ifndef CLIB_MARCH_VARIANT
  31 /* packet trace format function */
  32 static u8 *
  33 format_nsim_tx_trace (u8 * s, va_list * args)
  34 {
  35   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  36   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  37   nsim_tx_trace_t *t = va_arg (*args, nsim_tx_trace_t *);
  38
  39   s = format (s, "NSIM: tx at %.6f sw_if_index %d",
  40               t->expired, t->tx_sw_if_index);
  41   return s;
  42 }
  43 #endif /* CLIB_MARCH_VARIANT */
  44
  45 #define foreach_nsim_tx_error                      \
  46 _(TX, "Packets transmitted")                    \
  47 _(DROPPED, "No buffer drops")
  48
  49 typedef enum
  50 {
  51 #define _(sym,str) NSIM_TX_ERROR_##sym,
  52   foreach_nsim_tx_error
  53 #undef _
  54     NSIM_N_ERROR,
  55 } nsim_tx_error_t;
  56
  57 #ifndef CLIB_MARCH_VARIANT
  58 static char *nsim_tx_error_strings[] = {
  59 #define _(sym,string) string,
  60   foreach_nsim_tx_error
  61 #undef _
  62 };
  63 #endif /* CLIB_MARCH_VARIANT */
  64
  65 typedef enum
  66 {
  67   NSIM_NEXT_DROP,
  68   NSIM_N_NEXT,
  69 } nsim_next_t;
  70
  71 always_inline uword
  72 nsim_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
  73                    vlib_frame_t * f, int is_trace)
  74 {
  75   nsim_main_t *nsm = &nsim_main;
  76   u32 my_thread_index = vm->thread_index;
  77   u32 *my_buffer_cache = nsm->buffer_indices_by_thread[my_thread_index];
  78   nsim_wheel_t *wp = nsm->wheel_by_thread[my_thread_index];
  79   u32 n_trace = vlib_get_trace_count (vm, node);
  80   f64 now = vlib_time_now (vm);
  81   uword n_rx_packets = 0;
  82   vlib_buffer_t *b0;
  83   u32 bi0, next0;
  84   vlib_buffer_free_list_t *fl;
  85   u32 *to_next;
  86   u32 next_index;
  87   u32 n_left_to_next;
  88   nsim_wheel_entry_t *ep;
  89
  90   /* Nothing on the scheduler wheel? */
  91   if (wp->cursize == 0)
  92     return 0;
  93
  94   /* First entry on the wheel isn't expired? */
  95   ep = wp->entries + wp->head;
  96   if (ep->tx_time > now)
  97     return n_rx_packets;
  98
  99   /*
 100    * We use per-thread buffer caches, so we need the freelist to
 101    * initialize them...
 102    */
 103   fl = vlib_buffer_get_free_list (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
 104   next_index = node->cached_next_index;
 105
 106   while (wp->cursize)
 107     {
 108       /* Be aware: this is not the usual coding pattern */
 109       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 110
 111       while (n_left_to_next > 0 && ep->tx_time <= now)
 112         {
 113           /* Out of local buffer cache? */
 114           if (PREDICT_FALSE (_vec_len (my_buffer_cache) == 0))
 115             {
 116               u32 n =
 117                 vlib_buffer_alloc (vm, my_buffer_cache, VLIB_FRAME_SIZE);
 118               _vec_len (my_buffer_cache) = n;
 119
 120               /* Ugh, drop the rest of the expired entries */
 121               if (n == 0)
 122                 {
 123                   u32 drops = 0;
 124                   while (ep->tx_time <= now && wp->cursize)
 125                     {
 126                       wp->head++;
 127                       if (wp->head == wp->wheel_size)
 128                         wp->head = 0;
 129                       ep = wp->entries + wp->head;
 130                       wp->cursize--;
 131                       drops++;
 132                     }
 133                   /* Count the drops */
 134                   vlib_node_increment_counter (vm, node->node_index,
 135                                                NSIM_TX_ERROR_DROPPED, drops);
 136                   /* Ship any pkts we already processed */
 137                   vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 138                   return n_rx_packets + drops;
 139                 }
 140             }
 141
 142           /* Allocate a buffer */
 143           bi0 = my_buffer_cache[_vec_len (my_buffer_cache) - 1];
 144           _vec_len (my_buffer_cache) -= 1;
 145
 146           to_next[0] = bi0;
 147           to_next += 1;
 148           n_left_to_next -= 1;
 149
 150           b0 = vlib_get_buffer (vm, bi0);
 151           /* Initialize the buffer */
 152           vlib_buffer_init_for_free_list (b0, fl);
 153
 154           b0->current_data = 0;
 155           b0->current_length = ep->current_length;
 156
 157           VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
 158
 159           if (PREDICT_FALSE (n_trace))
 160             {
 161               nsim_tx_trace_t *t0;
 162               vlib_trace_buffer (vm, node, next_index, b0,
 163                                  0 /* follow_chain */ );
 164               t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
 165               t0->expired = ep->tx_time;
 166               t0->tx_sw_if_index = ep->tx_sw_if_index;
 167             }
 168
 169           /* Copy data from the ring */
 170           clib_memcpy_fast (b0->data, ep->data, ep->current_length);
 171           b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
 172           vnet_buffer (b0)->sw_if_index[VLIB_TX] = ep->tx_sw_if_index;
 173           vnet_buffer (b0)->sw_if_index[VLIB_RX] =
 174             (ep->tx_sw_if_index == nsm->sw_if_index0) ? nsm->sw_if_index1 :
 175             nsm->sw_if_index0;
 176           next0 = (ep->tx_sw_if_index == nsm->sw_if_index0) ?
 177             nsm->output_next_index0 : nsm->output_next_index1;
 178
 179           /* verify speculative enqueue, maybe switch current next frame */
 180           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 181                                            to_next, n_left_to_next,
 182                                            bi0, next0);
 183           /* Advance to the next ring entry */
 184           wp->head++;
 185           if (wp->head == wp->wheel_size)
 186             wp->head = 0;
 187           wp->cursize--;
 188           ep = wp->entries + wp->head;
 189           n_rx_packets++;
 190
 191           /* Out of ring entries? */
 192           if (PREDICT_FALSE (wp->cursize == 0))
 193             break;
 194         }
 195
 196       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 197
 198       /* If the current entry hasn't expired, we're done */
 199       if (ep->tx_time > now)
 200         break;
 201     }
 202   return n_rx_packets;
 203 }
 204
 205 VLIB_NODE_FN (nsim_input_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
 206                                 vlib_frame_t * frame)
 207 {
 208   if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
 209     return nsim_input_inline (vm, node, frame, 1 /* is_trace */ );
 210   else
 211     return nsim_input_inline (vm, node, frame, 0 /* is_trace */ );
 212
 213 }
 214
 215 /* *INDENT-OFF* */
 216 #ifndef CLIB_MARCH_VARIANT
 217 VLIB_REGISTER_NODE (nsim_input_node) =
 218 {
 219   .type = VLIB_NODE_TYPE_INPUT,
 220   .name = "nsim-wheel",
 221
 222   /* Will be enabled if/when the feature is configured */
 223   .state = VLIB_NODE_STATE_DISABLED,
 224
 225   .format_trace = format_nsim_tx_trace,
 226
 227   .n_errors = NSIM_N_ERROR,
 228   .error_strings = nsim_tx_error_strings,
 229 };
 230 #endif /* CLIB_MARCH_VARIANT */
 231 /* *INDENT-ON* */
 232
 233 /*
 234  * fd.io coding-style-patch-verification: ON
 235  *
 236  * Local Variables:
 237  * eval: (c-set-style "gnu")
 238  * End:
 239  */