vcl: add support for multi-worker apps
[vpp.git] / src / vcl / vcl_bapi.c
1 /*
2  * Copyright (c) 2018 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 ssvm_segment_attach (char *name, ssvm_segment_type_t type, int fd)
66 {
67   svm_fifo_segment_create_args_t _a, *a = &_a;
68   int rv;
69
70   memset (a, 0, sizeof (*a));
71   a->segment_name = (char *) name;
72   a->segment_type = type;
73
74   if (type == SSVM_SEGMENT_MEMFD)
75     a->memfd_fd = fd;
76
77   if ((rv = svm_fifo_segment_attach (a)))
78     {
79       clib_warning ("svm_fifo_segment_attach ('%s') failed", name);
80       return rv;
81     }
82   vec_reset_length (a->new_segment_indices);
83   return 0;
84 }
85
86 static void
87 vl_api_application_attach_reply_t_handler (vl_api_application_attach_reply_t *
88                                            mp)
89 {
90   vcl_worker_t *wrk = vcl_worker_get (0);
91   u32 n_fds = 0;
92   int *fds = 0;
93
94   if (mp->retval)
95     {
96       clib_warning ("VCL<%d>: attach failed: %U", getpid (),
97                     format_api_error, ntohl (mp->retval));
98       return;
99     }
100
101   wrk->app_event_queue = uword_to_pointer (mp->app_event_queue_address,
102                                            svm_msg_q_t *);
103   if (mp->n_fds)
104     {
105       vec_validate (fds, mp->n_fds);
106       vl_socket_client_recv_fd_msg (fds, mp->n_fds, 5);
107
108       if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
109         if (ssvm_segment_attach ("vpp-mq-seg", SSVM_SEGMENT_MEMFD,
110                                  fds[n_fds++]))
111           return;
112
113       if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
114         if (ssvm_segment_attach ((char *) mp->segment_name,
115                                  SSVM_SEGMENT_MEMFD, fds[n_fds++]))
116           return;
117
118       if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
119         {
120           svm_msg_q_set_consumer_eventfd (wrk->app_event_queue, fds[n_fds]);
121           vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
122           n_fds++;
123         }
124
125       vec_free (fds);
126     }
127   else
128     {
129       if (ssvm_segment_attach ((char *) mp->segment_name, SSVM_SEGMENT_SHM,
130                                -1))
131         return;
132     }
133
134   vcm->app_state = STATE_APP_ATTACHED;
135 }
136
137 static void
138 vl_api_app_worker_add_del_reply_t_handler (vl_api_app_worker_add_del_reply_t *
139                                            mp)
140 {
141   vcl_worker_t *wrk;
142   int n_fds = 0;
143   int *fds = 0;
144
145   if (mp->retval)
146     {
147       clib_warning ("VCL<%d>: add/del worker failed: %U", getpid (),
148                     format_api_error, ntohl (mp->retval));
149       goto failed;
150     }
151   ASSERT (mp->context == mp->wrk_index);
152   if (mp->context != mp->wrk_index)
153     {
154       clib_warning ("VCL<%d>: wrk numbering doesn't match ours: %u, vpp: %u",
155                     getpid (), mp->context, mp->wrk_index);
156       goto failed;
157     }
158   wrk = vcl_worker_get (mp->context);
159   wrk->app_event_queue = uword_to_pointer (mp->app_event_queue_address,
160                                            svm_msg_q_t *);
161
162   if (mp->n_fds)
163     {
164       vec_validate (fds, mp->n_fds);
165       vl_socket_client_recv_fd_msg (fds, mp->n_fds, 5);
166
167       if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
168         if (ssvm_segment_attach ("vpp-worker-seg", SSVM_SEGMENT_MEMFD,
169                                  fds[n_fds++]))
170           goto failed;
171
172       if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
173         if (ssvm_segment_attach ((char *) mp->segment_name,
174                                  SSVM_SEGMENT_MEMFD, fds[n_fds++]))
175           goto failed;
176
177       if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
178         {
179           svm_msg_q_set_consumer_eventfd (wrk->app_event_queue, fds[n_fds]);
180           vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
181           n_fds++;
182         }
183
184       vec_free (fds);
185     }
186   else
187     {
188       if (ssvm_segment_attach ((char *) mp->segment_name, SSVM_SEGMENT_SHM,
189                                -1))
190         goto failed;
191     }
192   vcm->app_state = STATE_APP_READY;
193   return;
194
195 failed:
196   vcm->app_state = STATE_APP_FAILED;
197 }
198
199 static void
200 vl_api_application_detach_reply_t_handler (vl_api_application_detach_reply_t *
201                                            mp)
202 {
203   if (mp->retval)
204     clib_warning ("VCL<%d>: detach failed: %U", getpid (), format_api_error,
205                   ntohl (mp->retval));
206
207   vcm->app_state = STATE_APP_ENABLED;
208 }
209
210 static void
211 vl_api_map_another_segment_t_handler (vl_api_map_another_segment_t * mp)
212 {
213   ssvm_segment_type_t seg_type = SSVM_SEGMENT_SHM;
214   int fd = -1;
215
216   vcm->mounting_segment = 1;
217
218   if (mp->fd_flags)
219     {
220       vl_socket_client_recv_fd_msg (&fd, 1, 5);
221       seg_type = SSVM_SEGMENT_MEMFD;
222     }
223
224   if (PREDICT_FALSE (ssvm_segment_attach ((char *) mp->segment_name,
225                                           seg_type, fd)))
226     {
227       clib_warning ("VCL<%d>: svm_fifo_segment_attach ('%s') failed",
228                     getpid (), mp->segment_name);
229       return;
230     }
231
232   VDBG (1, "VCL<%d>: mapped new segment '%s' size %d", getpid (),
233         mp->segment_name, mp->segment_size);
234   vcm->mounting_segment = 0;
235 }
236
237 static void
238 vl_api_unmap_segment_t_handler (vl_api_unmap_segment_t * mp)
239 {
240
241 /*
242  * XXX Need segment_name to session_id hash,
243  * XXX - have sessionID by handle hash currently
244  */
245
246   VDBG (1, "Unmapped segment '%s'", mp->segment_name);
247 }
248
249 static void
250   vl_api_app_cut_through_registration_add_t_handler
251   (vl_api_app_cut_through_registration_add_t * mp)
252 {
253   vcl_cut_through_registration_t *ctr;
254   u32 mqc_index = ~0;
255   vcl_worker_t *wrk;
256   int *fds = 0;
257
258   if (mp->n_fds)
259     {
260       ASSERT (mp->n_fds == 2);
261       vec_validate (fds, mp->n_fds);
262       vl_socket_client_recv_fd_msg (fds, mp->n_fds, 5);
263     }
264
265   wrk = vcl_worker_get (mp->wrk_index);
266   ctr = vcl_ct_registration_lock_and_alloc (wrk);
267   ctr->mq = uword_to_pointer (mp->evt_q_address, svm_msg_q_t *);
268   ctr->peer_mq = uword_to_pointer (mp->peer_evt_q_address, svm_msg_q_t *);
269   VDBG (0, "Adding ct registration %u", vcl_ct_registration_index (wrk, ctr));
270
271   if (mp->n_fds && (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD))
272     {
273       svm_msg_q_set_consumer_eventfd (ctr->mq, fds[0]);
274       svm_msg_q_set_producer_eventfd (ctr->peer_mq, fds[1]);
275       mqc_index = vcl_mq_epoll_add_evfd (wrk, ctr->mq);
276       ctr->epoll_evt_conn_index = mqc_index;
277       vec_free (fds);
278     }
279   vcl_ct_registration_lookup_add (wrk, mp->evt_q_address,
280                                   vcl_ct_registration_index (wrk, ctr));
281   vcl_ct_registration_unlock (wrk);
282 }
283
284 static void
285 vl_api_bind_sock_reply_t_handler (vl_api_bind_sock_reply_t * mp)
286 {
287   /* Expecting a similar message on mq. So ignore this */
288   VDBG (1, "VCL<%d>: bapi msg vpp handle 0x%llx, sid %u: bind retval: %u!",
289         getpid (), mp->handle, mp->context, mp->retval);
290 }
291
292 static void
293 vl_api_unbind_sock_reply_t_handler (vl_api_unbind_sock_reply_t * mp)
294 {
295   if (mp->retval)
296     clib_warning ("VCL<%d>: ERROR: sid %u: unbind failed: %U",
297                   getpid (), mp->context, format_api_error,
298                   ntohl (mp->retval));
299
300   else
301     VDBG (1, "VCL<%d>: sid %u: unbind succeeded!", getpid (), mp->context);
302 }
303
304 #define foreach_sock_msg                                                \
305 _(SESSION_ENABLE_DISABLE_REPLY, session_enable_disable_reply)           \
306 _(BIND_SOCK_REPLY, bind_sock_reply)                                     \
307 _(UNBIND_SOCK_REPLY, unbind_sock_reply)                                 \
308 _(APPLICATION_ATTACH_REPLY, application_attach_reply)                   \
309 _(APPLICATION_DETACH_REPLY, application_detach_reply)                   \
310 _(MAP_ANOTHER_SEGMENT, map_another_segment)                             \
311 _(UNMAP_SEGMENT, unmap_segment)                                         \
312 _(APP_CUT_THROUGH_REGISTRATION_ADD, app_cut_through_registration_add)   \
313 _(APP_WORKER_ADD_DEL_REPLY, app_worker_add_del_reply)                   \
314
315 void
316 vppcom_api_hookup (void)
317 {
318 #define _(N, n)                                                 \
319     vl_msg_api_set_handlers(VL_API_##N, #n,                     \
320                            vl_api_##n##_t_handler,              \
321                            vl_noop_handler,                     \
322                            vl_api_##n##_t_endian,               \
323                            vl_api_##n##_t_print,                \
324                            sizeof(vl_api_##n##_t), 1);
325   foreach_sock_msg;
326 #undef _
327 }
328
329 /*
330  * VPP-API message functions
331  */
332 void
333 vppcom_send_session_enable_disable (u8 is_enable)
334 {
335   vl_api_session_enable_disable_t *bmp;
336   bmp = vl_msg_api_alloc (sizeof (*bmp));
337   memset (bmp, 0, sizeof (*bmp));
338
339   bmp->_vl_msg_id = ntohs (VL_API_SESSION_ENABLE_DISABLE);
340   bmp->client_index = vcm->my_client_index;
341   bmp->context = htonl (0xfeedface);
342   bmp->is_enable = is_enable;
343   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
344 }
345
346 void
347 vppcom_app_send_attach (void)
348 {
349   vl_api_application_attach_t *bmp;
350   u8 nsid_len = vec_len (vcm->cfg.namespace_id);
351   u8 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
352                      vcm->cfg.app_proxy_transport_udp);
353
354   bmp = vl_msg_api_alloc (sizeof (*bmp));
355   memset (bmp, 0, sizeof (*bmp));
356
357   bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_ATTACH);
358   bmp->client_index = vcm->my_client_index;
359   bmp->context = htonl (0xfeedface);
360   bmp->options[APP_OPTIONS_FLAGS] =
361     APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
362     (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
363     (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
364     (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0) |
365     APP_OPTIONS_FLAGS_USE_MQ_FOR_CTRL_MSGS |
366     (vcm->cfg.use_mq_eventfd ? APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD : 0);
367   bmp->options[APP_OPTIONS_PROXY_TRANSPORT] =
368     (u64) ((vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
369            (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0));
370   bmp->options[APP_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
371   bmp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
372   bmp->options[APP_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
373   bmp->options[APP_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
374   bmp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
375     vcm->cfg.preallocated_fifo_pairs;
376   bmp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = vcm->cfg.event_queue_size;
377   if (nsid_len)
378     {
379       bmp->namespace_id_len = nsid_len;
380       clib_memcpy (bmp->namespace_id, vcm->cfg.namespace_id, nsid_len);
381       bmp->options[APP_OPTIONS_NAMESPACE_SECRET] = vcm->cfg.namespace_secret;
382     }
383   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
384 }
385
386 void
387 vppcom_app_send_detach (void)
388 {
389   vl_api_application_detach_t *bmp;
390   bmp = vl_msg_api_alloc (sizeof (*bmp));
391   memset (bmp, 0, sizeof (*bmp));
392
393   bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_DETACH);
394   bmp->client_index = vcm->my_client_index;
395   bmp->context = htonl (0xfeedface);
396   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
397 }
398
399 void
400 vcl_send_app_worker_add_del (u8 is_add)
401 {
402   vcl_worker_t *wrk = vcl_worker_get_current ();
403   vl_api_app_worker_add_del_t *mp;
404   u32 wrk_index = wrk->wrk_index;
405
406   mp = vl_msg_api_alloc (sizeof (*mp));
407   memset (mp, 0, sizeof (*mp));
408
409   mp->_vl_msg_id = ntohs (VL_API_APP_WORKER_ADD_DEL);
410   mp->client_index = vcm->my_client_index;
411   mp->context = wrk_index;
412   mp->is_add = is_add;
413   if (!is_add)
414     mp->wrk_index = clib_host_to_net_u32 (wrk_index);
415
416   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & mp);
417 }
418
419 void
420 vppcom_send_connect_sock (vcl_session_t * session)
421 {
422   vl_api_connect_sock_t *cmp;
423
424   /* Assumes caller as acquired the spinlock: vcm->sessions_lockp */
425   cmp = vl_msg_api_alloc (sizeof (*cmp));
426   memset (cmp, 0, sizeof (*cmp));
427   cmp->_vl_msg_id = ntohs (VL_API_CONNECT_SOCK);
428   cmp->client_index = vcm->my_client_index;
429   cmp->context = session->session_index;
430
431   cmp->is_ip4 = session->transport.is_ip4;
432   clib_memcpy (cmp->ip, &session->transport.rmt_ip, sizeof (cmp->ip));
433   cmp->port = session->transport.rmt_port;
434   cmp->proto = session->session_type;
435   clib_memcpy (cmp->options, session->options, sizeof (cmp->options));
436   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & cmp);
437 }
438
439 void
440 vppcom_send_disconnect_session (u64 vpp_handle, u32 session_index)
441 {
442   vl_api_disconnect_session_t *dmp;
443
444   VDBG (1, "VCL<%d>: vpp handle 0x%llx, sid %u: sending disconnect msg",
445         getpid (), vpp_handle, session_index);
446
447   dmp = vl_msg_api_alloc (sizeof (*dmp));
448   memset (dmp, 0, sizeof (*dmp));
449   dmp->_vl_msg_id = ntohs (VL_API_DISCONNECT_SESSION);
450   dmp->client_index = vcm->my_client_index;
451   dmp->handle = vpp_handle;
452   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & dmp);
453 }
454
455 /* VPP combines bind and listen as one operation. VCL manages the separation
456  * of bind and listen locally via vppcom_session_bind() and
457  * vppcom_session_listen() */
458 void
459 vppcom_send_bind_sock (vcl_session_t * session)
460 {
461   vl_api_bind_sock_t *bmp;
462
463   /* Assumes caller has acquired spinlock: vcm->sessions_lockp */
464   bmp = vl_msg_api_alloc (sizeof (*bmp));
465   memset (bmp, 0, sizeof (*bmp));
466
467   bmp->_vl_msg_id = ntohs (VL_API_BIND_SOCK);
468   bmp->client_index = vcm->my_client_index;
469   bmp->context = session->session_index;
470   bmp->is_ip4 = session->transport.is_ip4;
471   clib_memcpy (bmp->ip, &session->transport.lcl_ip, sizeof (bmp->ip));
472   bmp->port = session->transport.lcl_port;
473   bmp->proto = session->session_type;
474   clib_memcpy (bmp->options, session->options, sizeof (bmp->options));
475   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
476 }
477
478 void
479 vppcom_send_unbind_sock (u64 vpp_handle)
480 {
481   vl_api_unbind_sock_t *ump;
482
483   ump = vl_msg_api_alloc (sizeof (*ump));
484   memset (ump, 0, sizeof (*ump));
485
486   ump->_vl_msg_id = ntohs (VL_API_UNBIND_SOCK);
487   ump->client_index = vcm->my_client_index;
488   ump->handle = vpp_handle;
489   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & ump);
490 }
491
492 void
493 vppcom_send_accept_session_reply (u64 handle, u32 context, int retval)
494 {
495   vl_api_accept_session_reply_t *rmp;
496
497   rmp = vl_msg_api_alloc (sizeof (*rmp));
498   memset (rmp, 0, sizeof (*rmp));
499   rmp->_vl_msg_id = ntohs (VL_API_ACCEPT_SESSION_REPLY);
500   rmp->retval = htonl (retval);
501   rmp->context = context;
502   rmp->handle = handle;
503   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & rmp);
504 }
505
506 u32
507 vcl_max_nsid_len (void)
508 {
509   vl_api_application_attach_t *mp;
510   return (sizeof (mp->namespace_id) - 1);
511 }
512
513 void
514 vppcom_init_error_string_table (void)
515 {
516   vcm->error_string_by_error_number = hash_create (0, sizeof (uword));
517
518 #define _(n, v, s) hash_set (vcm->error_string_by_error_number, -v, s);
519   foreach_vnet_api_error;
520 #undef _
521
522   hash_set (vcm->error_string_by_error_number, 99, "Misc");
523 }
524
525 int
526 vppcom_connect_to_vpp (char *app_name)
527 {
528   api_main_t *am = &api_main;
529   vppcom_cfg_t *vcl_cfg = &vcm->cfg;
530
531   if (vcl_cfg->vpp_api_socket_name)
532     {
533       if (vl_socket_client_connect ((char *) vcl_cfg->vpp_api_socket_name,
534                                     app_name, 0 /* default rx/tx buffer */ ))
535         {
536           clib_warning ("VCL<%d>: app (%s) socket connect failed!",
537                         getpid (), app_name);
538           return VPPCOM_ECONNREFUSED;
539         }
540
541       if (vl_socket_client_init_shm (0))
542         {
543           clib_warning ("VCL<%d>: app (%s) init shm failed!",
544                         getpid (), app_name);
545           return VPPCOM_ECONNREFUSED;
546         }
547     }
548   else
549     {
550       if (!vcl_cfg->vpp_api_filename)
551         vcl_cfg->vpp_api_filename = format (0, "/vpe-api%c", 0);
552
553       VDBG (0, "VCL<%d>: app (%s) connecting to VPP api (%s)...", getpid (),
554             app_name, vcl_cfg->vpp_api_filename);
555
556       if (vl_client_connect_to_vlib ((char *) vcl_cfg->vpp_api_filename,
557                                      app_name, vcm->cfg.vpp_api_q_length) < 0)
558         {
559           clib_warning ("VCL<%d>: app (%s) connect failed!", getpid (),
560                         app_name);
561           return VPPCOM_ECONNREFUSED;
562         }
563
564     }
565
566   vcm->vl_input_queue = am->shmem_hdr->vl_input_queue;
567   vcm->my_client_index = (u32) am->my_client_index;
568   vcm->app_state = STATE_APP_CONN_VPP;
569
570   VDBG (0, "VCL<%d>: app (%s) is connected to VPP!", getpid (), app_name);
571
572   vcl_evt (VCL_EVT_INIT, vcm);
573   return VPPCOM_OK;
574 }
575
576 /*
577  * fd.io coding-style-patch-verification: ON
578  *
579  * Local Variables:
580  * eval: (c-set-style "gnu")
581  * End:
582  */