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