Add a name to the creation of an IP and MPLS table
[vpp.git] / src / vnet / ip / ip.api
index b5e730f..f26d794 100644 (file)
     called through a shared memory interface. 
 */
 
+/** \brief Add / del table request
+           A table can be added multiple times, but need be deleted only once.
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param is_ipv6 - V4 or V6 table
+    @param table_id - table ID associated with the route
+                      This table ID will apply to both the unicats
+                     and mlticast FIBs
+    @param name - A client provided name/tag for the table. If this is
+                  not set by the client, then VPP will generate something
+                 meaningfull.
+*/
+autoreply define ip_table_add_del
+{
+  u32 client_index;
+  u32 context;
+  u32 table_id;
+  u8 is_ipv6;
+  u8 is_add;
+  u8 name[64];
+};
+
 /** \brief Dump IP fib table
     @param client_index - opaque cookie to identify the sender
 */
@@ -31,6 +53,7 @@ define ip_fib_dump
 /** \brief FIB path
     @param sw_if_index - index of the interface
     @param weight - The weight, for UCMP
+    @param preference - The preference of the path. lowest preference is prefered
     @param is_local - local if non-zero, else remote
     @param is_drop - Drop the packet
     @param is_unreach - Drop the packet and rate limit send ICMP unreachable
@@ -43,7 +66,8 @@ define ip_fib_dump
 typeonly manual_print manual_endian define fib_path
 {
   u32 sw_if_index;
-  u32 weight;
+  u8 weight;
+  u8 preference;
   u8 is_local;
   u8 is_drop;
   u8 is_unreach;
@@ -63,6 +87,7 @@ manual_endian manual_print define ip_fib_details
 {
   u32 context;
   u32 table_id;
+  u8  table_name[64];
   u8  address_length;
   u8  address[4];
   u32 count;
@@ -78,10 +103,10 @@ define ip6_fib_dump
   u32 context;
 };
 
-/** \brief IP6 FIB table response
+/** \brief IP6 FIB table entry response
     @param table_id - IP6 fib table id
-    @address_length - mask length
-    @address - ip6 prefix
+    @param address_length - mask length
+    @param address - ip6 prefix
     @param count - the number of fib_path in path
     @param path  - array of of fib_path structures
 */
@@ -89,6 +114,7 @@ manual_endian manual_print define ip6_fib_details
 {
   u32 context;
   u32 table_id;
+  u8  table_name[64];
   u8  address_length;
   u8  address[16];
   u32 count;
@@ -128,11 +154,15 @@ define ip_neighbor_details {
     @param sw_if_index - interface used to reach neighbor
     @param is_add - 1 to add neighbor, 0 to delete
     @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
-    @param is_static - 
+    @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
+    @param is_static - A static neighbor Entry - there are not flushed
+                       If the interface goes down.
+    @param is_no_adj_fib - Do not create a corresponding entry in the FIB
+                           table for the neighbor.
     @param mac_address - l2 address of the neighbor
     @param dst_address - ip4 or ip6 address of the neighbor
 */
-define ip_neighbor_add_del
+autoreply define ip_neighbor_add_del
 {
   u32 client_index;
   u32 context;
@@ -141,20 +171,11 @@ define ip_neighbor_add_del
   u8 is_add;
   u8 is_ipv6;
   u8 is_static;
+  u8 is_no_adj_fib;
   u8 mac_address[6];
   u8 dst_address[16];
 };
 
-/** \brief Reply for IP Neighbor add / delete request
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-define ip_neighbor_add_del_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \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
@@ -167,7 +188,7 @@ define ip_neighbor_add_del_reply
     @param proto -if non-zero include proto in flow hash
     @param reverse - if non-zero include reverse in flow hash
 */
-define set_ip_flow_hash
+autoreply define set_ip_flow_hash
 {
   u32 client_index;
   u32 context;
@@ -181,16 +202,6 @@ define set_ip_flow_hash
   u8 reverse;
 };
 
-/** \brief Set the ip flow hash config for a fib response
-    @param context - sender context, to match reply w/ request
-    @param retval - return code for the request
-*/
-define set_ip_flow_hash_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief IPv6 router advertisement config request
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -208,7 +219,7 @@ define set_ip_flow_hash_reply
     @param initial_count -
     @param initial_interval -
 */
-define sw_interface_ip6nd_ra_config
+autoreply define sw_interface_ip6nd_ra_config
 {
   u32 client_index;
   u32 context;
@@ -228,16 +239,6 @@ define sw_interface_ip6nd_ra_config
   u32 initial_interval;
 };
 
-/** \brief IPv6 router advertisement config response
-    @param context - sender context, to match reply w/ request
-    @param retval - return code for the request
-*/
-define sw_interface_ip6nd_ra_config_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief IPv6 router advertisement prefix config request
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -267,7 +268,7 @@ define sw_interface_ip6nd_ra_config_reply
                      preferred [ADDRCONF].  A value of all one bits
                      (0xffffffff) represents infinity.
 */
-define sw_interface_ip6nd_ra_prefix
+autoreply define sw_interface_ip6nd_ra_prefix
 {
   u32 client_index;
   u32 context;
@@ -284,16 +285,6 @@ define sw_interface_ip6nd_ra_prefix
   u32 pref_lifetime;
 };
 
-/** \brief IPv6 router advertisement prefix config response
-    @param context - sender context, to match reply w/ request
-    @param retval - return code for the request
-*/
-define sw_interface_ip6nd_ra_prefix_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief IPv6 ND proxy config
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -301,7 +292,7 @@ define sw_interface_ip6nd_ra_prefix_reply
     @param address - The address of the host for which to proxy for
     @param is_add - Adding or deleting
 */
-define ip6nd_proxy_add_del
+autoreply define ip6nd_proxy_add_del
 {
   u32 client_index;
   u32 context;
@@ -310,16 +301,6 @@ define ip6nd_proxy_add_del
   u8 address[16];
 };
 
-/** \brief IPv6 ND proxy response
-    @param context - sender context, to match reply w/ request
-    @param retval - return code for the request
-*/
-define ip6nd_proxy_add_del_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief IPv6 ND proxy details returned after request
     @param context - sender context, to match reply w/ request
     @param retval - return code for the request
@@ -350,7 +331,7 @@ define ip6nd_proxy_dump
     @param sw_if_index - interface used to reach neighbor
     @param enable - if non-zero enable ip6 on interface, else disable
 */
-define sw_interface_ip6_enable_disable
+autoreply define sw_interface_ip6_enable_disable
 {
   u32 client_index;
   u32 context;
@@ -358,23 +339,13 @@ define sw_interface_ip6_enable_disable
   u8 enable;                   /* set to true if enable */
 };
 
-/** \brief IPv6 interface enable / disable response
-    @param context - sender context, to match reply w/ request
-    @param retval - return code for the request
-*/
-define sw_interface_ip6_enable_disable_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \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
 */
-define sw_interface_ip6_set_link_local_address
+autoreply define sw_interface_ip6_set_link_local_address
 {
   u32 client_index;
   u32 context;
@@ -382,16 +353,6 @@ define sw_interface_ip6_set_link_local_address
   u8 address[16];
 };
 
-/** \brief IPv6 set link local address on interface response
-    @param context - sender context, to match reply w/ request
-    @param retval - error code for the request
-*/
-define sw_interface_ip6_set_link_local_address_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief Add / del route request
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -417,7 +378,7 @@ define sw_interface_ip6_set_link_local_address_reply
     @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
 */
-define ip_add_del_route
+autoreply define ip_add_del_route
 {
   u32 client_index;
   u32 context;
@@ -439,6 +400,7 @@ define ip_add_del_route
   /* Is last/not-last message in group of multiple add/del messages. */
   u8 not_last;
   u8 next_hop_weight;
+  u8 next_hop_preference;
   u8 dst_address_length;
   u8 dst_address[16];
   u8 next_hop_address[16];
@@ -447,16 +409,6 @@ define ip_add_del_route
   u32 next_hop_out_label_stack[next_hop_n_out_labels];
 };
 
-/** \brief Reply for add / del route request
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-define ip_add_del_route_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief Add / del route request
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -465,7 +417,7 @@ define ip_add_del_route_reply
 
     FIXME
 */
-define ip_mroute_add_del
+autoreply define ip_mroute_add_del
 {
   u32 client_index;
   u32 context;
@@ -473,6 +425,7 @@ define ip_mroute_add_del
   u32 table_id;
   u32 entry_flags;
   u32 itf_flags;
+  u32 rpf_id;
   u16 grp_address_length;
   u8 create_vrf_if_needed;
   u8 is_add;
@@ -482,16 +435,6 @@ define ip_mroute_add_del
   u8 src_address[16];
 };
 
-/** \brief Reply for add / del mroute request
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-define ip_mroute_add_del_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief Dump IP multicast fib table
     @param client_index - opaque cookie to identify the sender
 */
@@ -513,6 +456,8 @@ manual_endian manual_print define ip_mfib_details
 {
   u32 context;
   u32 table_id;
+  u32 entry_flags;
+  u32 rpf_id;
   u8  address_length;
   u8  grp_address[4];
   u8  src_address[4];