2 * Copyright (c) 2017 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
15 #ifndef __included_vnet_bonding_node_h__
16 #define __included_vnet_bonding_node_h__
18 #include <vlib/vlib.h>
19 #include <vlib/unix/unix.h>
20 #include <vppinfra/format.h>
21 #include <vppinfra/hash.h>
22 #include <vnet/ethernet/ethernet.h>
23 #include <vnet/interface.h>
25 #define LACP_FAST_PERIODIC_TIMER 1.0
26 #define LACP_SHORT_TIMOUT_TIME (LACP_FAST_PERIODIC_TIMER * 3)
27 #define LACP_SLOW_PERIODIC_TIMER 30.0
28 #define LACP_LONG_TIMOUT_TIME (LACP_SLOW_PERIODIC_TIMER * 3)
31 #define MIN(x,y) (((x)<(y))?(x):(y))
34 #define BOND_MODULO_SHORTCUT(a) \
37 #define foreach_bond_mode \
38 _ (1, ROUND_ROBIN, "round-robin") \
39 _ (2, ACTIVE_BACKUP, "active-backup") \
41 _ (4, BROADCAST, "broadcast") \
46 #define _(v, f, s) BOND_MODE_##f = v,
51 /* configurable load-balances */
52 #define foreach_bond_lb \
53 _ (2, L23, "l23", l23) \
54 _ (1, L34 , "l34", l34) \
57 /* load-balance functions implemented in bond-output */
58 #define foreach_bond_lb_algo \
60 _ (1, L34 , "l34", l34) \
61 _ (2, L23, "l23", l23) \
62 _ (3, RR, "round-robin", round_robin) \
63 _ (4, BC, "broadcast", broadcast) \
64 _ (5, AB, "active-backup", active_backup)
68 #define _(v, f, s, p) BOND_LB_##f = v,
71 } bond_load_balance_t;
75 BOND_SEND_GARP_NA = 1,
76 } bond_send_garp_na_process_event_t;
88 } bond_create_if_args_t;
92 /* slave's sw_if_index */
94 /* bond's sw_if_index */
101 } bond_enslave_args_t;
109 } bond_detach_slave_args_t;
111 /** BOND interface details struct */
115 u8 interface_name[64];
120 } bond_interface_details_t;
122 /** slave interface details struct */
126 u8 interface_name[64];
130 } slave_interface_details_t;
132 typedef CLIB_PACKED (struct
136 u16 key; u16 port_priority; u16 port_number;
142 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
143 u32 buffers[VLIB_FRAME_SIZE];
145 } bond_per_port_queue_t;
149 bond_per_port_queue_t *per_port_queue;
150 } bond_per_thread_data_t;
158 /* the last slave index for the rr lb */
159 u32 lb_rr_last_index;
165 /* Configured slaves */
168 /* Slaves that are in DISTRIBUTING state */
171 /* rapidly find an active slave */
172 uword *active_slave_by_sw_if_index;
174 lacp_port_info_t partner;
175 lacp_port_info_t actor;
176 u8 individual_aggregator;
179 uword *port_number_bitmap;
183 clib_spinlock_t lockp;
188 u8 persistent_hw_address[6];
190 /* neighbor's vlib software interface index */
193 /* Neighbor time-to-live (usually 3s) */
196 /* 1 = interface is configured with long timeout (60s) */
199 /* 1 = debug is on; 0 = debug is off */
202 /* tx packet template id for this neighbor */
203 u8 packet_template_index;
205 /* Info we actually keep about each neighbor */
207 /* Jenkins hash optimization: avoid tlv scan, send short keepalive msg */
208 u8 last_packet_signature_valid;
209 uword last_packet_signature;
211 /* last received lacp packet, for the J-hash optimization */
214 /* last marker packet */
217 /* neighbor vlib hw_if_index */
220 /* actor does not initiate the protocol exchange */
223 /* Partner port information */
224 lacp_port_info_t partner;
225 lacp_port_info_t partner_admin;;
227 /* Partner port information */
228 lacp_port_info_t actor;
229 lacp_port_info_t actor_admin;
231 /* Need To Transmit flag */
234 /* Link has been established and Aggregate Port is operable */
237 /* Initialization or reinitialization of the lacp protocol entity */
240 /* Aggregation Port is operating the lacp */
243 /* MUX to indicate to the Selection Logic wait_while_timer expired */
246 /* Selection Logic indicates al Aggregation Ports attached */
249 /* Selection Logic selected an Aggregator */
252 /* RX machine indicates an Aggregation Port in PORT_DISABLED state */
255 /* timer used to detect whether received protocol information has expired */
256 f64 current_while_timer;
258 /* timer used to detect actor churn states */
259 f64 actor_churn_timer;
261 /* time last lacpdu was sent */
262 f64 last_lacpdu_time;
264 /* timer used to generate periodic transmission */
267 /* timer used to detect partner churn states */
268 f64 partner_churn_timer;
270 /* provides hysteresis before performing an aggregation change */
271 f64 wait_while_timer;
273 /* Implemention variables, not in the spec */
279 /* actor admin key */
284 u32 bif_dev_instance;
292 typedef void (*lacp_enable_disable_func) (vlib_main_t * vm, bond_if_t * bif,
293 slave_if_t * sif, u8 enable);
297 /* pool of bonding interfaces */
298 bond_if_t *interfaces;
300 /* pool of slave interfaces */
301 slave_if_t *neighbors;
303 /* rapidly find a bond by vlib software interface index */
304 uword *bond_by_sw_if_index;
306 /* convenience variables */
307 vlib_main_t *vlib_main;
308 vnet_main_t *vnet_main;
310 /* lacp plugin is loaded */
311 u8 lacp_plugin_loaded;
313 lacp_enable_disable_func lacp_enable_disable;
315 uword *slave_by_sw_if_index;
317 bond_per_thread_data_t *per_thread_data;
320 /* bond packet trace capture */
323 ethernet_header_t ethernet;
325 u32 bond_sw_if_index;
326 } bond_packet_trace_t;
328 typedef u32 (*load_balance_func) (vlib_main_t * vm,
329 vlib_node_runtime_t * node, bond_if_t * bif,
330 vlib_buffer_t * b0, uword slave_count);
334 load_balance_func load_balance;
335 } bond_load_balance_func_t;
337 extern vlib_node_registration_t bond_input_node;
338 extern vlib_node_registration_t bond_process_node;
339 extern vnet_device_class_t bond_dev_class;
340 extern bond_main_t bond_main;
342 void bond_disable_collecting_distributing (vlib_main_t * vm,
344 void bond_enable_collecting_distributing (vlib_main_t * vm, slave_if_t * sif);
345 u8 *format_bond_interface_name (u8 * s, va_list * args);
347 void bond_create_if (vlib_main_t * vm, bond_create_if_args_t * args);
348 int bond_delete_if (vlib_main_t * vm, u32 sw_if_index);
349 void bond_enslave (vlib_main_t * vm, bond_enslave_args_t * args);
350 void bond_detach_slave (vlib_main_t * vm, bond_detach_slave_args_t * args);
351 int bond_dump_ifs (bond_interface_details_t ** out_bondids);
352 int bond_dump_slave_ifs (slave_interface_details_t ** out_slaveids,
353 u32 bond_sw_if_index);
356 unformat_bond_mode (unformat_input_t * input, va_list * args)
358 u8 *r = va_arg (*args, u8 *);
361 #define _(v, f, s) else if (unformat (input, s)) *r = BOND_MODE_##f;
371 format_bond_mode (u8 * s, va_list * args)
373 u32 i = va_arg (*args, u32);
378 #define _(v, f, s) case BOND_MODE_##f: t = (u8 *) s; break;
382 return format (s, "unknown");
384 return format (s, "%s", t);
388 unformat_bond_load_balance (unformat_input_t * input, va_list * args)
390 u8 *r = va_arg (*args, u8 *);
393 #define _(v, f, s, p) else if (unformat (input, s)) *r = BOND_LB_##f;
403 format_bond_load_balance (u8 * s, va_list * args)
405 u32 i = va_arg (*args, u32);
410 #define _(v, f, s, p) case BOND_LB_##f: t = (u8 *) s; break;
414 return format (s, "unknown");
416 return format (s, "%s", t);
420 bond_register_callback (lacp_enable_disable_func func)
422 bond_main_t *bm = &bond_main;
424 bm->lacp_plugin_loaded = 1;
425 bm->lacp_enable_disable = func;
428 static inline bond_if_t *
429 bond_get_master_by_sw_if_index (u32 sw_if_index)
431 bond_main_t *bm = &bond_main;
434 p = hash_get (bm->bond_by_sw_if_index, sw_if_index);
439 return pool_elt_at_index (bm->interfaces, p[0]);
442 static inline bond_if_t *
443 bond_get_master_by_dev_instance (u32 dev_instance)
445 bond_main_t *bm = &bond_main;
447 return pool_elt_at_index (bm->interfaces, dev_instance);
450 static inline slave_if_t *
451 bond_get_slave_by_sw_if_index (u32 sw_if_index)
453 bond_main_t *bm = &bond_main;
457 if (sw_if_index < vec_len (bm->slave_by_sw_if_index))
459 p = bm->slave_by_sw_if_index[sw_if_index];
461 sif = pool_elt_at_index (bm->neighbors, p >> 1);
467 #endif /* __included_vnet_bonding_node_h__ */
470 * fd.io coding-style-patch-verification: ON
473 * eval: (c-set-style "gnu")