emacs skeletons: add quad/single, avx2/avx512 support

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

1 files changed, 236 insertions, 0 deletions

diff --git a/extras/emacs/plugin-qsnode-skel.el b/extras/emacs/plugin-qsnode-skel.el
new file mode 100644
index 00000000000..d3fc908bbea
--- /dev/null
+++ b/extras/emacs/plugin-qsnode-skel.el
@@ -0,0 +1,236 @@
+;;; plugin-node-skel.el - vpp engine plug-in "node.c" skeleton
+;;;
+;;; Copyright (c) 2016 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.
+
+(require 'skeleton)
+
+(define-skeleton skel-plugin-qsnode
+"Insert a plug-in 'node.c' skeleton "
+nil
+'(if (not (boundp 'plugin-name))
+     (setq plugin-name (read-string "Plugin name: ")))
+'(setq PLUGIN-NAME (upcase plugin-name))
+'(setq capital-oh-en "ON")
+"/*
+ * 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 <" plugin-name "/" plugin-name ".h>
+
+typedef struct
+{
+  u32 sw_if_index;
+  u32 next_index;
+} " plugin-name "_trace_t;
+
+#ifndef CLIB_MARCH_VARIANT
+
+/* packet trace format function */
+static u8 * format_" plugin-name "_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 *);
+  " plugin-name "_trace_t * t = va_arg (*args, " plugin-name "_trace_t *);
+  
+  s = format (s, \"" PLUGIN-NAME ": sw_if_index %d, next index %d\\n\",
+              t->sw_if_index, t->next_index);
+  return s;
+}
+#endif /* CLIB_MARCH_VARIANT */
+
+vlib_node_registration_t " plugin-name "_node;
+
+#define foreach_" plugin-name "_error \\
+_(SWAPPED, \"Mac swap packets processed\")
+
+typedef enum 
+{
+#define _(sym,str) " PLUGIN-NAME "_ERROR_##sym,
+  foreach_" plugin-name "_error
+#undef _
+  " PLUGIN-NAME "_N_ERROR,
+} " plugin-name "_error_t;
+
+#ifndef CLIB_MARCH_VARIANT
+static char * " plugin-name "_error_strings[] = 
+{
+#define _(sym,string) string,
+  foreach_" plugin-name "_error
+#undef _
+};
+#endif /* CLIB_MARCH_VARIANT */
+
+typedef enum 
+{
+  " PLUGIN-NAME "_NEXT_DROP,
+  " PLUGIN-NAME "_N_NEXT,
+} " plugin-name "_next_t;
+
+always_inline uword
+"plugin-name"_inline (vlib_main_t * vm,
+     		 vlib_node_runtime_t * node, vlib_frame_t * frame,
+		 int is_ip4, int is_trace)
+{
+  u32 n_left_from, *from;
+  vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
+  u16 nexts[VLIB_FRAME_SIZE], *next;
+
+  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;
+
+  while (n_left_from >= 4)
+    {
+      /* Prefetch next iteration. */
+      if (PREDICT_TRUE (n_left_from >= 8))
+	{
+	  vlib_prefetch_buffer_header (b[4], STORE);
+	  vlib_prefetch_buffer_header (b[5], STORE);
+	  vlib_prefetch_buffer_header (b[6], STORE);
+	  vlib_prefetch_buffer_header (b[7], STORE);
+          CLIB_PREFETCH (b[4]->data, CLIB_CACHE_LINE_BYTES, STORE);
+          CLIB_PREFETCH (b[5]->data, CLIB_CACHE_LINE_BYTES, STORE);
+          CLIB_PREFETCH (b[6]->data, CLIB_CACHE_LINE_BYTES, STORE);
+          CLIB_PREFETCH (b[7]->data, CLIB_CACHE_LINE_BYTES, STORE);
+	}
+
+     /* $$$$ process 4x pkts right here */
+      next[0] = 0;
+      next[1] = 0;
+      next[2] = 0;
+      next[3] = 0;
+
+      if (is_trace)
+	{
+	  if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
+	    {
+	      "plugin-name"_trace_t *t = 
+                   vlib_add_trace (vm, node, b[0], sizeof (*t));
+	      t->next_index = next[0];
+              t->sw_if_index = vnet_buffer(b[0])->sw_if_index[VLIB_RX];
+	    }
+	  if (b[1]->flags & VLIB_BUFFER_IS_TRACED)
+	    {
+	      "plugin-name"_trace_t *t = 
+                    vlib_add_trace (vm, node, b[1], sizeof (*t));
+	      t->next_index = next[1];
+              t->sw_if_index = vnet_buffer(b[1])->sw_if_index[VLIB_RX];
+	    }
+	  if (b[2]->flags & VLIB_BUFFER_IS_TRACED)
+	    {
+	      "plugin-name"_trace_t *t = 
+                    vlib_add_trace (vm, node, b[2], sizeof (*t));
+	      t->next_index = next[2];
+              t->sw_if_index = vnet_buffer(b[2])->sw_if_index[VLIB_RX];
+	    }
+	  if (b[3]->flags & VLIB_BUFFER_IS_TRACED)
+	    {
+	      "plugin-name"_trace_t *t = 
+                    vlib_add_trace (vm, node, b[3], sizeof (*t));
+	      t->next_index = next[3];
+              t->sw_if_index = vnet_buffer(b[3])->sw_if_index[VLIB_RX];
+	    }
+	}
+
+      b += 4;
+      next += 4;
+      n_left_from -= 4;
+    }
+
+  while (n_left_from > 0)
+    {
+
+     /* $$$$ process 1 pkt right here */
+      next[0] = 0;
+
+      if (is_trace)
+	{
+	  if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
+	    {
+	      "plugin-name"_trace_t *t = 
+                    vlib_add_trace (vm, node, b[0], sizeof (*t));
+	      t->next_index = next[0];
+              t->sw_if_index = vnet_buffer(b[0])->sw_if_index[VLIB_RX];
+	    }
+	}
+
+      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 ("plugin-name"_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
+                             vlib_frame_t * frame)
+{
+  if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
+    return " plugin-name "_inline (vm, node, frame, 1 /* is_ip4 */ ,
+			    1 /* is_trace */ );
+  else
+    return " plugin-name "_inline (vm, node, frame, 1 /* is_ip4 */ ,
+			    0 /* is_trace */ );
+}
+
+/* *INDENT-OFF* */
+#ifndef CLIB_MARCH_VARIANT
+VLIB_REGISTER_NODE (" plugin-name "_node) = 
+{
+  .name = \"" plugin-name "\",
+  .vector_size = sizeof (u32),
+  .format_trace = format_" plugin-name "_trace,
+  .type = VLIB_NODE_TYPE_INTERNAL,
+  
+  .n_errors = ARRAY_LEN(" plugin-name "_error_strings),
+  .error_strings = " plugin-name "_error_strings,
+
+  .n_next_nodes = " PLUGIN-NAME "_N_NEXT,
+
+  /* edit / add dispositions here */
+  .next_nodes = {
+        [" PLUGIN-NAME "_NEXT_DROP] = \"error-drop\",
+  },
+};
+#endif /* CLIB_MARCH_VARIANT */
+/* *INDENT-ON* */
+/*
+ * fd.io coding-style-patch-verification: " capital-oh-en "
+ *
+ * Local Variables:
+ * eval: (c-set-style \"gnu\")
+ * End:
+ */
+")