api: multiple connections per process
[vpp.git] / src / vcl / vcl_bapi.c
1 /*
2  * Copyright (c) 2018-2019 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15
16 #include <vcl/vcl_private.h>
17 #include <vlibmemory/api.h>
18 #include <vpp/api/vpe_msg_enum.h>
19
20 #define vl_typedefs             /* define message structures */
21 #include <vpp/api/vpe_all_api_h.h>
22 #undef vl_typedefs
23
24 /* declare message handlers for each api */
25
26 #define vl_endianfun            /* define message structures */
27 #include <vpp/api/vpe_all_api_h.h>
28 #undef vl_endianfun
29
30 /* instantiate all the print functions we know about */
31 #define vl_print(handle, ...)
32 #define vl_printfun
33 #include <vpp/api/vpe_all_api_h.h>
34 #undef vl_printfun
35
36 u8 *
37 format_api_error (u8 * s, va_list * args)
38 {
39   i32 error = va_arg (*args, u32);
40   uword *p;
41
42   p = hash_get (vcm->error_string_by_error_number, -error);
43
44   if (p)
45     s = format (s, "%s (%d)", p[0], error);
46   else
47     s = format (s, "%d", error);
48   return s;
49 }
50
51 static void
52   vl_api_session_enable_disable_reply_t_handler
53   (vl_api_session_enable_disable_reply_t * mp)
54 {
55   if (mp->retval)
56     {
57       clib_warning ("VCL<%d>: session_enable_disable failed: %U", getpid (),
58                     format_api_error, ntohl (mp->retval));
59     }
60   else
61     vcm->app_state = STATE_APP_ENABLED;
62 }
63
64 static int
65 vcl_segment_attach (u64 segment_handle, char *name, ssvm_segment_type_t type,
66                     int fd)
67 {
68   fifo_segment_create_args_t _a, *a = &_a;
69   int rv;
70
71   memset (a, 0, sizeof (*a));
72   a->segment_name = (char *) name;
73   a->segment_type = type;
74
75   if (type == SSVM_SEGMENT_MEMFD)
76     a->memfd_fd = fd;
77
78   if ((rv = fifo_segment_attach (&vcm->segment_main, a)))
79     {
80       clib_warning ("svm_fifo_segment_attach ('%s') failed", name);
81       return rv;
82     }
83   vcl_segment_table_add (segment_handle, a->new_segment_indices[0]);
84   vec_reset_length (a->new_segment_indices);
85   return 0;
86 }
87
88 static void
89 vcl_segment_detach (u64 segment_handle)
90 {
91   fifo_segment_main_t *sm = &vcm->segment_main;
92   fifo_segment_t *segment;
93   u32 segment_index;
94
95   segment_index = vcl_segment_table_lookup (segment_handle);
96   if (segment_index == (u32) ~ 0)
97     return;
98   segment = fifo_segment_get_segment (sm, segment_index);
99   fifo_segment_delete (sm, segment);
100   vcl_segment_table_del (segment_handle);
101   VDBG (0, "detached segment %u handle %u", segment_index, segment_handle);
102 }
103
104 static u64
105 vcl_vpp_worker_segment_handle (u32 wrk_index)
106 {
107   return (VCL_INVALID_SEGMENT_HANDLE - wrk_index - 1);
108 }
109
110 static void
111 vl_api_app_attach_reply_t_handler (vl_api_app_attach_reply_t * mp)
112 {
113   vcl_worker_t *wrk = vcl_worker_get (0);
114   svm_msg_q_t *ctrl_mq;
115   u64 segment_handle;
116   int *fds = 0, i;
117   u32 n_fds = 0;
118
119   if (mp->retval)
120     {
121       VERR ("attach failed: %U", format_api_error, ntohl (mp->retval));
122       goto failed;
123     }
124
125   wrk->app_event_queue = uword_to_pointer (mp->app_mq, svm_msg_q_t *);
126   ctrl_mq = uword_to_pointer (mp->vpp_ctrl_mq, svm_msg_q_t *);
127   vec_validate (wrk->vpp_event_queues, mp->vpp_ctrl_mq_thread);
128   wrk->vpp_event_queues[mp->vpp_ctrl_mq_thread] = ctrl_mq;
129   vcm->ctrl_mq = wrk->ctrl_mq = ctrl_mq;
130   segment_handle = clib_net_to_host_u64 (mp->segment_handle);
131   if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
132     {
133       VERR ("invalid segment handle");
134       goto failed;
135     }
136
137   if (mp->n_fds)
138     {
139       vec_validate (fds, mp->n_fds);
140       if (vl_socket_client_recv_fd_msg (fds, mp->n_fds, 5))
141         goto failed;
142
143       if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
144         if (vcl_segment_attach (vcl_vpp_worker_segment_handle (0),
145                                 "vpp-mq-seg", SSVM_SEGMENT_MEMFD,
146                                 fds[n_fds++]))
147           goto failed;
148
149       if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
150         if (vcl_segment_attach (segment_handle, (char *) mp->segment_name,
151                                 SSVM_SEGMENT_MEMFD, fds[n_fds++]))
152           goto failed;
153
154       if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
155         {
156           svm_msg_q_set_consumer_eventfd (wrk->app_event_queue, fds[n_fds]);
157           vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
158           n_fds++;
159         }
160
161       vec_free (fds);
162     }
163   else
164     {
165       if (vcl_segment_attach (segment_handle, (char *) mp->segment_name,
166                               SSVM_SEGMENT_SHM, -1))
167         goto failed;
168     }
169
170   vcm->app_index = clib_net_to_host_u32 (mp->app_index);
171   vcm->app_state = STATE_APP_ATTACHED;
172   return;
173
174 failed:
175   vcm->app_state = STATE_APP_FAILED;
176   for (i = clib_max (n_fds - 1, 0); i < vec_len (fds); i++)
177     close (fds[i]);
178   vec_free (fds);
179 }
180
181 static void
182 vl_api_app_worker_add_del_reply_t_handler (vl_api_app_worker_add_del_reply_t *
183                                            mp)
184 {
185   int n_fds = 0, *fds = 0, i;
186   u64 segment_handle;
187   vcl_worker_t *wrk;
188   u32 wrk_index;
189
190   if (mp->retval)
191     {
192       clib_warning ("VCL<%d>: add/del worker failed: %U", getpid (),
193                     format_api_error, ntohl (mp->retval));
194       goto failed;
195     }
196
197   if (!mp->is_add)
198     return;
199
200   wrk_index = mp->context;
201   wrk = vcl_worker_get_if_valid (wrk_index);
202   if (!wrk)
203     return;
204
205   wrk->vpp_wrk_index = clib_net_to_host_u32 (mp->wrk_index);
206   wrk->app_event_queue = uword_to_pointer (mp->app_event_queue_address,
207                                            svm_msg_q_t *);
208   wrk->ctrl_mq = vcm->ctrl_mq;
209
210   segment_handle = clib_net_to_host_u64 (mp->segment_handle);
211   if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
212     {
213       clib_warning ("invalid segment handle");
214       goto failed;
215     }
216
217   if (mp->n_fds)
218     {
219       vec_validate (fds, mp->n_fds);
220       if (vl_socket_client_recv_fd_msg (fds, mp->n_fds, 5))
221         goto failed;
222
223       if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
224         if (vcl_segment_attach (vcl_vpp_worker_segment_handle (wrk_index),
225                                 "vpp-worker-seg", SSVM_SEGMENT_MEMFD,
226                                 fds[n_fds++]))
227           goto failed;
228
229       if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
230         if (vcl_segment_attach (segment_handle, (char *) mp->segment_name,
231                                 SSVM_SEGMENT_MEMFD, fds[n_fds++]))
232           goto failed;
233
234       if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
235         {
236           svm_msg_q_set_consumer_eventfd (wrk->app_event_queue, fds[n_fds]);
237           vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
238           n_fds++;
239         }
240
241       vec_free (fds);
242     }
243   else
244     {
245       if (vcl_segment_attach (segment_handle, (char *) mp->segment_name,
246                               SSVM_SEGMENT_SHM, -1))
247         goto failed;
248     }
249   vcm->app_state = STATE_APP_READY;
250   VDBG (0, "worker %u vpp-worker %u added", wrk_index, wrk->vpp_wrk_index);
251   return;
252
253 failed:
254   vcm->app_state = STATE_APP_FAILED;
255   for (i = clib_max (n_fds - 1, 0); i < vec_len (fds); i++)
256     close (fds[i]);
257   vec_free (fds);
258 }
259
260 static void
261 vl_api_map_another_segment_t_handler (vl_api_map_another_segment_t * mp)
262 {
263   ssvm_segment_type_t seg_type = SSVM_SEGMENT_SHM;
264   u64 segment_handle;
265   int fd = -1;
266
267   if (mp->fd_flags)
268     {
269       vl_socket_client_recv_fd_msg (&fd, 1, 5);
270       seg_type = SSVM_SEGMENT_MEMFD;
271     }
272
273   segment_handle = clib_net_to_host_u64 (mp->segment_handle);
274   if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
275     {
276       clib_warning ("invalid segment handle");
277       return;
278     }
279
280   if (vcl_segment_attach (segment_handle, (char *) mp->segment_name,
281                           seg_type, fd))
282     {
283       clib_warning ("VCL<%d>: svm_fifo_segment_attach ('%s') failed",
284                     getpid (), mp->segment_name);
285       return;
286     }
287
288   VDBG (1, "VCL<%d>: mapped new segment '%s' size %d", getpid (),
289         mp->segment_name, mp->segment_size);
290 }
291
292 static void
293 vl_api_unmap_segment_t_handler (vl_api_unmap_segment_t * mp)
294 {
295   u64 segment_handle = clib_net_to_host_u64 (mp->segment_handle);
296   vcl_segment_detach (segment_handle);
297   VDBG (1, "Unmapped segment: %d", segment_handle);
298 }
299
300 static void
301   vl_api_application_tls_cert_add_reply_t_handler
302   (vl_api_application_tls_cert_add_reply_t * mp)
303 {
304   if (mp->retval)
305     VDBG (0, "add cert failed: %U", format_api_error, ntohl (mp->retval));
306   vcm->app_state = STATE_APP_READY;
307 }
308
309 static void
310   vl_api_application_tls_key_add_reply_t_handler
311   (vl_api_application_tls_key_add_reply_t * mp)
312 {
313   if (mp->retval)
314     VDBG (0, "add key failed: %U", format_api_error, ntohl (mp->retval));
315   vcm->app_state = STATE_APP_READY;
316 }
317
318 #define foreach_sock_msg                                                \
319 _(SESSION_ENABLE_DISABLE_REPLY, session_enable_disable_reply)           \
320 _(APP_ATTACH_REPLY, app_attach_reply)                                   \
321 _(APPLICATION_TLS_CERT_ADD_REPLY, application_tls_cert_add_reply)       \
322 _(APPLICATION_TLS_KEY_ADD_REPLY, application_tls_key_add_reply)         \
323 _(MAP_ANOTHER_SEGMENT, map_another_segment)                             \
324 _(UNMAP_SEGMENT, unmap_segment)                                         \
325 _(APP_WORKER_ADD_DEL_REPLY, app_worker_add_del_reply)                   \
326
327 void
328 vppcom_api_hookup (void)
329 {
330 #define _(N, n)                                                 \
331     vl_msg_api_set_handlers(VL_API_##N, #n,                     \
332                            vl_api_##n##_t_handler,              \
333                            vl_noop_handler,                     \
334                            vl_api_##n##_t_endian,               \
335                            vl_api_##n##_t_print,                \
336                            sizeof(vl_api_##n##_t), 1);
337   foreach_sock_msg;
338 #undef _
339 }
340
341 /*
342  * VPP-API message functions
343  */
344 void
345 vppcom_send_session_enable_disable (u8 is_enable)
346 {
347   vcl_worker_t *wrk = vcl_worker_get_current ();
348   vl_api_session_enable_disable_t *bmp;
349   bmp = vl_msg_api_alloc (sizeof (*bmp));
350   memset (bmp, 0, sizeof (*bmp));
351
352   bmp->_vl_msg_id = ntohs (VL_API_SESSION_ENABLE_DISABLE);
353   bmp->client_index = wrk->my_client_index;
354   bmp->context = htonl (0xfeedface);
355   bmp->is_enable = is_enable;
356   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
357 }
358
359 void
360 vppcom_app_send_attach (void)
361 {
362   vcl_worker_t *wrk = vcl_worker_get_current ();
363   u8 tls_engine = CRYPTO_ENGINE_OPENSSL;
364   vl_api_app_attach_t *bmp;
365   u8 nsid_len = vec_len (vcm->cfg.namespace_id);
366   u8 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
367                      vcm->cfg.app_proxy_transport_udp);
368
369   tls_engine = vcm->cfg.tls_engine ? vcm->cfg.tls_engine : tls_engine;
370
371   bmp = vl_msg_api_alloc (sizeof (*bmp));
372   memset (bmp, 0, sizeof (*bmp));
373
374   bmp->_vl_msg_id = ntohs (VL_API_APP_ATTACH);
375   bmp->client_index = wrk->my_client_index;
376   bmp->context = htonl (0xfeedface);
377   bmp->options[APP_OPTIONS_FLAGS] =
378     APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
379     (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
380     (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
381     (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0) |
382     (vcm->cfg.use_mq_eventfd ? APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD : 0);
383   bmp->options[APP_OPTIONS_PROXY_TRANSPORT] =
384     (u64) ((vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
385            (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0));
386   bmp->options[APP_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
387   bmp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
388   bmp->options[APP_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
389   bmp->options[APP_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
390   bmp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
391     vcm->cfg.preallocated_fifo_pairs;
392   bmp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = vcm->cfg.event_queue_size;
393   bmp->options[APP_OPTIONS_TLS_ENGINE] = tls_engine;
394   if (nsid_len)
395     {
396       bmp->namespace_id_len = nsid_len;
397       clib_memcpy_fast (bmp->namespace_id, vcm->cfg.namespace_id, nsid_len);
398       bmp->options[APP_OPTIONS_NAMESPACE_SECRET] = vcm->cfg.namespace_secret;
399     }
400   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
401 }
402
403 void
404 vppcom_app_send_detach (void)
405 {
406   vcl_worker_t *wrk = vcl_worker_get_current ();
407   vl_api_application_detach_t *bmp;
408   bmp = vl_msg_api_alloc (sizeof (*bmp));
409   memset (bmp, 0, sizeof (*bmp));
410
411   bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_DETACH);
412   bmp->client_index = wrk->my_client_index;
413   bmp->context = htonl (0xfeedface);
414   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp);
415 }
416
417 void
418 vcl_send_app_worker_add_del (u8 is_add)
419 {
420   vcl_worker_t *wrk = vcl_worker_get_current ();
421   vl_api_app_worker_add_del_t *mp;
422
423   mp = vl_msg_api_alloc (sizeof (*mp));
424   memset (mp, 0, sizeof (*mp));
425
426   mp->_vl_msg_id = ntohs (VL_API_APP_WORKER_ADD_DEL);
427   mp->client_index = wrk->my_client_index;
428   mp->app_index = clib_host_to_net_u32 (vcm->app_index);
429   mp->context = wrk->wrk_index;
430   mp->is_add = is_add;
431   if (!is_add)
432     mp->wrk_index = clib_host_to_net_u32 (wrk->vpp_wrk_index);
433
434   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp);
435 }
436
437 void
438 vcl_send_child_worker_del (vcl_worker_t * child_wrk)
439 {
440   vcl_worker_t *wrk = vcl_worker_get_current ();
441   vl_api_app_worker_add_del_t *mp;
442
443   mp = vl_msg_api_alloc (sizeof (*mp));
444   memset (mp, 0, sizeof (*mp));
445
446   mp->_vl_msg_id = ntohs (VL_API_APP_WORKER_ADD_DEL);
447   mp->client_index = wrk->my_client_index;
448   mp->app_index = clib_host_to_net_u32 (vcm->app_index);
449   mp->context = wrk->wrk_index;
450   mp->is_add = 0;
451   mp->wrk_index = clib_host_to_net_u32 (child_wrk->vpp_wrk_index);
452
453   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp);
454 }
455
456 void
457 vppcom_send_application_tls_cert_add (vcl_session_t * session, char *cert,
458                                       u32 cert_len)
459 {
460   vcl_worker_t *wrk = vcl_worker_get_current ();
461   vl_api_application_tls_cert_add_t *cert_mp;
462
463   cert_mp = vl_msg_api_alloc (sizeof (*cert_mp) + cert_len);
464   clib_memset (cert_mp, 0, sizeof (*cert_mp));
465   cert_mp->_vl_msg_id = ntohs (VL_API_APPLICATION_TLS_CERT_ADD);
466   cert_mp->client_index = wrk->my_client_index;
467   cert_mp->context = session->session_index;
468   cert_mp->cert_len = clib_host_to_net_u16 (cert_len);
469   clib_memcpy_fast (cert_mp->cert, cert, cert_len);
470   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & cert_mp);
471 }
472
473 void
474 vppcom_send_application_tls_key_add (vcl_session_t * session, char *key,
475                                      u32 key_len)
476 {
477   vcl_worker_t *wrk = vcl_worker_get_current ();
478   vl_api_application_tls_key_add_t *key_mp;
479
480   key_mp = vl_msg_api_alloc (sizeof (*key_mp) + key_len);
481   clib_memset (key_mp, 0, sizeof (*key_mp));
482   key_mp->_vl_msg_id = ntohs (VL_API_APPLICATION_TLS_KEY_ADD);
483   key_mp->client_index = wrk->my_client_index;
484   key_mp->context = session->session_index;
485   key_mp->key_len = clib_host_to_net_u16 (key_len);
486   clib_memcpy_fast (key_mp->key, key, key_len);
487   vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & key_mp);
488 }
489
490 u32
491 vcl_max_nsid_len (void)
492 {
493   vl_api_application_attach_t *mp;
494   return (sizeof (mp->namespace_id) - 1);
495 }
496
497 void
498 vppcom_init_error_string_table (void)
499 {
500   vcm->error_string_by_error_number = hash_create (0, sizeof (uword));
501
502 #define _(n, v, s) hash_set (vcm->error_string_by_error_number, -v, s);
503   foreach_vnet_api_error;
504 #undef _
505
506   hash_set (vcm->error_string_by_error_number, 99, "Misc");
507 }
508
509 int
510 vppcom_connect_to_vpp (char *app_name)
511 {
512   vcl_worker_t *wrk = vcl_worker_get_current ();
513   api_main_t *am = vlibapi_get_main ();
514   vppcom_cfg_t *vcl_cfg = &vcm->cfg;
515
516   if (vcl_cfg->vpp_api_socket_name)
517     {
518       if (vl_socket_client_connect ((char *) vcl_cfg->vpp_api_socket_name,
519                                     app_name, 0 /* default rx/tx buffer */ ))
520         {
521           VERR ("app (%s) socket connect failed!", app_name);
522           return VPPCOM_ECONNREFUSED;
523         }
524
525       if (vl_socket_client_init_shm (0, 1 /* want_pthread */ ))
526         {
527           VERR ("app (%s) init shm failed!", app_name);
528           return VPPCOM_ECONNREFUSED;
529         }
530     }
531   else
532     {
533       if (!vcl_cfg->vpp_api_filename)
534         vcl_cfg->vpp_api_filename = format (0, "/vpe-api%c", 0);
535
536       VDBG (0, "app (%s) connecting to VPP api (%s)...",
537             app_name, vcl_cfg->vpp_api_filename);
538
539       if (vl_client_connect_to_vlib ((char *) vcl_cfg->vpp_api_filename,
540                                      app_name, vcm->cfg.vpp_api_q_length) < 0)
541         {
542           VERR ("app (%s) connect failed!", app_name);
543           return VPPCOM_ECONNREFUSED;
544         }
545
546     }
547
548   wrk->vl_input_queue = am->shmem_hdr->vl_input_queue;
549   wrk->my_client_index = (u32) am->my_client_index;
550   wrk->wrk_state = STATE_APP_CONN_VPP;
551
552   VDBG (0, "app (%s) is connected to VPP!", app_name);
553   vcl_evt (VCL_EVT_INIT, vcm);
554   return VPPCOM_OK;
555 }
556
557 void
558 vppcom_disconnect_from_vpp (void)
559 {
560   vppcom_cfg_t *vcl_cfg = &vcm->cfg;
561
562   if (vcl_cfg->vpp_api_socket_name)
563     vl_socket_client_disconnect ();
564   else
565     vl_client_disconnect_from_vlib ();
566 }
567
568 /*
569  * fd.io coding-style-patch-verification: ON
570  *
571  * Local Variables:
572  * eval: (c-set-style "gnu")
573  * End:
574  */