2 *------------------------------------------------------------------
3 * Copyright (c) 2017 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
20 #include <vnet/ethernet/ethernet.h>
21 #include <vnet/ip/ip4_packet.h>
22 #include <vnet/ip/ip6_packet.h>
23 #include <vnet/ip/ip6_hop_by_hop_packet.h>
24 #include <vnet/bonding/node.h>
25 #include <vppinfra/lb_hash_hash.h>
26 #include <vnet/ip/ip.h>
27 #include <vnet/ethernet/arp_packet.h>
29 #define foreach_bond_tx_error \
31 _(IF_DOWN, "interface down") \
32 _(NO_SLAVE, "no slave")
36 #define _(f,s) BOND_TX_ERROR_##f,
42 static char *bond_tx_error_strings[] = {
49 format_bond_tx_trace (u8 * s, va_list * args)
51 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
52 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
53 bond_packet_trace_t *t = va_arg (*args, bond_packet_trace_t *);
54 vnet_hw_interface_t *hw, *hw1;
55 vnet_main_t *vnm = vnet_get_main ();
57 hw = vnet_get_sup_hw_interface (vnm, t->sw_if_index);
58 hw1 = vnet_get_sup_hw_interface (vnm, t->bond_sw_if_index);
59 s = format (s, "src %U, dst %U, %s -> %s",
60 format_ethernet_address, t->ethernet.src_address,
61 format_ethernet_address, t->ethernet.dst_address,
67 #ifndef CLIB_MARCH_VARIANT
69 format_bond_interface_name (u8 * s, va_list * args)
71 u32 dev_instance = va_arg (*args, u32);
72 bond_main_t *bm = &bond_main;
73 bond_if_t *bif = pool_elt_at_index (bm->interfaces, dev_instance);
75 s = format (s, "BondEthernet%lu", bif->dev_instance);
81 static __clib_unused clib_error_t *
82 bond_set_l2_mode_function (vnet_main_t * vnm,
83 struct vnet_hw_interface_t *bif_hw,
88 struct vnet_hw_interface_t *sif_hw;
90 bif = bond_get_master_by_sw_if_index (bif_hw->sw_if_index);
94 if ((bif_hw->l2_if_count == 1) && (l2_if_adjust == 1))
96 /* Just added first L2 interface on this port */
97 vec_foreach (sw_if_index, bif->slaves)
99 sif_hw = vnet_get_sup_hw_interface (vnm, *sw_if_index);
100 ethernet_set_flags (vnm, sif_hw->hw_if_index,
101 ETHERNET_INTERFACE_FLAG_ACCEPT_ALL);
103 /* ensure all packets go to ethernet-input */
104 ethernet_set_rx_redirect (vnm, sif_hw, 1);
111 static __clib_unused clib_error_t *
112 bond_subif_add_del_function (vnet_main_t * vnm, u32 hw_if_index,
113 struct vnet_sw_interface_t *st, int is_add)
115 /* Nothing for now */
119 static clib_error_t *
120 bond_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
122 vnet_hw_interface_t *hif = vnet_get_hw_interface (vnm, hw_if_index);
123 uword is_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
124 bond_main_t *bm = &bond_main;
125 bond_if_t *bif = pool_elt_at_index (bm->interfaces, hif->dev_instance);
127 bif->admin_up = is_up;
128 if (is_up && vec_len (bif->active_slaves))
129 vnet_hw_interface_set_flags (vnm, bif->hw_if_index,
130 VNET_HW_INTERFACE_FLAG_LINK_UP);
134 static_always_inline u32
135 bond_load_balance_broadcast (vlib_main_t * vm, vlib_node_runtime_t * node,
136 bond_if_t * bif, vlib_buffer_t * b0,
139 bond_main_t *bm = &bond_main;
143 u16 thread_index = vm->thread_index;
144 bond_per_thread_data_t *ptd = vec_elt_at_index (bm->per_thread_data,
147 for (port = 1; port < slave_count; port++)
149 sw_if_index = *vec_elt_at_index (bif->active_slaves, port);
150 c0 = vlib_buffer_copy (vm, b0);
151 if (PREDICT_TRUE (c0 != 0))
153 vnet_buffer (c0)->sw_if_index[VLIB_TX] = sw_if_index;
154 ptd->per_port_queue[sw_if_index].buffers[ptd->per_port_queue
155 [sw_if_index].n_buffers] =
156 vlib_get_buffer_index (vm, c0);
157 ptd->per_port_queue[sw_if_index].n_buffers++;
164 static_always_inline u32
165 bond_load_balance_l2 (vlib_main_t * vm, vlib_node_runtime_t * node,
166 bond_if_t * bif, vlib_buffer_t * b0, uword slave_count)
168 ethernet_header_t *eth = (ethernet_header_t *) vlib_buffer_get_current (b0);
170 u64 *dst = (u64 *) & eth->dst_address[0];
171 u64 a = clib_mem_unaligned (dst, u64);
172 u32 *src = (u32 *) & eth->src_address[2];
173 u32 b = clib_mem_unaligned (src, u32);
175 c = lb_hash_hash_2_tuples (a, b);
177 if (BOND_MODULO_SHORTCUT (slave_count))
178 return (c & (slave_count - 1));
180 return c % slave_count;
183 static_always_inline u16 *
184 bond_locate_ethertype (ethernet_header_t * eth)
187 ethernet_vlan_header_t *vlan;
189 if (!ethernet_frame_is_tagged (clib_net_to_host_u16 (eth->type)))
191 ethertype_p = ð->type;
195 vlan = (void *) (eth + 1);
196 ethertype_p = &vlan->type;
197 if (*ethertype_p == ntohs (ETHERNET_TYPE_VLAN))
200 ethertype_p = &vlan->type;
206 static_always_inline u32
207 bond_load_balance_l23 (vlib_main_t * vm, vlib_node_runtime_t * node,
208 bond_if_t * bif, vlib_buffer_t * b0, uword slave_count)
210 ethernet_header_t *eth = (ethernet_header_t *) vlib_buffer_get_current (b0);
213 u16 ethertype, *ethertype_p;
214 u32 *mac1, *mac2, *mac3;
216 ethertype_p = bond_locate_ethertype (eth);
217 ethertype = clib_mem_unaligned (ethertype_p, u16);
219 if ((ethertype != htons (ETHERNET_TYPE_IP4)) &&
220 (ethertype != htons (ETHERNET_TYPE_IP6)))
221 return (bond_load_balance_l2 (vm, node, bif, b0, slave_count));
223 ip4 = (ip4_header_t *) (ethertype_p + 1);
224 ip_version = (ip4->ip_version_and_header_length >> 4);
226 if (ip_version == 0x4)
230 mac1 = (u32 *) & eth->dst_address[0];
231 mac2 = (u32 *) & eth->dst_address[4];
232 mac3 = (u32 *) & eth->src_address[2];
234 a = clib_mem_unaligned (mac1, u32) ^ clib_mem_unaligned (mac2, u32) ^
235 clib_mem_unaligned (mac3, u32);
237 lb_hash_hash_2_tuples (clib_mem_unaligned (&ip4->address_pair, u64),
239 if (BOND_MODULO_SHORTCUT (slave_count))
240 return (c & (slave_count - 1));
242 return c % slave_count;
244 else if (ip_version == 0x6)
248 ip6_header_t *ip6 = (ip6_header_t *) (eth + 1);
250 mac1 = (u32 *) & eth->dst_address[0];
251 mac2 = (u32 *) & eth->dst_address[4];
252 mac3 = (u32 *) & eth->src_address[2];
254 a = clib_mem_unaligned (mac1, u32) ^ clib_mem_unaligned (mac2, u32) ^
255 clib_mem_unaligned (mac3, u32);
257 lb_hash_hash (clib_mem_unaligned
258 (&ip6->src_address.as_uword[0], uword),
259 clib_mem_unaligned (&ip6->src_address.as_uword[1],
261 clib_mem_unaligned (&ip6->dst_address.as_uword[0],
263 clib_mem_unaligned (&ip6->dst_address.as_uword[1],
265 if (BOND_MODULO_SHORTCUT (slave_count))
266 return (c & (slave_count - 1));
268 return c % slave_count;
270 return (bond_load_balance_l2 (vm, node, bif, b0, slave_count));
273 static_always_inline u32
274 bond_load_balance_l34 (vlib_main_t * vm, vlib_node_runtime_t * node,
275 bond_if_t * bif, vlib_buffer_t * b0, uword slave_count)
277 ethernet_header_t *eth = (ethernet_header_t *) vlib_buffer_get_current (b0);
281 u16 ethertype, *ethertype_p;
283 ethertype_p = bond_locate_ethertype (eth);
284 ethertype = clib_mem_unaligned (ethertype_p, u16);
286 if ((ethertype != htons (ETHERNET_TYPE_IP4)) &&
287 (ethertype != htons (ETHERNET_TYPE_IP6)))
288 return (bond_load_balance_l2 (vm, node, bif, b0, slave_count));
290 ip4 = (ip4_header_t *) (ethertype_p + 1);
291 ip_version = (ip4->ip_version_and_header_length >> 4);
293 if (ip_version == 0x4)
296 tcp_header_t *tcp = (void *) (ip4 + 1);
298 is_tcp_udp = (ip4->protocol == IP_PROTOCOL_TCP) ||
299 (ip4->protocol == IP_PROTOCOL_UDP);
300 t1 = is_tcp_udp ? clib_mem_unaligned (&tcp->src, u16) : 0;
301 t2 = is_tcp_udp ? clib_mem_unaligned (&tcp->dst, u16) : 0;
304 lb_hash_hash_2_tuples (clib_mem_unaligned (&ip4->address_pair, u64),
306 if (BOND_MODULO_SHORTCUT (slave_count))
307 return (c & (slave_count - 1));
309 return c % slave_count;
311 else if (ip_version == 0x6)
315 ip6_header_t *ip6 = (ip6_header_t *) (eth + 1);
316 tcp_header_t *tcp = (void *) (ip6 + 1);
319 if (PREDICT_TRUE ((ip6->protocol == IP_PROTOCOL_TCP) ||
320 (ip6->protocol == IP_PROTOCOL_UDP)))
323 tcp = (void *) (ip6 + 1);
325 else if (ip6->protocol == IP_PROTOCOL_IP6_HOP_BY_HOP_OPTIONS)
327 ip6_hop_by_hop_header_t *hbh =
328 (ip6_hop_by_hop_header_t *) (ip6 + 1);
329 if ((hbh->protocol == IP_PROTOCOL_TCP)
330 || (hbh->protocol == IP_PROTOCOL_UDP))
333 tcp = (tcp_header_t *) ((u8 *) hbh + ((hbh->length + 1) << 3));
336 t1 = is_tcp_udp ? clib_mem_unaligned (&tcp->src, u16) : 0;
337 t2 = is_tcp_udp ? clib_mem_unaligned (&tcp->dst, u16) : 0;
340 lb_hash_hash (clib_mem_unaligned
341 (&ip6->src_address.as_uword[0], uword),
342 clib_mem_unaligned (&ip6->src_address.as_uword[1],
344 clib_mem_unaligned (&ip6->dst_address.as_uword[0],
346 clib_mem_unaligned (&ip6->dst_address.as_uword[1],
348 if (BOND_MODULO_SHORTCUT (slave_count))
349 return (c & (slave_count - 1));
351 return c % slave_count;
354 return (bond_load_balance_l2 (vm, node, bif, b0, slave_count));
357 static_always_inline u32
358 bond_load_balance_round_robin (vlib_main_t * vm,
359 vlib_node_runtime_t * node,
360 bond_if_t * bif, vlib_buffer_t * b0,
363 bif->lb_rr_last_index++;
364 if (BOND_MODULO_SHORTCUT (slave_count))
365 bif->lb_rr_last_index &= slave_count - 1;
367 bif->lb_rr_last_index %= slave_count;
369 return bif->lb_rr_last_index;
372 static_always_inline u32
373 bond_load_balance_active_backup (vlib_main_t * vm,
374 vlib_node_runtime_t * node,
375 bond_if_t * bif, vlib_buffer_t * b0,
378 /* First interface is the active, the rest is backup */
382 static bond_load_balance_func_t bond_load_balance_table[] = {
383 #define _(v,f,s, p) { bond_load_balance_##p },
388 VNET_DEVICE_CLASS_TX_FN (bond_dev_class) (vlib_main_t * vm,
389 vlib_node_runtime_t * node,
390 vlib_frame_t * frame)
392 vnet_interface_output_runtime_t *rund = (void *) node->runtime_data;
393 bond_main_t *bm = &bond_main;
394 bond_if_t *bif = pool_elt_at_index (bm->interfaces, rund->dev_instance);
395 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
396 u32 *from = vlib_frame_vector_args (frame);
397 ethernet_header_t *eth;
400 bond_packet_trace_t *t0;
401 uword n_trace = vlib_get_trace_count (vm, node);
402 u16 thread_index = vm->thread_index;
403 vnet_main_t *vnm = vnet_get_main ();
407 u32 port0 = 0, port1 = 0, port2 = 0, port3 = 0;
408 bond_per_thread_data_t *ptd = vec_elt_at_index (bm->per_thread_data,
411 if (PREDICT_FALSE (bif->admin_up == 0))
413 vlib_buffer_free (vm, vlib_frame_args (frame), frame->n_vectors);
414 vlib_increment_simple_counter (vnet_main.interface_main.sw_if_counters +
415 VNET_INTERFACE_COUNTER_DROP,
416 thread_index, bif->sw_if_index,
418 vlib_error_count (vm, node->node_index, BOND_TX_ERROR_IF_DOWN,
420 return frame->n_vectors;
423 n_left = frame->n_vectors;
424 vlib_get_buffers (vm, from, bufs, n_left);
426 slave_count = vec_len (bif->active_slaves);
427 if (PREDICT_FALSE (slave_count == 0))
429 vlib_buffer_free (vm, vlib_frame_args (frame), frame->n_vectors);
430 vlib_increment_simple_counter (vnet_main.interface_main.sw_if_counters +
431 VNET_INTERFACE_COUNTER_DROP,
432 thread_index, bif->sw_if_index,
434 vlib_error_count (vm, node->node_index, BOND_TX_ERROR_NO_SLAVE,
436 return frame->n_vectors;
442 u32 sif_if_index0, sif_if_index1, sif_if_index2, sif_if_index3;
444 // Prefetch next iteration
447 vlib_buffer_t **pb = b + 4;
449 vlib_prefetch_buffer_header (pb[0], LOAD);
450 vlib_prefetch_buffer_header (pb[1], LOAD);
451 vlib_prefetch_buffer_header (pb[2], LOAD);
452 vlib_prefetch_buffer_header (pb[3], LOAD);
454 CLIB_PREFETCH (pb[0]->data, CLIB_CACHE_LINE_BYTES, LOAD);
455 CLIB_PREFETCH (pb[1]->data, CLIB_CACHE_LINE_BYTES, LOAD);
456 CLIB_PREFETCH (pb[2]->data, CLIB_CACHE_LINE_BYTES, LOAD);
457 CLIB_PREFETCH (pb[3]->data, CLIB_CACHE_LINE_BYTES, LOAD);
460 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
461 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[1]);
462 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[2]);
463 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[3]);
465 if (PREDICT_TRUE (slave_count > 1))
468 (bond_load_balance_table[bif->lb]).load_balance (vm, node,
472 (bond_load_balance_table[bif->lb]).load_balance (vm, node,
476 (bond_load_balance_table[bif->lb]).load_balance (vm, node,
480 (bond_load_balance_table[bif->lb]).load_balance (vm, node,
485 sif_if_index0 = *vec_elt_at_index (bif->active_slaves, port0);
486 sif_if_index1 = *vec_elt_at_index (bif->active_slaves, port1);
487 sif_if_index2 = *vec_elt_at_index (bif->active_slaves, port2);
488 sif_if_index3 = *vec_elt_at_index (bif->active_slaves, port3);
490 /* Do the tracing before the interface is overwritten */
491 if (PREDICT_FALSE (n_trace > 0))
493 u32 next0 = 0, next1 = 0, next2 = 0, next3 = 0;
494 vlib_trace_buffer (vm, node, next0, b[0], 0 /* follow_chain */ );
495 vlib_set_trace_count (vm, node, --n_trace);
496 t0 = vlib_add_trace (vm, node, b[0], sizeof (*t0));
497 eth = (ethernet_header_t *) vlib_buffer_get_current (b[0]);
499 t0->sw_if_index = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
500 t0->bond_sw_if_index = sif_if_index0;
502 if (PREDICT_TRUE (n_trace > 0))
504 vlib_trace_buffer (vm, node, next1, b[1],
505 0 /* follow_chain */ );
506 vlib_set_trace_count (vm, node, --n_trace);
507 t0 = vlib_add_trace (vm, node, b[1], sizeof (*t0));
508 eth = (ethernet_header_t *) vlib_buffer_get_current (b[1]);
510 t0->sw_if_index = vnet_buffer (b[1])->sw_if_index[VLIB_TX];
511 t0->bond_sw_if_index = sif_if_index1;
513 if (PREDICT_TRUE (n_trace > 0))
515 vlib_trace_buffer (vm, node, next2, b[2],
516 0 /* follow_chain */ );
517 vlib_set_trace_count (vm, node, --n_trace);
518 t0 = vlib_add_trace (vm, node, b[2], sizeof (*t0));
519 eth = (ethernet_header_t *) vlib_buffer_get_current (b[2]);
521 t0->sw_if_index = vnet_buffer (b[2])->sw_if_index[VLIB_TX];
522 t0->bond_sw_if_index = sif_if_index2;
524 if (PREDICT_TRUE (n_trace > 0))
526 vlib_trace_buffer (vm, node, next3, b[3],
527 0 /* follow_chain */ );
528 vlib_set_trace_count (vm, node, --n_trace);
529 t0 = vlib_add_trace (vm, node, b[3], sizeof (*t0));
531 (ethernet_header_t *) vlib_buffer_get_current (b[3]);
534 vnet_buffer (b[3])->sw_if_index[VLIB_TX];
535 t0->bond_sw_if_index = sif_if_index3;
541 vnet_buffer (b[0])->sw_if_index[VLIB_TX] = sif_if_index0;
542 vnet_buffer (b[1])->sw_if_index[VLIB_TX] = sif_if_index1;
543 vnet_buffer (b[2])->sw_if_index[VLIB_TX] = sif_if_index2;
544 vnet_buffer (b[3])->sw_if_index[VLIB_TX] = sif_if_index3;
546 ptd->per_port_queue[sif_if_index0].buffers[ptd->per_port_queue
547 [sif_if_index0].n_buffers] =
548 vlib_get_buffer_index (vm, b[0]);
549 ptd->per_port_queue[sif_if_index0].n_buffers++;
551 ptd->per_port_queue[sif_if_index1].buffers[ptd->per_port_queue
552 [sif_if_index1].n_buffers] =
553 vlib_get_buffer_index (vm, b[1]);
554 ptd->per_port_queue[sif_if_index1].n_buffers++;
556 ptd->per_port_queue[sif_if_index2].buffers[ptd->per_port_queue
557 [sif_if_index2].n_buffers] =
558 vlib_get_buffer_index (vm, b[2]);
559 ptd->per_port_queue[sif_if_index2].n_buffers++;
561 ptd->per_port_queue[sif_if_index3].buffers[ptd->per_port_queue
562 [sif_if_index3].n_buffers] =
563 vlib_get_buffer_index (vm, b[3]);
564 ptd->per_port_queue[sif_if_index3].n_buffers++;
574 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
576 if (PREDICT_TRUE (slave_count > 1))
578 (bond_load_balance_table[bif->lb]).load_balance (vm, node, bif,
580 sif_if_index0 = *vec_elt_at_index (bif->active_slaves, port0);
582 /* Do the tracing before the old interface is overwritten */
583 if (PREDICT_FALSE (n_trace > 0))
587 vlib_trace_buffer (vm, node, next0, b[0], 0 /* follow_chain */ );
588 vlib_set_trace_count (vm, node, --n_trace);
589 t0 = vlib_add_trace (vm, node, b[0], sizeof (*t0));
590 eth = (ethernet_header_t *) vlib_buffer_get_current (b[0]);
592 t0->sw_if_index = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
593 t0->bond_sw_if_index = sif_if_index0;
596 vnet_buffer (b[0])->sw_if_index[VLIB_TX] = sif_if_index0;
598 ptd->per_port_queue[sif_if_index0].buffers[ptd->per_port_queue
599 [sif_if_index0].n_buffers] =
600 vlib_get_buffer_index (vm, b[0]);
601 ptd->per_port_queue[sif_if_index0].n_buffers++;
607 for (port0 = 0; port0 < slave_count; port0++)
609 sw_if_index = *vec_elt_at_index (bif->active_slaves, port0);
610 if (PREDICT_TRUE (ptd->per_port_queue[sw_if_index].n_buffers))
612 f = vnet_get_frame_to_sw_interface (vnm, sw_if_index);
613 f->n_vectors = ptd->per_port_queue[sw_if_index].n_buffers;
614 to_next = vlib_frame_vector_args (f);
615 clib_memcpy (to_next, ptd->per_port_queue[sw_if_index].buffers,
617 vnet_put_frame_to_sw_interface (vnm, sw_if_index, f);
618 ptd->per_port_queue[sw_if_index].n_buffers = 0;
622 vlib_increment_simple_counter (vnet_main.interface_main.sw_if_counters
623 + VNET_INTERFACE_COUNTER_TX, thread_index,
624 bif->sw_if_index, frame->n_vectors);
626 return frame->n_vectors;
630 bond_active_interface_switch_cb (vnet_main_t * vnm, u32 sw_if_index,
633 bond_main_t *bm = &bond_main;
635 send_ip4_garp (bm->vlib_main, sw_if_index);
636 send_ip6_na (bm->vlib_main, sw_if_index);
638 return (WALK_CONTINUE);
642 bond_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
644 vnet_main_t *vnm = vnet_get_main ();
645 uword event_type, *event_data = 0;
652 vlib_process_wait_for_event (vm);
653 event_type = vlib_process_get_events (vm, &event_data);
654 ASSERT (event_type == BOND_SEND_GARP_NA);
655 for (i = 0; i < vec_len (event_data); i++)
657 hw_if_index = event_data[i];
658 /* walk hw interface to process all subinterfaces */
659 vnet_hw_interface_walk_sw (vnm, hw_if_index,
660 bond_active_interface_switch_cb, 0);
662 vec_reset_length (event_data);
668 VLIB_REGISTER_NODE (bond_process_node) = {
669 .function = bond_process,
670 .type = VLIB_NODE_TYPE_PROCESS,
671 .name = "bond-process",
676 VNET_DEVICE_CLASS (bond_dev_class) = {
678 .tx_function_n_errors = BOND_TX_N_ERROR,
679 .tx_function_error_strings = bond_tx_error_strings,
680 .format_device_name = format_bond_interface_name,
681 .set_l2_mode_function = bond_set_l2_mode_function,
682 .admin_up_down_function = bond_interface_admin_up_down,
683 .subif_add_del_function = bond_subif_add_del_function,
684 .format_tx_trace = format_bond_tx_trace,
690 * fd.io coding-style-patch-verification: ON
693 * eval: (c-set-style "gnu")