blob: fcd31992fa59f21677e116803f4580e12e0ecf28 [file] [log] [blame]
Dave Barach59b25652017-09-10 15:04:27 -04001/*
2 *------------------------------------------------------------------
3 * socket_client.c - API message handling over sockets, client code.
4 *
5 * Copyright (c) 2017 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
18 */
19
20#include <stdio.h>
Florin Coras90a63982017-12-19 04:50:01 -080021#define __USE_GNU
22#include <sys/socket.h>
Dave Barach59b25652017-09-10 15:04:27 -040023
Florin Coras4d9b9d82018-01-14 12:25:50 -080024#include <svm/ssvm.h>
Florin Corase86a8ed2018-01-05 03:20:25 -080025#include <vlibmemory/socket_client.h>
26#include <vlibmemory/memory_client.h>
Dave Barach59b25652017-09-10 15:04:27 -040027
28#include <vlibmemory/vl_memory_msg_enum.h>
29
30#define vl_typedefs /* define message structures */
31#include <vlibmemory/vl_memory_api_h.h>
32#undef vl_typedefs
33
34#define vl_endianfun /* define message structures */
35#include <vlibmemory/vl_memory_api_h.h>
36#undef vl_endianfun
37
38/* instantiate all the print functions we know about */
39#define vl_print(handle, ...) clib_warning (__VA_ARGS__)
40#define vl_printfun
41#include <vlibmemory/vl_memory_api_h.h>
42#undef vl_printfun
43
44socket_client_main_t socket_client_main;
45
46/* Debug aid */
47u32 vl (void *p) __attribute__ ((weak));
Florin Coras90a63982017-12-19 04:50:01 -080048
Dave Barach59b25652017-09-10 15:04:27 -040049u32
50vl (void *p)
51{
52 return vec_len (p);
53}
54
Florin Coras90a63982017-12-19 04:50:01 -080055int
56vl_socket_client_read (int wait)
Dave Barach59b25652017-09-10 15:04:27 -040057{
Florin Coras90a63982017-12-19 04:50:01 -080058 socket_client_main_t *scm = &socket_client_main;
Florin Coras2881dec2018-10-02 18:29:25 -070059 u32 data_len = 0, msg_size;
Dave Barach59b25652017-09-10 15:04:27 -040060 int n, current_rx_index;
Florin Coras90a63982017-12-19 04:50:01 -080061 msgbuf_t *mbp = 0;
62 f64 timeout;
Dave Barach59b25652017-09-10 15:04:27 -040063
Florin Coras90a63982017-12-19 04:50:01 -080064 if (scm->socket_fd == 0)
65 return -1;
Dave Barach59b25652017-09-10 15:04:27 -040066
Florin Coras90a63982017-12-19 04:50:01 -080067 if (wait)
68 timeout = clib_time_now (&scm->clib_time) + wait;
Dave Barach59b25652017-09-10 15:04:27 -040069
70 while (1)
71 {
Florin Coras2881dec2018-10-02 18:29:25 -070072 while (vec_len (scm->socket_rx_buffer) < sizeof (*mbp))
Dave Barach59b25652017-09-10 15:04:27 -040073 {
Florin Coras2881dec2018-10-02 18:29:25 -070074 current_rx_index = vec_len (scm->socket_rx_buffer);
Dave Barach59b25652017-09-10 15:04:27 -040075 vec_validate (scm->socket_rx_buffer, current_rx_index
76 + scm->socket_buffer_size - 1);
77 _vec_len (scm->socket_rx_buffer) = current_rx_index;
78 n = read (scm->socket_fd, scm->socket_rx_buffer + current_rx_index,
79 scm->socket_buffer_size);
80 if (n < 0)
81 {
Florin Coras66a10032018-12-21 16:23:09 -080082 if (errno == EAGAIN)
83 continue;
84
Dave Barach59b25652017-09-10 15:04:27 -040085 clib_unix_warning ("socket_read");
Florin Coras90a63982017-12-19 04:50:01 -080086 return -1;
Dave Barach59b25652017-09-10 15:04:27 -040087 }
88 _vec_len (scm->socket_rx_buffer) += n;
89 }
90
91#if CLIB_DEBUG > 1
92 if (n > 0)
93 clib_warning ("read %d bytes", n);
94#endif
95
Florin Coras2881dec2018-10-02 18:29:25 -070096 mbp = (msgbuf_t *) (scm->socket_rx_buffer);
97 data_len = ntohl (mbp->data_len);
98 current_rx_index = vec_len (scm->socket_rx_buffer);
99 vec_validate (scm->socket_rx_buffer, current_rx_index + data_len);
100 _vec_len (scm->socket_rx_buffer) = current_rx_index;
101 mbp = (msgbuf_t *) (scm->socket_rx_buffer);
102 msg_size = data_len + sizeof (*mbp);
Dave Barach59b25652017-09-10 15:04:27 -0400103
Florin Coras2881dec2018-10-02 18:29:25 -0700104 while (vec_len (scm->socket_rx_buffer) < msg_size)
105 {
106 n = read (scm->socket_fd,
107 scm->socket_rx_buffer + vec_len (scm->socket_rx_buffer),
108 msg_size - vec_len (scm->socket_rx_buffer));
Florin Coras66a10032018-12-21 16:23:09 -0800109 if (n < 0)
Florin Coras2881dec2018-10-02 18:29:25 -0700110 {
Florin Coras66a10032018-12-21 16:23:09 -0800111 if (errno == EAGAIN)
112 continue;
113
Florin Coras2881dec2018-10-02 18:29:25 -0700114 clib_unix_warning ("socket_read");
115 return -1;
116 }
117 _vec_len (scm->socket_rx_buffer) += n;
118 }
119
120 if (vec_len (scm->socket_rx_buffer) >= data_len + sizeof (*mbp))
Dave Barach59b25652017-09-10 15:04:27 -0400121 {
122 vl_msg_api_socket_handler ((void *) (mbp->data));
123
Florin Coras2881dec2018-10-02 18:29:25 -0700124 if (vec_len (scm->socket_rx_buffer) == data_len + sizeof (*mbp))
Dave Barach59b25652017-09-10 15:04:27 -0400125 _vec_len (scm->socket_rx_buffer) = 0;
126 else
Florin Coras2881dec2018-10-02 18:29:25 -0700127 vec_delete (scm->socket_rx_buffer, data_len + sizeof (*mbp), 0);
Dave Barach59b25652017-09-10 15:04:27 -0400128 mbp = 0;
129
130 /* Quit if we're out of data, and not expecting a ping reply */
131 if (vec_len (scm->socket_rx_buffer) == 0
132 && scm->control_pings_outstanding == 0)
133 break;
134 }
Florin Coras90a63982017-12-19 04:50:01 -0800135 if (wait && clib_time_now (&scm->clib_time) >= timeout)
136 return -1;
Dave Barach59b25652017-09-10 15:04:27 -0400137 }
Florin Coras90a63982017-12-19 04:50:01 -0800138 return 0;
Dave Barach59b25652017-09-10 15:04:27 -0400139}
140
141int
Florin Coras90a63982017-12-19 04:50:01 -0800142vl_socket_client_write (void)
Dave Barach59b25652017-09-10 15:04:27 -0400143{
Florin Coras90a63982017-12-19 04:50:01 -0800144 socket_client_main_t *scm = &socket_client_main;
145 int n;
146
147 msgbuf_t msgbuf = {
148 .q = 0,
149 .gc_mark_timestamp = 0,
150 .data_len = htonl (scm->socket_tx_nbytes),
151 };
152
153 n = write (scm->socket_fd, &msgbuf, sizeof (msgbuf));
154 if (n < sizeof (msgbuf))
155 {
156 clib_unix_warning ("socket write (msgbuf)");
157 return -1;
158 }
159
160 n = write (scm->socket_fd, scm->socket_tx_buffer, scm->socket_tx_nbytes);
161 if (n < scm->socket_tx_nbytes)
162 {
163 clib_unix_warning ("socket write (msg)");
164 return -1;
165 }
166
167 return n;
168}
169
170void *
171vl_socket_client_msg_alloc (int nbytes)
172{
173 socket_client_main.socket_tx_nbytes = nbytes;
174 return ((void *) socket_client_main.socket_tx_buffer);
175}
176
177void
178vl_socket_client_disconnect (void)
179{
180 socket_client_main_t *scm = &socket_client_main;
Florin Corasb384b542018-01-15 01:08:33 -0800181
182 if (vl_mem_client_is_connected ())
183 {
184 vl_client_disconnect_from_vlib_no_unmap ();
185 ssvm_delete_memfd (&scm->memfd_segment);
186 }
Florin Coras90a63982017-12-19 04:50:01 -0800187 if (scm->socket_fd && (close (scm->socket_fd) < 0))
188 clib_unix_warning ("close");
189 scm->socket_fd = 0;
190}
191
192void
193vl_socket_client_enable_disable (int enable)
194{
195 socket_client_main_t *scm = &socket_client_main;
196 scm->socket_enable = enable;
197}
198
Florin Corasb384b542018-01-15 01:08:33 -0800199clib_error_t *
Florin Coras466f2892018-08-03 02:50:43 -0700200vl_sock_api_recv_fd_msg (int socket_fd, int fds[], int n_fds, u32 wait)
Florin Coras90a63982017-12-19 04:50:01 -0800201{
Florin Corasb384b542018-01-15 01:08:33 -0800202 socket_client_main_t *scm = &socket_client_main;
Florin Coras90a63982017-12-19 04:50:01 -0800203 char msgbuf[16];
Florin Coras466f2892018-08-03 02:50:43 -0700204 char ctl[CMSG_SPACE (sizeof (int) * n_fds)
205 + CMSG_SPACE (sizeof (struct ucred))];
Florin Coras90a63982017-12-19 04:50:01 -0800206 struct msghdr mh = { 0 };
207 struct iovec iov[1];
Florin Corasb384b542018-01-15 01:08:33 -0800208 ssize_t size = 0;
Florin Coras90a63982017-12-19 04:50:01 -0800209 struct ucred *cr = 0;
210 struct cmsghdr *cmsg;
211 pid_t pid __attribute__ ((unused));
212 uid_t uid __attribute__ ((unused));
213 gid_t gid __attribute__ ((unused));
Florin Corasb384b542018-01-15 01:08:33 -0800214 f64 timeout;
Florin Coras90a63982017-12-19 04:50:01 -0800215
216 iov[0].iov_base = msgbuf;
217 iov[0].iov_len = 5;
218 mh.msg_iov = iov;
219 mh.msg_iovlen = 1;
220 mh.msg_control = ctl;
221 mh.msg_controllen = sizeof (ctl);
222
Dave Barachb7b92992018-10-17 10:38:51 -0400223 clib_memset (ctl, 0, sizeof (ctl));
Florin Coras90a63982017-12-19 04:50:01 -0800224
Florin Corasb384b542018-01-15 01:08:33 -0800225 if (wait != ~0)
226 {
227 timeout = clib_time_now (&scm->clib_time) + wait;
228 while (size != 5 && clib_time_now (&scm->clib_time) < timeout)
229 size = recvmsg (socket_fd, &mh, MSG_DONTWAIT);
230 }
231 else
232 size = recvmsg (socket_fd, &mh, 0);
233
Florin Coras90a63982017-12-19 04:50:01 -0800234 if (size != 5)
235 {
236 return (size == 0) ? clib_error_return (0, "disconnected") :
237 clib_error_return_unix (0, "recvmsg: malformed message (fd %d)",
238 socket_fd);
239 }
240
241 cmsg = CMSG_FIRSTHDR (&mh);
242 while (cmsg)
243 {
244 if (cmsg->cmsg_level == SOL_SOCKET)
245 {
246 if (cmsg->cmsg_type == SCM_CREDENTIALS)
247 {
248 cr = (struct ucred *) CMSG_DATA (cmsg);
249 uid = cr->uid;
250 gid = cr->gid;
251 pid = cr->pid;
252 }
253 else if (cmsg->cmsg_type == SCM_RIGHTS)
254 {
Dave Barach178cf492018-11-13 16:34:13 -0500255 clib_memcpy_fast (fds, CMSG_DATA (cmsg), sizeof (int) * n_fds);
Florin Coras90a63982017-12-19 04:50:01 -0800256 }
257 }
258 cmsg = CMSG_NXTHDR (&mh, cmsg);
259 }
260 return 0;
261}
262
263static void vl_api_sock_init_shm_reply_t_handler
264 (vl_api_sock_init_shm_reply_t * mp)
265{
266 socket_client_main_t *scm = &socket_client_main;
Florin Corasb384b542018-01-15 01:08:33 -0800267 ssvm_private_t *memfd = &scm->memfd_segment;
Florin Coras90a63982017-12-19 04:50:01 -0800268 i32 retval = ntohl (mp->retval);
Florin Coras90a63982017-12-19 04:50:01 -0800269 api_main_t *am = &api_main;
Florin Corasb384b542018-01-15 01:08:33 -0800270 clib_error_t *error;
271 int my_fd = -1;
Florin Coras90a63982017-12-19 04:50:01 -0800272 u8 *new_name;
273
274 if (retval)
275 {
276 clib_warning ("failed to init shmem");
277 return;
278 }
279
280 /*
281 * Check the socket for the magic fd
282 */
Florin Coras466f2892018-08-03 02:50:43 -0700283 error = vl_sock_api_recv_fd_msg (scm->socket_fd, &my_fd, 1, 5);
Florin Coras90a63982017-12-19 04:50:01 -0800284 if (error)
285 {
Florin Corasb384b542018-01-15 01:08:33 -0800286 clib_error_report (error);
Florin Coras90a63982017-12-19 04:50:01 -0800287 retval = -99;
288 return;
289 }
290
Dave Barachb7b92992018-10-17 10:38:51 -0400291 clib_memset (memfd, 0, sizeof (*memfd));
Florin Corasb384b542018-01-15 01:08:33 -0800292 memfd->fd = my_fd;
Florin Coras90a63982017-12-19 04:50:01 -0800293
294 /* Note: this closes memfd.fd */
Florin Corasb384b542018-01-15 01:08:33 -0800295 retval = ssvm_slave_init_memfd (memfd);
Florin Coras90a63982017-12-19 04:50:01 -0800296 if (retval)
297 clib_warning ("WARNING: segment map returned %d", retval);
298
299 /*
300 * Pivot to the memory client segment that vpp just created
301 */
Florin Corasb384b542018-01-15 01:08:33 -0800302 am->vlib_rp = (void *) (memfd->requested_va + MMAP_PAGESIZE);
Florin Coras90a63982017-12-19 04:50:01 -0800303 am->shmem_hdr = (void *) am->vlib_rp->user_ctx;
304
305 new_name = format (0, "%v[shm]%c", scm->name, 0);
306 vl_client_install_client_message_handlers ();
Tomasz Kulasek97dcf5b2019-01-31 18:26:32 +0100307 if (scm->want_shm_pthread)
308 {
309 vl_client_connect_to_vlib_no_map ("pvt", (char *) new_name,
310 32 /* input_queue_length */ );
311 }
312 else
313 {
314 vl_client_connect_to_vlib_no_rx_pthread_no_map ("pvt",
315 (char *) new_name, 32
316 /* input_queue_length */
317 );
318 }
Florin Coras90a63982017-12-19 04:50:01 -0800319 vl_socket_client_enable_disable (0);
320 vec_free (new_name);
321}
322
323static void
324vl_api_sockclnt_create_reply_t_handler (vl_api_sockclnt_create_reply_t * mp)
325{
326 socket_client_main_t *scm = &socket_client_main;
327 if (!mp->response)
Florin Coras2881dec2018-10-02 18:29:25 -0700328 {
329 scm->socket_enable = 1;
330 scm->client_index = clib_net_to_host_u32 (mp->index);
331 }
Florin Coras90a63982017-12-19 04:50:01 -0800332}
333
334#define foreach_sock_client_api_msg \
335_(SOCKCLNT_CREATE_REPLY, sockclnt_create_reply) \
336_(SOCK_INIT_SHM_REPLY, sock_init_shm_reply) \
337
338static void
339noop_handler (void *notused)
340{
341}
342
343void
344vl_sock_client_install_message_handlers (void)
345{
346
347#define _(N,n) \
348 vl_msg_api_set_handlers(VL_API_##N, #n, \
349 vl_api_##n##_t_handler, \
350 noop_handler, \
351 vl_api_##n##_t_endian, \
352 vl_api_##n##_t_print, \
353 sizeof(vl_api_##n##_t), 1);
354 foreach_sock_client_api_msg;
355#undef _
356}
357
358int
359vl_socket_client_connect (char *socket_path, char *client_name,
360 u32 socket_buffer_size)
361{
362 socket_client_main_t *scm = &socket_client_main;
Dave Barach59b25652017-09-10 15:04:27 -0400363 vl_api_sockclnt_create_t *mp;
Florin Coras90a63982017-12-19 04:50:01 -0800364 clib_socket_t *sock;
Dave Barach59b25652017-09-10 15:04:27 -0400365 clib_error_t *error;
366
367 /* Already connected? */
368 if (scm->socket_fd)
369 return (-2);
370
371 /* bogus call? */
372 if (socket_path == 0 || client_name == 0)
373 return (-3);
374
Florin Coras90a63982017-12-19 04:50:01 -0800375 sock = &scm->client_socket;
Dave Barach59b25652017-09-10 15:04:27 -0400376 sock->config = socket_path;
Ole Troan4ff09ae2019-04-15 11:27:22 +0200377 sock->flags = CLIB_SOCKET_F_IS_CLIENT | CLIB_SOCKET_F_NON_BLOCKING_CONNECT;
Dave Barach59b25652017-09-10 15:04:27 -0400378
Florin Coras90a63982017-12-19 04:50:01 -0800379 if ((error = clib_socket_init (sock)))
Dave Barach59b25652017-09-10 15:04:27 -0400380 {
381 clib_error_report (error);
382 return (-1);
383 }
384
Florin Coras90a63982017-12-19 04:50:01 -0800385 vl_sock_client_install_message_handlers ();
386
Dave Barach59b25652017-09-10 15:04:27 -0400387 scm->socket_fd = sock->fd;
Dave Barach59b25652017-09-10 15:04:27 -0400388 scm->socket_buffer_size = socket_buffer_size ? socket_buffer_size :
389 SOCKET_CLIENT_DEFAULT_BUFFER_SIZE;
390 vec_validate (scm->socket_tx_buffer, scm->socket_buffer_size - 1);
391 vec_validate (scm->socket_rx_buffer, scm->socket_buffer_size - 1);
392 _vec_len (scm->socket_rx_buffer) = 0;
Florin Coras90a63982017-12-19 04:50:01 -0800393 _vec_len (scm->socket_tx_buffer) = 0;
394 scm->name = format (0, "%s", client_name);
Dave Barach59b25652017-09-10 15:04:27 -0400395
Florin Coras90a63982017-12-19 04:50:01 -0800396 mp = vl_socket_client_msg_alloc (sizeof (*mp));
397 mp->_vl_msg_id = htons (VL_API_SOCKCLNT_CREATE);
Ole Troan2959d422019-08-22 09:02:59 +0200398
399 vl_api_to_api_string (strnlen_s (client_name, 64), client_name, &mp->name);
Florin Coras90a63982017-12-19 04:50:01 -0800400 mp->context = 0xfeedface;
401
Florin Coras2881dec2018-10-02 18:29:25 -0700402 clib_time_init (&scm->clib_time);
403
Florin Coras90a63982017-12-19 04:50:01 -0800404 if (vl_socket_client_write () <= 0)
405 return (-1);
406
Florin Coras2881dec2018-10-02 18:29:25 -0700407 if (vl_socket_client_read (5))
Florin Coras90a63982017-12-19 04:50:01 -0800408 return (-1);
409
Dave Barach59b25652017-09-10 15:04:27 -0400410 return (0);
411}
412
Florin Coras90a63982017-12-19 04:50:01 -0800413int
Tomasz Kulasek97dcf5b2019-01-31 18:26:32 +0100414vl_socket_client_init_shm (vl_api_shm_elem_config_t * config,
415 int want_pthread)
Dave Barach59b25652017-09-10 15:04:27 -0400416{
Florin Coras2881dec2018-10-02 18:29:25 -0700417 socket_client_main_t *scm = &socket_client_main;
Florin Coras90a63982017-12-19 04:50:01 -0800418 vl_api_sock_init_shm_t *mp;
419 int rv, i;
420 u64 *cfg;
Dave Barach59b25652017-09-10 15:04:27 -0400421
Tomasz Kulasek97dcf5b2019-01-31 18:26:32 +0100422 scm->want_shm_pthread = want_pthread;
423
Florin Coras90a63982017-12-19 04:50:01 -0800424 mp = vl_socket_client_msg_alloc (sizeof (*mp) +
425 vec_len (config) * sizeof (u64));
Dave Barachb7b92992018-10-17 10:38:51 -0400426 clib_memset (mp, 0, sizeof (*mp));
Florin Coras90a63982017-12-19 04:50:01 -0800427 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_SOCK_INIT_SHM);
Florin Coras2881dec2018-10-02 18:29:25 -0700428 mp->client_index = clib_host_to_net_u32 (scm->client_index);
Florin Coras90a63982017-12-19 04:50:01 -0800429 mp->requested_size = 64 << 20;
430
431 if (config)
432 {
433 for (i = 0; i < vec_len (config); i++)
434 {
435 cfg = (u64 *) & config[i];
436 mp->configs[i] = *cfg;
437 }
438 mp->nitems = vec_len (config);
439 }
440 rv = vl_socket_client_write ();
441 if (rv <= 0)
442 return rv;
443
444 if (vl_socket_client_read (1))
445 return -1;
446
447 return 0;
Dave Barach59b25652017-09-10 15:04:27 -0400448}
449
Florin Corasb384b542018-01-15 01:08:33 -0800450clib_error_t *
Florin Coras466f2892018-08-03 02:50:43 -0700451vl_socket_client_recv_fd_msg (int fds[], int n_fds, u32 wait)
Florin Corasb384b542018-01-15 01:08:33 -0800452{
453 socket_client_main_t *scm = &socket_client_main;
454 if (!scm->socket_fd)
455 return clib_error_return (0, "no socket");
Florin Coras466f2892018-08-03 02:50:43 -0700456 return vl_sock_api_recv_fd_msg (scm->client_socket.fd, fds, n_fds, wait);
Florin Corasb384b542018-01-15 01:08:33 -0800457}
458
Dave Barach59b25652017-09-10 15:04:27 -0400459/*
460 * fd.io coding-style-patch-verification: ON
461 *
462 * Local Variables:
463 * eval: (c-set-style "gnu")
464 * End:
465 */