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