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 */
206 /** \brief Request all or filtered subset of sw_interface_details
207 @param client_index - opaque cookie to identify the sender
208 @param context - sender context, to match reply w/ request
209 @param name_filter_valid - 1 if requesting a filtered subset of records else 0
210 @param name_filter - interface name substring filter. Eg. loop1 returns [loop1, loop10]
213 define sw_interface_dump
217 u8 name_filter_valid;
221 /** \brief Set or delete one or all ip addresses on a specified 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 to add/del addresses
225 @param is_add - add address if non-zero, else delete
226 @param is_ipv6 - if non-zero the address is ipv6, else ipv4
227 @param del_all - if non-zero delete all addresses on the interface
228 @param address_length - address length in bytes, 4 for ip4, 16 for ip6
229 @param address - array of address bytes
231 autoreply define sw_interface_add_del_address
243 /** \brief Associate the specified interface with a fib table
244 @param client_index - opaque cookie to identify the sender
245 @param context - sender context, to match reply w/ request
246 @param sw_if_index - index of the interface
247 @param is_ipv6 - if non-zero ipv6, else ipv4
248 @param vrf_id - fib table/vrd id to associate the interface with
250 autoreply define sw_interface_set_table
259 /** \brief Get VRF id assigned to interface
260 @param client_index - opaque cookie to identify the sender
261 @param context - sender context, to match reply w/ request
262 @param sw_if_index - index of the interface
264 define sw_interface_get_table
272 /** \brief Reply to get_sw_interface_vrf
273 @param context - sender context which was passed in the request
274 @param vrf_id - VRF id assigned to the interface
276 define sw_interface_get_table_reply
283 /** \brief Set unnumbered interface add / del request
284 @param client_index - opaque cookie to identify the sender
285 @param context - sender context, to match reply w/ request
286 @param sw_if_index - interface with an IP address
287 @param unnumbered_sw_if_index - interface which will use the address
288 @param is_add - if non-zero set the association, else unset it
290 autoreply define sw_interface_set_unnumbered
294 u32 sw_if_index; /* use this intfc address */
295 u32 unnumbered_sw_if_index; /* on this interface */
299 /** \brief Clear interface statistics
300 @param client_index - opaque cookie to identify the sender
301 @param context - sender context, to match reply w/ request
302 @param sw_if_index - index of the interface to clear statistics
304 autoreply define sw_interface_clear_stats
311 /** \brief Set / clear software interface tag
312 @param client_index - opaque cookie to identify the sender
313 @param context - sender context, to match reply w/ request
314 @param sw_if_index - the interface
315 @param add_del - 1 = add, 0 = delete
316 @param tag - an ascii tag
318 autoreply define sw_interface_tag_add_del
327 /** \brief Set an interface's MAC address
328 @param client_index - opaque cookie to identify the sender
329 @param context - sender context, to match reply w/ request
330 @param sw_if_index - the interface whose MAC will be set
331 @param mac_addr - the new MAC address
333 autoreply define sw_interface_set_mac_address
341 /** \brief Get interface's MAC address
342 @param client_index - opaque cookie to identify the sender
343 @param context - sender context, to match reply w/ request
344 @param sw_if_index - the interface whose MAC will be returned
346 define sw_interface_get_mac_address
353 /** \brief Reply for get interface's MAC address request
354 @param context - returned sender context, to match reply w/ request
355 @param retval - return code
356 @param mac_addr - returned interface's MAC address
358 define sw_interface_get_mac_address_reply
365 /** \brief Set an interface's rx-mode
366 @param client_index - opaque cookie to identify the sender
367 @param context - sender context, to match reply w/ request
368 @param sw_if_index - the interface whose rx-mode will be set
369 @param queue_id_valid - 1 = the queue_id field is valid. 0 means all
371 @param queue_id - the queue number whose rx-mode will be set. Only valid
372 if queue_id_valid is 1
373 @param mode - polling=1, interrupt=2, adaptive=3
375 autoreply define sw_interface_set_rx_mode
385 /** \brief Set an interface's rx-placement
386 Rx-Queue placement on specific thread is operational for only hardware
387 interface. It will not set queue - thread placement for sub-interfaces,
388 p2p and pipe interfaces.
389 @param client_index - opaque cookie to identify the sender
390 @param context - sender context, to match reply w/ request
391 @param sw_if_index - the interface whose rx-placement will be set
392 @param queue_id - the queue number whose rx-placement will be set.
393 @param worker_id - the worker number whom rx-placement will be at.
394 @param is_main - flag to set rx-placement to main thread
396 autoreply define sw_interface_set_rx_placement
406 /** \brief dump the rx queue placement of interface(s)
407 @param sw_if_index - optional interface index for which queue placement to
408 be requested. sw_if_index = ~0 will dump placement information for all
409 interfaces. It will not dump information related to sub-interfaces, p2p
412 define sw_interface_rx_placement_dump
419 /** \brief show the interface's queue - thread placement
420 This api is used to display the interface and queue worker
421 thread placement. One message per rx-queue per interface will
423 Each message will contain information about rx-queue id of an
424 interface, interface index, thread on which this rx-queue is
425 placed and mode of rx-queue.
426 @param client_index - opaque cookie to identify the sender
427 @param context - sender context, to match reply w/ request
428 @param sw_if_index - the interface whose rx-placement will be dumped
429 @param queue_id - the queue id
430 @param worker_id - the worker id on which queue_id is placed,
431 worker_id = 0 means main thread.
432 @param mode - polling=1, interrupt=2, adaptive=3
434 define sw_interface_rx_placement_details
444 /* Gross kludge, DGMS */
445 autoreply define interface_name_renumber
450 u32 new_show_dev_instance;
460 /* These fields map directly onto the subif template */
464 u8 dot1ad; // 0 = dot1q, 1=dot1ad
467 u8 outer_vlan_id_any;
468 u8 inner_vlan_id_any;
473 define create_subif_reply
480 /** \brief Create a new subinterface with the given vlan id
481 @param client_index - opaque cookie to identify the sender
482 @param context - sender context, to match reply w/ request
483 @param sw_if_index - software index of the new vlan's parent interface
484 @param vlan_id - vlan tag of the new interface
486 define create_vlan_subif
494 /** \brief Reply for the vlan subinterface create request
495 @param context - returned sender context, to match reply w/ request
496 @param retval - return code
497 @param sw_if_index - software index allocated for the new subinterface
499 define create_vlan_subif_reply
506 /** \brief Delete sub interface request
507 @param client_index - opaque cookie to identify the sender
508 @param context - sender context, to match reply w/ request
509 @param sw_if_index - sw index of the interface that was created by create_subif
511 autoreply define delete_subif {
517 /** \brief Create loopback interface request
518 @param client_index - opaque cookie to identify the sender
519 @param context - sender context, to match reply w/ request
520 @param mac_address - mac addr to assign to the interface if none-zero
522 define create_loopback
529 /** \brief Create loopback interface response
530 @param context - sender context, to match reply w/ request
531 @param sw_if_index - sw index of the interface that was created
532 @param retval - return code for the request
534 define create_loopback_reply
541 /** \brief Create loopback interface instance request
542 @param client_index - opaque cookie to identify the sender
543 @param context - sender context, to match reply w/ request
544 @param mac_address - mac addr to assign to the interface if none-zero
545 @param is_specified - if non-0, a specific user_instance is being requested
546 @param user_instance - requested instance, ~0 => dynamically allocate
548 define create_loopback_instance
557 /** \brief Create loopback interface instance response
558 @param context - sender context, to match reply w/ request
559 @param sw_if_index - sw index of the interface that was created
560 @param retval - return code for the request
562 define create_loopback_instance_reply
569 /** \brief Delete loopback interface request
570 @param client_index - opaque cookie to identify the sender
571 @param context - sender context, to match reply w/ request
572 @param sw_if_index - sw index of the interface that was created
574 autoreply define delete_loopback
581 /** \brief Enable or disable detailed interface stats
582 @param client_index - opaque cookie to identify the sender
583 @param context - sender context, to match reply w/ request
584 @param sw_if_index - The interface to collect detail stats on. ~0 implies
586 @param enable_disable - set to 1 to enable, 0 to disable detailed stats
588 autoreply define collect_detailed_interface_stats
598 * eval: (c-set-style "gnu")