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;
90 } bond_create_if_args_t;
94 /* slave's sw_if_index */
96 /* bond's sw_if_index */
103 } bond_enslave_args_t;
111 } bond_detach_slave_args_t;
113 /** BOND interface details struct */
118 u8 interface_name[64];
124 } bond_interface_details_t;
126 /** slave interface details struct */
130 u8 interface_name[64];
134 } slave_interface_details_t;
136 typedef CLIB_PACKED (struct
140 u16 key; u16 port_priority; u16 port_number;
146 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
147 u32 buffers[VLIB_FRAME_SIZE];
149 } bond_per_port_queue_t;
153 bond_per_port_queue_t *per_port_queue;
154 } bond_per_thread_data_t;
162 /* This flag works for active-backup mode only
163 and marks if the working port is local numa. */
165 /* current working sw_if_index in active-bakeup mode. */
166 u32 sw_if_index_working;
167 /* the last slave index for the rr lb */
168 u32 lb_rr_last_index;
170 /* Real device instance in interface vector */
173 /* Interface ID being shown to user */
179 /* Configured slaves */
182 /* Slaves that are in DISTRIBUTING state */
185 /* rapidly find an active slave */
186 uword *active_slave_by_sw_if_index;
188 lacp_port_info_t partner;
189 lacp_port_info_t actor;
190 u8 individual_aggregator;
192 /* If the flag numa_only is set, it means that only slaves
193 on local numa node works for lacp mode if have at least one,
194 otherwise it works as usual. */
197 /* How many slaves on local numa node are there in lacp mode? */
201 uword *port_number_bitmap;
205 clib_spinlock_t lockp;
210 u8 persistent_hw_address[6];
212 /* neighbor's vlib software interface index */
215 /* Neighbor time-to-live (usually 3s) */
218 /* 1 = interface is configured with long timeout (60s) */
221 /* 1 = debug is on; 0 = debug is off */
224 /* tx packet template id for this neighbor */
225 u8 packet_template_index;
227 /* Info we actually keep about each neighbor */
229 /* Jenkins hash optimization: avoid tlv scan, send short keepalive msg */
230 u8 last_packet_signature_valid;
231 uword last_packet_signature;
233 /* last received lacp packet, for the J-hash optimization */
236 /* last marker packet */
239 /* neighbor vlib hw_if_index */
242 /* actor does not initiate the protocol exchange */
245 /* Partner port information */
246 lacp_port_info_t partner;
247 lacp_port_info_t partner_admin;;
249 /* Actor port information */
250 lacp_port_info_t actor;
251 lacp_port_info_t actor_admin;
253 /* Need To Transmit flag */
256 /* Link has been established and Aggregate Port is operable */
259 /* Initialization or reinitialization of the lacp protocol entity */
262 /* Aggregation Port is operating the lacp */
265 /* MUX to indicate to the Selection Logic wait_while_timer expired */
268 /* Selection Logic indicates al Aggregation Ports attached */
271 /* Selection Logic selected an Aggregator */
274 /* RX machine indicates an Aggregation Port in PORT_DISABLED state */
277 /* timer used to detect whether received protocol information has expired */
278 f64 current_while_timer;
280 /* timer used to detect actor churn states */
281 f64 actor_churn_timer;
283 /* time last lacpdu was sent */
284 f64 last_lacpdu_sent_time;
286 /* time last lacpdu was received */
287 f64 last_lacpdu_recd_time;
289 /* time last marker pdu was sent */
290 f64 last_marker_pdu_sent_time;
292 /* time last marker pdu was received */
293 f64 last_marker_pdu_recd_time;
295 /* timer used to generate periodic transmission */
298 /* timer used to detect partner churn states */
299 f64 partner_churn_timer;
301 /* provides hysteresis before performing an aggregation change */
302 f64 wait_while_timer;
304 /* Implemention variables, not in the spec */
310 /* actor admin key */
315 u32 bif_dev_instance;
322 /* good lacp pdu received */
325 /* bad lacp pdu received */
326 u64 bad_pdu_received;
331 /* good marker pdu received */
332 u64 marker_pdu_received;
334 /* bad marker pdu received */
335 u64 marker_bad_pdu_received;
341 typedef void (*lacp_enable_disable_func) (vlib_main_t * vm, bond_if_t * bif,
342 slave_if_t * sif, u8 enable);
346 /* pool of bonding interfaces */
347 bond_if_t *interfaces;
349 /* record used interface IDs */
352 /* pool of slave interfaces */
353 slave_if_t *neighbors;
355 /* rapidly find a bond by vlib software interface index */
356 uword *bond_by_sw_if_index;
358 /* convenience variables */
359 vlib_main_t *vlib_main;
360 vnet_main_t *vnet_main;
362 /* lacp plugin is loaded */
363 u8 lacp_plugin_loaded;
365 lacp_enable_disable_func lacp_enable_disable;
367 uword *slave_by_sw_if_index;
369 bond_per_thread_data_t *per_thread_data;
374 /* bond packet trace capture */
377 ethernet_header_t ethernet;
379 u32 bond_sw_if_index;
380 } bond_packet_trace_t;
382 typedef u32 (*load_balance_func) (vlib_main_t * vm,
383 vlib_node_runtime_t * node, bond_if_t * bif,
384 vlib_buffer_t * b0, uword slave_count);
388 load_balance_func load_balance;
389 } bond_load_balance_func_t;
391 extern vlib_node_registration_t bond_input_node;
392 extern vlib_node_registration_t bond_process_node;
393 extern vnet_device_class_t bond_dev_class;
394 extern bond_main_t bond_main;
396 void bond_disable_collecting_distributing (vlib_main_t * vm,
398 void bond_enable_collecting_distributing (vlib_main_t * vm, slave_if_t * sif);
399 u8 *format_bond_interface_name (u8 * s, va_list * args);
401 void bond_create_if (vlib_main_t * vm, bond_create_if_args_t * args);
402 int bond_delete_if (vlib_main_t * vm, u32 sw_if_index);
403 void bond_enslave (vlib_main_t * vm, bond_enslave_args_t * args);
404 void bond_detach_slave (vlib_main_t * vm, bond_detach_slave_args_t * args);
405 int bond_dump_ifs (bond_interface_details_t ** out_bondids);
406 int bond_dump_slave_ifs (slave_interface_details_t ** out_slaveids,
407 u32 bond_sw_if_index);
410 unformat_bond_mode (unformat_input_t * input, va_list * args)
412 u8 *r = va_arg (*args, u8 *);
415 #define _(v, f, s) else if (unformat (input, s)) *r = BOND_MODE_##f;
425 format_bond_mode (u8 * s, va_list * args)
427 u32 i = va_arg (*args, u32);
432 #define _(v, f, s) case BOND_MODE_##f: t = (u8 *) s; break;
436 return format (s, "unknown");
438 return format (s, "%s", t);
442 unformat_bond_load_balance (unformat_input_t * input, va_list * args)
444 u8 *r = va_arg (*args, u8 *);
447 #define _(v, f, s, p) else if (unformat (input, s)) *r = BOND_LB_##f;
457 format_bond_load_balance (u8 * s, va_list * args)
459 u32 i = va_arg (*args, u32);
464 #define _(v, f, s, p) case BOND_LB_##f: t = (u8 *) s; break;
468 return format (s, "unknown");
470 return format (s, "%s", t);
474 bond_register_callback (lacp_enable_disable_func func)
476 bond_main_t *bm = &bond_main;
478 bm->lacp_plugin_loaded = 1;
479 bm->lacp_enable_disable = func;
482 static inline bond_if_t *
483 bond_get_master_by_sw_if_index (u32 sw_if_index)
485 bond_main_t *bm = &bond_main;
488 p = hash_get (bm->bond_by_sw_if_index, sw_if_index);
493 return pool_elt_at_index (bm->interfaces, p[0]);
496 static inline bond_if_t *
497 bond_get_master_by_dev_instance (u32 dev_instance)
499 bond_main_t *bm = &bond_main;
501 return pool_elt_at_index (bm->interfaces, dev_instance);
504 static inline slave_if_t *
505 bond_get_slave_by_sw_if_index (u32 sw_if_index)
507 bond_main_t *bm = &bond_main;
511 if (sw_if_index < vec_len (bm->slave_by_sw_if_index))
513 p = bm->slave_by_sw_if_index[sw_if_index];
515 sif = pool_elt_at_index (bm->neighbors, p >> 1);
521 #endif /* __included_vnet_bonding_node_h__ */
524 * fd.io coding-style-patch-verification: ON
527 * eval: (c-set-style "gnu")