X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvnet%2Finterface.api;h=0f88863dff3bdc45e772b459e899785a8027cd13;hb=70083ee;hp=a6fd5ad60d4e53008637ebff2cfcb9a447315159;hpb=ad8015be47a8d7d4c1f94b51ad9c70e37cc29cbf;p=vpp.git diff --git a/src/vnet/interface.api b/src/vnet/interface.api index a6fd5ad60d4..0f88863dff3 100644 --- a/src/vnet/interface.api +++ b/src/vnet/interface.api @@ -1,4 +1,9 @@ -vl_api_version 1.0.0 +option version = "1.1.0"; + +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 @@ -70,7 +75,7 @@ autoreply define want_interface_events @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 MTU - max. transmittion 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 @@ -118,7 +123,7 @@ define sw_interface_details u8 link_speed; /* MTU */ - u16 link_mtu; + u16 mtu; /* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface */ u32 sub_id; @@ -233,17 +238,41 @@ typeonly manual_print manual_endian define vlib_counter @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 tx_packets; /**< packet counter */ - u64 tx_bytes; /**< byte counter */ + 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 @@ -273,66 +302,6 @@ typeonly manual_print manual_endian define vnet_simple_counter u64 rx_mpls; }; -/** \brief Simple 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 u64 counters - - vnet_counter_type defined in enums - plural - in vnet/interface.h -*/ -manual_print manual_endian define vnet_interface_simple_counters -{ - u8 vnet_counter_type; - u32 first_sw_if_index; - u32 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 @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @@ -391,6 +360,30 @@ autoreply define sw_interface_set_mac_address 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 @@ -411,6 +404,158 @@ autoreply define sw_interface_set_rx_mode 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 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 - software index of the new vlan's parent interface + @param vlan_id - vlan tag of the new interface +*/ +define create_vlan_subif +{ + u32 client_index; + u32 context; + u32 sw_if_index; + u32 vlan_id; +}; + +/** \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 create_vlan_subif_reply +{ + u32 context; + i32 retval; + u32 sw_if_index; +}; + +/** \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 - 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 create_loopback +{ + u32 client_index; + u32 context; + u8 mac_address[6]; +}; + +/** \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 create_loopback_reply +{ + 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")