2 * Copyright (c) 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.
19 #include <hs_apps/sapi/vpp_echo_common.h>
21 typedef struct _quic_echo_cb_vft
23 void (*quic_connected_cb) (session_connected_msg_t * mp, u32 session_index);
24 void (*client_stream_connected_cb) (session_connected_msg_t * mp,
26 void (*server_stream_connected_cb) (session_connected_msg_t * mp,
28 void (*quic_accepted_cb) (session_accepted_msg_t * mp, u32 session_index);
29 void (*client_stream_accepted_cb) (session_accepted_msg_t * mp,
31 void (*server_stream_accepted_cb) (session_accepted_msg_t * mp,
37 quic_echo_cb_vft_t cb_vft; /* cb vft for QUIC scenarios */
38 u8 send_quic_disconnects; /* actively send disconnect */
39 u32 n_stream_clients; /* Target Number of STREAM sessions per QUIC session */
40 volatile u32 n_quic_clients_connected; /* Number of connected QUIC sessions */
41 } quic_echo_proto_main_t;
43 quic_echo_proto_main_t quic_echo_proto_main;
47 * ECHO Callback definitions
52 quic_echo_on_connected_connect (session_connected_msg_t * mp,
55 echo_main_t *em = &echo_main;
56 quic_echo_proto_main_t *eqm = &quic_echo_proto_main;
59 echo_notify_event (em, ECHO_EVT_FIRST_SCONNECT);
60 for (i = 0; i < eqm->n_stream_clients; i++)
61 echo_send_rpc (em, echo_send_connect, (void *) mp->handle, session_index);
63 ECHO_LOG (0, "Qsession 0x%llx S[%d] connected to %U:%d",
64 mp->handle, session_index, format_ip46_address, &mp->lcl.ip,
65 mp->lcl.is_ip4, clib_net_to_host_u16 (mp->lcl.port));
69 quic_echo_on_connected_send (session_connected_msg_t * mp, u32 session_index)
71 static u32 client_index = 0;
72 echo_main_t *em = &echo_main;
73 echo_session_t *session;
75 session = pool_elt_at_index (em->sessions, session_index);
76 session->bytes_to_send = em->bytes_to_send;
77 session->bytes_to_receive = em->bytes_to_receive;
78 session->session_state = ECHO_SESSION_STATE_READY;
79 em->data_thread_args[client_index++] = session->session_index;
83 quic_echo_on_connected_error (session_connected_msg_t * mp, u32 session_index)
85 ECHO_FAIL (ECHO_FAIL_QUIC_WRONG_CONNECT,
86 "Got a wrong connected on session %u [%lx]", session_index,
91 quic_echo_on_accept_recv (session_accepted_msg_t * mp, u32 session_index)
93 static u32 client_index = 0;
94 echo_main_t *em = &echo_main;
95 echo_session_t *session;
97 session = pool_elt_at_index (em->sessions, session_index);
98 session->bytes_to_send = em->bytes_to_send;
99 session->bytes_to_receive = em->bytes_to_receive;
100 em->data_thread_args[client_index++] = session->session_index;
101 session->session_state = ECHO_SESSION_STATE_READY;
105 quic_echo_on_accept_connect (session_accepted_msg_t * mp, u32 session_index)
107 echo_main_t *em = &echo_main;
108 quic_echo_proto_main_t *eqm = &quic_echo_proto_main;
109 ECHO_LOG (1, "Accept on QSession 0x%lx S[%u]", mp->handle, session_index);
112 echo_notify_event (em, ECHO_EVT_FIRST_SCONNECT);
113 for (i = 0; i < eqm->n_stream_clients; i++)
114 echo_send_rpc (em, echo_send_connect, (void *) mp->handle, session_index);
118 quic_echo_on_accept_error (session_accepted_msg_t * mp, u32 session_index)
120 ECHO_FAIL (ECHO_FAIL_QUIC_WRONG_ACCEPT,
121 "Got a wrong accept on session 0x%lx S[%u]", mp->handle,
126 quic_echo_on_accept_log_ip (session_accepted_msg_t * mp, u32 session_index)
129 ip_str = format (0, "%U", format_ip46_address, &mp->rmt.ip, mp->rmt.is_ip4);
130 ECHO_LOG (0, "Accepted session from: %s:%d", ip_str,
131 clib_net_to_host_u16 (mp->rmt.port));
135 static const quic_echo_cb_vft_t default_cb_vft = {
137 .quic_accepted_cb = quic_echo_on_accept_log_ip,
138 .quic_connected_cb = quic_echo_on_connected_connect,
139 /* client initiated streams */
140 .server_stream_accepted_cb = quic_echo_on_accept_recv,
141 .client_stream_connected_cb = quic_echo_on_connected_send,
142 /* server initiated streams */
143 .client_stream_accepted_cb = quic_echo_on_accept_error,
144 .server_stream_connected_cb = quic_echo_on_connected_error,
147 static const quic_echo_cb_vft_t server_stream_cb_vft = {
149 .quic_accepted_cb = quic_echo_on_accept_connect,
150 .quic_connected_cb = NULL,
151 /* client initiated streams */
152 .server_stream_accepted_cb = quic_echo_on_accept_error,
153 .client_stream_connected_cb = quic_echo_on_connected_error,
154 /* server initiated streams */
155 .client_stream_accepted_cb = quic_echo_on_accept_recv,
156 .server_stream_connected_cb = quic_echo_on_connected_send,
159 static void quic_echo_cleanup_cb (echo_session_t * s, u8 parent_died);
162 quic_echo_cleanup_listener (u32 listener_index, echo_main_t * em,
163 quic_echo_proto_main_t * eqm)
166 ls = pool_elt_at_index (em->sessions, listener_index);
167 if (ls->session_type != ECHO_SESSION_TYPE_QUIC)
169 ECHO_LOG (1, "%U: Invalid listener session type",
170 echo_format_session, ls);
173 if (!clib_atomic_sub_fetch (&ls->accepted_session_count, 1))
175 if (eqm->send_quic_disconnects == ECHO_CLOSE_F_ACTIVE)
177 echo_send_rpc (em, echo_send_disconnect_session,
178 (void *) ls->vpp_session_handle, 0);
179 clib_atomic_fetch_add (&em->stats.active_count.q, 1);
181 else if (eqm->send_quic_disconnects == ECHO_CLOSE_F_NONE)
183 quic_echo_cleanup_cb (ls, 0 /* parent_died */ );
184 clib_atomic_fetch_add (&em->stats.clean_count.q, 1);
190 quic_echo_cleanup_cb (echo_session_t * s, u8 parent_died)
192 echo_main_t *em = &echo_main;
193 quic_echo_proto_main_t *eqm = &quic_echo_proto_main;
194 if ((em->state == STATE_DATA_DONE) ||
195 !(s->session_state < ECHO_SESSION_STATE_CLOSED))
197 ECHO_LOG (2, "%U cleanup (parent_died %d)", echo_format_session, s,
199 s->session_state = ECHO_SESSION_STATE_CLOSED;
200 if (s->session_type == ECHO_SESSION_TYPE_QUIC)
203 clib_atomic_fetch_add (&em->stats.clean_count.q, 1);
204 /* Don't cleanup listener as it's handled by main() */
205 clib_atomic_sub_fetch (&eqm->n_quic_clients_connected, 1);
207 else if (s->session_type == ECHO_SESSION_TYPE_STREAM)
210 clib_atomic_fetch_add (&em->stats.clean_count.s, 1);
212 quic_echo_cleanup_listener (s->listener_index, em, eqm);
213 clib_atomic_sub_fetch (&em->n_clients_connected, 1);
215 if (!em->n_clients_connected && !eqm->n_quic_clients_connected)
216 em->state = STATE_DATA_DONE;
217 ECHO_LOG (1, "Cleanup sessions (still %uQ %uS): app %U",
218 eqm->n_quic_clients_connected, em->n_clients_connected,
219 echo_format_app_state, em->state);
223 quic_echo_initiate_qsession_close_no_stream (echo_main_t * em)
225 quic_echo_proto_main_t *eqm = &quic_echo_proto_main;
226 ECHO_LOG (1, "Closing Qsessions");
227 /* Close Quic session without streams */
231 pool_foreach (s, em->sessions,
233 if (s->session_type == ECHO_SESSION_TYPE_QUIC)
235 if (eqm->send_quic_disconnects == ECHO_CLOSE_F_ACTIVE)
237 ECHO_LOG (1,"%U: ACTIVE close", echo_format_session, s);
238 echo_send_rpc (em, echo_send_disconnect_session,
239 (void *) s->vpp_session_handle, 0);
240 clib_atomic_fetch_add (&em->stats.active_count.q, 1);
242 else if (eqm->send_quic_disconnects == ECHO_CLOSE_F_NONE)
244 ECHO_LOG (1,"%U: CLEAN close", echo_format_session, s);
245 quic_echo_cleanup_cb (s, 0 /* parent_died */);
246 clib_atomic_fetch_add (&em->stats.clean_count.q, 1);
249 ECHO_LOG (1,"%U: PASSIVE close", echo_format_session, s);
256 quic_echo_on_connected (session_connected_msg_t * mp, u32 session_index)
258 echo_main_t *em = &echo_main;
259 quic_echo_proto_main_t *eqm = &quic_echo_proto_main;
260 echo_session_t *listen_session;
261 echo_session_t *session = pool_elt_at_index (em->sessions, session_index);
263 if (session->listener_index == SESSION_INVALID_INDEX)
265 session->session_type = ECHO_SESSION_TYPE_QUIC;
266 ECHO_LOG (1, "Connected %U -> URI", echo_format_session, session);
267 session->accepted_session_count = 0;
268 if (eqm->cb_vft.quic_connected_cb)
269 eqm->cb_vft.quic_connected_cb (mp, session->session_index);
270 clib_atomic_fetch_add (&eqm->n_quic_clients_connected, 1);
275 pool_elt_at_index (em->sessions, session->listener_index);
276 session->session_type = ECHO_SESSION_TYPE_STREAM;
277 clib_atomic_fetch_add (&listen_session->accepted_session_count, 1);
278 ECHO_LOG (1, "Connected %U -> %U", echo_format_session, session,
279 echo_format_session, listen_session);
280 if (em->i_am_master && eqm->cb_vft.server_stream_connected_cb)
281 eqm->cb_vft.server_stream_connected_cb (mp, session->session_index);
282 if (!em->i_am_master && eqm->cb_vft.client_stream_connected_cb)
283 eqm->cb_vft.client_stream_connected_cb (mp, session->session_index);
284 clib_atomic_fetch_add (&em->n_clients_connected, 1);
287 if (em->n_clients_connected == em->n_clients
288 && em->n_clients_connected != 0)
289 echo_notify_event (em, ECHO_EVT_LAST_SCONNECTED);
291 if (eqm->n_quic_clients_connected == em->n_connects
292 && em->state < STATE_READY)
294 echo_notify_event (em, ECHO_EVT_LAST_QCONNECTED);
295 em->state = STATE_READY;
296 if (eqm->n_stream_clients == 0)
297 quic_echo_initiate_qsession_close_no_stream (em);
302 quic_echo_retry_connect (u32 session_index)
305 echo_session_t *session;
306 echo_main_t *em = &echo_main;
307 if (session_index == SESSION_INVALID_INDEX)
309 ECHO_LOG (1, "Retrying Qsession connect");
310 echo_send_rpc (em, echo_send_connect, (void *) SESSION_INVALID_HANDLE,
311 SESSION_INVALID_INDEX);
315 session = pool_elt_at_index (em->sessions, session_index);
316 ECHO_LOG (1, "Retrying connect %U", echo_format_session, session);
317 echo_send_rpc (em, echo_send_connect,
318 (void *) session->vpp_session_handle, session_index);
323 quic_echo_connected_cb (session_connected_bundled_msg_t * mp,
324 u32 session_index, u8 is_failed)
327 return quic_echo_retry_connect (session_index);
328 return quic_echo_on_connected ((session_connected_msg_t *) mp,
333 quic_echo_accepted_cb (session_accepted_msg_t * mp, echo_session_t * session)
335 echo_main_t *em = &echo_main;
336 quic_echo_proto_main_t *eqm = &quic_echo_proto_main;
338 ls = pool_elt_at_index (em->sessions, session->listener_index);
339 if (ls->session_type == ECHO_SESSION_TYPE_LISTEN)
341 echo_notify_event (em, ECHO_EVT_FIRST_QCONNECT);
342 session->session_type = ECHO_SESSION_TYPE_QUIC;
343 session->accepted_session_count = 0;
344 if (eqm->cb_vft.quic_accepted_cb)
345 eqm->cb_vft.quic_accepted_cb (mp, session->session_index);
346 clib_atomic_fetch_add (&eqm->n_quic_clients_connected, 1);
350 session->session_type = ECHO_SESSION_TYPE_STREAM;
351 echo_notify_event (em, ECHO_EVT_FIRST_SCONNECT);
352 clib_atomic_fetch_add (&ls->accepted_session_count, 1);
353 if (em->i_am_master && eqm->cb_vft.server_stream_accepted_cb)
354 eqm->cb_vft.server_stream_accepted_cb (mp, session->session_index);
355 if (!em->i_am_master && eqm->cb_vft.client_stream_accepted_cb)
356 eqm->cb_vft.client_stream_accepted_cb (mp, session->session_index);
357 clib_atomic_fetch_add (&em->n_clients_connected, 1);
360 if (em->n_clients_connected == em->n_clients
361 && em->n_clients_connected != 0)
362 echo_notify_event (em, ECHO_EVT_LAST_SCONNECTED);
364 if (eqm->n_quic_clients_connected == em->n_connects
365 && em->state < STATE_READY)
367 echo_notify_event (em, ECHO_EVT_LAST_QCONNECTED);
368 em->state = STATE_READY;
369 if (eqm->n_stream_clients == 0)
370 quic_echo_initiate_qsession_close_no_stream (em);
375 quic_echo_sent_disconnect_cb (echo_session_t * s)
377 if (s->session_type == ECHO_SESSION_TYPE_STREAM)
378 s->session_state = ECHO_SESSION_STATE_CLOSING;
380 quic_echo_cleanup_cb (s, 0 /* parent_died */ ); /* We can clean Q/Lsessions right away */
384 quic_echo_disconnected_cb (session_disconnected_msg_t * mp,
387 echo_main_t *em = &echo_main;
388 if (s->session_type == ECHO_SESSION_TYPE_STREAM)
390 echo_session_print_stats (em, s);
391 if (s->bytes_to_receive || s->bytes_to_send)
392 s->session_state = ECHO_SESSION_STATE_AWAIT_DATA;
394 s->session_state = ECHO_SESSION_STATE_CLOSING;
395 clib_atomic_fetch_add (&em->stats.close_count.s, 1);
399 quic_echo_cleanup_cb (s, 0 /* parent_died */ ); /* We can clean Q/Lsessions right away */
400 clib_atomic_fetch_add (&em->stats.close_count.q, 1);
405 quic_echo_reset_cb (session_reset_msg_t * mp, echo_session_t * s)
407 echo_main_t *em = &echo_main;
408 if (s->session_type == ECHO_SESSION_TYPE_STREAM)
410 clib_atomic_fetch_add (&em->stats.reset_count.s, 1);
411 s->session_state = ECHO_SESSION_STATE_CLOSING;
415 clib_atomic_fetch_add (&em->stats.reset_count.q, 1);
416 quic_echo_cleanup_cb (s, 0 /* parent_died */ ); /* We can clean Q/Lsessions right away */
421 quic_echo_unformat_setup_vft (unformat_input_t * input, va_list * args)
423 quic_echo_proto_main_t *eqm = &quic_echo_proto_main;
424 if (unformat (input, "serverstream"))
425 eqm->cb_vft = server_stream_cb_vft;
426 else if (unformat (input, "default"))
434 quic_echo_process_opts_cb (unformat_input_t * a)
436 quic_echo_proto_main_t *eqm = &quic_echo_proto_main;
437 if (unformat (a, "quic-streams %d", &eqm->n_stream_clients))
439 else if (unformat (a, "quic-setup %U", quic_echo_unformat_setup_vft))
441 else if (unformat (a, "qclose=%U",
442 echo_unformat_close, &eqm->send_quic_disconnects))
450 quic_echo_set_defaults_before_opts_cb ()
452 quic_echo_proto_main_t *eqm = &quic_echo_proto_main;
453 eqm->cb_vft = default_cb_vft;
454 eqm->n_stream_clients = 1;
458 quic_echo_set_defaults_after_opts_cb ()
460 quic_echo_proto_main_t *eqm = &quic_echo_proto_main;
461 echo_main_t *em = &echo_main;
464 em->n_connects = em->n_clients;
466 clib_max (1, eqm->n_stream_clients) * em->n_clients + em->n_clients + 1;
467 em->n_clients = eqm->n_stream_clients * em->n_clients;
471 em->bytes_to_send == 0 ? ECHO_CLOSE_F_ACTIVE : ECHO_CLOSE_F_PASSIVE;
474 em->bytes_to_receive == 0 ? ECHO_CLOSE_F_PASSIVE : ECHO_CLOSE_F_ACTIVE;
475 if (eqm->send_quic_disconnects == ECHO_CLOSE_F_INVALID)
476 eqm->send_quic_disconnects = default_f_active;
480 quic_echo_print_usage_cb ()
483 "-- QUIC specific options -- \n"
484 " quic-setup OPT OPT=serverstream : Client open N connections. \n"
485 " On each one server opens M streams\n"
486 " OPT=default : Client open N connections.\n"
487 " On each one client opens M streams\n"
488 " qclose=[Y|N|W] When connection is done send[Y]|nop[N]|wait[W] for close\n"
490 " quic-streams N Open N QUIC streams (defaults to 1)\n");
493 echo_proto_cb_vft_t quic_echo_proto_cb_vft = {
494 .disconnected_cb = quic_echo_disconnected_cb,
495 .connected_cb = quic_echo_connected_cb,
496 .accepted_cb = quic_echo_accepted_cb,
497 .reset_cb = quic_echo_reset_cb,
498 .sent_disconnect_cb = quic_echo_sent_disconnect_cb,
499 .cleanup_cb = quic_echo_cleanup_cb,
500 .process_opts_cb = quic_echo_process_opts_cb,
501 .print_usage_cb = quic_echo_print_usage_cb,
502 .set_defaults_before_opts_cb = quic_echo_set_defaults_before_opts_cb,
503 .set_defaults_after_opts_cb = quic_echo_set_defaults_after_opts_cb,
506 ECHO_REGISTER_PROTO (TRANSPORT_PROTO_QUIC, quic_echo_proto_cb_vft);
509 * fd.io coding-style-patch-verification: ON
512 * eval: (c-set-style "gnu")