summaryrefslogtreecommitdiffstats
path: root/src/vnet/interface.api
diff options
context:
space:
mode:
authorOle Trøan <otroan@employees.org>2019-03-15 16:14:41 +0000
committerOle Trøan <otroan@employees.org>2019-03-15 17:34:06 +0000
commit3b0d7e42f65eaf8d84cfe26e2e9f5244c554b934 (patch)
tree4c7248e37fc7e0d3478fa5a77a8bfc7b2c9159d4 /src/vnet/interface.api
parent3fef8f811a013d1392f702fda1347c5211471ed7 (diff)
Revert "API: Cleanup APIs interface.api"
This reverts commit e63325e3ca03c847963863446345e6c80a2c0cfd. Allow time for CSIT to accommodate. Change-Id: I59435e4ab5e05e36a2796c3bf44889b5d4823cc2 Signed-off-by: ot@cisco.com
Diffstat (limited to 'src/vnet/interface.api')
-rw-r--r--src/vnet/interface.api221
1 files changed, 124 insertions, 97 deletions
diff --git a/src/vnet/interface.api b/src/vnet/interface.api
index cae2b65778e..1af323e0a44 100644
--- a/src/vnet/interface.api
+++ b/src/vnet/interface.api
@@ -14,11 +14,9 @@
* limitations under the License.
*/
-option version = "3.0.0";
+option version = "2.2.0";
import "vnet/interface_types.api";
-import "vnet/ethernet/ethernet_types.api";
-import "vnet/ip/ip_types.api";
service {
rpc want_interface_events returns want_interface_events_reply
@@ -29,15 +27,16 @@ service {
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - index of the interface to set flags on
- @param flags - interface_status flags
- (only IF_STATUS_API_FLAG_ADMIN_UP used in config)
+ @param admin_up_down - set the admin state, 1 = up, 0 = down
+ @param link_up_down - Oper state sent on change event, not used in config.
*/
autoreply define sw_interface_set_flags
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
- vl_api_if_status_flags_t flags;
+ u32 sw_if_index;
+ /* 1 = up, 0 = down */
+ u8 admin_up_down;
};
/** \brief Set interface physical MTU
@@ -50,7 +49,7 @@ autoreply define hw_interface_set_mtu
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
+ u32 sw_if_index;
u16 mtu;
};
@@ -59,8 +58,9 @@ autoreply define sw_interface_set_mtu
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
- u32 mtu[4]; /* vl_api_mtu_proto_t 0 - L3, 1 - IP4, 2 - IP6, 3 - MPLS */
+ u32 sw_if_index;
+ /* $$$$ Replace with enum */
+ u32 mtu[4]; /* 0 - L3, 1 - IP4, 2 - IP6, 3 - MPLS */
};
/** \brief Set IP4 directed broadcast
@@ -73,8 +73,8 @@ autoreply define sw_interface_set_ip_directed_broadcast
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
- bool enable;
+ u32 sw_if_index;
+ u8 enable;
};
@@ -82,16 +82,18 @@ autoreply define sw_interface_set_ip_directed_broadcast
@param client_index - opaque cookie to identify the sender
@param pid - client pid registered to receive notification
@param sw_if_index - index of the interface of the event
- @param flags - interface_status flags
+ @param admin_up_down - The administrative state; 1 = up, 0 = down
+ @param link_up_down - The operational state; 1 = up, 0 = down
@param deleted - interface was deleted
*/
define sw_interface_event
{
u32 client_index;
u32 pid;
- vl_api_interface_index_t sw_if_index;
- vl_api_if_status_flags_t flags;
- bool deleted;
+ u32 sw_if_index;
+ u8 admin_up_down;
+ u8 link_up_down;
+ u8 deleted;
};
/** \brief Register for interface events
@@ -108,19 +110,25 @@ autoreply define want_interface_events
u32 pid;
};
-/** \brief Interface details structure (fix this)
+/** \brief Interface details structure (fix this)
@param sw_if_index - index of the interface
- @param sup_sw_if_index - index of parent interface if any, else same as sw_if_index
- @param l2_address - the interface's l2 address
- @param flags - interface_status flags
+ @param sup_sw_if_index - index of parent interface if any, else same as sw_if_index
+ @param l2_address_length - length of the interface's l2 address
+ @param pid - the interface's l2 address
+ @param interface_name - name of the interface
@param link_duplex - 1 if half duplex, 2 if full duplex
@param link_speed - value in kbps
@param link_MTU - max. transmission unit
- @param sub_id - A number 0-N to uniquely identify this subif on super if
+ @param sub_if_id - A number 0-N to uniquely identify this subif on super if
+ @param sub_dot1ad - 0 = dot1q, 1 = dot1ad
+ @param sub_dot1ah - 1 = dot1ah, 0 = otherwise
@param sub_number_of_tags - Number of tags (0 - 2)
@param sub_outer_vlan_id
@param sub_inner_vlan_id
- @param sub_if_flags - sub interface flags
+ @param sub_exact_match
+ @param sub_default
+ @param sub_outer_vlan_id_any
+ @param sub_inner_vlan_id_any
@param vtr_op - vlan tag rewrite operation
@param vtr_push_dot1q
@param vtr_tag1
@@ -130,25 +138,29 @@ autoreply define want_interface_events
@param pbb_b_smac[6] - B-tag local mac address
@param pbb_b_vlanid - B-tag vlanid
@param pbb_i_sid - I-tag service id
- @param interface_name - name of the interface
- @param tag - an ascii tag
*/
define sw_interface_details
{
u32 context;
- vl_api_interface_index_t sw_if_index;
+ u32 sw_if_index;
/* index of sup interface (e.g. hw interface).
equal to sw_if_index for super hw interface. */
u32 sup_sw_if_index;
/* Layer 2 address, if applicable */
- vl_api_mac_address_t l2_address;
+ u32 l2_address_length;
+ u8 l2_address[8];
+
+ /* Interface name */
+ u8 interface_name[64];
- vl_api_if_status_flags_t flags;
+ /* 1 = up, 0 = down */
+ u8 admin_up_down;
+ u8 link_up_down;
/* 1 = half duplex, 2 = full duplex */
- vl_api_link_duplex_t link_duplex;
+ u8 link_duplex;
/* link speed in kbps */
u32 link_speed;
@@ -157,34 +169,38 @@ define sw_interface_details
u16 link_mtu;
/* Per protocol MTUs */
- u32 mtu[4]; /* vl_api_mtu_proto_t 0 - L3, 1 - IP4, 2 - IP6, 3 - MPLS */
+ u32 mtu[4]; /* 0 - L3, 1 - IP4, 2 - IP6, 3 - MPLS */
/* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface */
u32 sub_id;
+ /* 0 = dot1q, 1=dot1ad */
+ u8 sub_dot1ad;
+ /* 1 = dot1h, 1=otherwise */
+ u8 sub_dot1ah;
+
/* Number of tags 0-2 */
u8 sub_number_of_tags;
u16 sub_outer_vlan_id;
u16 sub_inner_vlan_id;
-
- vl_api_sub_if_flags_t sub_if_flags;
+ u8 sub_exact_match;
+ u8 sub_default;
+ u8 sub_outer_vlan_id_any;
+ u8 sub_inner_vlan_id_any;
/* vlan tag rewrite state */
u32 vtr_op;
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;
- vl_api_mac_address_t b_dmac;
- vl_api_mac_address_t b_smac;
+ u8 b_dmac[6];
+ u8 b_smac[6];
u16 b_vlanid;
u32 i_sid;
-
- /* Interface name */
- string interface_name;
- string tag;
};
/** \brief Request all or filtered subset of sw_interface_details
@@ -198,27 +214,30 @@ define sw_interface_dump
{
u32 client_index;
u32 context;
- bool name_filter_valid;
- string name_filter;
+ u8 name_filter_valid;
+ u8 name_filter[49];
};
/** \brief Set or delete one or all ip addresses on a specified interface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
- @param sw_if_index - index of the interface to add/del addresses
+ @param sw_if_index - index of the interface to add/del addresses
@param is_add - add address if non-zero, else delete
+ @param is_ipv6 - if non-zero the address is ipv6, else ipv4
@param del_all - if non-zero delete all addresses on the interface
- @param prefix - address + a prefix length for the implied connected route
+ @param address_length - address length in bytes, 4 for ip4, 16 for ip6
+ @param address - array of address bytes
*/
autoreply define sw_interface_add_del_address
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
- bool is_add;
-
- bool del_all;
- vl_api_prefix_t prefix;
+ u32 sw_if_index;
+ u8 is_add;
+ u8 is_ipv6;
+ u8 del_all;
+ u8 address_length;
+ u8 address[16];
};
/** \brief Associate the specified interface with a fib table
@@ -232,8 +251,8 @@ autoreply define sw_interface_set_table
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
- bool is_ipv6;
+ u32 sw_if_index;
+ u8 is_ipv6;
u32 vrf_id;
};
@@ -246,8 +265,8 @@ define sw_interface_get_table
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
- bool is_ipv6;
+ u32 sw_if_index;
+ u8 is_ipv6;
};
/** \brief Reply to get_sw_interface_vrf
@@ -272,9 +291,9 @@ autoreply define sw_interface_set_unnumbered
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index; /* use this intfc address */
- vl_api_interface_index_t unnumbered_sw_if_index; /* on this interface */
- bool is_add;
+ u32 sw_if_index; /* use this intfc address */
+ u32 unnumbered_sw_if_index; /* on this interface */
+ u8 is_add;
};
/** \brief Clear interface statistics
@@ -286,7 +305,7 @@ autoreply define sw_interface_clear_stats
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
+ u32 sw_if_index;
};
/** \brief Set / clear software interface tag
@@ -296,13 +315,13 @@ autoreply define sw_interface_clear_stats
@param add_del - 1 = add, 0 = delete
@param tag - an ascii tag
*/
-autoreply define sw_interface_tag_add_del
+autoreply define sw_interface_tag_add_del
{
- u32 client_index;
- u32 context;
- bool is_add;
- vl_api_interface_index_t sw_if_index;
- string tag;
+ u32 client_index;
+ u32 context;
+ u8 is_add;
+ u32 sw_if_index;
+ u8 tag[64];
};
/** \brief Set an interface's MAC address
@@ -313,10 +332,10 @@ autoreply define sw_interface_tag_add_del
*/
autoreply define sw_interface_set_mac_address
{
- u32 client_index;
- u32 context;
- vl_api_interface_index_t sw_if_index;
- vl_api_mac_address_t mac_address;
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+ u8 mac_address[6];
};
/** \brief Get interface's MAC address
@@ -326,9 +345,9 @@ autoreply define sw_interface_set_mac_address
*/
define sw_interface_get_mac_address
{
- u32 client_index;
- u32 context;
- vl_api_interface_index_t sw_if_index;
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
};
/** \brief Reply for get interface's MAC address request
@@ -338,9 +357,9 @@ define sw_interface_get_mac_address
*/
define sw_interface_get_mac_address_reply
{
- u32 context;
- i32 retval;
- vl_api_mac_address_t mac_address;
+ u32 context;
+ i32 retval;
+ u8 mac_address[6];
};
/** \brief Set an interface's rx-mode
@@ -355,12 +374,12 @@ define sw_interface_get_mac_address_reply
*/
autoreply define sw_interface_set_rx_mode
{
- u32 client_index;
- u32 context;
- vl_api_interface_index_t sw_if_index;
- bool queue_id_valid;
- u32 queue_id;
- vl_api_rx_mode_t mode;
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+ u8 queue_id_valid;
+ u32 queue_id;
+ u8 mode;
};
/** \brief Set an interface's rx-placement
@@ -378,10 +397,10 @@ autoreply define sw_interface_set_rx_placement
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
+ u32 sw_if_index;
u32 queue_id;
u32 worker_id;
- bool is_main;
+ u8 is_main;
};
/** \brief dump the rx queue placement of interface(s)
@@ -394,7 +413,7 @@ define sw_interface_rx_placement_dump
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
+ u32 sw_if_index;
};
/** \brief show the interface's queue - thread placement
@@ -416,10 +435,10 @@ define sw_interface_rx_placement_details
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
+ u32 sw_if_index;
u32 queue_id;
u32 worker_id;
- vl_api_rx_mode_t mode;
+ u8 mode;
};
/* Gross kludge, DGMS */
@@ -427,7 +446,7 @@ autoreply define interface_name_renumber
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
+ u32 sw_if_index;
u32 new_show_dev_instance;
};
@@ -435,10 +454,18 @@ define create_subif
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
+ u32 sw_if_index;
u32 sub_id;
- vl_api_sub_if_flags_t sub_if_flags;
+ /* These fields map directly onto the subif template */
+ u8 no_tags;
+ u8 one_tag;
+ u8 two_tags;
+ u8 dot1ad; // 0 = dot1q, 1=dot1ad
+ u8 exact_match;
+ u8 default_sub;
+ u8 outer_vlan_id_any;
+ u8 inner_vlan_id_any;
u16 outer_vlan_id;
u16 inner_vlan_id;
};
@@ -447,7 +474,7 @@ define create_subif_reply
{
u32 context;
i32 retval;
- vl_api_interface_index_t sw_if_index;
+ u32 sw_if_index;
};
/** \brief Create a new subinterface with the given vlan id
@@ -460,7 +487,7 @@ define create_vlan_subif
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
+ u32 sw_if_index;
u32 vlan_id;
};
@@ -473,7 +500,7 @@ define create_vlan_subif_reply
{
u32 context;
i32 retval;
- vl_api_interface_index_t sw_if_index;
+ u32 sw_if_index;
};
/** \brief Delete sub interface request
@@ -484,7 +511,7 @@ define create_vlan_subif_reply
autoreply define delete_subif {
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
+ u32 sw_if_index;
};
/** \brief Create loopback interface request
@@ -496,7 +523,7 @@ define create_loopback
{
u32 client_index;
u32 context;
- vl_api_mac_address_t mac_address;
+ u8 mac_address[6];
};
/** \brief Create loopback interface response
@@ -508,7 +535,7 @@ define create_loopback_reply
{
u32 context;
i32 retval;
- vl_api_interface_index_t sw_if_index;
+ u32 sw_if_index;
};
/** \brief Create loopback interface instance request
@@ -522,8 +549,8 @@ define create_loopback_instance
{
u32 client_index;
u32 context;
- vl_api_mac_address_t mac_address;
- bool is_specified;
+ u8 mac_address[6];
+ u8 is_specified;
u32 user_instance;
};
@@ -536,7 +563,7 @@ define create_loopback_instance_reply
{
u32 context;
i32 retval;
- vl_api_interface_index_t sw_if_index;
+ u32 sw_if_index;
};
/** \brief Delete loopback interface request
@@ -548,7 +575,7 @@ autoreply define delete_loopback
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
+ u32 sw_if_index;
};
/** \brief Enable or disable detailed interface stats
@@ -562,8 +589,8 @@ autoreply define collect_detailed_interface_stats
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
- bool enable_disable;
+ u32 sw_if_index;
+ u8 enable_disable;
};
/*