misc: move osi to plugin

Type: refactor

This patch moves osi into a plugin, and also modifies
the init functions of llc and snap to preserve init
order dependency (llc_init --> osi_init --> snap_init).

While the initial intent was to move osi/llc/snap together
into a single plugin, there exists a dependency on llc
in vnet/ethernet, which would require further refactoring
and testing work.

Change-Id: Ic0eff030ee29c8d316c0e0fe13931451aa193527
Signed-off-by: Hadi Rayan Al-Sandid <halsandi@cisco.com>

src/plugins/osi/CMakeLists.txt

@@ -0,0 +1,24 @@
+# Copyright (c) 2023 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(osi
+
+  SOURCES
+  osi.c
+  node.c
+  pg.c
+  plugin.c
+
+  INSTALL_HEADERS
+  osi.h
+)

src/plugins/osi/FEATURE.yaml

@@ -0,0 +1,11 @@
+---
+name: OSI plugin
+maintainer:
+  - community <vpp-dev@lists.fd.io>
+features:
+  - Adds support for OSI protocols (SAP types)
+  - Registered as input protocol for PPP, HDLC, and LLC
+missing:
+  - No tests for this feature currently exist
+description: ""
+state: experimental

src/plugins/osi/osi.c

@@ -0,0 +1,199 @@
+/*
+ * Copyright (c) 2015 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.
+ */
+/*
+ * osi.c: osi support
+ *
+ * Copyright (c) 2010 Eliot Dresselhaus
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <vnet/vnet.h>
+#include <osi/osi.h>
+
+/* Global main structure. */
+osi_main_t osi_main;
+
+u8 *
+format_osi_protocol (u8 * s, va_list * args)
+{
+  osi_protocol_t p = va_arg (*args, u32);
+  osi_main_t *pm = &osi_main;
+  osi_protocol_info_t *pi = osi_get_protocol_info (pm, p);
+
+  if (pi)
+    s = format (s, "%s", pi->name);
+  else
+    s = format (s, "0x%02x", p);
+
+  return s;
+}
+
+u8 *
+format_osi_header_with_length (u8 * s, va_list * args)
+{
+  osi_main_t *pm = &osi_main;
+  osi_header_t *h = va_arg (*args, osi_header_t *);
+  u32 max_header_bytes = va_arg (*args, u32);
+  osi_protocol_t p = h->protocol;
+  u32 indent, header_bytes;
+
+  header_bytes = sizeof (h[0]);
+  if (max_header_bytes != 0 && header_bytes > max_header_bytes)
+    return format (s, "osi header truncated");
+
+  indent = format_get_indent (s);
+
+  s = format (s, "OSI %U", format_osi_protocol, p);
+
+  if (max_header_bytes != 0 && header_bytes > max_header_bytes)
+    {
+      osi_protocol_info_t *pi = osi_get_protocol_info (pm, p);
+      vlib_node_t *node = vlib_get_node (pm->vlib_main, pi->node_index);
+      if (node->format_buffer)
+	s = format (s, "\n%U%U",
+		    format_white_space, indent,
+		    node->format_buffer, (void *) (h + 1),
+		    max_header_bytes - header_bytes);
+    }
+
+  return s;
+}
+
+u8 *
+format_osi_header (u8 * s, va_list * args)
+{
+  osi_header_t *h = va_arg (*args, osi_header_t *);
+  return format (s, "%U", format_osi_header_with_length, h, 0);
+}
+
+/* Returns osi protocol as an int in host byte order. */
+uword
+unformat_osi_protocol (unformat_input_t * input, va_list * args)
+{
+  u8 *result = va_arg (*args, u8 *);
+  osi_main_t *pm = &osi_main;
+  int p, i;
+
+  /* Numeric type. */
+  if (unformat (input, "0x%x", &p) || unformat (input, "%d", &p))
+    {
+      if (p >= (1 << 8))
+	return 0;
+      *result = p;
+      return 1;
+    }
+
+  /* Named type. */
+  if (unformat_user (input, unformat_vlib_number_by_name,
+		     pm->protocol_info_by_name, &i))
+    {
+      osi_protocol_info_t *pi = vec_elt_at_index (pm->protocol_infos, i);
+      *result = pi->protocol;
+      return 1;
+    }
+
+  return 0;
+}
+
+uword
+unformat_osi_header (unformat_input_t * input, va_list * args)
+{
+  u8 **result = va_arg (*args, u8 **);
+  osi_header_t _h, *h = &_h;
+  u8 p;
+
+  if (!unformat (input, "%U", unformat_osi_protocol, &p))
+    return 0;
+
+  h->protocol = p;
+
+  /* Add header to result. */
+  {
+    void *p;
+    u32 n_bytes = sizeof (h[0]);
+
+    vec_add2 (*result, p, n_bytes);
+    clib_memcpy (p, h, n_bytes);
+  }
+
+  return 1;
+}
+
+static void
+add_protocol (osi_main_t * pm, osi_protocol_t protocol, char *protocol_name)
+{
+  osi_protocol_info_t *pi;
+  u32 i;
+
+  vec_add2 (pm->protocol_infos, pi, 1);
+  i = pi - pm->protocol_infos;
+
+  pi->name = protocol_name;
+  pi->protocol = protocol;
+  pi->next_index = pi->node_index = ~0;
+
+  hash_set (pm->protocol_info_by_protocol, protocol, i);
+  hash_set_mem (pm->protocol_info_by_name, pi->name, i);
+}
+
+static clib_error_t *
+osi_init (vlib_main_t * vm)
+{
+  osi_main_t *pm = &osi_main;
+
+  clib_memset (pm, 0, sizeof (pm[0]));
+  pm->vlib_main = vm;
+
+  pm->protocol_info_by_name = hash_create_string (0, sizeof (uword));
+  pm->protocol_info_by_protocol = hash_create (0, sizeof (uword));
+
+#define _(f,n) add_protocol (pm, OSI_PROTOCOL_##f, #f);
+  foreach_osi_protocol;
+#undef _
+
+  return vlib_call_init_function (vm, osi_input_init);
+}
+
+/* init order dependency: llc_init -> osi_init -> snap_init*/
+/* Otherwise, osi_input_init will wipe out e.g. the snap init */
+VLIB_INIT_FUNCTION (osi_init) = {
+  .init_order = VLIB_INITS ("llc_init", "osi_init", "snap_init"),
+};
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */

src/plugins/osi/osi.h

@@ -0,0 +1,156 @@
+/*
+ * Copyright (c) 2015 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.
+ */
+/*
+ * osi.h: OSI definitions
+ *
+ * Copyright (c) 2008 Eliot Dresselhaus
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef included_osi_h
+#define included_osi_h
+
+#include <vnet/vnet.h>
+
+#define foreach_osi_protocol			\
+  _ (null, 0x0)					\
+  _ (x_29, 0x01)				\
+  _ (x_633, 0x03)				\
+  _ (q_931, 0x08)				\
+  _ (q_933, 0x08)				\
+  _ (q_2931, 0x09)				\
+  _ (q_2119, 0x0c)				\
+  _ (snap, 0x80)				\
+  _ (clnp, 0x81)				\
+  _ (esis, 0x82)				\
+  _ (isis, 0x83)				\
+  _ (idrp, 0x85)				\
+  _ (x25_esis, 0x8a)				\
+  _ (iso10030, 0x8c)				\
+  _ (iso11577, 0x8d)				\
+  _ (ip6, 0x8e)					\
+  _ (compressed, 0xb0)				\
+  _ (sndcf, 0xc1)				\
+  _ (ip4, 0xcc)					\
+  _ (ppp, 0xcf)
+
+typedef enum
+{
+#define _(f,n) OSI_PROTOCOL_##f = n,
+  foreach_osi_protocol
+#undef _
+} osi_protocol_t;
+
+typedef struct
+{
+  u8 protocol;
+
+  u8 payload[0];
+} osi_header_t;
+
+typedef struct
+{
+  /* Name (a c string). */
+  char *name;
+
+  /* OSI protocol (SAP type). */
+  osi_protocol_t protocol;
+
+  /* Node which handles this type. */
+  u32 node_index;
+
+  /* Next index for this type. */
+  u32 next_index;
+} osi_protocol_info_t;
+
+#define foreach_osi_error			\
+  _ (NONE, "no error")				\
+  _ (UNKNOWN_PROTOCOL, "unknown osi protocol")
+
+typedef enum
+{
+#define _(f,s) OSI_ERROR_##f,
+  foreach_osi_error
+#undef _
+    OSI_N_ERROR,
+} osi_error_t;
+
+typedef struct
+{
+  vlib_main_t *vlib_main;
+
+  osi_protocol_info_t *protocol_infos;
+
+  /* Hash tables mapping name/protocol to protocol info index. */
+  uword *protocol_info_by_name, *protocol_info_by_protocol;
+
+  /* osi-input next index indexed by protocol. */
+  u8 input_next_by_protocol[256];
+} osi_main_t;
+
+always_inline osi_protocol_info_t *
+osi_get_protocol_info (osi_main_t * m, osi_protocol_t protocol)
+{
+  uword *p = hash_get (m->protocol_info_by_protocol, protocol);
+  return p ? vec_elt_at_index (m->protocol_infos, p[0]) : 0;
+}
+
+extern osi_main_t osi_main;
+
+/* Register given node index to take input for given osi type. */
+void osi_register_input_protocol (osi_protocol_t protocol, u32 node_index);
+
+format_function_t format_osi_protocol;
+format_function_t format_osi_header;
+format_function_t format_osi_header_with_length;
+
+/* Parse osi protocol as 0xXXXX or protocol name. */
+unformat_function_t unformat_osi_protocol;
+
+/* Parse osi header. */
+unformat_function_t unformat_osi_header;
+unformat_function_t unformat_pg_osi_header;
+
+void osi_register_input_protocol (osi_protocol_t protocol, u32 node_index);
+
+format_function_t format_osi_header;
+
+#endif /* included_osi_h */
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */

src/plugins/osi/pg.c

@@ -0,0 +1,106 @@
+/*
+ * Copyright (c) 2015 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.
+ */
+/*
+ * osi_pg.c: packet generator osi interface
+ *
+ * Copyright (c) 2008 Eliot Dresselhaus
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <vlib/vlib.h>
+#include <vnet/pg/pg.h>
+#include <osi/osi.h>
+
+typedef struct
+{
+  pg_edit_t protocol;
+} pg_osi_header_t;
+
+static inline void
+pg_osi_header_init (pg_osi_header_t * e)
+{
+  pg_edit_init (&e->protocol, osi_header_t, protocol);
+}
+
+uword
+unformat_pg_osi_header (unformat_input_t * input, va_list * args)
+{
+  pg_stream_t *s = va_arg (*args, pg_stream_t *);
+  pg_osi_header_t *h;
+  u32 group_index, error;
+
+  h = pg_create_edit_group (s, sizeof (h[0]), sizeof (osi_header_t),
+			    &group_index);
+  pg_osi_header_init (h);
+
+  error = 1;
+  if (!unformat (input, "%U",
+		 unformat_pg_edit, unformat_osi_protocol, &h->protocol))
+    goto done;
+
+  {
+    osi_main_t *pm = &osi_main;
+    osi_protocol_info_t *pi = 0;
+    pg_node_t *pg_node = 0;
+
+    if (h->protocol.type == PG_EDIT_FIXED)
+      {
+	u8 t = *h->protocol.values[PG_EDIT_LO];
+	pi = osi_get_protocol_info (pm, t);
+	if (pi && pi->node_index != ~0)
+	  pg_node = pg_get_node (pi->node_index);
+      }
+
+    if (pg_node && pg_node->unformat_edit
+	&& unformat_user (input, pg_node->unformat_edit, s))
+      ;
+
+    else if (!unformat_user (input, unformat_pg_payload, s))
+      goto done;
+  }
+
+  error = 0;
+done:
+  if (error)
+    pg_free_edit_group (s);
+  return error == 0;
+}
+
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */

src/plugins/osi/plugin.c

@@ -0,0 +1,23 @@
+/*
+ * plugin.c: osi
+ *
+ * Copyright (c) 2023 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 <vlib/vlib.h>
+#include <vnet/plugin/plugin.h>
+#include <vpp/app/version.h>
+VLIB_PLUGIN_REGISTER () = {
+  .version = VPP_BUILD_VER,
+  .description = "OSI plugin",
+};