+/* 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.
*/
-vl_api_version 1.0.1
+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.
u32 context;
};
-/** \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
- @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
- @param afi - the afi of the next hop, IP46_TYPE_IP4=1, IP46_TYPE_IP6=2
- @param next_hop[16] - the next hop address
-
- WARNING: this type is replicated, pending cleanup completion
-*/
-typeonly manual_print manual_endian define fib_path
-{
- u32 sw_if_index;
- u32 table_id;
- u8 weight;
- u8 preference;
- u8 is_local;
- u8 is_drop;
- u8 is_unreach;
- u8 is_prohibit;
- u8 afi;
- u8 next_hop[16];
-};
-
/** \brief IP FIB table response
@param table_id - IP fib table id
@address_length - mask length
u8 address_length;
u8 address[4];
u32 count;
+ u32 stats_index;
vl_api_fib_path_t path[count];
};
u8 address_length;
u8 address[16];
u32 count;
+ u32 stats_index;
vl_api_fib_path_t path[count];
};
/** \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];
@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;
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
@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
{
u8 dport;
u8 proto;
u8 reverse;
+ u8 symmetric;
};
/** \brief IPv6 router advertisement config request
*/
define ip6nd_proxy_details
{
- u32 client_index;
u32 context;
u32 sw_if_index;
u8 address[16];
u32 context;
};
-/** \brief IPv6 interface enable / disable request
+/** \brief Start / stop sending router solicitation
@param client_index - opaque cookie to identify the sender
@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 irt - initial retransmission time
+ @param mrt - maximum retransmission time
+ @param mrc - maximum retransmission count
+ @param mrd - maximum retransmission duration
+ @param sw_if_index - software interface index of interface
+ for sending router solicitation
+ @param stop - if non-zero then stop sending router solicitation,
+ otherwise start sending router solicitation
*/
-autoreply define sw_interface_ip6_enable_disable
+autoreply define ip6nd_send_router_solicitation
{
u32 client_index;
u32 context;
+ u32 irt;
+ u32 mrt;
+ u32 mrc;
+ u32 mrd;
u32 sw_if_index;
- u8 enable; /* set to true if enable */
+ u8 stop;
};
-/** \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
*/
-autoreply 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 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_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 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_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;
u32 classify_table_index;
u32 next_hop_table_id;
u32 next_hop_id;
- u8 create_vrf_if_needed;
u8 is_add;
u8 is_drop;
u8 is_unreach;
u8 is_multipath;
u8 is_resolve_host;
u8 is_resolve_attached;
- u8 is_l2_bridged;
+ u8 is_dvr;
u8 is_source_lookup;
u8 is_udp_encap;
u8 next_hop_weight;
u8 next_hop_address[16];
u8 next_hop_n_out_labels;
u32 next_hop_via_label;
- u32 next_hop_out_label_stack[next_hop_n_out_labels];
+ 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;
u32 bier_imp;
u16 grp_address_length;
u8 next_hop_afi;
- u8 create_vrf_if_needed;
u8 is_add;
u8 is_ipv6;
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
@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;
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
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;
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;
};
define mfib_signal_details
{
- u32 client_index;
u32 context;
u32 sw_if_index;
u32 table_id;
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
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
u32 udp_out_vrf_id;
};
-/** \brief Register for ip4 arp resolution events
+/** \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
+ @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
{
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
{
u8 mac_ip;
};
-/** \brief Register for ip6 nd resolution events
+service {
+ rpc want_ip4_arp_events returns want_ip4_arp_events_reply
+ events ip4_arp_event;
+};
+
+/** \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
{
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
{
u8 mac_ip;
};
-/** \brief Proxy ARP add / del request
+service {
+ rpc want_ip6_ra_events returns want_ip6_ra_events_reply
+ events ip6_ra_event;
+};
+
+/** \brief Register for ip6 router advertisement 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
+*/
+autoreply define want_ip6_ra_events
+{
+ u32 client_index;
+ u32 context;
+ u8 enable_disable;
+ u32 pid;
+};
+
+/** \brief Struct representing RA prefix info
+ @param dst_address - RA prefix info destination address
+ @param dst_address_length - RA prefix info destination address length
+ @param flags - RA prefix info flags
+ @param valid_time - RA prefix info valid time
+ @param preferred_time - RA prefix info preferred time
+*/
+typeonly define ip6_ra_prefix_info
+{
+ u8 dst_address[16];
+ u8 dst_address_length;
+ u8 flags;
+ u32 valid_time;
+ u32 preferred_time;
+};
+
+/** \brief Tell client about a router advertisement event
+ @param client_index - opaque cookie to identify the sender
+ @param pid - client pid registered to receive notification
+ @param current_hop_limit - RA current hop limit
+ @param flags - RA flags
+ @param router_lifetime_in_sec - RA lifetime in seconds
+ @param neighbor_reachable_time_in_msec - RA neighbor reachable time in msec
+ @param time_in_msec_between_retransmitted_neighbor_solicitations -
+ time in msec between retransmitted neighbor solicitations
+ @param n_prefixes -
+ @param prefixes -
+*/
+define ip6_ra_event
+{
+ u32 client_index;
+ u32 pid;
+ u32 sw_if_index;
+ u8 router_address[16];
+ u8 current_hop_limit;
+ u8 flags;
+ u16 router_lifetime_in_sec;
+ u32 neighbor_reachable_time_in_msec;
+ u32 time_in_msec_between_retransmitted_neighbor_solicitations;
+ u32 n_prefixes;
+ vl_api_ip6_ra_prefix_info_t prefixes[n_prefixes];
+};
+
+service {
+ rpc want_ip6_nd_events returns want_ip6_nd_events_reply
+ events ip6_nd_event;
+};
+
+/** \brief Proxy ARP configuration type
@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
+typeonly define proxy_arp
{
- 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 is_add - 1 if adding the Proxy ARP range, 0 if deleting
+ @param proxy - Proxy configuration
+*/
+autoreply define proxy_arp_add_del
+{
+ u32 client_index;
+ u32 context;
+ u8 is_add;
+ vl_api_proxy_arp_t proxy;
+};
+
+/** \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
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
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 context;
+ i32 retval;
+ u32 timeout_ms;
+ u32 max_reassemblies;
+ u32 expire_walk_interval_ms;
+ u8 is_ip6;
+};
+
+/** \brief Enable/disable reassembly feature
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param sw_if_index - interface to enable/disable feature on
+ @param enable_ip4 - enable ip4 reassembly if non-zero, disable if 0
+ @param enable_ip6 - enable ip6 reassembly if non-zero, disable if 0
+*/
+autoreply define ip_reassembly_enable_disable
+{
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+ u8 enable_ip4;
+ u8 enable_ip6;
+};
+
/*
* Local Variables:
* eval: (c-set-style "gnu")
Code Review / vpp.git / blobdiff