src/vlibmemory/socket_api.c

   1 /*
   2  *------------------------------------------------------------------
   3  * socket_api.c
   4  *
   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>
  24 #include <fcntl.h>
  25 #include <sys/stat.h>
  26
  27 #include <vppinfra/byte_order.h>
  28 #include <svm/ssvm.h>
  29 #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
  48 socket_main_t socket_main;
  49
  50 #define SOCK_API_REG_HANDLE_BIT (1<<31)
  51
  52 static u32
  53 sock_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
  59 static u32
  60 socket_api_registration_handle_to_index (u32 reg_index)
  61 {
  62   return (reg_index & ~SOCK_API_REG_HANDLE_BIT);
  63 }
  64
  65 u8
  66 vl_socket_api_registration_handle_is_valid (u32 reg_handle)
  67 {
  68   return ((reg_handle & SOCK_API_REG_HANDLE_BIT) != 0);
  69 }
  70
  71 void
  72 vl_sock_api_dump_clients (vlib_main_t * vm, api_main_t * am)
  73 {
  74   vl_api_registration_t *reg;
  75   socket_main_t *sm = &socket_main;
  76   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");
  86   vlib_cli_output (vm, "%20s %8s", "Name", "Fildesc");
  87     /* *INDENT-OFF* */
  88     pool_foreach (reg, sm->registration_pool,
  89     ({
  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);
  93         }
  94     }));
  95 /* *INDENT-ON* */
  96 }
  97
  98 vl_api_registration_t *
  99 vl_socket_api_client_handle_to_registration (u32 handle)
 100 {
 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))
 104     {
 105 #if DEBUG > 2
 106       clib_warning ("Invalid index %d\n", index);
 107 #endif
 108       return 0;
 109     }
 110   return pool_elt_at_index (sm->registration_pool, index);
 111 }
 112
 113 void
 114 vl_socket_api_send (vl_api_registration_t * rp, u8 * elem)
 115 {
 116 #if CLIB_DEBUG > 1
 117   u32 output_length;
 118 #endif
 119   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));
 123   vl_api_registration_t *sock_rp;
 124   clib_file_main_t *fm = &file_main;
 125   clib_error_t *error;
 126   clib_file_t *cf;
 127
 128   cf = vl_api_registration_file (rp);
 129   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
 138   sock_rp = pool_elt_at_index (sm->registration_pool,
 139                                rp->vl_api_registration_pool_index);
 140   ASSERT (sock_rp);
 141
 142   /* Add the msgbuf_t to the output vector */
 143   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     }
 158
 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
 168 void
 169 vl_socket_free_registration_index (u32 pool_index)
 170 {
 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
 192 void
 193 vl_socket_process_api_msg (clib_file_t * uf, vl_api_registration_t * rp,
 194                            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
 206 /*
 207  * Read function for API socket.
 208  *
 209  * Read data from socket, invoke SOCKET_READ_EVENT
 210  * for each fully read API message, return 0.
 211  * Store incomplete data for next invocation to continue.
 212  *
 213  * On severe read error, the file is closed.
 214  *
 215  * As reading is single threaded,
 216  * socket_main.input_buffer is used temporarily.
 217  * Even its length is modified, but always restored before return.
 218  *
 219  * Incomplete data is copied into a vector,
 220  * pointer saved in registration's unprocessed_input.
 221  */
 222 clib_error_t *
 223 vl_socket_read_ready (clib_file_t * uf)
 224 {
 225   clib_file_main_t *fm = &file_main;
 226   vlib_main_t *vm = vlib_get_main ();
 227   vl_api_registration_t *rp;
 228   /* n is the size of data read to input_buffer */
 229   int n;
 230   /* msg_buffer vector can point to input_buffer or unprocessed_input */
 231   i8 *msg_buffer = 0;
 232   /* data_for_process is a vector containing one full message, incl msgbuf_t */
 233   u8 *data_for_process;
 234   /* msgbuf_len is the size of one message, including sizeof (msgbuf_t) */
 235   u32 msgbuf_len;
 236   u32 save_input_buffer_length = vec_len (socket_main.input_buffer);
 237   vl_socket_args_for_process_t *a;
 238
 239   rp = pool_elt_at_index (socket_main.registration_pool, uf->private_data);
 240
 241   /* Ignore unprocessed_input for now, n describes input_buffer for now. */
 242   n = read (uf->file_descriptor, socket_main.input_buffer,
 243             vec_len (socket_main.input_buffer));
 244
 245   if (n <= 0)
 246     {
 247       if (errno != EAGAIN)
 248         {
 249           /* Severe error, close the file. */
 250           clib_file_del (fm, uf);
 251
 252           if (!pool_is_free (socket_main.registration_pool, rp))
 253             {
 254               u32 index = rp - socket_main.registration_pool;
 255               vl_socket_free_registration_index (index);
 256             }
 257           else
 258             {
 259               clib_warning ("client index %d already free?",
 260                             rp->vl_api_registration_pool_index);
 261             }
 262         }
 263       /* EAGAIN means we do not close the file, but no data to process anyway. */
 264       return 0;
 265     }
 266
 267   /* Fake smaller length teporarily, so input_buffer can be used as msg_buffer. */
 268   _vec_len (socket_main.input_buffer) = n;
 269
 270   /*
 271    * Look for bugs here. This code is tricky because
 272    * data read from a stream socket does not honor message
 273    * boundaries. In the case of a long message (>4K bytes)
 274    * we have to do (at least) 2 reads, etc.
 275    */
 276   /* Determine msg_buffer. */
 277   if (vec_len (rp->unprocessed_input))
 278     {
 279       vec_append (rp->unprocessed_input, socket_main.input_buffer);
 280       msg_buffer = rp->unprocessed_input;
 281     }
 282   else
 283     {
 284       msg_buffer = socket_main.input_buffer;
 285     }
 286   /* Loop to process any full messages. */
 287   ASSERT (vec_len (msg_buffer) > 0);
 288   do
 289     {
 290       /* Here, we are not sure how big a chunk of message we have left. */
 291       /* Do we at least know how big the full message will be? */
 292       if (vec_len (msg_buffer) <= sizeof (msgbuf_t))
 293         /* No, so fragment is not a full message. */
 294         goto save_and_split;
 295
 296       /* Now we know how big the full message will be. */
 297       msgbuf_len =
 298         ntohl (((msgbuf_t *) msg_buffer)->data_len) + sizeof (msgbuf_t);
 299
 300       /* But do we have a full message? */
 301       if (msgbuf_len > vec_len (msg_buffer))
 302         {
 303         save_and_split:
 304           /* We don't have the entire message yet. */
 305           /* If msg_buffer is unprocessed_input, nothing needs to be done. */
 306           if (msg_buffer == socket_main.input_buffer)
 307             /* But if we were using the input buffer, save the fragment. */
 308             {
 309               ASSERT (vec_len (rp->unprocessed_input) == 0);
 310               vec_validate (rp->unprocessed_input, vec_len (msg_buffer) - 1);
 311               clib_memcpy_fast (rp->unprocessed_input, msg_buffer,
 312                                 vec_len (msg_buffer));
 313               _vec_len (rp->unprocessed_input) = vec_len (msg_buffer);
 314             }
 315           /* No more full messages, restore original input_buffer length. */
 316           _vec_len (socket_main.input_buffer) = save_input_buffer_length;
 317           return 0;
 318         }
 319
 320       /*
 321        * We have at least one full message.
 322        * But msg_buffer can contain more data, so copy one message data
 323        * so we can overwrite its length to what single message has.
 324        */
 325       data_for_process = (u8 *) vec_dup (msg_buffer);
 326       _vec_len (data_for_process) = msgbuf_len;
 327       /* Everything is ready to signal the SOCKET_READ_EVENT. */
 328       pool_get (socket_main.process_args, a);
 329       a->clib_file = uf;
 330       a->regp = rp;
 331       a->data = data_for_process;
 332
 333       vlib_process_signal_event (vm, vl_api_clnt_node.index,
 334                                  SOCKET_READ_EVENT,
 335                                  a - socket_main.process_args);
 336       if (vec_len (msg_buffer) > msgbuf_len)
 337         /* There are some fragments left. Shrink the msg_buffer to simplify logic. */
 338         vec_delete (msg_buffer, msgbuf_len, 0);
 339       else
 340         /* We are done with msg_buffer. */
 341         _vec_len (msg_buffer) = 0;
 342     }
 343   while (vec_len (msg_buffer) > 0);
 344
 345   /* Restore input_buffer, it could have been msg_buffer. */
 346   _vec_len (socket_main.input_buffer) = save_input_buffer_length;
 347   return 0;
 348 }
 349
 350 clib_error_t *
 351 vl_socket_write_ready (clib_file_t * uf)
 352 {
 353   clib_file_main_t *fm = &file_main;
 354   vl_api_registration_t *rp;
 355   int n;
 356
 357   rp = pool_elt_at_index (socket_main.registration_pool, uf->private_data);
 358
 359   /* Flush output vector. */
 360   size_t total_bytes = vec_len (rp->output_vector);
 361   size_t bytes_to_send, remaining_bytes = total_bytes;
 362   void *p = rp->output_vector;
 363   while (remaining_bytes > 0)
 364     {
 365       bytes_to_send = remaining_bytes > 4096 ? 4096 : remaining_bytes;
 366       n = write (uf->file_descriptor, p, bytes_to_send);
 367       if (n < 0)
 368         {
 369           if (errno == EAGAIN)
 370             {
 371               break;
 372             }
 373 #if DEBUG > 2
 374           clib_warning ("write error, close the file...\n");
 375 #endif
 376           clib_file_del (fm, uf);
 377           vl_socket_free_registration_index (rp -
 378                                              socket_main.registration_pool);
 379           return 0;
 380         }
 381       remaining_bytes -= bytes_to_send;
 382       p += bytes_to_send;
 383     }
 384
 385   vec_delete (rp->output_vector, total_bytes - remaining_bytes, 0);
 386   if (vec_len (rp->output_vector) <= 0
 387       && (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE))
 388     {
 389       uf->flags &= ~UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
 390       fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
 391     }
 392
 393   return 0;
 394 }
 395
 396 clib_error_t *
 397 vl_socket_error_ready (clib_file_t * uf)
 398 {
 399   vl_api_registration_t *rp;
 400   clib_file_main_t *fm = &file_main;
 401
 402   rp = pool_elt_at_index (socket_main.registration_pool, uf->private_data);
 403   clib_file_del (fm, uf);
 404   vl_socket_free_registration_index (rp - socket_main.registration_pool);
 405
 406   return 0;
 407 }
 408
 409 void
 410 socksvr_file_add (clib_file_main_t * fm, int fd)
 411 {
 412   vl_api_registration_t *rp;
 413   clib_file_t template = { 0 };
 414
 415   pool_get (socket_main.registration_pool, rp);
 416   clib_memset (rp, 0, sizeof (*rp));
 417
 418   template.read_function = vl_socket_read_ready;
 419   template.write_function = vl_socket_write_ready;
 420   template.error_function = vl_socket_error_ready;
 421   template.file_descriptor = fd;
 422   template.private_data = rp - socket_main.registration_pool;
 423
 424   rp->registration_type = REGISTRATION_TYPE_SOCKET_SERVER;
 425   rp->vl_api_registration_pool_index = rp - socket_main.registration_pool;
 426   rp->clib_file_index = clib_file_add (fm, &template);
 427 }
 428
 429 static clib_error_t *
 430 socksvr_accept_ready (clib_file_t * uf)
 431 {
 432   clib_file_main_t *fm = &file_main;
 433   socket_main_t *sm = &socket_main;
 434   clib_socket_t *sock = &sm->socksvr_listen_socket;
 435   clib_socket_t client;
 436   clib_error_t *error;
 437
 438   error = clib_socket_accept (sock, &client);
 439   if (error)
 440     return error;
 441
 442   socksvr_file_add (fm, client.fd);
 443   return 0;
 444 }
 445
 446 static clib_error_t *
 447 socksvr_bogus_write (clib_file_t * uf)
 448 {
 449   clib_warning ("why am I here?");
 450   return 0;
 451 }
 452
 453 /*
 454  * vl_api_sockclnt_create_t_handler
 455  */
 456 void
 457 vl_api_sockclnt_create_t_handler (vl_api_sockclnt_create_t * mp)
 458 {
 459   vl_api_registration_t *regp;
 460   vl_api_sockclnt_create_reply_t *rp;
 461   api_main_t *am = &api_main;
 462   hash_pair_t *hp;
 463   int rv = 0;
 464   u32 nmsg = hash_elts (am->msg_index_by_name_and_crc);
 465   u32 i = 0;
 466
 467   regp = socket_main.current_rp;
 468
 469   ASSERT (regp->registration_type == REGISTRATION_TYPE_SOCKET_SERVER);
 470
 471   regp->name = format (0, "%s%c", mp->name, 0);
 472
 473   u32 size = sizeof (*rp) + (nmsg * sizeof (vl_api_message_table_entry_t));
 474   rp = vl_msg_api_alloc_zero (size);
 475   rp->_vl_msg_id = htons (VL_API_SOCKCLNT_CREATE_REPLY);
 476   rp->index = htonl (sock_api_registration_handle (regp));
 477   rp->context = mp->context;
 478   rp->response = htonl (rv);
 479   rp->count = htons (nmsg);
 480
 481   /* *INDENT-OFF* */
 482   hash_foreach_pair (hp, am->msg_index_by_name_and_crc,
 483   ({
 484     rp->message_table[i].index = htons(hp->value[0]);
 485     strncpy_s((char *)rp->message_table[i].name, 64 /* bytes of space at dst */,
 486               (char *)hp->key, 64-1 /* chars to copy, without zero byte. */);
 487     i++;
 488   }));
 489   /* *INDENT-ON* */
 490   vl_api_send_msg (regp, (u8 *) rp);
 491 }
 492
 493 /*
 494  * vl_api_sockclnt_delete_t_handler
 495  */
 496 void
 497 vl_api_sockclnt_delete_t_handler (vl_api_sockclnt_delete_t * mp)
 498 {
 499   vl_api_registration_t *regp;
 500   vl_api_sockclnt_delete_reply_t *rp;
 501
 502   regp = vl_api_client_index_to_registration (mp->client_index);
 503   if (!regp)
 504     return;
 505
 506   u32 reg_index = socket_api_registration_handle_to_index (ntohl (mp->index));
 507   rp = vl_msg_api_alloc (sizeof (*rp));
 508   rp->_vl_msg_id = htons (VL_API_SOCKCLNT_DELETE_REPLY);
 509   rp->context = mp->context;
 510
 511   if (!pool_is_free_index (socket_main.registration_pool, reg_index))
 512     {
 513       rp->response = htonl (1);
 514       vl_api_send_msg (regp, (u8 *) rp);
 515
 516       vl_api_registration_del_file (regp);
 517       vl_socket_free_registration_index (reg_index);
 518     }
 519   else
 520     {
 521       clib_warning ("unknown client ID %d", reg_index);
 522       rp->response = htonl (-1);
 523       vl_api_send_msg (regp, (u8 *) rp);
 524     }
 525 }
 526
 527 clib_error_t *
 528 vl_sock_api_send_fd_msg (int socket_fd, int fds[], int n_fds)
 529 {
 530   struct msghdr mh = { 0 };
 531   struct iovec iov[1];
 532   char ctl[CMSG_SPACE (sizeof (int) * n_fds)];
 533   struct cmsghdr *cmsg;
 534   char *msg = "fdmsg";
 535   int rv;
 536
 537   iov[0].iov_base = msg;
 538   iov[0].iov_len = strlen (msg);
 539   mh.msg_iov = iov;
 540   mh.msg_iovlen = 1;
 541
 542   clib_memset (&ctl, 0, sizeof (ctl));
 543   mh.msg_control = ctl;
 544   mh.msg_controllen = sizeof (ctl);
 545   cmsg = CMSG_FIRSTHDR (&mh);
 546   cmsg->cmsg_len = CMSG_LEN (sizeof (int) * n_fds);
 547   cmsg->cmsg_level = SOL_SOCKET;
 548   cmsg->cmsg_type = SCM_RIGHTS;
 549   clib_memcpy_fast (CMSG_DATA (cmsg), fds, sizeof (int) * n_fds);
 550
 551   rv = sendmsg (socket_fd, &mh, 0);
 552   if (rv < 0)
 553     return clib_error_return_unix (0, "sendmsg");
 554   return 0;
 555 }
 556
 557 vl_api_shm_elem_config_t *
 558 vl_api_make_shm_config (vl_api_sock_init_shm_t * mp)
 559 {
 560   vl_api_shm_elem_config_t *config = 0, *c;
 561   u64 cfg;
 562   int i;
 563
 564   if (!mp->nitems)
 565     {
 566       vec_validate (config, 6);
 567       config[0].type = VL_API_VLIB_RING;
 568       config[0].size = 256;
 569       config[0].count = 32;
 570
 571       config[1].type = VL_API_VLIB_RING;
 572       config[1].size = 1024;
 573       config[1].count = 16;
 574
 575       config[2].type = VL_API_VLIB_RING;
 576       config[2].size = 4096;
 577       config[2].count = 2;
 578
 579       config[3].type = VL_API_CLIENT_RING;
 580       config[3].size = 256;
 581       config[3].count = 32;
 582
 583       config[4].type = VL_API_CLIENT_RING;
 584       config[4].size = 1024;
 585       config[4].count = 16;
 586
 587       config[5].type = VL_API_CLIENT_RING;
 588       config[5].size = 4096;
 589       config[5].count = 2;
 590
 591       config[6].type = VL_API_QUEUE;
 592       config[6].count = 128;
 593       config[6].size = sizeof (uword);
 594     }
 595   else
 596     {
 597       vec_validate (config, mp->nitems - 1);
 598       for (i = 0; i < mp->nitems; i++)
 599         {
 600           cfg = mp->configs[i];
 601           /* Pretty much a hack but it avoids defining our own api type
 602            * in memclnt.api */
 603           c = (vl_api_shm_elem_config_t *) & cfg;
 604           config[i].type = c->type;
 605           config[i].count = c->count;
 606           config[i].size = c->size;
 607         }
 608     }
 609   return config;
 610 }
 611
 612 /*
 613  * Bootstrap shm api using the socket api
 614  */
 615 void
 616 vl_api_sock_init_shm_t_handler (vl_api_sock_init_shm_t * mp)
 617 {
 618   vl_api_sock_init_shm_reply_t *rmp;
 619   ssvm_private_t _memfd_private, *memfd = &_memfd_private;
 620   svm_map_region_args_t _args, *a = &_args;
 621   vl_api_registration_t *regp;
 622   api_main_t *am = &api_main;
 623   svm_region_t *vlib_rp;
 624   clib_file_t *cf;
 625   vl_api_shm_elem_config_t *config = 0;
 626   vl_shmem_hdr_t *shmem_hdr;
 627   int rv, tries = 1000;
 628
 629   regp = vl_api_client_index_to_registration (mp->client_index);
 630   if (regp == 0)
 631     {
 632       clib_warning ("API client disconnected");
 633       return;
 634     }
 635   if (regp->registration_type != REGISTRATION_TYPE_SOCKET_SERVER)
 636     {
 637       rv = -31;                 /* VNET_API_ERROR_INVALID_REGISTRATION */
 638       goto reply;
 639     }
 640
 641   /*
 642    * Set up a memfd segment of the requested size wherein the
 643    * shmem data structures will be initialized
 644    */
 645   clib_memset (memfd, 0, sizeof (*memfd));
 646   memfd->ssvm_size = mp->requested_size;
 647   memfd->requested_va = 0ULL;
 648   memfd->i_am_master = 1;
 649   memfd->name = format (0, "%s%c", regp->name, 0);
 650
 651   if ((rv = ssvm_master_init_memfd (memfd)))
 652     goto reply;
 653
 654   /* Remember to close this fd when the socket connection goes away */
 655   vec_add1 (regp->additional_fds_to_close, memfd->fd);
 656
 657   /*
 658    * Create a plausible svm_region in the memfd backed segment
 659    */
 660   clib_memset (a, 0, sizeof (*a));
 661   a->baseva = memfd->sh->ssvm_va + MMAP_PAGESIZE;
 662   a->size = memfd->ssvm_size - MMAP_PAGESIZE;
 663   /* $$$$ might want a different config parameter */
 664   a->pvt_heap_size = am->api_pvt_heap_size;
 665   a->flags = SVM_FLAGS_MHEAP;
 666   svm_region_init_mapped_region (a, (svm_region_t *) a->baseva);
 667
 668   /*
 669    * Part deux, initialize the svm_region_t shared-memory header
 670    * api allocation rings, and so on.
 671    */
 672   config = vl_api_make_shm_config (mp);
 673   vlib_rp = (svm_region_t *) a->baseva;
 674   vl_init_shmem (vlib_rp, config, 1 /* is_vlib (dont-care) */ ,
 675                  1 /* is_private */ );
 676
 677   /* Remember who created this. Needs to be post vl_init_shmem */
 678   shmem_hdr = (vl_shmem_hdr_t *) vlib_rp->user_ctx;
 679   shmem_hdr->clib_file_index = vl_api_registration_file_index (regp);
 680
 681   vec_add1 (am->vlib_private_rps, vlib_rp);
 682   memfd->sh->ready = 1;
 683   vec_free (config);
 684
 685   /* Recompute the set of input queues to poll in memclnt_process */
 686   vec_reset_length (vl_api_queue_cursizes);
 687
 688 reply:
 689
 690   rmp = vl_msg_api_alloc (sizeof (*rmp));
 691   rmp->_vl_msg_id = htons (VL_API_SOCK_INIT_SHM_REPLY);
 692   rmp->context = mp->context;
 693   rmp->retval = htonl (rv);
 694
 695   /*
 696    * Note: The reply message needs to make it out the back door
 697    * before we send the magic fd message. That's taken care of by
 698    * the send function.
 699    */
 700   vl_socket_api_send (regp, (u8 *) rmp);
 701
 702   if (rv != 0)
 703     return;
 704
 705   /* Send the magic "here's your sign (aka fd)" socket message */
 706   cf = vl_api_registration_file (regp);
 707
 708   /* Wait for reply to be consumed before sending the fd */
 709   while (tries-- > 0)
 710     {
 711       int bytes;
 712       rv = ioctl (cf->file_descriptor, TIOCOUTQ, &bytes);
 713       if (rv < 0)
 714         {
 715           clib_unix_warning ("ioctl returned");
 716           break;
 717         }
 718       if (bytes == 0)
 719         break;
 720       usleep (1e3);
 721     }
 722
 723   vl_sock_api_send_fd_msg (cf->file_descriptor, &memfd->fd, 1);
 724 }
 725
 726 #define foreach_vlib_api_msg                            \
 727   _(SOCKCLNT_CREATE, sockclnt_create, 1)                \
 728   _(SOCKCLNT_DELETE, sockclnt_delete, 1)                \
 729   _(SOCK_INIT_SHM, sock_init_shm, 1)
 730
 731 clib_error_t *
 732 vl_sock_api_init (vlib_main_t * vm)
 733 {
 734   clib_file_main_t *fm = &file_main;
 735   clib_file_t template = { 0 };
 736   vl_api_registration_t *rp;
 737   socket_main_t *sm = &socket_main;
 738   clib_socket_t *sock = &sm->socksvr_listen_socket;
 739   clib_error_t *error;
 740
 741   /* If not explicitly configured, do not bind/enable, etc. */
 742   if (sm->socket_name == 0)
 743     return 0;
 744
 745 #define _(N,n,t)                                                \
 746     vl_msg_api_set_handlers(VL_API_##N, #n,                     \
 747                            vl_api_##n##_t_handler,              \
 748                            vl_noop_handler,                     \
 749                            vl_api_##n##_t_endian,               \
 750                            vl_api_##n##_t_print,                \
 751                            sizeof(vl_api_##n##_t), t);
 752   foreach_vlib_api_msg;
 753 #undef _
 754
 755   vec_resize (sm->input_buffer, 4096);
 756
 757   sock->config = (char *) sm->socket_name;
 758   sock->flags = CLIB_SOCKET_F_IS_SERVER | CLIB_SOCKET_F_ALLOW_GROUP_WRITE;
 759   error = clib_socket_init (sock);
 760   if (error)
 761     return error;
 762
 763   pool_get (sm->registration_pool, rp);
 764   clib_memset (rp, 0, sizeof (*rp));
 765
 766   rp->registration_type = REGISTRATION_TYPE_SOCKET_LISTEN;
 767
 768   template.read_function = socksvr_accept_ready;
 769   template.write_function = socksvr_bogus_write;
 770   template.file_descriptor = sock->fd;
 771   template.private_data = rp - sm->registration_pool;
 772
 773   rp->clib_file_index = clib_file_add (fm, &template);
 774   return 0;
 775 }
 776
 777 static clib_error_t *
 778 socket_exit (vlib_main_t * vm)
 779 {
 780   socket_main_t *sm = &socket_main;
 781   vl_api_registration_t *rp;
 782
 783   /* Defensive driving in case something wipes out early */
 784   if (sm->registration_pool)
 785     {
 786       u32 index;
 787         /* *INDENT-OFF* */
 788         pool_foreach (rp, sm->registration_pool, ({
 789           vl_api_registration_del_file (rp);
 790           index = rp->vl_api_registration_pool_index;
 791           vl_socket_free_registration_index (index);
 792         }));
 793 /* *INDENT-ON* */
 794     }
 795
 796   return 0;
 797 }
 798
 799 VLIB_MAIN_LOOP_EXIT_FUNCTION (socket_exit);
 800
 801 static clib_error_t *
 802 socksvr_config (vlib_main_t * vm, unformat_input_t * input)
 803 {
 804   socket_main_t *sm = &socket_main;
 805
 806   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 807     {
 808       if (unformat (input, "socket-name %s", &sm->socket_name))
 809         ;
 810       /* DEPRECATE: default keyword is ignored */
 811       else if (unformat (input, "default"))
 812         ;
 813       else
 814         {
 815           return clib_error_return (0, "unknown input '%U'",
 816                                     format_unformat_error, input);
 817         }
 818     }
 819
 820   if (!vec_len (sm->socket_name))
 821     sm->socket_name = format (0, "%s/%s", vlib_unix_get_runtime_dir (),
 822                               API_SOCKET_FILENAME);
 823   vec_terminate_c_string (sm->socket_name);
 824
 825   return 0;
 826 }
 827
 828 VLIB_CONFIG_FUNCTION (socksvr_config, "socksvr");
 829
 830 void
 831 vlibsocket_reference ()
 832 {
 833 }
 834
 835 /*
 836  * fd.io coding-style-patch-verification: ON
 837  *
 838  * Local Variables:
 839  * eval: (c-set-style "gnu")
 840  * End:
 841  */