qos: Store function

Type: feature

store: write a QoS value into the buffer meta-data
record: Extract a QoS value from a packet header and store it.
mark: Make a change to the content of a packet header by writing a stored
      QoS value

Change-Id: I07d1e87dd1ca90d40ac1ae1774fee1b272cab83f
Signed-off-by: Neale Ranns <nranns@cisco.com>

6 files changed, 663 insertions, 6 deletions

diff --git a/src/vnet/CMakeLists.txt b/src/vnet/CMakeLists.txt
index aaf7357e410..05a8077c8ab 100644
--- a/src/vnet/CMakeLists.txt
+++ b/src/vnet/CMakeLists.txt
@@ -1451,6 +1451,8 @@ list(APPEND VNET_SOURCES
   qos/qos_egress_map.c
   qos/qos_record.c
   qos/qos_record_node.c
+  qos/qos_store.c
+  qos/qos_store_node.c
   qos/qos_mark.c
   qos/qos_mark_node.c
 )
diff --git a/src/vnet/qos/qos.api b/src/vnet/qos/qos.api
index 11c91638c5b..dcd9ce5d011 100644
--- a/src/vnet/qos/qos.api
+++ b/src/vnet/qos/qos.api
@@ -14,13 +14,20 @@
  * limitations under the License.
  */
 
-/** \file
-
-    This file defines QoS record and mark API messages which are generally
-    called through a shared memory interface.
-*/
+/**
+ * @file
+ * This file defines QoS record, store and mark API messages which are generally
+ *    called through a shared memory interface.
+ *
+ * Definitions of verbs:
+ *  store: write a QoS value into the buffer meta-data
+ *  record: Extract a QoS value from a packet header and store it.
+ *  mark: Make a change to the content of a packet header by writing a stored
+ *        QoS value
+ */
+option version = "1.1.0";
 
-option version = "1.0.0";
+import "vnet/ip/ip_types.api";
 
 enum qos_source : u8
 {
@@ -31,6 +38,55 @@ enum qos_source : u8
 };
 
 /**
+ * QoS store.
+ * @param sw_if_index - The interface on which store is enabled.
+ * @param input_source - The input source/layer at which the QoS bits are stored
+ *                       See qos_source_t. This determines what packets have a
+ *                       value stored. i.e. If IP is seleted this affects on IP
+ *                       packets.
+ * @param value - The value to store.
+ */
+typedef qos_store
+{
+  u32 sw_if_index;
+  vl_api_qos_source_t input_source;
+  u8 value;
+};
+
+/**
+ * Enable/Disable QoS storing
+ * The QoS bits from the packet at the specified input layer are copied
+ * into the packet. Storeing should be used in conjunction with marking
+ * @param enable - enable=1 or disable the feature
+ * @param store - Store configuration
+ */
+autoreply define qos_store_enable_disable
+{
+  u32 client_index;
+  u32 context;
+  u8 enable;
+  vl_api_qos_store_t store;
+};
+
+/**
+ * Dump the QoS store configs
+ */
+define qos_store_dump
+{
+  u32 client_index;
+  u32 context;
+};
+
+/**
+ * Details of QoS recording configs
+ */
+define qos_store_details
+{
+  u32 context;
+  vl_api_qos_store_t store;
+};
+
+/**
  * QoS recording.
  * @param sw_if_index - The interface on which recording is enabled.
  * @param input_source - The input source/layer at which the QoS bits
diff --git a/src/vnet/qos/qos_api.c b/src/vnet/qos/qos_api.c
index 966ffcce395..cb92c851854 100644
--- a/src/vnet/qos/qos_api.c
+++ b/src/vnet/qos/qos_api.c
@@ -20,6 +20,7 @@
 #include <vnet/api_errno.h>
 
 #include <vnet/qos/qos_record.h>
+#include <vnet/qos/qos_store.h>
 #include <vnet/qos/qos_mark.h>
 #include <vnet/qos/qos_egress_map.h>
 
@@ -45,6 +46,8 @@
 #define foreach_qos_api_msg                                             \
   _(QOS_RECORD_ENABLE_DISABLE, qos_record_enable_disable)               \
   _(QOS_RECORD_DUMP, qos_record_dump)                                   \
+  _(QOS_STORE_ENABLE_DISABLE, qos_store_enable_disable)                 \
+  _(QOS_STORE_DUMP, qos_store_dump)                                     \
   _(QOS_EGRESS_MAP_DELETE, qos_egress_map_delete)                       \
   _(QOS_EGRESS_MAP_UPDATE, qos_egress_map_update)                       \
   _(QOS_EGRESS_MAP_DUMP, qos_egress_map_dump)                           \
@@ -145,6 +148,74 @@ vl_api_qos_record_dump_t_handler (vl_api_qos_record_dump_t * mp)
 }
 
 void
+vl_api_qos_store_enable_disable_t_handler (vl_api_qos_store_enable_disable_t
+					   * mp)
+{
+  vl_api_qos_store_enable_disable_reply_t *rmp;
+  qos_source_t qs;
+  int rv = 0;
+
+  VALIDATE_SW_IF_INDEX (&(mp->store));
+
+  rv = qos_source_decode (mp->store.input_source, &qs);
+
+  if (0 == rv)
+    {
+      if (mp->enable)
+	rv = qos_store_enable (ntohl (mp->store.sw_if_index), qs,
+			       mp->store.value);
+      else
+	rv = qos_store_disable (ntohl (mp->store.sw_if_index), qs);
+    }
+
+  BAD_SW_IF_INDEX_LABEL;
+  REPLY_MACRO (VL_API_QOS_STORE_ENABLE_DISABLE_REPLY);
+}
+
+typedef struct qos_store_send_walk_ctx_t_
+{
+  vl_api_registration_t *reg;
+  u32 context;
+} qos_store_send_walk_ctx_t;
+
+static walk_rc_t
+send_qos_store_details (u32 sw_if_index,
+			qos_source_t input_source, qos_bits_t value, void *c)
+{
+  qos_store_send_walk_ctx_t *ctx;
+  vl_api_qos_store_details_t *mp;
+
+  ctx = c;
+  mp = vl_msg_api_alloc_zero (sizeof (*mp));
+
+  mp->_vl_msg_id = ntohs (VL_API_QOS_STORE_DETAILS);
+  mp->context = ctx->context;
+  mp->store.sw_if_index = htonl (sw_if_index);
+  mp->store.input_source = qos_source_encode (input_source);
+  mp->store.value = value;
+
+  vl_api_send_msg (ctx->reg, (u8 *) mp);
+
+  return (WALK_CONTINUE);
+}
+
+static void
+vl_api_qos_store_dump_t_handler (vl_api_qos_store_dump_t * mp)
+{
+  vl_api_registration_t *reg;
+
+  reg = vl_api_client_index_to_registration (mp->client_index);
+  if (!reg)
+    return;
+
+  qos_store_send_walk_ctx_t ctx = {
+    .reg = reg,
+    .context = mp->context,
+  };
+  qos_store_walk (send_qos_store_details, &ctx);
+}
+
+void
 vl_api_qos_egress_map_update_t_handler (vl_api_qos_egress_map_update_t * mp)
 {
   vl_api_qos_egress_map_update_reply_t *rmp;
diff --git a/src/vnet/qos/qos_store.c b/src/vnet/qos/qos_store.c
new file mode 100644
index 00000000000..18e79a33653
--- /dev/null
+++ b/src/vnet/qos/qos_store.c
@@ -0,0 +1,310 @@
+/*
+ * 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.
+ */
+
+#include <vnet/qos/qos_store.h>
+#include <vnet/ip/ip.h>
+#include <vnet/feature/feature.h>
+
+/**
+ * QoS Store configuration
+ */
+typedef struct qos_store_t_
+{
+  u8 qst_n_cfgs;
+  qos_bits_t qst_value;
+} qos_store_t;
+
+/**
+ * Per-interface, per-protocol vector of feature on/off configurations
+ */
+qos_store_t *qos_store_configs[QOS_N_SOURCES];
+
+static void
+qos_store_feature_config (u32 sw_if_index,
+			  qos_source_t input_source,
+			  u8 enable, qos_bits_t value)
+{
+  switch (input_source)
+    {
+    case QOS_SOURCE_IP:
+      vnet_feature_enable_disable ("ip6-unicast", "ip6-qos-store",
+				   sw_if_index, enable, &value,
+				   sizeof (value));
+      vnet_feature_enable_disable ("ip6-multicast", "ip6-qos-store",
+				   sw_if_index, enable, &value,
+				   sizeof (value));
+      vnet_feature_enable_disable ("ip4-unicast", "ip4-qos-store",
+				   sw_if_index, enable, &value,
+				   sizeof (value));
+      vnet_feature_enable_disable ("ip4-multicast", "ip4-qos-store",
+				   sw_if_index, enable, &value,
+				   sizeof (value));
+      break;
+    case QOS_SOURCE_MPLS:
+    case QOS_SOURCE_VLAN:
+    case QOS_SOURCE_EXT:
+      /* not a valid option for storeing */
+      break;
+    }
+}
+
+int
+qos_store_enable (u32 sw_if_index,
+		  qos_source_t input_source, qos_bits_t value)
+{
+  qos_store_t *qst;
+
+  if (QOS_SOURCE_IP != input_source)
+    return VNET_API_ERROR_UNIMPLEMENTED;
+
+  vec_validate (qos_store_configs[input_source], sw_if_index);
+
+  qst = &qos_store_configs[input_source][sw_if_index];
+
+  if (0 == qst->qst_n_cfgs)
+    {
+      qst->qst_value = value;
+      qos_store_feature_config (sw_if_index, input_source, 1, value);
+    }
+
+  qst->qst_n_cfgs++;
+
+  return (0);
+}
+
+int
+qos_store_disable (u32 sw_if_index, qos_source_t input_source)
+{
+  qos_store_t *qst;
+
+  if (vec_len (qos_store_configs[input_source]) <= sw_if_index)
+    return VNET_API_ERROR_NO_MATCHING_INTERFACE;
+
+  qst = &qos_store_configs[input_source][sw_if_index];
+
+  if (0 == qst->qst_n_cfgs)
+    return VNET_API_ERROR_VALUE_EXIST;
+
+  qst->qst_n_cfgs--;
+
+  if (0 == qst->qst_n_cfgs)
+    {
+      qos_store_feature_config (sw_if_index, input_source, 0, qst->qst_value);
+    }
+
+  return (0);
+}
+
+void
+qos_store_walk (qos_store_walk_cb_t fn, void *c)
+{
+  qos_source_t qs;
+
+  FOR_EACH_QOS_SOURCE (qs)
+  {
+    qos_store_t *qst;
+    u32 sw_if_index;
+
+    vec_foreach_index (sw_if_index, qos_store_configs[qs])
+    {
+      qst = &qos_store_configs[qs][sw_if_index];
+      if (0 != qst->qst_n_cfgs)
+	fn (sw_if_index, qs, qst->qst_value, c);
+    }
+  }
+}
+
+/*
+ * Disable storeing feature for all protocols when the interface
+ * is deleted
+ */
+static clib_error_t *
+qos_store_ip_interface_add_del (vnet_main_t * vnm,
+				u32 sw_if_index, u32 is_add)
+{
+  if (!is_add)
+    {
+      qos_source_t qs;
+
+      FOR_EACH_QOS_SOURCE (qs)
+      {
+	while (qos_store_disable (sw_if_index, qs) == 0);
+      }
+    }
+
+  return (NULL);
+}
+
+VNET_SW_INTERFACE_ADD_DEL_FUNCTION (qos_store_ip_interface_add_del);
+
+clib_error_t *
+qos_store_init (vlib_main_t * vm)
+{
+  return 0;
+}
+
+VLIB_INIT_FUNCTION (qos_store_init);
+
+static clib_error_t *
+qos_store_cli (vlib_main_t * vm,
+	       unformat_input_t * input, vlib_cli_command_t * cmd)
+{
+  vnet_main_t *vnm = vnet_get_main ();
+  u32 sw_if_index, qs, value;
+  u8 enable;
+
+  qs = 0xff;
+  enable = 1;
+  sw_if_index = ~0;
+
+  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
+    {
+      if (unformat (input, "%U", unformat_vnet_sw_interface,
+		    vnm, &sw_if_index))
+	;
+      else if (unformat (input, "%U", unformat_qos_source, &qs))
+	;
+      else if (unformat (input, "enable"))
+	enable = 1;
+      else if (unformat (input, "disable"))
+	enable = 0;
+      else if (unformat (input, "value &d", &value))
+	;
+      else
+	break;
+    }
+
+  if (~0 == sw_if_index)
+    return clib_error_return (0, "interface must be specified");
+  if (0xff == qs)
+    return clib_error_return (0, "input location must be specified");
+
+  if (enable)
+    qos_store_enable (sw_if_index, qs, value);
+  else
+    qos_store_disable (sw_if_index, qs);
+
+  return (NULL);
+}
+
+/*?
+ * Enable QoS bit storeing on an interface using the packet's input DSCP bits
+ * Which input QoS bits to use are either; IP, MPLS or VLAN. If more than
+ * one protocol is chosen (which is foolish) the higher layers override the
+ * lower.
+ *
+ * @cliexpar
+ * @cliexcmd{qos store ip GigEthernet0/1/0}
+ ?*/
+/* *INDENT-OFF* */
+VLIB_CLI_COMMAND (qos_store_command, static) = {
+  .path = "qos store",
+  .short_help = "qos store <store-source> <INTERFACE> [disable]",
+  .function = qos_store_cli,
+  .is_mp_safe = 1,
+};
+/* *INDENT-ON* */
+
+static void
+qos_store_show_one_interface (vlib_main_t * vm, u32 sw_if_index)
+{
+  u8 n_cfgs[QOS_N_SOURCES] = { };
+  qos_source_t qs;
+  bool set;
+
+  set = false;
+
+  FOR_EACH_QOS_SOURCE (qs)
+  {
+    if (vec_len (qos_store_configs[qs]) <= sw_if_index)
+      continue;
+    if (0 != (n_cfgs[qs] = qos_store_configs[qs][sw_if_index].qst_n_cfgs))
+      set = true;
+  }
+
+  if (set)
+    {
+      vlib_cli_output (vm, " %U:", format_vnet_sw_if_index_name,
+		       vnet_get_main (), sw_if_index);
+
+      FOR_EACH_QOS_SOURCE (qs)
+      {
+	if (n_cfgs[qs] != 0)
+	  vlib_cli_output (vm, "  %U -> %d",
+			   format_qos_source, qs,
+			   qos_store_configs[qs][sw_if_index].qst_value);
+      }
+    }
+}
+
+static clib_error_t *
+qos_store_show (vlib_main_t * vm,
+		unformat_input_t * input, vlib_cli_command_t * cmd)
+{
+  vnet_main_t *vnm = vnet_get_main ();
+  qos_source_t qs;
+  u32 sw_if_index;
+
+  sw_if_index = ~0;
+
+  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
+    {
+      if (unformat (input, "%U", unformat_vnet_sw_interface,
+		    vnm, &sw_if_index))
+	;
+    }
+
+  if (~0 == sw_if_index)
+    {
+      u32 ii, n_ints = 0;
+
+      FOR_EACH_QOS_SOURCE (qs)
+      {
+	n_ints = clib_max (n_ints, vec_len (qos_store_configs[qs]));
+      }
+
+      for (ii = 0; ii < n_ints; ii++)
+	{
+	  qos_store_show_one_interface (vm, ii);
+	}
+    }
+  else
+    qos_store_show_one_interface (vm, sw_if_index);
+
+  return (NULL);
+}
+
+/*?
+ * Show Egress Qos Maps
+ *
+ * @cliexpar
+ * @cliexcmd{show qos egress map}
+ ?*/
+/* *INDENT-OFF* */
+VLIB_CLI_COMMAND (qos_store_show_command, static) = {
+  .path = "show qos store",
+  .short_help = "show qos store [interface]",
+  .function = qos_store_show,
+  .is_mp_safe = 1,
+};
+/* *INDENT-ON* */
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */
diff --git a/src/vnet/qos/qos_store.h b/src/vnet/qos/qos_store.h
new file mode 100644
index 00000000000..7b3c8014e08
--- /dev/null
+++ b/src/vnet/qos/qos_store.h
@@ -0,0 +1,39 @@
+/*
+ * 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.
+ */
+
+#ifndef __QOS_STORE_H__
+#define __QOS_STORE_H__
+
+#include <vnet/qos/qos_types.h>
+#include <vnet/ip/ip_packet.h>
+
+extern int qos_store_disable (u32 sw_if_index, qos_source_t input_source);
+extern int qos_store_enable (u32 sw_if_index,
+			     qos_source_t input_source, qos_bits_t value);
+
+typedef walk_rc_t (*qos_store_walk_cb_t) (u32 sw_if_index,
+					  qos_source_t input_source,
+					  qos_bits_t value, void *ctx);
+void qos_store_walk (qos_store_walk_cb_t fn, void *c);
+
+#endif
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */
diff --git a/src/vnet/qos/qos_store_node.c b/src/vnet/qos/qos_store_node.c
new file mode 100644
index 00000000000..2273b2eac77
--- /dev/null
+++ b/src/vnet/qos/qos_store_node.c
@@ -0,0 +1,179 @@
+/*
+ * 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.
+ */
+
+#include <vnet/qos/qos_store.h>
+#include <vnet/ip/ip.h>
+#include <vnet/ip/ip6_to_ip4.h>
+#include <vnet/feature/feature.h>
+#include <vnet/qos/qos_types.h>
+
+extern u8 *qos_store_configs[QOS_N_SOURCES];
+
+/**
+ * per-packet trace data
+ */
+typedef struct qos_store_trace_t_
+{
+  /* per-pkt trace data */
+  qos_bits_t bits;
+} qos_store_trace_t;
+
+/* packet trace format function */
+static u8 *
+format_qos_store_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 *);
+  qos_store_trace_t *t = va_arg (*args, qos_store_trace_t *);
+
+  s = format (s, "qos:%d", t->bits);
+
+  return s;
+}
+
+static inline uword
+qos_store_inline (vlib_main_t * vm,
+		  vlib_node_runtime_t * node,
+		  vlib_frame_t * frame, qos_source_t qos_src)
+{
+  u32 n_left_from, *from, *to_next, next_index;
+
+  next_index = 0;
+  n_left_from = frame->n_vectors;
+  from = vlib_frame_vector_args (frame);
+
+  while (n_left_from > 0)
+    {
+      u32 n_left_to_next;
+
+      vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
+
+      while (n_left_from > 0 && n_left_to_next > 0)
+	{
+	  vlib_buffer_t *b0;
+	  u32 next0, bi0;
+	  qos_bits_t qos0;
+
+	  next0 = 0;
+	  bi0 = from[0];
+	  to_next[0] = bi0;
+	  from += 1;
+	  to_next += 1;
+	  n_left_from -= 1;
+	  n_left_to_next -= 1;
+
+	  b0 = vlib_get_buffer (vm, bi0);
+
+	  qos0 =
+	    *(qos_bits_t *) vnet_feature_next_with_data (&next0, b0,
+							 sizeof (qos_bits_t));
+
+	  vnet_buffer2 (b0)->qos.bits = qos0;
+	  vnet_buffer2 (b0)->qos.source = qos_src;
+	  b0->flags |= VNET_BUFFER_F_QOS_DATA_VALID;
+
+	  if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE) &&
+			     (b0->flags & VLIB_BUFFER_IS_TRACED)))
+	    {
+	      qos_store_trace_t *t =
+		vlib_add_trace (vm, node, b0, sizeof (*t));
+	      t->bits = qos0;
+	    }
+
+
+	  /* 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);
+	}
+
+      vlib_put_next_frame (vm, node, next_index, n_left_to_next);
+    }
+
+  return frame->n_vectors;
+}
+
+
+VLIB_NODE_FN (ip4_qos_store_node) (vlib_main_t * vm,
+				   vlib_node_runtime_t * node,
+				   vlib_frame_t * frame)
+{
+  return (qos_store_inline (vm, node, frame, QOS_SOURCE_IP));
+}
+
+VLIB_NODE_FN (ip6_qos_store_node) (vlib_main_t * vm,
+				   vlib_node_runtime_t * node,
+				   vlib_frame_t * frame)
+{
+  return (qos_store_inline (vm, node, frame, QOS_SOURCE_IP));
+}
+
+
+/* *INDENT-OFF* */
+VLIB_REGISTER_NODE (ip4_qos_store_node) = {
+  .name = "ip4-qos-store",
+  .vector_size = sizeof (u32),
+  .format_trace = format_qos_store_trace,
+  .type = VLIB_NODE_TYPE_INTERNAL,
+
+  .n_errors = 0,
+  .n_next_nodes = 1,
+
+  .next_nodes = {
+    [0] = "ip4-drop",
+  },
+};
+
+VNET_FEATURE_INIT (ip4_qos_store_node, static) = {
+    .arc_name = "ip4-unicast",
+    .node_name = "ip4-qos-store",
+};
+VNET_FEATURE_INIT (ip4m_qos_store_node, static) = {
+    .arc_name = "ip4-multicast",
+    .node_name = "ip4-qos-store",
+};
+
+VLIB_REGISTER_NODE (ip6_qos_store_node) = {
+  .name = "ip6-qos-store",
+  .vector_size = sizeof (u32),
+  .format_trace = format_qos_store_trace,
+  .type = VLIB_NODE_TYPE_INTERNAL,
+
+  .n_errors = 0,
+  .n_next_nodes = 1,
+
+  .next_nodes = {
+    [0] = "ip6-drop",
+  },
+};
+
+VNET_FEATURE_INIT (ip6_qos_store_node, static) = {
+    .arc_name = "ip6-unicast",
+    .node_name = "ip6-qos-store",
+};
+VNET_FEATURE_INIT (ip6m_qos_store_node, static) = {
+    .arc_name = "ip6-multicast",
+    .node_name = "ip6-qos-store",
+};
+
+/* *INDENT-ON* */
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */