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 current_rx_index = vec_len (scm->socket_rx_buffer);
91 while (current_rx_index < sizeof (*mbp))
93 vec_validate (scm->socket_rx_buffer, current_rx_index
94 + scm->socket_buffer_size - 1);
95 n = read (scm->socket_fd, scm->socket_rx_buffer + current_rx_index,
96 scm->socket_buffer_size);
102 clib_unix_warning ("socket_read");
103 vec_set_len (scm->socket_rx_buffer, current_rx_index);
106 current_rx_index += n;
108 vec_set_len (scm->socket_rx_buffer, current_rx_index);
112 clib_warning ("read %d bytes", n);
115 mbp = (msgbuf_t *) (scm->socket_rx_buffer);
116 data_len = ntohl (mbp->data_len);
117 current_rx_index = vec_len (scm->socket_rx_buffer);
118 vec_validate (scm->socket_rx_buffer, current_rx_index + data_len);
119 mbp = (msgbuf_t *) (scm->socket_rx_buffer);
120 msg_size = data_len + sizeof (*mbp);
122 while (current_rx_index < msg_size)
124 n = read (scm->socket_fd, scm->socket_rx_buffer + current_rx_index,
125 msg_size - current_rx_index);
131 clib_unix_warning ("socket_read");
132 vec_set_len (scm->socket_rx_buffer, current_rx_index);
135 current_rx_index += n;
137 vec_set_len (scm->socket_rx_buffer, current_rx_index);
139 if (vec_len (scm->socket_rx_buffer) >= data_len + sizeof (*mbp))
141 vl_msg_api_socket_handler ((void *) (mbp->data), data_len);
143 if (vec_len (scm->socket_rx_buffer) == data_len + sizeof (*mbp))
144 vec_set_len (scm->socket_rx_buffer, 0);
146 vec_delete (scm->socket_rx_buffer, data_len + sizeof (*mbp), 0);
149 /* Quit if we're out of data, and not expecting a ping reply */
150 if (vec_len (scm->socket_rx_buffer) == 0
151 && scm->control_pings_outstanding == 0)
154 if (wait && clib_time_now (&scm->clib_time) >= timeout)
161 vl_socket_client_read (int wait)
163 return vl_socket_client_read_internal (socket_client_ctx, wait);
167 vl_socket_client_read2 (socket_client_main_t * scm, int wait)
169 socket_client_main_t *old_ctx;
172 old_ctx = vl_socket_client_ctx_push (scm);
173 rv = vl_socket_client_read_internal (scm, wait);
174 vl_socket_client_ctx_pop (old_ctx);
179 vl_socket_client_write_internal (socket_client_main_t * scm)
182 int len = vec_len (scm->socket_tx_buffer);
185 .gc_mark_timestamp = 0,
186 .data_len = htonl (len),
189 n = write (scm->socket_fd, &msgbuf, sizeof (msgbuf));
190 if (n < sizeof (msgbuf))
192 clib_unix_warning ("socket write (msgbuf)");
196 n = write (scm->socket_fd, scm->socket_tx_buffer, len);
198 vec_set_len (scm->socket_tx_buffer, 0);
202 clib_unix_warning ("socket write (msg)");
210 vl_socket_client_write (void)
212 return vl_socket_client_write_internal (socket_client_ctx);
216 vl_socket_client_write2 (socket_client_main_t * scm)
218 socket_client_main_t *old_ctx;
221 old_ctx = vl_socket_client_ctx_push (scm);
222 rv = vl_socket_client_write_internal (scm);
223 vl_socket_client_ctx_pop (old_ctx);
228 vl_socket_client_msg_alloc2 (socket_client_main_t * scm, int nbytes)
230 vec_set_len (scm->socket_tx_buffer, nbytes);
231 return ((void *) scm->socket_tx_buffer);
235 vl_socket_client_msg_alloc (int nbytes)
237 return vl_socket_client_msg_alloc2 (socket_client_ctx, nbytes);
241 vl_socket_client_disconnect2 (socket_client_main_t * scm)
243 if (vl_mem_client_is_connected ())
245 vl_client_disconnect_from_vlib_no_unmap ();
246 ssvm_delete_memfd (&scm->memfd_segment);
248 if (scm->socket_fd && (close (scm->socket_fd) < 0))
249 clib_unix_warning ("close");
254 vl_socket_client_disconnect (void)
256 vl_socket_client_disconnect2 (socket_client_ctx);
260 vl_socket_client_enable_disable2 (socket_client_main_t * scm, int enable)
262 scm->socket_enable = enable;
266 vl_socket_client_enable_disable (int enable)
268 vl_socket_client_enable_disable2 (socket_client_ctx, enable);
271 static clib_error_t *
272 vl_sock_api_recv_fd_msg_internal (socket_client_main_t * scm, int fds[],
276 char ctl[CMSG_SPACE (sizeof (int) * n_fds)
277 + CMSG_SPACE (sizeof (struct ucred))];
278 struct msghdr mh = { 0 };
281 struct ucred *cr = 0;
282 struct cmsghdr *cmsg;
283 pid_t pid __attribute__ ((unused));
284 uid_t uid __attribute__ ((unused));
285 gid_t gid __attribute__ ((unused));
289 socket_fd = scm->client_socket.fd;
291 iov[0].iov_base = msgbuf;
295 mh.msg_control = ctl;
296 mh.msg_controllen = sizeof (ctl);
298 clib_memset (ctl, 0, sizeof (ctl));
302 timeout = clib_time_now (&scm->clib_time) + wait;
303 while (size != 5 && clib_time_now (&scm->clib_time) < timeout)
304 size = recvmsg (socket_fd, &mh, MSG_DONTWAIT);
307 size = recvmsg (socket_fd, &mh, 0);
311 return (size == 0) ? clib_error_return (0, "disconnected") :
312 clib_error_return_unix (0, "recvmsg: malformed message (fd %d)",
316 cmsg = CMSG_FIRSTHDR (&mh);
319 if (cmsg->cmsg_level == SOL_SOCKET)
321 if (cmsg->cmsg_type == SCM_CREDENTIALS)
323 cr = (struct ucred *) CMSG_DATA (cmsg);
328 else if (cmsg->cmsg_type == SCM_RIGHTS)
330 clib_memcpy_fast (fds, CMSG_DATA (cmsg), sizeof (int) * n_fds);
333 cmsg = CMSG_NXTHDR (&mh, cmsg);
339 vl_sock_api_recv_fd_msg (int socket_fd, int fds[], int n_fds, u32 wait)
341 return vl_sock_api_recv_fd_msg_internal (socket_client_ctx, fds, n_fds,
346 vl_sock_api_recv_fd_msg2 (socket_client_main_t * scm, int socket_fd,
347 int fds[], int n_fds, u32 wait)
349 socket_client_main_t *old_ctx;
352 old_ctx = vl_socket_client_ctx_push (scm);
353 error = vl_sock_api_recv_fd_msg_internal (scm, fds, n_fds, wait);
354 vl_socket_client_ctx_pop (old_ctx);
358 static void vl_api_sock_init_shm_reply_t_handler
359 (vl_api_sock_init_shm_reply_t * mp)
361 socket_client_main_t *scm = socket_client_ctx;
362 ssvm_private_t *memfd = &scm->memfd_segment;
363 i32 retval = ntohl (mp->retval);
364 api_main_t *am = vlibapi_get_main ();
371 clib_warning ("failed to init shmem");
376 * Check the socket for the magic fd
378 error = vl_sock_api_recv_fd_msg (scm->socket_fd, &my_fd, 1, 5);
381 clib_error_report (error);
386 clib_memset (memfd, 0, sizeof (*memfd));
389 /* Note: this closes memfd.fd */
390 retval = ssvm_client_init_memfd (memfd);
392 clib_warning ("WARNING: segment map returned %d", retval);
395 * Pivot to the memory client segment that vpp just created
397 am->vlib_rp = (void *) (memfd->requested_va + MMAP_PAGESIZE);
398 am->shmem_hdr = (void *) am->vlib_rp->user_ctx;
400 new_name = format (0, "%v[shm]%c", scm->name, 0);
401 vl_client_install_client_message_handlers ();
402 if (scm->want_shm_pthread)
404 vl_client_connect_to_vlib_no_map ("pvt", (char *) new_name,
405 32 /* input_queue_length */ );
409 vl_client_connect_to_vlib_no_rx_pthread_no_map ("pvt",
410 (char *) new_name, 32
411 /* input_queue_length */
414 vl_socket_client_enable_disable (0);
419 vl_api_sockclnt_create_reply_t_handler (vl_api_sockclnt_create_reply_t * mp)
421 socket_client_main_t *scm = socket_client_ctx;
424 scm->socket_enable = 1;
425 scm->client_index = clib_net_to_host_u32 (mp->index);
429 #define foreach_sock_client_api_msg \
430 _(SOCKCLNT_CREATE_REPLY, sockclnt_create_reply) \
431 _(SOCK_INIT_SHM_REPLY, sock_init_shm_reply) \
434 vl_sock_client_install_message_handlers (void)
438 vl_msg_api_config (&(vl_msg_api_msg_config_t){ \
441 .handler = vl_api_##n##_t_handler, \
442 .endian = vl_api_##n##_t_endian, \
443 .format_fn = vl_api_##n##_t_format, \
444 .size = sizeof (vl_api_##n##_t), \
446 .tojson = vl_api_##n##_t_tojson, \
447 .fromjson = vl_api_##n##_t_fromjson, \
448 .calc_size = vl_api_##n##_t_calc_size, \
450 foreach_sock_client_api_msg;
455 vl_socket_client_connect_internal (socket_client_main_t * scm,
456 char *socket_path, char *client_name,
457 u32 socket_buffer_size)
459 vl_api_sockclnt_create_t *mp;
463 /* Already connected? */
468 if (socket_path == 0 || client_name == 0)
471 sock = &scm->client_socket;
472 sock->config = socket_path;
473 sock->flags = CLIB_SOCKET_F_IS_CLIENT;
475 if ((error = clib_socket_init (sock)))
477 clib_error_report (error);
481 vl_sock_client_install_message_handlers ();
483 scm->socket_fd = sock->fd;
484 scm->socket_buffer_size = socket_buffer_size ? socket_buffer_size :
485 SOCKET_CLIENT_DEFAULT_BUFFER_SIZE;
486 vec_validate (scm->socket_tx_buffer, scm->socket_buffer_size - 1);
487 vec_validate (scm->socket_rx_buffer, scm->socket_buffer_size - 1);
488 vec_set_len (scm->socket_rx_buffer, 0);
489 vec_set_len (scm->socket_tx_buffer, 0);
490 scm->name = format (0, "%s", client_name);
492 mp = vl_socket_client_msg_alloc2 (scm, sizeof (*mp));
493 mp->_vl_msg_id = htons (VL_API_SOCKCLNT_CREATE);
494 strncpy ((char *) mp->name, client_name, sizeof (mp->name) - 1);
495 mp->name[sizeof (mp->name) - 1] = 0;
496 mp->context = 0xfeedface;
498 clib_time_init (&scm->clib_time);
500 if (vl_socket_client_write_internal (scm) <= 0)
503 if (vl_socket_client_read_internal (scm, 5))
510 vl_socket_client_connect (char *socket_path, char *client_name,
511 u32 socket_buffer_size)
513 return vl_socket_client_connect_internal (socket_client_ctx, socket_path,
514 client_name, socket_buffer_size);
518 vl_socket_client_connect2 (socket_client_main_t * scm, char *socket_path,
519 char *client_name, u32 socket_buffer_size)
521 socket_client_main_t *old_ctx;
524 old_ctx = vl_socket_client_ctx_push (scm);
525 rv = vl_socket_client_connect_internal (socket_client_ctx, socket_path,
526 client_name, socket_buffer_size);
527 vl_socket_client_ctx_pop (old_ctx);
532 vl_socket_client_init_shm_internal (socket_client_main_t * scm,
533 vl_api_shm_elem_config_t * config,
536 vl_api_sock_init_shm_t *mp;
540 scm->want_shm_pthread = want_pthread;
542 mp = vl_socket_client_msg_alloc2 (scm, sizeof (*mp) +
543 vec_len (config) * sizeof (u64));
544 clib_memset (mp, 0, sizeof (*mp));
545 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_SOCK_INIT_SHM);
546 mp->client_index = clib_host_to_net_u32 (scm->client_index);
547 mp->requested_size = 64 << 20;
551 for (i = 0; i < vec_len (config); i++)
553 cfg = (u64 *) & config[i];
554 mp->configs[i] = *cfg;
556 mp->nitems = vec_len (config);
558 rv = vl_socket_client_write_internal (scm);
562 if (vl_socket_client_read_internal (scm, 1))
569 vl_socket_client_init_shm (vl_api_shm_elem_config_t * config,
572 return vl_socket_client_init_shm_internal (socket_client_ctx, config,
577 vl_socket_client_init_shm2 (socket_client_main_t * scm,
578 vl_api_shm_elem_config_t * config,
581 socket_client_main_t *old_ctx;
584 old_ctx = vl_socket_client_ctx_push (scm);
585 rv = vl_socket_client_init_shm_internal (socket_client_ctx, config,
587 vl_socket_client_ctx_pop (old_ctx);
592 vl_socket_client_recv_fd_msg2 (socket_client_main_t * scm, int fds[],
596 return clib_error_return (0, "no socket");
597 return vl_sock_api_recv_fd_msg_internal (scm, fds, n_fds, wait);
601 vl_socket_client_recv_fd_msg (int fds[], int n_fds, u32 wait)
603 return vl_socket_client_recv_fd_msg2 (socket_client_ctx, fds, n_fds, wait);
607 * fd.io coding-style-patch-verification: ON
610 * eval: (c-set-style "gnu")