acl-plugin: add a plugin-specific control-ping message api and make the test code...

[vpp.git] / src / plugins / acl / acl.api

diff --git a/src/plugins/acl/acl.api b/src/plugins/acl/acl.api
index 58a5a17..d34f374 100644 (file)
--- a/src/plugins/acl/acl.api
+++ b/src/plugins/acl/acl.api
@@ -44,6 +44,30 @@ define acl_plugin_get_version_reply
   u32 minor;
 };
 
+/** \brief Control ping from client to api server request
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+*/
+define acl_plugin_control_ping
+{
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief Control ping from the client to the server response
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param retval - return code for the request
+    @param vpe_pid - the pid of the vpe, returned by the server
+*/
+define acl_plugin_control_ping_reply
+{
+  u32 context;
+  i32 retval;
+  u32 client_index;
+  u32 vpe_pid;
+};
+
 /** \brief Access List Rule entry
     @param is_permit - deny (0), permit (1), or permit+reflect(2) action on this rule.
     @param is_ipv6   - IP addresses in this rule are IPv6 (1) or IPv4 (0)
@@ -60,7 +84,7 @@ define acl_plugin_get_version_reply
     @param tcp_flags_value - if proto==6, mask to AND the TCP flags in the packet with
 */
 
-typeonly manual_print manual_endian define acl_rule
+typeonly manual_print define acl_rule
 {
   u8 is_permit;
   u8 is_ipv6;
@@ -104,7 +128,7 @@ typeonly manual_print manual_endian define acl_rule
     @param src_ip_prefix_len - Source prefix length
 */
 
-typeonly manual_print manual_endian define macip_acl_rule
+typeonly manual_print define macip_acl_rule
 {
   u8 is_permit;
   u8 is_ipv6;
@@ -161,24 +185,13 @@ define acl_add_replace_reply
     @param acl_index - ACL index to delete
 */
 
-define acl_del
+autoreply manual_print define acl_del
 {
   u32 client_index;
   u32 context;
   u32 acl_index;
 };
 
-/** \brief Reply to delete the ACL
-    @param context - returned sender context, to match reply w/ request
-    @param retval 0 - no error
-*/
-
-define acl_del_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /* acl_interface_add_del(_reply) to be deprecated in lieu of acl_interface_set_acl_list */
 /** \brief Use acl_interface_set_acl_list instead
     Append/remove an ACL index to/from the list of ACLs checked for an interface
@@ -190,7 +203,7 @@ define acl_del_reply
     @param acl_index - index of ACL for the operation
 */
 
-define acl_interface_add_del
+autoreply manual_print define acl_interface_add_del
 {
   u32 client_index;
   u32 context;
@@ -204,17 +217,6 @@ define acl_interface_add_del
   u32 acl_index;
 };
 
-/** \brief Reply to alter the ACL list
-    @param context - returned sender context, to match reply w/ request
-    @param retval 0 - no error
-*/
-
-define acl_interface_add_del_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief Set the vector of input/output ACLs checked for an interface
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -224,7 +226,7 @@ define acl_interface_add_del_reply
     @param acls - vector of ACL indices
 */
 
-manual_endian define acl_interface_set_acl_list
+autoreply manual_print define acl_interface_set_acl_list
 {
   u32 client_index;
   u32 context;
@@ -239,12 +241,6 @@ manual_endian define acl_interface_set_acl_list
     @param retval 0 - no error
 */
 
-define acl_interface_set_acl_list_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief Dump the specific ACL contents or all of the ACLs' contents
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -266,7 +262,7 @@ define acl_dump
     @param r - Array of rules within this ACL
 */
 
-manual_print manual_endian define acl_details
+manual_endian manual_print define acl_details
 {
   u32 context;
   u32 acl_index;
@@ -296,7 +292,7 @@ define acl_interface_list_dump
     @param acls - the vector of ACL indices
 */
 
-manual_endian define acl_interface_list_details
+define acl_interface_list_details
 {
   u32 context;
   u32 sw_if_index;
@@ -313,7 +309,7 @@ manual_endian define acl_interface_list_details
     @param r - vector of MACIP ACL rules
 */
 
-manual_print manual_endian define macip_acl_add
+manual_endian manual_print define macip_acl_add
 {
   u32 client_index;
   u32 context;
@@ -341,24 +337,13 @@ define macip_acl_add_reply
     @param acl_index - MACIP ACL index to delete
 */
 
-define macip_acl_del
+autoreply manual_print define macip_acl_del
 {
   u32 client_index;
   u32 context;
   u32 acl_index;
 };
 
-/** \brief Reply to delete the MACIP ACL
-    @param context - returned sender context, to match reply w/ request
-    @param retval 0 - no error
-*/
-
-define macip_acl_del_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief Add or delete a MACIP ACL to/from interface
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -367,7 +352,7 @@ define macip_acl_del_reply
     @param acl_index - MACIP ACL index
 */
 
-define macip_acl_interface_add_del
+autoreply manual_print define macip_acl_interface_add_del
 {
   u32 client_index;
   u32 context;
@@ -377,17 +362,6 @@ define macip_acl_interface_add_del
   u32 acl_index;
 };
 
-/** \brief Reply to apply/unapply  the MACIP ACL
-    @param context - returned sender context, to match reply w/ request
-    @param retval 0 - no error
-*/
-
-define macip_acl_interface_add_del_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief Dump one or all defined MACIP ACLs
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -409,7 +383,7 @@ define macip_acl_dump
     @param r - rules comprising this ACL
 */
 
-manual_print manual_endian define macip_acl_details
+manual_endian manual_print define macip_acl_details
 {
   u32 context;
   u32 acl_index;