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;
89 } bond_create_if_args_t;
93 /* slave's sw_if_index */
95 /* bond's sw_if_index */
102 } bond_enslave_args_t;
110 } bond_detach_slave_args_t;
112 /** BOND interface details struct */
117 u8 interface_name[64];
122 } bond_interface_details_t;
124 /** slave interface details struct */
128 u8 interface_name[64];
132 } slave_interface_details_t;
134 typedef CLIB_PACKED (struct
138 u16 key; u16 port_priority; u16 port_number;
144 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
145 u32 buffers[VLIB_FRAME_SIZE];
147 } bond_per_port_queue_t;
151 bond_per_port_queue_t *per_port_queue;
152 } bond_per_thread_data_t;
160 /* the last slave index for the rr lb */
161 u32 lb_rr_last_index;
163 /* Real device instance in interface vector */
166 /* Interface ID being shown to user */
172 /* Configured slaves */
175 /* Slaves that are in DISTRIBUTING state */
178 /* rapidly find an active slave */
179 uword *active_slave_by_sw_if_index;
181 lacp_port_info_t partner;
182 lacp_port_info_t actor;
183 u8 individual_aggregator;
186 uword *port_number_bitmap;
190 clib_spinlock_t lockp;
195 u8 persistent_hw_address[6];
197 /* neighbor's vlib software interface index */
200 /* Neighbor time-to-live (usually 3s) */
203 /* 1 = interface is configured with long timeout (60s) */
206 /* 1 = debug is on; 0 = debug is off */
209 /* tx packet template id for this neighbor */
210 u8 packet_template_index;
212 /* Info we actually keep about each neighbor */
214 /* Jenkins hash optimization: avoid tlv scan, send short keepalive msg */
215 u8 last_packet_signature_valid;
216 uword last_packet_signature;
218 /* last received lacp packet, for the J-hash optimization */
221 /* last marker packet */
224 /* neighbor vlib hw_if_index */
227 /* actor does not initiate the protocol exchange */
230 /* Partner port information */
231 lacp_port_info_t partner;
232 lacp_port_info_t partner_admin;;
234 /* Partner port information */
235 lacp_port_info_t actor;
236 lacp_port_info_t actor_admin;
238 /* Need To Transmit flag */
241 /* Link has been established and Aggregate Port is operable */
244 /* Initialization or reinitialization of the lacp protocol entity */
247 /* Aggregation Port is operating the lacp */
250 /* MUX to indicate to the Selection Logic wait_while_timer expired */
253 /* Selection Logic indicates al Aggregation Ports attached */
256 /* Selection Logic selected an Aggregator */
259 /* RX machine indicates an Aggregation Port in PORT_DISABLED state */
262 /* timer used to detect whether received protocol information has expired */
263 f64 current_while_timer;
265 /* timer used to detect actor churn states */
266 f64 actor_churn_timer;
268 /* time last lacpdu was sent */
269 f64 last_lacpdu_time;
271 /* timer used to generate periodic transmission */
274 /* timer used to detect partner churn states */
275 f64 partner_churn_timer;
277 /* provides hysteresis before performing an aggregation change */
278 f64 wait_while_timer;
280 /* Implemention variables, not in the spec */
286 /* actor admin key */
291 u32 bif_dev_instance;
299 typedef void (*lacp_enable_disable_func) (vlib_main_t * vm, bond_if_t * bif,
300 slave_if_t * sif, u8 enable);
304 /* pool of bonding interfaces */
305 bond_if_t *interfaces;
307 /* record used interface IDs */
310 /* pool of slave interfaces */
311 slave_if_t *neighbors;
313 /* rapidly find a bond by vlib software interface index */
314 uword *bond_by_sw_if_index;
316 /* convenience variables */
317 vlib_main_t *vlib_main;
318 vnet_main_t *vnet_main;
320 /* lacp plugin is loaded */
321 u8 lacp_plugin_loaded;
323 lacp_enable_disable_func lacp_enable_disable;
325 uword *slave_by_sw_if_index;
327 bond_per_thread_data_t *per_thread_data;
330 /* bond packet trace capture */
333 ethernet_header_t ethernet;
335 u32 bond_sw_if_index;
336 } bond_packet_trace_t;
338 typedef u32 (*load_balance_func) (vlib_main_t * vm,
339 vlib_node_runtime_t * node, bond_if_t * bif,
340 vlib_buffer_t * b0, uword slave_count);
344 load_balance_func load_balance;
345 } bond_load_balance_func_t;
347 extern vlib_node_registration_t bond_input_node;
348 extern vlib_node_registration_t bond_process_node;
349 extern vnet_device_class_t bond_dev_class;
350 extern bond_main_t bond_main;
352 void bond_disable_collecting_distributing (vlib_main_t * vm,
354 void bond_enable_collecting_distributing (vlib_main_t * vm, slave_if_t * sif);
355 u8 *format_bond_interface_name (u8 * s, va_list * args);
357 void bond_create_if (vlib_main_t * vm, bond_create_if_args_t * args);
358 int bond_delete_if (vlib_main_t * vm, u32 sw_if_index);
359 void bond_enslave (vlib_main_t * vm, bond_enslave_args_t * args);
360 void bond_detach_slave (vlib_main_t * vm, bond_detach_slave_args_t * args);
361 int bond_dump_ifs (bond_interface_details_t ** out_bondids);
362 int bond_dump_slave_ifs (slave_interface_details_t ** out_slaveids,
363 u32 bond_sw_if_index);
366 unformat_bond_mode (unformat_input_t * input, va_list * args)
368 u8 *r = va_arg (*args, u8 *);
371 #define _(v, f, s) else if (unformat (input, s)) *r = BOND_MODE_##f;
381 format_bond_mode (u8 * s, va_list * args)
383 u32 i = va_arg (*args, u32);
388 #define _(v, f, s) case BOND_MODE_##f: t = (u8 *) s; break;
392 return format (s, "unknown");
394 return format (s, "%s", t);
398 unformat_bond_load_balance (unformat_input_t * input, va_list * args)
400 u8 *r = va_arg (*args, u8 *);
403 #define _(v, f, s, p) else if (unformat (input, s)) *r = BOND_LB_##f;
413 format_bond_load_balance (u8 * s, va_list * args)
415 u32 i = va_arg (*args, u32);
420 #define _(v, f, s, p) case BOND_LB_##f: t = (u8 *) s; break;
424 return format (s, "unknown");
426 return format (s, "%s", t);
430 bond_register_callback (lacp_enable_disable_func func)
432 bond_main_t *bm = &bond_main;
434 bm->lacp_plugin_loaded = 1;
435 bm->lacp_enable_disable = func;
438 static inline bond_if_t *
439 bond_get_master_by_sw_if_index (u32 sw_if_index)
441 bond_main_t *bm = &bond_main;
444 p = hash_get (bm->bond_by_sw_if_index, sw_if_index);
449 return pool_elt_at_index (bm->interfaces, p[0]);
452 static inline bond_if_t *
453 bond_get_master_by_dev_instance (u32 dev_instance)
455 bond_main_t *bm = &bond_main;
457 return pool_elt_at_index (bm->interfaces, dev_instance);
460 static inline slave_if_t *
461 bond_get_slave_by_sw_if_index (u32 sw_if_index)
463 bond_main_t *bm = &bond_main;
467 if (sw_if_index < vec_len (bm->slave_by_sw_if_index))
469 p = bm->slave_by_sw_if_index[sw_if_index];
471 sif = pool_elt_at_index (bm->neighbors, p >> 1);
477 #endif /* __included_vnet_bonding_node_h__ */
480 * fd.io coding-style-patch-verification: ON
483 * eval: (c-set-style "gnu")