LCOV - code coverage report
Current view: top level - vcl - vcl_sapi.c (source / functions) Hit Total Coverage
Test: coverage-filtered.info Lines: 128 249 51.4 %
Date: 2023-07-05 22:20:52 Functions: 8 11 72.7 %

          Line data    Source code
       1             : /*
       2             :  * Copyright (c) 2020 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             : 
      18             : static int
      19           8 : vcl_api_connect_app_socket (vcl_worker_t * wrk)
      20             : {
      21           8 :   clib_socket_t *cs = &wrk->app_api_sock;
      22             :   clib_error_t *err;
      23           8 :   int rv = 0;
      24             : 
      25           8 :   cs->config = (char *) vcm->cfg.vpp_app_socket_api;
      26           8 :   cs->flags =
      27           8 :     CLIB_SOCKET_F_IS_CLIENT | CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_BLOCKING;
      28             : 
      29           8 :   wrk->vcl_needs_real_epoll = 1;
      30             : 
      31           8 :   if ((err = clib_socket_init (cs)))
      32             :     {
      33             :       /* don't report the error to avoid flood of error messages during
      34             :        * reconnect */
      35           0 :       clib_error_free (err);
      36           0 :       rv = -1;
      37           0 :       goto done;
      38             :     }
      39             : 
      40           8 : done:
      41             : 
      42           8 :   wrk->vcl_needs_real_epoll = 0;
      43             : 
      44           8 :   return rv;
      45             : }
      46             : 
      47             : static int
      48           8 : vcl_api_attach_reply_handler (app_sapi_attach_reply_msg_t * mp, int *fds)
      49             : {
      50           8 :   vcl_worker_t *wrk = vcl_worker_get_current ();
      51           8 :   int i, rv, n_fds_used = 0;
      52             :   u64 segment_handle;
      53             :   u8 *segment_name;
      54             : 
      55           8 :   if (mp->retval)
      56             :     {
      57           0 :       VERR ("attach failed: %U", format_session_error, mp->retval);
      58           0 :       goto failed;
      59             :     }
      60             : 
      61           8 :   wrk->api_client_handle = mp->api_client_handle;
      62             :   /* reattaching via `vcl_api_retry_attach` wants wrk->vpp_wrk_index to be 0 */
      63           8 :   wrk->vpp_wrk_index = 0;
      64           8 :   segment_handle = mp->segment_handle;
      65           8 :   if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
      66             :     {
      67           0 :       VERR ("invalid segment handle");
      68           0 :       goto failed;
      69             :     }
      70             : 
      71           8 :   if (!mp->n_fds)
      72           0 :     goto failed;
      73             : 
      74           8 :   if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
      75           8 :     if (vcl_segment_attach (vcl_vpp_worker_segment_handle (0), "vpp-mq-seg",
      76           8 :                             SSVM_SEGMENT_MEMFD, fds[n_fds_used++]))
      77           0 :       goto failed;
      78             : 
      79           8 :   if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
      80             :     {
      81           8 :       segment_name = format (0, "memfd-%ld%c", segment_handle, 0);
      82           8 :       rv = vcl_segment_attach (segment_handle, (char *) segment_name,
      83           8 :                                SSVM_SEGMENT_MEMFD, fds[n_fds_used++]);
      84           8 :       vec_free (segment_name);
      85           8 :       if (rv != 0)
      86           0 :         goto failed;
      87             :     }
      88             : 
      89           8 :   vcl_segment_attach_mq (segment_handle, mp->app_mq, 0, &wrk->app_event_queue);
      90             : 
      91           8 :   if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
      92             :     {
      93           0 :       svm_msg_q_set_eventfd (wrk->app_event_queue, fds[n_fds_used++]);
      94           0 :       vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
      95             :     }
      96             : 
      97           8 :   vcl_segment_discover_mqs (vcl_vpp_worker_segment_handle (0),
      98           8 :                             fds + n_fds_used, mp->n_fds - n_fds_used);
      99           8 :   vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0), mp->vpp_ctrl_mq,
     100           8 :                          mp->vpp_ctrl_mq_thread, &wrk->ctrl_mq);
     101           8 :   vcm->ctrl_mq = wrk->ctrl_mq;
     102           8 :   vcm->app_index = mp->app_index;
     103             : 
     104           8 :   return 0;
     105             : 
     106           0 : failed:
     107             : 
     108           0 :   for (i = clib_max (n_fds_used - 1, 0); i < mp->n_fds; i++)
     109           0 :     close (fds[i]);
     110             : 
     111           0 :   return -1;
     112             : }
     113             : 
     114             : static int
     115           8 : vcl_api_send_attach (clib_socket_t * cs)
     116             : {
     117           8 :   app_sapi_msg_t msg = { 0 };
     118           8 :   app_sapi_attach_msg_t *mp = &msg.attach;
     119             :   u8 app_is_proxy, tls_engine;
     120             :   clib_error_t *err;
     121             : 
     122          16 :   app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
     123           8 :                   vcm->cfg.app_proxy_transport_udp);
     124           8 :   tls_engine = CRYPTO_ENGINE_OPENSSL;
     125             : 
     126           8 :   clib_memcpy (&mp->name, vcm->app_name, vec_len (vcm->app_name));
     127           8 :   mp->options[APP_OPTIONS_FLAGS] =
     128           8 :     APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
     129           8 :     (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
     130           8 :     (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
     131           8 :     (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0) |
     132           8 :     (vcm->cfg.use_mq_eventfd ? APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD : 0) |
     133           8 :     (vcm->cfg.huge_page ? APP_OPTIONS_FLAGS_USE_HUGE_PAGE : 0);
     134           8 :   mp->options[APP_OPTIONS_PROXY_TRANSPORT] =
     135          16 :     (u64) ((vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
     136           8 :            (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0));
     137           8 :   mp->options[APP_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
     138           8 :   mp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
     139           8 :   mp->options[APP_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
     140           8 :   mp->options[APP_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
     141           8 :   mp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
     142           8 :     vcm->cfg.preallocated_fifo_pairs;
     143           8 :   mp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = vcm->cfg.event_queue_size;
     144           8 :   mp->options[APP_OPTIONS_TLS_ENGINE] = tls_engine;
     145             : 
     146           8 :   msg.type = APP_SAPI_MSG_TYPE_ATTACH;
     147           8 :   err = clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
     148           8 :   if (err)
     149             :     {
     150           0 :       clib_error_report (err);
     151           0 :       return -1;
     152             :     }
     153             : 
     154           8 :   return 0;
     155             : }
     156             : 
     157             : int
     158           8 : vcl_sapi_attach (void)
     159             : {
     160           8 :   vcl_worker_t *wrk = vcl_worker_get_current ();
     161           8 :   app_sapi_msg_t _rmp, *rmp = &_rmp;
     162             :   clib_error_t *err;
     163             :   clib_socket_t *cs;
     164             :   int fds[32];
     165             : 
     166             :   /*
     167             :    * Init client socket and send attach
     168             :    */
     169           8 :   if (vcl_api_connect_app_socket (wrk))
     170           0 :     return -1;
     171             : 
     172           8 :   cs = &wrk->app_api_sock;
     173           8 :   if (vcl_api_send_attach (cs))
     174           0 :     return -1;
     175             : 
     176             :   /*
     177             :    * Wait for attach reply
     178             :    */
     179           8 :   err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), fds, ARRAY_LEN (fds));
     180           8 :   if (err)
     181             :     {
     182           0 :       clib_error_report (err);
     183           0 :       return -1;
     184             :     }
     185             : 
     186           8 :   if (rmp->type != APP_SAPI_MSG_TYPE_ATTACH_REPLY)
     187           0 :     return -1;
     188             : 
     189           8 :   return vcl_api_attach_reply_handler (&rmp->attach_reply, fds);
     190             : }
     191             : 
     192             : static int
     193           0 : vcl_api_add_del_worker_reply_handler (app_sapi_worker_add_del_reply_msg_t *
     194             :                                       mp, int *fds)
     195             : {
     196           0 :   int n_fds = 0, i, rv;
     197             :   u64 segment_handle;
     198             :   vcl_worker_t *wrk;
     199             : 
     200           0 :   if (mp->retval)
     201             :     {
     202           0 :       VDBG (0, "add/del worker failed: %U", format_session_error, mp->retval);
     203           0 :       goto failed;
     204             :     }
     205             : 
     206           0 :   if (!mp->is_add)
     207           0 :     goto failed;
     208             : 
     209           0 :   wrk = vcl_worker_get_current ();
     210           0 :   wrk->api_client_handle = mp->api_client_handle;
     211           0 :   wrk->vpp_wrk_index = mp->wrk_index;
     212           0 :   wrk->ctrl_mq = vcm->ctrl_mq;
     213             : 
     214           0 :   segment_handle = mp->segment_handle;
     215           0 :   if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
     216             :     {
     217           0 :       clib_warning ("invalid segment handle");
     218           0 :       goto failed;
     219             :     }
     220             : 
     221           0 :   if (!mp->n_fds)
     222           0 :     goto failed;
     223             : 
     224           0 :   if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
     225           0 :     if (vcl_segment_attach (vcl_vpp_worker_segment_handle (wrk->wrk_index),
     226             :                             "vpp-worker-seg", SSVM_SEGMENT_MEMFD,
     227           0 :                             fds[n_fds++]))
     228           0 :       goto failed;
     229             : 
     230           0 :   if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
     231             :     {
     232           0 :       u8 *segment_name = format (0, "memfd-%ld%c", segment_handle, 0);
     233           0 :       rv = vcl_segment_attach (segment_handle, (char *) segment_name,
     234           0 :                                SSVM_SEGMENT_MEMFD, fds[n_fds++]);
     235           0 :       vec_free (segment_name);
     236           0 :       if (rv != 0)
     237           0 :         goto failed;
     238             :     }
     239             : 
     240           0 :   vcl_segment_attach_mq (segment_handle, mp->app_event_queue_address, 0,
     241             :                          &wrk->app_event_queue);
     242             : 
     243           0 :   if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
     244             :     {
     245           0 :       svm_msg_q_set_eventfd (wrk->app_event_queue, fds[n_fds]);
     246           0 :       vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
     247           0 :       n_fds++;
     248             :     }
     249             : 
     250           0 :   VDBG (0, "worker %u vpp-worker %u added", wrk->wrk_index,
     251             :         wrk->vpp_wrk_index);
     252             : 
     253           0 :   return 0;
     254             : 
     255           0 : failed:
     256           0 :   for (i = clib_max (n_fds - 1, 0); i < mp->n_fds; i++)
     257           0 :     close (fds[i]);
     258             : 
     259           0 :   return -1;
     260             : }
     261             : 
     262             : int
     263           0 : vcl_sapi_app_worker_add (void)
     264             : {
     265           0 :   vcl_worker_t *wrk = vcl_worker_get_current ();
     266             :   app_sapi_worker_add_del_msg_t *mp;
     267           0 :   app_sapi_msg_t _rmp, *rmp = &_rmp;
     268           0 :   app_sapi_msg_t msg = { 0 };
     269             :   int fds[SESSION_N_FD_TYPE];
     270             :   clib_error_t *err;
     271             :   clib_socket_t *cs;
     272             : 
     273             :   /* Connect to socket api */
     274           0 :   if (vcl_api_connect_app_socket (wrk))
     275           0 :     return -1;
     276             : 
     277             :   /*
     278             :    * Send add worker
     279             :    */
     280           0 :   cs = &wrk->app_api_sock;
     281             : 
     282           0 :   msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_WORKER;
     283           0 :   mp = &msg.worker_add_del;
     284           0 :   mp->app_index = vcm->app_index;
     285           0 :   mp->is_add = 1;
     286             : 
     287           0 :   err = clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
     288           0 :   if (err)
     289             :     {
     290           0 :       clib_error_report (err);
     291           0 :       return -1;
     292             :     }
     293             : 
     294             :   /*
     295             :    * Wait for reply and process it
     296             :    */
     297           0 :   err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), fds, ARRAY_LEN (fds));
     298           0 :   if (err)
     299             :     {
     300           0 :       clib_error_report (err);
     301           0 :       return -1;
     302             :     }
     303             : 
     304           0 :   if (rmp->type != APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY)
     305             :     {
     306           0 :       clib_warning ("unexpected reply type %u", rmp->type);
     307           0 :       return -1;
     308             :     }
     309             : 
     310           0 :   return vcl_api_add_del_worker_reply_handler (&rmp->worker_add_del_reply,
     311             :                                                fds);
     312             : }
     313             : 
     314             : void
     315           2 : vcl_sapi_app_worker_del (vcl_worker_t * wrk)
     316             : {
     317             :   app_sapi_worker_add_del_msg_t *mp;
     318           2 :   app_sapi_msg_t msg = { 0 };
     319             :   clib_error_t *err;
     320             :   clib_socket_t *cs;
     321             : 
     322           2 :   cs = &wrk->app_api_sock;
     323             : 
     324           2 :   msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_WORKER;
     325           2 :   mp = &msg.worker_add_del;
     326           2 :   mp->app_index = vcm->app_index;
     327           2 :   mp->wrk_index = wrk->vpp_wrk_index;
     328           2 :   mp->is_add = 0;
     329             : 
     330           2 :   err = clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
     331           2 :   if (err)
     332           0 :     clib_error_report (err);
     333           2 :   clib_socket_close (cs);
     334           2 : }
     335             : 
     336             : void
     337           6 : vcl_sapi_detach (vcl_worker_t * wrk)
     338             : {
     339           6 :   clib_socket_t *cs = &wrk->app_api_sock;
     340           6 :   clib_socket_close (cs);
     341           6 : }
     342             : 
     343             : int
     344           7 : vcl_sapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds)
     345             : {
     346           7 :   app_sapi_msg_t _msg, *msg = &_msg;
     347             :   clib_socket_t *cs;
     348             :   clib_error_t *err;
     349             : 
     350           7 :   cs = &wrk->app_api_sock;
     351             : 
     352           7 :   err = clib_socket_recvmsg (cs, msg, sizeof (*msg), fds, n_fds);
     353           7 :   if (err)
     354             :     {
     355           0 :       clib_error_report (err);
     356           0 :       return -1;
     357             :     }
     358           7 :   if (msg->type != APP_SAPI_MSG_TYPE_SEND_FDS)
     359           0 :     return -1;
     360             : 
     361           7 :   return 0;
     362             : }
     363             : 
     364             : int
     365           4 : vcl_sapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
     366             : {
     367           4 :   u32 cert_len = ckpair->cert_len, key_len = ckpair->key_len, certkey_len;
     368           4 :   vcl_worker_t *wrk = vcl_worker_get_current ();
     369           4 :   app_sapi_msg_t _msg = { 0 }, *msg = &_msg;
     370             :   app_sapi_cert_key_add_del_msg_t *mp;
     371           4 :   app_sapi_msg_t _rmp, *rmp = &_rmp;
     372             :   clib_error_t *err;
     373             :   clib_socket_t *cs;
     374           4 :   u8 *certkey = 0;
     375           4 :   int rv = -1;
     376             : 
     377           4 :   msg->type = APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY;
     378           4 :   mp = &msg->cert_key_add_del;
     379           4 :   mp->context = wrk->wrk_index;
     380           4 :   mp->cert_len = cert_len;
     381           4 :   mp->certkey_len = cert_len + key_len;
     382           4 :   mp->is_add = 1;
     383             : 
     384           4 :   certkey_len = cert_len + key_len;
     385           4 :   vec_validate (certkey, certkey_len - 1);
     386           4 :   clib_memcpy_fast (certkey, ckpair->cert, cert_len);
     387           4 :   clib_memcpy_fast (certkey + cert_len, ckpair->key, key_len);
     388             : 
     389           4 :   cs = &wrk->app_api_sock;
     390           4 :   err = clib_socket_sendmsg (cs, msg, sizeof (*msg), 0, 0);
     391           4 :   if (err)
     392             :     {
     393           0 :       clib_error_report (err);
     394           0 :       goto done;
     395             :     }
     396             : 
     397           4 :   err = clib_socket_sendmsg (cs, certkey, certkey_len, 0, 0);
     398           4 :   if (err)
     399             :     {
     400           0 :       clib_error_report (err);
     401           0 :       goto done;
     402             :     }
     403             : 
     404             :   /*
     405             :    * Wait for reply and process it
     406             :    */
     407           4 :   err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), 0, 0);
     408           4 :   if (err)
     409             :     {
     410           0 :       clib_error_report (err);
     411           0 :       goto done;
     412             :     }
     413             : 
     414           4 :   if (rmp->type != APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY_REPLY)
     415             :     {
     416           0 :       clib_warning ("unexpected reply type %u", rmp->type);
     417           0 :       goto done;
     418             :     }
     419             : 
     420           4 :   if (!rmp->cert_key_add_del_reply.retval)
     421           4 :     rv = rmp->cert_key_add_del_reply.index;
     422             : 
     423           0 : done:
     424             : 
     425           4 :   return rv;
     426             : }
     427             : 
     428             : int
     429           0 : vcl_sapi_del_cert_key_pair (u32 ckpair_index)
     430             : {
     431           0 :   vcl_worker_t *wrk = vcl_worker_get_current ();
     432           0 :   app_sapi_msg_t _msg = { 0 }, *msg = &_msg;
     433             :   app_sapi_cert_key_add_del_msg_t *mp;
     434           0 :   app_sapi_msg_t _rmp, *rmp = &_rmp;
     435             :   clib_error_t *err;
     436             :   clib_socket_t *cs;
     437             : 
     438           0 :   msg->type = APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY;
     439           0 :   mp = &msg->cert_key_add_del;
     440           0 :   mp->context = wrk->wrk_index;
     441           0 :   mp->index = ckpair_index;
     442             : 
     443           0 :   cs = &wrk->app_api_sock;
     444           0 :   err = clib_socket_sendmsg (cs, msg, sizeof (*msg), 0, 0);
     445           0 :   if (err)
     446             :     {
     447           0 :       clib_error_report (err);
     448           0 :       return -1;
     449             :     }
     450             : 
     451             :   /*
     452             :    * Wait for reply and process it
     453             :    */
     454           0 :   err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), 0, 0);
     455           0 :   if (err)
     456             :     {
     457           0 :       clib_error_report (err);
     458           0 :       return -1;
     459             :     }
     460             : 
     461           0 :   if (rmp->type != APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY_REPLY)
     462             :     {
     463           0 :       clib_warning ("unexpected reply type %u", rmp->type);
     464           0 :       return -1;
     465             :     }
     466             : 
     467           0 :   if (rmp->cert_key_add_del_reply.retval)
     468           0 :     return -1;
     469             : 
     470           0 :   return 0;
     471             : }
     472             : 
     473             : /*
     474             :  * fd.io coding-style-patch-verification: ON
     475             :  *
     476             :  * Local Variables:
     477             :  * eval: (c-set-style "gnu")
     478             :  * End:
     479             :  */

Generated by: LCOV version 1.14