API refactoring : cop 62/4862/5
authorPavel Kotucek <pkotucek@cisco.com>
Wed, 25 Jan 2017 07:27:15 +0000 (08:27 +0100)
committerDamjan Marion <dmarion.lists@gmail.com>
Fri, 27 Jan 2017 19:55:36 +0000 (19:55 +0000)
Change-Id: I1596d7a130fb6d3b170b8e01f2116b323cc10c0d
Signed-off-by: Pavel Kotucek <pkotucek@cisco.com>
src/vnet.am
src/vnet/cop/cop.api [new file with mode: 0644]
src/vnet/cop/cop_api.c [new file with mode: 0644]
src/vnet/vnet_all_api_h.h
src/vpp/api/api.c
src/vpp/api/vpe.api

index 6d043e3..28a1b19 100644 (file)
@@ -88,10 +88,14 @@ libvnet_la_SOURCES +=                               \
   vnet/cop/cop.c                               \
   vnet/cop/node1.c                             \
   vnet/cop/ip4_whitelist.c                     \
-  vnet/cop/ip6_whitelist.c
+  vnet/cop/ip6_whitelist.c                     \
+  vnet/cop/cop_api.c
 
 nobase_include_HEADERS +=                      \
-  vnet/cop/cop.h
+  vnet/cop/cop.h                                       \
+  vnet/cop/cop.api.h
+
+API_FILES += vnet/cop/cop.api
 
 ########################################
 # Layer 2 protocols go here
diff --git a/src/vnet/cop/cop.api b/src/vnet/cop/cop.api
new file mode 100644 (file)
index 0000000..b34dae8
--- /dev/null
@@ -0,0 +1,88 @@
+/*
+ * Copyright (c) 2015-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.
+ */
+
+ /** \brief cop: enable/disable junk filtration features on an interface
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param sw_if_inded - desired interface
+    @param enable_disable - 1 => enable, 0 => disable
+*/
+
+define cop_interface_enable_disable
+{
+  u32 client_index;
+  u32 context;
+  u32 sw_if_index;
+  u8 enable_disable;
+};
+
+/** \brief cop: interface enable/disable junk filtration reply
+    @param context - returned sender context, to match reply w/ request
+    @param retval - return code
+*/
+
+define cop_interface_enable_disable_reply
+{
+  u32 context;
+  i32 retval;
+};
+
+/** \brief cop: enable/disable whitelist filtration features on an interface
+    Note: the supplied fib_id must match in order to remove the feature!
+    
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param sw_if_index - interface handle, physical interfaces only
+    @param fib_id - fib identifier for the whitelist / blacklist fib
+    @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
+    @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
+    @param default_cop -  1 => enable non-ip4, non-ip6 filtration 0=> disable it
+*/
+
+define cop_whitelist_enable_disable
+{
+  u32 client_index;
+  u32 context;
+  u32 sw_if_index;
+  u32 fib_id;
+  u8 ip4;
+  u8 ip6;
+  u8 default_cop;
+};
+
+/** \brief cop: interface enable/disable junk filtration reply
+    @param context - returned sender context, to match reply w/ request
+    @param retval - return code
+*/
+
+define cop_whitelist_enable_disable_reply
+{
+  u32 context;
+  i32 retval;
+};
+
+/** \brief get_node_graph - get a copy of the vpp node graph
+    including the current set of graph arcs.
+
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+*/
+
+ /*
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */
\ No newline at end of file
diff --git a/src/vnet/cop/cop_api.c b/src/vnet/cop/cop_api.c
new file mode 100644 (file)
index 0000000..95d5a9f
--- /dev/null
@@ -0,0 +1,141 @@
+/*
+ *------------------------------------------------------------------
+ * cop_api.c - cop api
+ *
+ * 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.
+ *------------------------------------------------------------------
+ */
+
+#include <vnet/vnet.h>
+#include <vlibmemory/api.h>
+
+#include <vnet/interface.h>
+#include <vnet/api_errno.h>
+#include <vnet/cop/cop.h>
+
+#include <vnet/vnet_msg_enum.h>
+
+#define vl_typedefs            /* define message structures */
+#include <vnet/vnet_all_api_h.h>
+#undef vl_typedefs
+
+#define vl_endianfun           /* define message structures */
+#include <vnet/vnet_all_api_h.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 <vnet/vnet_all_api_h.h>
+#undef vl_printfun
+
+#include <vlibapi/api_helper_macros.h>
+
+#define foreach_vpe_api_msg                                     \
+_(COP_INTERFACE_ENABLE_DISABLE, cop_interface_enable_disable)   \
+_(COP_WHITELIST_ENABLE_DISABLE, cop_whitelist_enable_disable)
+
+static void vl_api_cop_interface_enable_disable_t_handler
+  (vl_api_cop_interface_enable_disable_t * mp)
+{
+  vl_api_cop_interface_enable_disable_reply_t *rmp;
+  int rv;
+  u32 sw_if_index = ntohl (mp->sw_if_index);
+  int enable_disable;
+
+  VALIDATE_SW_IF_INDEX (mp);
+
+  enable_disable = (int) mp->enable_disable;
+
+  rv = cop_interface_enable_disable (sw_if_index, enable_disable);
+
+  BAD_SW_IF_INDEX_LABEL;
+
+  REPLY_MACRO (VL_API_COP_INTERFACE_ENABLE_DISABLE_REPLY);
+}
+
+static void vl_api_cop_whitelist_enable_disable_t_handler
+  (vl_api_cop_whitelist_enable_disable_t * mp)
+{
+  vl_api_cop_whitelist_enable_disable_reply_t *rmp;
+  cop_whitelist_enable_disable_args_t _a, *a = &_a;
+  u32 sw_if_index = ntohl (mp->sw_if_index);
+  int rv;
+
+  VALIDATE_SW_IF_INDEX (mp);
+
+  a->sw_if_index = sw_if_index;
+  a->ip4 = mp->ip4;
+  a->ip6 = mp->ip6;
+  a->default_cop = mp->default_cop;
+  a->fib_id = ntohl (mp->fib_id);
+
+  rv = cop_whitelist_enable_disable (a);
+
+  BAD_SW_IF_INDEX_LABEL;
+
+  REPLY_MACRO (VL_API_COP_WHITELIST_ENABLE_DISABLE_REPLY);
+}
+
+/*
+ * cop_api_hookup
+ * Add vpe's API message handlers to the table.
+ * vlib has alread mapped shared memory and
+ * added the client registration handlers.
+ * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
+ */
+#define vl_msg_name_crc_list
+#include <vnet/vnet_all_api_h.h>
+#undef vl_msg_name_crc_list
+
+static void
+setup_message_id_table (api_main_t * am)
+{
+#define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
+  foreach_vl_msg_name_crc_cop;
+#undef _
+}
+
+static clib_error_t *
+cop_api_hookup (vlib_main_t * vm)
+{
+  api_main_t *am = &api_main;
+
+#define _(N,n)                                                  \
+    vl_msg_api_set_handlers(VL_API_##N, #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_msg;
+#undef _
+
+  /*
+   * Set up the (msg_name, crc, message-id) table
+   */
+  setup_message_id_table (am);
+
+  return 0;
+}
+
+VLIB_API_INIT_FUNCTION (cop_api_hookup);
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */
index 4ba3a0e..9a75872 100644 (file)
@@ -55,6 +55,7 @@
 #include <vnet/classify/classify.api.h>
 #include <vnet/flow/flow.api.h>
 #include <vnet/dhcp/dhcp.api.h>
+#include <vnet/cop/cop.api.h>
 
 /*
  * fd.io coding-style-patch-verification: ON
index 6c8800e..f929f56 100644 (file)
@@ -64,7 +64,6 @@
 #include <vnet/vxlan/vxlan.h>
 #include <vnet/vxlan-gpe/vxlan_gpe.h>
 #include <vnet/map/map.h>
-#include <vnet/cop/cop.h>
 #include <vnet/ip/ip6_hop_by_hop.h>
 #include <vnet/ip/ip_source_and_port_range_check.h>
 #include <vnet/policer/policer.h>
@@ -142,8 +141,6 @@ _(WANT_IP6_ND_EVENTS, want_ip6_nd_events)                               \
 _(INPUT_ACL_SET_INTERFACE, input_acl_set_interface)                     \
 _(DELETE_LOOPBACK, delete_loopback)                                     \
 _(BD_IP_MAC_ADD_DEL, bd_ip_mac_add_del)                                 \
-_(COP_INTERFACE_ENABLE_DISABLE, cop_interface_enable_disable)          \
-_(COP_WHITELIST_ENABLE_DISABLE, cop_whitelist_enable_disable)          \
 _(GET_NODE_GRAPH, get_node_graph)                                       \
 _(IOAM_ENABLE, ioam_enable)                                             \
 _(IOAM_DISABLE, ioam_disable)                                           \
@@ -1957,48 +1954,6 @@ static void vl_api_input_acl_set_interface_t_handler
   REPLY_MACRO (VL_API_INPUT_ACL_SET_INTERFACE_REPLY);
 }
 
-static void vl_api_cop_interface_enable_disable_t_handler
-  (vl_api_cop_interface_enable_disable_t * mp)
-{
-  vl_api_cop_interface_enable_disable_reply_t *rmp;
-  int rv;
-  u32 sw_if_index = ntohl (mp->sw_if_index);
-  int enable_disable;
-
-  VALIDATE_SW_IF_INDEX (mp);
-
-  enable_disable = (int) mp->enable_disable;
-
-  rv = cop_interface_enable_disable (sw_if_index, enable_disable);
-
-  BAD_SW_IF_INDEX_LABEL;
-
-  REPLY_MACRO (VL_API_COP_INTERFACE_ENABLE_DISABLE_REPLY);
-}
-
-static void vl_api_cop_whitelist_enable_disable_t_handler
-  (vl_api_cop_whitelist_enable_disable_t * mp)
-{
-  vl_api_cop_whitelist_enable_disable_reply_t *rmp;
-  cop_whitelist_enable_disable_args_t _a, *a = &_a;
-  u32 sw_if_index = ntohl (mp->sw_if_index);
-  int rv;
-
-  VALIDATE_SW_IF_INDEX (mp);
-
-  a->sw_if_index = sw_if_index;
-  a->ip4 = mp->ip4;
-  a->ip6 = mp->ip6;
-  a->default_cop = mp->default_cop;
-  a->fib_id = ntohl (mp->fib_id);
-
-  rv = cop_whitelist_enable_disable (a);
-
-  BAD_SW_IF_INDEX_LABEL;
-
-  REPLY_MACRO (VL_API_COP_WHITELIST_ENABLE_DISABLE_REPLY);
-}
-
 static void
 vl_api_get_node_graph_t_handler (vl_api_get_node_graph_t * mp)
 {
index 981ae25..6e17400 100644 (file)
@@ -44,6 +44,7 @@
  * CLASSIFY APIs: see ... /src/vnet/classify/{classify.api, classify_api.c}
  * FLOW APIs: see ... /src/vnet/flow/{flow.api, flow_api.c}
  * DHCP APIs: see ... /src/vnet/dhcp/{dhcpk.api, dhcp_api.c}
+ * COP APIs: see ... /src/vnet/cop/{cop.api, cop_api.c}
  */
 
 /** \brief Create a new subinterface with the given vlan id
@@ -990,73 +991,6 @@ define input_acl_set_interface_reply
   i32 retval;
 };
 
-/** \brief cop: enable/disable junk filtration features on an interface
-    @param client_index - opaque cookie to identify the sender
-    @param context - sender context, to match reply w/ request
-    @param sw_if_inded - desired interface
-    @param enable_disable - 1 => enable, 0 => disable
-*/
-
-define cop_interface_enable_disable
-{
-  u32 client_index;
-  u32 context;
-  u32 sw_if_index;
-  u8 enable_disable;
-};
-
-/** \brief cop: interface enable/disable junk filtration reply
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-
-define cop_interface_enable_disable_reply
-{
-  u32 context;
-  i32 retval;
-};
-
-/** \brief cop: enable/disable whitelist filtration features on an interface
-    Note: the supplied fib_id must match in order to remove the feature!
-    
-    @param client_index - opaque cookie to identify the sender
-    @param context - sender context, to match reply w/ request
-    @param sw_if_index - interface handle, physical interfaces only
-    @param fib_id - fib identifier for the whitelist / blacklist fib
-    @param ip4 - 1 => enable ip4 filtration, 0=> disable ip4 filtration
-    @param ip6 - 1 => enable ip6 filtration, 0=> disable ip6 filtration
-    @param default_cop -  1 => enable non-ip4, non-ip6 filtration 0=> disable it
-*/
-
-define cop_whitelist_enable_disable
-{
-  u32 client_index;
-  u32 context;
-  u32 sw_if_index;
-  u32 fib_id;
-  u8 ip4;
-  u8 ip6;
-  u8 default_cop;
-};
-
-/** \brief cop: interface enable/disable junk filtration reply
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-
-define cop_whitelist_enable_disable_reply
-{
-  u32 context;
-  i32 retval;
-};
-
-/** \brief get_node_graph - get a copy of the vpp node graph
-    including the current set of graph arcs.
-
-    @param client_index - opaque cookie to identify the sender
-    @param context - sender context, to match reply w/ request
-*/
-
 define get_node_graph
 {
   u32 client_index;