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 if (ss->flags & SESSION_F_HALF_OPEN)
149 s = format (s, "%U", format_transport_half_open_connection, tp,
150 ss->connection_index, ss->thread_index, verbose);
151 s = format (s, "%v", str);
154 s = format (s, "%U", format_transport_connection, tp,
155 ss->connection_index, ss->thread_index, verbose);
159 clib_warning ("Session in state: %d!", ss->session_state);
167 unformat_stream_session_id (unformat_input_t * input, va_list * args)
169 u8 *proto = va_arg (*args, u8 *);
170 u32 *fib_index = va_arg (*args, u32 *);
171 ip46_address_t *lcl = va_arg (*args, ip46_address_t *);
172 ip46_address_t *rmt = va_arg (*args, ip46_address_t *);
173 u16 *lcl_port = va_arg (*args, u16 *);
174 u16 *rmt_port = va_arg (*args, u16 *);
175 u8 *is_ip4 = va_arg (*args, u8 *);
179 clib_memset (lcl, 0, sizeof (*lcl));
180 clib_memset (rmt, 0, sizeof (*rmt));
182 if (unformat (input, "tcp"))
184 *proto = TRANSPORT_PROTO_TCP;
186 else if (unformat (input, "udp"))
188 *proto = TRANSPORT_PROTO_UDP;
193 if (unformat (input, "vrf %u", &vrf))
196 if (unformat (input, "%U:%d->%U:%d", unformat_ip4_address, &lcl->ip4,
197 lcl_port, unformat_ip4_address, &rmt->ip4, rmt_port))
202 else if (unformat (input, "%U:%d->%U:%d", unformat_ip6_address, &lcl->ip6,
203 lcl_port, unformat_ip6_address, &rmt->ip6, rmt_port))
211 fib_protocol_t fib_proto;
212 fib_proto = *is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
213 *fib_index = fib_table_find (fib_proto, vrf);
220 unformat_session_state (unformat_input_t * input, va_list * args)
222 session_state_t *state = va_arg (*args, session_state_t *);
226 #define _(sym, str) \
227 if (unformat (input, str)) \
229 *state = SESSION_STATE_ ## sym; \
233 foreach_session_state
236 vec_free (state_vec);
241 unformat_session (unformat_input_t * input, va_list * args)
243 session_t **result = va_arg (*args, session_t **);
244 u32 lcl_port = 0, rmt_port = 0, fib_index = 0;
245 ip46_address_t lcl, rmt;
250 if (!unformat (input, "%U", unformat_stream_session_id, &proto, &fib_index,
251 &lcl, &rmt, &lcl_port, &rmt_port, &is_ip4))
255 s = session_lookup_safe4 (fib_index, &lcl.ip4, &rmt.ip4,
256 clib_host_to_net_u16 (lcl_port),
257 clib_host_to_net_u16 (rmt_port), proto);
259 s = session_lookup_safe6 (fib_index, &lcl.ip6, &rmt.ip6,
260 clib_host_to_net_u16 (lcl_port),
261 clib_host_to_net_u16 (rmt_port), proto);
271 unformat_transport_connection (unformat_input_t * input, va_list * args)
273 transport_connection_t **result = va_arg (*args, transport_connection_t **);
274 u32 suggested_proto = va_arg (*args, u32);
275 transport_connection_t *tc;
277 ip46_address_t lcl, rmt;
278 u32 lcl_port = 0, rmt_port = 0, fib_index = 0;
281 if (!unformat (input, "%U", unformat_stream_session_id, &fib_index, &proto,
282 &lcl, &rmt, &lcl_port, &rmt_port, &is_ip4))
285 proto = (proto == (u8) ~ 0) ? suggested_proto : proto;
286 if (proto == (u8) ~ 0)
289 tc = session_lookup_connection4 (fib_index, &lcl.ip4, &rmt.ip4,
290 clib_host_to_net_u16 (lcl_port),
291 clib_host_to_net_u16 (rmt_port), proto);
293 tc = session_lookup_connection6 (fib_index, &lcl.ip6, &rmt.ip6,
294 clib_host_to_net_u16 (lcl_port),
295 clib_host_to_net_u16 (rmt_port), proto);
306 session_cli_show_all_sessions (vlib_main_t * vm, int verbose)
308 session_main_t *smm = &session_main;
309 u32 n_closed, thread_index;
312 for (thread_index = 0; thread_index < vec_len (smm->wrk); thread_index++)
314 pool = smm->wrk[thread_index].sessions;
316 if (!pool_elts (pool))
318 vlib_cli_output (vm, "Thread %d: no sessions", thread_index);
324 vlib_cli_output (vm, "Thread %d: %d sessions", thread_index,
329 if (pool_elts (pool) > 50)
331 vlib_cli_output (vm, "Thread %u: %d sessions. Verbose output "
332 "suppressed. For more details use filters.",
333 thread_index, pool_elts (pool));
338 vlib_cli_output (vm, "%s%-" SESSION_CLI_ID_LEN "s%-"
339 SESSION_CLI_STATE_LEN "s%-10s%-10s",
340 thread_index ? "\n" : "",
341 "Connection", "State", "Rx-f", "Tx-f");
346 pool_foreach (s, pool) {
347 if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
352 vlib_cli_output (vm, "%U", format_session, s, verbose);
357 vlib_cli_output (vm, "Thread %d: active sessions %u", thread_index,
358 pool_elts (pool) - n_closed);
360 vlib_cli_output (vm, "Thread %d: active sessions %u closed %u",
361 thread_index, pool_elts (pool) - n_closed, n_closed);
366 session_cli_filter_check (session_t * s, session_state_t * states,
367 transport_proto_t tp)
371 session_state_t *state;
372 vec_foreach (state, states) if (s->session_state == *state)
373 goto check_transport;
379 if (tp != TRANSPORT_PROTO_INVALID && session_get_transport_proto (s) != tp)
386 session_cli_show_session_filter (vlib_main_t * vm, u32 thread_index,
387 u32 start, u32 end, session_state_t * states,
388 transport_proto_t tp, int verbose)
390 u8 output_suppressed = 0;
391 session_worker_t *wrk;
393 u32 count = 0, max_index;
396 wrk = session_main_get_worker_if_valid (thread_index);
399 vlib_cli_output (vm, "invalid thread index %u", thread_index);
403 pool = wrk->sessions;
405 if (tp == TRANSPORT_PROTO_INVALID && states == 0 && !verbose
406 && (start == 0 && end == ~0))
408 vlib_cli_output (vm, "Thread %d: %u sessions", thread_index,
413 max_index = pool_len (pool) ? pool_len (pool) - 1 : 0;
414 for (i = start; i <= clib_min (end, max_index); i++)
416 if (pool_is_free_index (pool, i))
419 s = pool_elt_at_index (pool, i);
421 if (session_cli_filter_check (s, states, tp))
426 if (count > 50 || (verbose > 1 && count > 10))
428 output_suppressed = 1;
431 if (s->session_state < SESSION_STATE_TRANSPORT_DELETED)
432 vlib_cli_output (vm, "%U", format_session, s, verbose);
437 if (!output_suppressed)
438 vlib_cli_output (vm, "Thread %d: %u sessions matched filter",
439 thread_index, count);
441 vlib_cli_output (vm, "Thread %d: %u sessions matched filter. Not all"
442 " shown. Use finer grained filter.", thread_index,
447 session_cli_show_events_thread (vlib_main_t * vm, u32 thread_index)
449 session_worker_t *wrk;
451 wrk = session_main_get_worker_if_valid (thread_index);
454 vlib_cli_output (vm, "invalid thread index %u", thread_index);
458 vlib_cli_output (vm, "Thread %d:\n", thread_index);
459 vlib_cli_output (vm, " evt elements alloc: %u",
460 clib_llist_elts (wrk->event_elts));
461 vlib_cli_output (vm, " ctrl evt elt data alloc: %d",
462 clib_llist_elts (wrk->ctrl_evts_data));
466 session_cli_show_events (vlib_main_t * vm, u32 thread_index)
468 session_main_t *smm = &session_main;
471 session_cli_show_events_thread (vm, thread_index);
475 for (thread_index = 0; thread_index < vec_len (smm->wrk); thread_index++)
476 session_cli_show_events_thread (vm, thread_index);
480 session_cli_print_session_states (vlib_main_t * vm)
482 #define _(sym, str) vlib_cli_output (vm, str);
483 foreach_session_state
487 static clib_error_t *
488 show_session_command_fn (vlib_main_t * vm, unformat_input_t * input,
489 vlib_cli_command_t * cmd)
491 u8 one_session = 0, do_listeners = 0, sst, do_elog = 0, do_filter = 0;
492 u32 track_index, thread_index = 0, start = 0, end = ~0, session_index;
493 transport_proto_t transport_proto = TRANSPORT_PROTO_INVALID;
494 session_state_t state = SESSION_N_STATES, *states = 0;
495 session_main_t *smm = &session_main;
496 clib_error_t *error = 0;
497 app_worker_t *app_wrk;
504 session_cli_return_if_not_enabled ();
506 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
508 if (unformat (input, "verbose %d", &verbose))
510 else if (unformat (input, "verbose"))
512 else if (unformat (input, "listeners %U", unformat_transport_proto,
515 else if (unformat (input, "%U", unformat_session, &s))
519 else if (unformat (input, "thread %u index %u", &thread_index,
522 s = session_get_if_valid (session_index, thread_index);
525 vlib_cli_output (vm, "session is not allocated");
530 else if (unformat (input, "thread %u", &thread_index))
534 else if (unformat (input, "state %U", unformat_session_state, &state))
536 vec_add1 (states, state);
539 else if (unformat (input, "proto %U index %u", unformat_transport_proto,
540 &transport_proto, &transport_index))
542 transport_connection_t *tc;
543 tc = transport_get_connection (transport_proto, transport_index,
547 vlib_cli_output (vm, "transport connection %u thread %u is not"
548 " allocated", transport_index, thread_index);
551 s = session_get_if_valid (tc->s_index, thread_index);
554 vlib_cli_output (vm, "session for transport connection %u "
555 "thread %u does not exist", transport_index,
561 else if (unformat (input, "proto %U", unformat_transport_proto,
564 else if (unformat (input, "range %u %u", &start, &end))
566 else if (unformat (input, "range %u", &start))
571 else if (unformat (input, "elog"))
573 else if (unformat (input, "protos"))
575 vlib_cli_output (vm, "%U", format_transport_protos);
578 else if (unformat (input, "states"))
580 session_cli_print_session_states (vm);
583 else if (unformat (input, "events"))
587 error = clib_error_return (0, "unknown input `%U'",
588 format_unformat_error, input);
595 u8 *str = format (0, "%U", format_session, s, 3);
596 if (do_elog && s->session_state != SESSION_STATE_LISTENING)
598 elog_main_t *em = &vlib_global_main.elog_main;
599 transport_connection_t *tc;
602 tc = session_get_transport (s);
603 track_index = transport_elog_track_index (tc);
604 dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
605 * vm->clib_time.seconds_per_clock;
606 if (track_index != ~0)
607 str = format (str, " session elog:\n%U", format_elog_track, em,
610 vlib_cli_output (vm, "%v", str);
617 sst = session_type_from_proto_and_ip (transport_proto, 1);
618 vlib_cli_output (vm, "%-" SESSION_CLI_ID_LEN "s%-24s", "Listener",
622 pool_foreach (s, smm->wrk[0].sessions) {
623 if (s->session_state != SESSION_STATE_LISTENING
624 || s->session_type != sst)
626 app_wrk = app_worker_get (s->app_wrk_index);
627 app_name = application_name_from_index (app_wrk->app_index);
628 vlib_cli_output (vm, "%U%-25v%", format_session, s, 0,
637 session_cli_show_events (vm, thread_index);
645 error = clib_error_return (0, "invalid range start: %u end: %u",
649 session_cli_show_session_filter (vm, thread_index, start, end, states,
650 transport_proto, verbose);
654 session_cli_show_all_sessions (vm, verbose);
662 VLIB_CLI_COMMAND (vlib_cli_show_session_command) =
664 .path = "show session",
665 .short_help = "show session [verbose [n]] [listeners <proto>] "
666 "[<session-id> [elog]] [thread <n> [index <n>] "
667 "[proto <proto>] [state <state>] [range <min> [<max>]] "
668 "[protos] [states] ",
669 .function = show_session_command_fn,
674 clear_session (session_t * s)
676 app_worker_t *server_wrk = app_worker_get (s->app_wrk_index);
677 app_worker_close_notify (server_wrk, s);
681 static clib_error_t *
682 clear_session_command_fn (vlib_main_t * vm, unformat_input_t * input,
683 vlib_cli_command_t * cmd)
685 session_main_t *smm = &session_main;
686 u32 thread_index = 0, clear_all = 0;
687 session_worker_t *wrk;
688 u32 session_index = ~0;
691 if (!smm->is_enabled)
693 return clib_error_return (0, "session layer is not enabled");
696 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
698 if (unformat (input, "thread %d", &thread_index))
700 else if (unformat (input, "session %d", &session_index))
702 else if (unformat (input, "all"))
705 return clib_error_return (0, "unknown input `%U'",
706 format_unformat_error, input);
709 if (!clear_all && session_index == ~0)
710 return clib_error_return (0, "session <nn> required, but not set.");
712 if (session_index != ~0)
714 session = session_get_if_valid (session_index, thread_index);
716 return clib_error_return (0, "no session %d on thread %d",
717 session_index, thread_index);
718 clear_session (session);
724 vec_foreach (wrk, smm->wrk)
726 pool_foreach (session, wrk->sessions) {
727 clear_session (session);
737 VLIB_CLI_COMMAND (clear_session_command, static) =
739 .path = "clear session",
740 .short_help = "clear session thread <thread> session <index>",
741 .function = clear_session_command_fn,
745 static clib_error_t *
746 show_session_fifo_trace_command_fn (vlib_main_t * vm,
747 unformat_input_t * input,
748 vlib_cli_command_t * cmd)
751 u8 is_rx = 0, *str = 0;
753 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
755 if (unformat (input, "%U", unformat_session, &s))
757 else if (unformat (input, "rx"))
759 else if (unformat (input, "tx"))
762 return clib_error_return (0, "unknown input `%U'",
763 format_unformat_error, input);
768 vlib_cli_output (vm, "fifo tracing not enabled");
774 vlib_cli_output (vm, "could not find session");
779 svm_fifo_dump_trace (str, s->rx_fifo) :
780 svm_fifo_dump_trace (str, s->tx_fifo);
782 vlib_cli_output (vm, "%v", str);
787 VLIB_CLI_COMMAND (show_session_fifo_trace_command, static) =
789 .path = "show session fifo trace",
790 .short_help = "show session fifo trace <session>",
791 .function = show_session_fifo_trace_command_fn,
795 static clib_error_t *
796 session_replay_fifo_command_fn (vlib_main_t * vm, unformat_input_t * input,
797 vlib_cli_command_t * cmd)
800 u8 is_rx = 0, *str = 0;
802 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
804 if (unformat (input, "%U", unformat_session, &s))
806 else if (unformat (input, "rx"))
809 return clib_error_return (0, "unknown input `%U'",
810 format_unformat_error, input);
815 vlib_cli_output (vm, "fifo tracing not enabled");
821 vlib_cli_output (vm, "could not find session");
826 svm_fifo_replay (str, s->rx_fifo, 0, 1) :
827 svm_fifo_replay (str, s->tx_fifo, 0, 1);
829 vlib_cli_output (vm, "%v", str);
834 VLIB_CLI_COMMAND (session_replay_fifo_trace_command, static) =
836 .path = "session replay fifo",
837 .short_help = "session replay fifo <session>",
838 .function = session_replay_fifo_command_fn,
842 static clib_error_t *
843 session_enable_disable_fn (vlib_main_t * vm, unformat_input_t * input,
844 vlib_cli_command_t * cmd)
848 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
850 if (unformat (input, "enable"))
852 else if (unformat (input, "disable"))
855 return clib_error_return (0, "unknown input `%U'",
856 format_unformat_error, input);
860 return clib_error_return (0, "expected enable | disable");
862 return vnet_session_enable_disable (vm, is_en);
866 VLIB_CLI_COMMAND (session_enable_disable_command, static) =
869 .short_help = "session [enable|disable]",
870 .function = session_enable_disable_fn,
874 static clib_error_t *
875 show_session_stats_fn (vlib_main_t *vm, unformat_input_t *input,
876 vlib_cli_command_t *cmd)
878 session_main_t *smm = &session_main;
879 session_worker_t *wrk;
882 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
883 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
886 vec_foreach (wrk, smm->wrk)
888 vlib_cli_output (vm, "Thread %u:\n", wrk - smm->wrk);
889 e = wrk->stats.errors;
890 #define _(name, str) \
891 if (e[SESSION_EP_##name]) \
892 vlib_cli_output (vm, " %lu %s", e[SESSION_EP_##name], str);
893 foreach_session_error
899 VLIB_CLI_COMMAND (show_session_stats_command, static) = {
900 .path = "show session stats",
901 .short_help = "show session stats",
902 .function = show_session_stats_fn,
905 static clib_error_t *
906 clear_session_stats_fn (vlib_main_t *vm, unformat_input_t *input,
907 vlib_cli_command_t *cmd)
909 session_main_t *smm = &session_main;
910 session_worker_t *wrk;
912 if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
913 return clib_error_return (0, "unknown input `%U'", format_unformat_error,
916 vec_foreach (wrk, smm->wrk)
918 clib_memset (&wrk->stats, 0, sizeof (wrk->stats));
924 VLIB_CLI_COMMAND (clear_session_stats_command, static) = {
925 .path = "clear session stats",
926 .short_help = "clear session stats",
927 .function = clear_session_stats_fn,
931 * fd.io coding-style-patch-verification: ON
934 * eval: (c-set-style "gnu")