+/* 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.
*/
-option version = "1.2.4";
+option version = "2.0.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.
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 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, ~0 == all
- @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
+/** \brief IP neighbor flags
+ @param is_static - A static neighbor Entry - there are not flushed
+ If the interface goes down.
+ @param is_no_fib_entry - Do not create a corresponding entry in the FIB
+ table for the neighbor.
*/
-define ip_neighbor_dump
+enum ip_neighbor_flags
{
- u32 client_index;
- u32 context;
- u32 sw_if_index;
- u8 is_ipv6;
+ IP_API_NEIGHBOR_FLAG_NONE = 0,
+ IP_API_NEIGHBOR_FLAG_STATIC = 0x1,
+ IP_API_NEIGHBOR_FLAG_NO_FIB_ENTRY = 0x2,
};
-/** \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]
+/** \brief IP neighbor
+ @param sw_if_index - interface used to reach neighbor
+ @param mac_address - l2 address of the neighbor
+ @param ip_address - ip4 or ip6 address of the neighbor
+ @param flags - flags for the nieghbor
*/
-define ip_neighbor_details {
- u32 context;
- u32 sw_if_index;
- u8 is_static;
- u8 is_ipv6;
- u8 mac_address[6];
- u8 ip_address[16];
+typedef ip_neighbor {
+ u32 sw_if_index;
+ vl_api_ip_neighbor_flags_t flags;
+ vl_api_mac_address_t mac_address;
+ vl_api_address_t ip_address;
};
/** \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 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_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
+ @param neighbor - the neighor to add/remove
*/
-autoreply define ip_neighbor_add_del
+define ip_neighbor_add_del
{
u32 client_index;
u32 context;
- 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];
+ vl_api_ip_neighbor_t neighbor;
+};
+define ip_neighbor_add_del_reply
+{
+ u32 context;
+ i32 retval;
+ u32 stats_index;
+};
+
+/** \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, ~0 == all
+ @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
+*/
+define ip_neighbor_dump
+{
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+ u8 is_ipv6;
+};
+
+/** \brief IP neighboors dump response
+ @param context - sender context which was passed in the request
+ @param neighbour - the neighbor
+*/
+define ip_neighbor_details {
+ u32 context;
+ vl_api_ip_neighbor_t neighbor;
};
/** \brief Set the ip flow hash config for a fib 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
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@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 prefix - The prefix to advertise
@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)
u32 client_index;
u32 context;
u32 sw_if_index;
- u8 address[16];
- u8 address_length;
+ vl_api_prefix_t prefix;
u8 use_default;
u8 no_advertise;
u8 off_link;
u32 context;
u32 sw_if_index;
u8 is_del;
- u8 address[16];
+ vl_api_ip6_address_t ip;
};
/** \brief IPv6 ND proxy details returned after request
*/
define ip6nd_proxy_details
{
- u32 client_index;
u32 context;
u32 sw_if_index;
- u8 address[16];
+ vl_api_ip6_address_t ip;
};
/** \brief IPv6 ND proxy dump request
u8 enable; /* set to true if enable */
};
-/** \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
-*/
-autoreply define sw_interface_ip6_set_link_local_address
-{
- u32 client_index;
- u32 context;
- u32 sw_if_index;
- u8 address[16];
-};
-
/** \brief Add / del route request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@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;
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;
u8 nh_address[16];
};
+define ip_mroute_add_del_reply
+{
+ u32 context;
+ i32 retval;
+ u32 stats_index;
+};
+
/** \brief Dump IP multicast fib table
@param client_index - opaque cookie to identify the sender
*/
@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;
*/
define ip_unnumbered_details
{
- u32 client_index;
u32 context;
u32 sw_if_index;
u32 ip_sw_if_index;
define ip_details
{
- u32 sw_if_index;
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
{
u32 client_index;
u32 context;
- u8 ip[16];
- u8 is_ip4;
- u8 plen;
+ vl_api_prefix_t pfx;
u32 sw_if_index;
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
@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 ip - prefix to match
@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)
{
u32 client_index;
u32 context;
- u8 is_ipv6;
u8 is_add;
- u8 mask_length;
- u8 address[16];
+ vl_api_prefix_t prefix;
u8 number_of_ranges;
u16 low_ports[32];
u16 high_ports[32];
u32 udp_out_vrf_id;
};
+/** \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 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]
+ @param dst - target IP address to send IP addr resolution request
*/
autoreply define ip_probe_neighbor
{
u32 client_index;
u32 context;
u32 sw_if_index;
- u8 dst_address[16];
- u8 is_ipv6;
+ vl_api_address_t dst;
};
/** \brief Register for IP4 ARP resolution event on receing ARP reply or
@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 - exact IP4 address of interested arp resolution event, or
- 0 to get MAC/IP info from ARP requests in BDs
+ @param ip - 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 context;
u8 enable_disable;
u32 pid;
- u32 address;
+ vl_api_ip4_address_t ip;
};
/** \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 ip - 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 - the new mac address
@param mac_ip - 0: ARP resolution event, 1: MAC/IP info from L2 BDs
*/
define ip4_arp_event
{
u32 client_index;
- u32 address;
+ vl_api_ip4_address_t ip;
u32 pid;
u32 sw_if_index;
- u8 new_mac[6];
+ vl_api_mac_address_t mac;
u8 mac_ip;
};
@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 interested ND resolution event, or
- 0 to get MAC/IP info from ICMP6 NS in L2 BDs.
+ @param ip - 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
{
u32 context;
u8 enable_disable;
u32 pid;
- u8 address[16];
+ vl_api_ip6_address_t ip;
};
/** \brief Tell client about an IP6 ND resolution or
@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 ip - the exact ip6 address of interest
@param new_mac - the new mac address
@param mac_ip - 0: ND resolution event, 1: MAC/IP info from L2 BDs
*/
u32 client_index;
u32 pid;
u32 sw_if_index;
- u8 address[16];
- u8 new_mac[6];
+ vl_api_ip6_address_t ip;
+ vl_api_mac_address_t mac;
u8 mac_ip;
};
};
/** \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 prefix - RA prefix info destination address
@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;
+ vl_api_prefix_t prefix;
u8 flags;
u32 valid_time;
u32 preferred_time;
@param current_hop_limit - RA current hop limit
@param flags - RA flags
@param router_lifetime_in_sec - RA lifetime in seconds
+ @param router_addr - The router's address
@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
u32 client_index;
u32 pid;
u32 sw_if_index;
- u8 router_address[16];
+ vl_api_ip6_address_t router_addr;
u8 current_hop_limit;
u8 flags;
u16 router_lifetime_in_sec;
events ip6_nd_event;
};
+/** \brief Proxy ARP configuration type
+ @param table_id - VRF / Fib table ID
+ @param low - Low address of the Proxy ARP range
+ @param hi - High address of the Proxy ARP range
+*/
+typeonly define proxy_arp
+{
+ u32 table_id;
+ vl_api_ip4_address_t low;
+ vl_api_ip4_address_t hi;
+};
+
/** \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
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
define ip_reassembly_get_reply
{
- u32 client_index;
u32 context;
i32 retval;
u32 timeout_ms;
Code Review / vpp.git / blobdiff