Network delay simulator plugin

Change-Id: I4a70c7df8f0cb368a4e1cb16f30eeef5c6058c79
Signed-off-by: Dave Barach <dave@barachs.net>

src/plugins/nsim/CMakeLists.txt

@@ -0,0 +1,33 @@
+# Copyright (c) 2018 Cisco and/or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+add_vpp_plugin(nsim
+  SOURCES
+  nsim.c
+  node.c
+  nsim_input.c
+
+  MULTIARCH_SOURCES
+  nsim_input.c
+  node.c
+
+  API_FILES
+  nsim.api
+
+  INSTALL_HEADERS
+  nsim_all_api_h.h
+  nsim_msg_enum.h
+
+  API_TEST_SOURCES
+  nsim_test.c
+)

src/plugins/nsim/node.c

@@ -0,0 +1,187 @@
+/*
+ * node.c - skeleton vpp engine plug-in dual-loop node skeleton
+ *
+ * Copyright (c) <current-year> <your-organization>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#include <vlib/vlib.h>
+#include <vnet/vnet.h>
+#include <vnet/pg/pg.h>
+#include <vppinfra/error.h>
+#include <nsim/nsim.h>
+
+typedef struct
+{
+  f64 expires;
+  u32 tx_sw_if_index;
+  int is_drop;
+} nsim_trace_t;
+
+#ifndef CLIB_MARCH_VARIANT
+
+/* packet trace format function */
+static u8 *
+format_nsim_trace (u8 * s, va_list * args)
+{
+  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
+  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
+  nsim_trace_t *t = va_arg (*args, nsim_trace_t *);
+
+  if (t->is_drop)
+    s = format (s, "NSIM: ring drop");
+  else
+    s = format (s, "NSIM: tx time %.6f sw_if_index %d",
+		t->expires, t->tx_sw_if_index);
+
+  return s;
+}
+#endif /* CLIB_MARCH_VARIANT */
+
+vlib_node_registration_t nsim_node;
+
+#define foreach_nsim_error                              \
+_(BUFFERED, "Packets buffered")                         \
+_(DROPPED, "Packets dropped due to lack of space")
+
+typedef enum
+{
+#define _(sym,str) NSIM_ERROR_##sym,
+  foreach_nsim_error
+#undef _
+    NSIM_N_ERROR,
+} nsim_error_t;
+
+#ifndef CLIB_MARCH_VARIANT
+static char *nsim_error_strings[] = {
+#define _(sym,string) string,
+  foreach_nsim_error
+#undef _
+};
+#endif /* CLIB_MARCH_VARIANT */
+
+typedef enum
+{
+  NSIM_NEXT_DROP,
+  NSIM_N_NEXT,
+} nsim_next_t;
+
+always_inline uword
+nsim_inline (vlib_main_t * vm,
+	     vlib_node_runtime_t * node, vlib_frame_t * frame, int is_trace)
+{
+  nsim_main_t *nsm = &nsim_main;
+  u32 n_left_from, *from;
+  vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
+  u16 nexts[VLIB_FRAME_SIZE], *next;
+  u32 my_thread_index = vm->thread_index;
+  nsim_wheel_t *wp = nsm->wheel_by_thread[my_thread_index];
+  f64 now = vlib_time_now (vm);
+  f64 expires = now + nsm->delay;
+  int is_drop0;
+  u32 no_error = node->errors[NSIM_ERROR_BUFFERED];
+  u32 no_buffer_error = node->errors[NSIM_ERROR_DROPPED];
+  nsim_wheel_entry_t *ep = 0;
+
+  ASSERT (wp);
+
+  from = vlib_frame_vector_args (frame);
+  n_left_from = frame->n_vectors;
+
+  vlib_get_buffers (vm, from, bufs, n_left_from);
+  b = bufs;
+  next = nexts;
+
+  /* There is no point in trying to do more than 1 pkt here */
+  while (n_left_from > 0)
+    {
+      b[0]->error = no_error;
+      next[0] = NSIM_NEXT_DROP;
+      is_drop0 = 0;
+      if (PREDICT_TRUE (wp->cursize < wp->wheel_size))
+	{
+	  ep = wp->entries + wp->tail;
+	  wp->tail++;
+	  if (wp->tail == wp->wheel_size)
+	    wp->tail = 0;
+	  wp->cursize++;
+
+	  ep->tx_time = expires;
+	  ep->tx_sw_if_index =
+	    (vnet_buffer (b[0])->sw_if_index[VLIB_RX] == nsm->sw_if_index0)
+	    ? nsm->sw_if_index1 : nsm->sw_if_index0;
+	  ep->current_length = vlib_buffer_length_in_chain (vm, b[0]);
+	  ASSERT (ep->current_length <= WHEEL_ENTRY_DATA_SIZE);
+	  clib_memcpy (ep->data, vlib_buffer_get_current (b[0]),
+		       ep->current_length);
+	}
+      else			/* out of wheel space, drop pkt */
+	b[0]->error = no_buffer_error;
+
+      if (is_trace)
+	{
+	  if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
+	    {
+	      nsim_trace_t *t = vlib_add_trace (vm, node, b[0], sizeof (*t));
+	      t->expires = expires;
+	      t->is_drop = is_drop0;
+	      if (is_drop0 == 0)
+		t->tx_sw_if_index = ep->tx_sw_if_index;
+	    }
+	}
+
+      b += 1;
+      next += 1;
+      n_left_from -= 1;
+    }
+  vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
+  return frame->n_vectors;
+}
+
+VLIB_NODE_FN (nsim_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
+			  vlib_frame_t * frame)
+{
+  if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
+    return nsim_inline (vm, node, frame, 1 /* is_trace */ );
+  else
+    return nsim_inline (vm, node, frame, 0 /* is_trace */ );
+}
+
+/* *INDENT-OFF* */
+#ifndef CLIB_MARCH_VARIANT
+VLIB_REGISTER_NODE (nsim_node) =
+{
+  .name = "nsim",
+  .vector_size = sizeof (u32),
+  .format_trace = format_nsim_trace,
+  .type = VLIB_NODE_TYPE_INTERNAL,
+
+  .n_errors = ARRAY_LEN(nsim_error_strings),
+  .error_strings = nsim_error_strings,
+
+  .n_next_nodes = NSIM_N_NEXT,
+
+  /* edit / add dispositions here */
+  .next_nodes = {
+        [NSIM_NEXT_DROP] = "error-drop",
+  },
+};
+#endif /* CLIB_MARCH_VARIANT */
+/* *INDENT-ON* */
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */

src/plugins/nsim/nsim.api

@@ -0,0 +1,50 @@
+/**
+ * @file nsim.api
+ * @brief VPP control-plane API messages for the network delay simulator
+ */
+
+option version = "1.0.0";
+
+/** \brief enable / disable the network delay simulation cross-connect
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param enable_disable - enable or disable the feature
+    @param sw_if_index0 - one interface to cross-connect
+    @param sw_if_index1 - the other interface to cross-connect
+*/
+autoreply define nsim_enable_disable 
+{
+  /* Client identifier, set from api_main.my_client_index */
+  u32 client_index;
+  
+  /* Arbitrary context, so client can match reply to request */
+  u32 context;
+  
+  /* Enable / disable the feature on the interfaces */
+  u8 enable_disable;
+  
+  /* Interface handles */
+  u32 sw_if_index0;
+  u32 sw_if_index1;
+};
+
+/** \brief configure the network delay simulation cross-connect
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param delay_in_usec - microseconds of link delay to simulate
+    @param average_packet_size - average packet size for wheel sizing
+    @param bandwidth_in_bits_per_second - bps for wheel sizing
+*/
+autoreply define nsim_configure
+{
+  /* Client identifier, set from api_main.my_client_index */
+  u32 client_index;
+  
+  /* Arbitrary context, so client can match reply to request */
+  u32 context;
+
+  /* Configuration parameters */
+  u32 delay_in_usec;
+  u32 average_packet_size;
+  u64 bandwidth_in_bits_per_second;
+};

src/plugins/nsim/nsim.h

@@ -0,0 +1,90 @@
+
+/*
+ * nsim.h - skeleton vpp engine plug-in header file
+ *
+ * Copyright (c) <current-year> <your-organization>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef __included_nsim_h__
+#define __included_nsim_h__
+
+#include <vnet/vnet.h>
+#include <vnet/ip/ip.h>
+#include <vnet/ethernet/ethernet.h>
+
+#include <vppinfra/hash.h>
+#include <vppinfra/error.h>
+
+#define WHEEL_ENTRY_DATA_SIZE 1536	/* an even multiple of 64, pls */
+
+typedef struct
+{
+  f64 tx_time;
+  u32 tx_sw_if_index;
+  u32 current_length;
+    CLIB_CACHE_LINE_ALIGN_MARK (pad);
+  u8 data[WHEEL_ENTRY_DATA_SIZE];
+} nsim_wheel_entry_t;
+
+typedef struct
+{
+  u32 wheel_size;
+  u32 cursize;
+  u32 head;
+  u32 tail;
+  nsim_wheel_entry_t *entries;
+    CLIB_CACHE_LINE_ALIGN_MARK (pad);
+} nsim_wheel_t;
+
+typedef struct
+{
+  /* API message ID base */
+  u16 msg_id_base;
+
+  /* Two interfaces, cross-connected with delay */
+  u32 sw_if_index0, sw_if_index1;
+  u32 output_next_index0, output_next_index1;
+
+  /* Per-thread buffer / scheduler wheels */
+  nsim_wheel_t **wheel_by_thread;
+  u32 **buffer_indices_by_thread;
+
+  /* Config parameters */
+  f64 delay;
+  f64 bandwidth;
+  f64 packet_size;
+
+  u64 mmap_size;
+
+  /* Wheels are configured */
+  int is_configured;
+
+  /* convenience */
+  vlib_main_t *vlib_main;
+  vnet_main_t *vnet_main;
+} nsim_main_t;
+
+extern nsim_main_t nsim_main;
+
+extern vlib_node_registration_t nsim_node;
+extern vlib_node_registration_t nsim_input_node;
+
+#endif /* __included_nsim_h__ */
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */

src/plugins/nsim/nsim_all_api_h.h

@@ -0,0 +1,19 @@
+
+/*
+ * nsim_all_api_h.h - skeleton vpp engine plug-in api #include file
+ *
+ * Copyright (c) <current-year> <your-organization>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/* Include the generated file, see BUILT_SOURCES in Makefile.am */
+#include <nsim/nsim.api.h>

src/plugins/nsim/nsim_input.c

@@ -0,0 +1,228 @@
+/*
+ * nsim.c - skeleton vpp engine plug-in
+ *
+ * Copyright (c) <current-year> <your-organization>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <vlib/vlib.h>
+#include <vnet/vnet.h>
+#include <vnet/pg/pg.h>
+#include <vppinfra/error.h>
+#include <nsim/nsim.h>
+
+typedef struct
+{
+  f64 expired;
+  u32 tx_sw_if_index;
+} nsim_tx_trace_t;
+
+#ifndef CLIB_MARCH_VARIANT
+/* packet trace format function */
+static u8 *
+format_nsim_tx_trace (u8 * s, va_list * args)
+{
+  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
+  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
+  nsim_tx_trace_t *t = va_arg (*args, nsim_tx_trace_t *);
+
+  s = format (s, "NSIM: tx at %.6f sw_if_index %d",
+	      t->expired, t->tx_sw_if_index);
+  return s;
+}
+#endif /* CLIB_MARCH_VARIANT */
+
+vlib_node_registration_t nsim_node;
+
+#define foreach_nsim_tx_error                      \
+_(TX, "Packets transmitted")                    \
+_(DROPPED, "No buffer drops")
+
+typedef enum
+{
+#define _(sym,str) NSIM_TX_ERROR_##sym,
+  foreach_nsim_tx_error
+#undef _
+    NSIM_N_ERROR,
+} nsim_tx_error_t;
+
+#ifndef CLIB_MARCH_VARIANT
+static char *nsim_tx_error_strings[] = {
+#define _(sym,string) string,
+  foreach_nsim_tx_error
+#undef _
+};
+#endif /* CLIB_MARCH_VARIANT */
+
+typedef enum
+{
+  NSIM_NEXT_DROP,
+  NSIM_N_NEXT,
+} nsim_next_t;
+
+always_inline uword
+nsim_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
+		   vlib_frame_t * f, int is_trace)
+{
+  nsim_main_t *nsm = &nsim_main;
+  u32 my_thread_index = vm->thread_index;
+  u32 *my_buffer_cache = nsm->buffer_indices_by_thread[my_thread_index];
+  nsim_wheel_t *wp = nsm->wheel_by_thread[my_thread_index];
+  f64 now = vlib_time_now (vm);
+  uword n_rx_packets = 0;
+  vlib_buffer_t *b0;
+  u32 bi0, next0;
+  vlib_buffer_free_list_t *fl;
+  u32 *to_next;
+  u32 next_index;
+  u32 n_left_to_next;
+  nsim_wheel_entry_t *ep;
+
+  /* Nothing on the scheduler wheel? */
+  if (wp->cursize == 0)
+    return 0;
+
+  /* First entry on the wheel isn't expired? */
+  ep = wp->entries + wp->head;
+  if (ep->tx_time > now)
+    return n_rx_packets;
+
+  /*
+   * We use per-thread buffer caches, so we need the freelist to
+   * initialize them...
+   */
+  fl = vlib_buffer_get_free_list (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
+  next_index = node->cached_next_index;
+
+  while (wp->cursize)
+    {
+      /* Be aware: this is not the usual coding pattern */
+      vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
+
+      while (n_left_to_next > 0 && ep->tx_time <= now)
+	{
+	  /* Out of local buffer cache? */
+	  if (PREDICT_FALSE (_vec_len (my_buffer_cache) == 0))
+	    {
+	      u32 n =
+		vlib_buffer_alloc (vm, my_buffer_cache, VLIB_FRAME_SIZE);
+	      _vec_len (my_buffer_cache) = n;
+
+	      /* Ugh, drop the rest of the expired entries */
+	      if (n == 0)
+		{
+		  u32 drops = 0;
+		  while (ep->tx_time <= now && wp->cursize)
+		    {
+		      wp->head++;
+		      if (wp->head == wp->wheel_size)
+			wp->head = 0;
+		      ep = wp->entries + wp->head;
+		      wp->cursize--;
+		      drops++;
+		    }
+		  /* Count the drops */
+		  vlib_node_increment_counter (vm, node->node_index,
+					       NSIM_TX_ERROR_DROPPED, drops);
+		  /* Ship any pkts we already processed */
+		  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
+		  return n_rx_packets + drops;
+		}
+	    }
+
+	  /* Allocate a buffer */
+	  bi0 = my_buffer_cache[_vec_len (my_buffer_cache) - 1];
+	  _vec_len (my_buffer_cache) -= 1;
+
+	  to_next[0] = bi0;
+	  to_next += 1;
+	  n_left_to_next -= 1;
+
+	  b0 = vlib_get_buffer (vm, bi0);
+	  /* Initialize the buffer */
+	  vlib_buffer_init_for_free_list (b0, fl);
+
+	  b0->current_data = 0;
+	  b0->current_length = ep->current_length;
+
+	  /* Copy data from the ring */
+	  clib_memcpy (b0->data, ep->data, ep->current_length);
+	  b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
+	  vnet_buffer (b0)->sw_if_index[VLIB_TX] = ep->tx_sw_if_index;
+	  vnet_buffer (b0)->sw_if_index[VLIB_RX] =
+	    (ep->tx_sw_if_index == nsm->sw_if_index0) ? nsm->sw_if_index1 :
+	    nsm->sw_if_index0;
+	  next0 = (ep->tx_sw_if_index == nsm->sw_if_index0) ?
+	    nsm->output_next_index0 : nsm->output_next_index1;
+
+	  /* verify speculative enqueue, maybe switch current next frame */
+	  vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
+					   to_next, n_left_to_next,
+					   bi0, next0);
+	  /* Advance to the next ring entry */
+	  wp->head++;
+	  if (wp->head == wp->wheel_size)
+	    wp->head = 0;
+	  wp->cursize--;
+	  ep = wp->entries + wp->head;
+	  n_rx_packets++;
+
+	  /* Out of ring entries? */
+	  if (PREDICT_FALSE (wp->cursize == 0))
+	    break;
+	}
+
+      vlib_put_next_frame (vm, node, next_index, n_left_to_next);
+
+      /* If the current entry hasn't expired, we're done */
+      if (ep->tx_time > now)
+	break;
+    }
+  return n_rx_packets;
+}
+
+VLIB_NODE_FN (nsim_input_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
+				vlib_frame_t * frame)
+{
+  if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
+    return nsim_input_inline (vm, node, frame, 1 /* is_trace */ );
+  else
+    return nsim_input_inline (vm, node, frame, 0 /* is_trace */ );
+
+}
+
+/* *INDENT-OFF* */
+#ifndef CLIB_MARCH_VARIANT
+VLIB_REGISTER_NODE (nsim_input_node) =
+{
+  .type = VLIB_NODE_TYPE_INPUT,
+  .name = "nsim-wheel",
+
+  /* Will be enabled if/when the feature is configured */
+  .state = VLIB_NODE_STATE_DISABLED,
+
+  .format_trace = format_nsim_tx_trace,
+
+  .n_errors = NSIM_N_ERROR,
+  .error_strings = nsim_tx_error_strings,
+};
+#endif /* CLIB_MARCH_VARIANT */
+/* *INDENT-ON* */
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */

src/plugins/nsim/nsim_msg_enum.h

@@ -0,0 +1,31 @@
+
+/*
+ * nsim_msg_enum.h - skeleton vpp engine plug-in message enumeration
+ *
+ * Copyright (c) <current-year> <your-organization>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef included_nsim_msg_enum_h
+#define included_nsim_msg_enum_h
+
+#include <vppinfra/byte_order.h>
+
+#define vl_msg_id(n,h) n,
+typedef enum {
+#include <nsim/nsim_all_api_h.h>
+    /* We'll want to know how many messages IDs we need... */
+    VL_MSG_FIRST_AVAILABLE,
+} vl_msg_id_t;
+#undef vl_msg_id
+
+#endif /* included_nsim_msg_enum_h */

src/plugins/nsim/nsim_test.c

@@ -0,0 +1,285 @@
+/*
+ * nsim.c - skeleton vpp-api-test plug-in
+ *
+ * Copyright (c) <current-year> <your-organization>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#include <vat/vat.h>
+#include <vlibapi/api.h>
+#include <vlibmemory/api.h>
+#include <vppinfra/error.h>
+
+uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
+
+/* Declare message IDs */
+#include <nsim/nsim_msg_enum.h>
+
+/* define message structures */
+#define vl_typedefs
+#include <nsim/nsim_all_api_h.h>
+#undef vl_typedefs
+
+/* declare message handlers for each api */
+
+#define vl_endianfun		/* define message structures */
+#include <nsim/nsim_all_api_h.h>
+#undef vl_endianfun
+
+/* instantiate all the print functions we know about */
+#define vl_print(handle, ...)
+#define vl_printfun
+#include <nsim/nsim_all_api_h.h>
+#undef vl_printfun
+
+/* Get the API version number. */
+#define vl_api_version(n,v) static u32 api_version=(v);
+#include <nsim/nsim_all_api_h.h>
+#undef vl_api_version
+
+
+typedef struct
+{
+  /* API message ID base */
+  u16 msg_id_base;
+  vat_main_t *vat_main;
+} nsim_test_main_t;
+
+nsim_test_main_t nsim_test_main;
+
+#define __plugin_msg_base nsim_test_main.msg_id_base
+#include <vlibapi/vat_helper_macros.h>
+
+#define foreach_standard_reply_retval_handler   \
+_(nsim_enable_disable_reply)                    \
+_(nsim_configure_reply)
+
+#define _(n)                                            \
+    static void vl_api_##n##_t_handler                  \
+    (vl_api_##n##_t * mp)                               \
+    {                                                   \
+        vat_main_t * vam = nsim_test_main.vat_main;   \
+        i32 retval = ntohl(mp->retval);                 \
+        if (vam->async_mode) {                          \
+            vam->async_errors += (retval < 0);          \
+        } else {                                        \
+            vam->retval = retval;                       \
+            vam->result_ready = 1;                      \
+        }                                               \
+    }
+foreach_standard_reply_retval_handler;
+#undef _
+
+/*
+ * Table of message reply handlers, must include boilerplate handlers
+ * we just generated
+ */
+#define foreach_vpe_api_reply_msg                       \
+_(NSIM_ENABLE_DISABLE_REPLY, nsim_enable_disable_reply) \
+_(NSIM_CONFIGURE_REPLY, nsim_configure_reply)
+
+static int
+api_nsim_enable_disable (vat_main_t * vam)
+{
+  unformat_input_t *i = vam->input;
+  int enable_disable = 1;
+  u32 sw_if_index0 = ~0;
+  u32 sw_if_index1 = ~0;
+  u32 tmp;
+  vl_api_nsim_enable_disable_t *mp;
+  int ret;
+
+  /* Parse args required to build the message */
+  while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
+    {
+      if (unformat (i, "%U", unformat_sw_if_index, vam, &tmp))
+	{
+	  if (sw_if_index0 == ~0)
+	    sw_if_index0 = tmp;
+	  else
+	    sw_if_index1 = tmp;
+	}
+      else if (unformat (i, "sw_if_index %d", &tmp))
+	{
+	  if (sw_if_index0 == ~0)
+	    sw_if_index0 = tmp;
+	  else
+	    sw_if_index1 = tmp;
+	}
+      else if (unformat (i, "disable"))
+	enable_disable = 0;
+      else
+	break;
+    }
+
+  if (sw_if_index0 == ~0 || sw_if_index1 == ~0)
+    {
+      errmsg ("missing interface name / explicit sw_if_index number \n");
+      return -99;
+    }
+
+  /* Construct the API message */
+  M (NSIM_ENABLE_DISABLE, mp);
+  mp->sw_if_index0 = ntohl (sw_if_index0);
+  mp->sw_if_index1 = ntohl (sw_if_index1);
+  mp->enable_disable = enable_disable;
+
+  /* send it... */
+  S (mp);
+
+  /* Wait for a reply... */
+  W (ret);
+  return ret;
+}
+
+static uword
+unformat_delay (unformat_input_t * input, va_list * args)
+{
+  f64 *result = va_arg (*args, f64 *);
+  f64 tmp;
+
+  if (unformat (input, "%f us", &tmp))
+    *result = tmp * 1e-6;
+  else if (unformat (input, "%f ms", &tmp))
+    *result = tmp * 1e-3;
+  else if (unformat (input, "%f sec", &tmp))
+    *result = tmp;
+  else
+    return 0;
+
+  return 1;
+}
+
+static uword
+unformat_bandwidth (unformat_input_t * input, va_list * args)
+{
+  f64 *result = va_arg (*args, f64 *);
+  f64 tmp;
+
+  if (unformat (input, "%f gbit", &tmp))
+    *result = tmp * 1e9;
+  else if (unformat (input, "%f gbyte", &tmp))
+    *result = tmp * 8e9;
+  else
+    return 0;
+  return 1;
+}
+
+static int
+api_nsim_configure (vat_main_t * vam)
+{
+  vl_api_nsim_configure_t *mp;
+  unformat_input_t *i = vam->input;
+  f64 delay = 0.0, bandwidth = 0.0;
+  f64 packet_size = 1500.0;
+  u32 num_workers = vlib_num_workers ();
+  int ret;
+
+  while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
+    {
+      if (unformat (i, "delay %U", unformat_delay, &delay))
+	;
+      else if (unformat (i, "bandwidth %U", unformat_bandwidth, &bandwidth))
+	;
+      else if (unformat (i, "packet-size %f", &packet_size))
+	;
+      else
+	break;
+    }
+
+  if (delay == 0.0 || bandwidth == 0.0)
+    {
+      errmsg ("must specify delay and bandwidth");
+      return -99;
+    }
+
+  /* Construct the API message */
+  M (NSIM_CONFIGURE, mp);
+  mp->delay_in_usec = (u32) (delay * 1e6);
+  mp->delay_in_usec = ntohl (mp->delay_in_usec);
+  mp->average_packet_size = (u32) (packet_size);
+  mp->average_packet_size = ntohl (mp->average_packet_size);
+  mp->bandwidth_in_bits_per_second = (u64) (bandwidth);
+  mp->bandwidth_in_bits_per_second =
+    clib_host_to_net_u64 (mp->bandwidth_in_bits_per_second);
+
+  /* send it... */
+  S (mp);
+
+  /* Wait for a reply... */
+  W (ret);
+  return ret;
+}
+
+/*
+ * List of messages that the api test plugin sends,
+ * and that the data plane plugin processes
+ */
+#define foreach_vpe_api_msg                                             \
+_(nsim_enable_disable,                                                  \
+"[<intfc0> | sw_if_index <swif0>] [<intfc1> | sw_if_index <swif1>] [disable]") \
+_(nsim_configure, "delay <time> bandwidth <bw> [packet-size <nn>]")
+
+static void
+nsim_api_hookup (vat_main_t * vam)
+{
+  nsim_test_main_t *sm = &nsim_test_main;
+  /* Hook up handlers for replies from the data plane plug-in */
+#define _(N,n)                                                  \
+    vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base),     \
+                           #n,                                  \
+                           vl_api_##n##_t_handler,              \
+                           vl_noop_handler,                     \
+                           vl_api_##n##_t_endian,               \
+                           vl_api_##n##_t_print,                \
+                           sizeof(vl_api_##n##_t), 1);
+  foreach_vpe_api_reply_msg;
+#undef _
+
+  /* API messages we can send */
+#define _(n,h) hash_set_mem (vam->function_by_name, #n, api_##n);
+  foreach_vpe_api_msg;
+#undef _
+
+  /* Help strings */
+#define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
+  foreach_vpe_api_msg;
+#undef _
+}
+
+clib_error_t *
+vat_plugin_register (vat_main_t * vam)
+{
+  nsim_test_main_t *sm = &nsim_test_main;
+  u8 *name;
+
+  sm->vat_main = vam;
+
+  /* Ask the vpp engine for the first assigned message-id */
+  name = format (0, "nsim_%08x%c", api_version, 0);
+  sm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
+
+  if (sm->msg_id_base != (u16) ~ 0)
+    nsim_api_hookup (vam);
+
+  vec_free (name);
+
+  return 0;
+}
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */

src/vnet/api_errno.h

@@ -143,6 +143,7 @@ _(BIER_BSL_UNSUP, -146, "BIER bit-string-length unsupported")		\
 _(INSTANCE_IN_USE, -147, "Instance in use")				\
 _(INVALID_SESSION_ID, -148, "session ID out of range")			\
 _(ACL_IN_USE_BY_LOOKUP_CONTEXT, -149, "ACL in use by a lookup context")	\
+_(INVALID_VALUE_3, -150, "Invalid value #3")
 
 typedef enum
 {