vppapigen: support per-file (major,minor,patch) version stamps
[vpp.git] / src / vnet / interface.api
index 9df63f1..2f2e837 100644 (file)
@@ -1,10 +1,11 @@
+vl_api_version 1.0.0
+
 /** \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
 */
 autoreply define sw_interface_set_flags
 {
@@ -13,8 +14,6 @@ autoreply define sw_interface_set_flags
   u32 sw_if_index;
   /* 1 = up, 0 = down */
   u8 admin_up_down;
-  u8 link_up_down;
-  u8 deleted;
 };
 
 /** \brief Set interface MTU
@@ -31,6 +30,24 @@ autoreply define sw_interface_set_mtu
   u16 mtu;
 };
 
+/** \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 client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -206,21 +223,114 @@ define sw_interface_get_table_reply
   u32 vrf_id;
 };
 
-/** \brief Stats counters structure 
+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 tx_packets - transmitted packet count
+    @param tx_bytes - transmitted 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 tx_packets;                      /**< packet counter */
+  u64 tx_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
+
+*/
+typeonly manual_print manual_endian define vnet_simple_counter
+{
+  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 Simple 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 
+    @param count - number of counters, equal to the number of interfaces in
+      this stats block
+    @param data - contiguous block of u64 counters
+
+    vnet_counter_type defined in enums - plural - in vnet/interface.h
 */
-define vnet_interface_counters
+manual_print manual_endian define vnet_interface_simple_counters
 {
-  /* enums - plural - in vnet/interface.h */
   u8 vnet_counter_type;
-  u8 is_combined;
   u32 first_sw_if_index;
   u32 count;
-  u8 data[count];
+  u64 data[count];
+};
+
+/** \brief Combined stats counters structure
+    @param vnet_counter_type- such as ip4, ip6, punts, etc
+    @param first_sw_if_index - first sw index in block of index, counts
+    @param count - number of counters, equal to the number of interfaces in
+      this stats block
+    @param data - contiguous block of vlib_counter_t structures
+
+    vnet_counter_type defined in enums - plural - in vnet/interface.h
+*/
+manual_print manual_endian define vnet_interface_combined_counters
+{
+  u8 vnet_counter_type;
+  u32 first_sw_if_index;
+  u32 count;
+  vl_api_vlib_counter_t data[count];
+};
+
+
+/** \brief Simple per interface stats counters structure
+    @param count - number of elements in message
+    @param timestamp - u32 vlib timestamp for control plane
+    @param data[count] - vl_api_vnet_simple_counter_t 
+
+*/
+manual_print manual_endian define vnet_per_interface_simple_counters
+{
+  u32 count;
+  u32 timestamp;
+  vl_api_vnet_simple_counter_t data[count];
+};
+
+/** \brief Combined stats counters structure per interface
+    @param count - number of elements in message
+    @param timestamp - u32 vlib timestamp for control plane
+    @param data[count] - vl_api_vnet_combined_counter_t
+*/
+manual_print manual_endian define vnet_per_interface_combined_counters
+{
+  u32 count;
+  u32 timestamp;
+  vl_api_vnet_combined_counter_t data[count];
 };
 
 /** \brief Set unnumbered interface add / del request