VOM: mroutes
[vpp.git] / src / vnet / ip / ip.api
index 7f4f030..025fd57 100644 (file)
@@ -1,5 +1,6 @@
+/* Hey Emacs use -*- mode: C -*- */
 /*
- * Copyright (c) 2016 Cisco and/or its affiliates.
+ * Copyright (c) 2018 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:
     called through a shared memory interface. 
 */
 
-option version = "1.2.4";
+option version = "1.4.0";
+import "vnet/ip/ip_types.api";
 import "vnet/fib/fib_types.api";
+import "vnet/ethernet/ethernet_types.api";
 
 /** \brief Add / del table request
            A table can be added multiple times, but need be deleted only once.
@@ -68,6 +71,7 @@ manual_endian manual_print define ip_fib_details
   u8  address_length;
   u8  address[4];
   u32 count;
+  u32 stats_index;
   vl_api_fib_path_t path[count];
 };
 
@@ -95,6 +99,7 @@ manual_endian manual_print define ip6_fib_details
   u8  address_length;
   u8  address[16];
   u32 count;
+  u32 stats_index;
   vl_api_fib_path_t path[count];
 };
 
@@ -115,12 +120,15 @@ define ip_neighbor_dump
 /** \brief IP neighboors dump response
     @param context - sender context which was passed in the request
     @param sw_if_index - The interface used to reach the neighbor
+    @param stats_index - An index in the stats segment that can be used to read
+                         the counters for this neighbour.
     @param is_static - [1|0] to indicate if neighbor is statically configured
     @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
 */
 define ip_neighbor_details {
     u32 context;
     u32 sw_if_index;
+    u32 stats_index;
     u8  is_static;
     u8  is_ipv6;
     u8  mac_address[6];
@@ -141,7 +149,7 @@ define ip_neighbor_details {
     @param mac_address - l2 address of the neighbor
     @param dst_address - ip4 or ip6 address of the neighbor
 */
-autoreply define ip_neighbor_add_del
+define ip_neighbor_add_del
 {
   u32 client_index;
   u32 context;
@@ -155,6 +163,13 @@ autoreply define ip_neighbor_add_del
   u8 dst_address[16];
 };
 
+define ip_neighbor_add_del_reply
+{
+  u32 context;
+  i32 retval;
+  u32 stats_index;
+};
+
 /** \brief Set the ip flow hash config for a fib request
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -166,6 +181,7 @@ autoreply define ip_neighbor_add_del
     @param dport - if non-zero include dport in flow hash
     @param proto -if non-zero include proto in flow hash
     @param reverse - if non-zero include reverse in flow hash
+    @param symmetric - if non-zero include symmetry in flow hash
 */
 autoreply define set_ip_flow_hash
 {
@@ -179,6 +195,7 @@ autoreply define set_ip_flow_hash
   u8 dport;
   u8 proto;
   u8 reverse;
+  u8 symmetric;
 };
 
 /** \brief IPv6 router advertisement config request
@@ -286,7 +303,6 @@ autoreply define ip6nd_proxy_add_del
 */
 define ip6nd_proxy_details
 {
-  u32 client_index;
   u32 context;
   u32 sw_if_index;
   u8 address[16];
@@ -342,20 +358,6 @@ autoreply define sw_interface_ip6_enable_disable
   u8 enable;                   /* set to true if enable */
 };
 
-/** \brief IPv6 set link local address on interface request
-    @param client_index - opaque cookie to identify the sender
-    @param context - sender context, to match reply w/ request
-    @param sw_if_index - interface to set link local on
-    @param address[] - the new link local address
-*/
-autoreply define sw_interface_ip6_set_link_local_address
-{
-  u32 client_index;
-  u32 context;
-  u32 sw_if_index;
-  u8 address[16];
-};
-
 /** \brief Add / del route request
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -388,7 +390,7 @@ autoreply define sw_interface_ip6_set_link_local_address
     @param next_hop_out_label_stack - the next-hop output label stack, outer most first
     @param next_hop_via_label - The next-hop is a resolved via a local label
 */
-autoreply define ip_add_del_route
+define ip_add_del_route
 {
   u32 client_index;
   u32 context;
@@ -421,15 +423,42 @@ autoreply define ip_add_del_route
   vl_api_fib_mpls_label_t next_hop_out_label_stack[next_hop_n_out_labels];
 };
 
+define ip_add_del_route_reply
+{
+  u32 context;
+  i32 retval;
+  u32 stats_index;
+};
+
 /** \brief Add / del route request
+
+    Adds a route, consisting both of the MFIB entry to match packets
+    (which may already exist) and a path to send those packets down.
+    Routes can be entered repeatedly to add multiple paths.  Deletions are
+    per-path.
+
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
-    @param sw_if_index - software index of the new vlan's parent interface
-    @param vrf_id - fib table /vrf associated with the route
-    @param next_hop_afi - Use dpo_proto_t
-    FIXME
+    @param table_id - fib table /vrf associated with the route
+    @param is_add - true if adding a route; false if deleting one
+    @param is_ipv6 - true iff all the addresses are v6
+    @param entry_flags - see fib_entry_flag_t
+    @param itf_flags - see mfib_entry_flags_t
+    @param next_hop_afi - see dpo_proto_t; the type of destination description
+    @param src_address - the source of the packet
+    @param grp_address - the group the packet is destined to
+    @param nh_address - the nexthop to forward the packet to
+    @param next_hop_sw_if_index - interface to emit packet on
+
+    BIER AFIs use the BIER imposition ID.  v4 and v6 AFIs use either the
+    interface or the nexthop address.
+
+    Note that if the route is source-specific (S is supplied, not all 0s),
+    the prefix match is treated as exact (prefixlen /32 or /128).
+
+    FIXME not complete yet
 */
-autoreply define ip_mroute_add_del
+define ip_mroute_add_del
 {
   u32 client_index;
   u32 context;
@@ -449,6 +478,13 @@ autoreply define ip_mroute_add_del
   u8 nh_address[16];
 };
 
+define ip_mroute_add_del_reply
+{
+  u32 context;
+  i32 retval;
+  u32 stats_index;
+};
+
 /** \brief Dump IP multicast fib table
     @param client_index - opaque cookie to identify the sender
 */
@@ -466,6 +502,12 @@ define ip_mfib_dump
     @param count - the number of fib_path in path
     @param path  - array of of fib_path structures
 */
+typedef mfib_path
+{
+  vl_api_fib_path_t path;
+  u32 itf_flags;
+};
+
 manual_endian manual_print define ip_mfib_details
 {
   u32 context;
@@ -476,7 +518,8 @@ manual_endian manual_print define ip_mfib_details
   u8  grp_address[4];
   u8  src_address[4];
   u32 count;
-  vl_api_fib_path_t path[count];
+  u32 stats_index;
+  vl_api_mfib_path_t path[count];
 };
 
 /** \brief Dump IP6 multicast fib table
@@ -504,12 +547,11 @@ manual_endian manual_print define ip6_mfib_details
   u8  grp_address[16];
   u8  src_address[16];
   u32 count;
-  vl_api_fib_path_t path[count];
+  vl_api_mfib_path_t path[count];
 };
 
 define ip_address_details
 {
-  u32 client_index;
   u32 context;
   u8 ip[16];
   u8 prefix_length;
@@ -531,7 +573,6 @@ define ip_address_dump
 */
 define ip_unnumbered_details
 {
-  u32 client_index;
   u32 context;
   u32 sw_if_index;
   u32 ip_sw_if_index;
@@ -549,8 +590,8 @@ define ip_unnumbered_dump
 
 define ip_details
 {
-  u32 sw_if_index;
   u32 context;
+  u32 sw_if_index;
   u8 is_ipv6;
 };
 
@@ -569,7 +610,6 @@ define mfib_signal_dump
 
 define mfib_signal_details
 {
-  u32 client_index;
   u32 context;
   u32 sw_if_index;
   u32 table_id;
@@ -596,24 +636,47 @@ autoreply define ip_punt_police
   u8 is_ip6;
 };
 
+/** \brief Punt redirect type
+    @param rx_sw_if_index - specify the original RX interface of traffic
+                            that should be redirected. ~0 means any interface.
+    @param tx_sw_if_index - the TX interface to which traffic shoulde be
+                            redirected.
+    @param nh - the next-hop to redirect the traffic to.
+    @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
+*/
+typeonly define punt_redirect
+{
+  u32 rx_sw_if_index;
+  u32 tx_sw_if_index;
+  vl_api_address_t nh;
+};
+
 /** \brief IP punt redirect
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
+    @param punt - punt definition
     @param is_add - 1 to add neighbor, 0 to delete
-    @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
-    @param tx_sw_if_index - the TX interface to which traffic shoulde be
-                            redirected.
-    @param nh - The next-hop to redirect the traffic to.
 */
 autoreply define ip_punt_redirect
 {
   u32 client_index;
   u32 context;
-  u32 rx_sw_if_index;
-  u32 tx_sw_if_index;
+  vl_api_punt_redirect_t punt;
   u8 is_add;
-  u8 is_ip6;
-  u8 nh[16];
+};
+
+define ip_punt_redirect_dump
+{
+  u32 client_index;
+  u32 context;
+  u32 sw_if_index;
+  u8 is_ipv6;
+};
+
+define ip_punt_redirect_details
+{
+  u32 context;
+  vl_api_punt_redirect_t punt;
 };
 
 autoreply define ip_container_proxy_add_del
@@ -627,6 +690,19 @@ autoreply define ip_container_proxy_add_del
   u8 is_add;
 };
 
+define ip_container_proxy_dump
+{
+  u32 client_index;
+  u32 context;
+};
+
+define ip_container_proxy_details
+{
+  u32 context;
+  u32 sw_if_index;
+  vl_api_prefix_t prefix;
+};
+
 /** \brief Configure IP source and L4 port-range check
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -673,6 +749,22 @@ autoreply define ip_source_and_port_range_check_interface_add_del
   u32 udp_out_vrf_id;
 };
 
+/** \brief Set interface source check request
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param is_add - add or del
+    @param loose - strict or loose
+    @param sw_if_index - interface index
+*/
+autoreply define ip_source_check_interface_add_del
+{
+  u32 client_index;
+  u32 context;
+  u8 is_add;
+  u8 loose;
+  u32 sw_if_index;
+};
+
 /** \brief Enable/disable periodic IP neighbor scan
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -860,25 +952,50 @@ service {
     events ip6_nd_event;
 };
 
+/** \brief Proxy ARP configuration type
+    @param vrf_id - VRF / Fib table ID
+    @param low_address[4] - Low address of the Proxy ARP range
+    @param hi_address[4] - High address of the Proxy ARP range
+*/
+typeonly define proxy_arp
+{
+  u32 vrf_id;
+  u8 low_address[4];
+  u8 hi_address[4];
+};
+
 /** \brief Proxy ARP add / del request
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
-    @param vrf_id - VRF / Fib table ID
     @param is_add - 1 if adding the Proxy ARP range, 0 if deleting
-    @param low_address[4] - Low address of the Proxy ARP range
-    @param hi_address[4] - High address of the Proxy ARP range
+    @param proxy - Proxy configuration
 */
 autoreply define proxy_arp_add_del
 {
   u32 client_index;
   u32 context;
-  u32 vrf_id;
   u8 is_add;
-  u8 low_address[4];
-  u8 hi_address[4];
+  vl_api_proxy_arp_t proxy;
 };
 
-/** \brief Proxy ARP add / del request
+/** \brief Proxy ARP dump request
+ */
+define proxy_arp_dump
+{
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief Proxy ARP dump details reply
+ * @param proxy - Same data as used to configure
+ */
+define proxy_arp_details
+{
+  u32 context;
+  vl_api_proxy_arp_t proxy;
+};
+
+/** \brief Proxy ARP add / del interface request
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
     @param sw_if_index - Which interface to enable / disable Proxy Arp on
@@ -893,6 +1010,23 @@ autoreply define proxy_arp_intfc_enable_disable
   u8 enable_disable;
 };
 
+/** \brief Proxy ARP interface dump request
+ */
+define proxy_arp_intfc_dump
+{
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief Proxy ARP interface dump details reply
+ * @param sw_if_index The interface on which ARP proxy is enabled.
+ */
+define proxy_arp_intfc_details
+{
+  u32 context;
+  u32 sw_if_index;
+};
+
 /** \brief Reset fib table request
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -971,7 +1105,6 @@ define ip_reassembly_get
 
 define ip_reassembly_get_reply
 {
-  u32 client_index;
   u32 context;
   i32 retval;
   u32 timeout_ms;