+/* Hey Emacs use -*- mode: C -*- */
+/*
+ * 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:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+option version = "2.2.0";
+
+import "vnet/interface_types.api";
+
+service {
+ rpc want_interface_events returns want_interface_events_reply
+ events sw_interface_event;
+};
+
/** \brief Set flags on the interface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - index of the interface to set flags on
@param admin_up_down - set the admin state, 1 = up, 0 = down
@param link_up_down - Oper state sent on change event, not used in config.
- @param deleted - interface was deleted
*/
-define sw_interface_set_flags
+autoreply define sw_interface_set_flags
{
u32 client_index;
u32 context;
u32 sw_if_index;
/* 1 = up, 0 = down */
u8 admin_up_down;
- u8 link_up_down;
- u8 deleted;
};
-/** \brief Reply to sw_interface_set_flags
- @param context - sender context which was passed in the request
- @param retval - return code of the set flags request
-*/
-define sw_interface_set_flags_reply
-{
- u32 context;
- i32 retval;
-};
-
-/** \brief Set interface MTU
+/** \brief Set interface physical MTU
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - index of the interface to set MTU on
@param mtu - MTU
*/
-define sw_interface_set_mtu
+autoreply define hw_interface_set_mtu
{
u32 client_index;
u32 context;
u16 mtu;
};
-/** \brief Reply to sw_interface_set_mtu
- @param context - sender context which was passed in the request
- @param retval - return code of the set flags request
+/** \brief Set interface L3 MTU */
+autoreply define sw_interface_set_mtu
+{
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+ /* $$$$ Replace with enum */
+ u32 mtu[4]; /* 0 - L3, 1 - IP4, 2 - IP6, 3 - MPLS */
+};
+
+/** \brief Set IP4 directed broadcast
+ The directed broadcast enabled a packet sent to the interface's
+ subnet address will be broadcast on the interface
+ @param sw_if_index
+ @param enable
*/
-define sw_interface_set_mtu_reply
+autoreply define sw_interface_set_ip_directed_broadcast
{
+ u32 client_index;
u32 context;
- i32 retval;
+ u32 sw_if_index;
+ u8 enable;
+};
+
+
+/** \brief Interface Event generated by want_interface_events
+ @param client_index - opaque cookie to identify the sender
+ @param pid - client pid registered to receive notification
+ @param sw_if_index - index of the interface of the event
+ @param admin_up_down - The administrative state; 1 = up, 0 = down
+ @param link_up_down - The operational state; 1 = up, 0 = down
+ @param deleted - interface was deleted
+*/
+define sw_interface_event
+{
+ u32 client_index;
+ u32 pid;
+ u32 sw_if_index;
+ u8 admin_up_down;
+ u8 link_up_down;
+ u8 deleted;
};
/** \brief Register for interface events
@param enable_disable - 1 => register for events, 0 => cancel registration
@param pid - sender's pid
*/
-define want_interface_events
+autoreply define want_interface_events
{
u32 client_index;
u32 context;
u32 pid;
};
-/** \brief Reply for interface events registration
- @param context - returned sender context, to match reply w/ request
- @param retval - return code
-*/
-define want_interface_events_reply
-{
- u32 context;
- i32 retval;
-};
-
/** \brief Interface details structure (fix this)
@param sw_if_index - index of the interface
@param sup_sw_if_index - index of parent interface if any, else same as sw_if_index
@param pid - the interface's l2 address
@param interface_name - name of the interface
@param link_duplex - 1 if half duplex, 2 if full duplex
- @param link_speed - 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G
- @param link_MTU - max. transmittion unit
+ @param link_speed - value in kbps
+ @param link_MTU - max. transmission unit
@param sub_if_id - A number 0-N to uniquely identify this subif on super if
@param sub_dot1ad - 0 = dot1q, 1 = dot1ad
@param sub_dot1ah - 1 = dot1ah, 0 = otherwise
/* 1 = half duplex, 2 = full duplex */
u8 link_duplex;
- /* 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G */
- u8 link_speed;
+ /* link speed in kbps */
+ u32 link_speed;
/* MTU */
u16 link_mtu;
+ /* Per protocol MTUs */
+ u32 mtu[4]; /* 0 - L3, 1 - IP4, 2 - IP6, 3 - MPLS */
+
/* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface */
u32 sub_id;
@param address_length - address length in bytes, 4 for ip4, 16 for ip6
@param address - array of address bytes
*/
-define sw_interface_add_del_address
+autoreply define sw_interface_add_del_address
{
u32 client_index;
u32 context;
u8 address[16];
};
-/** \brief Reply to sw_interface_add_del_address
- @param context - returned sender context, to match reply w/ request
- @param retval - return code
-*/
-define sw_interface_add_del_address_reply
-{
- u32 context;
- i32 retval;
-};
-
/** \brief Associate the specified interface with a fib table
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_ipv6 - if non-zero ipv6, else ipv4
@param vrf_id - fib table/vrd id to associate the interface with
*/
-define sw_interface_set_table
+autoreply define sw_interface_set_table
{
u32 client_index;
u32 context;
u32 vrf_id;
};
-/** \brief Reply to sw_interface_set_table
- @param context - returned sender context, to match reply w/ request
- @param retval - return code
-*/
-define sw_interface_set_table_reply
-{
- u32 context;
- i32 retval;
-};
-
/** \brief Get VRF id assigned to interface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
u32 vrf_id;
};
-/** \brief Stats counters structure
- @param vnet_counter_type- such as ip4, ip6, punts, etc
- @param is_combined - rx & tx total (all types) counts
- @param first_sw_if_index - first sw index in block of index, counts
- @param count - number of interfaces this stats block includes counters for
- @param data - contiguous block of vlib_counter_t structures
+typeonly manual_print manual_endian define vlib_counter
+{
+ u64 packets; /**< packet counter */
+ u64 bytes; /**< byte counter */
+};
+
+/** \brief Combined interface counter data type for vnet_interface_combined_counters
+ @param sw_if_index - interface indexes for counters
+ @param rx_packets - received packet count
+ @param rx_bytes - received byte count
+ @param rx_unicast_packets - received unicast packet count
+ @param rx_unicast_bytes - received unicast byte count
+ @param rx_multicast_packets - received multicast packet count
+ @param rx_multicast_bytes - received multicast byte count
+ @param rx_broadcast_packets - received broadcast packet count
+ @param rx_broadcast_bytes - received broadcast byte count
+ @param tx_packets - transmitted packet count
+ @param tx_bytes - transmitted byte count
+ @param tx_unicast_packets - transmitted unicast packet count
+ @param tx_unicast_bytes - transmitted unicast byte count
+ @param tx_multicast_packets - transmitted multicast packet count
+ @param tx_multicast_bytes - transmitted multicast byte count
+ @param tx_broadcast_packets - transmitted broadcast packet count
+ @param tx_broadcast_bytes - transmitted broadcast byte count
+
+*/
+typeonly manual_print manual_endian define vnet_combined_counter
+{
+ u32 sw_if_index;
+ u64 rx_packets; /**< packet counter */
+ u64 rx_bytes; /**< byte counter */
+ u64 rx_unicast_packets; /**< packet counter */
+ u64 rx_unicast_bytes; /**< byte counter */
+ u64 rx_multicast_packets; /**< packet counter */
+ u64 rx_multicast_bytes; /**< byte counter */
+ u64 rx_broadcast_packets; /**< packet counter */
+ u64 rx_broadcast_bytes; /**< byte counter */
+ u64 tx_packets; /**< packet counter */
+ u64 tx_bytes; /**< byte counter */
+ u64 tx_unicast_packets; /**< packet counter */
+ u64 tx_unicast_bytes; /**< byte counter */
+ u64 tx_multicast_packets; /**< packet counter */
+ u64 tx_multicast_bytes; /**< byte counter */
+ u64 tx_broadcast_packets; /**< packet counter */
+ u64 tx_broadcast_bytes; /**< byte counter */
+};
+
+/** \brief Simple interface counter data type for vnet_interface_simple_counters
+ @param sw_if_index - interface indexes for counters
+ @param drop - RX or TX drops due to buffer starvation
+ @param punt - used with VNET "punt" disposition
+ @param rx_ip4 - received IP4 packets
+ @param rx_ip6 - received IP6 packets
+ @param rx_no_buffer - no RX buffers available
+ @param rx_miss - receive misses
+ @param rx_error - receive errors
+ @param tx_error - transmit errors
+ @param rx_mpls - received MPLS packet
+
*/
-define vnet_interface_counters
+typeonly manual_print manual_endian define vnet_simple_counter
{
- /* enums - plural - in vnet/interface.h */
- u8 vnet_counter_type;
- u8 is_combined;
- u32 first_sw_if_index;
- u32 count;
- u8 data[count];
+ u32 sw_if_index;
+ u64 drop;
+ u64 punt;
+ u64 rx_ip4;
+ u64 rx_ip6;
+ u64 rx_no_buffer;
+ u64 rx_miss;
+ u64 rx_error;
+ u64 tx_error;
+ u64 rx_mpls;
};
/** \brief Set unnumbered interface add / del request
@param unnumbered_sw_if_index - interface which will use the address
@param is_add - if non-zero set the association, else unset it
*/
-define sw_interface_set_unnumbered
+autoreply define sw_interface_set_unnumbered
{
u32 client_index;
u32 context;
u8 is_add;
};
-/** \brief Set unnumbered interface add / del response
+/** \brief Clear interface statistics
+ @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 - index of the interface to clear statistics
*/
-define sw_interface_set_unnumbered_reply
+autoreply define sw_interface_clear_stats
+{
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+};
+
+/** \brief Set / clear software interface tag
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param sw_if_index - the interface
+ @param add_del - 1 = add, 0 = delete
+ @param tag - an ascii tag
+*/
+autoreply define sw_interface_tag_add_del
+{
+ u32 client_index;
+ u32 context;
+ u8 is_add;
+ u32 sw_if_index;
+ u8 tag[64];
+};
+
+/** \brief Set an interface's MAC address
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param sw_if_index - the interface whose MAC will be set
+ @param mac_addr - the new MAC address
+*/
+autoreply define sw_interface_set_mac_address
+{
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+ u8 mac_address[6];
+};
+
+/** \brief Get interface's MAC address
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param sw_if_index - the interface whose MAC will be returned
+*/
+define sw_interface_get_mac_address
+{
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+};
+
+/** \brief Reply for get interface's MAC address request
+ @param context - returned sender context, to match reply w/ request
+ @param retval - return code
+ @param mac_addr - returned interface's MAC address
+*/
+define sw_interface_get_mac_address_reply
+{
+ u32 context;
+ i32 retval;
+ u8 mac_address[6];
+};
+
+/** \brief Set an interface's rx-mode
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param sw_if_index - the interface whose rx-mode will be set
+ @param queue_id_valid - 1 = the queue_id field is valid. 0 means all
+ queue_id's
+ @param queue_id - the queue number whose rx-mode will be set. Only valid
+ if queue_id_valid is 1
+ @param mode - polling=1, interrupt=2, adaptive=3
+*/
+autoreply define sw_interface_set_rx_mode
+{
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+ u8 queue_id_valid;
+ u32 queue_id;
+ u8 mode;
+};
+
+/** \brief Set an interface's rx-placement
+ Rx-Queue placement on specific thread is operational for only hardware
+ interface. It will not set queue - thread placement for sub-interfaces,
+ p2p and pipe interfaces.
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param sw_if_index - the interface whose rx-placement will be set
+ @param queue_id - the queue number whose rx-placement will be set.
+ @param worker_id - the worker number whom rx-placement will be at.
+ @param is_main - flag to set rx-placement to main thread
+*/
+autoreply define sw_interface_set_rx_placement
+{
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+ u32 queue_id;
+ u32 worker_id;
+ u8 is_main;
+};
+
+/** \brief dump the rx queue placement of interface(s)
+ @param sw_if_index - optional interface index for which queue placement to
+ be requested. sw_if_index = ~0 will dump placement information for all
+ interfaces. It will not dump information related to sub-interfaces, p2p
+ and pipe interfaces.
+*/
+define sw_interface_rx_placement_dump
+{
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+};
+
+/** \brief show the interface's queue - thread placement
+ This api is used to display the interface and queue worker
+ thread placement. One message per rx-queue per interface will
+ be sent to client.
+ Each message will contain information about rx-queue id of an
+ interface, interface index, thread on which this rx-queue is
+ placed and mode of rx-queue.
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param sw_if_index - the interface whose rx-placement will be dumped
+ @param queue_id - the queue id
+ @param worker_id - the worker id on which queue_id is placed,
+ worker_id = 0 means main thread.
+ @param mode - polling=1, interrupt=2, adaptive=3
+*/
+define sw_interface_rx_placement_details
+{
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+ u32 queue_id;
+ u32 worker_id;
+ u8 mode;
+};
+
+/* Gross kludge, DGMS */
+autoreply define interface_name_renumber
+{
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+ u32 new_show_dev_instance;
+};
+
+define create_subif
+{
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+ u32 sub_id;
+
+ /* These fields map directly onto the subif template */
+ u8 no_tags;
+ u8 one_tag;
+ u8 two_tags;
+ u8 dot1ad; // 0 = dot1q, 1=dot1ad
+ u8 exact_match;
+ u8 default_sub;
+ u8 outer_vlan_id_any;
+ u8 inner_vlan_id_any;
+ u16 outer_vlan_id;
+ u16 inner_vlan_id;
+};
+
+define create_subif_reply
{
u32 context;
i32 retval;
+ u32 sw_if_index;
};
-/** \brief Clear interface statistics
+/** \brief Create a new subinterface with the given vlan id
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
- @param sw_if_index - index of the interface to clear statistics
+ @param sw_if_index - software index of the new vlan's parent interface
+ @param vlan_id - vlan tag of the new interface
*/
-define sw_interface_clear_stats
+define create_vlan_subif
{
u32 client_index;
u32 context;
u32 sw_if_index;
+ u32 vlan_id;
};
-/** \brief Reply to sw_interface_clear_stats
- @param context - sender context which was passed in the request
- @param retval - return code of the set flags request
+/** \brief Reply for the vlan subinterface create request
+ @param context - returned sender context, to match reply w/ request
+ @param retval - return code
+ @param sw_if_index - software index allocated for the new subinterface
*/
-define sw_interface_clear_stats_reply
+define create_vlan_subif_reply
{
u32 context;
i32 retval;
+ u32 sw_if_index;
};
-/** \brief Set / clear software interface tag
+/** \brief Delete sub interface 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
- @param add_del - 1 = add, 0 = delete
- @param tag - an ascii tag
+ @param sw_if_index - sw index of the interface that was created by create_subif
+*/
+autoreply define delete_subif {
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+};
+
+/** \brief Create loopback interface request
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param mac_address - mac addr to assign to the interface if none-zero
*/
-define sw_interface_tag_add_del
+define create_loopback
{
- u32 client_index;
- u32 context;
- u8 is_add;
- u32 sw_if_index;
- u8 tag[64];
+ u32 client_index;
+ u32 context;
+ u8 mac_address[6];
};
-/** \brief Reply to set / clear software interface tag
- @param context - sender context which was passed in the request
+/** \brief Create loopback interface response
+ @param context - sender context, to match reply w/ request
+ @param sw_if_index - sw index of the interface that was created
@param retval - return code for the request
*/
-define sw_interface_tag_add_del_reply
+define create_loopback_reply
{
- u32 context;
- i32 retval;
+ u32 context;
+ i32 retval;
+ u32 sw_if_index;
};
+
+/** \brief Create loopback interface instance request
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param mac_address - mac addr to assign to the interface if none-zero
+ @param is_specified - if non-0, a specific user_instance is being requested
+ @param user_instance - requested instance, ~0 => dynamically allocate
+*/
+define create_loopback_instance
+{
+ u32 client_index;
+ u32 context;
+ u8 mac_address[6];
+ u8 is_specified;
+ u32 user_instance;
+};
+
+/** \brief Create loopback interface instance response
+ @param context - sender context, to match reply w/ request
+ @param sw_if_index - sw index of the interface that was created
+ @param retval - return code for the request
+*/
+define create_loopback_instance_reply
+{
+ u32 context;
+ i32 retval;
+ u32 sw_if_index;
+};
+
+/** \brief Delete loopback interface request
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param sw_if_index - sw index of the interface that was created
+*/
+autoreply define delete_loopback
+{
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+};
+
+/** \brief Enable or disable detailed interface stats
+ @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 collect detail stats on. ~0 implies
+ all interfaces.
+ @param enable_disable - set to 1 to enable, 0 to disable detailed stats
+*/
+autoreply define collect_detailed_interface_stats
+{
+ u32 client_index;
+ u32 context;
+ u32 sw_if_index;
+ u8 enable_disable;
+};
+
/*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/
-
Code Review / vpp.git / blobdiff