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 foreach_bond_mode \
35 _ (1, ROUND_ROBIN, "round-robin") \
36 _ (2, ACTIVE_BACKUP, "active-backup") \
38 _ (4, BROADCAST, "broadcast") \
43 #define _(v, f, s) BOND_MODE_##f = v,
48 /* configurable load-balances */
49 #define foreach_bond_lb \
50 _ (2, L23, "l23", l23) \
51 _ (1, l34 , "l34", l34) \
54 /* load-balance functions implemented in bond-output */
55 #define foreach_bond_lb_algo \
57 _ (1, l34 , "l34", l34) \
58 _ (2, L23, "l23", l23) \
59 _ (3, RR, "round-robin", round_robin) \
60 _ (4, BC, "broadcast", broadcast) \
61 _ (5, AB, "active-backup", active_backup)
65 #define _(v, f, s, p) BOND_LB_##f = v,
68 } bond_load_balance_t;
80 } bond_create_if_args_t;
84 /* slave's sw_if_index */
86 /* bond's sw_if_index */
93 } bond_enslave_args_t;
101 } bond_detach_slave_args_t;
103 /** BOND interface details struct */
107 u8 interface_name[64];
112 } bond_interface_details_t;
114 /** slave interface details struct */
118 u8 interface_name[64];
122 } slave_interface_details_t;
124 typedef CLIB_PACKED (struct
128 u16 key; u16 port_priority; u16 port_number;
134 vlib_frame_t **frame;
136 } bond_if_per_thread_t;
144 /* the last slave index for the rr lb */
145 u32 lb_rr_last_index;
151 /* Configured slaves */
154 /* Slaves that are in DISTRIBUTING state */
157 /* rapidly find an active slave */
158 uword *active_slave_by_sw_if_index;
160 lacp_port_info_t partner;
161 lacp_port_info_t actor;
162 u8 individual_aggregator;
165 uword *port_number_bitmap;
169 clib_spinlock_t lockp;
170 bond_if_per_thread_t *per_thread_info;
175 u8 persistent_hw_address[6];
177 /* neighbor's vlib software interface index */
180 /* Neighbor time-to-live (usually 3s) */
183 /* 1 = interface is configured with long timeout (60s) */
186 /* 1 = debug is on; 0 = debug is off */
189 /* tx packet template id for this neighbor */
190 u8 packet_template_index;
192 /* Info we actually keep about each neighbor */
194 /* Jenkins hash optimization: avoid tlv scan, send short keepalive msg */
195 u8 last_packet_signature_valid;
196 uword last_packet_signature;
198 /* last received lacp packet, for the J-hash optimization */
201 /* last marker packet */
204 /* neighbor vlib hw_if_index */
207 /* actor does not initiate the protocol exchange */
210 /* Partner port information */
211 lacp_port_info_t partner;
212 lacp_port_info_t partner_admin;;
214 /* Partner port information */
215 lacp_port_info_t actor;
216 lacp_port_info_t actor_admin;
218 /* Need To Transmit flag */
221 /* Link has been established and Aggregate Port is operable */
224 /* Initialization or reinitialization of the lacp protocol entity */
227 /* Aggregation Port is operating the lacp */
230 /* MUX to indicate to the Selection Logic wait_while_timer expired */
233 /* Selection Logic indicates al Aggregation Ports attached */
236 /* Selection Logic selected an Aggregator */
239 /* RX machine indicates an Aggregation Port in PORT_DISABLED state */
242 /* timer used to detect whether received protocol information has expired */
243 f64 current_while_timer;
245 /* timer used to detect actor churn states */
246 f64 actor_churn_timer;
248 /* time last lacpdu was sent */
249 f64 last_lacpdu_time;
251 /* timer used to generate periodic transmission */
254 /* timer used to detect partner churn states */
255 f64 partner_churn_timer;
257 /* provides hysteresis before performing an aggregation change */
258 f64 wait_while_timer;
260 /* Implemention variables, not in the spec */
266 /* actor admin key */
271 u32 bif_dev_instance;
278 clib_spinlock_t lockp;
281 typedef void (*lacp_enable_disable_func) (vlib_main_t * vm, bond_if_t * bif,
282 slave_if_t * sif, u8 enable);
286 /* pool of bonding interfaces */
287 bond_if_t *interfaces;
289 /* pool of lacp neighbors */
290 slave_if_t *neighbors;
292 /* rapidly find a neighbor by vlib software interface index */
293 uword *neighbor_by_sw_if_index;
295 /* rapidly find a bond by vlib software interface index */
296 uword *bond_by_sw_if_index;
298 /* convenience variables */
299 vlib_main_t *vlib_main;
300 vnet_main_t *vnet_main;
302 /* lacp plugin is loaded */
303 u8 lacp_plugin_loaded;
305 lacp_enable_disable_func lacp_enable_disable;
308 /* bond packet trace capture */
311 ethernet_header_t ethernet;
313 u32 bond_sw_if_index;
314 } bond_packet_trace_t;
316 typedef u32 (*load_balance_func) (vlib_main_t * vm,
317 vlib_node_runtime_t * node, bond_if_t * bif,
318 vlib_buffer_t * b0, uword slave_count);
322 load_balance_func load_balance;
323 } bond_load_balance_func_t;
325 extern vlib_node_registration_t bond_input_node;
326 extern vnet_device_class_t bond_dev_class;
327 extern bond_main_t bond_main;
329 void bond_disable_collecting_distributing (vlib_main_t * vm,
331 void bond_enable_collecting_distributing (vlib_main_t * vm, slave_if_t * sif);
332 u8 *format_bond_interface_name (u8 * s, va_list * args);
334 void bond_create_if (vlib_main_t * vm, bond_create_if_args_t * args);
335 int bond_delete_if (vlib_main_t * vm, u32 sw_if_index);
336 void bond_enslave (vlib_main_t * vm, bond_enslave_args_t * args);
337 void bond_detach_slave (vlib_main_t * vm, bond_detach_slave_args_t * args);
338 int bond_dump_ifs (bond_interface_details_t ** out_bondids);
339 int bond_dump_slave_ifs (slave_interface_details_t ** out_slaveids,
340 u32 bond_sw_if_index);
343 unformat_bond_mode (unformat_input_t * input, va_list * args)
345 u8 *r = va_arg (*args, u8 *);
348 #define _(v, f, s) else if (unformat (input, s)) *r = BOND_MODE_##f;
358 format_bond_mode (u8 * s, va_list * args)
360 u32 i = va_arg (*args, u32);
365 #define _(v, f, s) case BOND_MODE_##f: t = (u8 *) s; break;
369 return format (s, "unknown");
371 return format (s, "%s", t);
375 unformat_bond_load_balance (unformat_input_t * input, va_list * args)
377 u8 *r = va_arg (*args, u8 *);
380 #define _(v, f, s, p) else if (unformat (input, s)) *r = BOND_LB_##f;
390 format_bond_load_balance (u8 * s, va_list * args)
392 u32 i = va_arg (*args, u32);
397 #define _(v, f, s, p) case BOND_LB_##f: t = (u8 *) s; break;
401 return format (s, "unknown");
403 return format (s, "%s", t);
407 bond_register_callback (lacp_enable_disable_func func)
409 bond_main_t *bm = &bond_main;
411 bm->lacp_plugin_loaded = 1;
412 bm->lacp_enable_disable = func;
415 static inline bond_if_t *
416 bond_get_master_by_sw_if_index (u32 sw_if_index)
418 bond_main_t *bm = &bond_main;
421 p = hash_get (bm->bond_by_sw_if_index, sw_if_index);
426 return pool_elt_at_index (bm->interfaces, p[0]);
429 static inline bond_if_t *
430 bond_get_master_by_dev_instance (u32 dev_instance)
432 bond_main_t *bm = &bond_main;
434 return pool_elt_at_index (bm->interfaces, dev_instance);
437 static inline slave_if_t *
438 bond_get_slave_by_sw_if_index (u32 sw_if_index)
440 bond_main_t *bm = &bond_main;
444 p = hash_get (bm->neighbor_by_sw_if_index, sw_if_index);
447 sif = pool_elt_at_index (bm->neighbors, p[0]);
452 #endif /* __included_vnet_bonding_node_h__ */
455 * fd.io coding-style-patch-verification: ON
458 * eval: (c-set-style "gnu")