1 /* Hey Emacs use -*- mode: C -*- */
3 * Copyright (c) 2018 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 option version = "2.2.0";
19 import "vnet/interface_types.api";
22 rpc want_interface_events returns want_interface_events_reply
23 events sw_interface_event;
26 /** \brief Set flags on the interface
27 @param client_index - opaque cookie to identify the sender
28 @param context - sender context, to match reply w/ request
29 @param sw_if_index - index of the interface to set flags on
30 @param admin_up_down - set the admin state, 1 = up, 0 = down
31 @param link_up_down - Oper state sent on change event, not used in config.
33 autoreply define sw_interface_set_flags
38 /* 1 = up, 0 = down */
42 /** \brief Set interface physical MTU
43 @param client_index - opaque cookie to identify the sender
44 @param context - sender context, to match reply w/ request
45 @param sw_if_index - index of the interface to set MTU on
48 autoreply define hw_interface_set_mtu
56 /** \brief Set interface L3 MTU */
57 autoreply define sw_interface_set_mtu
62 /* $$$$ Replace with enum */
63 u32 mtu[4]; /* 0 - L3, 1 - IP4, 2 - IP6, 3 - MPLS */
66 /** \brief Set IP4 directed broadcast
67 The directed broadcast enabled a packet sent to the interface's
68 subnet address will be broadcast on the interface
72 autoreply define sw_interface_set_ip_directed_broadcast
81 /** \brief Interface Event generated by want_interface_events
82 @param client_index - opaque cookie to identify the sender
83 @param pid - client pid registered to receive notification
84 @param sw_if_index - index of the interface of the event
85 @param admin_up_down - The administrative state; 1 = up, 0 = down
86 @param link_up_down - The operational state; 1 = up, 0 = down
87 @param deleted - interface was deleted
89 define sw_interface_event
99 /** \brief Register for interface events
100 @param client_index - opaque cookie to identify the sender
101 @param context - sender context, to match reply w/ request
102 @param enable_disable - 1 => register for events, 0 => cancel registration
103 @param pid - sender's pid
105 autoreply define want_interface_events
113 /** \brief Interface details structure (fix this)
114 @param sw_if_index - index of the interface
115 @param sup_sw_if_index - index of parent interface if any, else same as sw_if_index
116 @param l2_address_length - length of the interface's l2 address
117 @param pid - the interface's l2 address
118 @param interface_name - name of the interface
119 @param link_duplex - 1 if half duplex, 2 if full duplex
120 @param link_speed - value in kbps
121 @param link_MTU - max. transmission unit
122 @param sub_if_id - A number 0-N to uniquely identify this subif on super if
123 @param sub_dot1ad - 0 = dot1q, 1 = dot1ad
124 @param sub_dot1ah - 1 = dot1ah, 0 = otherwise
125 @param sub_number_of_tags - Number of tags (0 - 2)
126 @param sub_outer_vlan_id
127 @param sub_inner_vlan_id
128 @param sub_exact_match
130 @param sub_outer_vlan_id_any
131 @param sub_inner_vlan_id_any
132 @param vtr_op - vlan tag rewrite operation
133 @param vtr_push_dot1q
136 @param pbb_outer_tag - translate pbb s-tag
137 @param pbb_b_dmac[6] - B-tag remote mac address
138 @param pbb_b_smac[6] - B-tag local mac address
139 @param pbb_b_vlanid - B-tag vlanid
140 @param pbb_i_sid - I-tag service id
142 define sw_interface_details
147 /* index of sup interface (e.g. hw interface).
148 equal to sw_if_index for super hw interface. */
151 /* Layer 2 address, if applicable */
152 u32 l2_address_length;
156 u8 interface_name[64];
158 /* 1 = up, 0 = down */
162 /* 1 = half duplex, 2 = full duplex */
165 /* link speed in kbps */
171 /* Per protocol MTUs */
172 u32 mtu[4]; /* 0 - L3, 1 - IP4, 2 - IP6, 3 - MPLS */
174 /* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface */
177 /* 0 = dot1q, 1=dot1ad */
179 /* 1 = dot1h, 1=otherwise */
182 /* Number of tags 0-2 */
183 u8 sub_number_of_tags;
184 u16 sub_outer_vlan_id;
185 u16 sub_inner_vlan_id;
188 u8 sub_outer_vlan_id_any;
189 u8 sub_inner_vlan_id_any;
191 /* vlan tag rewrite state */
193 u32 vtr_push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
194 u32 vtr_tag1; // first pushed tag
195 u32 vtr_tag2; // second pushed tag
198 /* pbb tag rewrite info */
207 define sw_interface_dump
211 u8 name_filter_valid;
215 /** \brief Set or delete one or all ip addresses on a specified interface
216 @param client_index - opaque cookie to identify the sender
217 @param context - sender context, to match reply w/ request
218 @param sw_if_index - index of the interface to add/del addresses
219 @param is_add - add address if non-zero, else delete
220 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
221 @param del_all - if non-zero delete all addresses on the interface
222 @param address_length - address length in bytes, 4 for ip4, 16 for ip6
223 @param address - array of address bytes
225 autoreply define sw_interface_add_del_address
237 /** \brief Associate the specified interface with a fib table
238 @param client_index - opaque cookie to identify the sender
239 @param context - sender context, to match reply w/ request
240 @param sw_if_index - index of the interface
241 @param is_ipv6 - if non-zero ipv6, else ipv4
242 @param vrf_id - fib table/vrd id to associate the interface with
244 autoreply define sw_interface_set_table
253 /** \brief Get VRF id assigned to interface
254 @param client_index - opaque cookie to identify the sender
255 @param context - sender context, to match reply w/ request
256 @param sw_if_index - index of the interface
258 define sw_interface_get_table
266 /** \brief Reply to get_sw_interface_vrf
267 @param context - sender context which was passed in the request
268 @param vrf_id - VRF id assigned to the interface
270 define sw_interface_get_table_reply
277 typeonly manual_print manual_endian define vlib_counter
279 u64 packets; /**< packet counter */
280 u64 bytes; /**< byte counter */
283 /** \brief Combined interface counter data type for vnet_interface_combined_counters
284 @param sw_if_index - interface indexes for counters
285 @param rx_packets - received packet count
286 @param rx_bytes - received byte count
287 @param rx_unicast_packets - received unicast packet count
288 @param rx_unicast_bytes - received unicast byte count
289 @param rx_multicast_packets - received multicast packet count
290 @param rx_multicast_bytes - received multicast byte count
291 @param rx_broadcast_packets - received broadcast packet count
292 @param rx_broadcast_bytes - received broadcast byte count
293 @param tx_packets - transmitted packet count
294 @param tx_bytes - transmitted byte count
295 @param tx_unicast_packets - transmitted unicast packet count
296 @param tx_unicast_bytes - transmitted unicast byte count
297 @param tx_multicast_packets - transmitted multicast packet count
298 @param tx_multicast_bytes - transmitted multicast byte count
299 @param tx_broadcast_packets - transmitted broadcast packet count
300 @param tx_broadcast_bytes - transmitted broadcast byte count
303 typeonly manual_print manual_endian define vnet_combined_counter
306 u64 rx_packets; /**< packet counter */
307 u64 rx_bytes; /**< byte counter */
308 u64 rx_unicast_packets; /**< packet counter */
309 u64 rx_unicast_bytes; /**< byte counter */
310 u64 rx_multicast_packets; /**< packet counter */
311 u64 rx_multicast_bytes; /**< byte counter */
312 u64 rx_broadcast_packets; /**< packet counter */
313 u64 rx_broadcast_bytes; /**< byte counter */
314 u64 tx_packets; /**< packet counter */
315 u64 tx_bytes; /**< byte counter */
316 u64 tx_unicast_packets; /**< packet counter */
317 u64 tx_unicast_bytes; /**< byte counter */
318 u64 tx_multicast_packets; /**< packet counter */
319 u64 tx_multicast_bytes; /**< byte counter */
320 u64 tx_broadcast_packets; /**< packet counter */
321 u64 tx_broadcast_bytes; /**< byte counter */
324 /** \brief Simple interface counter data type for vnet_interface_simple_counters
325 @param sw_if_index - interface indexes for counters
326 @param drop - RX or TX drops due to buffer starvation
327 @param punt - used with VNET "punt" disposition
328 @param rx_ip4 - received IP4 packets
329 @param rx_ip6 - received IP6 packets
330 @param rx_no_buffer - no RX buffers available
331 @param rx_miss - receive misses
332 @param rx_error - receive errors
333 @param tx_error - transmit errors
334 @param rx_mpls - received MPLS packet
337 typeonly manual_print manual_endian define vnet_simple_counter
351 /** \brief Set unnumbered interface add / del request
352 @param client_index - opaque cookie to identify the sender
353 @param context - sender context, to match reply w/ request
354 @param sw_if_index - interface with an IP address
355 @param unnumbered_sw_if_index - interface which will use the address
356 @param is_add - if non-zero set the association, else unset it
358 autoreply define sw_interface_set_unnumbered
362 u32 sw_if_index; /* use this intfc address */
363 u32 unnumbered_sw_if_index; /* on this interface */
367 /** \brief Clear interface statistics
368 @param client_index - opaque cookie to identify the sender
369 @param context - sender context, to match reply w/ request
370 @param sw_if_index - index of the interface to clear statistics
372 autoreply define sw_interface_clear_stats
379 /** \brief Set / clear software interface tag
380 @param client_index - opaque cookie to identify the sender
381 @param context - sender context, to match reply w/ request
382 @param sw_if_index - the interface
383 @param add_del - 1 = add, 0 = delete
384 @param tag - an ascii tag
386 autoreply define sw_interface_tag_add_del
395 /** \brief Set an interface's MAC address
396 @param client_index - opaque cookie to identify the sender
397 @param context - sender context, to match reply w/ request
398 @param sw_if_index - the interface whose MAC will be set
399 @param mac_addr - the new MAC address
401 autoreply define sw_interface_set_mac_address
409 /** \brief Get interface's MAC address
410 @param client_index - opaque cookie to identify the sender
411 @param context - sender context, to match reply w/ request
412 @param sw_if_index - the interface whose MAC will be returned
414 define sw_interface_get_mac_address
421 /** \brief Reply for get interface's MAC address request
422 @param context - returned sender context, to match reply w/ request
423 @param retval - return code
424 @param mac_addr - returned interface's MAC address
426 define sw_interface_get_mac_address_reply
433 /** \brief Set an interface's rx-mode
434 @param client_index - opaque cookie to identify the sender
435 @param context - sender context, to match reply w/ request
436 @param sw_if_index - the interface whose rx-mode will be set
437 @param queue_id_valid - 1 = the queue_id field is valid. 0 means all
439 @param queue_id - the queue number whose rx-mode will be set. Only valid
440 if queue_id_valid is 1
441 @param mode - polling=1, interrupt=2, adaptive=3
443 autoreply define sw_interface_set_rx_mode
453 /** \brief Set an interface's rx-placement
454 Rx-Queue placement on specific thread is operational for only hardware
455 interface. It will not set queue - thread placement for sub-interfaces,
456 p2p and pipe interfaces.
457 @param client_index - opaque cookie to identify the sender
458 @param context - sender context, to match reply w/ request
459 @param sw_if_index - the interface whose rx-placement will be set
460 @param queue_id - the queue number whose rx-placement will be set.
461 @param worker_id - the worker number whom rx-placement will be at.
462 @param is_main - flag to set rx-placement to main thread
464 autoreply define sw_interface_set_rx_placement
474 /** \brief dump the rx queue placement of interface(s)
475 @param sw_if_index - optional interface index for which queue placement to
476 be requested. sw_if_index = ~0 will dump placement information for all
477 interfaces. It will not dump information related to sub-interfaces, p2p
480 define sw_interface_rx_placement_dump
487 /** \brief show the interface's queue - thread placement
488 This api is used to display the interface and queue worker
489 thread placement. One message per rx-queue per interface will
491 Each message will contain information about rx-queue id of an
492 interface, interface index, thread on which this rx-queue is
493 placed and mode of rx-queue.
494 @param client_index - opaque cookie to identify the sender
495 @param context - sender context, to match reply w/ request
496 @param sw_if_index - the interface whose rx-placement will be dumped
497 @param queue_id - the queue id
498 @param worker_id - the worker id on which queue_id is placed,
499 worker_id = 0 means main thread.
500 @param mode - polling=1, interrupt=2, adaptive=3
502 define sw_interface_rx_placement_details
512 /* Gross kludge, DGMS */
513 autoreply define interface_name_renumber
518 u32 new_show_dev_instance;
528 /* These fields map directly onto the subif template */
532 u8 dot1ad; // 0 = dot1q, 1=dot1ad
535 u8 outer_vlan_id_any;
536 u8 inner_vlan_id_any;
541 define create_subif_reply
548 /** \brief Create a new subinterface with the given vlan id
549 @param client_index - opaque cookie to identify the sender
550 @param context - sender context, to match reply w/ request
551 @param sw_if_index - software index of the new vlan's parent interface
552 @param vlan_id - vlan tag of the new interface
554 define create_vlan_subif
562 /** \brief Reply for the vlan subinterface create request
563 @param context - returned sender context, to match reply w/ request
564 @param retval - return code
565 @param sw_if_index - software index allocated for the new subinterface
567 define create_vlan_subif_reply
574 /** \brief Delete sub interface request
575 @param client_index - opaque cookie to identify the sender
576 @param context - sender context, to match reply w/ request
577 @param sw_if_index - sw index of the interface that was created by create_subif
579 autoreply define delete_subif {
585 /** \brief Create loopback interface request
586 @param client_index - opaque cookie to identify the sender
587 @param context - sender context, to match reply w/ request
588 @param mac_address - mac addr to assign to the interface if none-zero
590 define create_loopback
597 /** \brief Create loopback interface response
598 @param context - sender context, to match reply w/ request
599 @param sw_if_index - sw index of the interface that was created
600 @param retval - return code for the request
602 define create_loopback_reply
609 /** \brief Create loopback interface instance request
610 @param client_index - opaque cookie to identify the sender
611 @param context - sender context, to match reply w/ request
612 @param mac_address - mac addr to assign to the interface if none-zero
613 @param is_specified - if non-0, a specific user_instance is being requested
614 @param user_instance - requested instance, ~0 => dynamically allocate
616 define create_loopback_instance
625 /** \brief Create loopback interface instance response
626 @param context - sender context, to match reply w/ request
627 @param sw_if_index - sw index of the interface that was created
628 @param retval - return code for the request
630 define create_loopback_instance_reply
637 /** \brief Delete loopback interface request
638 @param client_index - opaque cookie to identify the sender
639 @param context - sender context, to match reply w/ request
640 @param sw_if_index - sw index of the interface that was created
642 autoreply define delete_loopback
649 /** \brief Enable or disable detailed interface stats
650 @param client_index - opaque cookie to identify the sender
651 @param context - sender context, to match reply w/ request
652 @param sw_if_index - The interface to collect detail stats on. ~0 implies
654 @param enable_disable - set to 1 to enable, 0 to disable detailed stats
656 autoreply define collect_detailed_interface_stats
666 * eval: (c-set-style "gnu")