X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvnet%2Fip%2Fip.api;h=71ad1c189c10197c19d88f4a05a9b16a62895132;hb=28c142e3;hp=2ca2f56c58b965ee67f740b2ce7a0905db95276d;hpb=4c53313cd7e9b866412ad3e04b2d91ac098c1398;p=vpp.git

diff --git a/src/vnet/ip/ip.api b/src/vnet/ip/ip.api
index 2ca2f56c58b..71ad1c189c1 100644
--- a/src/vnet/ip/ip.api
+++ b/src/vnet/ip/ip.api
@@ -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:
@@ -19,8 +20,10 @@
     called through a shared memory interface. 
 */
 
-option version = "1.2.0";
+option version = "1.3.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];
 };
 
@@ -286,7 +291,6 @@ autoreply define ip6nd_proxy_add_del
 */
 define ip6nd_proxy_details
 {
-  u32 client_index;
   u32 context;
   u32 sw_if_index;
   u8 address[16];
@@ -388,7 +392,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,6 +425,13 @@ 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
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -429,7 +440,7 @@ autoreply define ip_add_del_route
     @param next_hop_afi - Use dpo_proto_t
     FIXME
 */
-autoreply define ip_mroute_add_del
+define ip_mroute_add_del
 {
   u32 client_index;
   u32 context;
@@ -446,6 +457,14 @@ autoreply define ip_mroute_add_del
   u8 is_local;
   u8 grp_address[16];
   u8 src_address[16];
+  u8 nh_address[16];
+};
+
+define ip_mroute_add_del_reply
+{
+  u32 context;
+  i32 retval;
+  u32 stats_index;
 };
 
 /** \brief Dump IP multicast fib table
@@ -475,6 +494,7 @@ manual_endian manual_print define ip_mfib_details
   u8  grp_address[4];
   u8  src_address[4];
   u32 count;
+  u32 stats_index;
   vl_api_fib_path_t path[count];
 };
 
@@ -508,7 +528,6 @@ manual_endian manual_print define ip6_mfib_details
 
 define ip_address_details
 {
-  u32 client_index;
   u32 context;
   u8 ip[16];
   u8 prefix_length;
@@ -524,10 +543,31 @@ define ip_address_dump
   u8 is_ipv6;
 };
 
-define ip_details
+/** \brief IP unnumbered configurations
+    @param sw_if_index The interface that has unnumbered configuration
+    @param ip_sw_if_index The IP interface that it is unnnumbered to
+*/
+define ip_unnumbered_details
 {
+  u32 context;
   u32 sw_if_index;
+  u32 ip_sw_if_index;
+};
+
+/** \brief Dump IP unnumbered configurations
+    @param sw_if_index ~0 for all interfaces, else the interface desired
+*/
+define ip_unnumbered_dump
+{
+  u32 client_index;
   u32 context;
+  u32 sw_if_index;
+};
+
+define ip_details
+{
+  u32 context;
+  u32 sw_if_index;
   u8 is_ipv6;
 };
 
@@ -546,7 +586,6 @@ define mfib_signal_dump
 
 define mfib_signal_details
 {
-  u32 client_index;
   u32 context;
   u32 sw_if_index;
   u32 table_id;
@@ -650,12 +689,55 @@ autoreply define ip_source_and_port_range_check_interface_add_del
   u32 udp_out_vrf_id;
 };
 
-/** \brief Register for ip4 arp resolution events
+/** \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
+    @param mode - 0: disable, 1: IPv4, 2: IPv6, 3: both IPv4/v6
+    @param scan_interval - neighbor scan interval in minutes, 0: default to 1
+    @param max_proc_time - max processing time per run in usec, 0: default to 20
+    @param max_update - max neighbor probe/delete per run, 0: default to 10
+    @param scan_int_delay - delay in msec to resume scan if exceed max proc
+                            time or update, 0: default to 1
+    @param stale_threshold - threshold in minutes for neighbor deletion, 
+                             0: default to 4*scan_interval
+*/
+autoreply define ip_scan_neighbor_enable_disable
+{
+  u32 client_index;
+  u32 context;
+  u8 mode;
+  u8 scan_interval;
+  u8 max_proc_time;
+  u8 max_update;
+  u8 scan_int_delay;
+  u8 stale_threshold;
+};
+
+/** \brief IP probe neighbor address on an interface by sending an
+           ARP request (for IP4) or ICMP6 Neighbor Solicitation (for IP6)
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param sw_if_index - interface index
+    @param dst_address - target IP address to send IP addr resolution request
+    @param is_ipv6 - [1|0] to indicate if address family is IPv[6|4]
+*/
+autoreply define ip_probe_neighbor
+{
+  u32 client_index;
+  u32 context;
+  u32 sw_if_index;
+  u8 dst_address[16];
+  u8 is_ipv6;
+};
+
+/** \brief Register for IP4 ARP resolution event on receing ARP reply or
+           MAC/IP info from ARP requests in L2 BDs
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
     @param enable_disable - 1 => register for events, 0 => cancel registration
     @param pid - sender's pid
-    @param address - the exact ip4 address of interest
+    @param address - exact IP4 address of interested arp resolution event, or
+                     0 to get MAC/IP info from ARP requests in BDs
 */
 autoreply define want_ip4_arp_events
 {
@@ -666,13 +748,14 @@ autoreply define want_ip4_arp_events
   u32 address;
 };
 
-/** \brief Tell client about an ip4 arp resolution event
+/** \brief Tell client about an IP4 ARP resolution event or
+           MAC/IP info from ARP requests in L2 BDs
     @param client_index - opaque cookie to identify the sender
     @param address - the exact ip4 address of interest
     @param pid - client pid registered to receive notification
     @param sw_if_index - interface which received ARP packet
     @param new_mac - the new mac address 
-    @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
+    @param mac_ip - 0: ARP resolution event, 1: MAC/IP info from L2 BDs
 */
 define ip4_arp_event
 {
@@ -689,12 +772,14 @@ service {
     events ip4_arp_event;
 };
 
-/** \brief Register for ip6 nd resolution events
+/** \brief Register for IP6 ND resolution event on recieving NA reply
+           MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
     @param enable_disable - 1 => register for events, 0 => cancel registration
     @param pid - sender's pid
-    @param address - the exact ip6 address of interest
+    @param address - the exact IP6 address of interested ND resolution event, or
+                     0 to get MAC/IP info from ICMP6 NS in L2 BDs.
 */
 autoreply define want_ip6_nd_events
 {
@@ -705,13 +790,14 @@ autoreply define want_ip6_nd_events
   u8 address[16];
 };
 
-/** \brief Tell client about an ip6 nd resolution or mac/ip event
+/** \brief Tell client about an IP6 ND resolution or
+           MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs.
     @param client_index - opaque cookie to identify the sender
     @param pid - client pid registered to receive notification
     @param sw_if_index - interface which received ARP packet
     @param address - the exact ip6 address of interest
     @param new_mac - the new mac address 
-    @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
+    @param mac_ip - 0: ND resolution event, 1: MAC/IP info from L2 BDs
 */
 define ip6_nd_event
 {
@@ -790,25 +876,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
@@ -823,6 +934,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
@@ -901,7 +1029,6 @@ define ip_reassembly_get
 
 define ip_reassembly_get_reply
 {
-  u32 client_index;
   u32 context;
   i32 retval;
   u32 timeout_ms;