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 int n, current_rx_index;
63 if (scm->socket_fd == 0)
67 timeout = clib_time_now (&scm->clib_time) + wait;
71 current_rx_index = vec_len (scm->socket_rx_buffer);
72 while (vec_len (scm->socket_rx_buffer) <
73 sizeof (*mbp) + 2 /* msg id */ )
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);
82 clib_unix_warning ("socket_read");
85 _vec_len (scm->socket_rx_buffer) += n;
90 clib_warning ("read %d bytes", n);
94 mbp = (msgbuf_t *) (scm->socket_rx_buffer);
96 if (vec_len (scm->socket_rx_buffer) >= ntohl (mbp->data_len)
99 vl_msg_api_socket_handler ((void *) (mbp->data));
101 if (vec_len (scm->socket_rx_buffer) == ntohl (mbp->data_len)
103 _vec_len (scm->socket_rx_buffer) = 0;
105 vec_delete (scm->socket_rx_buffer, ntohl (mbp->data_len)
109 /* Quit if we're out of data, and not expecting a ping reply */
110 if (vec_len (scm->socket_rx_buffer) == 0
111 && scm->control_pings_outstanding == 0)
115 if (wait && clib_time_now (&scm->clib_time) >= timeout)
122 vl_socket_client_write (void)
124 socket_client_main_t *scm = &socket_client_main;
129 .gc_mark_timestamp = 0,
130 .data_len = htonl (scm->socket_tx_nbytes),
133 n = write (scm->socket_fd, &msgbuf, sizeof (msgbuf));
134 if (n < sizeof (msgbuf))
136 clib_unix_warning ("socket write (msgbuf)");
140 n = write (scm->socket_fd, scm->socket_tx_buffer, scm->socket_tx_nbytes);
141 if (n < scm->socket_tx_nbytes)
143 clib_unix_warning ("socket write (msg)");
151 vl_socket_client_msg_alloc (int nbytes)
153 socket_client_main.socket_tx_nbytes = nbytes;
154 return ((void *) socket_client_main.socket_tx_buffer);
158 vl_socket_client_disconnect (void)
160 socket_client_main_t *scm = &socket_client_main;
162 if (vl_mem_client_is_connected ())
164 vl_client_disconnect_from_vlib_no_unmap ();
165 ssvm_delete_memfd (&scm->memfd_segment);
167 if (scm->socket_fd && (close (scm->socket_fd) < 0))
168 clib_unix_warning ("close");
173 vl_socket_client_enable_disable (int enable)
175 socket_client_main_t *scm = &socket_client_main;
176 scm->socket_enable = enable;
180 vl_sock_api_recv_fd_msg (int socket_fd, int fds[], int n_fds, u32 wait)
182 socket_client_main_t *scm = &socket_client_main;
184 char ctl[CMSG_SPACE (sizeof (int) * n_fds)
185 + CMSG_SPACE (sizeof (struct ucred))];
186 struct msghdr mh = { 0 };
189 struct ucred *cr = 0;
190 struct cmsghdr *cmsg;
191 pid_t pid __attribute__ ((unused));
192 uid_t uid __attribute__ ((unused));
193 gid_t gid __attribute__ ((unused));
196 iov[0].iov_base = msgbuf;
200 mh.msg_control = ctl;
201 mh.msg_controllen = sizeof (ctl);
203 memset (ctl, 0, sizeof (ctl));
207 timeout = clib_time_now (&scm->clib_time) + wait;
208 while (size != 5 && clib_time_now (&scm->clib_time) < timeout)
209 size = recvmsg (socket_fd, &mh, MSG_DONTWAIT);
212 size = recvmsg (socket_fd, &mh, 0);
216 return (size == 0) ? clib_error_return (0, "disconnected") :
217 clib_error_return_unix (0, "recvmsg: malformed message (fd %d)",
221 cmsg = CMSG_FIRSTHDR (&mh);
224 if (cmsg->cmsg_level == SOL_SOCKET)
226 if (cmsg->cmsg_type == SCM_CREDENTIALS)
228 cr = (struct ucred *) CMSG_DATA (cmsg);
233 else if (cmsg->cmsg_type == SCM_RIGHTS)
235 clib_memcpy (fds, CMSG_DATA (cmsg), sizeof (int) * n_fds);
238 cmsg = CMSG_NXTHDR (&mh, cmsg);
243 static void vl_api_sock_init_shm_reply_t_handler
244 (vl_api_sock_init_shm_reply_t * mp)
246 socket_client_main_t *scm = &socket_client_main;
247 ssvm_private_t *memfd = &scm->memfd_segment;
248 i32 retval = ntohl (mp->retval);
249 api_main_t *am = &api_main;
256 clib_warning ("failed to init shmem");
261 * Check the socket for the magic fd
263 error = vl_sock_api_recv_fd_msg (scm->socket_fd, &my_fd, 1, 5);
266 clib_error_report (error);
271 memset (memfd, 0, sizeof (*memfd));
274 /* Note: this closes memfd.fd */
275 retval = ssvm_slave_init_memfd (memfd);
277 clib_warning ("WARNING: segment map returned %d", retval);
280 * Pivot to the memory client segment that vpp just created
282 am->vlib_rp = (void *) (memfd->requested_va + MMAP_PAGESIZE);
283 am->shmem_hdr = (void *) am->vlib_rp->user_ctx;
285 new_name = format (0, "%v[shm]%c", scm->name, 0);
286 vl_client_install_client_message_handlers ();
287 vl_client_connect_to_vlib_no_map ("pvt", (char *) new_name,
288 32 /* input_queue_length */ );
289 vl_socket_client_enable_disable (0);
294 vl_api_sockclnt_create_reply_t_handler (vl_api_sockclnt_create_reply_t * mp)
296 socket_client_main_t *scm = &socket_client_main;
298 scm->socket_enable = 1;
301 #define foreach_sock_client_api_msg \
302 _(SOCKCLNT_CREATE_REPLY, sockclnt_create_reply) \
303 _(SOCK_INIT_SHM_REPLY, sock_init_shm_reply) \
306 noop_handler (void *notused)
311 vl_sock_client_install_message_handlers (void)
315 vl_msg_api_set_handlers(VL_API_##N, #n, \
316 vl_api_##n##_t_handler, \
318 vl_api_##n##_t_endian, \
319 vl_api_##n##_t_print, \
320 sizeof(vl_api_##n##_t), 1);
321 foreach_sock_client_api_msg;
326 vl_socket_client_connect (char *socket_path, char *client_name,
327 u32 socket_buffer_size)
329 socket_client_main_t *scm = &socket_client_main;
330 vl_api_sockclnt_create_t *mp;
334 /* Already connected? */
339 if (socket_path == 0 || client_name == 0)
342 sock = &scm->client_socket;
343 sock->config = socket_path;
344 sock->flags = CLIB_SOCKET_F_IS_CLIENT | CLIB_SOCKET_F_SEQPACKET;
346 if ((error = clib_socket_init (sock)))
348 clib_error_report (error);
352 vl_sock_client_install_message_handlers ();
354 scm->socket_fd = sock->fd;
355 scm->socket_buffer_size = socket_buffer_size ? socket_buffer_size :
356 SOCKET_CLIENT_DEFAULT_BUFFER_SIZE;
357 vec_validate (scm->socket_tx_buffer, scm->socket_buffer_size - 1);
358 vec_validate (scm->socket_rx_buffer, scm->socket_buffer_size - 1);
359 _vec_len (scm->socket_rx_buffer) = 0;
360 _vec_len (scm->socket_tx_buffer) = 0;
361 scm->name = format (0, "%s", client_name);
363 mp = vl_socket_client_msg_alloc (sizeof (*mp));
364 mp->_vl_msg_id = htons (VL_API_SOCKCLNT_CREATE);
365 strncpy ((char *) mp->name, client_name, sizeof (mp->name) - 1);
366 mp->name[sizeof (mp->name) - 1] = 0;
367 mp->context = 0xfeedface;
369 if (vl_socket_client_write () <= 0)
372 if (vl_socket_client_read (1))
375 clib_time_init (&scm->clib_time);
380 vl_socket_client_init_shm (vl_api_shm_elem_config_t * config)
382 vl_api_sock_init_shm_t *mp;
386 mp = vl_socket_client_msg_alloc (sizeof (*mp) +
387 vec_len (config) * sizeof (u64));
388 memset (mp, 0, sizeof (*mp));
389 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_SOCK_INIT_SHM);
390 mp->client_index = ~0;
391 mp->requested_size = 64 << 20;
395 for (i = 0; i < vec_len (config); i++)
397 cfg = (u64 *) & config[i];
398 mp->configs[i] = *cfg;
400 mp->nitems = vec_len (config);
402 rv = vl_socket_client_write ();
406 if (vl_socket_client_read (1))
413 vl_socket_client_recv_fd_msg (int fds[], int n_fds, u32 wait)
415 socket_client_main_t *scm = &socket_client_main;
417 return clib_error_return (0, "no socket");
418 return vl_sock_api_recv_fd_msg (scm->client_socket.fd, fds, n_fds, wait);
422 * fd.io coding-style-patch-verification: ON
425 * eval: (c-set-style "gnu")