From 30d28bdfd8aca4d6d3c70482ad9ebfdb753610aa Mon Sep 17 00:00:00 2001
From: Ole Troan <ot@cisco.com>
Date: Fri, 23 Aug 2019 22:55:18 +0200
Subject: api: enforce vla is last and fixed string type

Enforce that variable length fields are the last element of API messages.

Add a 'fixed' version of string type, since dealing with
multiple variable length strings turned out too painful
for the C language bindings.

The string type is now:
{
  string name[64]; // NUL terminated C-string. Essentially decays to u8 name[64]
  string name[];   // Variable length string with embedded len field (vl_api_string_t)
};

The latter notation could be made available to other types as well.
e.g.
{
  vl_api_address_t addresses[];
}
instead of

{
  u32 n_addr;
  vl_api_address_t addresses[n_addr];
};

Type: fix
Change-Id: I18fa17ef47227633752ab50453e8d20a652a9f9b
Signed-off-by: Ole Troan <ot@cisco.com>
(cherry picked from commit e5ff5a36dd126ee57dca4e0b03da2f7704e0a4f5)
Signed-off-by: Ole Troan <ot@cisco.com>
---
 src/vnet/interface.api       | 24 ++++++++++++------------
 src/vnet/interface_api.c     |  5 +++--
 src/vnet/ip/punt.api         |  4 ++--
 src/vnet/session/session.api |  2 +-
 4 files changed, 18 insertions(+), 17 deletions(-)

(limited to 'src/vnet')

diff --git a/src/vnet/interface.api b/src/vnet/interface.api
index d30f1c285ea..4ffc7f8801d 100644
--- a/src/vnet/interface.api
+++ b/src/vnet/interface.api
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-option version = "2.3.1";
+option version = "3.1.1";
 
 import "vnet/interface_types.api";
 
@@ -151,9 +151,6 @@ define sw_interface_details
   u32 l2_address_length;
   u8 l2_address[8];
 
-  /* Interface name */
-  u8 interface_name[64];
-
   /* 1 = up, 0 = down */
   u8 admin_up_down;
   u8 link_up_down;
@@ -192,7 +189,6 @@ define sw_interface_details
   u32 vtr_push_dot1q;		// ethertype of first pushed tag is dot1q/dot1ad
   u32 vtr_tag1;			// first pushed tag
   u32 vtr_tag2;			// second pushed tag
-  u8 tag[64];
 
   /* pbb tag rewrite info */
   u16 outer_tag;
@@ -200,6 +196,10 @@ define sw_interface_details
   u8  b_smac[6];
   u16 b_vlanid;
   u32 i_sid;
+
+  /* Interface name */
+  string interface_name[64];
+  string tag[64];
 };
 
 /** \brief Request all or filtered subset of sw_interface_details
@@ -216,8 +216,8 @@ define sw_interface_dump
   u32 client_index;
   u32 context;
   vl_api_interface_index_t sw_if_index;
-  u8 name_filter_valid;
-  u8 name_filter[49];
+  bool name_filter_valid;
+  string name_filter[];
 };
 
 /** \brief Set or delete one or all ip addresses on a specified interface
@@ -319,11 +319,11 @@ autoreply define sw_interface_clear_stats
 */
 autoreply define sw_interface_tag_add_del 
 {
-    u32 client_index;
-    u32 context;
-    u8 is_add;
-    u32 sw_if_index;
-    u8 tag[64];
+  u32 client_index;
+  u32 context;
+  bool is_add;
+  vl_api_interface_index_t sw_if_index;
+  string tag[64];
 };
 
 /** \brief Set an interface's MAC address
diff --git a/src/vnet/interface_api.c b/src/vnet/interface_api.c
index fb1982ae8b0..d170b71e07f 100644
--- a/src/vnet/interface_api.c
+++ b/src/vnet/interface_api.c
@@ -327,8 +327,9 @@ vl_api_sw_interface_dump_t_handler (vl_api_sw_interface_dump_t * mp)
 
   if (mp->name_filter_valid)
     {
-      mp->name_filter[ARRAY_LEN (mp->name_filter) - 1] = 0;
-      filter = format (0, "%s%c", mp->name_filter, 0);
+      filter =
+	format (0, ".*%s", vl_api_string_len (&mp->name_filter),
+		vl_api_from_api_string (&mp->name_filter), 0);
     }
 
   char *strcasestr (char *, char *);	/* lnx hdr file botch */
diff --git a/src/vnet/ip/punt.api b/src/vnet/ip/punt.api
index 72efc7a9557..9890385fe5a 100644
--- a/src/vnet/ip/punt.api
+++ b/src/vnet/ip/punt.api
@@ -13,7 +13,7 @@
  * limitations under the License.
  */
 
-option version = "2.1.0";
+option version = "2.2.0";
 import "vnet/ip/ip_types.api";
 
 /** \brief The types of packets to be punted
@@ -134,7 +134,7 @@ autoreply define punt_socket_deregister {
 typedef punt_reason
 {
     u32 id;
-    string name;
+    string name[];
 };
 
 /** \brief Dump all or one of the excpetion punt reasons
diff --git a/src/vnet/session/session.api b/src/vnet/session/session.api
index 533f65e85a2..8f0b7a28df2 100644
--- a/src/vnet/session/session.api
+++ b/src/vnet/session/session.api
@@ -263,9 +263,9 @@ autoreply define connect_sock {
   u8 ip[16];
   u16 port;
   u8 proto;
+  u64 parent_handle;
   u8 hostname_len;
   u8 hostname[hostname_len];
-  u64 parent_handle;
 };
 
 /** \brief ask app to add a new cut-through registration
-- 
cgit 1.2.3-korg