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);
82 clib_unix_warning ("socket_read");
85 _vec_len (scm->socket_rx_buffer) += n;
90 clib_warning ("read %d bytes", n);
93 mbp = (msgbuf_t *) (scm->socket_rx_buffer);
94 data_len = ntohl (mbp->data_len);
95 current_rx_index = vec_len (scm->socket_rx_buffer);
96 vec_validate (scm->socket_rx_buffer, current_rx_index + data_len);
97 _vec_len (scm->socket_rx_buffer) = current_rx_index;
98 mbp = (msgbuf_t *) (scm->socket_rx_buffer);
99 msg_size = data_len + sizeof (*mbp);
101 while (vec_len (scm->socket_rx_buffer) < msg_size)
103 n = read (scm->socket_fd,
104 scm->socket_rx_buffer + vec_len (scm->socket_rx_buffer),
105 msg_size - vec_len (scm->socket_rx_buffer));
106 if (n < 0 && errno != EAGAIN)
108 clib_unix_warning ("socket_read");
111 _vec_len (scm->socket_rx_buffer) += n;
114 if (vec_len (scm->socket_rx_buffer) >= data_len + sizeof (*mbp))
116 vl_msg_api_socket_handler ((void *) (mbp->data));
118 if (vec_len (scm->socket_rx_buffer) == data_len + sizeof (*mbp))
119 _vec_len (scm->socket_rx_buffer) = 0;
121 vec_delete (scm->socket_rx_buffer, data_len + sizeof (*mbp), 0);
124 /* Quit if we're out of data, and not expecting a ping reply */
125 if (vec_len (scm->socket_rx_buffer) == 0
126 && scm->control_pings_outstanding == 0)
129 if (wait && clib_time_now (&scm->clib_time) >= timeout)
136 vl_socket_client_write (void)
138 socket_client_main_t *scm = &socket_client_main;
143 .gc_mark_timestamp = 0,
144 .data_len = htonl (scm->socket_tx_nbytes),
147 n = write (scm->socket_fd, &msgbuf, sizeof (msgbuf));
148 if (n < sizeof (msgbuf))
150 clib_unix_warning ("socket write (msgbuf)");
154 n = write (scm->socket_fd, scm->socket_tx_buffer, scm->socket_tx_nbytes);
155 if (n < scm->socket_tx_nbytes)
157 clib_unix_warning ("socket write (msg)");
165 vl_socket_client_msg_alloc (int nbytes)
167 socket_client_main.socket_tx_nbytes = nbytes;
168 return ((void *) socket_client_main.socket_tx_buffer);
172 vl_socket_client_disconnect (void)
174 socket_client_main_t *scm = &socket_client_main;
176 if (vl_mem_client_is_connected ())
178 vl_client_disconnect_from_vlib_no_unmap ();
179 ssvm_delete_memfd (&scm->memfd_segment);
181 if (scm->socket_fd && (close (scm->socket_fd) < 0))
182 clib_unix_warning ("close");
187 vl_socket_client_enable_disable (int enable)
189 socket_client_main_t *scm = &socket_client_main;
190 scm->socket_enable = enable;
194 vl_sock_api_recv_fd_msg (int socket_fd, int fds[], int n_fds, u32 wait)
196 socket_client_main_t *scm = &socket_client_main;
198 char ctl[CMSG_SPACE (sizeof (int) * n_fds)
199 + CMSG_SPACE (sizeof (struct ucred))];
200 struct msghdr mh = { 0 };
203 struct ucred *cr = 0;
204 struct cmsghdr *cmsg;
205 pid_t pid __attribute__ ((unused));
206 uid_t uid __attribute__ ((unused));
207 gid_t gid __attribute__ ((unused));
210 iov[0].iov_base = msgbuf;
214 mh.msg_control = ctl;
215 mh.msg_controllen = sizeof (ctl);
217 clib_memset (ctl, 0, sizeof (ctl));
221 timeout = clib_time_now (&scm->clib_time) + wait;
222 while (size != 5 && clib_time_now (&scm->clib_time) < timeout)
223 size = recvmsg (socket_fd, &mh, MSG_DONTWAIT);
226 size = recvmsg (socket_fd, &mh, 0);
230 return (size == 0) ? clib_error_return (0, "disconnected") :
231 clib_error_return_unix (0, "recvmsg: malformed message (fd %d)",
235 cmsg = CMSG_FIRSTHDR (&mh);
238 if (cmsg->cmsg_level == SOL_SOCKET)
240 if (cmsg->cmsg_type == SCM_CREDENTIALS)
242 cr = (struct ucred *) CMSG_DATA (cmsg);
247 else if (cmsg->cmsg_type == SCM_RIGHTS)
249 clib_memcpy (fds, CMSG_DATA (cmsg), sizeof (int) * n_fds);
252 cmsg = CMSG_NXTHDR (&mh, cmsg);
257 static void vl_api_sock_init_shm_reply_t_handler
258 (vl_api_sock_init_shm_reply_t * mp)
260 socket_client_main_t *scm = &socket_client_main;
261 ssvm_private_t *memfd = &scm->memfd_segment;
262 i32 retval = ntohl (mp->retval);
263 api_main_t *am = &api_main;
270 clib_warning ("failed to init shmem");
275 * Check the socket for the magic fd
277 error = vl_sock_api_recv_fd_msg (scm->socket_fd, &my_fd, 1, 5);
280 clib_error_report (error);
285 clib_memset (memfd, 0, sizeof (*memfd));
288 /* Note: this closes memfd.fd */
289 retval = ssvm_slave_init_memfd (memfd);
291 clib_warning ("WARNING: segment map returned %d", retval);
294 * Pivot to the memory client segment that vpp just created
296 am->vlib_rp = (void *) (memfd->requested_va + MMAP_PAGESIZE);
297 am->shmem_hdr = (void *) am->vlib_rp->user_ctx;
299 new_name = format (0, "%v[shm]%c", scm->name, 0);
300 vl_client_install_client_message_handlers ();
301 vl_client_connect_to_vlib_no_map ("pvt", (char *) new_name,
302 32 /* input_queue_length */ );
303 vl_socket_client_enable_disable (0);
308 vl_api_sockclnt_create_reply_t_handler (vl_api_sockclnt_create_reply_t * mp)
310 socket_client_main_t *scm = &socket_client_main;
313 scm->socket_enable = 1;
314 scm->client_index = clib_net_to_host_u32 (mp->index);
318 #define foreach_sock_client_api_msg \
319 _(SOCKCLNT_CREATE_REPLY, sockclnt_create_reply) \
320 _(SOCK_INIT_SHM_REPLY, sock_init_shm_reply) \
323 noop_handler (void *notused)
328 vl_sock_client_install_message_handlers (void)
332 vl_msg_api_set_handlers(VL_API_##N, #n, \
333 vl_api_##n##_t_handler, \
335 vl_api_##n##_t_endian, \
336 vl_api_##n##_t_print, \
337 sizeof(vl_api_##n##_t), 1);
338 foreach_sock_client_api_msg;
343 vl_socket_client_connect (char *socket_path, char *client_name,
344 u32 socket_buffer_size)
346 socket_client_main_t *scm = &socket_client_main;
347 vl_api_sockclnt_create_t *mp;
351 /* Already connected? */
356 if (socket_path == 0 || client_name == 0)
359 sock = &scm->client_socket;
360 sock->config = socket_path;
361 sock->flags = CLIB_SOCKET_F_IS_CLIENT | CLIB_SOCKET_F_SEQPACKET;
363 if ((error = clib_socket_init (sock)))
365 clib_error_report (error);
369 vl_sock_client_install_message_handlers ();
371 scm->socket_fd = sock->fd;
372 scm->socket_buffer_size = socket_buffer_size ? socket_buffer_size :
373 SOCKET_CLIENT_DEFAULT_BUFFER_SIZE;
374 vec_validate (scm->socket_tx_buffer, scm->socket_buffer_size - 1);
375 vec_validate (scm->socket_rx_buffer, scm->socket_buffer_size - 1);
376 _vec_len (scm->socket_rx_buffer) = 0;
377 _vec_len (scm->socket_tx_buffer) = 0;
378 scm->name = format (0, "%s", client_name);
380 mp = vl_socket_client_msg_alloc (sizeof (*mp));
381 mp->_vl_msg_id = htons (VL_API_SOCKCLNT_CREATE);
382 strncpy ((char *) mp->name, client_name, sizeof (mp->name) - 1);
383 mp->name[sizeof (mp->name) - 1] = 0;
384 mp->context = 0xfeedface;
386 clib_time_init (&scm->clib_time);
388 if (vl_socket_client_write () <= 0)
391 if (vl_socket_client_read (5))
398 vl_socket_client_init_shm (vl_api_shm_elem_config_t * config)
400 socket_client_main_t *scm = &socket_client_main;
401 vl_api_sock_init_shm_t *mp;
405 mp = vl_socket_client_msg_alloc (sizeof (*mp) +
406 vec_len (config) * sizeof (u64));
407 clib_memset (mp, 0, sizeof (*mp));
408 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_SOCK_INIT_SHM);
409 mp->client_index = clib_host_to_net_u32 (scm->client_index);
410 mp->requested_size = 64 << 20;
414 for (i = 0; i < vec_len (config); i++)
416 cfg = (u64 *) & config[i];
417 mp->configs[i] = *cfg;
419 mp->nitems = vec_len (config);
421 rv = vl_socket_client_write ();
425 if (vl_socket_client_read (1))
432 vl_socket_client_recv_fd_msg (int fds[], int n_fds, u32 wait)
434 socket_client_main_t *scm = &socket_client_main;
436 return clib_error_return (0, "no socket");
437 return vl_sock_api_recv_fd_msg (scm->client_socket.fd, fds, n_fds, wait);
441 * fd.io coding-style-patch-verification: ON
444 * eval: (c-set-style "gnu")