bond: Add bonding driver and LACP protocol

Add bonding driver to support creation of bond interface which composes of
multiple slave interfaces. The slave interfaces could be physical interfaces,
or just any virtual interfaces. For example, memif interfaces.

The syntax to create a bond interface is
create bond mode <lacp | xor | acitve-backup | broadcast | round-robin>

To enslave an interface to the bond interface,
enslave interface TenGigabitEthernet6/0/0 to BondEthernet0

Please see src/plugins/lacp/lacp_doc.md for more examples and additional
options.

LACP is a control plane protocol which manages and monitors the status of
the slave interfaces. The protocol is part of 802.3ad standard. This patch
implements LACPv1. LACPv2 is not supported.
To enable LACP on the bond interface, specify "mode lacp" when the bond
interface is created. The syntax to enslave a slave interface is the same as
other bonding modes.

Change-Id: I06581d3b87635972f9f0e1ec50b67560fc13e26c
Signed-off-by: Steven <sluong@cisco.com>

1 files changed, 393 insertions, 0 deletions

diff --git a/src/plugins/lacp/cli.c b/src/plugins/lacp/cli.c
new file mode 100644
index 00000000000..10627774f56
--- /dev/null
+++ b/src/plugins/lacp/cli.c
@@ -0,0 +1,393 @@
+/*
+ * Copyright (c) 2017 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#define _GNU_SOURCE
+#include <vnet/bonding/node.h>
+#include <lacp/node.h>
+
+int
+lacp_dump_ifs (lacp_interface_details_t ** out_lacpifs)
+{
+  vnet_main_t *vnm = vnet_get_main ();
+  bond_main_t *bm = &bond_main;
+  slave_if_t *sif;
+  bond_if_t *bif;
+  vnet_hw_interface_t *hi;
+  lacp_interface_details_t *r_lacpifs = NULL;
+  lacp_interface_details_t *lacpif = NULL;
+
+  /* *INDENT-OFF* */
+  pool_foreach (sif, bm->neighbors,
+    if ((sif->port_enabled == 0) || (sif->lacp_enabled == 0))
+      continue;
+    vec_add2(r_lacpifs, lacpif, 1);
+    memset (lacpif, 0, sizeof (*lacpif));
+    lacpif->sw_if_index = sif->sw_if_index;
+    hi = vnet_get_hw_interface (vnm, sif->hw_if_index);
+    clib_memcpy(lacpif->interface_name, hi->name,
+                MIN (ARRAY_LEN (lacpif->interface_name) - 1,
+                     strlen ((const char *) hi->name)));
+    bif = bond_get_master_by_dev_instance (sif->bif_dev_instance);
+    hi = vnet_get_hw_interface (vnm, bif->hw_if_index);
+    clib_memcpy(lacpif->bond_interface_name, hi->name,
+                MIN (ARRAY_LEN (lacpif->bond_interface_name) - 1,
+                     strlen ((const char *) hi->name)));
+    clib_memcpy (lacpif->actor_system, sif->actor.system, 6);
+    lacpif->actor_system_priority = sif->actor.system_priority;
+    lacpif->actor_key = sif->actor.key;
+    lacpif->actor_port_priority = sif->actor.port_priority;
+    lacpif->actor_port_number = sif->actor.port_number;
+    lacpif->actor_state = sif->actor.state;
+    clib_memcpy (lacpif->partner_system, sif->partner.system, 6);
+    lacpif->partner_system_priority = sif->partner.system_priority;
+    lacpif->partner_key = sif->partner.key;
+    lacpif->partner_port_priority = sif->partner.port_priority;
+    lacpif->partner_port_number = sif->partner.port_number;
+    lacpif->partner_state = sif->partner.state;
+    lacpif->rx_state = sif->rx_state;
+    lacpif->tx_state = sif->tx_state;
+    lacpif->ptx_state = sif->ptx_state;
+    lacpif->mux_state = sif->mux_state;
+  );
+  /* *INDENT-ON* */
+
+  *out_lacpifs = r_lacpifs;
+
+  return 0;
+}
+
+static void
+show_lacp (vlib_main_t * vm, u32 * sw_if_indices)
+{
+  int i;
+  slave_if_t *sif;
+  bond_if_t *bif;
+
+  if (!sw_if_indices)
+    return;
+
+  vlib_cli_output (vm, "%-55s %-32s %-32s", " ", "actor state",
+		   "partner state");
+  vlib_cli_output (vm, "%-25s %-12s %-16s %-31s  %-31s", "interface name",
+		   "sw_if_index", "bond interface",
+		   "exp/def/dis/col/syn/agg/tim/act",
+		   "exp/def/dis/col/syn/agg/tim/act");
+
+  for (i = 0; i < vec_len (sw_if_indices); i++)
+    {
+      sif = bond_get_slave_by_sw_if_index (sw_if_indices[i]);
+      if (!sif || (sif->port_enabled == 0) || (sif->lacp_enabled == 0))
+	continue;
+      bif = bond_get_master_by_dev_instance (sif->bif_dev_instance);
+      vlib_cli_output (vm,
+		       "%-25U %-12d %-16U %3x %3x %3x %3x %3x %3x %3x %3x "
+		       "%4x %3x %3x %3x %3x %3x %3x %3x",
+		       format_vnet_sw_if_index_name, vnet_get_main (),
+		       sif->sw_if_index, sif->sw_if_index,
+		       format_vnet_sw_if_index_name, vnet_get_main (),
+		       bif->sw_if_index, lacp_bit_test (sif->actor.state, 7),
+		       lacp_bit_test (sif->actor.state, 6),
+		       lacp_bit_test (sif->actor.state, 5),
+		       lacp_bit_test (sif->actor.state, 4),
+		       lacp_bit_test (sif->actor.state, 3),
+		       lacp_bit_test (sif->actor.state, 2),
+		       lacp_bit_test (sif->actor.state, 1),
+		       lacp_bit_test (sif->actor.state, 0),
+		       lacp_bit_test (sif->partner.state, 7),
+		       lacp_bit_test (sif->partner.state, 6),
+		       lacp_bit_test (sif->partner.state, 5),
+		       lacp_bit_test (sif->partner.state, 4),
+		       lacp_bit_test (sif->partner.state, 3),
+		       lacp_bit_test (sif->partner.state, 2),
+		       lacp_bit_test (sif->partner.state, 1),
+		       lacp_bit_test (sif->partner.state, 0));
+      vlib_cli_output (vm,
+		       "  LAG ID: "
+		       "[(%04x,%02x-%02x-%02x-%02x-%02x-%02x,%04x,%04x,%04x), "
+		       "(%04x,%02x-%02x-%02x-%02x-%02x-%02x,%04x,%04x,%04x)]",
+		       ntohs (sif->actor.system_priority),
+		       sif->actor.system[0], sif->actor.system[1],
+		       sif->actor.system[2], sif->actor.system[3],
+		       sif->actor.system[4], sif->actor.system[5],
+		       ntohs (sif->actor.key),
+		       ntohs (sif->actor.port_priority),
+		       ntohs (sif->actor.port_number),
+		       ntohs (sif->partner.system_priority),
+		       sif->partner.system[0], sif->partner.system[1],
+		       sif->partner.system[2], sif->partner.system[3],
+		       sif->partner.system[4], sif->partner.system[5],
+		       ntohs (sif->partner.key),
+		       ntohs (sif->partner.port_priority),
+		       ntohs (sif->partner.port_number));
+      vlib_cli_output (vm,
+		       "  RX-state: %U, TX-state: %U, "
+		       "MUX-state: %U, PTX-state: %U",
+		       format_rx_sm_state, sif->rx_state, format_tx_sm_state,
+		       sif->tx_state, format_mux_sm_state, sif->mux_state,
+		       format_ptx_sm_state, sif->ptx_state);
+    }
+}
+
+static void
+show_lacp_details (vlib_main_t * vm, u32 * sw_if_indices)
+{
+  slave_if_t *sif;
+  lacp_state_struct *state_entry;
+  int i;
+  f64 now;
+
+  if (!sw_if_indices)
+    return;
+
+  now = vlib_time_now (vm);
+  for (i = 0; i < vec_len (sw_if_indices); i++)
+    {
+      sif = bond_get_slave_by_sw_if_index (sw_if_indices[i]);
+      if (!sif || (sif->port_enabled == 0) || (sif->lacp_enabled == 0))
+	continue;
+      vlib_cli_output (vm, "  %U", format_vnet_sw_if_index_name,
+		       vnet_get_main (), sif->sw_if_index);
+      vlib_cli_output (vm, "    debug: %d", sif->debug);
+      vlib_cli_output (vm, "    loopback port: %d", sif->loopback_port);
+      vlib_cli_output (vm, "    port moved: %d", sif->port_moved);
+      vlib_cli_output (vm, "    ready_n: %d", sif->ready_n);
+      vlib_cli_output (vm, "    ready: %d", sif->ready);
+      vlib_cli_output (vm, "    Actor");
+      vlib_cli_output (vm, "      system: %U",
+		       format_ethernet_address, sif->actor.system);
+      vlib_cli_output (vm, "      system priority: %u",
+		       ntohs (sif->actor.system_priority));
+      vlib_cli_output (vm, "      key: %u", ntohs (sif->actor.key));
+      vlib_cli_output (vm, "      port priority: %u",
+		       ntohs (sif->actor.port_priority));
+      vlib_cli_output (vm, "      port number: %u",
+		       ntohs (sif->actor.port_number));
+      vlib_cli_output (vm, "      state: 0x%x", sif->actor.state);
+
+      state_entry = (lacp_state_struct *) & lacp_state_array;
+      while (state_entry->str)
+	{
+	  if (sif->actor.state & (1 << state_entry->bit))
+	    vlib_cli_output (vm, "        %s (%d)", state_entry->str,
+			     state_entry->bit);
+	  state_entry++;
+	}
+
+      vlib_cli_output (vm, "    Partner");
+      vlib_cli_output (vm, "      system: %U",
+		       format_ethernet_address, sif->partner.system);
+      vlib_cli_output (vm, "      system priority: %u",
+		       ntohs (sif->partner.system_priority));
+      vlib_cli_output (vm, "      key: %u", ntohs (sif->partner.key));
+      vlib_cli_output (vm, "      port priority: %u",
+		       ntohs (sif->partner.port_priority));
+      vlib_cli_output (vm, "      port number: %u",
+		       ntohs (sif->partner.port_number));
+      vlib_cli_output (vm, "      state: 0x%x", sif->partner.state);
+
+      state_entry = (lacp_state_struct *) & lacp_state_array;
+      while (state_entry->str)
+	{
+	  if (sif->partner.state & (1 << state_entry->bit))
+	    vlib_cli_output (vm, "        %s (%d)", state_entry->str,
+			     state_entry->bit);
+	  state_entry++;
+	}
+
+      if (!lacp_timer_is_running (sif->wait_while_timer))
+	vlib_cli_output (vm, "      wait while timer: not running");
+      else
+	vlib_cli_output (vm, "      wait while timer: %=10.2f seconds",
+			 sif->wait_while_timer - now);
+      if (!lacp_timer_is_running (sif->current_while_timer))
+	vlib_cli_output (vm, "      current while timer: not running");
+      else
+	vlib_cli_output (vm, "      current while timer: %=10.2f seconds",
+			 sif->current_while_timer - now);
+      if (!lacp_timer_is_running (sif->periodic_timer))
+	vlib_cli_output (vm, "      periodic timer: not running");
+      else
+	vlib_cli_output (vm, "      periodic timer: %=10.2f seconds",
+			 sif->periodic_timer - now);
+      vlib_cli_output (vm, "    RX-state: %U", format_rx_sm_state,
+		       sif->rx_state);
+      vlib_cli_output (vm, "    TX-state: %U", format_tx_sm_state,
+		       sif->tx_state);
+      vlib_cli_output (vm, "    MUX-state: %U", format_mux_sm_state,
+		       sif->mux_state);
+      vlib_cli_output (vm, "    PTX-state: %U", format_ptx_sm_state,
+		       sif->ptx_state);
+      vlib_cli_output (vm, "\n");
+    }
+}
+
+static clib_error_t *
+show_lacp_fn (vlib_main_t * vm, unformat_input_t * input,
+	      vlib_cli_command_t * cmd)
+{
+  bond_main_t *bm = &bond_main;
+  vnet_main_t *vnm = &vnet_main;
+  slave_if_t *sif;
+  clib_error_t *error = 0;
+  u8 details = 0;
+  u32 hw_if_index, *sw_if_indices = 0;
+  vnet_interface_main_t *im = &vnm->interface_main;
+  vnet_sw_interface_t *sw;
+
+  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
+    {
+      if (unformat
+	  (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
+	{
+	  sw = pool_elt_at_index (im->sw_interfaces, hw_if_index);
+	  sif = bond_get_slave_by_sw_if_index (sw->sw_if_index);
+	  if (!sif)
+	    {
+	      error = clib_error_return (0, "interface is not enslaved");
+	      goto done;
+	    }
+	  vec_add1 (sw_if_indices, sif->sw_if_index);
+	}
+      else if (unformat (input, "details"))
+	details = 1;
+      else
+	{
+	  error = clib_error_return (0, "unknown input `%U'",
+				     format_unformat_error, input);
+	  goto done;
+	}
+    }
+
+  if (vec_len (sw_if_indices) == 0)
+    {
+      pool_foreach (sif, bm->neighbors,
+		    vec_add1 (sw_if_indices, sif->sw_if_index);
+	);
+    }
+
+  if (details)
+    show_lacp_details (vm, sw_if_indices);
+  else
+    show_lacp (vm, sw_if_indices);
+
+done:
+  vec_free (sw_if_indices);
+  return error;
+}
+
+/* *INDENT-OFF* */
+VLIB_CLI_COMMAND (show_lacp_command, static) = {
+  .path = "show lacp",
+  .short_help = "show lacp [<interface>] [details]",
+  .function = show_lacp_fn,
+};
+/* *INDENT-ON* */
+
+static clib_error_t *
+debug_lacp_command_fn (vlib_main_t * vm, unformat_input_t * input,
+		       vlib_cli_command_t * cmd)
+{
+  unformat_input_t _line_input, *line_input = &_line_input;
+  clib_error_t *error = NULL;
+  lacp_main_t *lm = &lacp_main;
+  u8 onoff = 0;
+  u8 input_found = 0;
+  u32 hw_if_index = ~0;
+  slave_if_t *sif;
+  vnet_main_t *vnm = vnet_get_main ();
+  vnet_interface_main_t *im = &vnm->interface_main;
+  vnet_sw_interface_t *sw;
+
+  /* Get a line of input. */
+  if (!unformat_user (input, unformat_line_input, line_input))
+    return clib_error_return (0, "missing argument");
+
+  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
+    {
+      if (unformat (line_input, "%U",
+		    unformat_vnet_hw_interface, vnm, &hw_if_index))
+	;
+      if (input_found)
+	{
+	  error = clib_error_return (0, "unknown input `%U'",
+				     format_unformat_error, line_input);
+	  goto done;
+	}
+      else if (unformat (line_input, "on"))
+	{
+	  input_found = 1;
+	  onoff = 1;
+	}
+      else if (unformat (line_input, "off"))
+	{
+	  input_found = 1;
+	  onoff = 0;
+	}
+      else
+	{
+	  error = clib_error_return (0, "unknown input `%U'",
+				     format_unformat_error, line_input);
+	  goto done;
+	}
+    }
+
+  if (!input_found)
+    return clib_error_return (0, "must specify on or off");
+
+  if (hw_if_index != ~0)
+    {
+      sw = pool_elt_at_index (im->sw_interfaces, hw_if_index);
+      sif = bond_get_slave_by_sw_if_index (sw->sw_if_index);
+      if (!sif)
+	return (clib_error_return (0, "Please enslave the interface first"));
+      sif->debug = onoff;
+    }
+  else
+    lm->debug = onoff;
+
+done:
+  unformat_free (line_input);
+
+  return error;
+}
+
+/* *INDENT-OFF* */
+VLIB_CLI_COMMAND (debug_lacp_command, static) = {
+    .path = "debug lacp",
+    .short_help = "debug lacp <interface> <on | off>",
+    .function = debug_lacp_command_fn,
+};
+/* *INDENT-ON* */
+
+clib_error_t *
+lacp_cli_init (vlib_main_t * vm)
+{
+  lacp_main_t *lm = &lacp_main;
+
+  lm->vlib_main = vm;
+  lm->vnet_main = vnet_get_main ();
+
+  return 0;
+}
+
+VLIB_INIT_FUNCTION (lacp_cli_init);
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */