2 *------------------------------------------------------------------
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:
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 *------------------------------------------------------------------
20 #include <sys/types.h>
21 #include <sys/socket.h>
22 #include <netinet/in.h>
23 #include <sys/ioctl.h>
27 #include <vppinfra/byte_order.h>
29 #include <vlibmemory/api.h>
31 #include <vlibmemory/vl_memory_msg_enum.h>
33 #define vl_typedefs /* define message structures */
34 #include <vlibmemory/vl_memory_api_h.h>
37 /* instantiate all the print functions we know about */
38 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
40 #include <vlibmemory/vl_memory_api_h.h>
43 /* instantiate all the endian swap functions we know about */
45 #include <vlibmemory/vl_memory_api_h.h>
48 socket_main_t socket_main;
50 #define SOCK_API_REG_HANDLE_BIT (1<<31)
53 sock_api_registration_handle (vl_api_registration_t * regp)
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;
60 socket_api_registration_handle_to_index (u32 reg_index)
62 return (reg_index & ~SOCK_API_REG_HANDLE_BIT);
66 vl_socket_api_registration_handle_is_valid (u32 reg_handle)
68 return ((reg_handle & SOCK_API_REG_HANDLE_BIT) != 0);
72 vl_sock_api_dump_clients (vlib_main_t * vm, api_main_t * am)
74 vl_api_registration_t *reg;
75 socket_main_t *sm = &socket_main;
79 * Must have at least one active client, not counting the
80 * REGISTRATION_TYPE_SOCKET_LISTEN bind/accept socket
82 if (pool_elts (sm->registration_pool) < 2)
85 vlib_cli_output (vm, "Socket clients");
86 vlib_cli_output (vm, "%20s %8s", "Name", "Fildesc");
88 pool_foreach (reg, sm->registration_pool)
90 if (reg->registration_type == REGISTRATION_TYPE_SOCKET_SERVER) {
91 f = vl_api_registration_file (reg);
92 vlib_cli_output (vm, "%20s %8d", reg->name, f->file_descriptor);
98 vl_api_registration_t *
99 vl_socket_api_client_handle_to_registration (u32 handle)
101 socket_main_t *sm = &socket_main;
102 u32 index = socket_api_registration_handle_to_index (handle);
103 if (pool_is_free_index (sm->registration_pool, index))
106 clib_warning ("Invalid index %d\n", index);
110 return pool_elt_at_index (sm->registration_pool, index);
114 vl_socket_api_send (vl_api_registration_t * rp, u8 * elem)
119 socket_main_t *sm = &socket_main;
120 u16 msg_id = ntohs (*(u16 *) elem);
121 api_main_t *am = vlibapi_get_main ();
122 msgbuf_t *mb = (msgbuf_t *) (elem - offsetof (msgbuf_t, data));
123 vl_api_registration_t *sock_rp;
124 clib_file_main_t *fm = &file_main;
128 cf = vl_api_registration_file (rp);
129 ASSERT (rp->registration_type > REGISTRATION_TYPE_SHMEM);
131 if (msg_id >= vec_len (am->api_trace_cfg))
133 clib_warning ("id out of range: %d", msg_id);
134 vl_msg_api_free ((void *) elem);
138 sock_rp = pool_elt_at_index (sm->registration_pool,
139 rp->vl_api_registration_pool_index);
142 /* Add the msgbuf_t to the output vector */
143 vec_add (sock_rp->output_vector, (u8 *) mb, sizeof (*mb));
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);
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))
155 cf->flags |= UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
156 fm->file_update (cf, UNIX_FILE_UPDATE_MODIFY);
160 output_length = sizeof (*mb) + ntohl (mb->data_len);
161 clib_warning ("wrote %u bytes to fd %d", output_length,
162 cf->file_descriptor);
165 vl_msg_api_free ((void *) elem);
169 vl_socket_free_registration_index (u32 pool_index)
172 vl_api_registration_t *rp;
173 void vl_api_call_reaper_functions (u32 client_index);
175 if (pool_is_free_index (socket_main.registration_pool, pool_index))
177 clib_warning ("main pool index %d already free", pool_index);
180 rp = pool_elt_at_index (socket_main.registration_pool, pool_index);
182 vl_api_call_reaper_functions (pool_index);
184 ASSERT (rp->registration_type != REGISTRATION_TYPE_FREE);
185 for (i = 0; i < vec_len (rp->additional_fds_to_close); i++)
186 if (close (rp->additional_fds_to_close[i]) < 0)
187 clib_unix_warning ("close");
188 vec_free (rp->additional_fds_to_close);
190 vec_free (rp->unprocessed_input);
191 vec_free (rp->output_vector);
192 rp->registration_type = REGISTRATION_TYPE_FREE;
193 pool_put (socket_main.registration_pool, rp);
197 vl_socket_process_api_msg (vl_api_registration_t * rp, i8 * input_v)
199 msgbuf_t *mbp = (msgbuf_t *) input_v;
201 u8 *the_msg = (u8 *) (mbp->data);
202 socket_main.current_rp = rp;
203 vl_msg_api_socket_handler (the_msg);
204 socket_main.current_rp = 0;
208 is_being_removed_reg_index (u32 reg_index)
210 vl_api_registration_t *rp = vl_socket_get_registration (reg_index);
211 ALWAYS_ASSERT (rp != 0);
212 return (rp->is_being_removed);
216 socket_cleanup_pending_remove_registration_cb (u32 *preg_index)
218 vl_api_registration_t *rp = vl_socket_get_registration (*preg_index);
219 clib_file_main_t *fm = &file_main;
220 u32 pending_remove_file_index = vl_api_registration_file_index (rp);
222 clib_file_t *zf = fm->file_pool + pending_remove_file_index;
224 clib_file_del (fm, zf);
225 vl_socket_free_registration_index (rp - socket_main.registration_pool);
229 vl_socket_request_remove_reg_index (u32 reg_index)
231 vl_api_registration_t *rp = vl_socket_get_registration (reg_index);
232 ALWAYS_ASSERT (rp != 0);
233 if (rp->is_being_removed)
237 rp->is_being_removed = 1;
238 vl_api_force_rpc_call_main_thread (
239 socket_cleanup_pending_remove_registration_cb, (void *) ®_index,
244 * Read function for API socket.
246 * Read data from socket, invoke SOCKET_READ_EVENT
247 * for each fully read API message, return 0.
248 * Store incomplete data for next invocation to continue.
250 * On severe read error, the file is closed.
252 * As reading is single threaded,
253 * socket_main.input_buffer is used temporarily.
254 * Even its length is modified, but always restored before return.
256 * Incomplete data is copied into a vector,
257 * pointer saved in registration's unprocessed_input.
260 vl_socket_read_ready (clib_file_t * uf)
262 vlib_main_t *vm = vlib_get_main ();
263 vl_api_registration_t *rp;
264 /* n is the size of data read to input_buffer */
266 /* msg_buffer vector can point to input_buffer or unprocessed_input */
268 /* data_for_process is a vector containing one full message, incl msgbuf_t */
269 u8 *data_for_process;
270 /* msgbuf_len is the size of one message, including sizeof (msgbuf_t) */
272 u32 save_input_buffer_length = vec_len (socket_main.input_buffer);
273 vl_socket_args_for_process_t *a;
274 u32 reg_index = uf->private_data;
275 if (is_being_removed_reg_index (reg_index))
280 rp = vl_socket_get_registration (reg_index);
282 /* Ignore unprocessed_input for now, n describes input_buffer for now. */
283 n = read (uf->file_descriptor, socket_main.input_buffer,
284 vec_len (socket_main.input_buffer));
290 /* Severe error, close the file. */
291 vl_socket_request_remove_reg_index (reg_index);
293 /* EAGAIN means we do not close the file, but no data to process anyway. */
297 /* Fake smaller length teporarily, so input_buffer can be used as msg_buffer. */
298 vec_set_len (socket_main.input_buffer, n);
301 * Look for bugs here. This code is tricky because
302 * data read from a stream socket does not honor message
303 * boundaries. In the case of a long message (>4K bytes)
304 * we have to do (at least) 2 reads, etc.
306 /* Determine msg_buffer. */
307 if (vec_len (rp->unprocessed_input))
309 vec_append (rp->unprocessed_input, socket_main.input_buffer);
310 msg_buffer = rp->unprocessed_input;
314 msg_buffer = socket_main.input_buffer;
316 /* Loop to process any full messages. */
317 ASSERT (vec_len (msg_buffer) > 0);
320 /* Here, we are not sure how big a chunk of message we have left. */
321 /* Do we at least know how big the full message will be? */
322 if (vec_len (msg_buffer) <= sizeof (msgbuf_t))
323 /* No, so fragment is not a full message. */
326 /* Now we know how big the full message will be. */
328 ntohl (((msgbuf_t *) msg_buffer)->data_len) + sizeof (msgbuf_t);
330 /* But do we have a full message? */
331 if (msgbuf_len > vec_len (msg_buffer))
334 /* We don't have the entire message yet. */
335 /* If msg_buffer is unprocessed_input, nothing needs to be done. */
336 if (msg_buffer == socket_main.input_buffer)
337 /* But if we were using the input buffer, save the fragment. */
339 ASSERT (vec_len (rp->unprocessed_input) == 0);
340 vec_validate (rp->unprocessed_input, vec_len (msg_buffer) - 1);
341 clib_memcpy_fast (rp->unprocessed_input, msg_buffer,
342 vec_len (msg_buffer));
343 vec_set_len (rp->unprocessed_input, vec_len (msg_buffer));
345 /* No more full messages, restore original input_buffer length. */
346 vec_set_len (socket_main.input_buffer, save_input_buffer_length);
351 * We have at least one full message.
352 * But msg_buffer can contain more data, so copy one message data
353 * so we can overwrite its length to what single message has.
355 data_for_process = (u8 *) vec_dup (msg_buffer);
356 vec_set_len (data_for_process, msgbuf_len);
357 /* Everything is ready to signal the SOCKET_READ_EVENT. */
358 pool_get (socket_main.process_args, a);
359 a->reg_index = reg_index;
360 a->data = data_for_process;
362 vlib_process_signal_event (vm, vl_api_clnt_node.index,
364 a - socket_main.process_args);
365 if (vec_len (msg_buffer) > msgbuf_len)
366 /* There are some fragments left. Shrink the msg_buffer to simplify logic. */
367 vec_delete (msg_buffer, msgbuf_len, 0);
369 /* We are done with msg_buffer. */
370 vec_set_len (msg_buffer, 0);
372 while (vec_len (msg_buffer) > 0);
374 /* Restore input_buffer, it could have been msg_buffer. */
375 vec_set_len (socket_main.input_buffer, save_input_buffer_length);
380 vl_socket_write_ready (clib_file_t * uf)
382 clib_file_main_t *fm = &file_main;
383 vl_api_registration_t *rp;
386 u32 reg_index = uf->private_data;
387 if (is_being_removed_reg_index (reg_index))
392 rp = pool_elt_at_index (socket_main.registration_pool, reg_index);
394 /* Flush output vector. */
395 size_t total_bytes = vec_len (rp->output_vector);
396 size_t bytes_to_send, remaining_bytes = total_bytes;
397 void *p = rp->output_vector;
398 while (remaining_bytes > 0)
400 bytes_to_send = remaining_bytes > 4096 ? 4096 : remaining_bytes;
401 n = write (uf->file_descriptor, p, bytes_to_send);
409 clib_warning ("write error, close the file...\n");
411 vl_socket_request_remove_reg_index (reg_index);
414 remaining_bytes -= bytes_to_send;
418 vec_delete (rp->output_vector, total_bytes - remaining_bytes, 0);
419 if (vec_len (rp->output_vector) <= 0
420 && (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE))
422 uf->flags &= ~UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
423 fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
430 vl_socket_error_ready (clib_file_t * uf)
432 u32 reg_index = uf->private_data;
433 vl_socket_request_remove_reg_index (reg_index);
438 socksvr_file_add (clib_file_main_t * fm, int fd)
440 vl_api_registration_t *rp;
441 clib_file_t template = { 0 };
443 pool_get (socket_main.registration_pool, rp);
444 clib_memset (rp, 0, sizeof (*rp));
446 template.read_function = vl_socket_read_ready;
447 template.write_function = vl_socket_write_ready;
448 template.error_function = vl_socket_error_ready;
449 template.file_descriptor = fd;
450 template.description = format (0, "socksrv");
451 template.private_data = rp - socket_main.registration_pool;
453 rp->registration_type = REGISTRATION_TYPE_SOCKET_SERVER;
454 rp->vl_api_registration_pool_index = rp - socket_main.registration_pool;
455 rp->clib_file_index = clib_file_add (fm, &template);
458 static clib_error_t *
459 socksvr_accept_ready (clib_file_t * uf)
461 clib_file_main_t *fm = &file_main;
462 socket_main_t *sm = &socket_main;
463 clib_socket_t *sock = &sm->socksvr_listen_socket;
464 clib_socket_t client;
467 error = clib_socket_accept (sock, &client);
471 socksvr_file_add (fm, client.fd);
475 static clib_error_t *
476 socksvr_bogus_write (clib_file_t * uf)
478 clib_warning ("why am I here?");
483 * vl_api_sockclnt_create_t_handler
486 vl_api_sockclnt_create_t_handler (vl_api_sockclnt_create_t * mp)
488 vl_api_registration_t *regp;
489 vl_api_sockclnt_create_reply_t *rp;
490 api_main_t *am = vlibapi_get_main ();
493 u32 nmsg = hash_elts (am->msg_index_by_name_and_crc);
496 regp = socket_main.current_rp;
498 ASSERT (regp->registration_type == REGISTRATION_TYPE_SOCKET_SERVER);
500 regp->name = format (0, "%s%c", mp->name, 0);
502 u32 size = sizeof (*rp) + (nmsg * sizeof (vl_api_message_table_entry_t));
503 rp = vl_msg_api_alloc_zero (size);
504 rp->_vl_msg_id = htons (VL_API_SOCKCLNT_CREATE_REPLY);
505 rp->index = htonl (sock_api_registration_handle (regp));
506 rp->context = mp->context;
507 rp->response = htonl (rv);
508 rp->count = htons (nmsg);
511 hash_foreach_pair (hp, am->msg_index_by_name_and_crc,
513 rp->message_table[i].index = htons(hp->value[0]);
514 (void) strncpy_s((char *)rp->message_table[i].name,
515 64 /* bytes of space at dst */,
517 64-1 /* chars to copy, without zero byte. */);
521 vl_api_send_msg (regp, (u8 *) rp);
525 * vl_api_sockclnt_delete_t_handler
528 vl_api_sockclnt_delete_t_handler (vl_api_sockclnt_delete_t * mp)
530 vl_api_registration_t *regp;
531 vl_api_sockclnt_delete_reply_t *rp;
533 regp = vl_api_client_index_to_registration (mp->client_index);
537 u32 reg_index = socket_api_registration_handle_to_index (ntohl (mp->index));
538 rp = vl_msg_api_alloc (sizeof (*rp));
539 rp->_vl_msg_id = htons (VL_API_SOCKCLNT_DELETE_REPLY);
540 rp->context = mp->context;
542 if (!pool_is_free_index (socket_main.registration_pool, reg_index))
544 rp->response = htonl (1);
545 vl_api_send_msg (regp, (u8 *) rp);
547 vl_api_registration_del_file (regp);
548 vl_socket_free_registration_index (reg_index);
552 clib_warning ("unknown client ID %d", reg_index);
553 rp->response = htonl (-1);
554 vl_api_send_msg (regp, (u8 *) rp);
559 vl_sock_api_send_fd_msg (int socket_fd, int fds[], int n_fds)
561 struct msghdr mh = { 0 };
563 char ctl[CMSG_SPACE (sizeof (int) * n_fds)];
564 struct cmsghdr *cmsg;
568 iov[0].iov_base = msg;
569 iov[0].iov_len = strlen (msg);
573 clib_memset (&ctl, 0, sizeof (ctl));
574 mh.msg_control = ctl;
575 mh.msg_controllen = sizeof (ctl);
576 cmsg = CMSG_FIRSTHDR (&mh);
577 cmsg->cmsg_len = CMSG_LEN (sizeof (int) * n_fds);
578 cmsg->cmsg_level = SOL_SOCKET;
579 cmsg->cmsg_type = SCM_RIGHTS;
580 clib_memcpy_fast (CMSG_DATA (cmsg), fds, sizeof (int) * n_fds);
582 while ((rv = sendmsg (socket_fd, &mh, 0)) < 0 && errno == EAGAIN)
585 return clib_error_return_unix (0, "sendmsg");
589 vl_api_shm_elem_config_t *
590 vl_api_make_shm_config (vl_api_sock_init_shm_t * mp)
592 vl_api_shm_elem_config_t *config = 0, *c;
598 vec_validate (config, 6);
599 config[0].type = VL_API_VLIB_RING;
600 config[0].size = 256;
601 config[0].count = 32;
603 config[1].type = VL_API_VLIB_RING;
604 config[1].size = 1024;
605 config[1].count = 16;
607 config[2].type = VL_API_VLIB_RING;
608 config[2].size = 4096;
611 config[3].type = VL_API_CLIENT_RING;
612 config[3].size = 256;
613 config[3].count = 32;
615 config[4].type = VL_API_CLIENT_RING;
616 config[4].size = 1024;
617 config[4].count = 16;
619 config[5].type = VL_API_CLIENT_RING;
620 config[5].size = 4096;
623 config[6].type = VL_API_QUEUE;
624 config[6].count = 128;
625 config[6].size = sizeof (uword);
629 vec_validate (config, mp->nitems - 1);
630 for (i = 0; i < mp->nitems; i++)
632 cfg = mp->configs[i];
633 /* Pretty much a hack but it avoids defining our own api type
635 c = (vl_api_shm_elem_config_t *) & cfg;
636 config[i].type = c->type;
637 config[i].count = c->count;
638 config[i].size = c->size;
645 * Bootstrap shm api using the socket api
648 vl_api_sock_init_shm_t_handler (vl_api_sock_init_shm_t * mp)
650 vl_api_sock_init_shm_reply_t *rmp;
651 ssvm_private_t _memfd_private, *memfd = &_memfd_private;
652 svm_map_region_args_t _args, *a = &_args;
653 vl_api_registration_t *regp;
654 api_main_t *am = vlibapi_get_main ();
655 svm_region_t *vlib_rp;
657 vl_api_shm_elem_config_t *config = 0;
658 vl_shmem_hdr_t *shmem_hdr;
659 int rv, tries = 1000;
661 regp = vl_api_client_index_to_registration (mp->client_index);
664 clib_warning ("API client disconnected");
667 if (regp->registration_type != REGISTRATION_TYPE_SOCKET_SERVER)
669 clib_warning ("Invalid registration");
674 * Set up a memfd segment of the requested size wherein the
675 * shmem data structures will be initialized
677 clib_memset (memfd, 0, sizeof (*memfd));
678 memfd->ssvm_size = mp->requested_size;
679 memfd->requested_va = 0ULL;
680 memfd->is_server = 1;
681 memfd->name = format (0, "%s%c", regp->name, 0);
683 if ((rv = ssvm_server_init_memfd (memfd)))
686 /* delete the unused heap created in ssvm_server_init_memfd and mark it
687 * accessible again for ASAN */
688 clib_mem_destroy_heap (memfd->sh->heap);
689 CLIB_MEM_UNPOISON ((void *) memfd->sh->ssvm_va, memfd->ssvm_size);
691 /* Remember to close this fd when the socket connection goes away */
692 vec_add1 (regp->additional_fds_to_close, memfd->fd);
695 * Create a plausible svm_region in the memfd backed segment
697 clib_memset (a, 0, sizeof (*a));
698 a->baseva = memfd->sh->ssvm_va + MMAP_PAGESIZE;
699 a->size = memfd->ssvm_size - MMAP_PAGESIZE;
700 /* $$$$ might want a different config parameter */
701 a->pvt_heap_size = am->api_pvt_heap_size;
702 a->flags = SVM_FLAGS_MHEAP;
703 svm_region_init_mapped_region (a, (svm_region_t *) a->baseva);
706 * Part deux, initialize the svm_region_t shared-memory header
707 * api allocation rings, and so on.
709 config = vl_api_make_shm_config (mp);
710 vlib_rp = (svm_region_t *) a->baseva;
711 vl_init_shmem (vlib_rp, config, 1 /* is_vlib (dont-care) */ ,
712 1 /* is_private */ );
714 /* Remember who created this. Needs to be post vl_init_shmem */
715 shmem_hdr = (vl_shmem_hdr_t *) vlib_rp->user_ctx;
716 shmem_hdr->clib_file_index = vl_api_registration_file_index (regp);
718 vec_add1 (am->vlib_private_rps, vlib_rp);
719 memfd->sh->ready = 1;
722 /* Recompute the set of input queues to poll in memclnt_process */
723 vec_reset_length (vl_api_queue_cursizes);
727 rmp = vl_msg_api_alloc (sizeof (*rmp));
728 rmp->_vl_msg_id = htons (VL_API_SOCK_INIT_SHM_REPLY);
729 rmp->context = mp->context;
730 rmp->retval = htonl (rv);
733 * Note: The reply message needs to make it out the back door
734 * before we send the magic fd message. That's taken care of by
737 vl_socket_api_send (regp, (u8 *) rmp);
742 /* Send the magic "here's your sign (aka fd)" socket message */
743 cf = vl_api_registration_file (regp);
746 clib_warning ("cf removed");
750 /* Wait for reply to be consumed before sending the fd */
754 rv = ioctl (cf->file_descriptor, TIOCOUTQ, &bytes);
757 clib_unix_warning ("ioctl returned");
765 vl_sock_api_send_fd_msg (cf->file_descriptor, &memfd->fd, 1);
768 #define foreach_vlib_api_msg \
769 _(SOCKCLNT_CREATE, sockclnt_create, 1) \
770 _(SOCKCLNT_DELETE, sockclnt_delete, 1) \
771 _(SOCK_INIT_SHM, sock_init_shm, 1)
774 vl_sock_api_init (vlib_main_t * vm)
776 clib_file_main_t *fm = &file_main;
777 clib_file_t template = { 0 };
778 vl_api_registration_t *rp;
779 socket_main_t *sm = &socket_main;
780 clib_socket_t *sock = &sm->socksvr_listen_socket;
783 /* If not explicitly configured, do not bind/enable, etc. */
784 if (sm->socket_name == 0)
788 vl_msg_api_set_handlers(VL_API_##N, #n, \
789 vl_api_##n##_t_handler, \
791 vl_api_##n##_t_endian, \
792 vl_api_##n##_t_print, \
793 sizeof(vl_api_##n##_t), t);
794 foreach_vlib_api_msg;
797 vec_resize (sm->input_buffer, 4096);
799 sock->config = (char *) sm->socket_name;
800 sock->flags = CLIB_SOCKET_F_IS_SERVER | CLIB_SOCKET_F_ALLOW_GROUP_WRITE;
801 error = clib_socket_init (sock);
805 pool_get (sm->registration_pool, rp);
806 clib_memset (rp, 0, sizeof (*rp));
808 rp->registration_type = REGISTRATION_TYPE_SOCKET_LISTEN;
810 template.read_function = socksvr_accept_ready;
811 template.write_function = socksvr_bogus_write;
812 template.file_descriptor = sock->fd;
813 template.description = format (0, "socksvr %s", sock->config);
814 template.private_data = rp - sm->registration_pool;
816 rp->clib_file_index = clib_file_add (fm, &template);
820 static clib_error_t *
821 socket_exit (vlib_main_t * vm)
823 socket_main_t *sm = &socket_main;
824 vl_api_registration_t *rp;
826 /* Defensive driving in case something wipes out early */
827 if (sm->registration_pool)
831 pool_foreach (rp, sm->registration_pool) {
832 vl_api_registration_del_file (rp);
833 index = rp->vl_api_registration_pool_index;
834 vl_socket_free_registration_index (index);
842 VLIB_MAIN_LOOP_EXIT_FUNCTION (socket_exit);
844 static clib_error_t *
845 socksvr_config (vlib_main_t * vm, unformat_input_t * input)
847 socket_main_t *sm = &socket_main;
849 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
851 if (unformat (input, "socket-name %s", &sm->socket_name))
853 /* DEPRECATE: default keyword is ignored */
854 else if (unformat (input, "default"))
858 return clib_error_return (0, "unknown input '%U'",
859 format_unformat_error, input);
863 if (!vec_len (sm->socket_name))
864 sm->socket_name = format (0, "%s/%s", vlib_unix_get_runtime_dir (),
865 API_SOCKET_FILENAME);
866 vec_terminate_c_string (sm->socket_name);
871 VLIB_CONFIG_FUNCTION (socksvr_config, "socksvr");
874 vlibsocket_reference ()
879 * fd.io coding-style-patch-verification: ON
882 * eval: (c-set-style "gnu")