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