FD.io VPP  v18.07-34-g55fbdb9
Vector Packet Processing
interface.api
Go to the documentation of this file.
1 option version = "2.0.0";
2 
4  rpc want_interface_events returns want_interface_events_reply
5  events sw_interface_event;
6 };
7 
8 /** \brief Set flags on the interface
9  @param client_index - opaque cookie to identify the sender
10  @param context - sender context, to match reply w/ request
11  @param sw_if_index - index of the interface to set flags on
12  @param admin_up_down - set the admin state, 1 = up, 0 = down
13  @param link_up_down - Oper state sent on change event, not used in config.
14 */
15 autoreply define sw_interface_set_flags
16 {
20  /* 1 = up, 0 = down */
22 };
23 
24 /** \brief Set interface physical MTU
25  @param client_index - opaque cookie to identify the sender
26  @param context - sender context, to match reply w/ request
27  @param sw_if_index - index of the interface to set MTU on
28  @param mtu - MTU
29 */
30 autoreply define hw_interface_set_mtu
31 {
36 };
37 
38 /** \brief Set interface L3 MTU */
39 autoreply define sw_interface_set_mtu
40 {
44  /* $$$$ Replace with enum */
45  u32 mtu[4]; /* 0 - L3, 1 - IP4, 2 - IP6, 3 - MPLS */
46 };
47 
48 
49 /** \brief Interface Event generated by want_interface_events
50  @param client_index - opaque cookie to identify the sender
51  @param pid - client pid registered to receive notification
52  @param sw_if_index - index of the interface of the event
53  @param admin_up_down - The administrative state; 1 = up, 0 = down
54  @param link_up_down - The operational state; 1 = up, 0 = down
55  @param deleted - interface was deleted
56 */
57 define sw_interface_event
58 {
65 };
66 
67 /** \brief Register for interface events
68  @param client_index - opaque cookie to identify the sender
69  @param context - sender context, to match reply w/ request
70  @param enable_disable - 1 => register for events, 0 => cancel registration
71  @param pid - sender's pid
72 */
73 autoreply define want_interface_events
74 {
79 };
80 
81 /** \brief Interface details structure (fix this)
82  @param sw_if_index - index of the interface
83  @param sup_sw_if_index - index of parent interface if any, else same as sw_if_index
84  @param l2_address_length - length of the interface's l2 address
85  @param pid - the interface's l2 address
86  @param interface_name - name of the interface
87  @param link_duplex - 1 if half duplex, 2 if full duplex
88  @param link_speed - 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G
89  @param link_MTU - max. transmittion unit
90  @param sub_if_id - A number 0-N to uniquely identify this subif on super if
91  @param sub_dot1ad - 0 = dot1q, 1 = dot1ad
92  @param sub_dot1ah - 1 = dot1ah, 0 = otherwise
93  @param sub_number_of_tags - Number of tags (0 - 2)
94  @param sub_outer_vlan_id
95  @param sub_inner_vlan_id
96  @param sub_exact_match
97  @param sub_default
98  @param sub_outer_vlan_id_any
99  @param sub_inner_vlan_id_any
100  @param vtr_op - vlan tag rewrite operation
101  @param vtr_push_dot1q
102  @param vtr_tag1
103  @param vtr_tag2
104  @param pbb_outer_tag - translate pbb s-tag
105  @param pbb_b_dmac[6] - B-tag remote mac address
106  @param pbb_b_smac[6] - B-tag local mac address
107  @param pbb_b_vlanid - B-tag vlanid
108  @param pbb_i_sid - I-tag service id
109 */
110 define sw_interface_details
111 {
114 
115  /* index of sup interface (e.g. hw interface).
116  equal to sw_if_index for super hw interface. */
118 
119  /* Layer 2 address, if applicable */
121  u8 l2_address[8];
122 
123  /* Interface name */
124  u8 interface_name[64];
125 
126  /* 1 = up, 0 = down */
129 
130  /* 1 = half duplex, 2 = full duplex */
132 
133  /* 1 = 10M, 2 = 100M, 4 = 1G, 8 = 10G, 16 = 40G, 32 = 100G */
135 
136  /* MTU */
138 
139  /* Per protocol MTUs */
140  u32 mtu[4]; /* 0 - L3, 1 - IP4, 2 - IP6, 3 - MPLS */
141 
142  /* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface */
144 
145  /* 0 = dot1q, 1=dot1ad */
147  /* 1 = dot1h, 1=otherwise */
149 
150  /* Number of tags 0-2 */
158 
159  /* vlan tag rewrite state */
161  u32 vtr_push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
162  u32 vtr_tag1; // first pushed tag
163  u32 vtr_tag2; // second pushed tag
164  u8 tag[64];
165 
166  /* pbb tag rewrite info */
168  u8 b_dmac[6];
169  u8 b_smac[6];
172 };
173 
174 /* works */
175 define sw_interface_dump
176 {
180  u8 name_filter[49];
181 };
182 
183 /** \brief Set or delete one or all ip addresses on a specified interface
184  @param client_index - opaque cookie to identify the sender
185  @param context - sender context, to match reply w/ request
186  @param sw_if_index - index of the interface to add/del addresses
187  @param is_add - add address if non-zero, else delete
188  @param is_ipv6 - if non-zero the address is ipv6, else ipv4
189  @param del_all - if non-zero delete all addresses on the interface
190  @param address_length - address length in bytes, 4 for ip4, 16 for ip6
191  @param address - array of address bytes
192 */
193 autoreply define sw_interface_add_del_address
194 {
202  u8 address[16];
203 };
204 
205 /** \brief Associate the specified interface with a fib table
206  @param client_index - opaque cookie to identify the sender
207  @param context - sender context, to match reply w/ request
208  @param sw_if_index - index of the interface
209  @param is_ipv6 - if non-zero ipv6, else ipv4
210  @param vrf_id - fib table/vrd id to associate the interface with
211 */
212 autoreply define sw_interface_set_table
213 {
219 };
220 
221 /** \brief Get VRF id assigned to interface
222  @param client_index - opaque cookie to identify the sender
223  @param context - sender context, to match reply w/ request
224  @param sw_if_index - index of the interface
225 */
226 define sw_interface_get_table
227 {
232 };
233 
234 /** \brief Reply to get_sw_interface_vrf
235  @param context - sender context which was passed in the request
236  @param vrf_id - VRF id assigned to the interface
237 */
238 define sw_interface_get_table_reply
239 {
243 };
244 
245 typeonly manual_print manual_endian define vlib_counter
246 {
247  u64 packets; /**< packet counter */
248  u64 bytes; /**< byte counter */
249 };
250 
251 /** \brief Combined interface counter data type for vnet_interface_combined_counters
252  @param sw_if_index - interface indexes for counters
253  @param rx_packets - received packet count
254  @param rx_bytes - received byte count
255  @param rx_unicast_packets - received unicast packet count
256  @param rx_unicast_bytes - received unicast byte count
257  @param rx_multicast_packets - received multicast packet count
258  @param rx_multicast_bytes - received multicast byte count
259  @param rx_broadcast_packets - received broadcast packet count
260  @param rx_broadcast_bytes - received broadcast byte count
261  @param tx_packets - transmitted packet count
262  @param tx_bytes - transmitted byte count
263  @param tx_unicast_packets - transmitted unicast packet count
264  @param tx_unicast_bytes - transmitted unicast byte count
265  @param tx_multicast_packets - transmitted multicast packet count
266  @param tx_multicast_bytes - transmitted multicast byte count
267  @param tx_broadcast_packets - transmitted broadcast packet count
268  @param tx_broadcast_bytes - transmitted broadcast byte count
269 
270 */
271 typeonly manual_print manual_endian define vnet_combined_counter
272 {
274  u64 rx_packets; /**< packet counter */
275  u64 rx_bytes; /**< byte counter */
276  u64 rx_unicast_packets; /**< packet counter */
277  u64 rx_unicast_bytes; /**< byte counter */
278  u64 rx_multicast_packets; /**< packet counter */
279  u64 rx_multicast_bytes; /**< byte counter */
280  u64 rx_broadcast_packets; /**< packet counter */
281  u64 rx_broadcast_bytes; /**< byte counter */
282  u64 tx_packets; /**< packet counter */
283  u64 tx_bytes; /**< byte counter */
284  u64 tx_unicast_packets; /**< packet counter */
285  u64 tx_unicast_bytes; /**< byte counter */
286  u64 tx_multicast_packets; /**< packet counter */
287  u64 tx_multicast_bytes; /**< byte counter */
288  u64 tx_broadcast_packets; /**< packet counter */
289  u64 tx_broadcast_bytes; /**< byte counter */
290 };
291 
292 /** \brief Simple interface counter data type for vnet_interface_simple_counters
293  @param sw_if_index - interface indexes for counters
294  @param drop - RX or TX drops due to buffer starvation
295  @param punt - used with VNET "punt" disposition
296  @param rx_ip4 - received IP4 packets
297  @param rx_ip6 - received IP6 packets
298  @param rx_no_buffer - no RX buffers available
299  @param rx_miss - receive misses
300  @param rx_error - receive errors
301  @param tx_error - transmit errors
302  @param rx_mpls - received MPLS packet
303 
304 */
305 typeonly manual_print manual_endian define vnet_simple_counter
306 {
317 };
318 
319 /** \brief Set unnumbered interface add / del request
320  @param client_index - opaque cookie to identify the sender
321  @param context - sender context, to match reply w/ request
322  @param sw_if_index - interface with an IP address
323  @param unnumbered_sw_if_index - interface which will use the address
324  @param is_add - if non-zero set the association, else unset it
325 */
326 autoreply define sw_interface_set_unnumbered
327 {
330  u32 sw_if_index; /* use this intfc address */
331  u32 unnumbered_sw_if_index; /* on this interface */
333 };
334 
335 /** \brief Clear interface statistics
336  @param client_index - opaque cookie to identify the sender
337  @param context - sender context, to match reply w/ request
338  @param sw_if_index - index of the interface to clear statistics
339 */
340 autoreply define sw_interface_clear_stats
341 {
345 };
346 
347 /** \brief Set / clear software interface tag
348  @param client_index - opaque cookie to identify the sender
349  @param context - sender context, to match reply w/ request
350  @param sw_if_index - the interface
351  @param add_del - 1 = add, 0 = delete
352  @param tag - an ascii tag
353 */
354 autoreply define sw_interface_tag_add_del
355 {
360  u8 tag[64];
361 };
362 
363 /** \brief Set an interface's MAC address
364  @param client_index - opaque cookie to identify the sender
365  @param context - sender context, to match reply w/ request
366  @param sw_if_index - the interface whose MAC will be set
367  @param mac_addr - the new MAC address
368 */
369 autoreply define sw_interface_set_mac_address
370 {
374  u8 mac_address[6];
375 };
376 
377 /** \brief Get interface's MAC address
378  @param client_index - opaque cookie to identify the sender
379  @param context - sender context, to match reply w/ request
380  @param sw_if_index - the interface whose MAC will be returned
381 */
382 define sw_interface_get_mac_address
383 {
387 };
388 
389 /** \brief Reply for get interface's MAC address request
390  @param context - returned sender context, to match reply w/ request
391  @param retval - return code
392  @param mac_addr - returned interface's MAC address
393 */
394 define sw_interface_get_mac_address_reply
395 {
398  u8 mac_address[6];
399 };
400 
401 /** \brief Set an interface's rx-mode
402  @param client_index - opaque cookie to identify the sender
403  @param context - sender context, to match reply w/ request
404  @param sw_if_index - the interface whose rx-mode will be set
405  @param queue_id_valid - 1 = the queue_id field is valid. 0 means all
406  queue_id's
407  @param queue_id - the queue number whose rx-mode will be set. Only valid
408  if queue_id_valid is 1
409  @param mode - polling=1, interrupt=2, adaptive=3
410 */
411 autoreply define sw_interface_set_rx_mode
412 {
419 };
420 
421 /* Gross kludge, DGMS */
422 autoreply define interface_name_renumber
423 {
428 };
429 
430 define create_subif
431 {
436 
437  /* These fields map directly onto the subif template */
441  u8 dot1ad; // 0 = dot1q, 1=dot1ad
448 };
449 
450 define create_subif_reply
451 {
455 };
456 
457 /** \brief Create a new subinterface with the given vlan id
458  @param client_index - opaque cookie to identify the sender
459  @param context - sender context, to match reply w/ request
460  @param sw_if_index - software index of the new vlan's parent interface
461  @param vlan_id - vlan tag of the new interface
462 */
463 define create_vlan_subif
464 {
469 };
470 
471 /** \brief Reply for the vlan subinterface create request
472  @param context - returned sender context, to match reply w/ request
473  @param retval - return code
474  @param sw_if_index - software index allocated for the new subinterface
475 */
476 define create_vlan_subif_reply
477 {
481 };
482 
483 /** \brief Delete sub interface request
484  @param client_index - opaque cookie to identify the sender
485  @param context - sender context, to match reply w/ request
486  @param sw_if_index - sw index of the interface that was created by create_subif
487 */
488 autoreply define delete_subif {
492 };
493 
494 /** \brief Create loopback interface request
495  @param client_index - opaque cookie to identify the sender
496  @param context - sender context, to match reply w/ request
497  @param mac_address - mac addr to assign to the interface if none-zero
498 */
499 define create_loopback
500 {
503  u8 mac_address[6];
504 };
505 
506 /** \brief Create loopback interface response
507  @param context - sender context, to match reply w/ request
508  @param sw_if_index - sw index of the interface that was created
509  @param retval - return code for the request
510 */
511 define create_loopback_reply
512 {
516 };
517 
518 /** \brief Create loopback interface instance request
519  @param client_index - opaque cookie to identify the sender
520  @param context - sender context, to match reply w/ request
521  @param mac_address - mac addr to assign to the interface if none-zero
522  @param is_specified - if non-0, a specific user_instance is being requested
523  @param user_instance - requested instance, ~0 => dynamically allocate
524 */
525 define create_loopback_instance
526 {
529  u8 mac_address[6];
532 };
533 
534 /** \brief Create loopback interface instance response
535  @param context - sender context, to match reply w/ request
536  @param sw_if_index - sw index of the interface that was created
537  @param retval - return code for the request
538 */
539 define create_loopback_instance_reply
540 {
544 };
545 
546 /** \brief Delete loopback interface request
547  @param client_index - opaque cookie to identify the sender
548  @param context - sender context, to match reply w/ request
549  @param sw_if_index - sw index of the interface that was created
550 */
551 autoreply define delete_loopback
552 {
556 };
557 
558 /** \brief Enable or disable detailed interface stats
559  @param client_index - opaque cookie to identify the sender
560  @param context - sender context, to match reply w/ request
561  @param sw_if_index - The interface to collect detail stats on. ~0 implies
562  all interfaces.
563  @param enable_disable - set to 1 to enable, 0 to disable detailed stats
564 */
566 {
571 };
572 
573 /*
574  * Local Variables:
575  * eval: (c-set-style "gnu")
576  * End:
577  */
u64 rx_multicast_packets
packet counter
Definition: interface.api:278
u64 tx_unicast_bytes
byte counter
Definition: interface.api:285
typedef address
Definition: ip_types.api:35
u64 tx_unicast_packets
packet counter
Definition: interface.api:284
unsigned long u64
Definition: types.h:89
u64 tx_broadcast_bytes
byte counter
Definition: interface.api:289
u64 tx_broadcast_packets
packet counter
Definition: interface.api:288
unsigned char u8
Definition: types.h:56
u64 rx_unicast_packets
packet counter
Definition: interface.api:276
option version
Definition: interface.api:1
u64 bytes
byte counter
Definition: interface.api:248
u64 rx_unicast_bytes
byte counter
Definition: interface.api:277
unsigned int u32
Definition: types.h:88
u64 tx_packets
packet counter
Definition: interface.api:282
u64 packets
packet counter
Definition: interface.api:247
u64 tx_multicast_bytes
byte counter
Definition: interface.api:287
u64 rx_broadcast_packets
packet counter
Definition: interface.api:280
unsigned short u16
Definition: types.h:57
u64 rx_broadcast_bytes
byte counter
Definition: interface.api:281
service
Definition: interface.api:3
u64 rx_multicast_bytes
byte counter
Definition: interface.api:279
static int collect_detailed_interface_stats(void)
Definition: interface.h:770
signed int i32
Definition: types.h:81
u64 rx_packets
packet counter
Definition: interface.api:274
u64 tx_multicast_packets
packet counter
Definition: interface.api:286