X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvnet%2Fip%2Fip.api;h=df3ae9646c441dd4bbf15ece2642528e3d366660;hb=595992c5c3b5abbdb7e90e61acbee212f25ad59f;hp=c811e465ea9ebd4f17a6c2bda5e2c6442263eb98;hpb=7cd468a3d7dee7d6c92f69a0bb7061ae208ec727;p=vpp.git diff --git a/src/vnet/ip/ip.api b/src/vnet/ip/ip.api index c811e465ea9..df3ae9646c4 100644 --- a/src/vnet/ip/ip.api +++ b/src/vnet/ip/ip.api @@ -19,6 +19,30 @@ called through a shared memory interface. */ +vl_api_version 1.0.0 + +/** \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 +55,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 +68,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 +89,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 +105,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 +116,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; @@ -116,7 +144,7 @@ define ip_neighbor_dump */ define ip_neighbor_details { u32 context; - u32 is_static; + u8 is_static; u8 is_ipv6; u8 mac_address[6]; u8 ip_address[16]; @@ -125,38 +153,31 @@ define ip_neighbor_details { /** \brief IP neighbor 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_id, only for IP4 @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; - u32 vrf_id; /* only makes sense for ip4 */ u32 sw_if_index; /* 1 = add, 0 = delete */ 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 @@ -169,7 +190,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; @@ -183,16 +204,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 @@ -210,7 +221,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; @@ -230,32 +241,36 @@ 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 - @param sw_if_index - - @param address[] - - @param address_length - - @param use_default - - @param no_advertise - - @param off_link - - @param no_autoconfig - - @param no_onlink - - @param is_no - - @param val_lifetime - - @param pref_lifetime - + @param sw_if_index - The interface the RA prefix information is for + @param address[] - The prefix to advertise + @param address_length - the prefix length + @param use_default - Revert to default settings + @param no_advertise - Do not advertise this prefix + @param off_link - The prefix is off link (it is not configured on the interface) + Configures the L-flag, When set, indicates that this + prefix can be used for on-link determination. + @param no_autoconfig - Setting for the A-flag. When + set indicates that this prefix can be used for + stateless address configuration. + @param no_onlink - The prefix is not on link. Make sure this is consistent + with the off_link parameter else YMMV + @param is_no - add/delete + @param val_lifetime - The length of time in + seconds (relative to the time the packet is sent) + that the prefix is valid for the purpose of on-link + determination. A value of all one bits + (0xffffffff) represents infinity + @param pref_lifetime - The length of time in + seconds (relative to the time the packet is sent) + that addresses generated from the prefix via + stateless address autoconfiguration remain + 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; @@ -272,64 +287,72 @@ define sw_interface_ip6nd_ra_prefix u32 pref_lifetime; }; -/** \brief IPv6 router advertisement prefix config response +/** \brief IPv6 ND proxy config + @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request - @param retval - return code for the request + @param sw_if_index - The interface the host is on + @param address - The address of the host for which to proxy for + @param is_add - Adding or deleting */ -define sw_interface_ip6nd_ra_prefix_reply +autoreply define ip6nd_proxy_add_del { + u32 client_index; u32 context; - i32 retval; + u32 sw_if_index; + u8 is_del; + u8 address[16]; }; -/** \brief IPv6 interface enable / disable request - @param client_index - opaque cookie to identify the sender +/** \brief IPv6 ND proxy details returned after request @param context - sender context, to match reply w/ request - @param sw_if_index - interface used to reach neighbor - @param enable - if non-zero enable ip6 on interface, else disable + @param retval - return code for the request */ -define sw_interface_ip6_enable_disable +define ip6nd_proxy_details { u32 client_index; u32 context; u32 sw_if_index; - u8 enable; /* set to true if enable */ + u8 address[16]; }; -/** \brief IPv6 interface enable / disable response +/** \brief IPv6 ND proxy dump request @param context - sender context, to match reply w/ request @param retval - return code for the request + @param sw_if_index - The interface the host is on + @param address - The address of the host for which to proxy for */ -define sw_interface_ip6_enable_disable_reply +define ip6nd_proxy_dump { + u32 client_index; u32 context; - i32 retval; }; -/** \brief IPv6 set link local address on interface request +/** \brief IPv6 interface enable / disable 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 - @param address_length - link local address length + @param sw_if_index - interface used to reach neighbor + @param enable - if non-zero enable ip6 on interface, else disable */ -define sw_interface_ip6_set_link_local_address +autoreply define sw_interface_ip6_enable_disable { u32 client_index; u32 context; u32 sw_if_index; - u8 address[16]; - u8 address_length; + u8 enable; /* set to true if enable */ }; -/** \brief IPv6 set link local address on interface response +/** \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 retval - error code for the 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_reply +autoreply define sw_interface_ip6_set_link_local_address { + u32 client_index; u32 context; - i32 retval; + u32 sw_if_index; + u8 address[16]; }; /** \brief Add / del route request @@ -348,7 +371,9 @@ define sw_interface_ip6_set_link_local_address_reply @param is_local - @param is_classify - @param is_multipath - Set to 1 if this is a multipath route, else 0 - @param not_last - Is last or not last msg in group of multiple add/del msgs + @param is_source_lookup - The the path is a deaggregate path (i.e. a lookup + in another table) is the lookup on the packet's + source address or destination. @param next_hop_weight - @param dst_address_length - @param dst_address[16] - @@ -357,7 +382,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; @@ -376,9 +401,10 @@ define ip_add_del_route u8 is_multipath; u8 is_resolve_host; u8 is_resolve_attached; - /* Is last/not-last message in group of multiple add/del messages. */ - u8 not_last; + u8 is_l2_bridged; + u8 is_source_lookup; u8 next_hop_weight; + u8 next_hop_preference; u8 dst_address_length; u8 dst_address[16]; u8 next_hop_address[16]; @@ -387,14 +413,88 @@ 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 +/** \brief Add / del route request + @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 + + FIXME +*/ +autoreply define ip_mroute_add_del +{ + u32 client_index; + u32 context; + u32 next_hop_sw_if_index; + u32 table_id; + u32 entry_flags; + u32 itf_flags; + u32 rpf_id; + u16 grp_address_length; + u8 create_vrf_if_needed; + u8 is_add; + u8 is_ipv6; + u8 is_local; + u8 grp_address[16]; + u8 src_address[16]; +}; + +/** \brief Dump IP multicast fib table + @param client_index - opaque cookie to identify the sender +*/ +define ip_mfib_dump +{ + u32 client_index; + u32 context; +}; + +/** \brief IP Multicast FIB table response + @param table_id - IP fib table id + @address_length - mask length + @grp_address - Group address/prefix + @src_address - Source address + @param count - the number of fib_path in path + @param path - array of of fib_path structures +*/ +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]; + u32 count; + vl_api_fib_path_t path[count]; +}; + +/** \brief Dump IP6 multicast fib table + @param client_index - opaque cookie to identify the sender +*/ +define ip6_mfib_dump +{ + u32 client_index; + u32 context; +}; + +/** \brief IP6 Multicast FIB table response + @param table_id - IP fib table id + @address_length - mask length + @grp_address - Group address/prefix + @src_address - Source address + @param count - the number of fib_path in path + @param path - array of of fib_path structures */ -define ip_add_del_route_reply +manual_endian manual_print define ip6_mfib_details { u32 context; - i32 retval; + u32 table_id; + u8 address_length; + u8 grp_address[16]; + u8 src_address[16]; + u32 count; + vl_api_fib_path_t path[count]; }; define ip_address_details @@ -403,6 +503,8 @@ define ip_address_details u32 context; u8 ip[16]; u8 prefix_length; + u32 sw_if_index; + u8 is_ipv6; }; define ip_address_dump @@ -417,6 +519,7 @@ define ip_details { u32 sw_if_index; u32 context; + u8 is_ipv6; }; define ip_dump @@ -426,6 +529,71 @@ define ip_dump u8 is_ipv6; }; +define mfib_signal_dump +{ + u32 client_index; + u32 context; +}; + +define mfib_signal_details +{ + u32 client_index; + u32 context; + u32 sw_if_index; + u32 table_id; + u16 grp_address_len; + u8 grp_address[16]; + u8 src_address[16]; + u16 ip_packet_len; + u8 ip_packet_data[256]; +}; + +/** \brief IP punt policer + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param is_add - 1 to add neighbor, 0 to delete + @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4 + @param policer_index - Index of policer to use +*/ +autoreply define ip_punt_police +{ + u32 client_index; + u32 context; + u32 policer_index; + u8 is_add; + u8 is_ip6; +}; + +/** \brief IP punt redirect + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @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; + u8 is_add; + u8 is_ip6; + u8 nh[16]; +}; + +autoreply define ip_container_proxy_add_del +{ + u32 client_index; + u32 context; + u8 ip[16]; + u8 is_ip4; + u8 plen; + u32 sw_if_index; + u8 is_add; +}; /* * Local Variables: