FD.io VPP  v19.01.3-6-g70449b9b9
Vector Packet Processing
node.h
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 #ifndef __included_vnet_bonding_node_h__
16 #define __included_vnet_bonding_node_h__
17 
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>
24 
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)
29 
30 #ifndef MIN
31 #define MIN(x,y) (((x)<(y))?(x):(y))
32 #endif
33 
34 #define BOND_MODULO_SHORTCUT(a) \
35  (is_pow2 (a))
36 
37 #define foreach_bond_mode \
38  _ (1, ROUND_ROBIN, "round-robin") \
39  _ (2, ACTIVE_BACKUP, "active-backup") \
40  _ (3, XOR, "xor") \
41  _ (4, BROADCAST, "broadcast") \
42  _ (5, LACP, "lacp")
43 
44 typedef enum
45 {
46 #define _(v, f, s) BOND_MODE_##f = v,
48 #undef _
49 } bond_mode_t;
50 
51 /* configurable load-balances */
52 #define foreach_bond_lb \
53  _ (2, L23, "l23", l23) \
54  _ (1, L34 , "l34", l34) \
55  _ (0, L2, "l2", l2)
56 
57 /* load-balance functions implemented in bond-output */
58 #define foreach_bond_lb_algo \
59  _ (0, L2, "l2", l2) \
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)
65 
66 typedef enum
67 {
68 #define _(v, f, s, p) BOND_LB_##f = v,
70 #undef _
72 
73 enum
74 {
77 
78 typedef struct
79 {
82  u8 hw_addr[6];
84  u8 lb;
85  /* return */
87  int rv;
90 
91 typedef struct
92 {
93  /* slave's sw_if_index */
95  /* bond's sw_if_index */
99  /* return */
100  int rv;
103 
104 typedef struct
105 {
107  /* return */
108  int rv;
111 
112 /** BOND interface details struct */
113 typedef struct
114 {
117  u8 interface_name[64];
123 
124 /** slave interface details struct */
125 typedef struct
126 {
128  u8 interface_name[64];
133 
134 typedef CLIB_PACKED (struct
135  {
136  u16 system_priority;
137  u8 system[6];
138  u16 key; u16 port_priority; u16 port_number;
139  u8 state;
140  }) lacp_port_info_t;
141 
142 typedef struct
143 {
144  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
148 
149 typedef struct
150 {
153 
154 typedef struct
155 {
159 
160  /* the last slave index for the rr lb */
162 
163  /* Real device instance in interface vector */
165 
166  /* Interface ID being shown to user */
168 
171 
172  /* Configured slaves */
174 
175  /* Slaves that are in DISTRIBUTING state */
177 
178  /* rapidly find an active slave */
180 
181  lacp_port_info_t partner;
182  lacp_port_info_t actor;
184 
188  u8 hw_address[6];
189 
191 } bond_if_t;
192 
193 typedef struct
194 {
195  u8 persistent_hw_address[6];
196 
197  /* neighbor's vlib software interface index */
199 
200  /* Neighbor time-to-live (usually 3s) */
202 
203  /* 1 = interface is configured with long timeout (60s) */
205 
206  /* 1 = debug is on; 0 = debug is off */
208 
209  /* tx packet template id for this neighbor */
211 
212  /* Info we actually keep about each neighbor */
213 
214  /* Jenkins hash optimization: avoid tlv scan, send short keepalive msg */
217 
218  /* last received lacp packet, for the J-hash optimization */
220 
221  /* last marker packet */
223 
224  /* neighbor vlib hw_if_index */
226 
227  /* actor does not initiate the protocol exchange */
229 
230  /* Partner port information */
231  lacp_port_info_t partner;
232  lacp_port_info_t partner_admin;;
233 
234  /* Partner port information */
235  lacp_port_info_t actor;
236  lacp_port_info_t actor_admin;
237 
238  /* Need To Transmit flag */
240 
241  /* Link has been established and Aggregate Port is operable */
243 
244  /* Initialization or reinitialization of the lacp protocol entity */
246 
247  /* Aggregation Port is operating the lacp */
249 
250  /* MUX to indicate to the Selection Logic wait_while_timer expired */
252 
253  /* Selection Logic indicates al Aggregation Ports attached */
255 
256  /* Selection Logic selected an Aggregator */
257  int selected;
258 
259  /* RX machine indicates an Aggregation Port in PORT_DISABLED state */
261 
262  /* timer used to detect whether received protocol information has expired */
264 
265  /* timer used to detect actor churn states */
267 
268  /* time last lacpdu was sent */
270 
271  /* timer used to generate periodic transmission */
273 
274  /* timer used to detect partner churn states */
276 
277  /* provides hysteresis before performing an aggregation change */
279 
280  /* Implemention variables, not in the spec */
281  int rx_state;
282  int tx_state;
285 
286  /* actor admin key */
288 
290 
292 
294 
295  /* bond mode */
297 } slave_if_t;
298 
300  slave_if_t * sif, u8 enable);
301 
302 typedef struct
303 {
304  /* pool of bonding interfaces */
306 
307  /* record used interface IDs */
309 
310  /* pool of slave interfaces */
312 
313  /* rapidly find a bond by vlib software interface index */
315 
316  /* convenience variables */
319 
320  /* lacp plugin is loaded */
322 
324 
326 
328 } bond_main_t;
329 
330 /* bond packet trace capture */
331 typedef struct
332 {
337 
339  vlib_node_runtime_t * node, bond_if_t * bif,
340  vlib_buffer_t * b0, uword slave_count);
341 
342 typedef struct
343 {
346 
350 extern bond_main_t bond_main;
351 
353  slave_if_t * sif);
355 u8 *format_bond_interface_name (u8 * s, va_list * args);
356 
359 void bond_enslave (vlib_main_t * vm, bond_enslave_args_t * args);
361 int bond_dump_ifs (bond_interface_details_t ** out_bondids);
363  u32 bond_sw_if_index);
364 
365 static inline uword
366 unformat_bond_mode (unformat_input_t * input, va_list * args)
367 {
368  u8 *r = va_arg (*args, u8 *);
369 
370  if (0);
371 #define _(v, f, s) else if (unformat (input, s)) *r = BOND_MODE_##f;
373 #undef _
374  else
375  return 0;
376 
377  return 1;
378 }
379 
380 static inline u8 *
381 format_bond_mode (u8 * s, va_list * args)
382 {
383  u32 i = va_arg (*args, u32);
384  u8 *t = 0;
385 
386  switch (i)
387  {
388 #define _(v, f, s) case BOND_MODE_##f: t = (u8 *) s; break;
390 #undef _
391  default:
392  return format (s, "unknown");
393  }
394  return format (s, "%s", t);
395 }
396 
397 static inline uword
399 {
400  u8 *r = va_arg (*args, u8 *);
401 
402  if (0);
403 #define _(v, f, s, p) else if (unformat (input, s)) *r = BOND_LB_##f;
405 #undef _
406  else
407  return 0;
408 
409  return 1;
410 }
411 
412 static inline u8 *
413 format_bond_load_balance (u8 * s, va_list * args)
414 {
415  u32 i = va_arg (*args, u32);
416  u8 *t = 0;
417 
418  switch (i)
419  {
420 #define _(v, f, s, p) case BOND_LB_##f: t = (u8 *) s; break;
422 #undef _
423  default:
424  return format (s, "unknown");
425  }
426  return format (s, "%s", t);
427 }
428 
429 static inline void
431 {
432  bond_main_t *bm = &bond_main;
433 
434  bm->lacp_plugin_loaded = 1;
435  bm->lacp_enable_disable = func;
436 }
437 
438 static inline bond_if_t *
440 {
441  bond_main_t *bm = &bond_main;
442  uword *p;
443 
444  p = hash_get (bm->bond_by_sw_if_index, sw_if_index);
445  if (!p)
446  {
447  return 0;
448  }
449  return pool_elt_at_index (bm->interfaces, p[0]);
450 }
451 
452 static inline bond_if_t *
454 {
455  bond_main_t *bm = &bond_main;
456 
457  return pool_elt_at_index (bm->interfaces, dev_instance);
458 }
459 
460 static inline slave_if_t *
462 {
463  bond_main_t *bm = &bond_main;
464  slave_if_t *sif = 0;
465  uword p;
466 
467  if (sw_if_index < vec_len (bm->slave_by_sw_if_index))
468  {
470  if (p)
471  sif = pool_elt_at_index (bm->neighbors, p >> 1);
472  }
473 
474  return sif;
475 }
476 
477 #endif /* __included_vnet_bonding_node_h__ */
478 
479 /*
480  * fd.io coding-style-patch-verification: ON
481  *
482  * Local Variables:
483  * eval: (c-set-style "gnu")
484  * End:
485  */
vnet_main_t * vnet_main
Definition: node.h:318
bond_mode_t
Definition: node.h:44
u32 dev_instance
Definition: node.h:164
u32 group
Definition: node.h:185
u32 hw_if_index
Definition: node.h:169
static uword unformat_bond_mode(unformat_input_t *input, va_list *args)
Definition: node.h:366
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
u8 individual_aggregator
Definition: node.h:183
int selected
Definition: node.h:257
u8 last_packet_signature_valid
Definition: node.h:215
u8 lb
Definition: node.h:158
clib_error_t * error
Definition: node.h:88
uword * id_used
Definition: node.h:308
static bond_if_t * bond_get_master_by_sw_if_index(u32 sw_if_index)
Definition: node.h:439
u8 is_long_timeout
Definition: node.h:98
u8 * last_marker_pkt
Definition: node.h:222
void(* lacp_enable_disable_func)(vlib_main_t *vm, bond_if_t *bif, slave_if_t *sif, u8 enable)
Definition: node.h:299
int tx_state
Definition: node.h:282
int i
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
lacp_enable_disable_func lacp_enable_disable
Definition: node.h:323
struct _vnet_device_class vnet_device_class_t
u32 id
Definition: node.h:167
f64 current_while_timer
Definition: node.h:263
u8 mode
Definition: node.h:296
unsigned char u8
Definition: types.h:56
f64 last_lacpdu_time
Definition: node.h:269
bond_per_thread_data_t * per_thread_data
Definition: node.h:327
#define foreach_bond_lb
Definition: node.h:52
u8 ntt
Definition: node.h:239
double f64
Definition: types.h:142
f64 periodic_timer
Definition: node.h:272
u32(* load_balance_func)(vlib_main_t *vm, vlib_node_runtime_t *node, bond_if_t *bif, vlib_buffer_t *b0, uword slave_count)
Definition: node.h:338
static void bond_register_callback(lacp_enable_disable_func func)
Definition: node.h:430
f32 ttl_in_seconds
Definition: node.h:201
u32 sw_if_index
Definition: vxlan_gbp.api:37
u8 use_custom_mac
Definition: node.h:187
bond_main_t bond_main
Definition: node.c:24
u32 sw_if_index
Definition: node.h:170
uword * active_slave_by_sw_if_index
Definition: node.h:179
vlib_main_t * vlib_main
Definition: node.h:317
lacp_port_info_t actor
Definition: node.h:182
vhost_vring_state_t state
Definition: vhost_user.h:120
unsigned int u32
Definition: types.h:88
u32 lb_rr_last_index
Definition: node.h:161
f64 partner_churn_timer
Definition: node.h:275
enum @53 bond_send_garp_na_process_event_t
#define VLIB_FRAME_SIZE
Definition: node.h:401
void bond_create_if(vlib_main_t *vm, bond_create_if_args_t *args)
Definition: cli.c:243
u8 * last_rx_pkt
Definition: node.h:219
bond_load_balance_t
Definition: node.h:66
#define hash_get(h, key)
Definition: hash.h:249
vnet_device_class_t bond_dev_class
u8 ready
Definition: node.h:254
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:511
u8 admin_up
Definition: node.h:156
int bond_delete_if(vlib_main_t *vm, u32 sw_if_index)
Definition: cli.c:194
struct _unformat_input_t unformat_input_t
unsigned short u16
Definition: types.h:57
u8 port_moved
Definition: node.h:260
static uword unformat_bond_load_balance(unformat_input_t *input, va_list *args)
Definition: node.h:398
bond_if_t * interfaces
Definition: node.h:305
vlib_node_registration_t bond_input_node
(constructor) VLIB_REGISTER_NODE (bond_input_node)
Definition: node.c:363
u8 is_long_timeout
Definition: node.h:204
int ptx_state
Definition: node.h:284
u32 marker_tx_id
Definition: node.h:289
u32 * slaves
Definition: node.h:173
u8 is_passive
Definition: node.h:228
u8 mode
Definition: node.h:157
u32 sw_if_index
Definition: node.h:198
vlib_main_t * vm
Definition: buffer.c:301
lacp_port_info_t partner
Definition: node.h:231
uword * bond_by_sw_if_index
Definition: node.h:314
ethernet_header_t ethernet
Definition: node.h:333
u32 group
Definition: node.h:287
clib_spinlock_t lockp
Definition: node.h:190
int rx_state
Definition: node.h:281
void bond_detach_slave(vlib_main_t *vm, bond_detach_slave_args_t *args)
Definition: cli.c:625
BOND interface details struct.
Definition: node.h:113
#define foreach_bond_lb_algo
Definition: node.h:58
void bond_enable_collecting_distributing(vlib_main_t *vm, slave_if_t *sif)
Definition: cli.c:59
typedef CLIB_PACKED(struct { u16 system_priority;u8 system[6];u16 key;u16 port_priority;u16 port_number;u8 state;}) lacp_port_info_t
uword * slave_by_sw_if_index
Definition: node.h:325
u8 loopback_port
Definition: node.h:293
u8 lacp_plugin_loaded
Definition: node.h:321
static bond_if_t * bond_get_master_by_dev_instance(u32 dev_instance)
Definition: node.h:453
u32 bif_dev_instance
Definition: node.h:291
u8 debug
Definition: node.h:207
u32 * active_slaves
Definition: node.h:176
u8 ready_n
Definition: node.h:251
clib_error_t * error
Definition: node.h:101
float f32
Definition: types.h:143
clib_error_t * error
Definition: node.h:109
int bond_dump_ifs(bond_interface_details_t **out_bondids)
Definition: cli.c:82
struct _vlib_node_registration vlib_node_registration_t
u8 lacp_enabled
Definition: node.h:248
u8 begin
Definition: node.h:245
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
u8 * format_bond_interface_name(u8 *s, va_list *args)
Definition: device.c:69
uword * port_number_bitmap
Definition: node.h:186
u64 uword
Definition: types.h:112
lacp_port_info_t partner_admin
Definition: node.h:232
static u8 * format_bond_mode(u8 *s, va_list *args)
Definition: node.h:381
slave interface details struct
Definition: node.h:125
#define foreach_bond_mode
Definition: node.h:37
void bond_disable_collecting_distributing(vlib_main_t *vm, slave_if_t *sif)
Definition: cli.c:25
slave_if_t * neighbors
Definition: node.h:311
f64 actor_churn_timer
Definition: node.h:266
static u8 * format_bond_load_balance(u8 *s, va_list *args)
Definition: node.h:413
u8 port_enabled
Definition: node.h:242
vlib_node_registration_t bond_process_node
(constructor) VLIB_REGISTER_NODE (bond_process_node)
Definition: device.c:791
static slave_if_t * bond_get_slave_by_sw_if_index(u32 sw_if_index)
Definition: node.h:461
void bond_enslave(vlib_main_t *vm, bond_enslave_args_t *args)
Definition: cli.c:436
lacp_port_info_t actor_admin
Definition: node.h:236
u32 bond_sw_if_index
Definition: node.h:335
uword last_packet_signature
Definition: node.h:216
u8 packet_template_index
Definition: node.h:210
f64 wait_while_timer
Definition: node.h:278
int bond_dump_slave_ifs(slave_interface_details_t **out_slaveids, u32 bond_sw_if_index)
Definition: cli.c:114
load_balance_func load_balance
Definition: node.h:344
u32 hw_if_index
Definition: node.h:225
int mux_state
Definition: node.h:283
bond_per_port_queue_t * per_port_queue
Definition: node.h:151
lacp_port_info_t partner
Definition: node.h:181