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