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/types.h>
25 #include <sys/socket.h>
28 #include <netinet/in.h>
35 #include <vppinfra/clib.h>
36 #include <vppinfra/vec.h>
37 #include <vppinfra/hash.h>
38 #include <vppinfra/bitmap.h>
39 #include <vppinfra/fifo.h>
40 #include <vppinfra/time.h>
41 #include <vppinfra/mheap.h>
42 #include <vppinfra/heap.h>
43 #include <vppinfra/pool.h>
44 #include <vppinfra/format.h>
46 #include <vlib/vlib.h>
47 #include <vlib/unix/unix.h>
48 #include <svm/memfd.h>
49 #include <vlibmemory/api.h>
51 #include <vlibmemory/vl_memory_msg_enum.h>
53 #define vl_typedefs /* define message structures */
54 #include <vlibmemory/vl_memory_api_h.h>
57 #define vl_endianfun /* define message structures */
58 #include <vlibmemory/vl_memory_api_h.h>
61 /* instantiate all the print functions we know about */
62 #define vl_print(handle, ...) clib_warning (__VA_ARGS__)
64 #include <vlibmemory/vl_memory_api_h.h>
67 socket_client_main_t socket_client_main;
70 u32 vl (void *p) __attribute__ ((weak));
79 vl_socket_client_read (int wait)
81 socket_client_main_t *scm = &socket_client_main;
82 int n, current_rx_index;
86 if (scm->socket_fd == 0)
90 timeout = clib_time_now (&scm->clib_time) + wait;
94 current_rx_index = vec_len (scm->socket_rx_buffer);
95 while (vec_len (scm->socket_rx_buffer) <
96 sizeof (*mbp) + 2 /* msg id */ )
98 vec_validate (scm->socket_rx_buffer, current_rx_index
99 + scm->socket_buffer_size - 1);
100 _vec_len (scm->socket_rx_buffer) = current_rx_index;
101 n = read (scm->socket_fd, scm->socket_rx_buffer + current_rx_index,
102 scm->socket_buffer_size);
105 clib_unix_warning ("socket_read");
108 _vec_len (scm->socket_rx_buffer) += n;
113 clib_warning ("read %d bytes", n);
117 mbp = (msgbuf_t *) (scm->socket_rx_buffer);
119 if (vec_len (scm->socket_rx_buffer) >= ntohl (mbp->data_len)
122 vl_msg_api_socket_handler ((void *) (mbp->data));
124 if (vec_len (scm->socket_rx_buffer) == ntohl (mbp->data_len)
126 _vec_len (scm->socket_rx_buffer) = 0;
128 vec_delete (scm->socket_rx_buffer, ntohl (mbp->data_len)
132 /* Quit if we're out of data, and not expecting a ping reply */
133 if (vec_len (scm->socket_rx_buffer) == 0
134 && scm->control_pings_outstanding == 0)
138 if (wait && clib_time_now (&scm->clib_time) >= timeout)
145 vl_socket_client_write (void)
147 socket_client_main_t *scm = &socket_client_main;
152 .gc_mark_timestamp = 0,
153 .data_len = htonl (scm->socket_tx_nbytes),
156 n = write (scm->socket_fd, &msgbuf, sizeof (msgbuf));
157 if (n < sizeof (msgbuf))
159 clib_unix_warning ("socket write (msgbuf)");
163 n = write (scm->socket_fd, scm->socket_tx_buffer, scm->socket_tx_nbytes);
164 if (n < scm->socket_tx_nbytes)
166 clib_unix_warning ("socket write (msg)");
174 vl_socket_client_msg_alloc (int nbytes)
176 socket_client_main.socket_tx_nbytes = nbytes;
177 return ((void *) socket_client_main.socket_tx_buffer);
181 vl_socket_client_disconnect (void)
183 socket_client_main_t *scm = &socket_client_main;
184 if (scm->socket_fd && (close (scm->socket_fd) < 0))
185 clib_unix_warning ("close");
190 vl_socket_client_enable_disable (int enable)
192 socket_client_main_t *scm = &socket_client_main;
193 scm->socket_enable = enable;
196 static clib_error_t *
197 receive_fd_msg (int socket_fd, int *my_fd)
200 char ctl[CMSG_SPACE (sizeof (int)) + CMSG_SPACE (sizeof (struct ucred))];
201 struct msghdr mh = { 0 };
204 struct ucred *cr = 0;
205 struct cmsghdr *cmsg;
206 pid_t pid __attribute__ ((unused));
207 uid_t uid __attribute__ ((unused));
208 gid_t gid __attribute__ ((unused));
210 iov[0].iov_base = msgbuf;
214 mh.msg_control = ctl;
215 mh.msg_controllen = sizeof (ctl);
217 memset (ctl, 0, sizeof (ctl));
219 /* receive the incoming message */
220 size = recvmsg (socket_fd, &mh, 0);
223 return (size == 0) ? clib_error_return (0, "disconnected") :
224 clib_error_return_unix (0, "recvmsg: malformed message (fd %d)",
228 cmsg = CMSG_FIRSTHDR (&mh);
231 if (cmsg->cmsg_level == SOL_SOCKET)
233 if (cmsg->cmsg_type == SCM_CREDENTIALS)
235 cr = (struct ucred *) CMSG_DATA (cmsg);
240 else if (cmsg->cmsg_type == SCM_RIGHTS)
242 clib_memcpy (my_fd, CMSG_DATA (cmsg), sizeof (int));
245 cmsg = CMSG_NXTHDR (&mh, cmsg);
250 static void vl_api_sock_init_shm_reply_t_handler
251 (vl_api_sock_init_shm_reply_t * mp)
253 socket_client_main_t *scm = &socket_client_main;
256 i32 retval = ntohl (mp->retval);
257 memfd_private_t memfd;
258 api_main_t *am = &api_main;
263 clib_warning ("failed to init shmem");
268 * Check the socket for the magic fd
270 error = receive_fd_msg (scm->socket_fd, &my_fd);
277 memset (&memfd, 0, sizeof (memfd));
280 /* Note: this closes memfd.fd */
281 retval = memfd_slave_init (&memfd);
283 clib_warning ("WARNING: segment map returned %d", retval);
286 * Pivot to the memory client segment that vpp just created
288 am->vlib_rp = (void *) (memfd.requested_va + MMAP_PAGESIZE);
289 am->shmem_hdr = (void *) am->vlib_rp->user_ctx;
291 new_name = format (0, "%v[shm]%c", scm->name, 0);
292 vl_client_install_client_message_handlers ();
293 vl_client_connect_to_vlib_no_map ("pvt", (char *) new_name,
294 32 /* input_queue_length */ );
295 vl_socket_client_enable_disable (0);
300 vl_api_sockclnt_create_reply_t_handler (vl_api_sockclnt_create_reply_t * mp)
302 socket_client_main_t *scm = &socket_client_main;
304 scm->socket_enable = 1;
307 #define foreach_sock_client_api_msg \
308 _(SOCKCLNT_CREATE_REPLY, sockclnt_create_reply) \
309 _(SOCK_INIT_SHM_REPLY, sock_init_shm_reply) \
312 noop_handler (void *notused)
317 vl_sock_client_install_message_handlers (void)
321 vl_msg_api_set_handlers(VL_API_##N, #n, \
322 vl_api_##n##_t_handler, \
324 vl_api_##n##_t_endian, \
325 vl_api_##n##_t_print, \
326 sizeof(vl_api_##n##_t), 1);
327 foreach_sock_client_api_msg;
332 vl_socket_client_connect (char *socket_path, char *client_name,
333 u32 socket_buffer_size)
335 socket_client_main_t *scm = &socket_client_main;
336 vl_api_sockclnt_create_t *mp;
340 /* Already connected? */
345 if (socket_path == 0 || client_name == 0)
348 sock = &scm->client_socket;
349 sock->config = socket_path;
350 sock->flags = CLIB_SOCKET_F_IS_CLIENT | CLIB_SOCKET_F_SEQPACKET;
352 if ((error = clib_socket_init (sock)))
354 clib_error_report (error);
358 vl_sock_client_install_message_handlers ();
360 scm->socket_fd = sock->fd;
361 scm->socket_buffer_size = socket_buffer_size ? socket_buffer_size :
362 SOCKET_CLIENT_DEFAULT_BUFFER_SIZE;
363 vec_validate (scm->socket_tx_buffer, scm->socket_buffer_size - 1);
364 vec_validate (scm->socket_rx_buffer, scm->socket_buffer_size - 1);
365 _vec_len (scm->socket_rx_buffer) = 0;
366 _vec_len (scm->socket_tx_buffer) = 0;
367 scm->name = format (0, "%s", client_name);
369 mp = vl_socket_client_msg_alloc (sizeof (*mp));
370 mp->_vl_msg_id = htons (VL_API_SOCKCLNT_CREATE);
371 strncpy ((char *) mp->name, client_name, sizeof (mp->name) - 1);
372 mp->name[sizeof (mp->name) - 1] = 0;
373 mp->context = 0xfeedface;
375 if (vl_socket_client_write () <= 0)
378 if (vl_socket_client_read (1))
381 clib_time_init (&scm->clib_time);
386 vl_socket_client_init_shm (vl_api_shm_elem_config_t * config)
388 vl_api_sock_init_shm_t *mp;
392 mp = vl_socket_client_msg_alloc (sizeof (*mp) +
393 vec_len (config) * sizeof (u64));
394 memset (mp, 0, sizeof (*mp));
395 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_SOCK_INIT_SHM);
396 mp->client_index = ~0;
397 mp->requested_size = 64 << 20;
401 for (i = 0; i < vec_len (config); i++)
403 cfg = (u64 *) & config[i];
404 mp->configs[i] = *cfg;
406 mp->nitems = vec_len (config);
408 rv = vl_socket_client_write ();
412 if (vl_socket_client_read (1))
419 * fd.io coding-style-patch-verification: ON
422 * eval: (c-set-style "gnu")