FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
cli.c
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 
16 #define _GNU_SOURCE
17 #include <vnet/bonding/node.h>
18 #include <lacp/node.h>
19 
20 int
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;
28  lacp_interface_details_t *r_lacpifs = 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)));
43  hi = vnet_get_hw_interface (vnm, bif->hw_if_index);
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;
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",
98  sif->sw_if_index, sif->sw_if_index,
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",
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;
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);
168  vlib_cli_output (vm,
169  " last LACP PDU received: %10.2f seconds ago",
170  now - sif->last_lacpdu_recd_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",
179  vlib_cli_output (vm,
180  " last Marker PDU received: %10.2f seconds ago",
181  now - sif->last_marker_pdu_recd_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 
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);
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);
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 *
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 
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 *
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 *
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 
403 
404 /*
405  * fd.io coding-style-patch-verification: ON
406  *
407  * Local Variables:
408  * eval: (c-set-style "gnu")
409  * End:
410  */
u32 sw_if_index
Definition: ipsec_gre.api:37
static void show_lacp_details(vlib_main_t *vm, u32 *sw_if_indices)
Definition: cli.c:144
u8 interface_name[64]
Definition: node.h:93
vmrglw vmrglh hi
vlib_main_t * vlib_main
Definition: node.h:119
u32 hw_if_index
Definition: node.h:169
vnet_main_t * vnet_get_main(void)
Definition: misc.c:47
f64 last_lacpdu_recd_time
Definition: node.h:269
#define NULL
Definition: clib.h:58
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:255
static vnet_hw_interface_t * vnet_get_hw_interface(vnet_main_t *vnm, u32 hw_if_index)
int tx_state
Definition: node.h:288
int lacp_dump_ifs(lacp_interface_details_t **out_lacpifs)
Definition: cli.c:21
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:522
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:560
int i
bond_main_t bond_main
Definition: node.c:25
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:983
lacp_state_struct lacp_state_array[]
Definition: node.c:21
unformat_function_t unformat_vnet_sw_interface
u64 pdu_received
Definition: node.h:305
f64 current_while_timer
Definition: node.h:260
format_function_t format_vnet_sw_if_index_name
unsigned char u8
Definition: types.h:56
static clib_error_t * show_lacp_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:260
double f64
Definition: types.h:142
#define clib_memcpy(d, s, n)
Definition: string.h:180
f64 periodic_timer
Definition: node.h:278
static u8 * format_rx_sm_state(u8 *s, va_list *args)
Definition: node.h:177
u8 * format_ethernet_address(u8 *s, va_list *args)
Definition: format.c:44
static u8 lacp_timer_is_running(f64 timer)
Definition: node.h:163
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:493
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:163
vnet_main_t * vnet_main
Definition: node.h:120
f64 last_marker_pdu_recd_time
Definition: node.h:275
u32 sw_if_index
Definition: node.h:170
u64 bad_pdu_received
Definition: node.h:308
lacp_port_info_t actor
Definition: node.h:229
u64 marker_pdu_received
Definition: node.h:314
#define clib_error_return(e, args...)
Definition: error.h:99
unsigned int u32
Definition: types.h:88
#define MIN(x, y)
Definition: node.h:31
unformat_function_t unformat_line_input
Definition: format.h:282
u8 ready
Definition: node.h:251
LACP interface details struct.
Definition: node.h:90
f64 last_marker_pdu_sent_time
Definition: node.h:272
struct _unformat_input_t unformat_input_t
u8 port_moved
Definition: node.h:257
u8 debug
Definition: node.h:135
vnet_main_t vnet_main
Definition: misc.c:43
int ptx_state
Definition: node.h:290
u8 bond_interface_name[64]
Definition: node.h:98
#define UNFORMAT_END_OF_INPUT
Definition: format.h:144
u32 sw_if_index
Definition: node.h:195
vlib_main_t * vm
Definition: buffer.c:312
lacp_port_info_t partner
Definition: node.h:228
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
static u8 * format_mux_sm_state(u8 *s, va_list *args)
Definition: node.h:219
int rx_state
Definition: node.h:287
#define ARRAY_LEN(x)
Definition: clib.h:62
lacp_main_t lacp_main
Definition: lacp.c:25
f64 last_lacpdu_sent_time
Definition: node.h:266
static clib_error_t * debug_lacp_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: cli.c:319
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:155
u8 loopback_port
Definition: node.h:299
static bond_if_t * bond_get_master_by_dev_instance(u32 dev_instance)
Definition: node.h:477
u32 bif_dev_instance
Definition: node.h:297
static u8 * format_ptx_sm_state(u8 *s, va_list *args)
Definition: node.h:240
u8 debug
Definition: node.h:204
u8 ready_n
Definition: node.h:248
clib_error_t * lacp_cli_init(vlib_main_t *vm)
Definition: cli.c:392
u8 lacp_enabled
Definition: node.h:245
u64 pdu_sent
Definition: node.h:311
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
static void show_lacp(vlib_main_t *vm, u32 *sw_if_indices)
Definition: cli.c:72
static void unformat_free(unformat_input_t *i)
Definition: format.h:162
static int lacp_bit_test(u8 val, u8 bit)
Definition: node.h:261
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
slave_if_t * neighbors
Definition: node.h:335
static u8 * format_tx_sm_state(u8 *s, va_list *args)
Definition: node.h:198
u8 port_enabled
Definition: node.h:239
static slave_if_t * bond_get_slave_by_sw_if_index(u32 sw_if_index)
Definition: node.h:485
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:762
f64 wait_while_timer
Definition: node.h:284
u32 hw_if_index
Definition: node.h:222
int mux_state
Definition: node.h:289
u64 marker_bad_pdu_received
Definition: node.h:317
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:972
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:170