sr: srv6 API cleanup
[vpp.git] / src / vnet / srv6 / sr.api
index bc22d61..75a23b0 100644 (file)
  * limitations under the License.
  */
 
-option version = "1.0.1";
+option version = "2.0.0";
+
+import "vnet/interface_types.api";
+import "vnet/ip/ip_types.api";
+import "vnet/srv6/sr_types.api";
+
+
+typedef srv6_sid_list
+{
+  u8 num_sids;
+  u32 weight;
+  vl_api_ip6_address_t sids[16];
+};
 
 /** \brief IPv6 SR LocalSID add/del request
     @param client_index - opaque cookie to identify the sender
@@ -27,20 +39,20 @@ option version = "1.0.1";
      fib_table.
     @param vlan_index Only for L2 xconnect. Outgoing VLAN tag.
     @param fib_table  FIB table in which we should install the localsid entry
-    @param nh_addr Next Hop IPv4/IPv6 address. Only for L2/L3 xconnect.
+    @param nh_addr Next Hop IPv46 address. Only for L2/L3 xconnect.
 */
 autoreply define sr_localsid_add_del
 {
   u32 client_index;
   u32 context;
-  u8 is_del;
-  u8 localsid_addr[16];
-  u8 end_psp;
-  u8 behavior;
-  u32 sw_if_index;
+  bool is_del [default=false];
+  vl_api_ip6_address_t localsid;
+  bool end_psp;
+  vl_api_sr_behavior_t behavior;
+  vl_api_interface_index_t sw_if_index;
   u32 vlan_index;
   u32 fib_table;
-  u8 nh_addr[16];
+  vl_api_address_t nh_addr;
 };
 
 /** \brief IPv6 SR policy add
@@ -49,21 +61,20 @@ autoreply define sr_localsid_add_del
     @param bsid is the bindingSID of the SR Policy
     @param weight is the weight of the sid list. optional.
     @param is_encap is the behavior of the SR policy. (0.SRH insert // 1.Encapsulation)
-    @param type is the type of the SR policy. (0.Default // 1.Spray)
+    @param is_spray is the type of the SR policy. (0.Default // 1.Spray)
     @param fib_table is the VRF where to install the FIB entry for the BSID
-    @param segments is a vector of IPv6 address composing the segment list
+    @param sids is a srv6_sid_list object
 */
 autoreply define sr_policy_add
 {
   u32 client_index;
   u32 context;
-  u8 bsid_addr[16];
+  vl_api_ip6_address_t bsid_addr;
   u32 weight;
-  u8 is_encap;
-  u8 type;
+  bool is_encap;
+  bool is_spray;
   u32 fib_table;
-  u8 n_segments;
-  u8 segments[0];
+  vl_api_srv6_sid_list_t sids;
 };
 
 /** \brief IPv6 SR policy modification
@@ -73,23 +84,21 @@ autoreply define sr_policy_add
     @param sr_policy_index is the index of the SR policy
     @param fib_table is the VRF where to install the FIB entry for the BSID
     @param operation is the operation to perform (among the top ones)
-    @param segments is a vector of IPv6 address composing the segment list
     @param sl_index is the index of the Segment List to modify/delete
     @param weight is the weight of the sid list. optional.
-    @param is_encap Mode. Encapsulation or SRH insertion.
+    @param sids is a srv6_sid_list object
 */
 autoreply define sr_policy_mod
 {
   u32 client_index;
   u32 context;
-  u8 bsid_addr[16];
+  vl_api_ip6_address_t bsid_addr;
   u32 sr_policy_index;
   u32 fib_table;
-  u8 operation;
+  vl_api_sr_policy_op_t operation;
   u32 sl_index;
   u32 weight;
-  u8 n_segments;
-  u8 segments[0];
+  vl_api_srv6_sid_list_t sids;
 };
 
 /** \brief IPv6 SR policy deletion
@@ -102,7 +111,7 @@ autoreply define sr_policy_del
 {
   u32 client_index;
   u32 context;
-  u8 bsid_addr[16];
+  vl_api_ip6_address_t bsid_addr;
   u32 sr_policy_index;
 };
 
@@ -116,7 +125,19 @@ autoreply define sr_set_encap_source
 {
   u32 client_index;
   u32 context;
-  u8 encaps_source[16];
+  vl_api_ip6_address_t encaps_source;
+};
+
+/** \brief IPv6 SR Set SRv6 encapsulation hop-limit
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param hop_limit is the hop-limit value to set
+*/
+autoreply define sr_set_encap_hop_limit
+{
+  u32 client_index;
+  u32 context;
+  u8 hop_limit;
 };
 
 /** \brief IPv6 SR steering add/del
@@ -135,14 +156,13 @@ autoreply define sr_steering_add_del
 {
   u32 client_index;
   u32 context;
-  u8 is_del;
-  u8 bsid_addr[16];
+  bool is_del [default=false];
+  vl_api_ip6_address_t bsid_addr;
   u32 sr_policy_index;
   u32 table_id;
-  u8 prefix_addr[16];
-  u32 mask_width;
-  u32 sw_if_index;
-  u8 traffic_type;
+  vl_api_prefix_t prefix;
+  vl_api_interface_index_t sw_if_index;
+  vl_api_sr_steer_t traffic_type;
 };
 
 /** \brief Dump the list of SR LocalSIDs
@@ -158,14 +178,56 @@ define sr_localsids_dump
 define sr_localsids_details
 {
   u32 context;
-  u8 address[16];
-  u8 end_psp;
-  u16 behavior;
+  vl_api_ip6_address_t addr;
+  bool end_psp;
+  vl_api_sr_behavior_t behavior;
   u32 fib_table;
-  u8 xconnect_next_hop[16];
+  u32 vlan_index;
+  vl_api_address_t xconnect_nh_addr;
   u32 xconnect_iface_or_vrf_table;
 };
 
+/** \brief Dump the list of SR policies
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+*/
+define sr_policies_dump
+{
+  u32 client_index;
+  u32 context;
+};
+
+define sr_policies_details
+{
+  u32 context;
+  vl_api_ip6_address_t bsid;
+  bool is_spray;
+  bool is_encap;
+  u32 fib_table;
+  u8 num_sid_lists;
+  vl_api_srv6_sid_list_t sid_lists[num_sid_lists];
+};
+
+/** \brief Dump the steering policies
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+*/
+define sr_steering_pol_dump
+{
+  u32 client_index;
+  u32 context;
+};
+
+define sr_steering_pol_details
+{
+  u32 context;
+  vl_api_sr_steer_t traffic_type;
+  u32 fib_table;
+  vl_api_prefix_t prefix;
+  vl_api_interface_index_t sw_if_index;
+  vl_api_ip6_address_t bsid;
+};
+
 /*
  * fd.io coding-style-patch-verification: OFF
  * Local Variables: