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.3.1";
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
80 /** \brief Interface Event generated by want_interface_events
81 @param client_index - opaque cookie to identify the sender
82 @param pid - client pid registered to receive notification
83 @param sw_if_index - index of the interface of the event
84 @param admin_up_down - The administrative state; 1 = up, 0 = down
85 @param link_up_down - The operational state; 1 = up, 0 = down
86 @param deleted - interface was deleted
88 define sw_interface_event
98 /** \brief Register for interface events
99 @param client_index - opaque cookie to identify the sender
100 @param context - sender context, to match reply w/ request
101 @param enable_disable - 1 => register for events, 0 => cancel registration
102 @param pid - sender's pid
104 autoreply define want_interface_events
112 /** \brief Interface details structure (fix this)
113 @param sw_if_index - index of the interface
114 @param sup_sw_if_index - index of parent interface if any, else same as sw_if_index
115 @param l2_address_length - length of the interface's l2 address
116 @param l2_address - the interface's l2 address
117 @param interface_name - name of the interface
118 @param link_duplex - 1 if half duplex, 2 if full duplex
119 @param link_speed - value in kbps
120 @param link_MTU - max. transmission unit
121 @param sub_if_id - A number 0-N to uniquely identify this subif on super if
122 @param sub_dot1ad - 0 = dot1q, 1 = dot1ad
123 @param sub_dot1ah - 1 = dot1ah, 0 = otherwise
124 @param sub_number_of_tags - Number of tags (0 - 2)
125 @param sub_outer_vlan_id
126 @param sub_inner_vlan_id
127 @param sub_exact_match
129 @param sub_outer_vlan_id_any
130 @param sub_inner_vlan_id_any
131 @param vtr_op - vlan tag rewrite operation
132 @param vtr_push_dot1q
135 @param pbb_outer_tag - translate pbb s-tag
136 @param pbb_b_dmac[6] - B-tag remote mac address
137 @param pbb_b_smac[6] - B-tag local mac address
138 @param pbb_b_vlanid - B-tag vlanid
139 @param pbb_i_sid - I-tag service id
141 define sw_interface_details
146 /* index of sup interface (e.g. hw interface).
147 equal to sw_if_index for super hw interface. */
150 /* Layer 2 address, if applicable */
151 u32 l2_address_length;
155 u8 interface_name[64];
157 /* 1 = up, 0 = down */
161 /* 1 = half duplex, 2 = full duplex */
164 /* link speed in kbps */
170 /* Per protocol MTUs */
171 u32 mtu[4]; /* 0 - L3, 1 - IP4, 2 - IP6, 3 - MPLS */
173 /* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface */
176 /* 0 = dot1q, 1=dot1ad */
178 /* 1 = dot1h, 1=otherwise */
181 /* Number of tags 0-2 */
182 u8 sub_number_of_tags;
183 u16 sub_outer_vlan_id;
184 u16 sub_inner_vlan_id;
187 u8 sub_outer_vlan_id_any;
188 u8 sub_inner_vlan_id_any;
190 /* vlan tag rewrite state */
192 u32 vtr_push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
193 u32 vtr_tag1; // first pushed tag
194 u32 vtr_tag2; // second pushed tag
197 /* pbb tag rewrite info */
205 /** \brief Request all or filtered subset of sw_interface_details
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 to dump info on, 0 or ~0 if on all
209 TODO: Support selecting only index==0 when CSIT is ready.
210 @param name_filter_valid - 1 if requesting a filtered subset of records else 0
211 if name filter is set as valid, sw_if_index value is ignored and all interfaces are examined
212 @param name_filter - interface name substring filter. Eg. loop1 returns [loop1, loop10]
214 define sw_interface_dump
218 vl_api_interface_index_t sw_if_index;
219 u8 name_filter_valid;
223 /** \brief Set or delete one or all ip addresses on a specified interface
224 @param client_index - opaque cookie to identify the sender
225 @param context - sender context, to match reply w/ request
226 @param sw_if_index - index of the interface to add/del addresses
227 @param is_add - add address if non-zero, else delete
228 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
229 @param del_all - if non-zero delete all addresses on the interface
230 @param address_length - address length in bytes, 4 for ip4, 16 for ip6
231 @param address - array of address bytes
233 autoreply define sw_interface_add_del_address
245 /** \brief Associate the specified interface with a fib table
246 @param client_index - opaque cookie to identify the sender
247 @param context - sender context, to match reply w/ request
248 @param sw_if_index - index of the interface
249 @param is_ipv6 - if non-zero ipv6, else ipv4
250 @param vrf_id - fib table/vrf id to associate the interface with
252 autoreply define sw_interface_set_table
261 /** \brief Get VRF id assigned to interface
262 @param client_index - opaque cookie to identify the sender
263 @param context - sender context, to match reply w/ request
264 @param sw_if_index - index of the interface
266 define sw_interface_get_table
274 /** \brief Reply to get_sw_interface_vrf
275 @param context - sender context which was passed in the request
276 @param vrf_id - VRF id assigned to the interface
278 define sw_interface_get_table_reply
285 /** \brief Set unnumbered interface add / del request
286 @param client_index - opaque cookie to identify the sender
287 @param context - sender context, to match reply w/ request
288 @param sw_if_index - interface with an IP address
289 @param unnumbered_sw_if_index - interface which will use the address
290 @param is_add - if non-zero set the association, else unset it
292 autoreply define sw_interface_set_unnumbered
296 u32 sw_if_index; /* use this intfc address */
297 u32 unnumbered_sw_if_index; /* on this interface */
301 /** \brief Clear interface statistics
302 @param client_index - opaque cookie to identify the sender
303 @param context - sender context, to match reply w/ request
304 @param sw_if_index - index of the interface to clear statistics
306 autoreply define sw_interface_clear_stats
313 /** \brief Set / clear software interface tag
314 @param client_index - opaque cookie to identify the sender
315 @param context - sender context, to match reply w/ request
316 @param sw_if_index - the interface
317 @param add_del - 1 = add, 0 = delete
318 @param tag - an ascii tag
320 autoreply define sw_interface_tag_add_del
329 /** \brief Set an interface's MAC address
330 @param client_index - opaque cookie to identify the sender
331 @param context - sender context, to match reply w/ request
332 @param sw_if_index - the interface whose MAC will be set
333 @param mac_addr - the new MAC address
335 autoreply define sw_interface_set_mac_address
343 /** \brief Get interface's MAC address
344 @param client_index - opaque cookie to identify the sender
345 @param context - sender context, to match reply w/ request
346 @param sw_if_index - the interface whose MAC will be returned
348 define sw_interface_get_mac_address
355 /** \brief Reply for get interface's MAC address request
356 @param context - returned sender context, to match reply w/ request
357 @param retval - return code
358 @param mac_addr - returned interface's MAC address
360 define sw_interface_get_mac_address_reply
367 /** \brief Set an interface's rx-mode
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 - the interface whose rx-mode will be set
371 @param queue_id_valid - 1 = the queue_id field is valid. 0 means all
373 @param queue_id - the queue number whose rx-mode will be set. Only valid
374 if queue_id_valid is 1
375 @param mode - polling=1, interrupt=2, adaptive=3
377 autoreply define sw_interface_set_rx_mode
387 /** \brief Set an interface's rx-placement
388 Rx-Queue placement on specific thread is operational for only hardware
389 interface. It will not set queue - thread placement for sub-interfaces,
390 p2p and pipe interfaces.
391 @param client_index - opaque cookie to identify the sender
392 @param context - sender context, to match reply w/ request
393 @param sw_if_index - the interface whose rx-placement will be set
394 @param queue_id - the queue number whose rx-placement will be set.
395 @param worker_id - the worker number whom rx-placement will be at.
396 @param is_main - flag to set rx-placement to main thread
398 autoreply define sw_interface_set_rx_placement
408 /** \brief dump the rx queue placement of interface(s)
409 @param sw_if_index - optional interface index for which queue placement to
410 be requested. sw_if_index = ~0 will dump placement information for all
411 interfaces. It will not dump information related to sub-interfaces, p2p
414 define sw_interface_rx_placement_dump
421 /** \brief show the interface's queue - thread placement
422 This api is used to display the interface and queue worker
423 thread placement. One message per rx-queue per interface will
425 Each message will contain information about rx-queue id of an
426 interface, interface index, thread on which this rx-queue is
427 placed and mode of rx-queue.
428 @param client_index - opaque cookie to identify the sender
429 @param context - sender context, to match reply w/ request
430 @param sw_if_index - the interface whose rx-placement will be dumped
431 @param queue_id - the queue id
432 @param worker_id - the worker id on which queue_id is placed,
433 worker_id = 0 means main thread.
434 @param mode - polling=1, interrupt=2, adaptive=3
436 define sw_interface_rx_placement_details
446 /* Gross kludge, DGMS */
447 autoreply define interface_name_renumber
452 u32 new_show_dev_instance;
462 /* These fields map directly onto the subif template */
466 u8 dot1ad; // 0 = dot1q, 1=dot1ad
469 u8 outer_vlan_id_any;
470 u8 inner_vlan_id_any;
475 define create_subif_reply
482 /** \brief Create a new subinterface with the given vlan id
483 @param client_index - opaque cookie to identify the sender
484 @param context - sender context, to match reply w/ request
485 @param sw_if_index - software index of the new vlan's parent interface
486 @param vlan_id - vlan tag of the new interface
488 define create_vlan_subif
496 /** \brief Reply for the vlan subinterface create request
497 @param context - returned sender context, to match reply w/ request
498 @param retval - return code
499 @param sw_if_index - software index allocated for the new subinterface
501 define create_vlan_subif_reply
508 /** \brief Delete sub interface request
509 @param client_index - opaque cookie to identify the sender
510 @param context - sender context, to match reply w/ request
511 @param sw_if_index - sw index of the interface that was created by create_subif
513 autoreply define delete_subif {
519 /** \brief Create loopback interface request
520 @param client_index - opaque cookie to identify the sender
521 @param context - sender context, to match reply w/ request
522 @param mac_address - mac addr to assign to the interface if none-zero
524 define create_loopback
531 /** \brief Create loopback interface response
532 @param context - sender context, to match reply w/ request
533 @param sw_if_index - sw index of the interface that was created
534 @param retval - return code for the request
536 define create_loopback_reply
543 /** \brief Create loopback interface instance request
544 @param client_index - opaque cookie to identify the sender
545 @param context - sender context, to match reply w/ request
546 @param mac_address - mac addr to assign to the interface if none-zero
547 @param is_specified - if non-0, a specific user_instance is being requested
548 @param user_instance - requested instance, ~0 => dynamically allocate
550 define create_loopback_instance
559 /** \brief Create loopback interface instance response
560 @param context - sender context, to match reply w/ request
561 @param sw_if_index - sw index of the interface that was created
562 @param retval - return code for the request
564 define create_loopback_instance_reply
571 /** \brief Delete loopback interface request
572 @param client_index - opaque cookie to identify the sender
573 @param context - sender context, to match reply w/ request
574 @param sw_if_index - sw index of the interface that was created
576 autoreply define delete_loopback
583 /** \brief Enable or disable detailed interface stats
584 @param client_index - opaque cookie to identify the sender
585 @param context - sender context, to match reply w/ request
586 @param sw_if_index - The interface to collect detail stats on. ~0 implies
588 @param enable_disable - set to 1 to enable, 0 to disable detailed stats
590 autoreply define collect_detailed_interface_stats
600 * eval: (c-set-style "gnu")