src/plugins/nsim/nsim.h

   1
   2 /*
   3  * nsim.h - skeleton vpp engine plug-in header file
   4  *
   5  * Copyright (c) <current-year> <your-organization>
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 #ifndef __included_nsim_h__
  19 #define __included_nsim_h__
  20
  21 #include <vnet/vnet.h>
  22 #include <vnet/ip/ip.h>
  23 #include <vnet/ethernet/ethernet.h>
  24
  25 #include <vppinfra/hash.h>
  26 #include <vppinfra/error.h>
  27
  28 #define NSIM_MAX_TX_BURST 32    /**< max packets in a tx burst */
  29
  30 typedef struct
  31 {
  32   f64 tx_time;
  33   u32 rx_sw_if_index;
  34   u32 tx_sw_if_index;
  35   u32 output_next_index;
  36   u32 buffer_index;
  37   u32 pad;                      /* pad to 32-bytes */
  38 } nsim_wheel_entry_t;
  39
  40 typedef struct
  41 {
  42   u32 wheel_size;
  43   u32 cursize;
  44   u32 head;
  45   u32 tail;
  46   nsim_wheel_entry_t *entries;
  47     CLIB_CACHE_LINE_ALIGN_MARK (pad);
  48 } nsim_wheel_t;
  49
  50 typedef struct nsim_node_ctx
  51 {
  52   vnet_feature_config_main_t *fcm;
  53   f64 expires;
  54   u32 *drop;
  55   u32 *reord;
  56   u16 *reord_nexts;
  57   u8 *action;
  58   u64 n_buffered;
  59   u64 n_loss;
  60 } nsim_node_ctx_t;
  61
  62 #define foreach_nsm_action                      \
  63   _(DROP, "Packet loss")                        \
  64   _(REORDER, "Packet reorder")
  65
  66 enum nsm_action_bit
  67 {
  68 #define _(sym, str) NSIM_ACTION_##sym##_BIT,
  69   foreach_nsm_action
  70 #undef _
  71 };
  72
  73 typedef enum nsm_action
  74 {
  75 #define _(sym, str) NSIM_ACTION_##sym = 1 << NSIM_ACTION_##sym##_BIT,
  76   foreach_nsm_action
  77 #undef _
  78 } nsm_action_e;
  79
  80 typedef struct
  81 {
  82   /* API message ID base */
  83   u16 msg_id_base;
  84
  85   /* output feature arc index */
  86   u16 arc_index;
  87
  88   /* Two interfaces, cross-connected with delay */
  89   u32 sw_if_index0, sw_if_index1;
  90   u32 output_next_index0, output_next_index1;
  91
  92   /* N interfaces, using the output feature */
  93   u32 *output_next_index_by_sw_if_index;
  94
  95   /* Random seed for loss-rate simulation */
  96   u32 seed;
  97
  98   /* Per-thread scheduler wheels */
  99   nsim_wheel_t **wheel_by_thread;
 100
 101   /* Config parameters */
 102   f64 delay;
 103   f64 bandwidth;
 104   f64 drop_fraction;
 105   f64 reorder_fraction;
 106   u32 packet_size;
 107   u32 wheel_slots_per_wrk;
 108   u32 poll_main_thread;
 109
 110   u64 mmap_size;
 111
 112   /* Wheels are configured */
 113   int is_configured;
 114
 115   /* convenience */
 116   vlib_main_t *vlib_main;
 117   vnet_main_t *vnet_main;
 118 } nsim_main_t;
 119
 120 extern nsim_main_t nsim_main;
 121
 122 extern vlib_node_registration_t nsim_node;
 123 extern vlib_node_registration_t nsim_input_node;
 124
 125 #endif /* __included_nsim_h__ */
 126
 127 /*
 128  * fd.io coding-style-patch-verification: ON
 129  *
 130  * Local Variables:
 131  * eval: (c-set-style "gnu")
 132  * End:
 133  */