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);
262 session_pool_remove_peeker (s->thread_index);
269 unformat_transport_connection (unformat_input_t * input, va_list * args)
271 transport_connection_t **result = va_arg (*args, transport_connection_t **);
272 u32 suggested_proto = va_arg (*args, u32);
273 transport_connection_t *tc;
275 ip46_address_t lcl, rmt;
276 u32 lcl_port = 0, rmt_port = 0, fib_index = 0;
279 if (!unformat (input, "%U", unformat_stream_session_id, &fib_index, &proto,
280 &lcl, &rmt, &lcl_port, &rmt_port, &is_ip4))
283 proto = (proto == (u8) ~ 0) ? suggested_proto : proto;
284 if (proto == (u8) ~ 0)
287 tc = session_lookup_connection4 (fib_index, &lcl.ip4, &rmt.ip4,
288 clib_host_to_net_u16 (lcl_port),
289 clib_host_to_net_u16 (rmt_port), proto);
291 tc = session_lookup_connection6 (fib_index, &lcl.ip6, &rmt.ip6,
292 clib_host_to_net_u16 (lcl_port),
293 clib_host_to_net_u16 (rmt_port), proto);
304 session_cli_show_all_sessions (vlib_main_t * vm, int verbose)
306 session_main_t *smm = &session_main;
307 u32 n_closed, thread_index;
310 for (thread_index = 0; thread_index < vec_len (smm->wrk); thread_index++)
312 pool = smm->wrk[thread_index].sessions;
314 if (!pool_elts (pool))
316 vlib_cli_output (vm, "Thread %d: no sessions", thread_index);
322 vlib_cli_output (vm, "Thread %d: %d sessions", thread_index,
327 if (pool_elts (pool) > 50)
329 vlib_cli_output (vm, "Thread %u: %d sessions. Verbose output "
330 "suppressed. For more details use filters.",
331 thread_index, pool_elts (pool));
336 vlib_cli_output (vm, "%s%-" SESSION_CLI_ID_LEN "s%-"
337 SESSION_CLI_STATE_LEN "s%-10s%-10s",
338 thread_index ? "\n" : "",
339 "Connection", "State", "Rx-f", "Tx-f");
344 pool_foreach (s, pool) {
345 if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
350 vlib_cli_output (vm, "%U", format_session, s, verbose);
355 vlib_cli_output (vm, "Thread %d: active sessions %u", thread_index,
356 pool_elts (pool) - n_closed);
358 vlib_cli_output (vm, "Thread %d: active sessions %u closed %u",
359 thread_index, pool_elts (pool) - n_closed, n_closed);
364 session_cli_filter_check (session_t * s, session_state_t * states,
365 transport_proto_t tp)
369 session_state_t *state;
370 vec_foreach (state, states) if (s->session_state == *state)
371 goto check_transport;
377 if (tp != TRANSPORT_PROTO_INVALID && session_get_transport_proto (s) != tp)
384 session_cli_show_session_filter (vlib_main_t * vm, u32 thread_index,
385 u32 start, u32 end, session_state_t * states,
386 transport_proto_t tp, int verbose)
388 u8 output_suppressed = 0;
389 session_worker_t *wrk;
391 u32 count = 0, max_index;
394 wrk = session_main_get_worker_if_valid (thread_index);
397 vlib_cli_output (vm, "invalid thread index %u", thread_index);
401 pool = wrk->sessions;
403 if (tp == TRANSPORT_PROTO_INVALID && states == 0 && !verbose
404 && (start == 0 && end == ~0))
406 vlib_cli_output (vm, "Thread %d: %u sessions", thread_index,
411 max_index = pool_len (pool) ? pool_len (pool) - 1 : 0;
412 for (i = start; i <= clib_min (end, max_index); i++)
414 if (pool_is_free_index (pool, i))
417 s = pool_elt_at_index (pool, i);
419 if (session_cli_filter_check (s, states, tp))
424 if (count > 50 || (verbose > 1 && count > 10))
426 output_suppressed = 1;
429 if (s->session_state < SESSION_STATE_TRANSPORT_DELETED)
430 vlib_cli_output (vm, "%U", format_session, s, verbose);
435 if (!output_suppressed)
436 vlib_cli_output (vm, "Thread %d: %u sessions matched filter",
437 thread_index, count);
439 vlib_cli_output (vm, "Thread %d: %u sessions matched filter. Not all"
440 " shown. Use finer grained filter.", thread_index,
445 session_cli_show_events_thread (vlib_main_t * vm, u32 thread_index)
447 session_worker_t *wrk;
449 wrk = session_main_get_worker_if_valid (thread_index);
452 vlib_cli_output (vm, "invalid thread index %u", thread_index);
456 vlib_cli_output (vm, "Thread %d:\n", thread_index);
457 vlib_cli_output (vm, " evt elements alloc: %u",
458 clib_llist_elts (wrk->event_elts));
459 vlib_cli_output (vm, " ctrl evt elt data alloc: %d",
460 clib_llist_elts (wrk->ctrl_evts_data));
464 session_cli_show_events (vlib_main_t * vm, u32 thread_index)
466 session_main_t *smm = &session_main;
469 session_cli_show_events_thread (vm, thread_index);
473 for (thread_index = 0; thread_index < vec_len (smm->wrk); thread_index++)
474 session_cli_show_events_thread (vm, thread_index);
478 session_cli_print_session_states (vlib_main_t * vm)
480 #define _(sym, str) vlib_cli_output (vm, str);
481 foreach_session_state
485 static clib_error_t *
486 show_session_command_fn (vlib_main_t * vm, unformat_input_t * input,
487 vlib_cli_command_t * cmd)
489 u8 one_session = 0, do_listeners = 0, sst, do_elog = 0, do_filter = 0;
490 u32 track_index, thread_index = 0, start = 0, end = ~0, session_index;
491 unformat_input_t _line_input, *line_input = &_line_input;
492 transport_proto_t transport_proto = TRANSPORT_PROTO_INVALID;
493 session_state_t state = SESSION_N_STATES, *states = 0;
494 session_main_t *smm = &session_main;
495 clib_error_t *error = 0;
496 app_worker_t *app_wrk;
503 session_cli_return_if_not_enabled ();
505 if (!unformat_user (input, unformat_line_input, line_input))
507 session_cli_show_all_sessions (vm, 0);
511 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
513 if (unformat (line_input, "verbose %d", &verbose))
515 else if (unformat (line_input, "verbose"))
517 else if (unformat (line_input, "listeners %U", unformat_transport_proto,
520 else if (unformat (line_input, "%U", unformat_session, &s))
524 else if (unformat (line_input, "thread %u index %u", &thread_index,
527 s = session_get_if_valid (session_index, thread_index);
530 vlib_cli_output (vm, "session is not allocated");
535 else if (unformat (line_input, "thread %u", &thread_index))
540 if (unformat (line_input, "state %U", unformat_session_state, &state))
542 vec_add1 (states, state);
545 else if (unformat (line_input, "proto %U index %u",
546 unformat_transport_proto, &transport_proto,
549 transport_connection_t *tc;
550 tc = transport_get_connection (transport_proto, transport_index,
554 vlib_cli_output (vm, "transport connection %u thread %u is not"
555 " allocated", transport_index, thread_index);
558 s = session_get_if_valid (tc->s_index, thread_index);
561 vlib_cli_output (vm, "session for transport connection %u "
562 "thread %u does not exist", transport_index,
568 else if (unformat (line_input, "proto %U", unformat_transport_proto,
571 else if (unformat (line_input, "range %u %u", &start, &end))
573 else if (unformat (line_input, "range %u", &start))
578 else if (unformat (line_input, "elog"))
580 else if (unformat (line_input, "protos"))
582 vlib_cli_output (vm, "%U", format_transport_protos);
585 else if (unformat (line_input, "states"))
587 session_cli_print_session_states (vm);
590 else if (unformat (line_input, "events"))
594 error = clib_error_return (0, "unknown input `%U'",
595 format_unformat_error, line_input);
602 u8 *str = format (0, "%U", format_session, s, 3);
603 if (do_elog && s->session_state != SESSION_STATE_LISTENING)
605 elog_main_t *em = &vlib_global_main.elog_main;
606 transport_connection_t *tc;
609 tc = session_get_transport (s);
610 track_index = transport_elog_track_index (tc);
611 dt = (em->init_time.cpu - vm->clib_time.init_cpu_time)
612 * vm->clib_time.seconds_per_clock;
613 if (track_index != ~0)
614 str = format (str, " session elog:\n%U", format_elog_track, em,
617 vlib_cli_output (vm, "%v", str);
624 sst = session_type_from_proto_and_ip (transport_proto, 1);
625 vlib_cli_output (vm, "%-" SESSION_CLI_ID_LEN "s%-24s", "Listener",
629 pool_foreach (s, smm->wrk[0].sessions) {
630 if (s->session_state != SESSION_STATE_LISTENING
631 || s->session_type != sst)
633 app_wrk = app_worker_get (s->app_wrk_index);
634 app_name = application_name_from_index (app_wrk->app_index);
635 vlib_cli_output (vm, "%U%-25v%", format_session, s, 0,
644 session_cli_show_events (vm, thread_index);
652 error = clib_error_return (0, "invalid range start: %u end: %u",
656 session_cli_show_session_filter (vm, thread_index, start, end, states,
657 transport_proto, verbose);
661 session_cli_show_all_sessions (vm, verbose);
664 unformat_free (line_input);
670 VLIB_CLI_COMMAND (vlib_cli_show_session_command) =
672 .path = "show session",
673 .short_help = "show session [verbose [n]] [listeners <proto>] "
674 "[<session-id> [elog]] [thread <n> [index <n>] "
675 "[proto <proto>] [state <state>] [range <min> [<max>]] "
676 "[protos] [states] ",
677 .function = show_session_command_fn,
682 clear_session (session_t * s)
684 app_worker_t *server_wrk = app_worker_get (s->app_wrk_index);
685 app_worker_close_notify (server_wrk, s);
689 static clib_error_t *
690 clear_session_command_fn (vlib_main_t * vm, unformat_input_t * input,
691 vlib_cli_command_t * cmd)
693 session_main_t *smm = &session_main;
694 u32 thread_index = 0, clear_all = 0;
695 session_worker_t *wrk;
696 u32 session_index = ~0;
699 if (!smm->is_enabled)
701 return clib_error_return (0, "session layer is not enabled");
704 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
706 if (unformat (input, "thread %d", &thread_index))
708 else if (unformat (input, "session %d", &session_index))
710 else if (unformat (input, "all"))
713 return clib_error_return (0, "unknown input `%U'",
714 format_unformat_error, input);
717 if (!clear_all && session_index == ~0)
718 return clib_error_return (0, "session <nn> required, but not set.");
720 if (session_index != ~0)
722 session = session_get_if_valid (session_index, thread_index);
724 return clib_error_return (0, "no session %d on thread %d",
725 session_index, thread_index);
726 clear_session (session);
732 vec_foreach (wrk, smm->wrk)
734 pool_foreach (session, wrk->sessions) {
735 clear_session (session);
745 VLIB_CLI_COMMAND (clear_session_command, static) =
747 .path = "clear session",
748 .short_help = "clear session thread <thread> session <index>",
749 .function = clear_session_command_fn,
753 static clib_error_t *
754 show_session_fifo_trace_command_fn (vlib_main_t * vm,
755 unformat_input_t * input,
756 vlib_cli_command_t * cmd)
759 u8 is_rx = 0, *str = 0;
761 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
763 if (unformat (input, "%U", unformat_session, &s))
765 else if (unformat (input, "rx"))
767 else if (unformat (input, "tx"))
770 return clib_error_return (0, "unknown input `%U'",
771 format_unformat_error, input);
776 vlib_cli_output (vm, "fifo tracing not enabled");
782 vlib_cli_output (vm, "could not find session");
787 svm_fifo_dump_trace (str, s->rx_fifo) :
788 svm_fifo_dump_trace (str, s->tx_fifo);
790 vlib_cli_output (vm, "%v", str);
795 VLIB_CLI_COMMAND (show_session_fifo_trace_command, static) =
797 .path = "show session fifo trace",
798 .short_help = "show session fifo trace <session>",
799 .function = show_session_fifo_trace_command_fn,
803 static clib_error_t *
804 session_replay_fifo_command_fn (vlib_main_t * vm, unformat_input_t * input,
805 vlib_cli_command_t * cmd)
808 u8 is_rx = 0, *str = 0;
810 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
812 if (unformat (input, "%U", unformat_session, &s))
814 else if (unformat (input, "rx"))
817 return clib_error_return (0, "unknown input `%U'",
818 format_unformat_error, input);
823 vlib_cli_output (vm, "fifo tracing not enabled");
829 vlib_cli_output (vm, "could not find session");
834 svm_fifo_replay (str, s->rx_fifo, 0, 1) :
835 svm_fifo_replay (str, s->tx_fifo, 0, 1);
837 vlib_cli_output (vm, "%v", str);
842 VLIB_CLI_COMMAND (session_replay_fifo_trace_command, static) =
844 .path = "session replay fifo",
845 .short_help = "session replay fifo <session>",
846 .function = session_replay_fifo_command_fn,
850 static clib_error_t *
851 session_enable_disable_fn (vlib_main_t * vm, unformat_input_t * input,
852 vlib_cli_command_t * cmd)
854 unformat_input_t _line_input, *line_input = &_line_input;
858 if (!unformat_user (input, unformat_line_input, line_input))
859 return clib_error_return (0, "expected enable | disable");
861 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
863 if (unformat (line_input, "enable"))
865 else if (unformat (line_input, "disable"))
869 error = clib_error_return (0, "unknown input `%U'",
870 format_unformat_error, line_input);
871 unformat_free (line_input);
876 unformat_free (line_input);
877 return vnet_session_enable_disable (vm, is_en);
881 VLIB_CLI_COMMAND (session_enable_disable_command, static) =
884 .short_help = "session [enable|disable]",
885 .function = session_enable_disable_fn,
890 * fd.io coding-style-patch-verification: ON
893 * eval: (c-set-style "gnu")