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 #define REPLY_MSG_ID_BASE msg_id_base
22 static u16 msg_id_base;
31 echo_send_attach (echo_main_t * em)
33 vl_api_app_attach_t *bmp;
34 bmp = vl_msg_api_alloc (sizeof (*bmp));
35 clib_memset (bmp, 0, sizeof (*bmp));
37 bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_ATTACH);
38 bmp->client_index = em->my_client_index;
39 bmp->context = ntohl (0xfeedface);
40 bmp->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_ACCEPT_REDIRECT;
41 bmp->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_ADD_SEGMENT;
42 bmp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] = em->prealloc_fifo_pairs;
43 bmp->options[APP_OPTIONS_RX_FIFO_SIZE] = em->fifo_size;
44 bmp->options[APP_OPTIONS_TX_FIFO_SIZE] = em->fifo_size;
45 bmp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = 128 << 20;
46 bmp->options[APP_OPTIONS_SEGMENT_SIZE] = 256 << 20;
47 bmp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = em->evt_q_size;
50 vl_api_vec_to_api_string (em->appns_id, &bmp->namespace_id);
51 bmp->options[APP_OPTIONS_FLAGS] |= em->appns_flags;
52 bmp->options[APP_OPTIONS_NAMESPACE_SECRET] = em->appns_secret;
54 vl_msg_api_send_shmem (em->vl_input_queue, (u8 *) & bmp);
58 echo_send_detach (echo_main_t * em)
60 vl_api_application_detach_t *bmp;
61 bmp = vl_msg_api_alloc (sizeof (*bmp));
62 clib_memset (bmp, 0, sizeof (*bmp));
64 bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APPLICATION_DETACH);
65 bmp->client_index = em->my_client_index;
66 bmp->context = ntohl (0xfeedface);
68 vl_msg_api_send_shmem (em->vl_input_queue, (u8 *) & bmp);
72 echo_send_add_cert_key (echo_main_t * em)
74 u32 cert_len = test_srv_crt_rsa_len;
75 u32 key_len = test_srv_key_rsa_len;
76 vl_api_app_add_cert_key_pair_t *bmp;
78 bmp = vl_msg_api_alloc (sizeof (*bmp) + cert_len + key_len);
79 clib_memset (bmp, 0, sizeof (*bmp) + cert_len + key_len);
81 bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_ADD_CERT_KEY_PAIR);
82 bmp->client_index = em->my_client_index;
83 bmp->context = ntohl (0xfeedface);
84 bmp->cert_len = clib_host_to_net_u16 (cert_len);
85 bmp->certkey_len = clib_host_to_net_u16 (key_len + cert_len);
86 clib_memcpy_fast (bmp->certkey, test_srv_crt_rsa, cert_len);
87 clib_memcpy_fast (bmp->certkey + cert_len, test_srv_key_rsa, key_len);
89 vl_msg_api_send_shmem (em->vl_input_queue, (u8 *) & bmp);
93 echo_send_del_cert_key (echo_main_t * em)
95 vl_api_app_del_cert_key_pair_t *bmp;
96 bmp = vl_msg_api_alloc (sizeof (*bmp));
97 clib_memset (bmp, 0, sizeof (*bmp));
99 bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_DEL_CERT_KEY_PAIR);
100 bmp->client_index = em->my_client_index;
101 bmp->context = ntohl (0xfeedface);
102 bmp->index = clib_host_to_net_u32 (em->ckpair_index);
103 vl_msg_api_send_shmem (em->vl_input_queue, (u8 *) & bmp);
107 echo_bapi_recv_fd (echo_main_t *em, int *fds, int n_fds)
110 err = vl_socket_client_recv_fd_msg (fds, n_fds, 5);
113 clib_error_report (err);
120 echo_transport_needs_crypto (transport_proto_t proto)
122 return proto == TRANSPORT_PROTO_TLS || proto == TRANSPORT_PROTO_DTLS ||
123 proto == TRANSPORT_PROTO_QUIC;
127 echo_msg_add_crypto_ext_config (echo_main_t *em, uword *offset)
129 transport_endpt_ext_cfg_t cfg;
132 c = echo_segment_alloc_chunk (ECHO_MQ_SEG_HANDLE, 0, sizeof (cfg), offset);
136 memset (&cfg, 0, sizeof (cfg));
137 cfg.type = TRANSPORT_ENDPT_EXT_CFG_CRYPTO;
138 cfg.len = sizeof (cfg);
139 cfg.crypto.ckpair_index = em->ckpair_index;
140 cfg.crypto.crypto_engine = em->crypto_engine;
141 clib_memcpy_fast (c->data, &cfg, cfg.len);
145 echo_send_listen (echo_main_t * em, ip46_address_t * ip)
147 app_session_evt_t _app_evt, *app_evt = &_app_evt;
148 session_listen_msg_t *mp;
149 svm_msg_q_t *mq = em->ctrl_mq;
151 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_LISTEN);
152 mp = (session_listen_msg_t *) app_evt->evt->data;
153 memset (mp, 0, sizeof (*mp));
154 mp->client_index = em->my_client_index;
155 mp->context = ntohl (0xfeedface);
157 mp->is_ip4 = em->uri_elts.is_ip4;
158 clib_memcpy_fast (&mp->ip, ip, sizeof (mp->ip));
159 mp->port = em->uri_elts.port;
160 mp->proto = em->uri_elts.transport_proto;
161 if (echo_transport_needs_crypto (mp->proto))
162 echo_msg_add_crypto_ext_config (em, &mp->ext_config);
163 app_send_ctrl_evt_to_vpp (mq, app_evt);
167 echo_send_unbind (echo_main_t * em, echo_session_t * s)
169 app_session_evt_t _app_evt, *app_evt = &_app_evt;
170 session_unlisten_msg_t *mp;
171 svm_msg_q_t *mq = em->ctrl_mq;
173 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_UNLISTEN);
174 mp = (session_unlisten_msg_t *) app_evt->evt->data;
175 memset (mp, 0, sizeof (*mp));
176 mp->client_index = em->my_client_index;
178 mp->handle = s->vpp_session_handle;
180 app_send_ctrl_evt_to_vpp (mq, app_evt);
184 echo_send_connect (echo_main_t * em, void *args)
186 app_session_evt_t _app_evt, *app_evt = &_app_evt;
187 session_connect_msg_t *mp;
188 echo_connect_args_t *a = (echo_connect_args_t *) args;
189 svm_msg_q_t *mq = em->ctrl_mq;
191 clib_atomic_sub_fetch (&em->max_sim_connects, 1);
192 while (em->max_sim_connects <= 0)
195 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_CONNECT);
196 mp = (session_connect_msg_t *) app_evt->evt->data;
197 memset (mp, 0, sizeof (*mp));
198 mp->client_index = em->my_client_index;
199 mp->context = ntohl (a->context);
201 mp->is_ip4 = em->uri_elts.is_ip4;
202 clib_memcpy_fast (&mp->ip, &a->ip, sizeof (mp->ip));
203 clib_memcpy_fast (&mp->lcl_ip, &a->lcl_ip, sizeof (mp->ip));
204 mp->port = em->uri_elts.port;
205 mp->proto = em->uri_elts.transport_proto;
206 mp->parent_handle = a->parent_session_handle;
207 if (echo_transport_needs_crypto (mp->proto))
208 echo_msg_add_crypto_ext_config (em, &mp->ext_config);
209 mp->flags = em->connect_flag;
210 app_send_ctrl_evt_to_vpp (mq, app_evt);
214 echo_send_disconnect_session (echo_main_t * em, void *args)
217 app_session_evt_t _app_evt, *app_evt = &_app_evt;
218 session_disconnect_msg_t *mp;
219 svm_msg_q_t *mq = em->ctrl_mq;
220 echo_disconnect_args_t *a = (echo_disconnect_args_t *) args;
222 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_DISCONNECT);
223 mp = (session_disconnect_msg_t *) app_evt->evt->data;
224 memset (mp, 0, sizeof (*mp));
225 mp->client_index = em->my_client_index;
226 mp->handle = a->session_handle;
227 app_send_ctrl_evt_to_vpp (mq, app_evt);
229 if (!(s = echo_get_session_from_handle (em, mp->handle)))
231 em->proto_cb_vft->sent_disconnect_cb (s);
241 echo_segment_attach (u64 segment_handle, char *name, ssvm_segment_type_t type,
244 fifo_segment_create_args_t _a, *a = &_a;
245 echo_main_t *em = &echo_main;
246 fifo_segment_main_t *sm;
249 clib_memset (a, 0, sizeof (*a));
250 a->segment_name = (char *) name;
251 a->segment_type = type;
253 if (type == SSVM_SEGMENT_MEMFD)
256 sm = &em->segment_main;
258 if ((rv = fifo_segment_attach (sm, a)))
261 clib_spinlock_lock (&em->segment_handles_lock);
262 hash_set (em->shared_segment_handles, segment_handle,
263 a->new_segment_indices[0]);
264 clib_spinlock_unlock (&em->segment_handles_lock);
266 vec_free (a->new_segment_indices);
271 echo_segment_lookup (u64 segment_handle)
273 echo_main_t *em = &echo_main;
276 ECHO_LOG (3, "Check if segment mapped 0x%lx...", segment_handle);
278 clib_spinlock_lock (&em->segment_handles_lock);
279 segment_idxp = hash_get (em->shared_segment_handles, segment_handle);
280 clib_spinlock_unlock (&em->segment_handles_lock);
282 return ((u32) *segment_idxp);
284 ECHO_LOG (2, "Segment not mapped (0x%lx)", segment_handle);
289 echo_segment_detach (u64 segment_handle)
291 echo_main_t *em = &echo_main;
292 fifo_segment_main_t *sm;
294 u32 segment_index = echo_segment_lookup (segment_handle);
295 if (segment_index == (u32) ~0)
298 sm = &em->segment_main;
300 clib_spinlock_lock (&em->segment_handles_lock);
301 fifo_segment_delete (sm, fifo_segment_get_segment (sm, segment_index));
302 hash_unset (em->shared_segment_handles, segment_handle);
303 clib_spinlock_unlock (&em->segment_handles_lock);
307 echo_attach_session (uword segment_handle, uword rxf_offset, uword txf_offset,
308 uword mq_offset, echo_session_t *s)
310 echo_main_t *em = &echo_main;
311 u32 fs_index, eqs_index;
314 fs_index = echo_segment_lookup (segment_handle);
315 if (fs_index == (u32) ~0)
317 ECHO_LOG (0, "ERROR: segment for session %u is not mounted!",
322 if (mq_offset != (uword) ~0)
324 eqs_index = echo_segment_lookup (ECHO_MQ_SEG_HANDLE);
325 ASSERT (eqs_index != (u32) ~0);
328 clib_spinlock_lock (&em->segment_handles_lock);
330 fs = fifo_segment_get_segment (&em->segment_main, fs_index);
331 s->rx_fifo = fifo_segment_alloc_fifo_w_offset (fs, rxf_offset);
332 s->tx_fifo = fifo_segment_alloc_fifo_w_offset (fs, txf_offset);
333 s->rx_fifo->segment_index = fs_index;
334 s->tx_fifo->segment_index = fs_index;
335 s->rx_fifo->shr->client_session_index = s->session_index;
336 s->tx_fifo->shr->client_session_index = s->session_index;
338 if (mq_offset != (uword) ~0)
340 fs = fifo_segment_get_segment (&em->segment_main, eqs_index);
341 s->vpp_evt_q = fifo_segment_msg_q_attach (fs, mq_offset,
342 s->rx_fifo->shr->slice_index);
345 clib_spinlock_unlock (&em->segment_handles_lock);
351 echo_segment_attach_mq (uword segment_handle, uword mq_offset, u32 mq_index,
354 echo_main_t *em = &echo_main;
358 fs_index = echo_segment_lookup (segment_handle);
359 if (fs_index == (u32) ~0)
361 ECHO_LOG (0, "ERROR: mq segment %lx for is not attached!",
366 clib_spinlock_lock (&em->segment_handles_lock);
368 fs = fifo_segment_get_segment (&em->segment_main, fs_index);
369 *mq = fifo_segment_msg_q_attach (fs, mq_offset, mq_index);
371 clib_spinlock_unlock (&em->segment_handles_lock);
377 echo_segment_alloc_chunk (uword segment_handle, u32 slice_index, u32 size,
380 echo_main_t *em = &echo_main;
385 fs_index = echo_segment_lookup (segment_handle);
386 if (fs_index == (u32) ~0)
388 ECHO_LOG (0, "ERROR: mq segment %lx for is not attached!",
393 clib_spinlock_lock (&em->segment_handles_lock);
395 fs = fifo_segment_get_segment (&em->segment_main, fs_index);
396 c = fifo_segment_alloc_chunk_w_slice (fs, slice_index, size);
397 *offset = fifo_segment_chunk_offset (fs, c);
399 clib_spinlock_unlock (&em->segment_handles_lock);
406 * Binary API callbacks
411 vl_api_app_add_cert_key_pair_reply_t_handler
412 (vl_api_app_add_cert_key_pair_reply_t * mp)
414 echo_main_t *em = &echo_main;
417 ECHO_FAIL (ECHO_FAIL_VL_API_CERT_KEY_ADD_REPLY,
418 "Adding cert and key returned %d",
419 clib_net_to_host_u32 (mp->retval));
422 /* No concurrency here, only bapi thread writes */
423 if (em->state != STATE_ATTACHED_NO_CERT)
425 ECHO_FAIL (ECHO_FAIL_VL_API_CERT_KEY_ADD_REPLY, "Wrong state");
428 em->ckpair_index = clib_net_to_host_u32 (mp->index);
429 em->state = STATE_ATTACHED;
433 vl_api_app_del_cert_key_pair_reply_t_handler
434 (vl_api_app_del_cert_key_pair_reply_t * mp)
436 echo_main_t *em = &echo_main;
439 ECHO_FAIL (ECHO_FAIL_VL_API_CERT_KEY_DEL_REPLY,
440 "Delete cert and key returned %d",
441 clib_net_to_host_u32 (mp->retval));
444 em->state = STATE_CLEANED_CERT_KEY;
448 vl_api_app_attach_reply_t_handler (vl_api_app_attach_reply_t * mp)
450 echo_main_t *em = &echo_main;
454 char *segment_name = 0;
456 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
457 ECHO_LOG (2, "Attached returned app %u", htons (mp->app_index));
461 ECHO_FAIL (ECHO_FAIL_VL_API_APP_ATTACH, "attach failed: %U",
462 format_api_error, clib_net_to_host_u32 (mp->retval));
468 ECHO_FAIL (ECHO_FAIL_VL_API_NULL_APP_MQ, "NULL app_mq");
474 vec_validate (fds, mp->n_fds);
475 if (vl_socket_client_recv_fd_msg (fds, mp->n_fds, 5))
477 ECHO_FAIL (ECHO_FAIL_VL_API_RECV_FD_MSG,
478 "vl_socket_client_recv_fd_msg failed");
482 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
483 if (echo_segment_attach (ECHO_MQ_SEG_HANDLE, 0, SSVM_SEGMENT_MEMFD,
486 ECHO_FAIL (ECHO_FAIL_VL_API_SVM_FIFO_SEG_ATTACH,
487 "svm_fifo_segment_attach failed on SSVM_SEGMENT_MEMFD");
490 echo_segment_attach_mq (ECHO_MQ_SEG_HANDLE, mp->vpp_ctrl_mq,
491 mp->vpp_ctrl_mq_thread, &em->ctrl_mq);
493 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
495 segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
496 rv = echo_segment_attach (segment_handle, segment_name,
497 SSVM_SEGMENT_MEMFD, fds[n_fds++]);
500 ECHO_FAIL (ECHO_FAIL_VL_API_SVM_FIFO_SEG_ATTACH,
501 "svm_fifo_segment_attach ('%s') "
502 "failed on SSVM_SEGMENT_MEMFD", segment_name);
503 vec_free (segment_name);
506 vec_free (segment_name);
508 echo_segment_attach_mq (segment_handle, mp->app_mq, 0, &em->app_mq);
510 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
511 svm_msg_q_set_eventfd (em->app_mq, fds[n_fds++]);
517 segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name);
518 rv = echo_segment_attach (segment_handle, segment_name, SSVM_SEGMENT_SHM,
522 ECHO_FAIL (ECHO_FAIL_VL_API_SVM_FIFO_SEG_ATTACH,
523 "svm_fifo_segment_attach ('%s') "
524 "failed on SSVM_SEGMENT_SHM", segment_name);
525 vec_free (segment_name);
528 vec_free (segment_name);
530 ECHO_LOG (2, "Mapped segment 0x%lx", segment_handle);
532 em->state = STATE_ATTACHED_NO_CERT;
535 for (i = clib_max (n_fds - 1, 0); i < vec_len (fds); i++)
541 vl_api_application_detach_reply_t_handler (vl_api_application_detach_reply_t *
546 ECHO_FAIL (ECHO_FAIL_VL_API_DETACH_REPLY,
547 "app detach returned with err: %d", mp->retval);
550 echo_main.state = STATE_DETACHED;
553 #define foreach_quic_echo_msg \
554 _(APP_ATTACH_REPLY, app_attach_reply) \
555 _(APPLICATION_DETACH_REPLY, application_detach_reply) \
556 _(APP_ADD_CERT_KEY_PAIR_REPLY, app_add_cert_key_pair_reply) \
557 _(APP_DEL_CERT_KEY_PAIR_REPLY, app_del_cert_key_pair_reply)
560 #include <vnet/session/session.api.h>
563 #define vl_calcsizefun
564 #include <vnet/session/session.api.h>
565 #undef vl_calcsizefun
568 #include <vnet/session/session.api.h>
571 #define vl_api_version(n, v) static u32 api_version = v;
572 #include <vnet/session/session.api.h>
573 #undef vl_api_version
576 echo_api_hookup (echo_main_t * em)
578 u8 *name = format (0, "session_%08x%c", api_version, 0);
580 REPLY_MSG_ID_BASE = vl_client_get_first_plugin_msg_id ((char *) name);
584 if (REPLY_MSG_ID_BASE == (u16) ~0)
588 vl_msg_api_config (&(vl_msg_api_msg_config_t){ \
589 .id = REPLY_MSG_ID_BASE + VL_API_##N, \
591 .handler = vl_api_##n##_t_handler, \
592 .endian = vl_api_##n##_t_endian, \
593 .format_fn = vl_api_##n##_t_format, \
594 .size = sizeof (vl_api_##n##_t), \
596 .tojson = vl_api_##n##_t_tojson, \
597 .fromjson = vl_api_##n##_t_fromjson, \
598 .calc_size = vl_api_##n##_t_calc_size, \
600 foreach_quic_echo_msg;
605 * fd.io coding-style-patch-verification: ON
608 * eval: (c-set-style "gnu")