FD.io VPP  v18.10-34-gcce845e
Vector Packet Processing
session_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  */
16 #include <vnet/session/session.h>
17 
18 u8 *
19 format_stream_session_fifos (u8 * s, va_list * args)
20 {
21  stream_session_t *ss = va_arg (*args, stream_session_t *);
22  int verbose = va_arg (*args, int);
23  session_event_t _e, *e = &_e;
24  u8 found;
25 
26  if (!ss->server_rx_fifo || !ss->server_tx_fifo)
27  return s;
28 
29  s = format (s, " Rx fifo: %U", format_svm_fifo, ss->server_rx_fifo,
30  verbose);
31  if (verbose > 2 && ss->server_rx_fifo->has_event)
32  {
33  found = session_node_lookup_fifo_event (ss->server_rx_fifo, e);
34  s = format (s, " session node event: %s\n",
35  found ? "found" : "not found");
36  }
37  s = format (s, " Tx fifo: %U", format_svm_fifo, ss->server_tx_fifo,
38  verbose);
39  if (verbose > 2 && ss->server_tx_fifo->has_event)
40  {
41  found = session_node_lookup_fifo_event (ss->server_tx_fifo, e);
42  s = format (s, " session node event: %s\n",
43  found ? "found" : "not found");
44  }
45  return s;
46 }
47 
48 /**
49  * Format stream session as per the following format
50  *
51  * verbose:
52  * "Connection", "Rx fifo", "Tx fifo", "Session Index"
53  * non-verbose:
54  * "Connection"
55  */
56 u8 *
57 format_stream_session (u8 * s, va_list * args)
58 {
59  stream_session_t *ss = va_arg (*args, stream_session_t *);
60  int verbose = va_arg (*args, int);
61  transport_proto_vft_t *tp_vft;
62  u8 *str = 0;
64 
65  if (verbose == 1 && ss->session_state >= SESSION_STATE_ACCEPTING)
66  str = format (0, "%-10u%-10u%-10lld",
67  svm_fifo_max_dequeue (ss->server_rx_fifo),
68  svm_fifo_max_enqueue (ss->server_tx_fifo),
69  session_get_index (ss));
70 
71  if (ss->session_state >= SESSION_STATE_ACCEPTING)
72  {
73  s = format (s, "%U", tp_vft->format_connection, ss->connection_index,
74  ss->thread_index, verbose);
75  if (verbose == 1)
76  s = format (s, "%v", str);
77  if (verbose > 1)
78  s = format (s, "%U", format_stream_session_fifos, ss, verbose);
79  }
80  else if (ss->session_state == SESSION_STATE_LISTENING)
81  {
82  s = format (s, "%-40U%v", tp_vft->format_listener, ss->connection_index,
83  str);
84  if (verbose > 1)
85  s = format (s, "\n%U", format_stream_session_fifos, ss, verbose);
86  }
87  else if (ss->session_state == SESSION_STATE_CONNECTING)
88  {
89  s = format (s, "%-40U%v", tp_vft->format_half_open,
90  ss->connection_index, str);
91  }
92  else
93  {
94  clib_warning ("Session in state: %d!", ss->session_state);
95  }
96  vec_free (str);
97 
98  return s;
99 }
100 
101 uword
103 {
104  u8 *proto = va_arg (*args, u8 *);
105  ip46_address_t *lcl = va_arg (*args, ip46_address_t *);
106  ip46_address_t *rmt = va_arg (*args, ip46_address_t *);
107  u16 *lcl_port = va_arg (*args, u16 *);
108  u16 *rmt_port = va_arg (*args, u16 *);
109  u8 *is_ip4 = va_arg (*args, u8 *);
110  u8 tuple_is_set = 0;
111 
112  memset (lcl, 0, sizeof (*lcl));
113  memset (rmt, 0, sizeof (*rmt));
114 
115  if (unformat (input, "tcp"))
116  {
117  *proto = TRANSPORT_PROTO_TCP;
118  }
119  if (unformat (input, "udp"))
120  {
121  *proto = TRANSPORT_PROTO_UDP;
122  }
123  if (unformat (input, "%U:%d->%U:%d", unformat_ip4_address, &lcl->ip4,
124  lcl_port, unformat_ip4_address, &rmt->ip4, rmt_port))
125  {
126  *is_ip4 = 1;
127  tuple_is_set = 1;
128  }
129  else if (unformat (input, "%U:%d->%U:%d", unformat_ip6_address, &lcl->ip6,
130  lcl_port, unformat_ip6_address, &rmt->ip6, rmt_port))
131  {
132  *is_ip4 = 0;
133  tuple_is_set = 1;
134  }
135 
136  return tuple_is_set;
137 }
138 
139 uword
140 unformat_stream_session (unformat_input_t * input, va_list * args)
141 {
142  stream_session_t **result = va_arg (*args, stream_session_t **);
143  stream_session_t *s;
144  u8 proto = ~0;
145  ip46_address_t lcl, rmt;
146  u32 lcl_port = 0, rmt_port = 0, fib_index = 0;
147  u8 is_ip4 = 0;
148 
149  if (!unformat (input, "%U", unformat_stream_session_id, &proto, &lcl, &rmt,
150  &lcl_port, &rmt_port, &is_ip4))
151  return 0;
152 
153  if (is_ip4)
154  s = session_lookup_safe4 (fib_index, &lcl.ip4, &rmt.ip4,
155  clib_host_to_net_u16 (lcl_port),
156  clib_host_to_net_u16 (rmt_port), proto);
157  else
158  s = session_lookup_safe6 (fib_index, &lcl.ip6, &rmt.ip6,
159  clib_host_to_net_u16 (lcl_port),
160  clib_host_to_net_u16 (rmt_port), proto);
161  if (s)
162  {
163  *result = s;
164  session_pool_remove_peeker (s->thread_index);
165  return 1;
166  }
167  return 0;
168 }
169 
170 uword
172 {
173  transport_connection_t **result = va_arg (*args, transport_connection_t **);
174  u32 suggested_proto = va_arg (*args, u32);
176  u8 proto = ~0;
177  ip46_address_t lcl, rmt;
178  u32 lcl_port = 0, rmt_port = 0, fib_index = 0;
179  u8 is_ip4 = 0;
180 
181  if (!unformat (input, "%U", unformat_stream_session_id, &proto, &lcl, &rmt,
182  &lcl_port, &rmt_port, &is_ip4))
183  return 0;
184 
185  proto = (proto == (u8) ~ 0) ? suggested_proto : proto;
186  if (proto == (u8) ~ 0)
187  return 0;
188  if (is_ip4)
189  tc = session_lookup_connection4 (fib_index, &lcl.ip4, &rmt.ip4,
190  clib_host_to_net_u16 (lcl_port),
191  clib_host_to_net_u16 (rmt_port), proto);
192  else
193  tc = session_lookup_connection6 (fib_index, &lcl.ip6, &rmt.ip6,
194  clib_host_to_net_u16 (lcl_port),
195  clib_host_to_net_u16 (rmt_port), proto);
196 
197  if (tc)
198  {
199  *result = tc;
200  return 1;
201  }
202  return 0;
203 }
204 
205 static clib_error_t *
207  vlib_cli_command_t * cmd)
208 {
210  u8 *str = 0, one_session = 0, do_listeners = 0, sst, *app_name;
211  int verbose = 0, i;
212  stream_session_t *pool, *s;
213  u32 transport_proto = ~0;
214 
215  if (!smm->is_enabled)
216  {
217  return clib_error_return (0, "session layer is not enabled");
218  }
219 
221  {
222  if (unformat (input, "verbose %d", &verbose))
223  ;
224  else if (unformat (input, "verbose"))
225  verbose = 1;
226  else if (unformat (input, "listeners %U", unformat_transport_proto,
227  &transport_proto))
228  do_listeners = 1;
229  else if (unformat (input, "%U", unformat_stream_session, &s))
230  {
231  one_session = 1;
232  }
233  else
234  return clib_error_return (0, "unknown input `%U'",
235  format_unformat_error, input);
236  }
237 
238  if (one_session)
239  {
240  vlib_cli_output (vm, "%U", format_stream_session, s, 3);
241  return 0;
242  }
243 
244  if (do_listeners)
245  {
246  sst = session_type_from_proto_and_ip (transport_proto, 1);
247  vlib_cli_output (vm, "%-40s%-24s%-10s", "Listener", "App", "S-idx");
248  /* *INDENT-OFF* */
249  pool_foreach (s, smm->sessions[0], ({
250  if (s->session_state != SESSION_STATE_LISTENING
251  || s->session_type != sst)
252  continue;
253  app_name = application_name_from_index (s->app_wrk_index);
254  vlib_cli_output (vm, "%U%-25v%-10u", format_stream_session, s, 1,
255  app_name, s->session_index);
256  vec_free (app_name);
257  }));
258  /* *INDENT-ON* */
259  return 0;
260  }
261 
262  for (i = 0; i < vec_len (smm->sessions); i++)
263  {
264  u32 once_per_pool;
265  pool = smm->sessions[i];
266 
267  once_per_pool = 1;
268 
269  if (pool_elts (pool))
270  {
271 
272  vlib_cli_output (vm, "Thread %d: %d active sessions",
273  i, pool_elts (pool));
274  if (verbose)
275  {
276  if (once_per_pool && verbose == 1)
277  {
278  str = format (str, "%-50s%-15s%-10s%-10s%-10s",
279  "Connection", "State", "Rx-f", "Tx-f",
280  "S-idx");
281  vlib_cli_output (vm, "%v", str);
282  vec_reset_length (str);
283  once_per_pool = 0;
284  }
285 
286  /* *INDENT-OFF* */
287  pool_foreach (s, pool,
288  ({
289  vec_reset_length (str);
290  str = format (str, "%U", format_stream_session, s, verbose);
291  vlib_cli_output (vm, "%v", str);
292  }));
293  /* *INDENT-ON* */
294  }
295  }
296  else
297  vlib_cli_output (vm, "Thread %d: no active sessions", i);
298  vec_reset_length (str);
299  }
300  vec_free (str);
301 
302  return 0;
303 }
304 
305 /* *INDENT-OFF* */
306 VLIB_CLI_COMMAND (vlib_cli_show_session_command) =
307 {
308  .path = "show session",
309  .short_help = "show session [verbose [nnn]]",
310  .function = show_session_command_fn,
311 };
312 /* *INDENT-ON* */
313 
314 static int
316 {
317  app_worker_t *server_wrk = app_worker_get (s->app_wrk_index);
318  application_t *server = application_get (server_wrk->app_index);
319  server->cb_fns.session_disconnect_callback (s);
320  return 0;
321 }
322 
323 static clib_error_t *
325  vlib_cli_command_t * cmd)
326 {
328  u32 thread_index = 0, clear_all = 0;
329  u32 session_index = ~0;
330  stream_session_t **pool, *session;
331 
332  if (!smm->is_enabled)
333  {
334  return clib_error_return (0, "session layer is not enabled");
335  }
336 
338  {
339  if (unformat (input, "thread %d", &thread_index))
340  ;
341  else if (unformat (input, "session %d", &session_index))
342  ;
343  else if (unformat (input, "all"))
344  clear_all = 1;
345  else
346  return clib_error_return (0, "unknown input `%U'",
347  format_unformat_error, input);
348  }
349 
350  if (!clear_all && session_index == ~0)
351  return clib_error_return (0, "session <nn> required, but not set.");
352 
353  if (session_index != ~0)
354  {
355  session = session_get_if_valid (session_index, thread_index);
356  if (!session)
357  return clib_error_return (0, "no session %d on thread %d",
358  session_index, thread_index);
359  clear_session (session);
360  }
361 
362  if (clear_all)
363  {
364  /* *INDENT-OFF* */
365  vec_foreach (pool, smm->sessions)
366  {
367  pool_foreach(session, *pool, ({
368  clear_session (session);
369  }));
370  };
371  /* *INDENT-ON* */
372  }
373 
374  return 0;
375 }
376 
377 /* *INDENT-OFF* */
378 VLIB_CLI_COMMAND (clear_session_command, static) =
379 {
380  .path = "clear session",
381  .short_help = "clear session thread <thread> session <index>",
382  .function = clear_session_command_fn,
383 };
384 /* *INDENT-ON* */
385 
386 static clib_error_t *
388  unformat_input_t * input,
389  vlib_cli_command_t * cmd)
390 {
391  stream_session_t *s = 0;
392  u8 is_rx = 0, *str = 0;
393 
395  {
396  if (unformat (input, "%U", unformat_stream_session, &s))
397  ;
398  else if (unformat (input, "rx"))
399  is_rx = 1;
400  else if (unformat (input, "tx"))
401  is_rx = 0;
402  else
403  return clib_error_return (0, "unknown input `%U'",
404  format_unformat_error, input);
405  }
406 
407  if (!SVM_FIFO_TRACE)
408  {
409  vlib_cli_output (vm, "fifo tracing not enabled");
410  return 0;
411  }
412 
413  if (!s)
414  {
415  vlib_cli_output (vm, "could not find session");
416  return 0;
417  }
418 
419  str = is_rx ?
420  svm_fifo_dump_trace (str, s->server_rx_fifo) :
421  svm_fifo_dump_trace (str, s->server_tx_fifo);
422 
423  vlib_cli_output (vm, "%v", str);
424  return 0;
425 }
426 
427 /* *INDENT-OFF* */
428 VLIB_CLI_COMMAND (show_session_fifo_trace_command, static) =
429 {
430  .path = "show session fifo trace",
431  .short_help = "show session fifo trace <session>",
433 };
434 /* *INDENT-ON* */
435 
436 static clib_error_t *
438  vlib_cli_command_t * cmd)
439 {
440  stream_session_t *s = 0;
441  u8 is_rx = 0, *str = 0;
442 
444  {
445  if (unformat (input, "%U", unformat_stream_session, &s))
446  ;
447  else if (unformat (input, "rx"))
448  is_rx = 1;
449  else
450  return clib_error_return (0, "unknown input `%U'",
451  format_unformat_error, input);
452  }
453 
454  if (!SVM_FIFO_TRACE)
455  {
456  vlib_cli_output (vm, "fifo tracing not enabled");
457  return 0;
458  }
459 
460  if (!s)
461  {
462  vlib_cli_output (vm, "could not find session");
463  return 0;
464  }
465 
466  str = is_rx ?
467  svm_fifo_replay (str, s->server_rx_fifo, 0, 1) :
468  svm_fifo_replay (str, s->server_tx_fifo, 0, 1);
469 
470  vlib_cli_output (vm, "%v", str);
471  return 0;
472 }
473 
474 /* *INDENT-OFF* */
475 VLIB_CLI_COMMAND (session_replay_fifo_trace_command, static) =
476 {
477  .path = "session replay fifo",
478  .short_help = "session replay fifo <session>",
479  .function = session_replay_fifo_command_fn,
480 };
481 /* *INDENT-ON* */
482 
483 static clib_error_t *
485  vlib_cli_command_t * cmd)
486 {
487  unformat_input_t _line_input, *line_input = &_line_input;
488  u8 is_en = 1;
489  clib_error_t *error;
490 
491  if (!unformat_user (input, unformat_line_input, line_input))
492  return clib_error_return (0, "expected enable | disable");
493 
494  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
495  {
496  if (unformat (line_input, "enable"))
497  is_en = 1;
498  else if (unformat (line_input, "disable"))
499  is_en = 0;
500  else
501  {
502  error = clib_error_return (0, "unknown input `%U'",
503  format_unformat_error, line_input);
504  unformat_free (line_input);
505  return error;
506  }
507  }
508 
509  unformat_free (line_input);
510  return vnet_session_enable_disable (vm, is_en);
511 }
512 
513 /* *INDENT-OFF* */
514 VLIB_CLI_COMMAND (session_enable_disable_command, static) =
515 {
516  .path = "session",
517  .short_help = "session [enable|disable]",
518  .function = session_enable_disable_fn,
519 };
520 /* *INDENT-ON* */
521 
522 /*
523  * fd.io coding-style-patch-verification: ON
524  *
525  * Local Variables:
526  * eval: (c-set-style "gnu")
527  * End:
528  */
app_worker_t * app_worker_get(u32 wrk_index)
Definition: application.c:499
struct _transport_connection transport_connection_t
format_function_t format_svm_fifo
Definition: svm_fifo.h:206
session_manager_main_t session_manager_main
Definition: session.c:27
struct _transport_proto_vft transport_proto_vft_t
int i
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:983
static clib_error_t * clear_session_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: session_cli.c:324
static u32 svm_fifo_max_enqueue(svm_fifo_t *f)
Definition: svm_fifo.h:132
static void session_pool_remove_peeker(u32 thread_index)
Definition: session.h:445
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
unsigned char u8
Definition: types.h:56
#define vec_reset_length(v)
Reset vector length to zero NULL-pointer tolerant.
transport_connection_t * session_lookup_connection6(u32 fib_index, ip6_address_t *lcl, ip6_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto)
Lookup connection with ip6 and transport layer information.
memset(h->entries, 0, sizeof(h->entries[0])*entries)
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:443
unformat_function_t unformat_ip4_address
Definition: format.h:70
static u32 svm_fifo_max_dequeue(svm_fifo_t *f)
Definition: svm_fifo.h:114
#define clib_error_return(e, args...)
Definition: error.h:99
static clib_error_t * show_session_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: session_cli.c:206
unsigned int u32
Definition: types.h:88
struct _stream_session_t stream_session_t
u8 * format_stream_session(u8 *s, va_list *args)
Format stream session as per the following format.
Definition: session_cli.c:57
transport_connection_t * session_lookup_connection4(u32 fib_index, ip4_address_t *lcl, ip4_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto)
Lookup connection with ip4 and transport layer information.
unformat_function_t unformat_line_input
Definition: format.h:282
transport_proto_vft_t * transport_protocol_get_vft(transport_proto_t transport_proto)
Get transport virtual function table.
Definition: transport.c:191
static transport_proto_t session_get_transport_proto(stream_session_t *s)
Definition: session.h:397
struct _unformat_input_t unformat_input_t
static u32 session_get_index(stream_session_t *s)
Definition: session.h:498
unsigned short u16
Definition: types.h:57
stream_session_t * session_lookup_safe6(u32 fib_index, ip6_address_t *lcl, ip6_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto)
Lookup session with ip6 and transport layer information.
uword unformat_transport_connection(unformat_input_t *input, va_list *args)
Definition: session_cli.c:171
static stream_session_t * session_get_if_valid(u64 si, u32 thread_index)
Definition: session.h:321
struct _session_manager_main session_manager_main_t
Definition: session.h:176
u8 * svm_fifo_replay(u8 *s, svm_fifo_t *f, u8 no_read, u8 verbose)
Definition: svm_fifo.c:92
clib_error_t * vnet_session_enable_disable(vlib_main_t *vm, u8 is_en)
Definition: session.c:1461
uword unformat_stream_session_id(unformat_input_t *input, va_list *args)
Definition: session_cli.c:102
static int clear_session(stream_session_t *s)
Definition: session_cli.c:315
unformat_function_t unformat_ip6_address
Definition: format.h:91
#define UNFORMAT_END_OF_INPUT
Definition: format.h:144
static session_type_t session_type_from_proto_and_ip(transport_proto_t proto, u8 is_ip4)
Definition: session.h:410
vlib_main_t * vm
Definition: buffer.c:294
uword unformat_stream_session(unformat_input_t *input, va_list *args)
Definition: session_cli.c:140
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:339
u8 * format_stream_session_fifos(u8 *s, va_list *args)
Definition: session_cli.c:19
#define clib_warning(format, args...)
Definition: error.h:59
stream_session_t * session_lookup_safe4(u32 fib_index, ip4_address_t *lcl, ip4_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto)
Lookup session with ip4 and transport layer information.
application_t * application_get(u32 app_index)
Definition: application.c:243
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:155
#define SVM_FIFO_TRACE
Definition: svm_fifo.h:39
uword unformat_transport_proto(unformat_input_t *input, va_list *args)
Definition: transport.c:90
session_cb_vft_t cb_fns
Callbacks: shoulder-taps for the server/client.
Definition: application.h:131
u8 * svm_fifo_dump_trace(u8 *s, svm_fifo_t *f)
Definition: svm_fifo.c:68
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
u64 uword
Definition: types.h:112
static void unformat_free(unformat_input_t *i)
Definition: format.h:162
static clib_error_t * session_replay_fifo_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: session_cli.c:437
static clib_error_t * show_session_fifo_trace_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: session_cli.c:387
u32 app_index
Index of owning app.
Definition: application.h:72
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
#define vec_foreach(var, vec)
Vector iterator.
u8 session_node_lookup_fifo_event(svm_fifo_t *f, session_event_t *e)
static clib_error_t * session_enable_disable_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: session_cli.c:484
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:725
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
static uword pool_elts(void *v)
Number of active elements in a pool.
Definition: pool.h:128