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 *------------------------------------------------------------------
22 #include <sys/socket.h>
25 #include <vlibmemory/socket_client.h>
26 #include <vlibmemory/memory_client.h>
28 #include <vlibmemory/vl_memory_msg_enum.h>
30 #define vl_typedefs /* define message structures */
31 #include <vlibmemory/vl_memory_api_h.h>
34 #define vl_endianfun /* define message structures */
35 #include <vlibmemory/vl_memory_api_h.h>
38 /* instantiate all the print functions we know about */
39 #define vl_print(handle, ...) clib_warning (__VA_ARGS__)
41 #include <vlibmemory/vl_memory_api_h.h>
44 socket_client_main_t socket_client_main;
45 __thread socket_client_main_t *socket_client_ctx = &socket_client_main;
48 u32 vl (void *p) __attribute__ ((weak));
56 static socket_client_main_t *
57 vl_socket_client_ctx_push (socket_client_main_t * ctx)
59 socket_client_main_t *old = socket_client_ctx;
60 socket_client_ctx = ctx;
65 vl_socket_client_ctx_pop (socket_client_main_t * old_ctx)
67 socket_client_ctx = old_ctx;
71 vl_socket_client_read_internal (socket_client_main_t * scm, int wait)
73 u32 data_len = 0, msg_size;
74 int n, current_rx_index;
78 if (scm->socket_fd == 0)
82 timeout = clib_time_now (&scm->clib_time) + wait;
86 while (vec_len (scm->socket_rx_buffer) < sizeof (*mbp))
88 current_rx_index = vec_len (scm->socket_rx_buffer);
89 vec_validate (scm->socket_rx_buffer, current_rx_index
90 + scm->socket_buffer_size - 1);
91 _vec_len (scm->socket_rx_buffer) = current_rx_index;
92 n = read (scm->socket_fd, scm->socket_rx_buffer + current_rx_index,
93 scm->socket_buffer_size);
99 clib_unix_warning ("socket_read");
102 _vec_len (scm->socket_rx_buffer) += n;
107 clib_warning ("read %d bytes", n);
110 mbp = (msgbuf_t *) (scm->socket_rx_buffer);
111 data_len = ntohl (mbp->data_len);
112 current_rx_index = vec_len (scm->socket_rx_buffer);
113 vec_validate (scm->socket_rx_buffer, current_rx_index + data_len);
114 _vec_len (scm->socket_rx_buffer) = current_rx_index;
115 mbp = (msgbuf_t *) (scm->socket_rx_buffer);
116 msg_size = data_len + sizeof (*mbp);
118 while (vec_len (scm->socket_rx_buffer) < msg_size)
120 n = read (scm->socket_fd,
121 scm->socket_rx_buffer + vec_len (scm->socket_rx_buffer),
122 msg_size - vec_len (scm->socket_rx_buffer));
128 clib_unix_warning ("socket_read");
131 _vec_len (scm->socket_rx_buffer) += n;
134 if (vec_len (scm->socket_rx_buffer) >= data_len + sizeof (*mbp))
136 vl_msg_api_socket_handler ((void *) (mbp->data));
138 if (vec_len (scm->socket_rx_buffer) == data_len + sizeof (*mbp))
139 _vec_len (scm->socket_rx_buffer) = 0;
141 vec_delete (scm->socket_rx_buffer, data_len + sizeof (*mbp), 0);
144 /* Quit if we're out of data, and not expecting a ping reply */
145 if (vec_len (scm->socket_rx_buffer) == 0
146 && scm->control_pings_outstanding == 0)
149 if (wait && clib_time_now (&scm->clib_time) >= timeout)
156 vl_socket_client_read (int wait)
158 return vl_socket_client_read_internal (socket_client_ctx, wait);
162 vl_socket_client_read2 (socket_client_main_t * scm, int wait)
164 socket_client_main_t *old_ctx;
167 old_ctx = vl_socket_client_ctx_push (scm);
168 rv = vl_socket_client_read_internal (scm, wait);
169 vl_socket_client_ctx_pop (old_ctx);
174 vl_socket_client_write_internal (socket_client_main_t * scm)
180 .gc_mark_timestamp = 0,
181 .data_len = htonl (scm->socket_tx_nbytes),
184 n = write (scm->socket_fd, &msgbuf, sizeof (msgbuf));
185 if (n < sizeof (msgbuf))
187 clib_unix_warning ("socket write (msgbuf)");
191 n = write (scm->socket_fd, scm->socket_tx_buffer, scm->socket_tx_nbytes);
192 if (n < scm->socket_tx_nbytes)
194 clib_unix_warning ("socket write (msg)");
202 vl_socket_client_write (void)
204 return vl_socket_client_write_internal (socket_client_ctx);
208 vl_socket_client_write2 (socket_client_main_t * scm)
210 socket_client_main_t *old_ctx;
213 old_ctx = vl_socket_client_ctx_push (scm);
214 rv = vl_socket_client_write_internal (scm);
215 vl_socket_client_ctx_pop (old_ctx);
220 vl_socket_client_msg_alloc2 (socket_client_main_t * scm, int nbytes)
222 scm->socket_tx_nbytes = nbytes;
223 return ((void *) scm->socket_tx_buffer);
227 vl_socket_client_msg_alloc (int nbytes)
229 return vl_socket_client_msg_alloc2 (socket_client_ctx, nbytes);
233 vl_socket_client_disconnect2 (socket_client_main_t * scm)
235 if (vl_mem_client_is_connected ())
237 vl_client_disconnect_from_vlib_no_unmap ();
238 ssvm_delete_memfd (&scm->memfd_segment);
240 if (scm->socket_fd && (close (scm->socket_fd) < 0))
241 clib_unix_warning ("close");
246 vl_socket_client_disconnect (void)
248 vl_socket_client_disconnect2 (socket_client_ctx);
252 vl_socket_client_enable_disable2 (socket_client_main_t * scm, int enable)
254 scm->socket_enable = enable;
258 vl_socket_client_enable_disable (int enable)
260 vl_socket_client_enable_disable2 (socket_client_ctx, enable);
263 static clib_error_t *
264 vl_sock_api_recv_fd_msg_internal (socket_client_main_t * scm, int fds[],
268 char ctl[CMSG_SPACE (sizeof (int) * n_fds)
269 + CMSG_SPACE (sizeof (struct ucred))];
270 struct msghdr mh = { 0 };
273 struct ucred *cr = 0;
274 struct cmsghdr *cmsg;
275 pid_t pid __attribute__ ((unused));
276 uid_t uid __attribute__ ((unused));
277 gid_t gid __attribute__ ((unused));
281 socket_fd = scm->client_socket.fd;
283 iov[0].iov_base = msgbuf;
287 mh.msg_control = ctl;
288 mh.msg_controllen = sizeof (ctl);
290 clib_memset (ctl, 0, sizeof (ctl));
294 timeout = clib_time_now (&scm->clib_time) + wait;
295 while (size != 5 && clib_time_now (&scm->clib_time) < timeout)
296 size = recvmsg (socket_fd, &mh, MSG_DONTWAIT);
299 size = recvmsg (socket_fd, &mh, 0);
303 return (size == 0) ? clib_error_return (0, "disconnected") :
304 clib_error_return_unix (0, "recvmsg: malformed message (fd %d)",
308 cmsg = CMSG_FIRSTHDR (&mh);
311 if (cmsg->cmsg_level == SOL_SOCKET)
313 if (cmsg->cmsg_type == SCM_CREDENTIALS)
315 cr = (struct ucred *) CMSG_DATA (cmsg);
320 else if (cmsg->cmsg_type == SCM_RIGHTS)
322 clib_memcpy_fast (fds, CMSG_DATA (cmsg), sizeof (int) * n_fds);
325 cmsg = CMSG_NXTHDR (&mh, cmsg);
331 vl_sock_api_recv_fd_msg (int socket_fd, int fds[], int n_fds, u32 wait)
333 return vl_sock_api_recv_fd_msg_internal (socket_client_ctx, fds, n_fds,
338 vl_sock_api_recv_fd_msg2 (socket_client_main_t * scm, int socket_fd,
339 int fds[], int n_fds, u32 wait)
341 socket_client_main_t *old_ctx;
344 old_ctx = vl_socket_client_ctx_push (scm);
345 error = vl_sock_api_recv_fd_msg_internal (scm, fds, n_fds, wait);
346 vl_socket_client_ctx_pop (old_ctx);
350 static void vl_api_sock_init_shm_reply_t_handler
351 (vl_api_sock_init_shm_reply_t * mp)
353 socket_client_main_t *scm = socket_client_ctx;
354 ssvm_private_t *memfd = &scm->memfd_segment;
355 i32 retval = ntohl (mp->retval);
356 api_main_t *am = vlibapi_get_main ();
363 clib_warning ("failed to init shmem");
368 * Check the socket for the magic fd
370 error = vl_sock_api_recv_fd_msg (scm->socket_fd, &my_fd, 1, 5);
373 clib_error_report (error);
378 clib_memset (memfd, 0, sizeof (*memfd));
381 /* Note: this closes memfd.fd */
382 retval = ssvm_slave_init_memfd (memfd);
384 clib_warning ("WARNING: segment map returned %d", retval);
387 * Pivot to the memory client segment that vpp just created
389 am->vlib_rp = (void *) (memfd->requested_va + MMAP_PAGESIZE);
390 am->shmem_hdr = (void *) am->vlib_rp->user_ctx;
392 new_name = format (0, "%v[shm]%c", scm->name, 0);
393 vl_client_install_client_message_handlers ();
394 if (scm->want_shm_pthread)
396 vl_client_connect_to_vlib_no_map ("pvt", (char *) new_name,
397 32 /* input_queue_length */ );
401 vl_client_connect_to_vlib_no_rx_pthread_no_map ("pvt",
402 (char *) new_name, 32
403 /* input_queue_length */
406 vl_socket_client_enable_disable (0);
411 vl_api_sockclnt_create_reply_t_handler (vl_api_sockclnt_create_reply_t * mp)
413 socket_client_main_t *scm = socket_client_ctx;
416 scm->socket_enable = 1;
417 scm->client_index = clib_net_to_host_u32 (mp->index);
421 #define foreach_sock_client_api_msg \
422 _(SOCKCLNT_CREATE_REPLY, sockclnt_create_reply) \
423 _(SOCK_INIT_SHM_REPLY, sock_init_shm_reply) \
426 noop_handler (void *notused)
431 vl_sock_client_install_message_handlers (void)
435 vl_msg_api_set_handlers(VL_API_##N, #n, \
436 vl_api_##n##_t_handler, \
438 vl_api_##n##_t_endian, \
439 vl_api_##n##_t_print, \
440 sizeof(vl_api_##n##_t), 1);
441 foreach_sock_client_api_msg;
446 vl_socket_client_connect_internal (socket_client_main_t * scm,
447 char *socket_path, char *client_name,
448 u32 socket_buffer_size)
450 vl_api_sockclnt_create_t *mp;
454 /* Already connected? */
459 if (socket_path == 0 || client_name == 0)
462 sock = &scm->client_socket;
463 sock->config = socket_path;
464 sock->flags = CLIB_SOCKET_F_IS_CLIENT | CLIB_SOCKET_F_NON_BLOCKING_CONNECT;
466 if ((error = clib_socket_init (sock)))
468 clib_error_report (error);
472 vl_sock_client_install_message_handlers ();
474 scm->socket_fd = sock->fd;
475 scm->socket_buffer_size = socket_buffer_size ? socket_buffer_size :
476 SOCKET_CLIENT_DEFAULT_BUFFER_SIZE;
477 vec_validate (scm->socket_tx_buffer, scm->socket_buffer_size - 1);
478 vec_validate (scm->socket_rx_buffer, scm->socket_buffer_size - 1);
479 _vec_len (scm->socket_rx_buffer) = 0;
480 _vec_len (scm->socket_tx_buffer) = 0;
481 scm->name = format (0, "%s", client_name);
483 mp = vl_socket_client_msg_alloc2 (scm, sizeof (*mp));
484 mp->_vl_msg_id = htons (VL_API_SOCKCLNT_CREATE);
485 strncpy ((char *) mp->name, client_name, sizeof (mp->name) - 1);
486 mp->name[sizeof (mp->name) - 1] = 0;
487 mp->context = 0xfeedface;
489 clib_time_init (&scm->clib_time);
491 if (vl_socket_client_write_internal (scm) <= 0)
494 if (vl_socket_client_read_internal (scm, 5))
501 vl_socket_client_connect (char *socket_path, char *client_name,
502 u32 socket_buffer_size)
504 return vl_socket_client_connect_internal (socket_client_ctx, socket_path,
505 client_name, socket_buffer_size);
509 vl_socket_client_connect2 (socket_client_main_t * scm, char *socket_path,
510 char *client_name, u32 socket_buffer_size)
512 socket_client_main_t *old_ctx;
515 old_ctx = vl_socket_client_ctx_push (scm);
516 rv = vl_socket_client_connect_internal (socket_client_ctx, socket_path,
517 client_name, socket_buffer_size);
518 vl_socket_client_ctx_pop (old_ctx);
523 vl_socket_client_init_shm_internal (socket_client_main_t * scm,
524 vl_api_shm_elem_config_t * config,
527 vl_api_sock_init_shm_t *mp;
531 scm->want_shm_pthread = want_pthread;
533 mp = vl_socket_client_msg_alloc2 (scm, sizeof (*mp) +
534 vec_len (config) * sizeof (u64));
535 clib_memset (mp, 0, sizeof (*mp));
536 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_SOCK_INIT_SHM);
537 mp->client_index = clib_host_to_net_u32 (scm->client_index);
538 mp->requested_size = 64 << 20;
542 for (i = 0; i < vec_len (config); i++)
544 cfg = (u64 *) & config[i];
545 mp->configs[i] = *cfg;
547 mp->nitems = vec_len (config);
549 rv = vl_socket_client_write_internal (scm);
553 if (vl_socket_client_read_internal (scm, 1))
560 vl_socket_client_init_shm (vl_api_shm_elem_config_t * config,
563 return vl_socket_client_init_shm_internal (socket_client_ctx, config,
568 vl_socket_client_init_shm2 (socket_client_main_t * scm,
569 vl_api_shm_elem_config_t * config,
572 socket_client_main_t *old_ctx;
575 old_ctx = vl_socket_client_ctx_push (scm);
576 rv = vl_socket_client_init_shm_internal (socket_client_ctx, config,
578 vl_socket_client_ctx_pop (old_ctx);
583 vl_socket_client_recv_fd_msg2 (socket_client_main_t * scm, int fds[],
587 return clib_error_return (0, "no socket");
588 return vl_sock_api_recv_fd_msg_internal (scm, fds, n_fds, wait);
592 vl_socket_client_recv_fd_msg (int fds[], int n_fds, u32 wait)
594 return vl_socket_client_recv_fd_msg2 (socket_client_ctx, fds, n_fds, wait);
598 * fd.io coding-style-patch-verification: ON
601 * eval: (c-set-style "gnu")