2 *------------------------------------------------------------------
3 * socket_client.c - API message handling over sockets, client code.
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:
10 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
23 #include <sys/socket.h>
26 #include <vlibmemory/socket_client.h>
27 #include <vlibmemory/memory_client.h>
29 #include <vlibmemory/vl_memory_msg_enum.h>
31 #define vl_typedefs /* define message structures */
32 #include <vlibmemory/vl_memory_api_h.h>
35 #define vl_endianfun /* define message structures */
36 #include <vlibmemory/vl_memory_api_h.h>
39 #define vl_calcsizefun
40 #include <vlibmemory/vl_memory_api_h.h>
43 /* instantiate all the print functions we know about */
45 #include <vlibmemory/vl_memory_api_h.h>
48 socket_client_main_t socket_client_main;
49 __thread socket_client_main_t *socket_client_ctx = &socket_client_main;
52 u32 vl (void *p) __attribute__ ((weak));
60 static socket_client_main_t *
61 vl_socket_client_ctx_push (socket_client_main_t * ctx)
63 socket_client_main_t *old = socket_client_ctx;
64 socket_client_ctx = ctx;
69 vl_socket_client_ctx_pop (socket_client_main_t * old_ctx)
71 socket_client_ctx = old_ctx;
75 vl_socket_client_read_internal (socket_client_main_t * scm, int wait)
77 u32 data_len = 0, msg_size;
78 int n, current_rx_index;
82 if (scm->socket_fd == 0)
86 timeout = clib_time_now (&scm->clib_time) + wait;
90 while (vec_len (scm->socket_rx_buffer) < sizeof (*mbp))
92 current_rx_index = vec_len (scm->socket_rx_buffer);
93 vec_validate (scm->socket_rx_buffer, current_rx_index
94 + scm->socket_buffer_size - 1);
95 vec_set_len (scm->socket_rx_buffer, current_rx_index);
96 n = read (scm->socket_fd, scm->socket_rx_buffer + current_rx_index,
97 scm->socket_buffer_size);
103 clib_unix_warning ("socket_read");
106 vec_inc_len (scm->socket_rx_buffer, n);
111 clib_warning ("read %d bytes", n);
114 mbp = (msgbuf_t *) (scm->socket_rx_buffer);
115 data_len = ntohl (mbp->data_len);
116 current_rx_index = vec_len (scm->socket_rx_buffer);
117 vec_validate (scm->socket_rx_buffer, current_rx_index + data_len);
118 vec_set_len (scm->socket_rx_buffer, current_rx_index);
119 mbp = (msgbuf_t *) (scm->socket_rx_buffer);
120 msg_size = data_len + sizeof (*mbp);
122 while (vec_len (scm->socket_rx_buffer) < msg_size)
124 n = read (scm->socket_fd,
125 scm->socket_rx_buffer + vec_len (scm->socket_rx_buffer),
126 msg_size - vec_len (scm->socket_rx_buffer));
132 clib_unix_warning ("socket_read");
135 vec_inc_len (scm->socket_rx_buffer, n);
138 if (vec_len (scm->socket_rx_buffer) >= data_len + sizeof (*mbp))
140 vl_msg_api_socket_handler ((void *) (mbp->data), data_len);
142 if (vec_len (scm->socket_rx_buffer) == data_len + sizeof (*mbp))
143 vec_set_len (scm->socket_rx_buffer, 0);
145 vec_delete (scm->socket_rx_buffer, data_len + sizeof (*mbp), 0);
148 /* Quit if we're out of data, and not expecting a ping reply */
149 if (vec_len (scm->socket_rx_buffer) == 0
150 && scm->control_pings_outstanding == 0)
153 if (wait && clib_time_now (&scm->clib_time) >= timeout)
160 vl_socket_client_read (int wait)
162 return vl_socket_client_read_internal (socket_client_ctx, wait);
166 vl_socket_client_read2 (socket_client_main_t * scm, int wait)
168 socket_client_main_t *old_ctx;
171 old_ctx = vl_socket_client_ctx_push (scm);
172 rv = vl_socket_client_read_internal (scm, wait);
173 vl_socket_client_ctx_pop (old_ctx);
178 vl_socket_client_write_internal (socket_client_main_t * scm)
184 .gc_mark_timestamp = 0,
185 .data_len = htonl (scm->socket_tx_nbytes),
188 n = write (scm->socket_fd, &msgbuf, sizeof (msgbuf));
189 if (n < sizeof (msgbuf))
191 clib_unix_warning ("socket write (msgbuf)");
195 n = write (scm->socket_fd, scm->socket_tx_buffer, scm->socket_tx_nbytes);
196 if (n < scm->socket_tx_nbytes)
198 clib_unix_warning ("socket write (msg)");
206 vl_socket_client_write (void)
208 return vl_socket_client_write_internal (socket_client_ctx);
212 vl_socket_client_write2 (socket_client_main_t * scm)
214 socket_client_main_t *old_ctx;
217 old_ctx = vl_socket_client_ctx_push (scm);
218 rv = vl_socket_client_write_internal (scm);
219 vl_socket_client_ctx_pop (old_ctx);
224 vl_socket_client_msg_alloc2 (socket_client_main_t * scm, int nbytes)
226 scm->socket_tx_nbytes = nbytes;
227 return ((void *) scm->socket_tx_buffer);
231 vl_socket_client_msg_alloc (int nbytes)
233 return vl_socket_client_msg_alloc2 (socket_client_ctx, nbytes);
237 vl_socket_client_disconnect2 (socket_client_main_t * scm)
239 if (vl_mem_client_is_connected ())
241 vl_client_disconnect_from_vlib_no_unmap ();
242 ssvm_delete_memfd (&scm->memfd_segment);
244 if (scm->socket_fd && (close (scm->socket_fd) < 0))
245 clib_unix_warning ("close");
250 vl_socket_client_disconnect (void)
252 vl_socket_client_disconnect2 (socket_client_ctx);
256 vl_socket_client_enable_disable2 (socket_client_main_t * scm, int enable)
258 scm->socket_enable = enable;
262 vl_socket_client_enable_disable (int enable)
264 vl_socket_client_enable_disable2 (socket_client_ctx, enable);
267 static clib_error_t *
268 vl_sock_api_recv_fd_msg_internal (socket_client_main_t * scm, int fds[],
272 char ctl[CMSG_SPACE (sizeof (int) * n_fds)
273 + CMSG_SPACE (sizeof (struct ucred))];
274 struct msghdr mh = { 0 };
277 struct ucred *cr = 0;
278 struct cmsghdr *cmsg;
279 pid_t pid __attribute__ ((unused));
280 uid_t uid __attribute__ ((unused));
281 gid_t gid __attribute__ ((unused));
285 socket_fd = scm->client_socket.fd;
287 iov[0].iov_base = msgbuf;
291 mh.msg_control = ctl;
292 mh.msg_controllen = sizeof (ctl);
294 clib_memset (ctl, 0, sizeof (ctl));
298 timeout = clib_time_now (&scm->clib_time) + wait;
299 while (size != 5 && clib_time_now (&scm->clib_time) < timeout)
300 size = recvmsg (socket_fd, &mh, MSG_DONTWAIT);
303 size = recvmsg (socket_fd, &mh, 0);
307 return (size == 0) ? clib_error_return (0, "disconnected") :
308 clib_error_return_unix (0, "recvmsg: malformed message (fd %d)",
312 cmsg = CMSG_FIRSTHDR (&mh);
315 if (cmsg->cmsg_level == SOL_SOCKET)
317 if (cmsg->cmsg_type == SCM_CREDENTIALS)
319 cr = (struct ucred *) CMSG_DATA (cmsg);
324 else if (cmsg->cmsg_type == SCM_RIGHTS)
326 clib_memcpy_fast (fds, CMSG_DATA (cmsg), sizeof (int) * n_fds);
329 cmsg = CMSG_NXTHDR (&mh, cmsg);
335 vl_sock_api_recv_fd_msg (int socket_fd, int fds[], int n_fds, u32 wait)
337 return vl_sock_api_recv_fd_msg_internal (socket_client_ctx, fds, n_fds,
342 vl_sock_api_recv_fd_msg2 (socket_client_main_t * scm, int socket_fd,
343 int fds[], int n_fds, u32 wait)
345 socket_client_main_t *old_ctx;
348 old_ctx = vl_socket_client_ctx_push (scm);
349 error = vl_sock_api_recv_fd_msg_internal (scm, fds, n_fds, wait);
350 vl_socket_client_ctx_pop (old_ctx);
354 static void vl_api_sock_init_shm_reply_t_handler
355 (vl_api_sock_init_shm_reply_t * mp)
357 socket_client_main_t *scm = socket_client_ctx;
358 ssvm_private_t *memfd = &scm->memfd_segment;
359 i32 retval = ntohl (mp->retval);
360 api_main_t *am = vlibapi_get_main ();
367 clib_warning ("failed to init shmem");
372 * Check the socket for the magic fd
374 error = vl_sock_api_recv_fd_msg (scm->socket_fd, &my_fd, 1, 5);
377 clib_error_report (error);
382 clib_memset (memfd, 0, sizeof (*memfd));
385 /* Note: this closes memfd.fd */
386 retval = ssvm_client_init_memfd (memfd);
388 clib_warning ("WARNING: segment map returned %d", retval);
391 * Pivot to the memory client segment that vpp just created
393 am->vlib_rp = (void *) (memfd->requested_va + MMAP_PAGESIZE);
394 am->shmem_hdr = (void *) am->vlib_rp->user_ctx;
396 new_name = format (0, "%v[shm]%c", scm->name, 0);
397 vl_client_install_client_message_handlers ();
398 if (scm->want_shm_pthread)
400 vl_client_connect_to_vlib_no_map ("pvt", (char *) new_name,
401 32 /* input_queue_length */ );
405 vl_client_connect_to_vlib_no_rx_pthread_no_map ("pvt",
406 (char *) new_name, 32
407 /* input_queue_length */
410 vl_socket_client_enable_disable (0);
415 vl_api_sockclnt_create_reply_t_handler (vl_api_sockclnt_create_reply_t * mp)
417 socket_client_main_t *scm = socket_client_ctx;
420 scm->socket_enable = 1;
421 scm->client_index = clib_net_to_host_u32 (mp->index);
425 #define foreach_sock_client_api_msg \
426 _(SOCKCLNT_CREATE_REPLY, sockclnt_create_reply) \
427 _(SOCK_INIT_SHM_REPLY, sock_init_shm_reply) \
430 vl_sock_client_install_message_handlers (void)
434 vl_msg_api_set_handlers ( \
435 VL_API_##N, #n, vl_api_##n##_t_handler, vl_api_##n##_t_endian, \
436 vl_api_##n##_t_format, sizeof (vl_api_##n##_t), 0, vl_api_##n##_t_tojson, \
437 vl_api_##n##_t_fromjson, vl_api_##n##_t_calc_size);
438 foreach_sock_client_api_msg;
443 vl_socket_client_connect_internal (socket_client_main_t * scm,
444 char *socket_path, char *client_name,
445 u32 socket_buffer_size)
447 vl_api_sockclnt_create_t *mp;
451 /* Already connected? */
456 if (socket_path == 0 || client_name == 0)
459 sock = &scm->client_socket;
460 sock->config = socket_path;
461 sock->flags = CLIB_SOCKET_F_IS_CLIENT;
463 if ((error = clib_socket_init (sock)))
465 clib_error_report (error);
469 vl_sock_client_install_message_handlers ();
471 scm->socket_fd = sock->fd;
472 scm->socket_buffer_size = socket_buffer_size ? socket_buffer_size :
473 SOCKET_CLIENT_DEFAULT_BUFFER_SIZE;
474 vec_validate (scm->socket_tx_buffer, scm->socket_buffer_size - 1);
475 vec_validate (scm->socket_rx_buffer, scm->socket_buffer_size - 1);
476 vec_set_len (scm->socket_rx_buffer, 0);
477 vec_set_len (scm->socket_tx_buffer, 0);
478 scm->name = format (0, "%s", client_name);
480 mp = vl_socket_client_msg_alloc2 (scm, sizeof (*mp));
481 mp->_vl_msg_id = htons (VL_API_SOCKCLNT_CREATE);
482 strncpy ((char *) mp->name, client_name, sizeof (mp->name) - 1);
483 mp->name[sizeof (mp->name) - 1] = 0;
484 mp->context = 0xfeedface;
486 clib_time_init (&scm->clib_time);
488 if (vl_socket_client_write_internal (scm) <= 0)
491 if (vl_socket_client_read_internal (scm, 5))
498 vl_socket_client_connect (char *socket_path, char *client_name,
499 u32 socket_buffer_size)
501 return vl_socket_client_connect_internal (socket_client_ctx, socket_path,
502 client_name, socket_buffer_size);
506 vl_socket_client_connect2 (socket_client_main_t * scm, char *socket_path,
507 char *client_name, u32 socket_buffer_size)
509 socket_client_main_t *old_ctx;
512 old_ctx = vl_socket_client_ctx_push (scm);
513 rv = vl_socket_client_connect_internal (socket_client_ctx, socket_path,
514 client_name, socket_buffer_size);
515 vl_socket_client_ctx_pop (old_ctx);
520 vl_socket_client_init_shm_internal (socket_client_main_t * scm,
521 vl_api_shm_elem_config_t * config,
524 vl_api_sock_init_shm_t *mp;
528 scm->want_shm_pthread = want_pthread;
530 mp = vl_socket_client_msg_alloc2 (scm, sizeof (*mp) +
531 vec_len (config) * sizeof (u64));
532 clib_memset (mp, 0, sizeof (*mp));
533 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_SOCK_INIT_SHM);
534 mp->client_index = clib_host_to_net_u32 (scm->client_index);
535 mp->requested_size = 64 << 20;
539 for (i = 0; i < vec_len (config); i++)
541 cfg = (u64 *) & config[i];
542 mp->configs[i] = *cfg;
544 mp->nitems = vec_len (config);
546 rv = vl_socket_client_write_internal (scm);
550 if (vl_socket_client_read_internal (scm, 1))
557 vl_socket_client_init_shm (vl_api_shm_elem_config_t * config,
560 return vl_socket_client_init_shm_internal (socket_client_ctx, config,
565 vl_socket_client_init_shm2 (socket_client_main_t * scm,
566 vl_api_shm_elem_config_t * config,
569 socket_client_main_t *old_ctx;
572 old_ctx = vl_socket_client_ctx_push (scm);
573 rv = vl_socket_client_init_shm_internal (socket_client_ctx, config,
575 vl_socket_client_ctx_pop (old_ctx);
580 vl_socket_client_recv_fd_msg2 (socket_client_main_t * scm, int fds[],
584 return clib_error_return (0, "no socket");
585 return vl_sock_api_recv_fd_msg_internal (scm, fds, n_fds, wait);
589 vl_socket_client_recv_fd_msg (int fds[], int n_fds, u32 wait)
591 return vl_socket_client_recv_fd_msg2 (socket_client_ctx, fds, n_fds, wait);
595 * fd.io coding-style-patch-verification: ON
598 * eval: (c-set-style "gnu")