FD.io VPP  v20.05.1-5-g09f167997
Vector Packet Processing
l2.api
Go to the documentation of this file.
1 /* Hey Emacs use -*- mode: C -*- */
2 /*
3  * Copyright (c) 2016 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:
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16 
17 option version = "3.0.0";
18 
19 import "vnet/ip/ip_types.api";
20 import "vnet/ethernet/ethernet_types.api";
21 import "vnet/interface_types.api";
22 
23 /** \brief Reply to l2_xconnect_dump
24  @param context - sender context which was passed in the request
25  @param rx_sw_if_index - Receive interface index
26  @param tx_sw_if_index - Transmit interface index
27  */
28 define l2_xconnect_details
29 {
31  vl_api_interface_index_t rx_sw_if_index;
32  vl_api_interface_index_t tx_sw_if_index;
33 };
34 
35 /** \brief Dump L2 XConnects
36  @param client_index - opaque cookie to identify the sender
37  @param context - sender context, to match reply w/ request
38 */
39 define l2_xconnect_dump
40 {
43 };
44 
45 /** \brief l2 fib table details structure
46  @param bd_id - the l2 fib / bridge domain table id
47  @param mac - the entry's mac address
48  @param sw_if_index - index of the interface
49  @param static_mac - the entry is statically configured.
50  @param filter_mac - the entry is a mac filter entry.
51  @param bvi_mac - the mac address is a bridge virtual interface
52 */
53 define l2_fib_table_details
54 {
57  vl_api_mac_address_t mac;
58  vl_api_interface_index_t sw_if_index;
59  bool static_mac;
60  bool filter_mac;
61  bool bvi_mac;
62 };
63 
64 /** \brief Dump l2 fib (aka bridge domain) table
65  @param client_index - opaque cookie to identify the sender
66  @param bd_id - the l2 fib / bridge domain table identifier
67 */
68 define l2_fib_table_dump
69 {
73 };
74 
75 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
76  @param client_index - opaque cookie to identify the sender
77  @param context - sender context, to match reply w/ request
78 */
79 autoreply define l2_fib_clear_table
80 {
83 };
84 
85 /** \brief L2 FIB flush all entries
86  @param client_index - opaque cookie to identify the sender
87  @param context - sender context, to match reply w/ request
88 */
89 autoreply define l2fib_flush_all
90 {
93 };
94 
95 /** \brief L2 FIB flush bridge domain entries
96  @param client_index - opaque cookie to identify the sender
97  @param context - sender context, to match reply w/ request
98  @param bd_id - the entry's bridge domain id
99 */
100 autoreply define l2fib_flush_bd
101 {
105 };
106 
107 /** \brief L2 FIB flush interface entries
108  @param client_index - opaque cookie to identify the sender
109  @param context - sender context, to match reply w/ request
110  @param bd_id - the entry's bridge domain id
111 */
112 autoreply define l2fib_flush_int
113 {
116  vl_api_interface_index_t sw_if_index;
117 };
118 
119 /** \brief L2 FIB add entry request
120  @param client_index - opaque cookie to identify the sender
121  @param context - sender context, to match reply w/ request
122  @param mac - the entry's mac address
123  @param bd_id - the entry's bridge domain id
124  @param sw_if_index - the interface
125  @param is_add - If non zero add the entry, else delete it
126  @param static_mac -
127  @param filter_mac -
128  @param bvi_mac -
129 */
130 autoreply define l2fib_add_del
131 {
134  vl_api_mac_address_t mac;
136  vl_api_interface_index_t sw_if_index;
137  bool is_add [default=true];
140  bool bvi_mac;
141 };
142 
143 /** \brief Register to receive L2 MAC events for learned and aged MAC
144  @param client_index - opaque cookie to identify the sender
145  @param context - sender context, to match reply w/ request
146  @param learn_limit - MAC learn limit
147  @param scan_delay - event scan delay in 10 msec unit
148  @param max_macs_in_event - in units of 10 mac entries
149  @param enable_disable - 1 => register for MAC events, 0 => cancel registration
150  @param pid - sender's pid
151 */
152 autoreply define want_l2_macs_events
153 {
156  u32 learn_limit [default=1000];
157  u8 scan_delay [default=10];
158  u8 max_macs_in_event [default=10];
159  bool enable_disable [default=true];
161 };
162 
164 {
168 };
169 
170 /** \brief Entry for learned or aged MAC in L2 MAC Events
171  @param sw_if_index - sw_if_index in the domain
172  @param mac_addr - mac_address
173  @param action - 0 => newly learned MAC, 1 => MAC deleted by ager
174  2 => MAC move (sw_if_index changed)
175  @param flags - flag bits to provide other info, not yet used
176 */
177 typedef mac_entry
178 {
179  vl_api_interface_index_t sw_if_index;
180  vl_api_mac_address_t mac_addr;
181  vl_api_mac_event_action_t action;
183 };
184 
185 /** \brief L2 MAC event for a list of learned or aged MACs
186  @param client_index - opaque cookie to identify the sender
187  @param pid - client pid registered to receive notification
188  @param n_macs - number of learned/aged MAC entries
189  @param mac - array of learned/aged MAC entries
190 */
191 define l2_macs_event
192 {
196  vl_api_mac_entry_t mac[n_macs];
197 };
198 
200  rpc want_l2_macs_events returns want_l2_macs_events_reply
201  events l2_macs_event;
202 };
203 
204 /** \brief Set interface L2 flags (such as L2_LEARN, L2_FWD,
205  L2_FLOOD, L2_UU_FLOOD, or L2_ARP_TERM bits). This can be used
206  to disable one or more of the features represented by the
207  flag bits on an interface to override what is set as default
208  for all interfaces in the bridge domain
209  @param client_index - opaque cookie to identify the sender
210  @param context - sender context, to match reply w/ request
211  @param sw_if_index - interface
212  @param is_set - if non-zero, set the bits, else clear them
213  @param feature_bitmap - non-zero bits (as above) to set or clear
214 */
215 define l2_flags
216 {
219  vl_api_interface_index_t sw_if_index;
220  bool is_set;
222 };
223 
224 /** \brief Set interface L2 flags response
225  @param context - sender context, to match reply w/ request
226  @param retval - return code for the set l2 bits request
227  @param resulting_feature_bitmap - the internal l2 feature bitmap after the request is implemented
228 */
229 define l2_flags_reply
230 {
234 };
235 
236 /** \brief L2 bridge domain set mac age
237  @param client_index - opaque cookie to identify the sender
238  @param context - sender context, to match reply w/ request
239  @param bd_id - the bridge domain to create
240  @param mac_age - mac aging time in min, 0 for disabled
241 */
242 autoreply define bridge_domain_set_mac_age
243 {
248 };
249 
250 /** \brief L2 bridge domain add or delete request
251  @param client_index - opaque cookie to identify the sender
252  @param context - sender context, to match reply w/ request
253  @param bd_id - the bridge domain to create
254  @param flood - enable/disable bcast/mcast flooding in the bd
255  @param uu_flood - enable/disable unknown unicast flood in the bd
256  @param forward - enable/disable forwarding on all interfaces in the bd
257  @param learn - enable/disable learning on all interfaces in the bd
258  @param arp_term - enable/disable arp termination in the bd
259  @param arp_ufwd - enable/disable arp unicast forwarding in the bd
260  @param mac_age - mac aging time in min, 0 for disabled
261  @param is_add - add or delete flag
262 */
263 autoreply define bridge_domain_add_del
264 {
268  bool flood;
269  bool uu_flood;
270  bool forward;
271  bool learn;
272  bool arp_term;
273  bool arp_ufwd;
275  string bd_tag[64];
276  bool is_add [default=true];
277 };
278 
279 /** \brief L2 bridge domain request operational state details
280  @param client_index - opaque cookie to identify the sender
281  @param context - sender context, to match reply w/ request
282  @param bd_id - the bridge domain id desired or ~0 to request all bds
283  @param sw_if_index - filter by sw_if_index UNIMPLEMENTED
284 */
285 define bridge_domain_dump
286 {
289  u32 bd_id [default=0xffffffff];
290  vl_api_interface_index_t sw_if_index [default=0xffffffff];
291 };
292 
293 /** \brief L2 bridge domain sw interface operational state response
294  @param bd_id - the bridge domain id
295  @param sw_if_index - sw_if_index in the domain
296  @param shg - split horizon group for the interface
297 */
298 typedef bridge_domain_sw_if
299 {
300  u32 context;
301  vl_api_interface_index_t sw_if_index;
302  /* FIXME: set_int_l2_mode() u32/ api u8 */
304 };
305 
306 /** \brief L2 bridge domain operational state response
307  @param bd_id - the bridge domain id
308  @param flood - bcast/mcast flooding state on all interfaces in the bd
309  @param uu_flood - unknown unicast flooding state on all interfaces in the bd
310  @param forward - forwarding state on all interfaces in the bd
311  @param learn - learning state on all interfaces in the bd
312  @param arp_term - arp termination state on all interfaces in the bd
313  @param arp_ufwd - arp unicast forwarding state on all interfaces in the bd
314  @param mac_age - mac aging time in min, 0 for disabled
315  @param bd_tag - optional textual tag for the bridge domain
316  @param n_sw_ifs - number of sw_if_index's in the domain
317 */
318 manual_print manual_endian define bridge_domain_details
319 {
322  bool flood;
323  bool uu_flood;
324  bool forward;
325  bool learn;
326  bool arp_term;
327  bool arp_ufwd;
329  string bd_tag[64];
330  vl_api_interface_index_t bvi_sw_if_index;
331  vl_api_interface_index_t uu_fwd_sw_if_index;
333  vl_api_bridge_domain_sw_if_t sw_if_details[n_sw_ifs];
334 };
335 
336 /** \brief Flags that can be changed on a bridge domain */
338 {
346 };
347 
348 /** \brief Set bridge flags request
349  @param client_index - opaque cookie to identify the sender
350  @param context - sender context, to match reply w/ request
351  @param bd_id - the bridge domain to set the flags for
352  @param is_set - if non-zero, set the flags, else clear them
353  @param flags - flags that are non-zero to set or clear
354 */
355 define bridge_flags
356 {
360  bool is_set;
361  vl_api_bd_flags_t flags;
362 };
363 
364 /** \brief Set bridge flags response
365  @param context - sender context, to match reply w/ request
366  @param retval - return code for the set bridge flags request
367  @param resulting_feature_bitmap - the internal L2 feature bitmap after the request is implemented
368 */
369 define bridge_flags_reply
370 {
374 };
375 
376 /** \brief L2 interface vlan tag rewrite configure request
377  @param client_index - opaque cookie to identify the sender
378  @param context - sender context, to match reply w/ request
379  @param sw_if_index - interface the operation is applied to
380  @param vtr_op - Choose from l2_vtr_op_t enum values
381  @param push_dot1q - first pushed flag dot1q id set, else dot1ad
382  @param tag1 - Needed for any push or translate vtr op
383  @param tag2 - Needed for any push 2 or translate x-2 vtr ops
384 */
385 autoreply define l2_interface_vlan_tag_rewrite
386 {
389  vl_api_interface_index_t sw_if_index;
391  u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
392  u32 tag1; // first pushed tag
393  u32 tag2; // second pushed tag
394 };
395 
396 /** \brief L2 interface pbb tag rewrite configure request
397  @param client_index - opaque cookie to identify the sender
398  @param context - sender context, to match reply w/ request
399  @param sw_if_index - interface the operation is applied to
400  @param vtr_op - Choose from l2_vtr_op_t enum values
401  @param inner_tag - needed for translate_qinq vtr op only
402  @param outer_tag - needed for translate_qinq vtr op only
403  @param b_dmac - B-tag remote mac address, needed for any push or translate_qinq vtr op
404  @param b_smac - B-tag local mac address, needed for any push or translate qinq vtr op
405  @param b_vlanid - B-tag vlanid, needed for any push or translate qinq vtr op
406  @param i_sid - I-tag service id, needed for any push or translate qinq vtr op
407 */
408 autoreply define l2_interface_pbb_tag_rewrite
409 {
412  vl_api_interface_index_t sw_if_index;
415  vl_api_mac_address_t b_dmac;
416  vl_api_mac_address_t b_smac;
419 };
420 
421 /** \brief L2 interface patch add / del request
422  @param client_index - opaque cookie to identify the sender
423  @param context - sender context, to match reply w/ request
424  @param rx_sw_if_index - receive side interface
425  @param tx_sw_if_index - transmit side interface
426  @param is_add - if non-zero set up the interface patch, else remove it
427 */
428 autoreply define l2_patch_add_del
429 {
432  vl_api_interface_index_t rx_sw_if_index;
433  vl_api_interface_index_t tx_sw_if_index;
434  bool is_add [default=true];
435 };
436 
437 /** \brief Set L2 XConnect between two interfaces request
438  @param client_index - opaque cookie to identify the sender
439  @param context - sender context, to match reply w/ request
440  @param rx_sw_if_index - Receive interface index
441  @param tx_sw_if_index - Transmit interface index
442  @param enable - enable xconnect if not 0, else set to L3 mode
443 */
444 autoreply define sw_interface_set_l2_xconnect
445 {
448  vl_api_interface_index_t rx_sw_if_index;
449  vl_api_interface_index_t tx_sw_if_index;
450  bool enable [default=true];
451 };
452 
453 /**
454  * @brief An enumeration of the type of ports that can be added
455  * to a bridge domain
456  */
458 {
459  /* a 'normal' interface, i.e. not BVI or UU-Flood */
461  /* a BVI interface in the BD */
463  /* The interface on which to forward unknown unicast packets
464  * If this is not set for a BD then UU is flooded */
466 };
467 
468 /** \brief Interface bridge mode request
469  @param client_index - opaque cookie to identify the sender
470  @param context - sender context, to match reply w/ request
471  @param rx_sw_if_index - the interface
472  @param bd_id - bridge domain id
473  @param port_type - port_mode, see #l2_port_type
474  @param shg - Split horizon group, for bridge mode only
475  @param enable - Enable beige mode if not 0, else set to L3 mode
476 */
477 
478 autoreply define sw_interface_set_l2_bridge
479 {
482  vl_api_interface_index_t rx_sw_if_index;
484  vl_api_l2_port_type_t port_type;
486  bool enable [default=true];
487 };
488 
489 /** \brief Set bridge domain ip to mac entry request
490  @param client_index - opaque cookie to identify the sender
491  @param context - sender context, to match reply w/ request
492  @param bd_id - the bridge domain to set the flags for
493  @param is_add - if non-zero, add the entry, else clear it
494  @param ip - ipv4 or ipv6 address
495  @param mac - MAC address
496 */
497 
498 typedef bd_ip_mac
499 {
500  u32 bd_id;
501  vl_api_address_t ip;
502  vl_api_mac_address_t mac;
503 };
504 
505 autoreply define bd_ip_mac_add_del
506 {
509  bool is_add [default=true];
510  vl_api_bd_ip_mac_t entry;
511 };
512 
513 /** \brief Flush bridge domain IP to MAC entries
514  @param client_index - opaque cookie to identify the sender
515  @param bd_id - bridge domain identifier
516 */
517 autoreply define bd_ip_mac_flush
518 {
522 };
523 
524 /** \brief bridge domain IP to MAC entry details structure
525  @param bd_id - bridge domain table id
526  @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
527  @param ip_address - ipv4 or ipv6 address
528  @param mac_address - MAC address
529 */
530 define bd_ip_mac_details
531 {
533  vl_api_bd_ip_mac_t entry;
534 };
535 
536 /** \brief Dump bridge domain IP to MAC entries
537  @param client_index - opaque cookie to identify the sender
538  @param bd_id - bridge domain identifier
539 */
540 define bd_ip_mac_dump
541 {
545 };
546 
547 /** \brief L2 interface ethernet flow point filtering enable/disable request
548  @param client_index - opaque cookie to identify the sender
549  @param context - sender context, to match reply w/ request
550  @param sw_if_index - interface to enable/disable filtering on
551  @param enable_disable - if non-zero enable filtering, else disable
552 */
553 autoreply define l2_interface_efp_filter
554 {
557  vl_api_interface_index_t sw_if_index;
558  bool enable_disable [default=true];
559 };
560 
561 /** \brief Interface set vpath request
562  @param client_index - opaque cookie to identify the sender
563  @param context - sender context, to match reply w/ request
564  @param sw_if_index - interface used to reach neighbor
565  @param enable - if non-zero enable, else disable
566 */
567 autoreply define sw_interface_set_vpath
568 {
571  vl_api_interface_index_t sw_if_index;
572  bool enable [default=0xffffffff];
573 };
574 
575 /** \brief Create BVI interface instance request
576  @param client_index - opaque cookie to identify the sender
577  @param context - sender context, to match reply w/ request
578  @param mac_address - mac addr to assign to the interface if none-zero
579  @param user_instance - requested instance, ~0 => dynamically allocate
580 */
581 define bvi_create
582 {
585  vl_api_mac_address_t mac;
586  u32 user_instance [default=0xffffffff];
587 };
588 
589 /** \brief Create BVI interface instance response
590  @param context - sender context, to match reply w/ request
591  @param sw_if_index - sw index of the interface that was created
592  @param retval - return code for the request
593 */
594 define bvi_create_reply
595 {
598  vl_api_interface_index_t sw_if_index;
599 };
600 
601 /** \brief Delete BVI interface request
602  @param client_index - opaque cookie to identify the sender
603  @param context - sender context, to match reply w/ request
604  @param sw_if_index - sw index of the interface that was created
605 */
606 autoreply define bvi_delete
607 {
610  vl_api_interface_index_t sw_if_index;
611 };
612 
613 /** \brief Register for IP4 ARP resolution event on receiving ARP reply or
614  MAC/IP info from ARP requests in L2 BDs
615  @param client_index - opaque cookie to identify the sender
616  @param context - sender context, to match reply w/ request
617  @param enable - 1 => register for events, 0 => cancel registration
618  @param pid - sender's pid
619 */
620 autoreply define want_l2_arp_term_events
621 {
624  bool enable;
626 };
627 
628 /** \brief Tell client about an IP4 ARP resolution event or
629  MAC/IP info from ARP requests in L2 BDs
630  @param client_index - opaque cookie to identify the sender
631  @param pid - client pid registered to receive notification
632  @param ip - IP address of new ARP term entry
633  @param sw_if_index - interface of new ARP term entry
634  @param mac - MAC address of new ARP term entry
635 */
636 define l2_arp_term_event
637 {
640  vl_api_address_t ip;
641  vl_api_interface_index_t sw_if_index;
642  vl_api_mac_address_t mac;
643 };
644 
645 service {
646  rpc want_l2_arp_term_events returns want_l2_arp_term_events_reply
647  events l2_arp_term_event;
648 };
649 
650 /*
651  * Local Variables:
652  * eval: (c-set-style "gnu")
653  * End:
654  */
vl_api_mac_address_t b_smac
Definition: l2.api:416
vl_api_mac_address_t mac
Definition: l2.api:57
vl_api_address_t ip
Definition: l2.api:640
vl_api_interface_index_t sw_if_index
Definition: l2.api:301
vl_api_bd_ip_mac_t entry
Definition: l2.api:533
vl_api_mac_address_t mac
Definition: l2.api:502
vl_api_l2_port_type_t port_type
Definition: l2.api:484
vl_api_mac_address_t mac
Definition: l2.api:642
vl_api_interface_index_t sw_if_index
Definition: l2.api:598
typedef bd_ip_mac
Set bridge domain ip to mac entry request.
Definition: l2.api:499
vl_api_interface_index_t sw_if_index
Definition: l2.api:557
l2_port_type
An enumeration of the type of ports that can be added to a bridge domain.
Definition: l2.api:457
vl_api_interface_index_t rx_sw_if_index
Definition: l2.api:31
vl_api_interface_index_t sw_if_index
Definition: l2.api:412
vl_api_interface_index_t rx_sw_if_index
Definition: l2.api:482
unsigned char u8
Definition: types.h:56
option version
Definition: l2.api:17
mac_event_action
Definition: l2.api:163
u8 shg
Definition: l2.api:303
u32 feature_bitmap
Definition: l2.api:221
u8 flags
Definition: l2.api:182
vl_api_interface_index_t sw_if_index
Definition: l2.api:641
unsigned int u32
Definition: types.h:88
vl_api_interface_index_t tx_sw_if_index
Definition: l2.api:32
vl_api_mac_address_t mac
Definition: l2.api:134
vl_api_interface_index_t sw_if_index
Definition: l2.api:389
vl_api_interface_index_t uu_fwd_sw_if_index
Definition: l2.api:331
vl_api_interface_index_t sw_if_index
Definition: l2.api:571
u32 client_index
Definition: l2.api:217
u32 bd_id
Definition: gbp.api:175
unsigned short u16
Definition: types.h:57
vl_api_interface_index_t sw_if_index
Definition: l2.api:116
vl_api_interface_index_t tx_sw_if_index
Definition: l2.api:449
vl_api_interface_index_t sw_if_index
Definition: l2.api:219
vl_api_interface_index_t sw_if_index
Definition: l2.api:610
vl_api_interface_index_t sw_if_index
Definition: l2.api:58
typedef mac_entry
Entry for learned or aged MAC in L2 MAC Events.
Definition: l2.api:178
vl_api_interface_index_t bvi_sw_if_index
Definition: l2.api:330
vl_api_interface_index_t tx_sw_if_index
Definition: l2.api:433
typedef bridge_domain_sw_if
L2 bridge domain sw interface operational state response.
Definition: l2.api:299
vl_api_interface_index_t rx_sw_if_index
Definition: l2.api:432
signed int i32
Definition: types.h:77
vl_api_interface_index_t rx_sw_if_index
Definition: l2.api:448
service
Definition: l2.api:199
u32 resulting_feature_bitmap
Definition: l2.api:233
vl_api_interface_index_t sw_if_index
Definition: l2.api:136
vl_api_address_t ip
Definition: l2.api:501
vl_api_bd_flags_t flags
Definition: l2.api:361
vl_api_mac_event_action_t action
Definition: l2.api:181
vl_api_mac_address_t mac_addr
Definition: l2.api:180
vl_api_mac_address_t b_dmac
Definition: l2.api:415
vl_api_bd_ip_mac_t entry
Definition: l2.api:510
bd_flags
Flags that can be changed on a bridge domain.
Definition: l2.api:337
vl_api_mac_address_t mac
Definition: l2.api:585