called through a shared memory interface.
*/
+option version = "1.0.1";
+
+/** \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
*/
/** \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
typeonly manual_print manual_endian define fib_path
{
u32 sw_if_index;
- u32 weight;
+ u32 table_id;
+ u8 weight;
+ u8 preference;
u8 is_local;
u8 is_drop;
u8 is_unreach;
{
u32 context;
u32 table_id;
+ u8 table_name[64];
u8 address_length;
u8 address[4];
u32 count;
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
*/
{
u32 context;
u32 table_id;
+ u8 table_name[64];
u8 address_length;
u8 address[16];
u32 count;
/** \brief Dump IP neighboors
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
- @param sw_if_index - the interface to dump neighboors
+ @param sw_if_index - the interface to dump neighboors, ~0 == all
@param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
*/
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 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;
u8 is_static;
u8 is_ipv6;
u8 mac_address[6];
@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;
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
@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;
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
@param initial_count -
@param initial_interval -
*/
-define sw_interface_ip6nd_ra_config
+autoreply define sw_interface_ip6nd_ra_config
{
u32 client_index;
u32 context;
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;
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 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 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
@param vrf_id - fib table /vrf associated with the route
@param lookup_in_vrf -
@param classify_table_index -
- @param create_vrf_if_needed -
@param is_add - 1 if adding the route, 0 if deleting
@param is_drop - Drop the packet
@param is_unreach - Drop the packet and rate limit send ICMP unreachable
@param is_prohibit - Drop the packet and rate limit send ICMP prohibited
@param is_ipv6 - 0 if an ip4 route, else ip6
- @param is_local -
+ @param is_local - The route will result in packets sent to VPP IP stack
+ @param is_udp_encap - The path describes a UDP-o-IP encapsulation.
@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 next_hop_weight -
+ @param is_dvr - Does the route resolve via a DVR interface.
+ @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 - Weight for Unequal cost multi-path
+ @param next_hop_preference - Path that are up that have the best preference are
+ are used for forwarding. lower value is better.
+ @param next_hop_id - Used when the path resolves via an object that has a unique
+ identifier.
@param dst_address_length -
@param dst_address[16] -
@param next_hop_address[16] -
@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;
u32 table_id;
u32 classify_table_index;
u32 next_hop_table_id;
- u8 create_vrf_if_needed;
+ u32 next_hop_id;
u8 is_add;
u8 is_drop;
u8 is_unreach;
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_dvr;
+ u8 is_source_lookup;
+ u8 is_udp_encap;
u8 next_hop_weight;
+ u8 next_hop_preference;
+ u8 next_hop_proto;
u8 dst_address_length;
u8 dst_address[16];
u8 next_hop_address[16];
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
@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
*/
-define ip_mroute_add_del
+autoreply define ip_mroute_add_del
{
u32 client_index;
u32 context;
u32 table_id;
u32 entry_flags;
u32 itf_flags;
+ u32 rpf_id;
+ u32 bier_imp;
u16 grp_address_length;
- u8 create_vrf_if_needed;
+ u8 next_hop_afi;
u8 is_add;
u8 is_ipv6;
u8 is_local;
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
*/
{
u32 context;
u32 table_id;
+ u32 entry_flags;
+ u32 rpf_id;
u8 address_length;
u8 grp_address[4];
u8 src_address[4];
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;
+};
+
+/** \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
+ @param is_ip6 - 1 if source address type is IPv6
+ @param is_add - 1 if add, 0 if delete
+ @param mask_length - mask length for address entry
+ @param address - array of address bytes
+ @param number_of_ranges - length of low_port and high_port arrays (must match)
+ @param low_ports[32] - up to 32 low end of port range entries (must have corresponding high_ports entry)
+ @param high_ports[32] - up to 32 high end of port range entries (must have corresponding low_ports entry)
+ @param vrf_id - fib table/vrf id to associate the source and port-range check with
+ @note To specify a single port set low_port and high_port entry the same
+*/
+autoreply define ip_source_and_port_range_check_add_del
+{
+ u32 client_index;
+ u32 context;
+ u8 is_ipv6;
+ u8 is_add;
+ u8 mask_length;
+ u8 address[16];
+ u8 number_of_ranges;
+ u16 low_ports[32];
+ u16 high_ports[32];
+ u32 vrf_id;
+};
+
+/** \brief Set interface source and L4 port-range request
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param interface_id - interface index
+ @param tcp_vrf_id - VRF associated with source and TCP port-range check
+ @param udp_vrf_id - VRF associated with source and TCP port-range check
+*/
+autoreply define ip_source_and_port_range_check_interface_add_del
+{
+ u32 client_index;
+ u32 context;
+ u8 is_add;
+ u32 sw_if_index;
+ u32 tcp_in_vrf_id;
+ u32 tcp_out_vrf_id;
+ u32 udp_in_vrf_id;
+ u32 udp_out_vrf_id;
+};
+
+/** \brief Register for ip4 arp resolution events
+ @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
+*/
+autoreply define want_ip4_arp_events
+{
+ u32 client_index;
+ u32 context;
+ u8 enable_disable;
+ u32 pid;
+ u32 address;
+};
+
+/** \brief Tell client about an ip4 arp resolution event
+ @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
+*/
+define ip4_arp_event
+{
+ u32 client_index;
+ u32 address;
+ u32 pid;
+ u32 sw_if_index;
+ u8 new_mac[6];
+ u8 mac_ip;
+};
+
+/** \brief Register for ip6 nd resolution events
+ @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
+*/
+autoreply define want_ip6_nd_events
+{
+ u32 client_index;
+ u32 context;
+ u8 enable_disable;
+ u32 pid;
+ u8 address[16];
+};
+
+/** \brief Tell client about an ip6 nd resolution or mac/ip event
+ @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
+*/
+define ip6_nd_event
+{
+ u32 client_index;
+ u32 pid;
+ u32 sw_if_index;
+ u8 address[16];
+ u8 new_mac[6];
+ u8 mac_ip;
+};
+
+/** \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
+*/
+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];
+};
+
+/** \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 sw_if_index - Which interface to enable / disable Proxy Arp on
+ @param enable_disable - 1 to enable Proxy ARP on interface, 0 to disable
+*/
+autoreply define proxy_arp_intfc_enable_disable
+{
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+ /* 1 = on, 0 = off */
+ u8 enable_disable;
+};
+
+/** \brief Reset fib table request
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param vrf_id - vrf/table id of the fib table to reset
+ @param is_ipv6 - an ipv6 fib to reset if non-zero, else ipv4
+*/
+autoreply define reset_fib
+{
+ u32 client_index;
+ u32 context;
+ u32 vrf_id;
+ u8 is_ipv6;
+};
+
+/** \brief Set max allowed ARP or ip6 neighbor entries request
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param is_ipv6 - neighbor limit if non-zero, else ARP limit
+ @param arp_neighbor_limit - the new limit, defaults are ~ 50k
+*/
+autoreply define set_arp_neighbor_limit
+{
+ u32 client_index;
+ u32 context;
+ u8 is_ipv6;
+ u32 arp_neighbor_limit;
+};
+
+/** \brief IOAM enable : Enable in-band OAM
+ @param id - profile id
+ @param seqno - To enable Seqno Processing
+ @param analyse - Enabling analysis of iOAM at decap node
+ @param pow_enable - Proof of Work enabled or not flag
+ @param trace_enable - iOAM Trace enabled or not flag
+*/
+autoreply define ioam_enable
+{
+ u32 client_index;
+ u32 context;
+ u16 id;
+ u8 seqno;
+ u8 analyse;
+ u8 pot_enable;
+ u8 trace_enable;
+ u32 node_id;
+};
+
+/** \brief iOAM disable
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param index - MAP Domain index
+*/
+autoreply define ioam_disable
+{
+ u32 client_index;
+ u32 context;
+ u16 id;
+};
+
+autoreply define ip_reassembly_set
+{
+ u32 client_index;
+ u32 context;
+ u32 timeout_ms;
+ u32 max_reassemblies;
+ u32 expire_walk_interval_ms;
+ u8 is_ip6;
+};
+
+define ip_reassembly_get
+{
+ u32 client_index;
+ u32 context;
+ u8 is_ip6;
+};
+
+define ip_reassembly_get_reply
+{
+ u32 client_index;
+ u32 context;
+ i32 retval;
+ u32 timeout_ms;
+ u32 max_reassemblies;
+ u32 expire_walk_interval_ms;
+ u8 is_ip6;
+};
+
/*
* Local Variables:
* eval: (c-set-style "gnu")