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;
120 } bond_set_intf_weight_args_t;
122 /** BOND interface details struct */
127 u8 interface_name[64];
133 } bond_interface_details_t;
135 /** slave interface details struct */
139 u8 interface_name[64];
145 } slave_interface_details_t;
147 typedef CLIB_PACKED (struct
151 u16 key; u16 port_priority; u16 port_number;
157 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
158 u32 buffers[VLIB_FRAME_SIZE];
160 } bond_per_port_queue_t;
164 bond_per_port_queue_t *per_port_queue;
165 } bond_per_thread_data_t;
173 /* the last slave index for the rr lb */
174 u32 lb_rr_last_index;
176 /* Real device instance in interface vector */
179 /* Interface ID being shown to user */
185 /* Configured slaves */
188 /* Slaves that are in DISTRIBUTING state */
191 lacp_port_info_t partner;
192 lacp_port_info_t actor;
193 u8 individual_aggregator;
195 /* If the flag numa_only is set, it means that only slaves
196 on local numa node works for lacp mode if have at least one,
197 otherwise it works as usual. */
200 /* How many slaves on local numa node are there in lacp mode? */
204 uword *port_number_bitmap;
208 clib_spinlock_t lockp;
213 u8 persistent_hw_address[6];
215 /* neighbor's vlib software interface index */
218 /* Neighbor time-to-live (usually 3s) */
221 /* 1 = interface is configured with long timeout (60s) */
224 /* 1 = debug is on; 0 = debug is off */
227 /* tx packet template id for this neighbor */
228 u8 packet_template_index;
230 /* Info we actually keep about each neighbor */
232 /* Jenkins hash optimization: avoid tlv scan, send short keepalive msg */
233 u8 last_packet_signature_valid;
234 uword last_packet_signature;
236 /* last received lacp packet, for the J-hash optimization */
239 /* last marker packet */
242 /* neighbor vlib hw_if_index */
245 /* weight -- valid only for active backup */
248 /* actor does not initiate the protocol exchange */
251 /* Partner port information */
252 lacp_port_info_t partner;
253 lacp_port_info_t partner_admin;;
255 /* Actor port information */
256 lacp_port_info_t actor;
257 lacp_port_info_t actor_admin;
259 /* Need To Transmit flag */
262 /* Link has been established and Aggregate Port is operable */
265 /* Initialization or reinitialization of the lacp protocol entity */
268 /* Aggregation Port is operating the lacp */
271 /* MUX to indicate to the Selection Logic wait_while_timer expired */
274 /* Selection Logic indicates al Aggregation Ports attached */
277 /* Selection Logic selected an Aggregator */
280 /* RX machine indicates an Aggregation Port in PORT_DISABLED state */
283 /* timer used to detect whether received protocol information has expired */
284 f64 current_while_timer;
286 /* timer used to detect actor churn states */
287 f64 actor_churn_timer;
289 /* time last lacpdu was sent */
290 f64 last_lacpdu_sent_time;
292 /* time last lacpdu was received */
293 f64 last_lacpdu_recd_time;
295 /* time last marker pdu was sent */
296 f64 last_marker_pdu_sent_time;
298 /* time last marker pdu was received */
299 f64 last_marker_pdu_recd_time;
301 /* timer used to generate periodic transmission */
304 /* timer used to detect partner churn states */
305 f64 partner_churn_timer;
307 /* provides hysteresis before performing an aggregation change */
308 f64 wait_while_timer;
310 /* Implemention variables, not in the spec */
316 /* actor admin key */
321 u32 bif_dev_instance;
328 /* good lacp pdu received */
331 /* bad lacp pdu received */
332 u64 bad_pdu_received;
337 /* good marker pdu received */
338 u64 marker_pdu_received;
340 /* bad marker pdu received */
341 u64 marker_bad_pdu_received;
346 /* slave is numa node */
350 typedef void (*lacp_enable_disable_func) (vlib_main_t * vm, bond_if_t * bif,
351 slave_if_t * sif, u8 enable);
361 /* pool of bonding interfaces */
362 bond_if_t *interfaces;
364 /* record used interface IDs */
367 /* pool of slave interfaces */
368 slave_if_t *neighbors;
370 /* rapidly find a bond by vlib software interface index */
371 uword *bond_by_sw_if_index;
373 /* convenience variables */
374 vlib_main_t *vlib_main;
375 vnet_main_t *vnet_main;
377 /* lacp plugin is loaded */
378 u8 lacp_plugin_loaded;
380 lacp_enable_disable_func lacp_enable_disable;
382 uword *slave_by_sw_if_index;
384 bond_per_thread_data_t *per_thread_data;
386 lacp_stats_t **stats;
389 /* bond packet trace capture */
392 ethernet_header_t ethernet;
394 u32 bond_sw_if_index;
395 } bond_packet_trace_t;
397 typedef u32 (*load_balance_func) (vlib_main_t * vm,
398 vlib_node_runtime_t * node, bond_if_t * bif,
399 vlib_buffer_t * b0, uword slave_count);
403 load_balance_func load_balance;
404 } bond_load_balance_func_t;
406 extern vlib_node_registration_t bond_input_node;
407 extern vlib_node_registration_t bond_process_node;
408 extern vnet_device_class_t bond_dev_class;
409 extern bond_main_t bond_main;
411 void bond_disable_collecting_distributing (vlib_main_t * vm,
413 void bond_enable_collecting_distributing (vlib_main_t * vm, slave_if_t * sif);
414 u8 *format_bond_interface_name (u8 * s, va_list * args);
416 void bond_set_intf_weight (vlib_main_t * vm,
417 bond_set_intf_weight_args_t * args);
418 void bond_create_if (vlib_main_t * vm, bond_create_if_args_t * args);
419 int bond_delete_if (vlib_main_t * vm, u32 sw_if_index);
420 void bond_enslave (vlib_main_t * vm, bond_enslave_args_t * args);
421 void bond_detach_slave (vlib_main_t * vm, bond_detach_slave_args_t * args);
422 int bond_dump_ifs (bond_interface_details_t ** out_bondids);
423 int bond_dump_slave_ifs (slave_interface_details_t ** out_slaveids,
424 u32 bond_sw_if_index);
427 unformat_bond_mode (unformat_input_t * input, va_list * args)
429 u8 *r = va_arg (*args, u8 *);
432 #define _(v, f, s) else if (unformat (input, s)) *r = BOND_MODE_##f;
442 format_bond_mode (u8 * s, va_list * args)
444 u32 i = va_arg (*args, u32);
449 #define _(v, f, s) case BOND_MODE_##f: t = (u8 *) s; break;
453 return format (s, "unknown");
455 return format (s, "%s", t);
459 unformat_bond_load_balance (unformat_input_t * input, va_list * args)
461 u8 *r = va_arg (*args, u8 *);
464 #define _(v, f, s, p) else if (unformat (input, s)) *r = BOND_LB_##f;
474 format_bond_load_balance (u8 * s, va_list * args)
476 u32 i = va_arg (*args, u32);
481 #define _(v, f, s, p) case BOND_LB_##f: t = (u8 *) s; break;
485 return format (s, "unknown");
487 return format (s, "%s", t);
491 bond_register_callback (lacp_enable_disable_func func)
493 bond_main_t *bm = &bond_main;
495 bm->lacp_plugin_loaded = 1;
496 bm->lacp_enable_disable = func;
499 static inline bond_if_t *
500 bond_get_master_by_sw_if_index (u32 sw_if_index)
502 bond_main_t *bm = &bond_main;
505 p = hash_get (bm->bond_by_sw_if_index, sw_if_index);
510 return pool_elt_at_index (bm->interfaces, p[0]);
513 static inline bond_if_t *
514 bond_get_master_by_dev_instance (u32 dev_instance)
516 bond_main_t *bm = &bond_main;
518 return pool_elt_at_index (bm->interfaces, dev_instance);
521 static inline slave_if_t *
522 bond_get_slave_by_sw_if_index (u32 sw_if_index)
524 bond_main_t *bm = &bond_main;
528 if (sw_if_index < vec_len (bm->slave_by_sw_if_index))
530 p = bm->slave_by_sw_if_index[sw_if_index];
532 sif = pool_elt_at_index (bm->neighbors, p >> 1);
538 #endif /* __included_vnet_bonding_node_h__ */
541 * fd.io coding-style-patch-verification: ON
544 * eval: (c-set-style "gnu")