Plugin for IP-Address to Interface Punting

This plugin provides per-ip address to interface punting.

When at least one rule is defined, the plugin receives all packets
which destination is one of VPP's address but which was not processed
by VPP (e.g., a TCP packet on a port that is not open, or a packet
for a protocol which is not attached).

Based on the set of configured rules, the destination address of each
packet is used to send the packet on the associated interface.

This plugin allows multiple containers to use
VPP's TCP stack (or other features provided by VPP) while still
being able to receive additional packets.

Change-Id: I3e69bb7d98183bf5163cb9ecb564cb482de252ce
Signed-off-by: Pierre Pfister <ppfister@cisco.com>

1 files changed, 231 insertions, 0 deletions

diff --git a/src/plugins/stn/stn_api.c b/src/plugins/stn/stn_api.c
new file mode 100644
index 00000000000..02ea29b6443
--- /dev/null
+++ b/src/plugins/stn/stn_api.c
@@ -0,0 +1,231 @@
+/*
+ * Copyright (c) 2017 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.
+ */
+
+#include <vlibapi/api.h>
+#include <vlibmemory/api.h>
+
+#include <plugins/stn/stn.h>
+#include <vnet/ip/format.h>
+
+#include <vppinfra/byte_order.h>
+
+/* define message IDs */
+#define vl_msg_id(n,h) n,
+typedef enum
+{
+#include <stn/stn.api.h>
+  /* We'll want to know how many messages IDs we need... */
+  VL_MSG_FIRST_AVAILABLE,
+} vl_msg_id_t;
+#undef vl_msg_id
+
+/* define message structures */
+#define vl_typedefs
+#include <stn/stn.api.h>
+#undef vl_typedefs
+
+/* define generated endian-swappers */
+#define vl_endianfun
+#include <stn/stn.api.h>
+#undef vl_endianfun
+
+/* instantiate all the print functions we know about */
+#define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
+#define vl_printfun
+#include <stn/stn.api.h>
+#undef vl_printfun
+
+/* Get the API version number */
+#define vl_api_version(n,v) static u32 api_version=(v);
+#include <nat/nat_all_api_h.h>
+#undef vl_api_version
+
+#define REPLY_MSG_ID_BASE stn_main.msg_id_base
+#include <vlibapi/api_helper_macros.h>
+
+/* Macro to finish up custom dump fns */
+#define FINISH                                  \
+    vec_add1 (s, 0);                            \
+    vl_print (handle, (char *)s);               \
+    vec_free (s);                               \
+    return handle;
+
+/**
+ * @brief API message custom-dump function
+ * @param mp vl_api_stn_add_del_rule_t * mp the api message
+ * @param handle void * print function handle
+ * @returns u8 * output string
+ */
+static void *vl_api_stn_add_del_rule_t_print
+  (vl_api_stn_add_del_rule_t * mp, void *handle)
+{
+  u8 *s;
+
+  s = format (0, "SCRIPT: stn_add_del_rule ");
+  if (mp->is_ip4)
+    s = format (s, "address %U ", format_ip4_address, mp->ip_address);
+  else
+    s = format (s, "address %U ", format_ip6_address, mp->ip_address);
+  s = format (s, "sw_if_index %d is_add %d", mp->sw_if_index, mp->is_add);
+
+  FINISH;
+}
+
+static void
+vl_api_stn_add_del_rule_t_handler (vl_api_stn_add_del_rule_t * mp)
+{
+  stn_rule_add_del_args_t args;
+  vl_api_stn_add_del_rule_reply_t *rmp;
+  int rv = 0;
+
+  if (mp->is_ip4)
+    {
+      ip4_address_t a;
+      memcpy(&a, mp->ip_address, sizeof(a));
+      ip46_address_set_ip4(&args.address, &a);
+    }
+  else
+    memcpy(&args.address.ip6, mp->ip_address, sizeof(ip6_address_t));
+
+  args.sw_if_index = clib_net_to_host_u32(mp->sw_if_index);
+  args.del = !mp->is_add;
+
+  rv = stn_rule_add_del(&args);
+
+  REPLY_MACRO (VL_API_STN_ADD_DEL_RULE_REPLY);
+}
+
+static void
+send_stn_rule (stn_rule_t *r, unix_shared_memory_queue_t *q, u32 context)
+{
+  vl_api_stn_rule_details_t *rmp;
+
+  rmp =
+      vl_msg_api_alloc (sizeof (*rmp));
+  memset (rmp, 0, sizeof (*rmp));
+  rmp->_vl_msg_id =
+      clib_host_to_net_u32 (VL_API_STN_RULES_DUMP + stn_main.msg_id_base);
+
+  if (ip46_address_is_ip4(&r->address))
+    {
+      clib_memcpy(rmp->ip_address, &r->address.ip4, sizeof(ip4_address_t));
+      rmp->is_ip4 = 1;
+    }
+  else
+    {
+      clib_memcpy(rmp->ip_address, &r->address.ip6, sizeof(ip6_address_t));
+    }
+
+  rmp->context = context;
+  rmp->sw_if_index = clib_host_to_net_u32(r->sw_if_index);
+
+  vl_msg_api_send_shmem (q, (u8 *) & rmp);
+}
+
+static void
+vl_api_stn_rules_dump_t_handler (vl_api_stn_rules_dump_t *mp)
+{
+  unix_shared_memory_queue_t *q;
+  stn_main_t *stn = &stn_main;
+  stn_rule_t *r;
+
+  q = vl_api_client_index_to_input_queue (mp->client_index);
+  if (q == 0)
+    return;
+
+  /* *INDENT-OFF* */
+  pool_foreach (r, stn->rules,
+		({
+
+    send_stn_rule (r, q, mp->context);
+  }));
+  /* *INDENT-ON* */
+}
+
+
+/* List of message types that this plugin understands */
+#define foreach_stn_plugin_api_msg			\
+_(STN_ADD_DEL_RULE, stn_add_del_rule)	\
+_(STN_RULES_DUMP, stn_rules_dump)
+
+/**
+ * @brief Set up the API message handling tables
+ * @param vm vlib_main_t * vlib main data structure pointer
+ * @returns 0 to indicate all is well
+ */
+static clib_error_t *
+stn_plugin_api_hookup (vlib_main_t * vm)
+{
+  stn_main_t *stn = &stn_main;
+#define _(N,n)                                                  \
+    vl_msg_api_set_handlers((VL_API_##N + stn->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_stn_plugin_api_msg;
+#undef _
+
+  return 0;
+}
+
+#define vl_msg_name_crc_list
+#include <stn/stn.api.h>
+#undef vl_msg_name_crc_list
+
+static void
+setup_message_id_table (stn_main_t * stn, api_main_t * am)
+{
+#define _(id,n,crc) \
+  vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + stn->msg_id_base);
+  foreach_vl_msg_name_crc_stn;
+#undef _
+}
+
+static void
+plugin_custom_dump_configure (stn_main_t * stn)
+{
+#define _(n,f) api_main.msg_print_handlers \
+  [VL_API_##n + stn->msg_id_base]                \
+    = (void *) vl_api_##f##_t_print;
+  foreach_stn_plugin_api_msg;
+#undef _
+}
+
+clib_error_t *
+stn_api_init (vlib_main_t * vm, stn_main_t * sm)
+{
+  u8 *name;
+  clib_error_t *error = 0;
+
+  name = format (0, "stn_%08x%c", api_version, 0);
+
+  /* Ask for a correctly-sized block of API message decode slots */
+  sm->msg_id_base =
+    vl_msg_api_get_msg_ids ((char *) name, VL_MSG_FIRST_AVAILABLE);
+
+  error = stn_plugin_api_hookup (vm);
+
+  /* Add our API messages to the global name_crc hash table */
+  setup_message_id_table (sm, &api_main);
+
+  plugin_custom_dump_configure (sm);
+
+  vec_free (name);
+
+  return error;
+}