2 * Copyright (c) 2017-2019 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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #include <vnet/session/application.h>
16 #include <vnet/session/session.h>
19 format_session_fifos (u8 * s, va_list * args)
21 session_t *ss = va_arg (*args, session_t *);
22 int verbose = va_arg (*args, int);
23 session_event_t _e, *e = &_e;
26 if (!ss->rx_fifo || !ss->tx_fifo)
29 s = format (s, " Rx fifo: %U", format_svm_fifo, ss->rx_fifo, verbose);
30 if (verbose > 2 && ss->rx_fifo->shr->has_event)
32 found = session_node_lookup_fifo_event (ss->rx_fifo, e);
33 s = format (s, " session node event: %s\n",
34 found ? "found" : "not found");
36 s = format (s, " Tx fifo: %U", format_svm_fifo, ss->tx_fifo, verbose);
37 if (verbose > 2 && ss->tx_fifo->shr->has_event)
39 found = session_node_lookup_fifo_event (ss->tx_fifo, e);
40 s = format (s, " session node event: %s\n",
41 found ? "found" : "not found");
46 const char *session_state_str[] = {
47 #define _(sym, str) str,
53 format_session_state (u8 * s, va_list * args)
55 session_t *ss = va_arg (*args, session_t *);
57 if (ss->session_state < SESSION_N_STATES)
58 s = format (s, "%s", session_state_str[ss->session_state]);
60 s = format (s, "UNKNOWN STATE (%d)", ss->session_state);
65 const char *session_flags_str[] = {
66 #define _(sym, str) str,
72 format_session_flags (u8 * s, va_list * args)
74 session_t *ss = va_arg (*args, session_t *);
77 for (i = 0; i < SESSION_N_FLAGS; i++)
78 if (ss->flags & (1 << i))
81 for (i = 0; i < last; i++)
83 if (ss->flags & (1 << i))
84 s = format (s, "%s, ", session_flags_str[i]);
87 s = format (s, "%s", session_flags_str[last]);
93 * Format stream session as per the following format
96 * "Connection", "Rx fifo", "Tx fifo", "Session Index"
101 format_session (u8 * s, va_list * args)
103 session_t *ss = va_arg (*args, session_t *);
104 int verbose = va_arg (*args, int);
105 u32 tp = session_get_transport_proto (ss);
108 if (ss->session_state >= SESSION_STATE_TRANSPORT_DELETED)
110 s = format (s, "[%u:%u] CLOSED", ss->thread_index, ss->session_index);
118 rxf = ss->rx_fifo ? svm_fifo_max_dequeue (ss->rx_fifo) : 0;
119 txf = ss->tx_fifo ? svm_fifo_max_dequeue (ss->tx_fifo) : 0;
120 str = format (0, "%-10u%-10u", rxf, txf);
123 if (ss->session_state >= SESSION_STATE_ACCEPTING
124 || ss->session_state == SESSION_STATE_CREATED)
126 s = format (s, "%U", format_transport_connection, tp,
127 ss->connection_index, ss->thread_index, verbose);
129 s = format (s, "%v", str);
132 s = format (s, "%U", format_session_fifos, ss, verbose);
133 s = format (s, " session: state: %U opaque: 0x%x flags: %U\n",
134 format_session_state, ss, ss->opaque,
135 format_session_flags, ss);
138 else if (ss->session_state == SESSION_STATE_LISTENING)
140 s = format (s, "%U%v", format_transport_listen_connection,
141 tp, ss->connection_index, ss->thread_index, verbose, str);
143 s = format (s, "\n%U", format_session_fifos, ss, verbose);
145 else if (ss->session_state == SESSION_STATE_CONNECTING)
147 s = format (s, "%-40U%v", format_transport_half_open_connection,
148 tp, ss->connection_index, ss->thread_index, str);
152 clib_warning ("Session in state: %d!", ss->session_state);
160 unformat_stream_session_id (unformat_input_t * input, va_list * args)
162 u8 *proto = va_arg (*args, u8 *);
163 u32 *fib_index = va_arg (*args, u32 *);
164 ip46_address_t *lcl = va_arg (*args, ip46_address_t *);
165 ip46_address_t *rmt = va_arg (*args, ip46_address_t *);
166 u16 *lcl_port = va_arg (*args, u16 *);
167 u16 *rmt_port = va_arg (*args, u16 *);
168 u8 *is_ip4 = va_arg (*args, u8 *);
172 clib_memset (lcl, 0, sizeof (*lcl));
173 clib_memset (rmt, 0, sizeof (*rmt));
175 if (unformat (input, "tcp"))
177 *proto = TRANSPORT_PROTO_TCP;
179 else if (unformat (input, "udp"))
181 *proto = TRANSPORT_PROTO_UDP;
186 if (unformat (input, "vrf %u", &vrf))
189 if (unformat (input, "%U:%d->%U:%d", unformat_ip4_address, &lcl->ip4,
190 lcl_port, unformat_ip4_address, &rmt->ip4, rmt_port))
195 else if (unformat (input, "%U:%d->%U:%d", unformat_ip6_address, &lcl->ip6,
196 lcl_port, unformat_ip6_address, &rmt->ip6, rmt_port))
204 fib_protocol_t fib_proto;
205 fib_proto = *is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
206 *fib_index = fib_table_find (fib_proto, vrf);
213 unformat_session_state (unformat_input_t * input, va_list * args)
215 session_state_t *state = va_arg (*args, session_state_t *);
219 #define _(sym, str) \
220 if (unformat (input, str)) \
222 *state = SESSION_STATE_ ## sym; \
226 foreach_session_state
229 vec_free (state_vec);
234 unformat_session (unformat_input_t * input, va_list * args)
236 session_t **result = va_arg (*args, session_t **);
237 u32 lcl_port = 0, rmt_port = 0, fib_index = 0;
238 ip46_address_t lcl, rmt;
243 if (!unformat (input, "%U", unformat_stream_session_id, &proto, &fib_index,
244 &lcl, &rmt, &lcl_port, &rmt_port, &is_ip4))
248 s = session_lookup_safe4 (fib_index, &lcl.ip4, &rmt.ip4,
249 clib_host_to_net_u16 (lcl_port),
250 clib_host_to_net_u16 (rmt_port), proto);
252 s = session_lookup_safe6 (fib_index, &lcl.ip6, &rmt.ip6,
253 clib_host_to_net_u16 (lcl_port),
254 clib_host_to_net_u16 (rmt_port), proto);
258 session_pool_remove_peeker (s->thread_index);
265 unformat_transport_connection (unformat_input_t * input, va_list * args)
267 transport_connection_t **result = va_arg (*args, transport_connection_t **);
268 u32 suggested_proto = va_arg (*args, u32);
269 transport_connection_t *tc;
271 ip46_address_t lcl, rmt;
272 u32 lcl_port = 0, rmt_port = 0, fib_index = 0;
275 if (!unformat (input, "%U", unformat_stream_session_id, &fib_index, &proto,
276 &lcl, &rmt, &lcl_port, &rmt_port, &is_ip4))
279 proto = (proto == (u8) ~ 0) ? suggested_proto : proto;
280 if (proto == (u8) ~ 0)
283 tc = session_lookup_connection4 (fib_index, &lcl.ip4, &rmt.ip4,
284 clib_host_to_net_u16 (lcl_port),
285 clib_host_to_net_u16 (rmt_port), proto);
287 tc = session_lookup_connection6 (fib_index, &lcl.ip6, &rmt.ip6,
288 clib_host_to_net_u16 (lcl_port),
289 clib_host_to_net_u16 (rmt_port), proto);
300 session_cli_show_all_sessions (vlib_main_t * vm, int verbose)
302 session_main_t *smm = &session_main;
303 u32 n_closed, thread_index;
306 for (thread_index = 0; thread_index < vec_len (smm->wrk); thread_index++)
308 pool = smm->wrk[thread_index].sessions;
310 if (!pool_elts (pool))
312 vlib_cli_output (vm, "Thread %d: no sessions", thread_index);
318 vlib_cli_output (vm, "Thread %d: %d sessions", thread_index,
323 if (pool_elts (pool) > 50)
325 vlib_cli_output (vm, "Thread %u: %d sessions. Verbose output "
326 "suppressed. For more details use filters.",
327 thread_index, pool_elts (pool));
332 vlib_cli_output (vm, "%s%-" SESSION_CLI_ID_LEN "s%-"
333 SESSION_CLI_STATE_LEN "s%-10s%-10s",
334 thread_index ? "\n" : "",
335 "Connection", "State", "Rx-f", "Tx-f");
340 pool_foreach (s, pool) {
341 if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
346 vlib_cli_output (vm, "%U", format_session, s, verbose);
351 vlib_cli_output (vm, "Thread %d: active sessions %u", thread_index,
352 pool_elts (pool) - n_closed);
354 vlib_cli_output (vm, "Thread %d: active sessions %u closed %u",
355 thread_index, pool_elts (pool) - n_closed, n_closed);
360 session_cli_filter_check (session_t * s, session_state_t * states,
361 transport_proto_t tp)
365 session_state_t *state;
366 vec_foreach (state, states) if (s->session_state == *state)
367 goto check_transport;
373 if (tp != TRANSPORT_PROTO_INVALID && session_get_transport_proto (s) != tp)
380 session_cli_show_session_filter (vlib_main_t * vm, u32 thread_index,
381 u32 start, u32 end, session_state_t * states,
382 transport_proto_t tp, int verbose)
384 u8 output_suppressed = 0;
385 session_worker_t *wrk;
387 u32 count = 0, max_index;
390 wrk = session_main_get_worker_if_valid (thread_index);
393 vlib_cli_output (vm, "invalid thread index %u", thread_index);
397 pool = wrk->sessions;
399 if (tp == TRANSPORT_PROTO_INVALID && states == 0 && !verbose
400 && (start == 0 && end == ~0))
402 vlib_cli_output (vm, "Thread %d: %u sessions", thread_index,
407 max_index = pool_len (pool) ? pool_len (pool) - 1 : 0;
408 for (i = start; i <= clib_min (end, max_index); i++)
410 if (pool_is_free_index (pool, i))
413 s = pool_elt_at_index (pool, i);
415 if (session_cli_filter_check (s, states, tp))
420 if (count > 50 || (verbose > 1 && count > 10))
422 output_suppressed = 1;
425 if (s->session_state < SESSION_STATE_TRANSPORT_DELETED)
426 vlib_cli_output (vm, "%U", format_session, s, verbose);
431 if (!output_suppressed)
432 vlib_cli_output (vm, "Thread %d: %u sessions matched filter",
433 thread_index, count);
435 vlib_cli_output (vm, "Thread %d: %u sessions matched filter. Not all"
436 " shown. Use finer grained filter.", thread_index,
441 session_cli_show_events_thread (vlib_main_t * vm, u32 thread_index)
443 session_worker_t *wrk;
445 wrk = session_main_get_worker_if_valid (thread_index);
448 vlib_cli_output (vm, "invalid thread index %u", thread_index);
452 vlib_cli_output (vm, "Thread %d:\n", thread_index);
453 vlib_cli_output (vm, " evt elements alloc: %u",
454 pool_elts (wrk->event_elts));
455 vlib_cli_output (vm, " ctrl evt elt data alloc: %d",
456 pool_elts (wrk->ctrl_evts_data));
460 session_cli_show_events (vlib_main_t * vm, u32 thread_index)
462 session_main_t *smm = &session_main;
465 session_cli_show_events_thread (vm, thread_index);
469 for (thread_index = 0; thread_index < vec_len (smm->wrk); thread_index++)
470 session_cli_show_events_thread (vm, thread_index);
474 session_cli_print_session_states (vlib_main_t * vm)
476 #define _(sym, str) vlib_cli_output (vm, str);
477 foreach_session_state
481 static clib_error_t *
482 show_session_command_fn (vlib_main_t * vm, unformat_input_t * input,
483 vlib_cli_command_t * cmd)
485 u8 one_session = 0, do_listeners = 0, sst, do_elog = 0, do_filter = 0;
486 u32 track_index, thread_index = 0, start = 0, end = ~0, session_index;
487 unformat_input_t _line_input, *line_input = &_line_input;
488 transport_proto_t transport_proto = TRANSPORT_PROTO_INVALID;
489 session_state_t state = SESSION_N_STATES, *states = 0;
490 session_main_t *smm = &session_main;
491 clib_error_t *error = 0;
492 app_worker_t *app_wrk;
499 session_cli_return_if_not_enabled ();
501 if (!unformat_user (input, unformat_line_input, line_input))
503 session_cli_show_all_sessions (vm, 0);
507 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
509 if (unformat (line_input, "verbose %d", &verbose))
511 else if (unformat (line_input, "verbose"))
513 else if (unformat (line_input, "listeners %U", unformat_transport_proto,
516 else if (unformat (line_input, "%U", unformat_session, &s))
520 else if (unformat (line_input, "thread %u index %u", &thread_index,
523 s = session_get_if_valid (session_index, thread_index);
526 vlib_cli_output (vm, "session is not allocated");
531 else if (unformat (line_input, "thread %u", &thread_index))
536 if (unformat (line_input, "state %U", unformat_session_state, &state))
538 vec_add1 (states, state);
541 else if (unformat (line_input, "proto %U index %u",
542 unformat_transport_proto, &transport_proto,
545 transport_connection_t *tc;
546 tc = transport_get_connection (transport_proto, transport_index,
550 vlib_cli_output (vm, "transport connection %u thread %u is not"
551 " allocated", transport_index, thread_index);
554 s = session_get_if_valid (tc->s_index, thread_index);
557 vlib_cli_output (vm, "session for transport connection %u "
558 "thread %u does not exist", transport_index,
564 else if (unformat (line_input, "proto %U", unformat_transport_proto,
567 else if (unformat (line_input, "range %u %u", &start, &end))
569 else if (unformat (line_input, "range %u", &start))
574 else if (unformat (line_input, "elog"))
576 else if (unformat (line_input, "protos"))
578 vlib_cli_output (vm, "%U", format_transport_protos);
581 else if (unformat (line_input, "states"))
583 session_cli_print_session_states (vm);
586 else if (unformat (line_input, "events"))
590 error = clib_error_return (0, "unknown input `%U'",
591 format_unformat_error, line_input);
598 u8 *str = format (0, "%U", format_session, s, 3);
599 if (do_elog && s->session_state != SESSION_STATE_LISTENING)
601 elog_main_t *em = &vm->elog_main;
602 transport_connection_t *tc;
605 tc = session_get_transport (s);
606 track_index = transport_elog_track_index (tc);
607 dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
608 * vm->clib_time.seconds_per_clock;
609 if (track_index != ~0)
610 str = format (str, " session elog:\n%U", format_elog_track, em,
613 vlib_cli_output (vm, "%v", str);
620 sst = session_type_from_proto_and_ip (transport_proto, 1);
621 vlib_cli_output (vm, "%-" SESSION_CLI_ID_LEN "s%-24s", "Listener",
625 pool_foreach (s, smm->wrk[0].sessions) {
626 if (s->session_state != SESSION_STATE_LISTENING
627 || s->session_type != sst)
629 app_wrk = app_worker_get (s->app_wrk_index);
630 app_name = application_name_from_index (app_wrk->app_index);
631 vlib_cli_output (vm, "%U%-25v%", format_session, s, 0,
640 session_cli_show_events (vm, thread_index);
648 error = clib_error_return (0, "invalid range start: %u end: %u",
652 session_cli_show_session_filter (vm, thread_index, start, end, states,
653 transport_proto, verbose);
657 session_cli_show_all_sessions (vm, verbose);
660 unformat_free (line_input);
666 VLIB_CLI_COMMAND (vlib_cli_show_session_command) =
668 .path = "show session",
669 .short_help = "show session [verbose [n]] [listeners <proto>] "
670 "[<session-id> [elog]] [thread <n> [index <n>] "
671 "[proto <proto>] [state <state>] [range <min> [<max>]] "
672 "[protos] [states] ",
673 .function = show_session_command_fn,
678 clear_session (session_t * s)
680 app_worker_t *server_wrk = app_worker_get (s->app_wrk_index);
681 app_worker_close_notify (server_wrk, s);
685 static clib_error_t *
686 clear_session_command_fn (vlib_main_t * vm, unformat_input_t * input,
687 vlib_cli_command_t * cmd)
689 session_main_t *smm = &session_main;
690 u32 thread_index = 0, clear_all = 0;
691 session_worker_t *wrk;
692 u32 session_index = ~0;
695 if (!smm->is_enabled)
697 return clib_error_return (0, "session layer is not enabled");
700 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
702 if (unformat (input, "thread %d", &thread_index))
704 else if (unformat (input, "session %d", &session_index))
706 else if (unformat (input, "all"))
709 return clib_error_return (0, "unknown input `%U'",
710 format_unformat_error, input);
713 if (!clear_all && session_index == ~0)
714 return clib_error_return (0, "session <nn> required, but not set.");
716 if (session_index != ~0)
718 session = session_get_if_valid (session_index, thread_index);
720 return clib_error_return (0, "no session %d on thread %d",
721 session_index, thread_index);
722 clear_session (session);
728 vec_foreach (wrk, smm->wrk)
730 pool_foreach (session, wrk->sessions) {
731 clear_session (session);
741 VLIB_CLI_COMMAND (clear_session_command, static) =
743 .path = "clear session",
744 .short_help = "clear session thread <thread> session <index>",
745 .function = clear_session_command_fn,
749 static clib_error_t *
750 show_session_fifo_trace_command_fn (vlib_main_t * vm,
751 unformat_input_t * input,
752 vlib_cli_command_t * cmd)
755 u8 is_rx = 0, *str = 0;
757 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
759 if (unformat (input, "%U", unformat_session, &s))
761 else if (unformat (input, "rx"))
763 else if (unformat (input, "tx"))
766 return clib_error_return (0, "unknown input `%U'",
767 format_unformat_error, input);
772 vlib_cli_output (vm, "fifo tracing not enabled");
778 vlib_cli_output (vm, "could not find session");
783 svm_fifo_dump_trace (str, s->rx_fifo) :
784 svm_fifo_dump_trace (str, s->tx_fifo);
786 vlib_cli_output (vm, "%v", str);
791 VLIB_CLI_COMMAND (show_session_fifo_trace_command, static) =
793 .path = "show session fifo trace",
794 .short_help = "show session fifo trace <session>",
795 .function = show_session_fifo_trace_command_fn,
799 static clib_error_t *
800 session_replay_fifo_command_fn (vlib_main_t * vm, unformat_input_t * input,
801 vlib_cli_command_t * cmd)
804 u8 is_rx = 0, *str = 0;
806 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
808 if (unformat (input, "%U", unformat_session, &s))
810 else if (unformat (input, "rx"))
813 return clib_error_return (0, "unknown input `%U'",
814 format_unformat_error, input);
819 vlib_cli_output (vm, "fifo tracing not enabled");
825 vlib_cli_output (vm, "could not find session");
830 svm_fifo_replay (str, s->rx_fifo, 0, 1) :
831 svm_fifo_replay (str, s->tx_fifo, 0, 1);
833 vlib_cli_output (vm, "%v", str);
838 VLIB_CLI_COMMAND (session_replay_fifo_trace_command, static) =
840 .path = "session replay fifo",
841 .short_help = "session replay fifo <session>",
842 .function = session_replay_fifo_command_fn,
846 static clib_error_t *
847 session_enable_disable_fn (vlib_main_t * vm, unformat_input_t * input,
848 vlib_cli_command_t * cmd)
850 unformat_input_t _line_input, *line_input = &_line_input;
854 if (!unformat_user (input, unformat_line_input, line_input))
855 return clib_error_return (0, "expected enable | disable");
857 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
859 if (unformat (line_input, "enable"))
861 else if (unformat (line_input, "disable"))
865 error = clib_error_return (0, "unknown input `%U'",
866 format_unformat_error, line_input);
867 unformat_free (line_input);
872 unformat_free (line_input);
873 return vnet_session_enable_disable (vm, is_en);
877 VLIB_CLI_COMMAND (session_enable_disable_command, static) =
880 .short_help = "session [enable|disable]",
881 .function = session_enable_disable_fn,
886 * fd.io coding-style-patch-verification: ON
889 * eval: (c-set-style "gnu")