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)
148 s = format (s, "%U%v", format_transport_half_open_connection, tp,
149 ss->connection_index, ss->thread_index, verbose, str);
151 s = format (s, "%U", format_transport_connection, tp,
152 ss->connection_index, ss->thread_index, verbose);
156 clib_warning ("Session in state: %d!", ss->session_state);
164 unformat_stream_session_id (unformat_input_t * input, va_list * args)
166 u8 *proto = va_arg (*args, u8 *);
167 u32 *fib_index = va_arg (*args, u32 *);
168 ip46_address_t *lcl = va_arg (*args, ip46_address_t *);
169 ip46_address_t *rmt = va_arg (*args, ip46_address_t *);
170 u16 *lcl_port = va_arg (*args, u16 *);
171 u16 *rmt_port = va_arg (*args, u16 *);
172 u8 *is_ip4 = va_arg (*args, u8 *);
176 clib_memset (lcl, 0, sizeof (*lcl));
177 clib_memset (rmt, 0, sizeof (*rmt));
179 if (unformat (input, "tcp"))
181 *proto = TRANSPORT_PROTO_TCP;
183 else if (unformat (input, "udp"))
185 *proto = TRANSPORT_PROTO_UDP;
190 if (unformat (input, "vrf %u", &vrf))
193 if (unformat (input, "%U:%d->%U:%d", unformat_ip4_address, &lcl->ip4,
194 lcl_port, unformat_ip4_address, &rmt->ip4, rmt_port))
199 else if (unformat (input, "%U:%d->%U:%d", unformat_ip6_address, &lcl->ip6,
200 lcl_port, unformat_ip6_address, &rmt->ip6, rmt_port))
208 fib_protocol_t fib_proto;
209 fib_proto = *is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
210 *fib_index = fib_table_find (fib_proto, vrf);
217 unformat_session_state (unformat_input_t * input, va_list * args)
219 session_state_t *state = va_arg (*args, session_state_t *);
223 #define _(sym, str) \
224 if (unformat (input, str)) \
226 *state = SESSION_STATE_ ## sym; \
230 foreach_session_state
233 vec_free (state_vec);
238 unformat_session (unformat_input_t * input, va_list * args)
240 session_t **result = va_arg (*args, session_t **);
241 u32 lcl_port = 0, rmt_port = 0, fib_index = 0;
242 ip46_address_t lcl, rmt;
247 if (!unformat (input, "%U", unformat_stream_session_id, &proto, &fib_index,
248 &lcl, &rmt, &lcl_port, &rmt_port, &is_ip4))
252 s = session_lookup_safe4 (fib_index, &lcl.ip4, &rmt.ip4,
253 clib_host_to_net_u16 (lcl_port),
254 clib_host_to_net_u16 (rmt_port), proto);
256 s = session_lookup_safe6 (fib_index, &lcl.ip6, &rmt.ip6,
257 clib_host_to_net_u16 (lcl_port),
258 clib_host_to_net_u16 (rmt_port), proto);
268 unformat_transport_connection (unformat_input_t * input, va_list * args)
270 transport_connection_t **result = va_arg (*args, transport_connection_t **);
271 u32 suggested_proto = va_arg (*args, u32);
272 transport_connection_t *tc;
274 ip46_address_t lcl, rmt;
275 u32 lcl_port = 0, rmt_port = 0, fib_index = 0;
278 if (!unformat (input, "%U", unformat_stream_session_id, &fib_index, &proto,
279 &lcl, &rmt, &lcl_port, &rmt_port, &is_ip4))
282 proto = (proto == (u8) ~ 0) ? suggested_proto : proto;
283 if (proto == (u8) ~ 0)
286 tc = session_lookup_connection4 (fib_index, &lcl.ip4, &rmt.ip4,
287 clib_host_to_net_u16 (lcl_port),
288 clib_host_to_net_u16 (rmt_port), proto);
290 tc = session_lookup_connection6 (fib_index, &lcl.ip6, &rmt.ip6,
291 clib_host_to_net_u16 (lcl_port),
292 clib_host_to_net_u16 (rmt_port), proto);
303 session_cli_show_all_sessions (vlib_main_t * vm, int verbose)
305 session_main_t *smm = &session_main;
306 u32 n_closed, thread_index;
309 for (thread_index = 0; thread_index < vec_len (smm->wrk); thread_index++)
311 pool = smm->wrk[thread_index].sessions;
313 if (!pool_elts (pool))
315 vlib_cli_output (vm, "Thread %d: no sessions", thread_index);
321 vlib_cli_output (vm, "Thread %d: %d sessions", thread_index,
326 if (pool_elts (pool) > 50)
328 vlib_cli_output (vm, "Thread %u: %d sessions. Verbose output "
329 "suppressed. For more details use filters.",
330 thread_index, pool_elts (pool));
335 vlib_cli_output (vm, "%s%-" SESSION_CLI_ID_LEN "s%-"
336 SESSION_CLI_STATE_LEN "s%-10s%-10s",
337 thread_index ? "\n" : "",
338 "Connection", "State", "Rx-f", "Tx-f");
343 pool_foreach (s, pool) {
344 if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
349 vlib_cli_output (vm, "%U", format_session, s, verbose);
354 vlib_cli_output (vm, "Thread %d: active sessions %u", thread_index,
355 pool_elts (pool) - n_closed);
357 vlib_cli_output (vm, "Thread %d: active sessions %u closed %u",
358 thread_index, pool_elts (pool) - n_closed, n_closed);
363 session_cli_filter_check (session_t * s, session_state_t * states,
364 transport_proto_t tp)
368 session_state_t *state;
369 vec_foreach (state, states) if (s->session_state == *state)
370 goto check_transport;
376 if (tp != TRANSPORT_PROTO_INVALID && session_get_transport_proto (s) != tp)
383 session_cli_show_session_filter (vlib_main_t * vm, u32 thread_index,
384 u32 start, u32 end, session_state_t * states,
385 transport_proto_t tp, int verbose)
387 u8 output_suppressed = 0;
388 session_worker_t *wrk;
390 u32 count = 0, max_index;
393 wrk = session_main_get_worker_if_valid (thread_index);
396 vlib_cli_output (vm, "invalid thread index %u", thread_index);
400 pool = wrk->sessions;
402 if (tp == TRANSPORT_PROTO_INVALID && states == 0 && !verbose
403 && (start == 0 && end == ~0))
405 vlib_cli_output (vm, "Thread %d: %u sessions", thread_index,
410 max_index = pool_len (pool) ? pool_len (pool) - 1 : 0;
411 for (i = start; i <= clib_min (end, max_index); i++)
413 if (pool_is_free_index (pool, i))
416 s = pool_elt_at_index (pool, i);
418 if (session_cli_filter_check (s, states, tp))
423 if (count > 50 || (verbose > 1 && count > 10))
425 output_suppressed = 1;
428 if (s->session_state < SESSION_STATE_TRANSPORT_DELETED)
429 vlib_cli_output (vm, "%U", format_session, s, verbose);
434 if (!output_suppressed)
435 vlib_cli_output (vm, "Thread %d: %u sessions matched filter",
436 thread_index, count);
438 vlib_cli_output (vm, "Thread %d: %u sessions matched filter. Not all"
439 " shown. Use finer grained filter.", thread_index,
444 session_cli_show_events_thread (vlib_main_t * vm, u32 thread_index)
446 session_worker_t *wrk;
448 wrk = session_main_get_worker_if_valid (thread_index);
451 vlib_cli_output (vm, "invalid thread index %u", thread_index);
455 vlib_cli_output (vm, "Thread %d:\n", thread_index);
456 vlib_cli_output (vm, " evt elements alloc: %u",
457 clib_llist_elts (wrk->event_elts));
458 vlib_cli_output (vm, " ctrl evt elt data alloc: %d",
459 clib_llist_elts (wrk->ctrl_evts_data));
463 session_cli_show_events (vlib_main_t * vm, u32 thread_index)
465 session_main_t *smm = &session_main;
468 session_cli_show_events_thread (vm, thread_index);
472 for (thread_index = 0; thread_index < vec_len (smm->wrk); thread_index++)
473 session_cli_show_events_thread (vm, thread_index);
477 session_cli_print_session_states (vlib_main_t * vm)
479 #define _(sym, str) vlib_cli_output (vm, str);
480 foreach_session_state
484 static clib_error_t *
485 show_session_command_fn (vlib_main_t * vm, unformat_input_t * input,
486 vlib_cli_command_t * cmd)
488 u8 one_session = 0, do_listeners = 0, sst, do_elog = 0, do_filter = 0;
489 u32 track_index, thread_index = 0, start = 0, end = ~0, session_index;
490 transport_proto_t transport_proto = TRANSPORT_PROTO_INVALID;
491 session_state_t state = SESSION_N_STATES, *states = 0;
492 session_main_t *smm = &session_main;
493 clib_error_t *error = 0;
494 app_worker_t *app_wrk;
501 session_cli_return_if_not_enabled ();
503 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
505 if (unformat (input, "verbose %d", &verbose))
507 else if (unformat (input, "verbose"))
509 else if (unformat (input, "listeners %U", unformat_transport_proto,
512 else if (unformat (input, "%U", unformat_session, &s))
516 else if (unformat (input, "thread %u index %u", &thread_index,
519 s = session_get_if_valid (session_index, thread_index);
522 vlib_cli_output (vm, "session is not allocated");
527 else if (unformat (input, "thread %u", &thread_index))
531 else if (unformat (input, "state %U", unformat_session_state, &state))
533 vec_add1 (states, state);
536 else if (unformat (input, "proto %U index %u", unformat_transport_proto,
537 &transport_proto, &transport_index))
539 transport_connection_t *tc;
540 tc = transport_get_connection (transport_proto, transport_index,
544 vlib_cli_output (vm, "transport connection %u thread %u is not"
545 " allocated", transport_index, thread_index);
548 s = session_get_if_valid (tc->s_index, thread_index);
551 vlib_cli_output (vm, "session for transport connection %u "
552 "thread %u does not exist", transport_index,
558 else if (unformat (input, "proto %U", unformat_transport_proto,
561 else if (unformat (input, "range %u %u", &start, &end))
563 else if (unformat (input, "range %u", &start))
568 else if (unformat (input, "elog"))
570 else if (unformat (input, "protos"))
572 vlib_cli_output (vm, "%U", format_transport_protos);
575 else if (unformat (input, "states"))
577 session_cli_print_session_states (vm);
580 else if (unformat (input, "events"))
584 error = clib_error_return (0, "unknown input `%U'",
585 format_unformat_error, input);
592 u8 *str = format (0, "%U", format_session, s, 3);
593 if (do_elog && s->session_state != SESSION_STATE_LISTENING)
595 elog_main_t *em = &vlib_global_main.elog_main;
596 transport_connection_t *tc;
599 tc = session_get_transport (s);
600 track_index = transport_elog_track_index (tc);
601 dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
602 * vm->clib_time.seconds_per_clock;
603 if (track_index != ~0)
604 str = format (str, " session elog:\n%U", format_elog_track, em,
607 vlib_cli_output (vm, "%v", str);
614 sst = session_type_from_proto_and_ip (transport_proto, 1);
615 vlib_cli_output (vm, "%-" SESSION_CLI_ID_LEN "s%-24s", "Listener",
619 pool_foreach (s, smm->wrk[0].sessions) {
620 if (s->session_state != SESSION_STATE_LISTENING
621 || s->session_type != sst)
623 app_wrk = app_worker_get (s->app_wrk_index);
624 app_name = application_name_from_index (app_wrk->app_index);
625 vlib_cli_output (vm, "%U%-25v%", format_session, s, 0,
634 session_cli_show_events (vm, thread_index);
642 error = clib_error_return (0, "invalid range start: %u end: %u",
646 session_cli_show_session_filter (vm, thread_index, start, end, states,
647 transport_proto, verbose);
651 session_cli_show_all_sessions (vm, verbose);
659 VLIB_CLI_COMMAND (vlib_cli_show_session_command) =
661 .path = "show session",
662 .short_help = "show session [verbose [n]] [listeners <proto>] "
663 "[<session-id> [elog]] [thread <n> [index <n>] "
664 "[proto <proto>] [state <state>] [range <min> [<max>]] "
665 "[protos] [states] ",
666 .function = show_session_command_fn,
671 clear_session (session_t * s)
673 app_worker_t *server_wrk = app_worker_get (s->app_wrk_index);
674 app_worker_close_notify (server_wrk, s);
678 static clib_error_t *
679 clear_session_command_fn (vlib_main_t * vm, unformat_input_t * input,
680 vlib_cli_command_t * cmd)
682 session_main_t *smm = &session_main;
683 u32 thread_index = 0, clear_all = 0;
684 session_worker_t *wrk;
685 u32 session_index = ~0;
688 if (!smm->is_enabled)
690 return clib_error_return (0, "session layer is not enabled");
693 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
695 if (unformat (input, "thread %d", &thread_index))
697 else if (unformat (input, "session %d", &session_index))
699 else if (unformat (input, "all"))
702 return clib_error_return (0, "unknown input `%U'",
703 format_unformat_error, input);
706 if (!clear_all && session_index == ~0)
707 return clib_error_return (0, "session <nn> required, but not set.");
709 if (session_index != ~0)
711 session = session_get_if_valid (session_index, thread_index);
713 return clib_error_return (0, "no session %d on thread %d",
714 session_index, thread_index);
715 clear_session (session);
721 vec_foreach (wrk, smm->wrk)
723 pool_foreach (session, wrk->sessions) {
724 clear_session (session);
734 VLIB_CLI_COMMAND (clear_session_command, static) =
736 .path = "clear session",
737 .short_help = "clear session thread <thread> session <index>",
738 .function = clear_session_command_fn,
742 static clib_error_t *
743 show_session_fifo_trace_command_fn (vlib_main_t * vm,
744 unformat_input_t * input,
745 vlib_cli_command_t * cmd)
748 u8 is_rx = 0, *str = 0;
750 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
752 if (unformat (input, "%U", unformat_session, &s))
754 else if (unformat (input, "rx"))
756 else if (unformat (input, "tx"))
759 return clib_error_return (0, "unknown input `%U'",
760 format_unformat_error, input);
765 vlib_cli_output (vm, "fifo tracing not enabled");
771 vlib_cli_output (vm, "could not find session");
776 svm_fifo_dump_trace (str, s->rx_fifo) :
777 svm_fifo_dump_trace (str, s->tx_fifo);
779 vlib_cli_output (vm, "%v", str);
784 VLIB_CLI_COMMAND (show_session_fifo_trace_command, static) =
786 .path = "show session fifo trace",
787 .short_help = "show session fifo trace <session>",
788 .function = show_session_fifo_trace_command_fn,
792 static clib_error_t *
793 session_replay_fifo_command_fn (vlib_main_t * vm, unformat_input_t * input,
794 vlib_cli_command_t * cmd)
797 u8 is_rx = 0, *str = 0;
799 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
801 if (unformat (input, "%U", unformat_session, &s))
803 else if (unformat (input, "rx"))
806 return clib_error_return (0, "unknown input `%U'",
807 format_unformat_error, input);
812 vlib_cli_output (vm, "fifo tracing not enabled");
818 vlib_cli_output (vm, "could not find session");
823 svm_fifo_replay (str, s->rx_fifo, 0, 1) :
824 svm_fifo_replay (str, s->tx_fifo, 0, 1);
826 vlib_cli_output (vm, "%v", str);
831 VLIB_CLI_COMMAND (session_replay_fifo_trace_command, static) =
833 .path = "session replay fifo",
834 .short_help = "session replay fifo <session>",
835 .function = session_replay_fifo_command_fn,
839 static clib_error_t *
840 session_enable_disable_fn (vlib_main_t * vm, unformat_input_t * input,
841 vlib_cli_command_t * cmd)
845 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
847 if (unformat (input, "enable"))
849 else if (unformat (input, "disable"))
852 return clib_error_return (0, "unknown input `%U'",
853 format_unformat_error, input);
857 return clib_error_return (0, "expected enable | disable");
859 return vnet_session_enable_disable (vm, is_en);
863 VLIB_CLI_COMMAND (session_enable_disable_command, static) =
866 .short_help = "session [enable|disable]",
867 .function = session_enable_disable_fn,
872 * fd.io coding-style-patch-verification: ON
875 * eval: (c-set-style "gnu")