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;
47 u32 vl (void *p) __attribute__ ((weak));
56 vl_socket_client_read (int wait)
58 socket_client_main_t *scm = &socket_client_main;
59 u32 data_len = 0, msg_size;
60 int n, current_rx_index;
64 if (scm->socket_fd == 0)
68 timeout = clib_time_now (&scm->clib_time) + wait;
72 while (vec_len (scm->socket_rx_buffer) < sizeof (*mbp))
74 current_rx_index = vec_len (scm->socket_rx_buffer);
75 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);
85 clib_unix_warning ("socket_read");
88 _vec_len (scm->socket_rx_buffer) += n;
93 clib_warning ("read %d bytes", n);
96 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);
104 while (vec_len (scm->socket_rx_buffer) < msg_size)
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));
114 clib_unix_warning ("socket_read");
117 _vec_len (scm->socket_rx_buffer) += n;
120 if (vec_len (scm->socket_rx_buffer) >= data_len + sizeof (*mbp))
122 vl_msg_api_socket_handler ((void *) (mbp->data));
124 if (vec_len (scm->socket_rx_buffer) == data_len + sizeof (*mbp))
125 _vec_len (scm->socket_rx_buffer) = 0;
127 vec_delete (scm->socket_rx_buffer, data_len + sizeof (*mbp), 0);
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)
135 if (wait && clib_time_now (&scm->clib_time) >= timeout)
142 vl_socket_client_write (void)
144 socket_client_main_t *scm = &socket_client_main;
149 .gc_mark_timestamp = 0,
150 .data_len = htonl (scm->socket_tx_nbytes),
153 n = write (scm->socket_fd, &msgbuf, sizeof (msgbuf));
154 if (n < sizeof (msgbuf))
156 clib_unix_warning ("socket write (msgbuf)");
160 n = write (scm->socket_fd, scm->socket_tx_buffer, scm->socket_tx_nbytes);
161 if (n < scm->socket_tx_nbytes)
163 clib_unix_warning ("socket write (msg)");
171 vl_socket_client_msg_alloc (int nbytes)
173 socket_client_main.socket_tx_nbytes = nbytes;
174 return ((void *) socket_client_main.socket_tx_buffer);
178 vl_socket_client_disconnect (void)
180 socket_client_main_t *scm = &socket_client_main;
182 if (vl_mem_client_is_connected ())
184 vl_client_disconnect_from_vlib_no_unmap ();
185 ssvm_delete_memfd (&scm->memfd_segment);
187 if (scm->socket_fd && (close (scm->socket_fd) < 0))
188 clib_unix_warning ("close");
193 vl_socket_client_enable_disable (int enable)
195 socket_client_main_t *scm = &socket_client_main;
196 scm->socket_enable = enable;
200 vl_sock_api_recv_fd_msg (int socket_fd, int fds[], int n_fds, u32 wait)
202 socket_client_main_t *scm = &socket_client_main;
204 char ctl[CMSG_SPACE (sizeof (int) * n_fds)
205 + CMSG_SPACE (sizeof (struct ucred))];
206 struct msghdr mh = { 0 };
209 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));
216 iov[0].iov_base = msgbuf;
220 mh.msg_control = ctl;
221 mh.msg_controllen = sizeof (ctl);
223 clib_memset (ctl, 0, sizeof (ctl));
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);
232 size = recvmsg (socket_fd, &mh, 0);
236 return (size == 0) ? clib_error_return (0, "disconnected") :
237 clib_error_return_unix (0, "recvmsg: malformed message (fd %d)",
241 cmsg = CMSG_FIRSTHDR (&mh);
244 if (cmsg->cmsg_level == SOL_SOCKET)
246 if (cmsg->cmsg_type == SCM_CREDENTIALS)
248 cr = (struct ucred *) CMSG_DATA (cmsg);
253 else if (cmsg->cmsg_type == SCM_RIGHTS)
255 clib_memcpy_fast (fds, CMSG_DATA (cmsg), sizeof (int) * n_fds);
258 cmsg = CMSG_NXTHDR (&mh, cmsg);
263 static void vl_api_sock_init_shm_reply_t_handler
264 (vl_api_sock_init_shm_reply_t * mp)
266 socket_client_main_t *scm = &socket_client_main;
267 ssvm_private_t *memfd = &scm->memfd_segment;
268 i32 retval = ntohl (mp->retval);
269 api_main_t *am = &api_main;
276 clib_warning ("failed to init shmem");
281 * Check the socket for the magic fd
283 error = vl_sock_api_recv_fd_msg (scm->socket_fd, &my_fd, 1, 5);
286 clib_error_report (error);
291 clib_memset (memfd, 0, sizeof (*memfd));
294 /* Note: this closes memfd.fd */
295 retval = ssvm_slave_init_memfd (memfd);
297 clib_warning ("WARNING: segment map returned %d", retval);
300 * Pivot to the memory client segment that vpp just created
302 am->vlib_rp = (void *) (memfd->requested_va + MMAP_PAGESIZE);
303 am->shmem_hdr = (void *) am->vlib_rp->user_ctx;
305 new_name = format (0, "%v[shm]%c", scm->name, 0);
306 vl_client_install_client_message_handlers ();
307 if (scm->want_shm_pthread)
309 vl_client_connect_to_vlib_no_map ("pvt", (char *) new_name,
310 32 /* input_queue_length */ );
314 vl_client_connect_to_vlib_no_rx_pthread_no_map ("pvt",
315 (char *) new_name, 32
316 /* input_queue_length */
319 vl_socket_client_enable_disable (0);
324 vl_api_sockclnt_create_reply_t_handler (vl_api_sockclnt_create_reply_t * mp)
326 socket_client_main_t *scm = &socket_client_main;
329 scm->socket_enable = 1;
330 scm->client_index = clib_net_to_host_u32 (mp->index);
334 #define foreach_sock_client_api_msg \
335 _(SOCKCLNT_CREATE_REPLY, sockclnt_create_reply) \
336 _(SOCK_INIT_SHM_REPLY, sock_init_shm_reply) \
339 noop_handler (void *notused)
344 vl_sock_client_install_message_handlers (void)
348 vl_msg_api_set_handlers(VL_API_##N, #n, \
349 vl_api_##n##_t_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;
359 vl_socket_client_connect (char *socket_path, char *client_name,
360 u32 socket_buffer_size)
362 socket_client_main_t *scm = &socket_client_main;
363 vl_api_sockclnt_create_t *mp;
367 /* Already connected? */
372 if (socket_path == 0 || client_name == 0)
375 sock = &scm->client_socket;
376 sock->config = socket_path;
377 sock->flags = CLIB_SOCKET_F_IS_CLIENT | CLIB_SOCKET_F_NON_BLOCKING_CONNECT;
379 if ((error = clib_socket_init (sock)))
381 clib_error_report (error);
385 vl_sock_client_install_message_handlers ();
387 scm->socket_fd = sock->fd;
388 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;
393 _vec_len (scm->socket_tx_buffer) = 0;
394 scm->name = format (0, "%s", client_name);
396 mp = vl_socket_client_msg_alloc (sizeof (*mp));
397 mp->_vl_msg_id = htons (VL_API_SOCKCLNT_CREATE);
398 strncpy ((char *) mp->name, client_name, sizeof (mp->name) - 1);
399 mp->name[sizeof (mp->name) - 1] = 0;
400 mp->context = 0xfeedface;
402 clib_time_init (&scm->clib_time);
404 if (vl_socket_client_write () <= 0)
407 if (vl_socket_client_read (5))
414 vl_socket_client_init_shm (vl_api_shm_elem_config_t * config,
417 socket_client_main_t *scm = &socket_client_main;
418 vl_api_sock_init_shm_t *mp;
422 scm->want_shm_pthread = want_pthread;
424 mp = vl_socket_client_msg_alloc (sizeof (*mp) +
425 vec_len (config) * sizeof (u64));
426 clib_memset (mp, 0, sizeof (*mp));
427 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_SOCK_INIT_SHM);
428 mp->client_index = clib_host_to_net_u32 (scm->client_index);
429 mp->requested_size = 64 << 20;
433 for (i = 0; i < vec_len (config); i++)
435 cfg = (u64 *) & config[i];
436 mp->configs[i] = *cfg;
438 mp->nitems = vec_len (config);
440 rv = vl_socket_client_write ();
444 if (vl_socket_client_read (1))
451 vl_socket_client_recv_fd_msg (int fds[], int n_fds, u32 wait)
453 socket_client_main_t *scm = &socket_client_main;
455 return clib_error_return (0, "no socket");
456 return vl_sock_api_recv_fd_msg (scm->client_socket.fd, fds, n_fds, wait);
460 * fd.io coding-style-patch-verification: ON
463 * eval: (c-set-style "gnu")