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 #define vl_calcsizefun
49 #include <vlibmemory/vl_memory_api_h.h>
52 socket_main_t socket_main;
54 #define SOCK_API_REG_HANDLE_BIT (1<<31)
57 sock_api_registration_handle (vl_api_registration_t * regp)
59 ASSERT (regp->vl_api_registration_pool_index < SOCK_API_REG_HANDLE_BIT);
60 return regp->vl_api_registration_pool_index | SOCK_API_REG_HANDLE_BIT;
64 socket_api_registration_handle_to_index (u32 reg_index)
66 return (reg_index & ~SOCK_API_REG_HANDLE_BIT);
70 vl_socket_api_registration_handle_is_valid (u32 reg_handle)
72 return ((reg_handle & SOCK_API_REG_HANDLE_BIT) != 0);
76 vl_sock_api_dump_clients (vlib_main_t * vm, api_main_t * am)
78 vl_api_registration_t *reg;
79 socket_main_t *sm = &socket_main;
83 * Must have at least one active client, not counting the
84 * REGISTRATION_TYPE_SOCKET_LISTEN bind/accept socket
86 if (pool_elts (sm->registration_pool) < 2)
89 vlib_cli_output (vm, "Socket clients");
90 vlib_cli_output (vm, "%20s %8s", "Name", "Fildesc");
92 pool_foreach (reg, sm->registration_pool)
94 if (reg->registration_type == REGISTRATION_TYPE_SOCKET_SERVER) {
95 f = vl_api_registration_file (reg);
96 vlib_cli_output (vm, "%20s %8d", reg->name, f->file_descriptor);
102 vl_api_registration_t *
103 vl_socket_api_client_handle_to_registration (u32 handle)
105 socket_main_t *sm = &socket_main;
106 u32 index = socket_api_registration_handle_to_index (handle);
107 if (pool_is_free_index (sm->registration_pool, index))
110 clib_warning ("Invalid index %d\n", index);
114 return pool_elt_at_index (sm->registration_pool, index);
118 vl_socket_api_send (vl_api_registration_t * rp, u8 * elem)
123 socket_main_t *sm = &socket_main;
124 u16 msg_id = ntohs (*(u16 *) elem);
125 api_main_t *am = vlibapi_get_main ();
126 msgbuf_t *mb = (msgbuf_t *) (elem - offsetof (msgbuf_t, data));
127 vl_api_registration_t *sock_rp;
128 clib_file_main_t *fm = &file_main;
132 cf = vl_api_registration_file (rp);
133 ASSERT (rp->registration_type > REGISTRATION_TYPE_SHMEM);
135 if (msg_id >= vec_len (am->api_trace_cfg))
137 clib_warning ("id out of range: %d", msg_id);
138 vl_msg_api_free ((void *) elem);
142 sock_rp = pool_elt_at_index (sm->registration_pool,
143 rp->vl_api_registration_pool_index);
146 /* Add the msgbuf_t to the output vector */
147 vec_add (sock_rp->output_vector, (u8 *) mb, sizeof (*mb));
149 /* Try to send the message and save any error like
150 * we do in the input epoll loop */
151 vec_add (sock_rp->output_vector, elem, ntohl (mb->data_len));
152 error = clib_file_write (cf);
153 unix_save_error (&unix_main, error);
155 /* If we didn't finish sending everything, wait for tx space */
156 if (vec_len (sock_rp->output_vector) > 0
157 && !(cf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE))
159 cf->flags |= UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
160 fm->file_update (cf, UNIX_FILE_UPDATE_MODIFY);
164 output_length = sizeof (*mb) + ntohl (mb->data_len);
165 clib_warning ("wrote %u bytes to fd %d", output_length,
166 cf->file_descriptor);
169 vl_msg_api_free ((void *) elem);
173 vl_socket_free_registration_index (u32 pool_index)
176 vl_api_registration_t *rp;
177 void vl_api_call_reaper_functions (u32 client_index);
179 if (pool_is_free_index (socket_main.registration_pool, pool_index))
181 clib_warning ("main pool index %d already free", pool_index);
184 rp = pool_elt_at_index (socket_main.registration_pool, pool_index);
186 vl_api_call_reaper_functions (
187 clib_host_to_net_u32 (sock_api_registration_handle (rp)));
189 ASSERT (rp->registration_type != REGISTRATION_TYPE_FREE);
190 for (i = 0; i < vec_len (rp->additional_fds_to_close); i++)
191 if (close (rp->additional_fds_to_close[i]) < 0)
192 clib_unix_warning ("close");
193 vec_free (rp->additional_fds_to_close);
195 vec_free (rp->unprocessed_input);
196 vec_free (rp->output_vector);
197 rp->registration_type = REGISTRATION_TYPE_FREE;
198 pool_put (socket_main.registration_pool, rp);
202 vl_socket_process_api_msg (vl_api_registration_t * rp, i8 * input_v)
204 msgbuf_t *mbp = (msgbuf_t *) input_v;
206 u8 *the_msg = (u8 *) (mbp->data);
207 socket_main.current_rp = rp;
208 vl_msg_api_socket_handler (the_msg, ntohl (mbp->data_len));
209 socket_main.current_rp = 0;
213 is_being_removed_reg_index (u32 reg_index)
215 vl_api_registration_t *rp = vl_socket_get_registration (reg_index);
216 ALWAYS_ASSERT (rp != 0);
217 return (rp->is_being_removed);
221 socket_cleanup_pending_remove_registration_cb (u32 *preg_index)
223 vl_api_registration_t *rp = vl_socket_get_registration (*preg_index);
224 clib_file_main_t *fm = &file_main;
225 u32 pending_remove_file_index = vl_api_registration_file_index (rp);
227 clib_file_t *zf = fm->file_pool + pending_remove_file_index;
229 clib_file_del (fm, zf);
230 vl_socket_free_registration_index (rp - socket_main.registration_pool);
234 vl_socket_request_remove_reg_index (u32 reg_index)
236 vl_api_registration_t *rp = vl_socket_get_registration (reg_index);
237 ALWAYS_ASSERT (rp != 0);
238 if (rp->is_being_removed)
242 rp->is_being_removed = 1;
243 vl_api_force_rpc_call_main_thread (
244 socket_cleanup_pending_remove_registration_cb, (void *) ®_index,
249 * Read function for API socket.
251 * Read data from socket, invoke SOCKET_READ_EVENT
252 * for each fully read API message, return 0.
253 * Store incomplete data for next invocation to continue.
255 * On severe read error, the file is closed.
257 * As reading is single threaded,
258 * socket_main.input_buffer is used temporarily.
259 * Even its length is modified, but always restored before return.
261 * Incomplete data is copied into a vector,
262 * pointer saved in registration's unprocessed_input.
265 vl_socket_read_ready (clib_file_t * uf)
267 vlib_main_t *vm = vlib_get_main ();
268 vl_api_registration_t *rp;
269 /* n is the size of data read to input_buffer */
271 /* msg_buffer vector can point to input_buffer or unprocessed_input */
273 /* data_for_process is a vector containing one full message, incl msgbuf_t */
274 u8 *data_for_process;
275 /* msgbuf_len is the size of one message, including sizeof (msgbuf_t) */
277 u32 save_input_buffer_length = vec_len (socket_main.input_buffer);
278 vl_socket_args_for_process_t *a;
279 u32 reg_index = uf->private_data;
280 if (is_being_removed_reg_index (reg_index))
285 rp = vl_socket_get_registration (reg_index);
287 /* Ignore unprocessed_input for now, n describes input_buffer for now. */
288 n = read (uf->file_descriptor, socket_main.input_buffer,
289 vec_len (socket_main.input_buffer));
295 /* Severe error, close the file. */
296 vl_socket_request_remove_reg_index (reg_index);
298 /* EAGAIN means we do not close the file, but no data to process anyway. */
302 /* Fake smaller length teporarily, so input_buffer can be used as msg_buffer. */
303 vec_set_len (socket_main.input_buffer, n);
306 * Look for bugs here. This code is tricky because
307 * data read from a stream socket does not honor message
308 * boundaries. In the case of a long message (>4K bytes)
309 * we have to do (at least) 2 reads, etc.
311 /* Determine msg_buffer. */
312 if (vec_len (rp->unprocessed_input))
314 vec_append (rp->unprocessed_input, socket_main.input_buffer);
315 msg_buffer = rp->unprocessed_input;
319 msg_buffer = socket_main.input_buffer;
321 /* Loop to process any full messages. */
322 ASSERT (vec_len (msg_buffer) > 0);
325 /* Here, we are not sure how big a chunk of message we have left. */
326 /* Do we at least know how big the full message will be? */
327 if (vec_len (msg_buffer) <= sizeof (msgbuf_t))
328 /* No, so fragment is not a full message. */
331 /* Now we know how big the full message will be. */
333 ntohl (((msgbuf_t *) msg_buffer)->data_len) + sizeof (msgbuf_t);
335 /* But do we have a full message? */
336 if (msgbuf_len > vec_len (msg_buffer))
339 /* We don't have the entire message yet. */
340 /* If msg_buffer is unprocessed_input, nothing needs to be done. */
341 if (msg_buffer == socket_main.input_buffer)
342 /* But if we were using the input buffer, save the fragment. */
344 ASSERT (vec_len (rp->unprocessed_input) == 0);
345 vec_validate (rp->unprocessed_input, vec_len (msg_buffer) - 1);
346 clib_memcpy_fast (rp->unprocessed_input, msg_buffer,
347 vec_len (msg_buffer));
348 vec_set_len (rp->unprocessed_input, vec_len (msg_buffer));
350 /* No more full messages, restore original input_buffer length. */
351 vec_set_len (socket_main.input_buffer, save_input_buffer_length);
356 * We have at least one full message.
357 * But msg_buffer can contain more data, so copy one message data
358 * so we can overwrite its length to what single message has.
360 data_for_process = (u8 *) vec_dup (msg_buffer);
361 vec_set_len (data_for_process, msgbuf_len);
362 /* Everything is ready to signal the SOCKET_READ_EVENT. */
363 pool_get (socket_main.process_args, a);
364 a->reg_index = reg_index;
365 a->data = data_for_process;
367 vlib_process_signal_event (vm, vl_api_clnt_node.index,
369 a - socket_main.process_args);
370 if (vec_len (msg_buffer) > msgbuf_len)
371 /* There are some fragments left. Shrink the msg_buffer to simplify logic. */
372 vec_delete (msg_buffer, msgbuf_len, 0);
374 /* We are done with msg_buffer. */
375 vec_set_len (msg_buffer, 0);
377 while (vec_len (msg_buffer) > 0);
379 /* Restore input_buffer, it could have been msg_buffer. */
380 vec_set_len (socket_main.input_buffer, save_input_buffer_length);
385 vl_socket_write_ready (clib_file_t * uf)
387 clib_file_main_t *fm = &file_main;
388 vl_api_registration_t *rp;
391 u32 reg_index = uf->private_data;
392 if (is_being_removed_reg_index (reg_index))
397 rp = pool_elt_at_index (socket_main.registration_pool, reg_index);
399 /* Flush output vector. */
400 size_t total_bytes = vec_len (rp->output_vector);
401 size_t bytes_to_send, remaining_bytes = total_bytes;
402 void *p = rp->output_vector;
403 while (remaining_bytes > 0)
405 bytes_to_send = remaining_bytes > 4096 ? 4096 : remaining_bytes;
406 n = write (uf->file_descriptor, p, bytes_to_send);
414 clib_warning ("write error, close the file...\n");
416 vl_socket_request_remove_reg_index (reg_index);
419 remaining_bytes -= bytes_to_send;
423 vec_delete (rp->output_vector, total_bytes - remaining_bytes, 0);
424 if (vec_len (rp->output_vector) <= 0
425 && (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE))
427 uf->flags &= ~UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
428 fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
435 vl_socket_error_ready (clib_file_t * uf)
437 u32 reg_index = uf->private_data;
438 vl_socket_request_remove_reg_index (reg_index);
443 socksvr_file_add (clib_file_main_t * fm, int fd)
445 vl_api_registration_t *rp;
446 clib_file_t template = { 0 };
448 pool_get (socket_main.registration_pool, rp);
449 clib_memset (rp, 0, sizeof (*rp));
451 template.read_function = vl_socket_read_ready;
452 template.write_function = vl_socket_write_ready;
453 template.error_function = vl_socket_error_ready;
454 template.file_descriptor = fd;
455 template.description = format (0, "socksrv");
456 template.private_data = rp - socket_main.registration_pool;
458 rp->registration_type = REGISTRATION_TYPE_SOCKET_SERVER;
459 rp->vl_api_registration_pool_index = rp - socket_main.registration_pool;
460 rp->clib_file_index = clib_file_add (fm, &template);
463 static clib_error_t *
464 socksvr_accept_ready (clib_file_t * uf)
466 clib_file_main_t *fm = &file_main;
467 socket_main_t *sm = &socket_main;
468 clib_socket_t *sock = &sm->socksvr_listen_socket;
469 clib_socket_t client;
472 error = clib_socket_accept (sock, &client);
476 socksvr_file_add (fm, client.fd);
480 static clib_error_t *
481 socksvr_bogus_write (clib_file_t * uf)
483 clib_warning ("why am I here?");
488 * vl_api_sockclnt_create_t_handler
491 vl_api_sockclnt_create_t_handler (vl_api_sockclnt_create_t * mp)
493 vl_api_registration_t *regp;
494 vl_api_sockclnt_create_reply_t *rp;
495 api_main_t *am = vlibapi_get_main ();
498 u32 nmsg = hash_elts (am->msg_index_by_name_and_crc);
501 regp = socket_main.current_rp;
503 /* client already connected through shared memory? */
504 if (!regp || regp->registration_type != REGISTRATION_TYPE_SOCKET_SERVER)
507 "unsupported API call: already connected though shared memory?");
511 regp->name = format (0, "%s%c", mp->name, 0);
513 u32 size = sizeof (*rp) + (nmsg * sizeof (vl_api_message_table_entry_t));
514 rp = vl_msg_api_alloc_zero (size);
515 rp->_vl_msg_id = htons (VL_API_SOCKCLNT_CREATE_REPLY);
516 rp->index = htonl (sock_api_registration_handle (regp));
517 rp->context = mp->context;
518 rp->response = htonl (rv);
519 rp->count = htons (nmsg);
522 hash_foreach_pair (hp, am->msg_index_by_name_and_crc,
524 rp->message_table[i].index = htons(hp->value[0]);
525 (void) strncpy_s((char *)rp->message_table[i].name,
526 64 /* bytes of space at dst */,
528 64-1 /* chars to copy, without zero byte. */);
532 vl_api_send_msg (regp, (u8 *) rp);
536 * vl_api_sockclnt_delete_t_handler
539 vl_api_sockclnt_delete_t_handler (vl_api_sockclnt_delete_t * mp)
541 vl_api_registration_t *regp;
542 vl_api_sockclnt_delete_reply_t *rp;
544 regp = vl_api_client_index_to_registration (mp->client_index);
548 u32 reg_index = socket_api_registration_handle_to_index (ntohl (mp->index));
549 rp = vl_msg_api_alloc (sizeof (*rp));
550 rp->_vl_msg_id = htons (VL_API_SOCKCLNT_DELETE_REPLY);
551 rp->context = mp->context;
553 if (!pool_is_free_index (socket_main.registration_pool, reg_index))
555 rp->response = htonl (1);
556 vl_api_send_msg (regp, (u8 *) rp);
558 vl_api_registration_del_file (regp);
559 vl_socket_free_registration_index (reg_index);
563 clib_warning ("unknown client ID %d", reg_index);
564 rp->response = htonl (-1);
565 vl_api_send_msg (regp, (u8 *) rp);
570 vl_sock_api_send_fd_msg (int socket_fd, int fds[], int n_fds)
572 struct msghdr mh = { 0 };
574 char ctl[CMSG_SPACE (sizeof (int) * n_fds)];
575 struct cmsghdr *cmsg;
579 iov[0].iov_base = msg;
580 iov[0].iov_len = strlen (msg);
584 clib_memset (&ctl, 0, sizeof (ctl));
585 mh.msg_control = ctl;
586 mh.msg_controllen = sizeof (ctl);
587 cmsg = CMSG_FIRSTHDR (&mh);
588 cmsg->cmsg_len = CMSG_LEN (sizeof (int) * n_fds);
589 cmsg->cmsg_level = SOL_SOCKET;
590 cmsg->cmsg_type = SCM_RIGHTS;
591 clib_memcpy_fast (CMSG_DATA (cmsg), fds, sizeof (int) * n_fds);
593 while ((rv = sendmsg (socket_fd, &mh, 0)) < 0 && errno == EAGAIN)
596 return clib_error_return_unix (0, "sendmsg");
600 vl_api_shm_elem_config_t *
601 vl_api_make_shm_config (vl_api_sock_init_shm_t * mp)
603 vl_api_shm_elem_config_t *config = 0, *c;
609 vec_validate (config, 6);
610 config[0].type = VL_API_VLIB_RING;
611 config[0].size = 256;
612 config[0].count = 32;
614 config[1].type = VL_API_VLIB_RING;
615 config[1].size = 1024;
616 config[1].count = 16;
618 config[2].type = VL_API_VLIB_RING;
619 config[2].size = 4096;
622 config[3].type = VL_API_CLIENT_RING;
623 config[3].size = 256;
624 config[3].count = 32;
626 config[4].type = VL_API_CLIENT_RING;
627 config[4].size = 1024;
628 config[4].count = 16;
630 config[5].type = VL_API_CLIENT_RING;
631 config[5].size = 4096;
634 config[6].type = VL_API_QUEUE;
635 config[6].count = 128;
636 config[6].size = sizeof (uword);
640 vec_validate (config, mp->nitems - 1);
641 for (i = 0; i < mp->nitems; i++)
643 cfg = mp->configs[i];
644 /* Pretty much a hack but it avoids defining our own api type
646 c = (vl_api_shm_elem_config_t *) & cfg;
647 config[i].type = c->type;
648 config[i].count = c->count;
649 config[i].size = c->size;
656 * Bootstrap shm api using the socket api
659 vl_api_sock_init_shm_t_handler (vl_api_sock_init_shm_t * mp)
661 vl_api_sock_init_shm_reply_t *rmp;
662 ssvm_private_t _memfd_private, *memfd = &_memfd_private;
663 svm_map_region_args_t _args, *a = &_args;
664 vl_api_registration_t *regp;
665 api_main_t *am = vlibapi_get_main ();
666 svm_region_t *vlib_rp;
668 vl_api_shm_elem_config_t *config = 0;
669 vl_shmem_hdr_t *shmem_hdr;
670 int rv, tries = 1000;
672 regp = vl_api_client_index_to_registration (mp->client_index);
675 clib_warning ("API client disconnected");
678 if (regp->registration_type != REGISTRATION_TYPE_SOCKET_SERVER)
680 clib_warning ("Invalid registration");
685 * Set up a memfd segment of the requested size wherein the
686 * shmem data structures will be initialized
688 clib_memset (memfd, 0, sizeof (*memfd));
689 memfd->ssvm_size = mp->requested_size;
690 memfd->requested_va = 0ULL;
691 memfd->is_server = 1;
692 memfd->name = format (0, "%s%c", regp->name, 0);
694 if ((rv = ssvm_server_init_memfd (memfd)))
697 /* delete the unused heap created in ssvm_server_init_memfd and mark it
698 * accessible again for ASAN */
699 clib_mem_destroy_heap (memfd->sh->heap);
700 CLIB_MEM_UNPOISON ((void *) memfd->sh->ssvm_va, memfd->ssvm_size);
702 /* Remember to close this fd when the socket connection goes away */
703 vec_add1 (regp->additional_fds_to_close, memfd->fd);
706 * Create a plausible svm_region in the memfd backed segment
708 clib_memset (a, 0, sizeof (*a));
709 a->baseva = memfd->sh->ssvm_va + MMAP_PAGESIZE;
710 a->size = memfd->ssvm_size - MMAP_PAGESIZE;
711 /* $$$$ might want a different config parameter */
712 a->pvt_heap_size = am->api_pvt_heap_size;
713 a->flags = SVM_FLAGS_MHEAP;
714 svm_region_init_mapped_region (a, (svm_region_t *) a->baseva);
717 * Part deux, initialize the svm_region_t shared-memory header
718 * api allocation rings, and so on.
720 config = vl_api_make_shm_config (mp);
721 vlib_rp = (svm_region_t *) a->baseva;
722 vl_init_shmem (vlib_rp, config, 1 /* is_vlib (dont-care) */ ,
723 1 /* is_private */ );
725 /* Remember who created this. Needs to be post vl_init_shmem */
726 shmem_hdr = (vl_shmem_hdr_t *) vlib_rp->user_ctx;
727 shmem_hdr->clib_file_index = vl_api_registration_file_index (regp);
729 vec_add1 (am->vlib_private_rps, vlib_rp);
730 memfd->sh->ready = 1;
733 /* Recompute the set of input queues to poll in memclnt_process */
734 vec_reset_length (vl_api_queue_cursizes);
738 rmp = vl_msg_api_alloc (sizeof (*rmp));
739 rmp->_vl_msg_id = htons (VL_API_SOCK_INIT_SHM_REPLY);
740 rmp->context = mp->context;
741 rmp->retval = htonl (rv);
744 * Note: The reply message needs to make it out the back door
745 * before we send the magic fd message. That's taken care of by
748 vl_socket_api_send (regp, (u8 *) rmp);
753 /* Send the magic "here's your sign (aka fd)" socket message */
754 cf = vl_api_registration_file (regp);
757 clib_warning ("cf removed");
761 /* Wait for reply to be consumed before sending the fd */
765 rv = ioctl (cf->file_descriptor, TIOCOUTQ, &bytes);
768 clib_unix_warning ("ioctl returned");
776 vl_sock_api_send_fd_msg (cf->file_descriptor, &memfd->fd, 1);
779 #define foreach_vlib_api_msg \
780 _ (SOCKCLNT_CREATE, sockclnt_create, 0) \
781 _ (SOCKCLNT_DELETE, sockclnt_delete, 0) \
782 _ (SOCK_INIT_SHM, sock_init_shm, 0)
785 vl_sock_api_init (vlib_main_t * vm)
787 api_main_t *am = vlibapi_get_main ();
788 clib_file_main_t *fm = &file_main;
789 clib_file_t template = { 0 };
790 vl_api_registration_t *rp;
791 socket_main_t *sm = &socket_main;
792 clib_socket_t *sock = &sm->socksvr_listen_socket;
795 /* If not explicitly configured, do not bind/enable, etc. */
796 if (sm->socket_name == 0)
800 vl_msg_api_set_handlers ( \
801 VL_API_##N, #n, vl_api_##n##_t_handler, vl_noop_handler, \
802 vl_api_##n##_t_endian, vl_api_##n##_t_print, sizeof (vl_api_##n##_t), t, \
803 vl_api_##n##_t_print_json, vl_api_##n##_t_tojson, \
804 vl_api_##n##_t_fromjson, vl_api_##n##_t_calc_size); \
805 am->api_trace_cfg[VL_API_##N].replay_enable = 0;
806 foreach_vlib_api_msg;
809 vec_resize (sm->input_buffer, 4096);
811 sock->config = (char *) sm->socket_name;
812 sock->flags = CLIB_SOCKET_F_IS_SERVER | CLIB_SOCKET_F_ALLOW_GROUP_WRITE;
813 error = clib_socket_init (sock);
817 pool_get (sm->registration_pool, rp);
818 clib_memset (rp, 0, sizeof (*rp));
820 rp->registration_type = REGISTRATION_TYPE_SOCKET_LISTEN;
822 template.read_function = socksvr_accept_ready;
823 template.write_function = socksvr_bogus_write;
824 template.file_descriptor = sock->fd;
825 template.description = format (0, "socksvr %s", sock->config);
826 template.private_data = rp - sm->registration_pool;
828 rp->clib_file_index = clib_file_add (fm, &template);
832 static clib_error_t *
833 socket_exit (vlib_main_t * vm)
835 socket_main_t *sm = &socket_main;
836 vl_api_registration_t *rp;
838 /* Defensive driving in case something wipes out early */
839 if (sm->registration_pool)
843 pool_foreach (rp, sm->registration_pool) {
844 vl_api_registration_del_file (rp);
845 index = rp->vl_api_registration_pool_index;
846 vl_socket_free_registration_index (index);
854 VLIB_MAIN_LOOP_EXIT_FUNCTION (socket_exit);
856 static clib_error_t *
857 socksvr_config (vlib_main_t * vm, unformat_input_t * input)
859 socket_main_t *sm = &socket_main;
861 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
863 if (unformat (input, "socket-name %s", &sm->socket_name))
865 /* DEPRECATE: default keyword is ignored */
866 else if (unformat (input, "default"))
870 return clib_error_return (0, "unknown input '%U'",
871 format_unformat_error, input);
875 if (!vec_len (sm->socket_name))
876 sm->socket_name = format (0, "%s/%s", vlib_unix_get_runtime_dir (),
877 API_SOCKET_FILENAME);
878 vec_terminate_c_string (sm->socket_name);
883 VLIB_CONFIG_FUNCTION (socksvr_config, "socksvr");
886 vlibsocket_reference ()
891 * fd.io coding-style-patch-verification: ON
894 * eval: (c-set-style "gnu")