src/plugins/lacp/cli.c

   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
  16 #define _GNU_SOURCE
  17 #include <vnet/bonding/node.h>
  18 #include <lacp/node.h>
  19
  20 int
  21 lacp_dump_ifs (lacp_interface_details_t ** out_lacpifs)
  22 {
  23   vnet_main_t *vnm = vnet_get_main ();
  24   bond_main_t *bm = &bond_main;
  25   slave_if_t *sif;
  26   bond_if_t *bif;
  27   vnet_hw_interface_t *hi;
  28   lacp_interface_details_t *r_lacpifs = NULL;
  29   lacp_interface_details_t *lacpif = NULL;
  30
  31   /* *INDENT-OFF* */
  32   pool_foreach (sif, bm->neighbors,
  33     if ((sif->port_enabled == 0) || (sif->lacp_enabled == 0))
  34       continue;
  35     vec_add2(r_lacpifs, lacpif, 1);
  36     clib_memset (lacpif, 0, sizeof (*lacpif));
  37     lacpif->sw_if_index = sif->sw_if_index;
  38     hi = vnet_get_hw_interface (vnm, sif->hw_if_index);
  39     clib_memcpy(lacpif->interface_name, hi->name,
  40                 MIN (ARRAY_LEN (lacpif->interface_name) - 1,
  41                      strlen ((const char *) hi->name)));
  42     bif = bond_get_master_by_dev_instance (sif->bif_dev_instance);
  43     hi = vnet_get_hw_interface (vnm, bif->hw_if_index);
  44     clib_memcpy(lacpif->bond_interface_name, hi->name,
  45                 MIN (ARRAY_LEN (lacpif->bond_interface_name) - 1,
  46                      strlen ((const char *) hi->name)));
  47     clib_memcpy (lacpif->actor_system, sif->actor.system, 6);
  48     lacpif->actor_system_priority = sif->actor.system_priority;
  49     lacpif->actor_key = sif->actor.key;
  50     lacpif->actor_port_priority = sif->actor.port_priority;
  51     lacpif->actor_port_number = sif->actor.port_number;
  52     lacpif->actor_state = sif->actor.state;
  53     clib_memcpy (lacpif->partner_system, sif->partner.system, 6);
  54     lacpif->partner_system_priority = sif->partner.system_priority;
  55     lacpif->partner_key = sif->partner.key;
  56     lacpif->partner_port_priority = sif->partner.port_priority;
  57     lacpif->partner_port_number = sif->partner.port_number;
  58     lacpif->partner_state = sif->partner.state;
  59     lacpif->rx_state = sif->rx_state;
  60     lacpif->tx_state = sif->tx_state;
  61     lacpif->ptx_state = sif->ptx_state;
  62     lacpif->mux_state = sif->mux_state;
  63   );
  64   /* *INDENT-ON* */
  65
  66   *out_lacpifs = r_lacpifs;
  67
  68   return 0;
  69 }
  70
  71 static void
  72 show_lacp (vlib_main_t * vm, u32 * sw_if_indices)
  73 {
  74   int i;
  75   slave_if_t *sif;
  76   bond_if_t *bif;
  77
  78   if (!sw_if_indices)
  79     return;
  80
  81   vlib_cli_output (vm, "%-55s %-32s %-32s", " ", "actor state",
  82                    "partner state");
  83   vlib_cli_output (vm, "%-25s %-12s %-16s %-31s  %-31s", "interface name",
  84                    "sw_if_index", "bond interface",
  85                    "exp/def/dis/col/syn/agg/tim/act",
  86                    "exp/def/dis/col/syn/agg/tim/act");
  87
  88   for (i = 0; i < vec_len (sw_if_indices); i++)
  89     {
  90       sif = bond_get_slave_by_sw_if_index (sw_if_indices[i]);
  91       if (!sif || (sif->port_enabled == 0) || (sif->lacp_enabled == 0))
  92         continue;
  93       bif = bond_get_master_by_dev_instance (sif->bif_dev_instance);
  94       vlib_cli_output (vm,
  95                        "%-25U %-12d %-16U %3x %3x %3x %3x %3x %3x %3x %3x "
  96                        "%4x %3x %3x %3x %3x %3x %3x %3x",
  97                        format_vnet_sw_if_index_name, vnet_get_main (),
  98                        sif->sw_if_index, sif->sw_if_index,
  99                        format_vnet_sw_if_index_name, vnet_get_main (),
 100                        bif->sw_if_index, lacp_bit_test (sif->actor.state, 7),
 101                        lacp_bit_test (sif->actor.state, 6),
 102                        lacp_bit_test (sif->actor.state, 5),
 103                        lacp_bit_test (sif->actor.state, 4),
 104                        lacp_bit_test (sif->actor.state, 3),
 105                        lacp_bit_test (sif->actor.state, 2),
 106                        lacp_bit_test (sif->actor.state, 1),
 107                        lacp_bit_test (sif->actor.state, 0),
 108                        lacp_bit_test (sif->partner.state, 7),
 109                        lacp_bit_test (sif->partner.state, 6),
 110                        lacp_bit_test (sif->partner.state, 5),
 111                        lacp_bit_test (sif->partner.state, 4),
 112                        lacp_bit_test (sif->partner.state, 3),
 113                        lacp_bit_test (sif->partner.state, 2),
 114                        lacp_bit_test (sif->partner.state, 1),
 115                        lacp_bit_test (sif->partner.state, 0));
 116       vlib_cli_output (vm,
 117                        "  LAG ID: "
 118                        "[(%04x,%02x-%02x-%02x-%02x-%02x-%02x,%04x,%04x,%04x), "
 119                        "(%04x,%02x-%02x-%02x-%02x-%02x-%02x,%04x,%04x,%04x)]",
 120                        ntohs (sif->actor.system_priority),
 121                        sif->actor.system[0], sif->actor.system[1],
 122                        sif->actor.system[2], sif->actor.system[3],
 123                        sif->actor.system[4], sif->actor.system[5],
 124                        ntohs (sif->actor.key),
 125                        ntohs (sif->actor.port_priority),
 126                        ntohs (sif->actor.port_number),
 127                        ntohs (sif->partner.system_priority),
 128                        sif->partner.system[0], sif->partner.system[1],
 129                        sif->partner.system[2], sif->partner.system[3],
 130                        sif->partner.system[4], sif->partner.system[5],
 131                        ntohs (sif->partner.key),
 132                        ntohs (sif->partner.port_priority),
 133                        ntohs (sif->partner.port_number));
 134       vlib_cli_output (vm,
 135                        "  RX-state: %U, TX-state: %U, "
 136                        "MUX-state: %U, PTX-state: %U",
 137                        format_rx_sm_state, sif->rx_state, format_tx_sm_state,
 138                        sif->tx_state, format_mux_sm_state, sif->mux_state,
 139                        format_ptx_sm_state, sif->ptx_state);
 140     }
 141 }
 142
 143 static void
 144 show_lacp_details (vlib_main_t * vm, u32 * sw_if_indices)
 145 {
 146   slave_if_t *sif;
 147   lacp_state_struct *state_entry;
 148   int i;
 149   f64 now;
 150
 151   if (!sw_if_indices)
 152     return;
 153
 154   now = vlib_time_now (vm);
 155   for (i = 0; i < vec_len (sw_if_indices); i++)
 156     {
 157       sif = bond_get_slave_by_sw_if_index (sw_if_indices[i]);
 158       if (!sif || (sif->port_enabled == 0) || (sif->lacp_enabled == 0))
 159         continue;
 160       vlib_cli_output (vm, "  %U", format_vnet_sw_if_index_name,
 161                        vnet_get_main (), sif->sw_if_index);
 162       vlib_cli_output (vm, "    Good LACP PDUs received: %llu",
 163                        sif->pdu_received);
 164       vlib_cli_output (vm, "    Bad LACP PDUs received: %llu",
 165                        sif->bad_pdu_received);
 166       vlib_cli_output (vm, "    LACP PDUs sent: %llu", sif->pdu_sent);
 167       if (lacp_timer_is_running (sif->last_lacpdu_recd_time))
 168         vlib_cli_output (vm,
 169                          "    last LACP PDU received: %10.2f seconds ago",
 170                          now - sif->last_lacpdu_recd_time);
 171       if (lacp_timer_is_running (sif->last_lacpdu_sent_time))
 172         vlib_cli_output (vm, "    last LACP PDU sent: %10.2f seconds ago",
 173                          now - sif->last_lacpdu_sent_time);
 174       vlib_cli_output (vm, "    Good Marker PDUs received: %llu",
 175                        sif->marker_pdu_received);
 176       vlib_cli_output (vm, "    Bad Marker PDUs received: %llu",
 177                        sif->marker_bad_pdu_received);
 178       if (lacp_timer_is_running (sif->last_marker_pdu_recd_time))
 179         vlib_cli_output (vm,
 180                          "    last Marker PDU received: %10.2f seconds ago",
 181                          now - sif->last_marker_pdu_recd_time);
 182       if (lacp_timer_is_running (sif->last_marker_pdu_sent_time))
 183         vlib_cli_output (vm, "    last Marker PDU sent: %10.2f seconds ago",
 184                          now - sif->last_marker_pdu_sent_time);
 185       vlib_cli_output (vm, "    debug: %d", sif->debug);
 186       vlib_cli_output (vm, "    loopback port: %d", sif->loopback_port);
 187       vlib_cli_output (vm, "    port moved: %d", sif->port_moved);
 188       vlib_cli_output (vm, "    ready_n: %d", sif->ready_n);
 189       vlib_cli_output (vm, "    ready: %d", sif->ready);
 190       vlib_cli_output (vm, "    Actor");
 191       vlib_cli_output (vm, "      system: %U",
 192                        format_ethernet_address, sif->actor.system);
 193       vlib_cli_output (vm, "      system priority: %u",
 194                        ntohs (sif->actor.system_priority));
 195       vlib_cli_output (vm, "      key: %u", ntohs (sif->actor.key));
 196       vlib_cli_output (vm, "      port priority: %u",
 197                        ntohs (sif->actor.port_priority));
 198       vlib_cli_output (vm, "      port number: %u",
 199                        ntohs (sif->actor.port_number));
 200       vlib_cli_output (vm, "      state: 0x%x", sif->actor.state);
 201
 202       state_entry = (lacp_state_struct *) & lacp_state_array;
 203       while (state_entry->str)
 204         {
 205           if (sif->actor.state & (1 << state_entry->bit))
 206             vlib_cli_output (vm, "        %s (%d)", state_entry->str,
 207                              state_entry->bit);
 208           state_entry++;
 209         }
 210
 211       vlib_cli_output (vm, "    Partner");
 212       vlib_cli_output (vm, "      system: %U",
 213                        format_ethernet_address, sif->partner.system);
 214       vlib_cli_output (vm, "      system priority: %u",
 215                        ntohs (sif->partner.system_priority));
 216       vlib_cli_output (vm, "      key: %u", ntohs (sif->partner.key));
 217       vlib_cli_output (vm, "      port priority: %u",
 218                        ntohs (sif->partner.port_priority));
 219       vlib_cli_output (vm, "      port number: %u",
 220                        ntohs (sif->partner.port_number));
 221       vlib_cli_output (vm, "      state: 0x%x", sif->partner.state);
 222
 223       state_entry = (lacp_state_struct *) & lacp_state_array;
 224       while (state_entry->str)
 225         {
 226           if (sif->partner.state & (1 << state_entry->bit))
 227             vlib_cli_output (vm, "        %s (%d)", state_entry->str,
 228                              state_entry->bit);
 229           state_entry++;
 230         }
 231
 232       if (!lacp_timer_is_running (sif->wait_while_timer))
 233         vlib_cli_output (vm, "      wait while timer: not running");
 234       else
 235         vlib_cli_output (vm, "      wait while timer: %10.2f seconds",
 236                          sif->wait_while_timer - now);
 237       if (!lacp_timer_is_running (sif->current_while_timer))
 238         vlib_cli_output (vm, "      current while timer: not running");
 239       else
 240         vlib_cli_output (vm, "      current while timer: %10.2f seconds",
 241                          sif->current_while_timer - now);
 242       if (!lacp_timer_is_running (sif->periodic_timer))
 243         vlib_cli_output (vm, "      periodic timer: not running");
 244       else
 245         vlib_cli_output (vm, "      periodic timer: %10.2f seconds",
 246                          sif->periodic_timer - now);
 247       vlib_cli_output (vm, "    RX-state: %U", format_rx_sm_state,
 248                        sif->rx_state);
 249       vlib_cli_output (vm, "    TX-state: %U", format_tx_sm_state,
 250                        sif->tx_state);
 251       vlib_cli_output (vm, "    MUX-state: %U", format_mux_sm_state,
 252                        sif->mux_state);
 253       vlib_cli_output (vm, "    PTX-state: %U", format_ptx_sm_state,
 254                        sif->ptx_state);
 255       vlib_cli_output (vm, "\n");
 256     }
 257 }
 258
 259 static clib_error_t *
 260 show_lacp_fn (vlib_main_t * vm, unformat_input_t * input,
 261               vlib_cli_command_t * cmd)
 262 {
 263   bond_main_t *bm = &bond_main;
 264   vnet_main_t *vnm = &vnet_main;
 265   slave_if_t *sif;
 266   clib_error_t *error = 0;
 267   u8 details = 0;
 268   u32 sw_if_index, *sw_if_indices = 0;
 269
 270   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 271     {
 272       if (unformat
 273           (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
 274         {
 275           sif = bond_get_slave_by_sw_if_index (sw_if_index);
 276           if (!sif)
 277             {
 278               error = clib_error_return (0, "interface is not enslaved");
 279               goto done;
 280             }
 281           vec_add1 (sw_if_indices, sif->sw_if_index);
 282         }
 283       else if (unformat (input, "details"))
 284         details = 1;
 285       else
 286         {
 287           error = clib_error_return (0, "unknown input `%U'",
 288                                      format_unformat_error, input);
 289           goto done;
 290         }
 291     }
 292
 293   if (vec_len (sw_if_indices) == 0)
 294     {
 295       pool_foreach (sif, bm->neighbors,
 296                     vec_add1 (sw_if_indices, sif->sw_if_index);
 297         );
 298     }
 299
 300   if (details)
 301     show_lacp_details (vm, sw_if_indices);
 302   else
 303     show_lacp (vm, sw_if_indices);
 304
 305 done:
 306   vec_free (sw_if_indices);
 307   return error;
 308 }
 309
 310 /* *INDENT-OFF* */
 311 VLIB_CLI_COMMAND (show_lacp_command, static) = {
 312   .path = "show lacp",
 313   .short_help = "show lacp [<interface>] [details]",
 314   .function = show_lacp_fn,
 315 };
 316 /* *INDENT-ON* */
 317
 318 static clib_error_t *
 319 debug_lacp_command_fn (vlib_main_t * vm, unformat_input_t * input,
 320                        vlib_cli_command_t * cmd)
 321 {
 322   unformat_input_t _line_input, *line_input = &_line_input;
 323   clib_error_t *error = NULL;
 324   lacp_main_t *lm = &lacp_main;
 325   u8 onoff = 0;
 326   u8 input_found = 0;
 327   u32 sw_if_index = ~0;
 328   slave_if_t *sif;
 329   vnet_main_t *vnm = vnet_get_main ();
 330
 331   /* Get a line of input. */
 332   if (!unformat_user (input, unformat_line_input, line_input))
 333     return clib_error_return (0, "missing argument");
 334
 335   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 336     {
 337       if (unformat (line_input, "%U",
 338                     unformat_vnet_sw_interface, vnm, &sw_if_index))
 339         ;
 340       if (input_found)
 341         {
 342           error = clib_error_return (0, "unknown input `%U'",
 343                                      format_unformat_error, line_input);
 344           goto done;
 345         }
 346       else if (unformat (line_input, "on"))
 347         {
 348           input_found = 1;
 349           onoff = 1;
 350         }
 351       else if (unformat (line_input, "off"))
 352         {
 353           input_found = 1;
 354           onoff = 0;
 355         }
 356       else
 357         {
 358           error = clib_error_return (0, "unknown input `%U'",
 359                                      format_unformat_error, line_input);
 360           goto done;
 361         }
 362     }
 363
 364   if (!input_found)
 365     return clib_error_return (0, "must specify on or off");
 366
 367   if (sw_if_index != ~0)
 368     {
 369       sif = bond_get_slave_by_sw_if_index (sw_if_index);
 370       if (!sif)
 371         return (clib_error_return (0, "Please enslave the interface first"));
 372       sif->debug = onoff;
 373     }
 374   else
 375     lm->debug = onoff;
 376
 377 done:
 378   unformat_free (line_input);
 379
 380   return error;
 381 }
 382
 383 /* *INDENT-OFF* */
 384 VLIB_CLI_COMMAND (debug_lacp_command, static) = {
 385     .path = "debug lacp",
 386     .short_help = "debug lacp <interface> <on | off>",
 387     .function = debug_lacp_command_fn,
 388 };
 389 /* *INDENT-ON* */
 390
 391 clib_error_t *
 392 lacp_cli_init (vlib_main_t * vm)
 393 {
 394   lacp_main_t *lm = &lacp_main;
 395
 396   lm->vlib_main = vm;
 397   lm->vnet_main = vnet_get_main ();
 398
 399   return 0;
 400 }
 401
 402 VLIB_INIT_FUNCTION (lacp_cli_init);
 403
 404 /*
 405  * fd.io coding-style-patch-verification: ON
 406  *
 407  * Local Variables:
 408  * eval: (c-set-style "gnu")
 409  * End:
 410  */