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