blob: a8423d11ccb30d8dd4f00a459ae16919180b08ab [file] [log] [blame]
Dave Barach59b25652017-09-10 15:04:27 -04001/*
2 *------------------------------------------------------------------
Ole Troan94495f22018-08-02 11:58:12 +02003 * socket_api.c
Dave Barach59b25652017-09-10 15:04:27 -04004 *
5 * Copyright (c) 2009 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:
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
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 *------------------------------------------------------------------
18 */
19
20#include <sys/types.h>
21#include <sys/socket.h>
22#include <netinet/in.h>
23#include <sys/ioctl.h>
Dave Barach59b25652017-09-10 15:04:27 -040024#include <fcntl.h>
25#include <sys/stat.h>
26
Florin Corase86a8ed2018-01-05 03:20:25 -080027#include <vppinfra/byte_order.h>
Florin Coras4d9b9d82018-01-14 12:25:50 -080028#include <svm/ssvm.h>
Dave Barach59b25652017-09-10 15:04:27 -040029#include <vlibmemory/api.h>
30
31#include <vlibmemory/vl_memory_msg_enum.h>
32
33#define vl_typedefs /* define message structures */
34#include <vlibmemory/vl_memory_api_h.h>
35#undef vl_typedefs
36
37/* instantiate all the print functions we know about */
38#define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
39#define vl_printfun
40#include <vlibmemory/vl_memory_api_h.h>
41#undef vl_printfun
42
43/* instantiate all the endian swap functions we know about */
44#define vl_endianfun
45#include <vlibmemory/vl_memory_api_h.h>
46#undef vl_endianfun
47
Florin Corase86a8ed2018-01-05 03:20:25 -080048socket_main_t socket_main;
49
Florin Coras2881dec2018-10-02 18:29:25 -070050#define SOCK_API_REG_HANDLE_BIT (1<<31)
51
52static u32
53sock_api_registration_handle (vl_api_registration_t * regp)
54{
55 ASSERT (regp->vl_api_registration_pool_index < SOCK_API_REG_HANDLE_BIT);
56 return regp->vl_api_registration_pool_index | SOCK_API_REG_HANDLE_BIT;
57}
58
59static u32
60socket_api_registration_handle_to_index (u32 reg_index)
61{
62 return (reg_index & ~SOCK_API_REG_HANDLE_BIT);
63}
64
65u8
66vl_socket_api_registration_handle_is_valid (u32 reg_handle)
67{
68 return ((reg_handle & SOCK_API_REG_HANDLE_BIT) != 0);
69}
70
Dave Barach59b25652017-09-10 15:04:27 -040071void
Florin Corase86a8ed2018-01-05 03:20:25 -080072vl_sock_api_dump_clients (vlib_main_t * vm, api_main_t * am)
Dave Barach59b25652017-09-10 15:04:27 -040073{
74 vl_api_registration_t *reg;
75 socket_main_t *sm = &socket_main;
Dave Barach59b25652017-09-10 15:04:27 -040076 clib_file_t *f;
77
78 /*
79 * Must have at least one active client, not counting the
80 * REGISTRATION_TYPE_SOCKET_LISTEN bind/accept socket
81 */
82 if (pool_elts (sm->registration_pool) < 2)
83 return;
84
85 vlib_cli_output (vm, "Socket clients");
Florin Coras90a63982017-12-19 04:50:01 -080086 vlib_cli_output (vm, "%20s %8s", "Name", "Fildesc");
Dave Barach59b25652017-09-10 15:04:27 -040087 /* *INDENT-OFF* */
88 pool_foreach (reg, sm->registration_pool,
89 ({
90 if (reg->registration_type == REGISTRATION_TYPE_SOCKET_SERVER) {
Florin Corasb384b542018-01-15 01:08:33 -080091 f = vl_api_registration_file (reg);
92 vlib_cli_output (vm, "%20s %8d", reg->name, f->file_descriptor);
Dave Barach59b25652017-09-10 15:04:27 -040093 }
94 }));
95/* *INDENT-ON* */
96}
97
Ole Troan94495f22018-08-02 11:58:12 +020098vl_api_registration_t *
Florin Coras2881dec2018-10-02 18:29:25 -070099vl_socket_api_client_handle_to_registration (u32 handle)
Ole Troan94495f22018-08-02 11:58:12 +0200100{
101 socket_main_t *sm = &socket_main;
Florin Coras2881dec2018-10-02 18:29:25 -0700102 u32 index = socket_api_registration_handle_to_index (handle);
103 if (pool_is_free_index (sm->registration_pool, index))
Ole Troan94495f22018-08-02 11:58:12 +0200104 {
105#if DEBUG > 2
Florin Coras2881dec2018-10-02 18:29:25 -0700106 clib_warning ("Invalid index %d\n", index);
Ole Troan94495f22018-08-02 11:58:12 +0200107#endif
108 return 0;
109 }
Florin Coras2881dec2018-10-02 18:29:25 -0700110 return pool_elt_at_index (sm->registration_pool, index);
Ole Troan94495f22018-08-02 11:58:12 +0200111}
112
Dave Barach59b25652017-09-10 15:04:27 -0400113void
114vl_socket_api_send (vl_api_registration_t * rp, u8 * elem)
115{
Dave Barach59b25652017-09-10 15:04:27 -0400116#if CLIB_DEBUG > 1
117 u32 output_length;
118#endif
Florin Coras90a63982017-12-19 04:50:01 -0800119 socket_main_t *sm = &socket_main;
120 u16 msg_id = ntohs (*(u16 *) elem);
121 api_main_t *am = &api_main;
122 msgbuf_t *mb = (msgbuf_t *) (elem - offsetof (msgbuf_t, data));
Florin Coras90a63982017-12-19 04:50:01 -0800123 vl_api_registration_t *sock_rp;
Florin Coras8023ad42018-08-02 12:16:03 -0700124 clib_file_main_t *fm = &file_main;
125 clib_error_t *error;
Florin Corasb384b542018-01-15 01:08:33 -0800126 clib_file_t *cf;
Dave Barach59b25652017-09-10 15:04:27 -0400127
Florin Corasb384b542018-01-15 01:08:33 -0800128 cf = vl_api_registration_file (rp);
Dave Barach59b25652017-09-10 15:04:27 -0400129 ASSERT (rp->registration_type > REGISTRATION_TYPE_SHMEM);
130
131 if (msg_id >= vec_len (am->api_trace_cfg))
132 {
133 clib_warning ("id out of range: %d", msg_id);
134 vl_msg_api_free ((void *) elem);
135 return;
136 }
137
Florin Coras90a63982017-12-19 04:50:01 -0800138 sock_rp = pool_elt_at_index (sm->registration_pool,
139 rp->vl_api_registration_pool_index);
140 ASSERT (sock_rp);
141
Dave Barach59b25652017-09-10 15:04:27 -0400142 /* Add the msgbuf_t to the output vector */
Florin Coras8023ad42018-08-02 12:16:03 -0700143 vec_add (sock_rp->output_vector, (u8 *) mb, sizeof (*mb));
144
145 /* Try to send the message and save any error like
146 * we do in the input epoll loop */
147 vec_add (sock_rp->output_vector, elem, ntohl (mb->data_len));
148 error = clib_file_write (cf);
149 unix_save_error (&unix_main, error);
150
151 /* If we didn't finish sending everything, wait for tx space */
152 if (vec_len (sock_rp->output_vector) > 0
153 && !(cf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE))
154 {
155 cf->flags |= UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
156 fm->file_update (cf, UNIX_FILE_UPDATE_MODIFY);
157 }
Dave Barach59b25652017-09-10 15:04:27 -0400158
159#if CLIB_DEBUG > 1
160 output_length = sizeof (*mb) + ntohl (mb->data_len);
161 clib_warning ("wrote %u bytes to fd %d", output_length,
162 cf->file_descriptor);
163#endif
164
165 vl_msg_api_free ((void *) elem);
166}
167
168void
Florin Corase86a8ed2018-01-05 03:20:25 -0800169vl_socket_free_registration_index (u32 pool_index)
Dave Barach59b25652017-09-10 15:04:27 -0400170{
171 int i;
172 vl_api_registration_t *rp;
173 if (pool_is_free_index (socket_main.registration_pool, pool_index))
174 {
175 clib_warning ("main pool index %d already free", pool_index);
176 return;
177 }
178 rp = pool_elt_at_index (socket_main.registration_pool, pool_index);
179
180 ASSERT (rp->registration_type != REGISTRATION_TYPE_FREE);
181 for (i = 0; i < vec_len (rp->additional_fds_to_close); i++)
182 if (close (rp->additional_fds_to_close[i]) < 0)
183 clib_unix_warning ("close");
184 vec_free (rp->additional_fds_to_close);
185 vec_free (rp->name);
186 vec_free (rp->unprocessed_input);
187 vec_free (rp->output_vector);
188 rp->registration_type = REGISTRATION_TYPE_FREE;
189 pool_put (socket_main.registration_pool, rp);
190}
191
192void
Florin Corase86a8ed2018-01-05 03:20:25 -0800193vl_socket_process_api_msg (clib_file_t * uf, vl_api_registration_t * rp,
Dave Barach59b25652017-09-10 15:04:27 -0400194 i8 * input_v)
195{
196 msgbuf_t *mbp = (msgbuf_t *) input_v;
197
198 u8 *the_msg = (u8 *) (mbp->data);
199 socket_main.current_uf = uf;
200 socket_main.current_rp = rp;
201 vl_msg_api_socket_handler (the_msg);
202 socket_main.current_uf = 0;
203 socket_main.current_rp = 0;
204}
205
206clib_error_t *
207vl_socket_read_ready (clib_file_t * uf)
208{
209 clib_file_main_t *fm = &file_main;
210 vlib_main_t *vm = vlib_get_main ();
211 vl_api_registration_t *rp;
212 int n;
213 i8 *msg_buffer = 0;
214 u8 *data_for_process;
215 u32 msg_len;
216 u32 save_input_buffer_length = vec_len (socket_main.input_buffer);
217 vl_socket_args_for_process_t *a;
218 msgbuf_t *mbp;
219 int mbp_set = 0;
220
221 rp = pool_elt_at_index (socket_main.registration_pool, uf->private_data);
222
223 n = read (uf->file_descriptor, socket_main.input_buffer,
224 vec_len (socket_main.input_buffer));
225
226 if (n <= 0 && errno != EAGAIN)
227 {
228 clib_file_del (fm, uf);
229
230 if (!pool_is_free (socket_main.registration_pool, rp))
231 {
232 u32 index = rp - socket_main.registration_pool;
Florin Corase86a8ed2018-01-05 03:20:25 -0800233 vl_socket_free_registration_index (index);
Dave Barach59b25652017-09-10 15:04:27 -0400234 }
235 else
236 {
237 clib_warning ("client index %d already free?",
238 rp->vl_api_registration_pool_index);
239 }
240 return 0;
241 }
242
243 _vec_len (socket_main.input_buffer) = n;
244
245 /*
246 * Look for bugs here. This code is tricky because
247 * data read from a stream socket does not honor message
248 * boundaries. In the case of a long message (>4K bytes)
249 * we have to do (at least) 2 reads, etc.
250 */
251 do
252 {
253 if (vec_len (rp->unprocessed_input))
254 {
255 vec_append (rp->unprocessed_input, socket_main.input_buffer);
256 msg_buffer = rp->unprocessed_input;
257 }
258 else
259 {
260 msg_buffer = socket_main.input_buffer;
261 mbp_set = 0;
262 }
263
264 if (mbp_set == 0)
265 {
266 /* Any chance that we have a complete message? */
267 if (vec_len (msg_buffer) <= sizeof (msgbuf_t))
268 goto save_and_split;
269
270 mbp = (msgbuf_t *) msg_buffer;
271 msg_len = ntohl (mbp->data_len);
272 mbp_set = 1;
273 }
274
275 /* We don't have the entire message yet. */
276 if (mbp_set == 0
277 || (msg_len + sizeof (msgbuf_t)) > vec_len (msg_buffer))
278 {
279 save_and_split:
280 /* if we were using the input buffer save the fragment */
281 if (msg_buffer == socket_main.input_buffer)
282 {
283 ASSERT (vec_len (rp->unprocessed_input) == 0);
284 vec_validate (rp->unprocessed_input, vec_len (msg_buffer) - 1);
Dave Barach178cf492018-11-13 16:34:13 -0500285 clib_memcpy_fast (rp->unprocessed_input, msg_buffer,
286 vec_len (msg_buffer));
Dave Barach59b25652017-09-10 15:04:27 -0400287 _vec_len (rp->unprocessed_input) = vec_len (msg_buffer);
288 }
289 _vec_len (socket_main.input_buffer) = save_input_buffer_length;
290 return 0;
291 }
292
293 data_for_process = (u8 *) vec_dup (msg_buffer);
294 _vec_len (data_for_process) = (msg_len + sizeof (msgbuf_t));
295 pool_get (socket_main.process_args, a);
296 a->clib_file = uf;
297 a->regp = rp;
298 a->data = data_for_process;
299
Florin Corase86a8ed2018-01-05 03:20:25 -0800300 vlib_process_signal_event (vm, vl_api_clnt_node.index,
Dave Barach59b25652017-09-10 15:04:27 -0400301 SOCKET_READ_EVENT,
302 a - socket_main.process_args);
303 if (n > (msg_len + sizeof (*mbp)))
304 vec_delete (msg_buffer, msg_len + sizeof (*mbp), 0);
305 else
306 _vec_len (msg_buffer) = 0;
307 n -= msg_len + sizeof (msgbuf_t);
308 msg_len = 0;
309 mbp_set = 0;
310 }
311 while (n > 0);
312
313 _vec_len (socket_main.input_buffer) = save_input_buffer_length;
314
315 return 0;
316}
317
Dave Barach59b25652017-09-10 15:04:27 -0400318clib_error_t *
319vl_socket_write_ready (clib_file_t * uf)
320{
321 clib_file_main_t *fm = &file_main;
322 vl_api_registration_t *rp;
323 int n;
324
325 rp = pool_elt_at_index (socket_main.registration_pool, uf->private_data);
326
327 /* Flush output vector. */
Ole Troan94495f22018-08-02 11:58:12 +0200328 size_t total_bytes = vec_len (rp->output_vector);
329 size_t bytes_to_send, remaining_bytes = total_bytes;
330 void *p = rp->output_vector;
331 while (remaining_bytes > 0)
Dave Barach59b25652017-09-10 15:04:27 -0400332 {
Ole Troan94495f22018-08-02 11:58:12 +0200333 bytes_to_send = remaining_bytes > 4096 ? 4096 : remaining_bytes;
334 n = write (uf->file_descriptor, p, bytes_to_send);
335 if (n < 0)
Florin Coras8023ad42018-08-02 12:16:03 -0700336 {
Ole Troan94495f22018-08-02 11:58:12 +0200337 if (errno == EAGAIN)
338 {
339 break;
340 }
341#if DEBUG > 2
342 clib_warning ("write error, close the file...\n");
343#endif
344 clib_file_del (fm, uf);
345 vl_socket_free_registration_index (rp -
346 socket_main.registration_pool);
347 return 0;
Florin Coras8023ad42018-08-02 12:16:03 -0700348 }
Ole Troan94495f22018-08-02 11:58:12 +0200349 remaining_bytes -= bytes_to_send;
350 p += bytes_to_send;
351 }
352
353 vec_delete (rp->output_vector, total_bytes - remaining_bytes, 0);
354 if (vec_len (rp->output_vector) <= 0
355 && (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE))
356 {
357 uf->flags &= ~UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
358 fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
Florin Coras8023ad42018-08-02 12:16:03 -0700359 }
Dave Barach59b25652017-09-10 15:04:27 -0400360
361 return 0;
362}
363
364clib_error_t *
365vl_socket_error_ready (clib_file_t * uf)
366{
367 vl_api_registration_t *rp;
368 clib_file_main_t *fm = &file_main;
369
370 rp = pool_elt_at_index (socket_main.registration_pool, uf->private_data);
371 clib_file_del (fm, uf);
Florin Corase86a8ed2018-01-05 03:20:25 -0800372 vl_socket_free_registration_index (rp - socket_main.registration_pool);
Dave Barach59b25652017-09-10 15:04:27 -0400373
374 return 0;
375}
376
377void
378socksvr_file_add (clib_file_main_t * fm, int fd)
379{
380 vl_api_registration_t *rp;
381 clib_file_t template = { 0 };
382
383 pool_get (socket_main.registration_pool, rp);
Dave Barachb7b92992018-10-17 10:38:51 -0400384 clib_memset (rp, 0, sizeof (*rp));
Dave Barach59b25652017-09-10 15:04:27 -0400385
386 template.read_function = vl_socket_read_ready;
387 template.write_function = vl_socket_write_ready;
388 template.error_function = vl_socket_error_ready;
389 template.file_descriptor = fd;
390 template.private_data = rp - socket_main.registration_pool;
391
392 rp->registration_type = REGISTRATION_TYPE_SOCKET_SERVER;
393 rp->vl_api_registration_pool_index = rp - socket_main.registration_pool;
394 rp->clib_file_index = clib_file_add (fm, &template);
395}
396
397static clib_error_t *
398socksvr_accept_ready (clib_file_t * uf)
399{
400 clib_file_main_t *fm = &file_main;
401 socket_main_t *sm = &socket_main;
402 clib_socket_t *sock = &sm->socksvr_listen_socket;
403 clib_socket_t client;
404 clib_error_t *error;
405
406 error = clib_socket_accept (sock, &client);
Dave Barach59b25652017-09-10 15:04:27 -0400407 if (error)
408 return error;
409
410 socksvr_file_add (fm, client.fd);
411 return 0;
412}
413
414static clib_error_t *
415socksvr_bogus_write (clib_file_t * uf)
416{
417 clib_warning ("why am I here?");
418 return 0;
419}
420
421/*
422 * vl_api_sockclnt_create_t_handler
423 */
424void
425vl_api_sockclnt_create_t_handler (vl_api_sockclnt_create_t * mp)
426{
427 vl_api_registration_t *regp;
428 vl_api_sockclnt_create_reply_t *rp;
Ole Troan94495f22018-08-02 11:58:12 +0200429 api_main_t *am = &api_main;
430 hash_pair_t *hp;
Florin Coras90a63982017-12-19 04:50:01 -0800431 int rv = 0;
Ole Troan94495f22018-08-02 11:58:12 +0200432 u32 nmsg = hash_elts (am->msg_index_by_name_and_crc);
433 u32 i = 0;
Dave Barach59b25652017-09-10 15:04:27 -0400434
435 regp = socket_main.current_rp;
436
437 ASSERT (regp->registration_type == REGISTRATION_TYPE_SOCKET_SERVER);
438
439 regp->name = format (0, "%s%c", mp->name, 0);
440
Ole Troan94495f22018-08-02 11:58:12 +0200441 u32 size = sizeof (*rp) + (nmsg * sizeof (vl_api_message_table_entry_t));
442 rp = vl_msg_api_alloc (size);
Dave Barach59b25652017-09-10 15:04:27 -0400443 rp->_vl_msg_id = htons (VL_API_SOCKCLNT_CREATE_REPLY);
Florin Coras2881dec2018-10-02 18:29:25 -0700444 rp->index = htonl (sock_api_registration_handle (regp));
Dave Barach59b25652017-09-10 15:04:27 -0400445 rp->context = mp->context;
446 rp->response = htonl (rv);
Ole Troan94495f22018-08-02 11:58:12 +0200447 rp->count = htons (nmsg);
Dave Barach59b25652017-09-10 15:04:27 -0400448
Ole Troan94495f22018-08-02 11:58:12 +0200449 /* *INDENT-OFF* */
450 hash_foreach_pair (hp, am->msg_index_by_name_and_crc,
451 ({
452 rp->message_table[i].index = htons(hp->value[0]);
453 strncpy((char *)rp->message_table[i].name, (char *)hp->key, 64-1);
454 i++;
455 }));
456 /* *INDENT-ON* */
Florin Corase86a8ed2018-01-05 03:20:25 -0800457 vl_api_send_msg (regp, (u8 *) rp);
Dave Barach59b25652017-09-10 15:04:27 -0400458}
459
460/*
461 * vl_api_sockclnt_delete_t_handler
462 */
463void
464vl_api_sockclnt_delete_t_handler (vl_api_sockclnt_delete_t * mp)
465{
466 vl_api_registration_t *regp;
467 vl_api_sockclnt_delete_reply_t *rp;
468
Ole Troan94495f22018-08-02 11:58:12 +0200469 regp = vl_api_client_index_to_registration (mp->client_index);
470 if (!regp)
471 return;
472
Ole Troan3c1cf2c2019-01-05 11:27:54 +0100473 u32 reg_index = socket_api_registration_handle_to_index (ntohl (mp->index));
Ole Troan94495f22018-08-02 11:58:12 +0200474 rp = vl_msg_api_alloc (sizeof (*rp));
475 rp->_vl_msg_id = htons (VL_API_SOCKCLNT_DELETE_REPLY);
476 rp->context = mp->context;
477
478 if (!pool_is_free_index (socket_main.registration_pool, reg_index))
Dave Barach59b25652017-09-10 15:04:27 -0400479 {
Dave Barach59b25652017-09-10 15:04:27 -0400480 rp->response = htonl (1);
Florin Corase86a8ed2018-01-05 03:20:25 -0800481 vl_api_send_msg (regp, (u8 *) rp);
Dave Barach59b25652017-09-10 15:04:27 -0400482
Florin Corasb384b542018-01-15 01:08:33 -0800483 vl_api_registration_del_file (regp);
Ole Troan94495f22018-08-02 11:58:12 +0200484 vl_socket_free_registration_index (reg_index);
Dave Barach59b25652017-09-10 15:04:27 -0400485 }
486 else
487 {
Ole Troan94495f22018-08-02 11:58:12 +0200488 clib_warning ("unknown client ID %d", reg_index);
489 rp->response = htonl (-1);
490 vl_api_send_msg (regp, (u8 *) rp);
Dave Barach59b25652017-09-10 15:04:27 -0400491 }
492}
493
Florin Corasb384b542018-01-15 01:08:33 -0800494clib_error_t *
Florin Coras466f2892018-08-03 02:50:43 -0700495vl_sock_api_send_fd_msg (int socket_fd, int fds[], int n_fds)
Dave Barach59b25652017-09-10 15:04:27 -0400496{
497 struct msghdr mh = { 0 };
498 struct iovec iov[1];
Florin Coras99368312018-08-02 10:45:44 -0700499 char ctl[CMSG_SPACE (sizeof (int) * n_fds)];
Florin Coras466f2892018-08-03 02:50:43 -0700500 struct cmsghdr *cmsg;
501 char *msg = "fdmsg";
Dave Barach59b25652017-09-10 15:04:27 -0400502 int rv;
503
504 iov[0].iov_base = msg;
505 iov[0].iov_len = strlen (msg);
506 mh.msg_iov = iov;
507 mh.msg_iovlen = 1;
508
Dave Barachb7b92992018-10-17 10:38:51 -0400509 clib_memset (&ctl, 0, sizeof (ctl));
Dave Barach59b25652017-09-10 15:04:27 -0400510 mh.msg_control = ctl;
511 mh.msg_controllen = sizeof (ctl);
512 cmsg = CMSG_FIRSTHDR (&mh);
Florin Coras466f2892018-08-03 02:50:43 -0700513 cmsg->cmsg_len = CMSG_LEN (sizeof (int) * n_fds);
Dave Barach59b25652017-09-10 15:04:27 -0400514 cmsg->cmsg_level = SOL_SOCKET;
515 cmsg->cmsg_type = SCM_RIGHTS;
Dave Barach178cf492018-11-13 16:34:13 -0500516 clib_memcpy_fast (CMSG_DATA (cmsg), fds, sizeof (int) * n_fds);
Dave Barach59b25652017-09-10 15:04:27 -0400517
518 rv = sendmsg (socket_fd, &mh, 0);
519 if (rv < 0)
520 return clib_error_return_unix (0, "sendmsg");
521 return 0;
522}
523
Florin Coras90a63982017-12-19 04:50:01 -0800524vl_api_shm_elem_config_t *
525vl_api_make_shm_config (vl_api_sock_init_shm_t * mp)
526{
527 vl_api_shm_elem_config_t *config = 0, *c;
528 u64 cfg;
529 int i;
530
531 if (!mp->nitems)
532 {
Dave Barach78958722018-05-10 16:44:27 -0400533 vec_validate (config, 6);
Florin Coras90a63982017-12-19 04:50:01 -0800534 config[0].type = VL_API_VLIB_RING;
Florin Coras90a63982017-12-19 04:50:01 -0800535 config[0].size = 256;
Dave Barach78958722018-05-10 16:44:27 -0400536 config[0].count = 32;
537
538 config[1].type = VL_API_VLIB_RING;
Florin Coras90a63982017-12-19 04:50:01 -0800539 config[1].size = 1024;
Dave Barach78958722018-05-10 16:44:27 -0400540 config[1].count = 16;
541
542 config[2].type = VL_API_VLIB_RING;
Florin Coras90a63982017-12-19 04:50:01 -0800543 config[2].size = 4096;
Dave Barach78958722018-05-10 16:44:27 -0400544 config[2].count = 2;
545
546 config[3].type = VL_API_CLIENT_RING;
547 config[3].size = 256;
548 config[3].count = 32;
549
550 config[4].type = VL_API_CLIENT_RING;
551 config[4].size = 1024;
552 config[4].count = 16;
553
554 config[5].type = VL_API_CLIENT_RING;
555 config[5].size = 4096;
556 config[5].count = 2;
557
558 config[6].type = VL_API_QUEUE;
559 config[6].count = 128;
560 config[6].size = sizeof (uword);
Florin Coras90a63982017-12-19 04:50:01 -0800561 }
562 else
563 {
564 vec_validate (config, mp->nitems - 1);
565 for (i = 0; i < mp->nitems; i++)
566 {
567 cfg = mp->configs[i];
568 /* Pretty much a hack but it avoids defining our own api type
569 * in memclnt.api */
570 c = (vl_api_shm_elem_config_t *) & cfg;
571 config[i].type = c->type;
572 config[i].count = c->count;
573 config[i].size = c->size;
574 }
575 }
576 return config;
577}
578
Dave Barach59b25652017-09-10 15:04:27 -0400579/*
Florin Coras90a63982017-12-19 04:50:01 -0800580 * Bootstrap shm api using the socket api
Dave Barach59b25652017-09-10 15:04:27 -0400581 */
582void
Florin Coras90a63982017-12-19 04:50:01 -0800583vl_api_sock_init_shm_t_handler (vl_api_sock_init_shm_t * mp)
Dave Barach59b25652017-09-10 15:04:27 -0400584{
Florin Coras90a63982017-12-19 04:50:01 -0800585 vl_api_sock_init_shm_reply_t *rmp;
Florin Coras4d9b9d82018-01-14 12:25:50 -0800586 ssvm_private_t _memfd_private, *memfd = &_memfd_private;
Dave Barach59b25652017-09-10 15:04:27 -0400587 svm_map_region_args_t _args, *a = &_args;
Florin Coras90a63982017-12-19 04:50:01 -0800588 vl_api_registration_t *regp;
589 api_main_t *am = &api_main;
Dave Barach59b25652017-09-10 15:04:27 -0400590 svm_region_t *vlib_rp;
Florin Coras90a63982017-12-19 04:50:01 -0800591 clib_file_t *cf;
592 vl_api_shm_elem_config_t *config = 0;
Florin Corasb384b542018-01-15 01:08:33 -0800593 vl_shmem_hdr_t *shmem_hdr;
Dave Barach59b25652017-09-10 15:04:27 -0400594 int rv;
595
596 regp = vl_api_client_index_to_registration (mp->client_index);
Dave Barach59b25652017-09-10 15:04:27 -0400597 if (regp == 0)
598 {
599 clib_warning ("API client disconnected");
600 return;
601 }
Dave Barach59b25652017-09-10 15:04:27 -0400602 if (regp->registration_type != REGISTRATION_TYPE_SOCKET_SERVER)
603 {
604 rv = -31; /* VNET_API_ERROR_INVALID_REGISTRATION */
605 goto reply;
606 }
607
Florin Coras90a63982017-12-19 04:50:01 -0800608 /*
609 * Set up a memfd segment of the requested size wherein the
610 * shmem data structures will be initialized
611 */
Dave Barachb7b92992018-10-17 10:38:51 -0400612 clib_memset (memfd, 0, sizeof (*memfd));
Florin Coras4d9b9d82018-01-14 12:25:50 -0800613 memfd->ssvm_size = mp->requested_size;
Dave Barach59b25652017-09-10 15:04:27 -0400614 memfd->requested_va = 0ULL;
615 memfd->i_am_master = 1;
616 memfd->name = format (0, "%s%c", regp->name, 0);
617
Florin Corasb384b542018-01-15 01:08:33 -0800618 if ((rv = ssvm_master_init_memfd (memfd)))
Dave Barach59b25652017-09-10 15:04:27 -0400619 goto reply;
620
621 /* Remember to close this fd when the socket connection goes away */
622 vec_add1 (regp->additional_fds_to_close, memfd->fd);
623
Florin Coras90a63982017-12-19 04:50:01 -0800624 /*
625 * Create a plausible svm_region in the memfd backed segment
626 */
Dave Barachb7b92992018-10-17 10:38:51 -0400627 clib_memset (a, 0, sizeof (*a));
Florin Coras4d9b9d82018-01-14 12:25:50 -0800628 a->baseva = memfd->sh->ssvm_va + MMAP_PAGESIZE;
629 a->size = memfd->ssvm_size - MMAP_PAGESIZE;
Dave Barach59b25652017-09-10 15:04:27 -0400630 /* $$$$ might want a different config parameter */
631 a->pvt_heap_size = am->api_pvt_heap_size;
632 a->flags = SVM_FLAGS_MHEAP;
633 svm_region_init_mapped_region (a, (svm_region_t *) a->baseva);
634
Dave Barach59b25652017-09-10 15:04:27 -0400635 /*
636 * Part deux, initialize the svm_region_t shared-memory header
637 * api allocation rings, and so on.
638 */
Florin Coras90a63982017-12-19 04:50:01 -0800639 config = vl_api_make_shm_config (mp);
640 vlib_rp = (svm_region_t *) a->baseva;
641 vl_init_shmem (vlib_rp, config, 1 /* is_vlib (dont-care) */ ,
642 1 /* is_private */ );
Florin Corasb384b542018-01-15 01:08:33 -0800643
644 /* Remember who created this. Needs to be post vl_init_shmem */
645 shmem_hdr = (vl_shmem_hdr_t *) vlib_rp->user_ctx;
646 shmem_hdr->clib_file_index = vl_api_registration_file_index (regp);
647
Dave Barach59b25652017-09-10 15:04:27 -0400648 vec_add1 (am->vlib_private_rps, vlib_rp);
Dave Barach59b25652017-09-10 15:04:27 -0400649 memfd->sh->ready = 1;
Florin Coras90a63982017-12-19 04:50:01 -0800650 vec_free (config);
Dave Barach59b25652017-09-10 15:04:27 -0400651
652 /* Recompute the set of input queues to poll in memclnt_process */
653 vec_reset_length (vl_api_queue_cursizes);
654
655reply:
656
Florin Coras90a63982017-12-19 04:50:01 -0800657 rmp = vl_msg_api_alloc (sizeof (*rmp));
658 rmp->_vl_msg_id = htons (VL_API_SOCK_INIT_SHM_REPLY);
659 rmp->context = mp->context;
660 rmp->retval = htonl (rv);
661
Florin Coras8023ad42018-08-02 12:16:03 -0700662 /*
663 * Note: The reply message needs to make it out the back door
664 * before we send the magic fd message. That's taken care of by
665 * the send function.
666 */
667 vl_socket_api_send (regp, (u8 *) rmp);
Florin Coras90a63982017-12-19 04:50:01 -0800668
669 if (rv != 0)
670 return;
671
Florin Coras90a63982017-12-19 04:50:01 -0800672 /* Send the magic "here's your sign (aka fd)" socket message */
Florin Coras8023ad42018-08-02 12:16:03 -0700673 cf = vl_api_registration_file (regp);
Florin Coras466f2892018-08-03 02:50:43 -0700674 vl_sock_api_send_fd_msg (cf->file_descriptor, &memfd->fd, 1);
Florin Coras90a63982017-12-19 04:50:01 -0800675}
676
Florin Coras90a63982017-12-19 04:50:01 -0800677#define foreach_vlib_api_msg \
678_(SOCKCLNT_CREATE, sockclnt_create) \
679_(SOCKCLNT_DELETE, sockclnt_delete) \
Dave Barach78958722018-05-10 16:44:27 -0400680_(SOCK_INIT_SHM, sock_init_shm)
Dave Barach59b25652017-09-10 15:04:27 -0400681
682clib_error_t *
Florin Corase86a8ed2018-01-05 03:20:25 -0800683vl_sock_api_init (vlib_main_t * vm)
Dave Barach59b25652017-09-10 15:04:27 -0400684{
685 clib_file_main_t *fm = &file_main;
686 clib_file_t template = { 0 };
687 vl_api_registration_t *rp;
Dave Barach59b25652017-09-10 15:04:27 -0400688 socket_main_t *sm = &socket_main;
689 clib_socket_t *sock = &sm->socksvr_listen_socket;
690 clib_error_t *error;
691
692 /* If not explicitly configured, do not bind/enable, etc. */
693 if (sm->socket_name == 0)
694 return 0;
695
Florin Coras90a63982017-12-19 04:50:01 -0800696#define _(N,n) \
697 vl_msg_api_set_handlers(VL_API_##N, #n, \
698 vl_api_##n##_t_handler, \
699 vl_noop_handler, \
700 vl_api_##n##_t_endian, \
701 vl_api_##n##_t_print, \
702 sizeof(vl_api_##n##_t), 1);
Dave Barach59b25652017-09-10 15:04:27 -0400703 foreach_vlib_api_msg;
704#undef _
705
706 vec_resize (sm->input_buffer, 4096);
707
708 sock->config = (char *) sm->socket_name;
709
710 /* mkdir of file socket, only under /run */
711 if (strncmp (sock->config, "/run", 4) == 0)
712 {
713 u8 *tmp = format (0, "%s", sock->config);
714 int i = vec_len (tmp);
715 while (i && tmp[--i] != '/')
716 ;
717
718 tmp[i] = 0;
719
720 if (i)
721 vlib_unix_recursive_mkdir ((char *) tmp);
722 vec_free (tmp);
723 }
724
725 sock->flags = CLIB_SOCKET_F_IS_SERVER | CLIB_SOCKET_F_SEQPACKET |
726 CLIB_SOCKET_F_ALLOW_GROUP_WRITE;
727 error = clib_socket_init (sock);
728 if (error)
729 return error;
730
731 pool_get (sm->registration_pool, rp);
Dave Barachb7b92992018-10-17 10:38:51 -0400732 clib_memset (rp, 0, sizeof (*rp));
Dave Barach59b25652017-09-10 15:04:27 -0400733
734 rp->registration_type = REGISTRATION_TYPE_SOCKET_LISTEN;
735
736 template.read_function = socksvr_accept_ready;
737 template.write_function = socksvr_bogus_write;
738 template.file_descriptor = sock->fd;
739 template.private_data = rp - sm->registration_pool;
740
741 rp->clib_file_index = clib_file_add (fm, &template);
742 return 0;
743}
744
745static clib_error_t *
746socket_exit (vlib_main_t * vm)
747{
Dave Barach59b25652017-09-10 15:04:27 -0400748 socket_main_t *sm = &socket_main;
749 vl_api_registration_t *rp;
750
751 /* Defensive driving in case something wipes out early */
752 if (sm->registration_pool)
753 {
754 u32 index;
755 /* *INDENT-OFF* */
756 pool_foreach (rp, sm->registration_pool, ({
Florin Corasb384b542018-01-15 01:08:33 -0800757 vl_api_registration_del_file (rp);
758 index = rp->vl_api_registration_pool_index;
759 vl_socket_free_registration_index (index);
Dave Barach59b25652017-09-10 15:04:27 -0400760 }));
761/* *INDENT-ON* */
762 }
763
764 return 0;
765}
766
767VLIB_MAIN_LOOP_EXIT_FUNCTION (socket_exit);
768
769static clib_error_t *
770socksvr_config (vlib_main_t * vm, unformat_input_t * input)
771{
772 socket_main_t *sm = &socket_main;
773
774 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
775 {
776 if (unformat (input, "socket-name %s", &sm->socket_name))
777 ;
778 else if (unformat (input, "default"))
779 {
780 sm->socket_name = format (0, "%s%c", API_SOCKET_FILE, 0);
781 }
782 else
783 {
784 return clib_error_return (0, "unknown input '%U'",
785 format_unformat_error, input);
786 }
787 }
788 return 0;
789}
790
791VLIB_CONFIG_FUNCTION (socksvr_config, "socksvr");
792
793clib_error_t *
794vlibsocket_init (vlib_main_t * vm)
795{
796 return 0;
797}
798
799VLIB_INIT_FUNCTION (vlibsocket_init);
800
801/*
802 * fd.io coding-style-patch-verification: ON
803 *
804 * Local Variables:
805 * eval: (c-set-style "gnu")
806 * End:
807 */