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 /* instantiate all the print functions we know about */
40 #define vl_print(handle, ...) clib_warning (__VA_ARGS__)
42 #include <vlibmemory/vl_memory_api_h.h>
45 socket_client_main_t socket_client_main;
46 __thread socket_client_main_t *socket_client_ctx = &socket_client_main;
49 u32 vl (void *p) __attribute__ ((weak));
57 static socket_client_main_t *
58 vl_socket_client_ctx_push (socket_client_main_t * ctx)
60 socket_client_main_t *old = socket_client_ctx;
61 socket_client_ctx = ctx;
66 vl_socket_client_ctx_pop (socket_client_main_t * old_ctx)
68 socket_client_ctx = old_ctx;
72 vl_socket_client_read_internal (socket_client_main_t * scm, int wait)
74 u32 data_len = 0, msg_size;
75 int n, current_rx_index;
79 if (scm->socket_fd == 0)
83 timeout = clib_time_now (&scm->clib_time) + wait;
87 while (vec_len (scm->socket_rx_buffer) < sizeof (*mbp))
89 current_rx_index = vec_len (scm->socket_rx_buffer);
90 vec_validate (scm->socket_rx_buffer, current_rx_index
91 + scm->socket_buffer_size - 1);
92 _vec_len (scm->socket_rx_buffer) = current_rx_index;
93 n = read (scm->socket_fd, scm->socket_rx_buffer + current_rx_index,
94 scm->socket_buffer_size);
100 clib_unix_warning ("socket_read");
103 _vec_len (scm->socket_rx_buffer) += n;
108 clib_warning ("read %d bytes", n);
111 mbp = (msgbuf_t *) (scm->socket_rx_buffer);
112 data_len = ntohl (mbp->data_len);
113 current_rx_index = vec_len (scm->socket_rx_buffer);
114 vec_validate (scm->socket_rx_buffer, current_rx_index + data_len);
115 _vec_len (scm->socket_rx_buffer) = current_rx_index;
116 mbp = (msgbuf_t *) (scm->socket_rx_buffer);
117 msg_size = data_len + sizeof (*mbp);
119 while (vec_len (scm->socket_rx_buffer) < msg_size)
121 n = read (scm->socket_fd,
122 scm->socket_rx_buffer + vec_len (scm->socket_rx_buffer),
123 msg_size - vec_len (scm->socket_rx_buffer));
129 clib_unix_warning ("socket_read");
132 _vec_len (scm->socket_rx_buffer) += n;
135 if (vec_len (scm->socket_rx_buffer) >= data_len + sizeof (*mbp))
137 vl_msg_api_socket_handler ((void *) (mbp->data));
139 if (vec_len (scm->socket_rx_buffer) == data_len + sizeof (*mbp))
140 _vec_len (scm->socket_rx_buffer) = 0;
142 vec_delete (scm->socket_rx_buffer, data_len + sizeof (*mbp), 0);
145 /* Quit if we're out of data, and not expecting a ping reply */
146 if (vec_len (scm->socket_rx_buffer) == 0
147 && scm->control_pings_outstanding == 0)
150 if (wait && clib_time_now (&scm->clib_time) >= timeout)
157 vl_socket_client_read (int wait)
159 return vl_socket_client_read_internal (socket_client_ctx, wait);
163 vl_socket_client_read2 (socket_client_main_t * scm, int wait)
165 socket_client_main_t *old_ctx;
168 old_ctx = vl_socket_client_ctx_push (scm);
169 rv = vl_socket_client_read_internal (scm, wait);
170 vl_socket_client_ctx_pop (old_ctx);
175 vl_socket_client_write_internal (socket_client_main_t * scm)
181 .gc_mark_timestamp = 0,
182 .data_len = htonl (scm->socket_tx_nbytes),
185 n = write (scm->socket_fd, &msgbuf, sizeof (msgbuf));
186 if (n < sizeof (msgbuf))
188 clib_unix_warning ("socket write (msgbuf)");
192 n = write (scm->socket_fd, scm->socket_tx_buffer, scm->socket_tx_nbytes);
193 if (n < scm->socket_tx_nbytes)
195 clib_unix_warning ("socket write (msg)");
203 vl_socket_client_write (void)
205 return vl_socket_client_write_internal (socket_client_ctx);
209 vl_socket_client_write2 (socket_client_main_t * scm)
211 socket_client_main_t *old_ctx;
214 old_ctx = vl_socket_client_ctx_push (scm);
215 rv = vl_socket_client_write_internal (scm);
216 vl_socket_client_ctx_pop (old_ctx);
221 vl_socket_client_msg_alloc2 (socket_client_main_t * scm, int nbytes)
223 scm->socket_tx_nbytes = nbytes;
224 return ((void *) scm->socket_tx_buffer);
228 vl_socket_client_msg_alloc (int nbytes)
230 return vl_socket_client_msg_alloc2 (socket_client_ctx, nbytes);
234 vl_socket_client_disconnect2 (socket_client_main_t * scm)
236 if (vl_mem_client_is_connected ())
238 vl_client_disconnect_from_vlib_no_unmap ();
239 ssvm_delete_memfd (&scm->memfd_segment);
241 if (scm->socket_fd && (close (scm->socket_fd) < 0))
242 clib_unix_warning ("close");
247 vl_socket_client_disconnect (void)
249 vl_socket_client_disconnect2 (socket_client_ctx);
253 vl_socket_client_enable_disable2 (socket_client_main_t * scm, int enable)
255 scm->socket_enable = enable;
259 vl_socket_client_enable_disable (int enable)
261 vl_socket_client_enable_disable2 (socket_client_ctx, enable);
264 static clib_error_t *
265 vl_sock_api_recv_fd_msg_internal (socket_client_main_t * scm, int fds[],
269 char ctl[CMSG_SPACE (sizeof (int) * n_fds)
270 + CMSG_SPACE (sizeof (struct ucred))];
271 struct msghdr mh = { 0 };
274 struct ucred *cr = 0;
275 struct cmsghdr *cmsg;
276 pid_t pid __attribute__ ((unused));
277 uid_t uid __attribute__ ((unused));
278 gid_t gid __attribute__ ((unused));
282 socket_fd = scm->client_socket.fd;
284 iov[0].iov_base = msgbuf;
288 mh.msg_control = ctl;
289 mh.msg_controllen = sizeof (ctl);
291 clib_memset (ctl, 0, sizeof (ctl));
295 timeout = clib_time_now (&scm->clib_time) + wait;
296 while (size != 5 && clib_time_now (&scm->clib_time) < timeout)
297 size = recvmsg (socket_fd, &mh, MSG_DONTWAIT);
300 size = recvmsg (socket_fd, &mh, 0);
304 return (size == 0) ? clib_error_return (0, "disconnected") :
305 clib_error_return_unix (0, "recvmsg: malformed message (fd %d)",
309 cmsg = CMSG_FIRSTHDR (&mh);
312 if (cmsg->cmsg_level == SOL_SOCKET)
314 if (cmsg->cmsg_type == SCM_CREDENTIALS)
316 cr = (struct ucred *) CMSG_DATA (cmsg);
321 else if (cmsg->cmsg_type == SCM_RIGHTS)
323 clib_memcpy_fast (fds, CMSG_DATA (cmsg), sizeof (int) * n_fds);
326 cmsg = CMSG_NXTHDR (&mh, cmsg);
332 vl_sock_api_recv_fd_msg (int socket_fd, int fds[], int n_fds, u32 wait)
334 return vl_sock_api_recv_fd_msg_internal (socket_client_ctx, fds, n_fds,
339 vl_sock_api_recv_fd_msg2 (socket_client_main_t * scm, int socket_fd,
340 int fds[], int n_fds, u32 wait)
342 socket_client_main_t *old_ctx;
345 old_ctx = vl_socket_client_ctx_push (scm);
346 error = vl_sock_api_recv_fd_msg_internal (scm, fds, n_fds, wait);
347 vl_socket_client_ctx_pop (old_ctx);
351 static void vl_api_sock_init_shm_reply_t_handler
352 (vl_api_sock_init_shm_reply_t * mp)
354 socket_client_main_t *scm = socket_client_ctx;
355 ssvm_private_t *memfd = &scm->memfd_segment;
356 i32 retval = ntohl (mp->retval);
357 api_main_t *am = vlibapi_get_main ();
364 clib_warning ("failed to init shmem");
369 * Check the socket for the magic fd
371 error = vl_sock_api_recv_fd_msg (scm->socket_fd, &my_fd, 1, 5);
374 clib_error_report (error);
379 clib_memset (memfd, 0, sizeof (*memfd));
382 /* Note: this closes memfd.fd */
383 retval = ssvm_client_init_memfd (memfd);
385 clib_warning ("WARNING: segment map returned %d", retval);
388 * Pivot to the memory client segment that vpp just created
390 am->vlib_rp = (void *) (memfd->requested_va + MMAP_PAGESIZE);
391 am->shmem_hdr = (void *) am->vlib_rp->user_ctx;
393 new_name = format (0, "%v[shm]%c", scm->name, 0);
394 vl_client_install_client_message_handlers ();
395 if (scm->want_shm_pthread)
397 vl_client_connect_to_vlib_no_map ("pvt", (char *) new_name,
398 32 /* input_queue_length */ );
402 vl_client_connect_to_vlib_no_rx_pthread_no_map ("pvt",
403 (char *) new_name, 32
404 /* input_queue_length */
407 vl_socket_client_enable_disable (0);
412 vl_api_sockclnt_create_reply_t_handler (vl_api_sockclnt_create_reply_t * mp)
414 socket_client_main_t *scm = socket_client_ctx;
417 scm->socket_enable = 1;
418 scm->client_index = clib_net_to_host_u32 (mp->index);
422 #define foreach_sock_client_api_msg \
423 _(SOCKCLNT_CREATE_REPLY, sockclnt_create_reply) \
424 _(SOCK_INIT_SHM_REPLY, sock_init_shm_reply) \
427 noop_handler (void *notused)
432 vl_sock_client_install_message_handlers (void)
436 vl_msg_api_set_handlers(VL_API_##N, #n, \
437 vl_api_##n##_t_handler, \
439 vl_api_##n##_t_endian, \
440 vl_api_##n##_t_print, \
441 sizeof(vl_api_##n##_t), 1);
442 foreach_sock_client_api_msg;
447 vl_socket_client_connect_internal (socket_client_main_t * scm,
448 char *socket_path, char *client_name,
449 u32 socket_buffer_size)
451 vl_api_sockclnt_create_t *mp;
455 /* Already connected? */
460 if (socket_path == 0 || client_name == 0)
463 sock = &scm->client_socket;
464 sock->config = socket_path;
465 sock->flags = CLIB_SOCKET_F_IS_CLIENT | CLIB_SOCKET_F_NON_BLOCKING_CONNECT;
467 if ((error = clib_socket_init (sock)))
469 clib_error_report (error);
473 vl_sock_client_install_message_handlers ();
475 scm->socket_fd = sock->fd;
476 scm->socket_buffer_size = socket_buffer_size ? socket_buffer_size :
477 SOCKET_CLIENT_DEFAULT_BUFFER_SIZE;
478 vec_validate (scm->socket_tx_buffer, scm->socket_buffer_size - 1);
479 vec_validate (scm->socket_rx_buffer, scm->socket_buffer_size - 1);
480 _vec_len (scm->socket_rx_buffer) = 0;
481 _vec_len (scm->socket_tx_buffer) = 0;
482 scm->name = format (0, "%s", client_name);
484 mp = vl_socket_client_msg_alloc2 (scm, sizeof (*mp));
485 mp->_vl_msg_id = htons (VL_API_SOCKCLNT_CREATE);
486 strncpy ((char *) mp->name, client_name, sizeof (mp->name) - 1);
487 mp->name[sizeof (mp->name) - 1] = 0;
488 mp->context = 0xfeedface;
490 clib_time_init (&scm->clib_time);
492 if (vl_socket_client_write_internal (scm) <= 0)
495 if (vl_socket_client_read_internal (scm, 5))
502 vl_socket_client_connect (char *socket_path, char *client_name,
503 u32 socket_buffer_size)
505 return vl_socket_client_connect_internal (socket_client_ctx, socket_path,
506 client_name, socket_buffer_size);
510 vl_socket_client_connect2 (socket_client_main_t * scm, char *socket_path,
511 char *client_name, u32 socket_buffer_size)
513 socket_client_main_t *old_ctx;
516 old_ctx = vl_socket_client_ctx_push (scm);
517 rv = vl_socket_client_connect_internal (socket_client_ctx, socket_path,
518 client_name, socket_buffer_size);
519 vl_socket_client_ctx_pop (old_ctx);
524 vl_socket_client_init_shm_internal (socket_client_main_t * scm,
525 vl_api_shm_elem_config_t * config,
528 vl_api_sock_init_shm_t *mp;
532 scm->want_shm_pthread = want_pthread;
534 mp = vl_socket_client_msg_alloc2 (scm, sizeof (*mp) +
535 vec_len (config) * sizeof (u64));
536 clib_memset (mp, 0, sizeof (*mp));
537 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_SOCK_INIT_SHM);
538 mp->client_index = clib_host_to_net_u32 (scm->client_index);
539 mp->requested_size = 64 << 20;
543 for (i = 0; i < vec_len (config); i++)
545 cfg = (u64 *) & config[i];
546 mp->configs[i] = *cfg;
548 mp->nitems = vec_len (config);
550 rv = vl_socket_client_write_internal (scm);
554 if (vl_socket_client_read_internal (scm, 1))
561 vl_socket_client_init_shm (vl_api_shm_elem_config_t * config,
564 return vl_socket_client_init_shm_internal (socket_client_ctx, config,
569 vl_socket_client_init_shm2 (socket_client_main_t * scm,
570 vl_api_shm_elem_config_t * config,
573 socket_client_main_t *old_ctx;
576 old_ctx = vl_socket_client_ctx_push (scm);
577 rv = vl_socket_client_init_shm_internal (socket_client_ctx, config,
579 vl_socket_client_ctx_pop (old_ctx);
584 vl_socket_client_recv_fd_msg2 (socket_client_main_t * scm, int fds[],
588 return clib_error_return (0, "no socket");
589 return vl_sock_api_recv_fd_msg_internal (scm, fds, n_fds, wait);
593 vl_socket_client_recv_fd_msg (int fds[], int n_fds, u32 wait)
595 return vl_socket_client_recv_fd_msg2 (socket_client_ctx, fds, n_fds, wait);
599 * fd.io coding-style-patch-verification: ON
602 * eval: (c-set-style "gnu")