src/uri/vppcom.c

   1 /*
   2  * Copyright (c) 2017 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #include <stdio.h>
  17 #include <stdlib.h>
  18 #include <signal.h>
  19 #include <svm/svm_fifo_segment.h>
  20 #include <vlibmemory/api.h>
  21 #include <vpp/api/vpe_msg_enum.h>
  22 #include <vnet/session/application_interface.h>
  23 #include <uri/vppcom.h>
  24 #include <vlib/unix/unix.h>
  25 #include <vppinfra/vec_bootstrap.h>
  26
  27 #define vl_typedefs             /* define message structures */
  28 #include <vpp/api/vpe_all_api_h.h>
  29 #undef vl_typedefs
  30
  31 /* declare message handlers for each api */
  32
  33 #define vl_endianfun            /* define message structures */
  34 #include <vpp/api/vpe_all_api_h.h>
  35 #undef vl_endianfun
  36
  37 /* instantiate all the print functions we know about */
  38 #define vl_print(handle, ...)
  39 #define vl_printfun
  40 #include <vpp/api/vpe_all_api_h.h>
  41 #undef vl_printfun
  42
  43 #if (CLIB_DEBUG > 0)
  44 /* Set VPPCOM_DEBUG 2 for connection debug, 3 for read/write debug output */
  45 #define VPPCOM_DEBUG 1
  46 #else
  47 #define VPPCOM_DEBUG 0
  48 #endif
  49
  50 /*
  51  * VPPCOM Private definitions and functions.
  52  */
  53 typedef enum
  54 {
  55   STATE_APP_START,
  56   STATE_APP_CONN_VPP,
  57   STATE_APP_ENABLED,
  58   STATE_APP_ATTACHED,
  59 } app_state_t;
  60
  61 typedef enum
  62 {
  63   STATE_START,
  64   STATE_CONNECT,
  65   STATE_LISTEN,
  66   STATE_ACCEPT,
  67   STATE_DISCONNECT,
  68   STATE_FAILED
  69 } session_state_t;
  70
  71 typedef struct
  72 {
  73   volatile session_state_t state;
  74
  75   svm_fifo_t *server_rx_fifo;
  76   svm_fifo_t *server_tx_fifo;
  77   u32 sm_seg_index;
  78   u64 vpp_session_handle;
  79   unix_shared_memory_queue_t *vpp_event_queue;
  80
  81   /* Socket configuration state */
  82   u8 is_server;
  83   u8 is_listen;
  84   u8 is_cut_thru;
  85   u8 is_nonblocking;
  86   u32 vrf;
  87   u8 is_ip4;
  88   u8 ip[16];
  89   u16 port;
  90   u8 proto;
  91   u64 client_queue_address;
  92   u64 options[16];
  93 } session_t;
  94
  95 typedef struct vppcom_cfg_t_
  96 {
  97   u64 heapsize;
  98   u64 segment_baseva;
  99   u32 segment_size;
 100   u32 add_segment_size;
 101   u32 preallocated_fifo_pairs;
 102   u32 rx_fifo_size;
 103   u32 tx_fifo_size;
 104   u32 event_queue_size;
 105   u32 listen_queue_size;
 106   f64 app_timeout;
 107   f64 session_timeout;
 108   f64 accept_timeout;
 109 } vppcom_cfg_t;
 110
 111 typedef struct vppcom_main_t_
 112 {
 113   u8 init;
 114   u32 *client_session_index_fifo;
 115   volatile u32 bind_session_index;
 116   u32 tx_event_id;
 117   int main_cpu;
 118
 119   /* vpe input queue */
 120   unix_shared_memory_queue_t *vl_input_queue;
 121
 122   /* API client handle */
 123   u32 my_client_index;
 124
 125   /* Session pool */
 126   clib_spinlock_t sessions_lockp;
 127   session_t *sessions;
 128
 129   /* Hash table for disconnect processing */
 130   uword *session_index_by_vpp_handles;
 131
 132   /* Select bitmaps */
 133   clib_bitmap_t *rd_bitmap;
 134   clib_bitmap_t *wr_bitmap;
 135   clib_bitmap_t *ex_bitmap;
 136
 137   /* Our event queue */
 138   unix_shared_memory_queue_t *app_event_queue;
 139
 140   /* unique segment name counter */
 141   u32 unique_segment_index;
 142
 143   pid_t my_pid;
 144
 145   /* For deadman timers */
 146   clib_time_t clib_time;
 147
 148   /* State of the connection, shared between msg RX thread and main thread */
 149   volatile app_state_t app_state;
 150
 151   vppcom_cfg_t cfg;
 152
 153   /* VNET_API_ERROR_FOO -> "Foo" hash table */
 154   uword *error_string_by_error_number;
 155 } vppcom_main_t;
 156
 157 vppcom_main_t vppcom_main = {.my_client_index = ~0 };
 158
 159 static const char *
 160 vppcom_app_state_str (app_state_t state)
 161 {
 162   char *st;
 163
 164   switch (state)
 165     {
 166     case STATE_APP_START:
 167       st = "STATE_APP_START";
 168       break;
 169
 170     case STATE_APP_CONN_VPP:
 171       st = "STATE_APP_CONN_VPP";
 172       break;
 173
 174     case STATE_APP_ENABLED:
 175       st = "STATE_APP_ENABLED";
 176       break;
 177
 178     case STATE_APP_ATTACHED:
 179       st = "STATE_APP_ATTACHED";
 180       break;
 181
 182     default:
 183       st = "UNKNOWN_APP_STATE";
 184       break;
 185     }
 186
 187   return st;
 188 }
 189
 190 static const char *
 191 vppcom_session_state_str (session_state_t state)
 192 {
 193   char *st;
 194
 195   switch (state)
 196     {
 197     case STATE_START:
 198       st = "STATE_START";
 199       break;
 200
 201     case STATE_CONNECT:
 202       st = "STATE_CONNECT";
 203       break;
 204
 205     case STATE_LISTEN:
 206       st = "STATE_LISTEN";
 207       break;
 208
 209     case STATE_ACCEPT:
 210       st = "STATE_ACCEPT";
 211       break;
 212
 213     case STATE_DISCONNECT:
 214       st = "STATE_DISCONNECT";
 215       break;
 216
 217     case STATE_FAILED:
 218       st = "STATE_FAILED";
 219       break;
 220
 221     default:
 222       st = "UNKNOWN_STATE";
 223       break;
 224     }
 225
 226   return st;
 227 }
 228
 229 /*
 230  * VPPCOM Utility Functions
 231  */
 232 static inline int
 233 vppcom_session_at_index (u32 session_index, session_t * volatile *sess)
 234 {
 235   vppcom_main_t *vcm = &vppcom_main;
 236
 237   /* Assumes that caller has acquired spinlock: vcm->sessions_lockp */
 238   if (PREDICT_FALSE ((session_index == ~0) ||
 239                      pool_is_free_index (vcm->sessions, session_index)))
 240     {
 241       clib_warning ("[%d] invalid session, sid (%d) has been closed!",
 242                     vcm->my_pid, session_index);
 243       return VPPCOM_EBADFD;
 244     }
 245   *sess = pool_elt_at_index (vcm->sessions, session_index);
 246   return VPPCOM_OK;
 247 }
 248
 249 static int
 250 vppcom_connect_to_vpp (char *app_name)
 251 {
 252   api_main_t *am = &api_main;
 253   vppcom_main_t *vcm = &vppcom_main;
 254
 255   if (VPPCOM_DEBUG > 0)
 256     printf ("\nConnecting to VPP api...");
 257   if (vl_client_connect_to_vlib ("/vpe-api", app_name, 32) < 0)
 258     {
 259       clib_warning ("[%d] connect to vpp (%s) failed!",
 260                     vcm->my_pid, app_name);
 261       return VPPCOM_ECONNREFUSED;
 262     }
 263
 264   vcm->vl_input_queue = am->shmem_hdr->vl_input_queue;
 265   vcm->my_client_index = am->my_client_index;
 266   if (VPPCOM_DEBUG > 0)
 267     printf (" connected!\n");
 268
 269   vcm->app_state = STATE_APP_CONN_VPP;
 270   return VPPCOM_OK;
 271 }
 272
 273 static u8 *
 274 format_api_error (u8 * s, va_list * args)
 275 {
 276   vppcom_main_t *vcm = &vppcom_main;
 277   i32 error = va_arg (*args, u32);
 278   uword *p;
 279
 280   p = hash_get (vcm->error_string_by_error_number, -error);
 281
 282   if (p)
 283     s = format (s, "%s (%d)", p[0], error);
 284   else
 285     s = format (s, "%d", error);
 286   return s;
 287 }
 288
 289 static void
 290 vppcom_init_error_string_table (void)
 291 {
 292   vppcom_main_t *vcm = &vppcom_main;
 293
 294   vcm->error_string_by_error_number = hash_create (0, sizeof (uword));
 295
 296 #define _(n,v,s) hash_set (vcm->error_string_by_error_number, -v, s);
 297   foreach_vnet_api_error;
 298 #undef _
 299
 300   hash_set (vcm->error_string_by_error_number, 99, "Misc");
 301 }
 302
 303 static inline int
 304 vppcom_wait_for_app_state_change (app_state_t app_state)
 305 {
 306   vppcom_main_t *vcm = &vppcom_main;
 307   f64 timeout = clib_time_now (&vcm->clib_time) + vcm->cfg.app_timeout;
 308
 309   while (clib_time_now (&vcm->clib_time) < timeout)
 310     {
 311       if (vcm->app_state == app_state)
 312         return VPPCOM_OK;
 313     }
 314   if (VPPCOM_DEBUG > 0)
 315     clib_warning ("[%d] timeout waiting for state %s (%d)", vcm->my_pid,
 316                   vppcom_app_state_str (app_state), app_state);
 317   return VPPCOM_ETIMEDOUT;
 318 }
 319
 320 static inline int
 321 vppcom_wait_for_session_state_change (u32 session_index,
 322                                       session_state_t state,
 323                                       f64 wait_for_time)
 324 {
 325   vppcom_main_t *vcm = &vppcom_main;
 326   f64 timeout = clib_time_now (&vcm->clib_time) + wait_for_time;
 327   session_t *volatile session;
 328   int rv;
 329
 330   do
 331     {
 332       clib_spinlock_lock (&vcm->sessions_lockp);
 333       rv = vppcom_session_at_index (session_index, &session);
 334       if (PREDICT_FALSE (rv))
 335         {
 336           clib_spinlock_unlock (&vcm->sessions_lockp);
 337           return rv;
 338         }
 339       if (session->state == state)
 340         {
 341           clib_spinlock_unlock (&vcm->sessions_lockp);
 342           return VPPCOM_OK;
 343         }
 344       clib_spinlock_unlock (&vcm->sessions_lockp);
 345     }
 346   while (clib_time_now (&vcm->clib_time) < timeout);
 347
 348   if (VPPCOM_DEBUG > 0)
 349     clib_warning ("[%d] timeout waiting for state %s (%d)", vcm->my_pid,
 350                   vppcom_session_state_str (state), state);
 351   return VPPCOM_ETIMEDOUT;
 352 }
 353
 354 static inline int
 355 vppcom_wait_for_client_session_index (f64 wait_for_time)
 356 {
 357   vppcom_main_t *vcm = &vppcom_main;
 358   f64 timeout = clib_time_now (&vcm->clib_time) + wait_for_time;
 359
 360   do
 361     {
 362       if (clib_fifo_elts (vcm->client_session_index_fifo))
 363         return VPPCOM_OK;
 364     }
 365   while (clib_time_now (&vcm->clib_time) < timeout);
 366
 367   if (wait_for_time == 0)
 368     return VPPCOM_EAGAIN;
 369
 370   if (VPPCOM_DEBUG > 0)
 371     clib_warning ("[%d] timeout waiting for client_session_index",
 372                   vcm->my_pid);
 373   return VPPCOM_ETIMEDOUT;
 374 }
 375
 376 /*
 377  * VPP-API message functions
 378  */
 379 static void
 380 vppcom_send_session_enable_disable (u8 is_enable)
 381 {
 382   vppcom_main_t *vcm = &vppcom_main;
 383   vl_api_session_enable_disable_t *bmp;
 384   bmp = vl_msg_api_alloc (sizeof (*bmp));
 385   memset (bmp, 0, sizeof (*bmp));
 386
 387   bmp->_vl_msg_id = ntohs (VL_API_SESSION_ENABLE_DISABLE);
 388   bmp->client_index = vcm->my_client_index;
 389   bmp->context = htonl (0xfeedface);
 390   bmp->is_enable = is_enable;
 391   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
 392 }
 393
 394 static int
 395 vppcom_app_session_enable (void)
 396 {
 397   vppcom_main_t *vcm = &vppcom_main;
 398   int rv;
 399
 400   if (vcm->app_state != STATE_APP_ENABLED)
 401     {
 402       vppcom_send_session_enable_disable (1 /* is_enabled == TRUE */ );
 403       rv = vppcom_wait_for_app_state_change (STATE_APP_ENABLED);
 404       if (PREDICT_FALSE (rv))
 405         {
 406           if (VPPCOM_DEBUG > 0)
 407             clib_warning ("[%d] Session enable timed out, rv = %s (%d)",
 408                           vcm->my_pid, vppcom_retval_str (rv), rv);
 409           return rv;
 410         }
 411     }
 412   return VPPCOM_OK;
 413 }
 414
 415 static void
 416   vl_api_session_enable_disable_reply_t_handler
 417   (vl_api_session_enable_disable_reply_t * mp)
 418 {
 419   vppcom_main_t *vcm = &vppcom_main;
 420
 421   if (mp->retval)
 422     {
 423       clib_warning ("[%d] session_enable_disable failed: %U", vcm->my_pid,
 424                     format_api_error, ntohl (mp->retval));
 425     }
 426   else
 427     vcm->app_state = STATE_APP_ENABLED;
 428 }
 429
 430 static void
 431 vppcom_app_send_attach (void)
 432 {
 433   vppcom_main_t *vcm = &vppcom_main;
 434   vl_api_application_attach_t *bmp;
 435   bmp = vl_msg_api_alloc (sizeof (*bmp));
 436   memset (bmp, 0, sizeof (*bmp));
 437
 438   bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_ATTACH);
 439   bmp->client_index = vcm->my_client_index;
 440   bmp->context = htonl (0xfeedface);
 441   bmp->options[APP_OPTIONS_FLAGS] =
 442     APP_OPTIONS_FLAGS_USE_FIFO | APP_OPTIONS_FLAGS_ADD_SEGMENT;
 443   bmp->options[SESSION_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
 444   bmp->options[SESSION_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
 445   bmp->options[SESSION_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
 446   bmp->options[SESSION_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
 447   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
 448 }
 449
 450 static int
 451 vppcom_app_attach (void)
 452 {
 453   vppcom_main_t *vcm = &vppcom_main;
 454   int rv;
 455
 456   vppcom_app_send_attach ();
 457   rv = vppcom_wait_for_app_state_change (STATE_APP_ATTACHED);
 458   if (PREDICT_FALSE (rv))
 459     {
 460       if (VPPCOM_DEBUG > 0)
 461         clib_warning ("[%d] application attach timed out, rv = %s (%d)",
 462                       vcm->my_pid, vppcom_retval_str (rv), rv);
 463       return rv;
 464     }
 465   return VPPCOM_OK;
 466 }
 467
 468 static void
 469 vppcom_app_detach (void)
 470 {
 471   vppcom_main_t *vcm = &vppcom_main;
 472   vl_api_application_detach_t *bmp;
 473   bmp = vl_msg_api_alloc (sizeof (*bmp));
 474   memset (bmp, 0, sizeof (*bmp));
 475
 476   bmp->_vl_msg_id = ntohs (VL_API_APPLICATION_DETACH);
 477   bmp->client_index = vcm->my_client_index;
 478   bmp->context = htonl (0xfeedface);
 479   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
 480 }
 481
 482 static void
 483 vl_api_application_attach_reply_t_handler (vl_api_application_attach_reply_t *
 484                                            mp)
 485 {
 486   vppcom_main_t *vcm = &vppcom_main;
 487   static svm_fifo_segment_create_args_t _a;
 488   svm_fifo_segment_create_args_t *a = &_a;
 489   int rv;
 490
 491   memset (a, 0, sizeof (*a));
 492   if (mp->retval)
 493     {
 494       clib_warning ("[%d] attach failed: %U", vcm->my_pid,
 495                     format_api_error, ntohl (mp->retval));
 496       return;
 497     }
 498
 499   if (mp->segment_name_length == 0)
 500     {
 501       clib_warning ("[%d] segment_name_length zero", vcm->my_pid);
 502       return;
 503     }
 504
 505   a->segment_name = (char *) mp->segment_name;
 506   a->segment_size = mp->segment_size;
 507
 508   ASSERT (mp->app_event_queue_address);
 509
 510   /* Attach to the segment vpp created */
 511   rv = svm_fifo_segment_attach (a);
 512   vec_reset_length (a->new_segment_indices);
 513   if (PREDICT_FALSE (rv))
 514     {
 515       clib_warning ("[%d] svm_fifo_segment_attach ('%s') failed", vcm->my_pid,
 516                     mp->segment_name);
 517       return;
 518     }
 519
 520   vcm->app_event_queue =
 521     uword_to_pointer (mp->app_event_queue_address,
 522                       unix_shared_memory_queue_t *);
 523
 524   vcm->app_state = STATE_APP_ATTACHED;
 525 }
 526
 527 static void
 528 vl_api_application_detach_reply_t_handler (vl_api_application_detach_reply_t *
 529                                            mp)
 530 {
 531   vppcom_main_t *vcm = &vppcom_main;
 532
 533   if (mp->retval)
 534     clib_warning ("[%d] detach failed: %U", vcm->my_pid, format_api_error,
 535                   ntohl (mp->retval));
 536
 537   vcm->app_state = STATE_APP_ENABLED;
 538 }
 539
 540 static void
 541 vl_api_disconnect_session_reply_t_handler (vl_api_disconnect_session_reply_t *
 542                                            mp)
 543 {
 544   vppcom_main_t *vcm = &vppcom_main;
 545   uword *p;
 546
 547   p = hash_get (vcm->session_index_by_vpp_handles, mp->handle);
 548   if (p)
 549     {
 550       session_t *session = 0;
 551       int rv;
 552       clib_spinlock_lock (&vcm->sessions_lockp);
 553       rv = vppcom_session_at_index (p[0], &session);
 554       if (PREDICT_FALSE (rv))
 555         {
 556           if (VPPCOM_DEBUG > 1)
 557             clib_warning ("[%d] invalid session, sid (%d) has been closed!",
 558                           vcm->my_pid, p[0]);
 559         }
 560       hash_unset (vcm->session_index_by_vpp_handles, mp->handle);
 561       session->state = STATE_DISCONNECT;
 562       clib_spinlock_unlock (&vcm->sessions_lockp);
 563     }
 564   else
 565     {
 566       if (VPPCOM_DEBUG > 1)
 567         clib_warning ("[%d] couldn't find session key %llx", vcm->my_pid,
 568                       mp->handle);
 569     }
 570
 571   if (mp->retval)
 572     clib_warning ("[%d] disconnect_session failed: %U", vcm->my_pid,
 573                   format_api_error, ntohl (mp->retval));
 574 }
 575
 576 static void
 577 vl_api_map_another_segment_t_handler (vl_api_map_another_segment_t * mp)
 578 {
 579   vppcom_main_t *vcm = &vppcom_main;
 580   static svm_fifo_segment_create_args_t _a;
 581   svm_fifo_segment_create_args_t *a = &_a;
 582   int rv;
 583
 584   memset (a, 0, sizeof (*a));
 585   a->segment_name = (char *) mp->segment_name;
 586   a->segment_size = mp->segment_size;
 587   /* Attach to the segment vpp created */
 588   rv = svm_fifo_segment_attach (a);
 589   vec_reset_length (a->new_segment_indices);
 590   if (PREDICT_FALSE (rv))
 591     {
 592       clib_warning ("[%d] svm_fifo_segment_attach ('%s') failed",
 593                     vcm->my_pid, mp->segment_name);
 594       return;
 595     }
 596   if (VPPCOM_DEBUG > 1)
 597     clib_warning ("[%d] mapped new segment '%s' size %d", vcm->my_pid,
 598                   mp->segment_name, mp->segment_size);
 599 }
 600
 601 static void
 602 vl_api_disconnect_session_t_handler (vl_api_disconnect_session_t * mp)
 603 {
 604   vppcom_main_t *vcm = &vppcom_main;
 605   session_t *session = 0;
 606   vl_api_disconnect_session_reply_t *rmp;
 607   uword *p;
 608   int rv = 0;
 609
 610   p = hash_get (vcm->session_index_by_vpp_handles, mp->handle);
 611   if (p)
 612     {
 613       int rval;
 614       clib_spinlock_lock (&vcm->sessions_lockp);
 615       rval = vppcom_session_at_index (p[0], &session);
 616       if (PREDICT_FALSE (rval))
 617         {
 618           if (VPPCOM_DEBUG > 1)
 619             clib_warning ("[%d] invalid session, sid (%d) has been closed!",
 620                           vcm->my_pid, p[0]);
 621         }
 622       else
 623         pool_put (vcm->sessions, session);
 624       clib_spinlock_unlock (&vcm->sessions_lockp);
 625       hash_unset (vcm->session_index_by_vpp_handles, mp->handle);
 626     }
 627   else
 628     {
 629       clib_warning ("[%d] couldn't find session key %llx", vcm->my_pid,
 630                     mp->handle);
 631       rv = -11;
 632     }
 633
 634   rmp = vl_msg_api_alloc (sizeof (*rmp));
 635   memset (rmp, 0, sizeof (*rmp));
 636
 637   rmp->_vl_msg_id = ntohs (VL_API_DISCONNECT_SESSION_REPLY);
 638   rmp->retval = htonl (rv);
 639   rmp->handle = mp->handle;
 640   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & rmp);
 641 }
 642
 643 static void
 644 vl_api_reset_session_t_handler (vl_api_reset_session_t * mp)
 645 {
 646   vppcom_main_t *vcm = &vppcom_main;
 647   session_t *session = 0;
 648   vl_api_reset_session_reply_t *rmp;
 649   uword *p;
 650   int rv = 0;
 651
 652   p = hash_get (vcm->session_index_by_vpp_handles, mp->handle);
 653   if (p)
 654     {
 655       int rval;
 656       clib_spinlock_lock (&vcm->sessions_lockp);
 657       rval = vppcom_session_at_index (p[0], &session);
 658       if (PREDICT_FALSE (rval))
 659         {
 660           if (VPPCOM_DEBUG > 1)
 661             clib_warning ("[%d] invalid session, sid (%d) has been closed!",
 662                           vcm->my_pid, p[0]);
 663         }
 664       else
 665         pool_put (vcm->sessions, session);
 666       clib_spinlock_unlock (&vcm->sessions_lockp);
 667       hash_unset (vcm->session_index_by_vpp_handles, mp->handle);
 668     }
 669   else
 670     {
 671       clib_warning ("[%d] couldn't find session key %llx", vcm->my_pid,
 672                     mp->handle);
 673       rv = -11;
 674     }
 675
 676   rmp = vl_msg_api_alloc (sizeof (*rmp));
 677   memset (rmp, 0, sizeof (*rmp));
 678   rmp->_vl_msg_id = ntohs (VL_API_RESET_SESSION_REPLY);
 679   rmp->retval = htonl (rv);
 680   rmp->handle = mp->handle;
 681   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & rmp);
 682 }
 683
 684 static void
 685 vl_api_connect_session_reply_t_handler (vl_api_connect_session_reply_t * mp)
 686 {
 687   vppcom_main_t *vcm = &vppcom_main;
 688   session_t *session;
 689   u32 session_index;
 690   svm_fifo_t *rx_fifo, *tx_fifo;
 691   u8 is_cut_thru = 0;
 692   int rv;
 693
 694   if (mp->retval)
 695     {
 696       clib_warning ("[%d] connect failed: %U", vcm->my_pid, format_api_error,
 697                     ntohl (mp->retval));
 698       return;
 699     }
 700
 701   session_index = mp->context;
 702   if (VPPCOM_DEBUG > 1)
 703     clib_warning ("[%d] session_index = %d 0x%08x", vcm->my_pid,
 704                   session_index, session_index);
 705
 706   clib_spinlock_lock (&vcm->sessions_lockp);
 707   if (pool_is_free_index (vcm->sessions, session_index))
 708     {
 709       clib_spinlock_unlock (&vcm->sessions_lockp);
 710       if (VPPCOM_DEBUG > 1)
 711         clib_warning ("[%d] invalid session, sid %d is closed!",
 712                       vcm->my_pid, session_index);
 713       return;
 714     }
 715
 716   /* We've been redirected */
 717   if (mp->segment_name_length > 0)
 718     {
 719       static svm_fifo_segment_create_args_t _a;
 720       svm_fifo_segment_create_args_t *a = &_a;
 721
 722       is_cut_thru = 1;
 723       memset (a, 0, sizeof (*a));
 724       a->segment_name = (char *) mp->segment_name;
 725       if (VPPCOM_DEBUG > 1)
 726         clib_warning ("[%d] cut-thru segment: %s", vcm->my_pid,
 727                       a->segment_name);
 728       rv = svm_fifo_segment_attach (a);
 729       vec_reset_length (a->new_segment_indices);
 730       if (PREDICT_FALSE (rv))
 731         {
 732           clib_warning ("[%d] sm_fifo_segment_attach ('%s') failed",
 733                         vcm->my_pid, a->segment_name);
 734           return;
 735         }
 736     }
 737
 738   /*
 739    * Setup session
 740    */
 741   if (VPPCOM_DEBUG > 1)
 742     clib_warning ("[%d] client sid %d", vcm->my_pid, session_index);
 743
 744   session = pool_elt_at_index (vcm->sessions, session_index);
 745   session->is_cut_thru = is_cut_thru;
 746   session->vpp_event_queue = uword_to_pointer (mp->vpp_event_queue_address,
 747                                                unix_shared_memory_queue_t *);
 748
 749   rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
 750   rx_fifo->client_session_index = session_index;
 751   tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
 752   tx_fifo->client_session_index = session_index;
 753
 754   session->server_rx_fifo = rx_fifo;
 755   session->server_tx_fifo = tx_fifo;
 756   session->vpp_session_handle = mp->handle;
 757   session->state = STATE_CONNECT;
 758
 759   /* Add it to lookup table */
 760   hash_set (vcm->session_index_by_vpp_handles, mp->handle, session_index);
 761   clib_spinlock_unlock (&vcm->sessions_lockp);
 762 }
 763
 764 static void
 765 vppcom_send_connect_sock (session_t * session, u32 session_index)
 766 {
 767   vppcom_main_t *vcm = &vppcom_main;
 768   vl_api_connect_sock_t *cmp;
 769
 770   /* Assumes caller as acquired the spinlock: vcm->sessions_lockp */
 771   session->is_server = 0;
 772   cmp = vl_msg_api_alloc (sizeof (*cmp));
 773   memset (cmp, 0, sizeof (*cmp));
 774   cmp->_vl_msg_id = ntohs (VL_API_CONNECT_SOCK);
 775   cmp->client_index = vcm->my_client_index;
 776   cmp->context = session_index;
 777
 778   if (VPPCOM_DEBUG > 1)
 779     clib_warning ("[%d] session_index = %d 0x%08x",
 780                   vcm->my_pid, session_index, session_index);
 781
 782   cmp->vrf = session->vrf;
 783   cmp->is_ip4 = session->is_ip4;
 784   clib_memcpy (cmp->ip, session->ip, sizeof (cmp->ip));
 785   cmp->port = session->port;
 786   cmp->proto = session->proto;
 787   clib_memcpy (cmp->options, session->options, sizeof (cmp->options));
 788   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & cmp);
 789 }
 790
 791 static int
 792 vppcom_send_disconnect (u32 session_index)
 793 {
 794   vppcom_main_t *vcm = &vppcom_main;
 795   vl_api_disconnect_session_t *dmp;
 796   session_t *session = 0;
 797   int rv;
 798
 799   clib_spinlock_lock (&vcm->sessions_lockp);
 800   rv = vppcom_session_at_index (session_index, &session);
 801   if (PREDICT_FALSE (rv))
 802     {
 803       clib_spinlock_unlock (&vcm->sessions_lockp);
 804       if (VPPCOM_DEBUG > 1)
 805         clib_warning ("[%d] invalid session, sid (%d) has been closed!",
 806                       vcm->my_pid, session_index);
 807       return rv;
 808     }
 809
 810   dmp = vl_msg_api_alloc (sizeof (*dmp));
 811   memset (dmp, 0, sizeof (*dmp));
 812   dmp->_vl_msg_id = ntohs (VL_API_DISCONNECT_SESSION);
 813   dmp->client_index = vcm->my_client_index;
 814   dmp->handle = session->vpp_session_handle;
 815   clib_spinlock_unlock (&vcm->sessions_lockp);
 816   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & dmp);
 817   return VPPCOM_OK;
 818 }
 819
 820 static void
 821 vl_api_bind_sock_reply_t_handler (vl_api_bind_sock_reply_t * mp)
 822 {
 823   vppcom_main_t *vcm = &vppcom_main;
 824   session_t *session = 0;
 825   int rv;
 826
 827   if (mp->retval)
 828     clib_warning ("[%d] bind failed: %U", vcm->my_pid, format_api_error,
 829                   ntohl (mp->retval));
 830
 831   ASSERT (vcm->bind_session_index != ~0);
 832
 833   clib_spinlock_lock (&vcm->sessions_lockp);
 834   rv = vppcom_session_at_index (vcm->bind_session_index, &session);
 835   if (rv == VPPCOM_OK)
 836     {
 837       session->vpp_session_handle = mp->handle;
 838       hash_set (vcm->session_index_by_vpp_handles, mp->handle,
 839                 vcm->bind_session_index);
 840       session->state = mp->retval ? STATE_FAILED : STATE_LISTEN;
 841       vcm->bind_session_index = ~0;
 842     }
 843   clib_spinlock_unlock (&vcm->sessions_lockp);
 844 }
 845
 846 static void
 847 vl_api_unbind_sock_reply_t_handler (vl_api_unbind_sock_reply_t * mp)
 848 {
 849   vppcom_main_t *vcm = &vppcom_main;
 850   session_t *session = 0;
 851   int rv;
 852
 853   clib_spinlock_lock (&vcm->sessions_lockp);
 854   rv = vppcom_session_at_index (vcm->bind_session_index, &session);
 855   if (PREDICT_FALSE (rv))
 856     {
 857       if (VPPCOM_DEBUG > 1)
 858         clib_warning ("[%d] invalid session, sid (%d) has been closed!",
 859                       vcm->my_pid, vcm->bind_session_index);
 860     }
 861
 862   if (mp->retval)
 863     clib_warning ("[%d] unbind failed: %U", vcm->my_pid, format_api_error,
 864                   ntohl (mp->retval));
 865
 866   vcm->bind_session_index = ~0;
 867   session->state = STATE_START;
 868   clib_spinlock_unlock (&vcm->sessions_lockp);
 869 }
 870
 871 u8 *
 872 format_ip4_address (u8 * s, va_list * args)
 873 {
 874   u8 *a = va_arg (*args, u8 *);
 875   return format (s, "%d.%d.%d.%d", a[0], a[1], a[2], a[3]);
 876 }
 877
 878 u8 *
 879 format_ip6_address (u8 * s, va_list * args)
 880 {
 881   ip6_address_t *a = va_arg (*args, ip6_address_t *);
 882   u32 i, i_max_n_zero, max_n_zeros, i_first_zero, n_zeros, last_double_colon;
 883
 884   i_max_n_zero = ARRAY_LEN (a->as_u16);
 885   max_n_zeros = 0;
 886   i_first_zero = i_max_n_zero;
 887   n_zeros = 0;
 888   for (i = 0; i < ARRAY_LEN (a->as_u16); i++)
 889     {
 890       u32 is_zero = a->as_u16[i] == 0;
 891       if (is_zero && i_first_zero >= ARRAY_LEN (a->as_u16))
 892         {
 893           i_first_zero = i;
 894           n_zeros = 0;
 895         }
 896       n_zeros += is_zero;
 897       if ((!is_zero && n_zeros > max_n_zeros)
 898           || (i + 1 >= ARRAY_LEN (a->as_u16) && n_zeros > max_n_zeros))
 899         {
 900           i_max_n_zero = i_first_zero;
 901           max_n_zeros = n_zeros;
 902           i_first_zero = ARRAY_LEN (a->as_u16);
 903           n_zeros = 0;
 904         }
 905     }
 906
 907   last_double_colon = 0;
 908   for (i = 0; i < ARRAY_LEN (a->as_u16); i++)
 909     {
 910       if (i == i_max_n_zero && max_n_zeros > 1)
 911         {
 912           s = format (s, "::");
 913           i += max_n_zeros - 1;
 914           last_double_colon = 1;
 915         }
 916       else
 917         {
 918           s = format (s, "%s%x",
 919                       (last_double_colon || i == 0) ? "" : ":",
 920                       clib_net_to_host_u16 (a->as_u16[i]));
 921           last_double_colon = 0;
 922         }
 923     }
 924
 925   return s;
 926 }
 927
 928 /* Format an IP46 address. */
 929 u8 *
 930 format_ip46_address (u8 * s, va_list * args)
 931 {
 932   ip46_address_t *ip46 = va_arg (*args, ip46_address_t *);
 933   ip46_type_t type = va_arg (*args, ip46_type_t);
 934   int is_ip4 = 1;
 935
 936   switch (type)
 937     {
 938     case IP46_TYPE_ANY:
 939       is_ip4 = ip46_address_is_ip4 (ip46);
 940       break;
 941     case IP46_TYPE_IP4:
 942       is_ip4 = 1;
 943       break;
 944     case IP46_TYPE_IP6:
 945       is_ip4 = 0;
 946       break;
 947     }
 948
 949   return is_ip4 ?
 950     format (s, "%U", format_ip4_address, &ip46->ip4) :
 951     format (s, "%U", format_ip6_address, &ip46->ip6);
 952 }
 953
 954 static void
 955 vl_api_accept_session_t_handler (vl_api_accept_session_t * mp)
 956 {
 957   vppcom_main_t *vcm = &vppcom_main;
 958   vl_api_accept_session_reply_t *rmp;
 959   svm_fifo_t *rx_fifo, *tx_fifo;
 960   session_t *session;
 961   u32 session_index;
 962   int rv = 0;
 963
 964   if (!clib_fifo_free_elts (vcm->client_session_index_fifo))
 965     {
 966       clib_warning ("[%d] client session queue is full!", vcm->my_pid);
 967       rv = VNET_API_ERROR_QUEUE_FULL;
 968       goto send_reply;
 969     }
 970
 971   if (VPPCOM_DEBUG > 1)
 972     {
 973       u8 *ip_str = format (0, "%U", format_ip46_address, &mp->ip, mp->is_ip4);
 974       clib_warning ("[%d] accepted session from: %s:%d", vcm->my_pid, ip_str,
 975                     clib_net_to_host_u16 (mp->port));
 976       vec_free (ip_str);
 977     }
 978
 979   clib_spinlock_lock (&vcm->sessions_lockp);
 980   /* Allocate local session and set it up */
 981   pool_get (vcm->sessions, session);
 982   memset (session, 0, sizeof (*session));
 983   session_index = session - vcm->sessions;
 984
 985   rx_fifo = uword_to_pointer (mp->server_rx_fifo, svm_fifo_t *);
 986   rx_fifo->client_session_index = session_index;
 987   tx_fifo = uword_to_pointer (mp->server_tx_fifo, svm_fifo_t *);
 988   tx_fifo->client_session_index = session_index;
 989
 990   session->server_rx_fifo = rx_fifo;
 991   session->server_tx_fifo = tx_fifo;
 992   session->vpp_event_queue = uword_to_pointer (mp->vpp_event_queue_address,
 993                                                unix_shared_memory_queue_t *);
 994   session->state = STATE_ACCEPT;
 995   session->is_cut_thru = 0;
 996   session->port = ntohs (mp->port);
 997   session->is_ip4 = mp->is_ip4;
 998   clib_memcpy (session->ip, mp->ip, sizeof (session->ip));
 999   clib_spinlock_unlock (&vcm->sessions_lockp);
1000
1001   /* Add it to lookup table */
1002   hash_set (vcm->session_index_by_vpp_handles, mp->handle, session_index);
1003
1004   clib_fifo_add1 (vcm->client_session_index_fifo, session_index);
1005
1006   /*
1007    * Send accept reply to vpp
1008    */
1009 send_reply:
1010   rmp = vl_msg_api_alloc (sizeof (*rmp));
1011   memset (rmp, 0, sizeof (*rmp));
1012   rmp->_vl_msg_id = ntohs (VL_API_ACCEPT_SESSION_REPLY);
1013   rmp->retval = htonl (rv);
1014   rmp->handle = mp->handle;
1015   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & rmp);
1016 }
1017
1018 /*
1019  * Acting as server for redirected connect requests
1020  */
1021 static void
1022 vl_api_connect_sock_t_handler (vl_api_connect_sock_t * mp)
1023 {
1024   static svm_fifo_segment_create_args_t _a;
1025   svm_fifo_segment_create_args_t *a = &_a;
1026   vppcom_main_t *vcm = &vppcom_main;
1027   u32 session_index;
1028   svm_fifo_segment_private_t *seg;
1029   unix_shared_memory_queue_t *client_q;
1030   vl_api_connect_session_reply_t *rmp;
1031   session_t *session = 0;
1032   int rv = 0;
1033   svm_fifo_t *rx_fifo;
1034   svm_fifo_t *tx_fifo;
1035   unix_shared_memory_queue_t *event_q = 0;
1036
1037   if (!clib_fifo_free_elts (vcm->client_session_index_fifo))
1038     {
1039       if (VPPCOM_DEBUG > 1)
1040         clib_warning ("[%d] client session queue is full!", vcm->my_pid);
1041       rv = VNET_API_ERROR_QUEUE_FULL;
1042       goto send_reply;
1043     }
1044
1045   /* Create the segment */
1046   memset (a, 0, sizeof (*a));
1047   a->segment_name = (char *) format ((u8 *) a->segment_name, "%d:segment%d%c",
1048                                      vcm->my_pid, vcm->unique_segment_index++,
1049                                      0);
1050   a->segment_size = vcm->cfg.segment_size;
1051   a->preallocated_fifo_pairs = vcm->cfg.preallocated_fifo_pairs;
1052   a->rx_fifo_size = vcm->cfg.rx_fifo_size;
1053   a->tx_fifo_size = vcm->cfg.tx_fifo_size;
1054
1055   rv = svm_fifo_segment_create (a);
1056   if (PREDICT_FALSE (rv))
1057     {
1058       if (VPPCOM_DEBUG > 1)
1059         clib_warning ("[%d] svm_fifo_segment_create ('%s') failed",
1060                       vcm->my_pid, a->segment_name);
1061       vec_reset_length (a->new_segment_indices);
1062       rv = VNET_API_ERROR_URI_FIFO_CREATE_FAILED;
1063       goto send_reply;
1064     }
1065
1066   if (VPPCOM_DEBUG > 1)
1067     clib_warning ("[%d] created segment '%s'", vcm->my_pid, a->segment_name);
1068
1069   clib_spinlock_lock (&vcm->sessions_lockp);
1070   pool_get (vcm->sessions, session);
1071   memset (session, 0, sizeof (*session));
1072   session_index = session - vcm->sessions;
1073
1074   session->sm_seg_index = a->new_segment_indices[0];
1075   vec_reset_length (a->new_segment_indices);
1076
1077   seg = svm_fifo_segment_get_segment (session->sm_seg_index);
1078   rx_fifo = session->server_rx_fifo =
1079     svm_fifo_segment_alloc_fifo (seg, vcm->cfg.rx_fifo_size,
1080                                  FIFO_SEGMENT_RX_FREELIST);
1081   if (PREDICT_FALSE (!session->server_rx_fifo))
1082     {
1083       svm_fifo_segment_delete (seg);
1084       clib_warning ("[%d] rx fifo alloc failed, size %ld (0x%lx)",
1085                     vcm->my_pid, vcm->cfg.rx_fifo_size,
1086                     vcm->cfg.rx_fifo_size);
1087       rv = VNET_API_ERROR_URI_FIFO_CREATE_FAILED;
1088       clib_spinlock_unlock (&vcm->sessions_lockp);
1089       goto send_reply;
1090     }
1091
1092   tx_fifo = session->server_tx_fifo =
1093     svm_fifo_segment_alloc_fifo (seg, vcm->cfg.tx_fifo_size,
1094                                  FIFO_SEGMENT_TX_FREELIST);
1095   if (PREDICT_FALSE (!session->server_tx_fifo))
1096     {
1097       svm_fifo_segment_delete (seg);
1098       if (VPPCOM_DEBUG > 1)
1099         clib_warning ("[%d] tx fifo alloc failed, size %ld (0x%lx)",
1100                       vcm->my_pid, vcm->cfg.tx_fifo_size,
1101                       vcm->cfg.tx_fifo_size);
1102       rv = VNET_API_ERROR_URI_FIFO_CREATE_FAILED;
1103       clib_spinlock_unlock (&vcm->sessions_lockp);
1104       goto send_reply;
1105     }
1106
1107   session->server_rx_fifo->master_session_index = session_index;
1108   session->server_tx_fifo->master_session_index = session_index;
1109   session->client_queue_address = mp->client_queue_address;
1110   session->is_cut_thru = 1;
1111   session->is_server = 1;
1112   session->is_ip4 = mp->is_ip4;
1113   session->port = mp->port;
1114   {
1115     void *oldheap;
1116     ssvm_shared_header_t *sh = seg->ssvm.sh;
1117
1118     ssvm_lock_non_recursive (sh, 1);
1119     oldheap = ssvm_push_heap (sh);
1120     event_q = session->vpp_event_queue =
1121       unix_shared_memory_queue_init (vcm->cfg.event_queue_size,
1122                                      sizeof (session_fifo_event_t),
1123                                      vcm->my_pid, 0 /* signal not sent */ );
1124     ssvm_pop_heap (oldheap);
1125     ssvm_unlock_non_recursive (sh);
1126   }
1127   clib_memcpy (session->ip, mp->ip, sizeof (session->ip));
1128
1129   session->state = STATE_ACCEPT;
1130   if (VPPCOM_DEBUG > 1)
1131     clib_warning ("[%d] Connected cut-thru to client: sid %d",
1132                   vcm->my_pid, session_index);
1133   clib_spinlock_unlock (&vcm->sessions_lockp);
1134   clib_fifo_add1 (vcm->client_session_index_fifo, session_index);
1135
1136 send_reply:
1137   rmp = vl_msg_api_alloc (sizeof (*rmp));
1138   memset (rmp, 0, sizeof (*rmp));
1139
1140   rmp->_vl_msg_id = ntohs (VL_API_CONNECT_SESSION_REPLY);
1141   rmp->context = mp->context;
1142   rmp->retval = htonl (rv);
1143   rmp->segment_name_length = vec_len (a->segment_name);
1144   clib_memcpy (rmp->segment_name, a->segment_name, vec_len (a->segment_name));
1145   vec_reset_length (a->segment_name);
1146
1147   if (event_q)
1148     {
1149       rmp->vpp_event_queue_address = pointer_to_uword (event_q);
1150       rmp->server_rx_fifo = pointer_to_uword (rx_fifo);
1151       rmp->server_tx_fifo = pointer_to_uword (tx_fifo);
1152     }
1153   client_q =
1154     uword_to_pointer (mp->client_queue_address, unix_shared_memory_queue_t *);
1155
1156   ASSERT (client_q);
1157   vl_msg_api_send_shmem (client_q, (u8 *) & rmp);
1158 }
1159
1160 static void
1161 vppcom_send_bind_sock (session_t * session)
1162 {
1163   vppcom_main_t *vcm = &vppcom_main;
1164   vl_api_bind_sock_t *bmp;
1165
1166   /* Assumes caller has acquired spinlock: vcm->sessions_lockp */
1167   session->is_server = 1;
1168   bmp = vl_msg_api_alloc (sizeof (*bmp));
1169   memset (bmp, 0, sizeof (*bmp));
1170
1171   bmp->_vl_msg_id = ntohs (VL_API_BIND_SOCK);
1172   bmp->client_index = vcm->my_client_index;
1173   bmp->context = htonl (0xfeedface);
1174   bmp->vrf = session->vrf;
1175   bmp->is_ip4 = session->is_ip4;
1176   clib_memcpy (bmp->ip, session->ip, sizeof (bmp->ip));
1177   bmp->port = session->port;
1178   bmp->proto = session->proto;
1179   clib_memcpy (bmp->options, session->options, sizeof (bmp->options));
1180   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & bmp);
1181 }
1182
1183 static void
1184 vppcom_send_unbind_sock (u32 session_index)
1185 {
1186   vppcom_main_t *vcm = &vppcom_main;
1187   vl_api_unbind_sock_t *ump;
1188   session_t *session = 0;
1189   int rv;
1190
1191   clib_spinlock_lock (&vcm->sessions_lockp);
1192   rv = vppcom_session_at_index (session_index, &session);
1193   if (PREDICT_FALSE (rv))
1194     {
1195       clib_spinlock_unlock (&vcm->sessions_lockp);
1196       if (VPPCOM_DEBUG > 0)
1197         clib_warning ("[%d] invalid session, sid (%d) has been closed!",
1198                       vcm->my_pid, session_index);
1199       return;
1200     }
1201
1202   ump = vl_msg_api_alloc (sizeof (*ump));
1203   memset (ump, 0, sizeof (*ump));
1204
1205   ump->_vl_msg_id = ntohs (VL_API_UNBIND_SOCK);
1206   ump->client_index = vcm->my_client_index;
1207   ump->handle = session->vpp_session_handle;
1208   clib_spinlock_unlock (&vcm->sessions_lockp);
1209   vl_msg_api_send_shmem (vcm->vl_input_queue, (u8 *) & ump);
1210 }
1211
1212 static int
1213 vppcom_session_unbind_cut_thru (session_t * session)
1214 {
1215   svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
1216   svm_fifo_segment_private_t *seg;
1217   int rv = VPPCOM_OK;
1218
1219   seg = vec_elt_at_index (sm->segments, session->sm_seg_index);
1220   svm_fifo_segment_free_fifo (seg, session->server_rx_fifo,
1221                               FIFO_SEGMENT_RX_FREELIST);
1222   svm_fifo_segment_free_fifo (seg, session->server_tx_fifo,
1223                               FIFO_SEGMENT_TX_FREELIST);
1224   svm_fifo_segment_delete (seg);
1225
1226   return rv;
1227 }
1228
1229 static int
1230 vppcom_session_unbind (u32 session_index)
1231 {
1232   vppcom_main_t *vcm = &vppcom_main;
1233   int rv;
1234
1235   clib_spinlock_lock (&vcm->sessions_lockp);
1236   if (PREDICT_FALSE (pool_is_free_index (vcm->sessions, session_index)))
1237     {
1238       clib_spinlock_unlock (&vcm->sessions_lockp);
1239       if (VPPCOM_DEBUG > 1)
1240         clib_warning ("[%d] invalid session, sid (%d) has been closed!",
1241                       vcm->my_pid, session_index);
1242       return VPPCOM_EBADFD;
1243     }
1244   clib_spinlock_unlock (&vcm->sessions_lockp);
1245
1246   vcm->bind_session_index = session_index;
1247   vppcom_send_unbind_sock (session_index);
1248   rv = vppcom_wait_for_session_state_change (session_index, STATE_START,
1249                                              vcm->cfg.session_timeout);
1250   if (PREDICT_FALSE (rv))
1251     {
1252       vcm->bind_session_index = ~0;
1253       if (VPPCOM_DEBUG > 0)
1254         clib_warning ("[%d] server unbind timed out, rv = %s (%d)",
1255                       vcm->my_pid, vppcom_retval_str (rv), rv);
1256       return rv;
1257     }
1258   return VPPCOM_OK;
1259 }
1260
1261 static int
1262 vppcom_session_disconnect (u32 session_index)
1263 {
1264   vppcom_main_t *vcm = &vppcom_main;
1265   int rv;
1266
1267   rv = vppcom_send_disconnect (session_index);
1268   if (PREDICT_FALSE (rv))
1269     return rv;
1270
1271   rv = vppcom_wait_for_session_state_change (session_index, STATE_DISCONNECT,
1272                                              vcm->cfg.session_timeout);
1273   if (PREDICT_FALSE (rv))
1274     {
1275       if (VPPCOM_DEBUG > 0)
1276         clib_warning ("[%d] client disconnect timed out, rv = %s (%d)",
1277                       vcm->my_pid, vppcom_retval_str (rv), rv);
1278       return rv;
1279     }
1280
1281   clib_spinlock_lock (&vcm->sessions_lockp);
1282   pool_put_index (vcm->sessions, session_index);
1283   clib_spinlock_unlock (&vcm->sessions_lockp);
1284   return VPPCOM_OK;
1285 }
1286
1287 #define foreach_sock_msg                                        \
1288 _(SESSION_ENABLE_DISABLE_REPLY, session_enable_disable_reply)   \
1289 _(BIND_SOCK_REPLY, bind_sock_reply)                             \
1290 _(UNBIND_SOCK_REPLY, unbind_sock_reply)                         \
1291 _(ACCEPT_SESSION, accept_session)                               \
1292 _(CONNECT_SOCK, connect_sock)                                   \
1293 _(CONNECT_SESSION_REPLY, connect_session_reply)                 \
1294 _(DISCONNECT_SESSION, disconnect_session)                       \
1295 _(DISCONNECT_SESSION_REPLY, disconnect_session_reply)           \
1296 _(RESET_SESSION, reset_session)                                 \
1297 _(APPLICATION_ATTACH_REPLY, application_attach_reply)           \
1298 _(APPLICATION_DETACH_REPLY, application_detach_reply)           \
1299 _(MAP_ANOTHER_SEGMENT, map_another_segment)
1300
1301 static void
1302 vppcom_api_hookup (void)
1303 {
1304 #define _(N,n)                                                  \
1305     vl_msg_api_set_handlers(VL_API_##N, #n,                     \
1306                            vl_api_##n##_t_handler,              \
1307                            vl_noop_handler,                     \
1308                            vl_api_##n##_t_endian,               \
1309                            vl_api_##n##_t_print,                \
1310                            sizeof(vl_api_##n##_t), 1);
1311   foreach_sock_msg;
1312 #undef _
1313 }
1314
1315 static void
1316 vppcom_cfg_init (vppcom_cfg_t * vcl_cfg)
1317 {
1318   ASSERT (vcl_cfg);
1319
1320   vcl_cfg->heapsize = (256ULL << 20);
1321   vcl_cfg->segment_baseva = 0x200000000ULL;
1322   vcl_cfg->segment_size = (256 << 20);
1323   vcl_cfg->add_segment_size = (128 << 20);
1324   vcl_cfg->preallocated_fifo_pairs = 8;
1325   vcl_cfg->rx_fifo_size = (1 << 20);
1326   vcl_cfg->tx_fifo_size = (1 << 20);
1327   vcl_cfg->event_queue_size = 2048;
1328   vcl_cfg->listen_queue_size = CLIB_CACHE_LINE_BYTES / sizeof (u32);
1329   vcl_cfg->app_timeout = 10 * 60.0;
1330   vcl_cfg->session_timeout = 10 * 60.0;
1331   vcl_cfg->accept_timeout = 60.0;
1332 }
1333
1334 static void
1335 vppcom_cfg_heapsize (char *conf_fname)
1336 {
1337   vppcom_main_t *vcm = &vppcom_main;
1338   vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1339   FILE *fp;
1340   char inbuf[4096];
1341   int argc = 1;
1342   char **argv = NULL;
1343   char *arg = NULL;
1344   char *p;
1345   int i;
1346   u8 *sizep;
1347   u32 size;
1348
1349   fp = fopen (conf_fname, "r");
1350   if (fp == NULL)
1351     {
1352       if (VPPCOM_DEBUG > 0)
1353         fprintf (stderr, "open configuration file '%s' failed\n", conf_fname);
1354       goto defaulted;
1355     }
1356   argv = calloc (1, sizeof (char *));
1357   if (argv == NULL)
1358     goto defaulted;
1359
1360   while (1)
1361     {
1362       if (fgets (inbuf, 4096, fp) == 0)
1363         break;
1364       p = strtok (inbuf, " \t\n");
1365       while (p != NULL)
1366         {
1367           if (*p == '#')
1368             break;
1369           argc++;
1370           char **tmp = realloc (argv, argc * sizeof (char *));
1371           if (tmp == NULL)
1372             {
1373               fclose (fp);
1374               goto defaulted;
1375             }
1376           argv = tmp;
1377           arg = strndup (p, 1024);
1378           if (arg == NULL)
1379             {
1380               fclose (fp);
1381               goto defaulted;
1382             }
1383           argv[argc - 1] = arg;
1384           p = strtok (NULL, " \t\n");
1385         }
1386     }
1387
1388   fclose (fp);
1389
1390   char **tmp = realloc (argv, (argc + 1) * sizeof (char *));
1391   if (tmp == NULL)
1392     goto defaulted;
1393   argv = tmp;
1394   argv[argc] = NULL;
1395
1396   /*
1397    * Look for and parse the "heapsize" config parameter.
1398    * Manual since none of the clib infra has been bootstrapped yet.
1399    *
1400    * Format: heapsize <nn>[mM][gG]
1401    */
1402
1403   for (i = 1; i < (argc - 1); i++)
1404     {
1405       if (!strncmp (argv[i], "heapsize", 8))
1406         {
1407           sizep = (u8 *) argv[i + 1];
1408           size = 0;
1409           while (*sizep >= '0' && *sizep <= '9')
1410             {
1411               size *= 10;
1412               size += *sizep++ - '0';
1413             }
1414           if (size == 0)
1415             {
1416               if (VPPCOM_DEBUG > 0)
1417                 clib_warning ("[%d] parse error '%s %s', "
1418                               "using default heapsize %lld (0x%llx)",
1419                               vcm->my_pid, argv[i], argv[i + 1],
1420                               vcl_cfg->heapsize, vcl_cfg->heapsize);
1421               goto defaulted;
1422             }
1423
1424           if (*sizep == 'g' || *sizep == 'G')
1425             vcl_cfg->heapsize = size << 30;
1426           else if (*sizep == 'm' || *sizep == 'M')
1427             vcl_cfg->heapsize = size << 20;
1428           else
1429             {
1430               if (VPPCOM_DEBUG > 0)
1431                 clib_warning ("[%d] parse error '%s %s', "
1432                               "using default heapsize %lld (0x%llx)",
1433                               vcm->my_pid, argv[i], argv[i + 1],
1434                               vcl_cfg->heapsize, vcl_cfg->heapsize);
1435               goto defaulted;
1436             }
1437         }
1438     }
1439
1440 defaulted:
1441   if (!clib_mem_init (0, vcl_cfg->heapsize))
1442     clib_warning ("[%d] vppcom heap allocation failure!", vcm->my_pid);
1443   else if (VPPCOM_DEBUG > 0)
1444     clib_warning ("[%d] allocated vppcom heapsize %lld (0x%llx)",
1445                   vcm->my_pid, vcl_cfg->heapsize, vcl_cfg->heapsize);
1446 }
1447
1448 static void
1449 vppcom_cfg_read (char *conf_fname)
1450 {
1451   vppcom_main_t *vcm = &vppcom_main;
1452   vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1453   int fd;
1454   unformat_input_t _input, *input = &_input;
1455   unformat_input_t _line_input, *line_input = &_line_input;
1456   u8 vc_cfg_input = 0;
1457   u8 *chroot_path;
1458   struct stat s;
1459   u32 uid, gid;
1460
1461   fd = open (conf_fname, O_RDONLY);
1462   if (fd < 0)
1463     {
1464       if (VPPCOM_DEBUG > 0)
1465         clib_warning ("[%d] open configuration file '%s' failed!",
1466                       vcm->my_pid, conf_fname);
1467       goto file_done;
1468     }
1469
1470   if (fstat (fd, &s) < 0)
1471     {
1472       if (VPPCOM_DEBUG > 0)
1473         clib_warning ("[%d] failed to stat `%s'", vcm->my_pid, conf_fname);
1474       goto file_done;
1475     }
1476
1477   if (!(S_ISREG (s.st_mode) || S_ISLNK (s.st_mode)))
1478     {
1479       if (VPPCOM_DEBUG > 0)
1480         clib_warning ("[%d] not a regular file `%s'", vcm->my_pid,
1481                       conf_fname);
1482       goto file_done;
1483     }
1484
1485   unformat_init_unix_file (input, fd);
1486
1487   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1488     {
1489       unformat_user (input, unformat_line_input, line_input);
1490       unformat_skip_white_space (line_input);
1491
1492       if (unformat (line_input, "vppcom {"))
1493         {
1494           vc_cfg_input = 1;
1495           continue;
1496         }
1497
1498       if (vc_cfg_input)
1499         {
1500           if (unformat (line_input, "heapsize %s", &chroot_path))
1501             {
1502               vec_terminate_c_string (chroot_path);
1503               if (VPPCOM_DEBUG > 0)
1504                 clib_warning ("[%d] configured heapsize %s, "
1505                               "actual heapsize %lld (0x%llx)",
1506                               vcm->my_pid, chroot_path, vcl_cfg->heapsize,
1507                               vcl_cfg->heapsize);
1508               vec_free (chroot_path);
1509             }
1510           else if (unformat (line_input, "api-prefix %s", &chroot_path))
1511             {
1512               vec_terminate_c_string (chroot_path);
1513               vl_set_memory_root_path ((char *) chroot_path);
1514               if (VPPCOM_DEBUG > 0)
1515                 clib_warning ("[%d] configured api-prefix %s",
1516                               vcm->my_pid, chroot_path);
1517               chroot_path = 0;  /* Don't vec_free() it! */
1518             }
1519           else if (unformat (line_input, "uid %d", &uid))
1520             {
1521               vl_set_memory_uid (uid);
1522               if (VPPCOM_DEBUG > 0)
1523                 clib_warning ("[%d] configured uid %d", vcm->my_pid, uid);
1524             }
1525           else if (unformat (line_input, "gid %d", &gid))
1526             {
1527               vl_set_memory_gid (gid);
1528               if (VPPCOM_DEBUG > 0)
1529                 clib_warning ("[%d] configured gid %d", vcm->my_pid, gid);
1530             }
1531           else if (unformat (line_input, "segment-baseva 0x%llx",
1532                              &vcl_cfg->segment_baseva))
1533             {
1534               if (VPPCOM_DEBUG > 0)
1535                 clib_warning ("[%d] configured segment_baseva 0x%llx",
1536                               vcm->my_pid, vcl_cfg->segment_baseva);
1537             }
1538           else if (unformat (line_input, "segment-size 0x%lx",
1539                              &vcl_cfg->segment_size))
1540             {
1541               if (VPPCOM_DEBUG > 0)
1542                 clib_warning ("[%d] configured segment_size 0x%lx (%ld)",
1543                               vcm->my_pid, vcl_cfg->segment_size,
1544                               vcl_cfg->segment_size);
1545             }
1546           else if (unformat (line_input, "segment-size %ld",
1547                              &vcl_cfg->segment_size))
1548             {
1549               if (VPPCOM_DEBUG > 0)
1550                 clib_warning ("[%d] configured segment_size %ld (0x%lx)",
1551                               vcm->my_pid, vcl_cfg->segment_size,
1552                               vcl_cfg->segment_size);
1553             }
1554           else if (unformat (line_input, "add-segment-size 0x%lx",
1555                              &vcl_cfg->add_segment_size))
1556             {
1557               if (VPPCOM_DEBUG > 0)
1558                 clib_warning
1559                   ("[%d] configured add_segment_size 0x%lx (%ld)",
1560                    vcm->my_pid, vcl_cfg->add_segment_size,
1561                    vcl_cfg->add_segment_size);
1562             }
1563           else if (unformat (line_input, "add-segment-size %ld",
1564                              &vcl_cfg->add_segment_size))
1565             {
1566               if (VPPCOM_DEBUG > 0)
1567                 clib_warning
1568                   ("[%d] configured add_segment_size %ld (0x%lx)",
1569                    vcm->my_pid, vcl_cfg->add_segment_size,
1570                    vcl_cfg->add_segment_size);
1571             }
1572           else if (unformat (line_input, "preallocated-fifo-pairs %d",
1573                              &vcl_cfg->preallocated_fifo_pairs))
1574             {
1575               if (VPPCOM_DEBUG > 0)
1576                 clib_warning ("[%d] configured preallocated_fifo_pairs "
1577                               "%d (0x%x)", vcm->my_pid,
1578                               vcl_cfg->preallocated_fifo_pairs,
1579                               vcl_cfg->preallocated_fifo_pairs);
1580             }
1581           else if (unformat (line_input, "rx-fifo-size 0x%lx",
1582                              &vcl_cfg->rx_fifo_size))
1583             {
1584               if (VPPCOM_DEBUG > 0)
1585                 clib_warning ("[%d] configured rx_fifo_size 0x%lx (%ld)",
1586                               vcm->my_pid, vcl_cfg->rx_fifo_size,
1587                               vcl_cfg->rx_fifo_size);
1588             }
1589           else if (unformat (line_input, "rx-fifo-size %ld",
1590                              &vcl_cfg->rx_fifo_size))
1591             {
1592               if (VPPCOM_DEBUG > 0)
1593                 clib_warning ("[%d] configured rx_fifo_size %ld (0x%lx)",
1594                               vcm->my_pid, vcl_cfg->rx_fifo_size,
1595                               vcl_cfg->rx_fifo_size);
1596             }
1597           else if (unformat (line_input, "tx-fifo-size 0x%lx",
1598                              &vcl_cfg->tx_fifo_size))
1599             {
1600               if (VPPCOM_DEBUG > 0)
1601                 clib_warning ("[%d] configured tx_fifo_size 0x%lx (%ld)",
1602                               vcm->my_pid, vcl_cfg->tx_fifo_size,
1603                               vcl_cfg->tx_fifo_size);
1604             }
1605           else if (unformat (line_input, "tx-fifo-size %ld",
1606                              &vcl_cfg->tx_fifo_size))
1607             {
1608               if (VPPCOM_DEBUG > 0)
1609                 clib_warning ("[%d] configured tx_fifo_size %ld (0x%lx)",
1610                               vcm->my_pid, vcl_cfg->tx_fifo_size,
1611                               vcl_cfg->tx_fifo_size);
1612             }
1613           else if (unformat (line_input, "event-queue-size 0x%lx",
1614                              &vcl_cfg->event_queue_size))
1615             {
1616               if (VPPCOM_DEBUG > 0)
1617                 clib_warning ("[%d] configured event_queue_size 0x%lx (%ld)",
1618                               vcm->my_pid, vcl_cfg->event_queue_size,
1619                               vcl_cfg->event_queue_size);
1620             }
1621           else if (unformat (line_input, "event-queue-size %ld",
1622                              &vcl_cfg->event_queue_size))
1623             {
1624               if (VPPCOM_DEBUG > 0)
1625                 clib_warning ("[%d] configured event_queue_size %ld (0x%lx)",
1626                               vcm->my_pid, vcl_cfg->event_queue_size,
1627                               vcl_cfg->event_queue_size);
1628             }
1629           else if (unformat (line_input, "listen-queue-size 0x%lx",
1630                              &vcl_cfg->listen_queue_size))
1631             {
1632               if (VPPCOM_DEBUG > 0)
1633                 clib_warning ("[%d] configured listen_queue_size 0x%lx (%ld)",
1634                               vcm->my_pid, vcl_cfg->listen_queue_size,
1635                               vcl_cfg->listen_queue_size);
1636             }
1637           else if (unformat (line_input, "listen-queue-size %ld",
1638                              &vcl_cfg->listen_queue_size))
1639             {
1640               if (VPPCOM_DEBUG > 0)
1641                 clib_warning ("[%d] configured listen_queue_size %ld (0x%lx)",
1642                               vcm->my_pid, vcl_cfg->listen_queue_size,
1643                               vcl_cfg->listen_queue_size);
1644             }
1645           else if (unformat (line_input, "app-timeout %f",
1646                              &vcl_cfg->app_timeout))
1647             {
1648               if (VPPCOM_DEBUG > 0)
1649                 clib_warning ("[%d] configured app_timeout %f",
1650                               vcm->my_pid, vcl_cfg->app_timeout);
1651             }
1652           else if (unformat (line_input, "session-timeout %f",
1653                              &vcl_cfg->session_timeout))
1654             {
1655               if (VPPCOM_DEBUG > 0)
1656                 clib_warning ("[%d] configured session_timeout %f",
1657                               vcm->my_pid, vcl_cfg->session_timeout);
1658             }
1659           else if (unformat (line_input, "accept-timeout %f",
1660                              &vcl_cfg->accept_timeout))
1661             {
1662               if (VPPCOM_DEBUG > 0)
1663                 clib_warning ("[%d] configured accept_timeout %f",
1664                               vcm->my_pid, vcl_cfg->accept_timeout);
1665             }
1666           else if (unformat (line_input, "}"))
1667             {
1668               vc_cfg_input = 0;
1669               if (VPPCOM_DEBUG > 0)
1670                 clib_warning ("[%d] completed parsing vppcom config!",
1671                               vcm->my_pid);
1672               goto input_done;
1673             }
1674           else
1675             {
1676               if (line_input->buffer[line_input->index] != '#')
1677                 {
1678                   clib_warning ("[%d] Unknown vppcom config option: '%s'",
1679                                 vcm->my_pid, (char *)
1680                                 &line_input->buffer[line_input->index]);
1681                 }
1682             }
1683         }
1684     }
1685
1686 input_done:
1687   unformat_free (input);
1688
1689 file_done:
1690   if (fd > 0)
1691     close (fd);
1692 }
1693
1694 /*
1695  * VPPCOM Public API functions
1696  */
1697 int
1698 vppcom_app_create (char *app_name)
1699 {
1700   vppcom_main_t *vcm = &vppcom_main;
1701   vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1702   u8 *heap;
1703   mheap_t *h;
1704   int rv;
1705
1706   if (!vcm->init)
1707     {
1708       char *conf_fname;
1709
1710       vcm->init = 1;
1711       vcm->my_pid = getpid ();
1712       clib_fifo_validate (vcm->client_session_index_fifo,
1713                           vcm->cfg.listen_queue_size);
1714       vppcom_cfg_init (vcl_cfg);
1715       conf_fname = getenv (VPPCOM_CONF_ENV);
1716       if (!conf_fname)
1717         {
1718           conf_fname = VPPCOM_CONF_DEFAULT;
1719           if (VPPCOM_DEBUG > 0)
1720             clib_warning ("[%d] getenv '%s' failed!", vcm->my_pid,
1721                           VPPCOM_CONF_ENV);
1722         }
1723       vppcom_cfg_heapsize (conf_fname);
1724       vppcom_cfg_read (conf_fname);
1725       vcm->bind_session_index = ~0;
1726       vcm->main_cpu = os_get_thread_index ();
1727       heap = clib_mem_get_per_cpu_heap ();
1728       h = mheap_header (heap);
1729
1730       /* make the main heap thread-safe */
1731       h->flags |= MHEAP_FLAG_THREAD_SAFE;
1732
1733       vcm->session_index_by_vpp_handles = hash_create (0, sizeof (uword));
1734
1735       clib_time_init (&vcm->clib_time);
1736       vppcom_init_error_string_table ();
1737       svm_fifo_segment_init (vcl_cfg->segment_baseva,
1738                              20 /* timeout in secs */ );
1739       clib_spinlock_init (&vcm->sessions_lockp);
1740       vppcom_api_hookup ();
1741     }
1742
1743   if (vcm->my_client_index == ~0)
1744     {
1745       vcm->app_state = STATE_APP_START;
1746       rv = vppcom_connect_to_vpp (app_name);
1747       if (rv)
1748         {
1749           clib_warning ("[%s] couldn't connect to VPP.", vcm->my_pid);
1750           return rv;
1751         }
1752
1753       if (VPPCOM_DEBUG > 0)
1754         clib_warning ("[%d] sending session enable", vcm->my_pid);
1755
1756       rv = vppcom_app_session_enable ();
1757       if (rv)
1758         {
1759           clib_warning ("[%d] vppcom_app_session_enable() failed!",
1760                         vcm->my_pid);
1761           return rv;
1762         }
1763
1764       if (VPPCOM_DEBUG > 0)
1765         clib_warning ("[%d] sending app attach", vcm->my_pid);
1766
1767       rv = vppcom_app_attach ();
1768       if (rv)
1769         {
1770           clib_warning ("[%d] vppcom_app_attach() failed!", vcm->my_pid);
1771           return rv;
1772         }
1773     }
1774
1775   if (VPPCOM_DEBUG > 0)
1776     clib_warning ("[%d] app_name '%s', my_client_index %d (0x%x)",
1777                   vcm->my_pid, app_name, vcm->my_client_index,
1778                   vcm->my_client_index);
1779
1780   return VPPCOM_OK;
1781 }
1782
1783 void
1784 vppcom_app_destroy (void)
1785 {
1786   vppcom_main_t *vcm = &vppcom_main;
1787   int rv;
1788
1789   if (vcm->my_client_index == ~0)
1790     return;
1791
1792   if (VPPCOM_DEBUG > 0)
1793     clib_warning ("[%d] detaching from VPP, my_client_index %d (0x%x)",
1794                   vcm->my_pid, vcm->my_client_index, vcm->my_client_index);
1795
1796   vppcom_app_detach ();
1797   rv = vppcom_wait_for_app_state_change (STATE_APP_ENABLED);
1798   if (PREDICT_FALSE (rv))
1799     {
1800       if (VPPCOM_DEBUG > 0)
1801         clib_warning ("[%d] application detach timed out, rv = %s (%d)",
1802                       vcm->my_pid, vppcom_retval_str (rv), rv);
1803     }
1804   vl_client_disconnect_from_vlib ();
1805   vcm->my_client_index = ~0;
1806   vcm->app_state = STATE_APP_START;
1807 }
1808
1809 int
1810 vppcom_session_create (u32 vrf, u8 proto, u8 is_nonblocking)
1811 {
1812   vppcom_main_t *vcm = &vppcom_main;
1813   session_t *session;
1814   u32 session_index;
1815
1816   clib_spinlock_lock (&vcm->sessions_lockp);
1817   pool_get (vcm->sessions, session);
1818   session_index = session - vcm->sessions;
1819
1820   session->vrf = vrf;
1821   session->proto = proto;
1822   session->state = STATE_START;
1823   session->is_nonblocking = is_nonblocking;
1824   clib_spinlock_unlock (&vcm->sessions_lockp);
1825
1826   if (VPPCOM_DEBUG > 0)
1827     clib_warning ("[%d] sid %d", vcm->my_pid, session_index);
1828
1829   return (int) session_index;
1830 }
1831
1832 int
1833 vppcom_session_close (uint32_t session_index)
1834 {
1835   vppcom_main_t *vcm = &vppcom_main;
1836   session_t *session = 0;
1837   int rv;
1838
1839   clib_spinlock_lock (&vcm->sessions_lockp);
1840   rv = vppcom_session_at_index (session_index, &session);
1841   if (PREDICT_FALSE (rv))
1842     {
1843       clib_spinlock_unlock (&vcm->sessions_lockp);
1844       if (VPPCOM_DEBUG > 0)
1845         clib_warning ("[%d] invalid session, sid (%d) has been closed!",
1846                       vcm->my_pid, session_index);
1847       return rv;
1848     }
1849   clib_spinlock_unlock (&vcm->sessions_lockp);
1850
1851   if (VPPCOM_DEBUG > 0)
1852     clib_warning ("[%d] sid %d", vcm->my_pid, session_index);
1853
1854   if (session->is_cut_thru)
1855     {
1856       if (session->is_server)
1857         rv = vppcom_session_unbind_cut_thru (session);
1858     }
1859   else
1860     {
1861       rv = (session->is_server) ?
1862         vppcom_session_unbind (session_index) :
1863         vppcom_session_disconnect (session_index);
1864     }
1865
1866   clib_spinlock_lock (&vcm->sessions_lockp);
1867   pool_put_index (vcm->sessions, session_index);
1868   clib_spinlock_unlock (&vcm->sessions_lockp);
1869   return rv;
1870 }
1871
1872 int
1873 vppcom_session_bind (uint32_t session_index, vppcom_endpt_t * ep)
1874 {
1875   vppcom_main_t *vcm = &vppcom_main;
1876   session_t *session = 0;
1877   int rv;
1878   ip46_address_t *ip46;
1879
1880   if (!ep || !ep->ip)
1881     return VPPCOM_EINVAL;
1882
1883   clib_spinlock_lock (&vcm->sessions_lockp);
1884   rv = vppcom_session_at_index (session_index, &session);
1885   if (PREDICT_FALSE (rv))
1886     {
1887       clib_spinlock_unlock (&vcm->sessions_lockp);
1888       if (VPPCOM_DEBUG > 0)
1889         clib_warning ("[%d] invalid session, sid (%d) has been closed!",
1890                       vcm->my_pid, session_index);
1891       return rv;
1892     }
1893
1894   if (VPPCOM_DEBUG > 0)
1895     clib_warning ("[%d] sid %d", vcm->my_pid, session_index);
1896
1897   session->vrf = ep->vrf;
1898   session->is_ip4 = ep->is_ip4;
1899   memset (session->ip, 0, sizeof (session->ip));
1900   ip46 = (ip46_address_t *) session->ip;
1901   *ip46 = to_ip46 (!ep->is_ip4, ep->ip);
1902   session->port = ep->port;
1903
1904   clib_spinlock_unlock (&vcm->sessions_lockp);
1905   return VPPCOM_OK;
1906 }
1907
1908 int
1909 vppcom_session_listen (uint32_t listen_session_index, uint32_t q_len)
1910 {
1911   vppcom_main_t *vcm = &vppcom_main;
1912   session_t *listen_session = 0;
1913   int rv;
1914
1915   clib_spinlock_lock (&vcm->sessions_lockp);
1916   rv = vppcom_session_at_index (listen_session_index, &listen_session);
1917   if (PREDICT_FALSE (rv))
1918     {
1919       clib_spinlock_unlock (&vcm->sessions_lockp);
1920       if (VPPCOM_DEBUG > 0)
1921         clib_warning ("[%d] invalid session, sid (%d) has been closed!",
1922                       vcm->my_pid, listen_session_index);
1923       return rv;
1924     }
1925
1926   if (VPPCOM_DEBUG > 0)
1927     clib_warning ("[%d] sid %d", vcm->my_pid, listen_session_index);
1928
1929   ASSERT (vcm->bind_session_index == ~0);
1930   vcm->bind_session_index = listen_session_index;
1931   vppcom_send_bind_sock (listen_session);
1932   clib_spinlock_unlock (&vcm->sessions_lockp);
1933   rv =
1934     vppcom_wait_for_session_state_change (listen_session_index, STATE_LISTEN,
1935                                           vcm->cfg.session_timeout);
1936   if (PREDICT_FALSE (rv))
1937     {
1938       vcm->bind_session_index = ~0;
1939       if (VPPCOM_DEBUG > 0)
1940         clib_warning ("[%d] server listen timed out, rv = %d (%d)",
1941                       vcm->my_pid, vppcom_retval_str (rv), rv);
1942       return rv;
1943     }
1944
1945   clib_spinlock_lock (&vcm->sessions_lockp);
1946   rv = vppcom_session_at_index (listen_session_index, &listen_session);
1947   if (PREDICT_FALSE (rv))
1948     {
1949       clib_spinlock_unlock (&vcm->sessions_lockp);
1950       if (VPPCOM_DEBUG > 0)
1951         clib_warning ("[%d] invalid session, sid (%d) has been closed!",
1952                       vcm->my_pid, listen_session_index);
1953       return rv;
1954     }
1955   listen_session->is_listen = 1;
1956   clib_spinlock_unlock (&vcm->sessions_lockp);
1957   clib_fifo_validate (vcm->client_session_index_fifo, q_len);
1958
1959   return VPPCOM_OK;
1960 }
1961
1962 int
1963 vppcom_session_accept (uint32_t listen_session_index, vppcom_endpt_t * ep,
1964                        double wait_for_time)
1965 {
1966   vppcom_main_t *vcm = &vppcom_main;
1967   session_t *listen_session = 0;
1968   session_t *client_session = 0;
1969   u32 client_session_index;
1970   int rv;
1971   f64 wait_for;
1972
1973   clib_spinlock_lock (&vcm->sessions_lockp);
1974   rv = vppcom_session_at_index (listen_session_index, &listen_session);
1975   if (PREDICT_FALSE (rv))
1976     {
1977       clib_spinlock_unlock (&vcm->sessions_lockp);
1978       if (VPPCOM_DEBUG > 0)
1979         clib_warning ("[%d] invalid session, sid (%d) has been closed!",
1980                       vcm->my_pid, listen_session_index);
1981       return rv;
1982     }
1983
1984   if (listen_session->state != STATE_LISTEN)
1985     {
1986       clib_spinlock_unlock (&vcm->sessions_lockp);
1987       if (VPPCOM_DEBUG > 0)
1988         clib_warning ("[%d] session not in listen state, state = %s",
1989                       vcm->my_pid,
1990                       vppcom_session_state_str (listen_session->state));
1991       return VPPCOM_EBADFD;
1992     }
1993   wait_for = listen_session->is_nonblocking ? 0 :
1994     (wait_for_time < 0) ? vcm->cfg.accept_timeout : wait_for_time;
1995
1996   if (VPPCOM_DEBUG > 0)
1997     clib_warning ("[%d] sid %d: %s (%d)", vcm->my_pid,
1998                   listen_session_index,
1999                   vppcom_session_state_str (listen_session->state),
2000                   listen_session->state);
2001   clib_spinlock_unlock (&vcm->sessions_lockp);
2002
2003   while (1)
2004     {
2005       rv = vppcom_wait_for_client_session_index (wait_for);
2006       if (rv)
2007         {
2008           if ((VPPCOM_DEBUG > 0))
2009             clib_warning ("[%d] sid %d, accept timed out, rv = %s (%d)",
2010                           vcm->my_pid, listen_session_index,
2011                           vppcom_retval_str (rv), rv);
2012           if ((wait_for == 0) || (wait_for_time > 0))
2013             return rv;
2014         }
2015       else
2016         break;
2017     }
2018
2019   clib_fifo_sub1 (vcm->client_session_index_fifo, client_session_index);
2020
2021   clib_spinlock_lock (&vcm->sessions_lockp);
2022   rv = vppcom_session_at_index (client_session_index, &client_session);
2023   ASSERT (rv == VPPCOM_OK);
2024   ASSERT (client_session->is_ip4 == listen_session->is_ip4);
2025
2026   if (VPPCOM_DEBUG > 0)
2027     clib_warning ("[%d] Got a request: client sid %d", vcm->my_pid,
2028                   client_session_index);
2029
2030   ep->vrf = client_session->vrf;
2031   ep->is_cut_thru = client_session->is_cut_thru;
2032   ep->is_ip4 = client_session->is_ip4;
2033   ep->port = client_session->port;
2034   if (client_session->is_ip4)
2035     clib_memcpy (ep->ip, client_session->ip, sizeof (ip4_address_t));
2036   else
2037     clib_memcpy (ep->ip, client_session->ip, sizeof (ip6_address_t));
2038   clib_spinlock_unlock (&vcm->sessions_lockp);
2039   return (int) client_session_index;
2040 }
2041
2042 int
2043 vppcom_session_connect (uint32_t session_index, vppcom_endpt_t * server_ep)
2044 {
2045   vppcom_main_t *vcm = &vppcom_main;
2046   session_t *session = 0;
2047   int rv;
2048   ip46_address_t *ip46;
2049
2050   clib_spinlock_lock (&vcm->sessions_lockp);
2051   rv = vppcom_session_at_index (session_index, &session);
2052   if (PREDICT_FALSE (rv))
2053     {
2054       clib_spinlock_unlock (&vcm->sessions_lockp);
2055       if (VPPCOM_DEBUG > 0)
2056         clib_warning ("[%d] invalid session, sid (%d) has been closed!",
2057                       vcm->my_pid, session_index);
2058       return rv;
2059     }
2060
2061   if (session->state == STATE_CONNECT)
2062     {
2063       clib_spinlock_unlock (&vcm->sessions_lockp);
2064       if (VPPCOM_DEBUG > 0)
2065         clib_warning ("[%d] session, sid (%d) already connected!",
2066                       vcm->my_pid, session_index);
2067       return VPPCOM_OK;
2068     }
2069
2070   session->vrf = server_ep->vrf;
2071   session->is_ip4 = server_ep->is_ip4;
2072   memset (session->ip, 0, sizeof (session->ip));
2073   ip46 = (ip46_address_t *) session->ip;
2074   *ip46 = to_ip46 (!server_ep->is_ip4, server_ep->ip);
2075   session->port = server_ep->port;
2076
2077   if (VPPCOM_DEBUG > 0)
2078     {
2079       u8 *ip_str = format (0, "%U", format_ip46_address,
2080                            &session->ip, session->is_ip4);
2081       clib_warning ("[%d] connect sid %d to %s server port %d",
2082                     vcm->my_pid, session_index, ip_str,
2083                     clib_net_to_host_u16 (session->port));
2084       vec_free (ip_str);
2085     }
2086
2087   vppcom_send_connect_sock (session, session_index);
2088   clib_spinlock_unlock (&vcm->sessions_lockp);
2089   rv = vppcom_wait_for_session_state_change (session_index, STATE_CONNECT,
2090                                              vcm->cfg.session_timeout);
2091   if (PREDICT_FALSE (rv))
2092     {
2093       if (VPPCOM_DEBUG > 0)
2094         clib_warning ("[%d] connect timed out, rv = %s (%d)",
2095                       vcm->my_pid, vppcom_retval_str (rv), rv);
2096       return rv;
2097     }
2098   return VPPCOM_OK;
2099 }
2100
2101 int
2102 vppcom_session_read (uint32_t session_index, void *buf, int n)
2103 {
2104   vppcom_main_t *vcm = &vppcom_main;
2105   session_t *session = 0;
2106   svm_fifo_t *rx_fifo;
2107   int n_read = 0;
2108   int rv;
2109   int max_dequeue;
2110   char *fifo_str;
2111
2112   ASSERT (buf);
2113
2114   clib_spinlock_lock (&vcm->sessions_lockp);
2115   rv = vppcom_session_at_index (session_index, &session);
2116   if (PREDICT_FALSE (rv))
2117     {
2118       clib_spinlock_unlock (&vcm->sessions_lockp);
2119       if (VPPCOM_DEBUG > 0)
2120         clib_warning ("[%d] invalid session, sid (%d) has been closed!",
2121                       vcm->my_pid, session_index);
2122       return rv;
2123     }
2124
2125   if (session->state == STATE_DISCONNECT)
2126     {
2127       clib_spinlock_unlock (&vcm->sessions_lockp);
2128       if (VPPCOM_DEBUG > 0)
2129         clib_warning ("[%d] sid (%d) has been closed by remote peer!",
2130                       vcm->my_pid, session_index);
2131       return VPPCOM_ECONNRESET;
2132     }
2133
2134   rx_fifo = ((!session->is_cut_thru || session->is_server) ?
2135              session->server_rx_fifo : session->server_tx_fifo);
2136   fifo_str = ((!session->is_cut_thru || session->is_server) ?
2137               "server_rx_fifo" : "server_tx_fifo");
2138   clib_spinlock_unlock (&vcm->sessions_lockp);
2139
2140   max_dequeue = (int) svm_fifo_max_dequeue (rx_fifo);
2141   n_read = svm_fifo_dequeue_nowait (rx_fifo, clib_min (n, max_dequeue), buf);
2142
2143   if (VPPCOM_DEBUG > 2)
2144     clib_warning ("[%d] sid %d, read %d bytes from %s (%p)", vcm->my_pid,
2145                   session_index, n_read, fifo_str, rx_fifo);
2146
2147   return (n_read <= 0) ? VPPCOM_EAGAIN : n_read;
2148 }
2149
2150 static inline int
2151 vppcom_session_read_ready (session_t * session, u32 session_index)
2152 {
2153   vppcom_main_t *vcm = &vppcom_main;
2154   svm_fifo_t *rx_fifo;
2155   int ready = 0;
2156
2157   /* Assumes caller has acquired spinlock: vcm->sessions_lockp */
2158   if (session->state == STATE_DISCONNECT)
2159     {
2160       if (VPPCOM_DEBUG > 0)
2161         clib_warning ("[%d] sid (%d) has been closed by remote peer!",
2162                       vcm->my_pid, session_index);
2163       return VPPCOM_ECONNRESET;
2164     }
2165
2166   if (session->is_listen)
2167     ready = clib_fifo_elts (vcm->client_session_index_fifo);
2168   else
2169     {
2170       rx_fifo = ((!session->is_cut_thru || session->is_server) ?
2171                  session->server_rx_fifo : session->server_tx_fifo);
2172
2173       ready = svm_fifo_max_dequeue (rx_fifo);
2174     }
2175
2176   if (VPPCOM_DEBUG > 3)
2177     clib_warning ("[%d] sid %d, peek %s (%p), ready = %d", vcm->my_pid,
2178                   session_index,
2179                   session->is_server ? "server_rx_fifo" : "server_tx_fifo",
2180                   rx_fifo, ready);
2181   return ready;
2182 }
2183
2184 int
2185 vppcom_session_write (uint32_t session_index, void *buf, int n)
2186 {
2187   vppcom_main_t *vcm = &vppcom_main;
2188   session_t *session = 0;
2189   svm_fifo_t *tx_fifo;
2190   unix_shared_memory_queue_t *q;
2191   session_fifo_event_t evt;
2192   int rv;
2193   char *fifo_str;
2194   u8 is_nonblocking;
2195
2196   ASSERT (buf);
2197
2198   clib_spinlock_lock (&vcm->sessions_lockp);
2199   rv = vppcom_session_at_index (session_index, &session);
2200   if (PREDICT_FALSE (rv))
2201     {
2202       clib_spinlock_unlock (&vcm->sessions_lockp);
2203       if (VPPCOM_DEBUG > 0)
2204         clib_warning ("[%d] invalid session, sid (%d) has been closed!",
2205                       vcm->my_pid, session_index);
2206       return rv;
2207     }
2208
2209   if (session->state == STATE_DISCONNECT)
2210     {
2211       clib_spinlock_unlock (&vcm->sessions_lockp);
2212       if (VPPCOM_DEBUG > 0)
2213         clib_warning ("[%d] sid (%d) has been closed by remote peer!",
2214                       vcm->my_pid, session_index);
2215       return VPPCOM_ECONNRESET;
2216     }
2217
2218   tx_fifo = ((!session->is_cut_thru || session->is_server) ?
2219              session->server_tx_fifo : session->server_rx_fifo);
2220   fifo_str = ((!session->is_cut_thru || session->is_server) ?
2221               "server_tx_fifo" : "server_rx_fifo");
2222
2223   is_nonblocking = session->is_nonblocking;
2224   clib_spinlock_unlock (&vcm->sessions_lockp);
2225
2226   do
2227     {
2228       rv = svm_fifo_enqueue_nowait (tx_fifo, n, buf);
2229     }
2230   while (!is_nonblocking && (rv <= 0));
2231
2232   /* If event wasn't set, add one */
2233   if (!session->is_cut_thru && (rv > 0) && svm_fifo_set_event (tx_fifo))
2234     {
2235       int rval;
2236
2237       /* Fabricate TX event, send to vpp */
2238       evt.fifo = tx_fifo;
2239       evt.event_type = FIFO_EVENT_APP_TX;
2240       evt.event_id = vcm->tx_event_id++;
2241
2242       clib_spinlock_lock (&vcm->sessions_lockp);
2243       rval = vppcom_session_at_index (session_index, &session);
2244       if (PREDICT_FALSE (rval))
2245         {
2246           clib_spinlock_unlock (&vcm->sessions_lockp);
2247           if (VPPCOM_DEBUG > 1)
2248             clib_warning ("[%d] invalid session, sid (%d) has been closed!",
2249                           vcm->my_pid, session_index);
2250           return rval;
2251         }
2252       q = session->vpp_event_queue;
2253       clib_spinlock_unlock (&vcm->sessions_lockp);
2254       ASSERT (q);
2255       unix_shared_memory_queue_add (q, (u8 *) & evt,
2256                                     0 /* do wait for mutex */ );
2257     }
2258
2259   if (VPPCOM_DEBUG > 2)
2260     clib_warning ("[%d] sid %d, wrote %d bytes to %s (%p)", vcm->my_pid,
2261                   session_index, rv, fifo_str, tx_fifo);
2262
2263   return rv;
2264 }
2265
2266 static inline int
2267 vppcom_session_write_ready (session_t * session, u32 session_index)
2268 {
2269   vppcom_main_t *vcm = &vppcom_main;
2270   svm_fifo_t *tx_fifo;
2271   char *fifo_str;
2272   int rv;
2273
2274   /* Assumes caller has acquired spinlock: vcm->sessions_lockp */
2275   if (session->state == STATE_DISCONNECT)
2276     {
2277       if (VPPCOM_DEBUG > 0)
2278         clib_warning ("[%d] sid (%d) has been closed by remote peer!",
2279                       vcm->my_pid, session_index);
2280       return VPPCOM_ECONNRESET;
2281     }
2282
2283   tx_fifo = ((!session->is_cut_thru || session->is_server) ?
2284              session->server_tx_fifo : session->server_rx_fifo);
2285   fifo_str = ((!session->is_cut_thru || session->is_server) ?
2286               "server_tx_fifo" : "server_rx_fifo");
2287
2288   rv = svm_fifo_max_enqueue (tx_fifo);
2289
2290   if (VPPCOM_DEBUG > 3)
2291     clib_warning ("[%d] sid %d, peek %s (%p), ready = %d", vcm->my_pid,
2292                   session_index, fifo_str, tx_fifo, rv);
2293   return rv;
2294 }
2295
2296 int
2297 vppcom_select (unsigned long n_bits, unsigned long *read_map,
2298                unsigned long *write_map, unsigned long *except_map,
2299                double time_to_wait)
2300 {
2301   vppcom_main_t *vcm = &vppcom_main;
2302   u32 session_index;
2303   session_t *session = 0;
2304   int rv, bits_set = 0;
2305   f64 timeout = clib_time_now (&vcm->clib_time) + time_to_wait;
2306   u32 minbits = clib_max (n_bits, BITS (uword));
2307
2308   ASSERT (sizeof (clib_bitmap_t) == sizeof (long int));
2309
2310   if (read_map)
2311     {
2312       clib_bitmap_validate (vcm->rd_bitmap, minbits);
2313       clib_memcpy (vcm->rd_bitmap, read_map, vec_len (vcm->rd_bitmap));
2314       memset (read_map, 0, vec_len (vcm->rd_bitmap));
2315     }
2316   if (write_map)
2317     {
2318       clib_bitmap_validate (vcm->wr_bitmap, minbits);
2319       clib_memcpy (vcm->wr_bitmap, write_map, vec_len (vcm->wr_bitmap));
2320       memset (write_map, 0, vec_len (vcm->wr_bitmap));
2321     }
2322   if (except_map)
2323     {
2324       clib_bitmap_validate (vcm->ex_bitmap, minbits);
2325       clib_memcpy (vcm->ex_bitmap, except_map, vec_len (vcm->ex_bitmap));
2326       memset (except_map, 0, vec_len (vcm->ex_bitmap));
2327     }
2328
2329   do
2330     {
2331       /* *INDENT-OFF* */
2332       clib_bitmap_foreach (session_index, vcm->rd_bitmap,
2333         ({
2334           clib_spinlock_lock (&vcm->sessions_lockp);
2335           rv = vppcom_session_at_index (session_index, &session);
2336           if (rv < 0)
2337             {
2338               clib_spinlock_unlock (&vcm->sessions_lockp);
2339               if (VPPCOM_DEBUG > 1)
2340                 clib_warning ("[%d] session %d specified in "
2341                               "read_map is closed.", vcm->my_pid,
2342                               session_index);
2343               bits_set = VPPCOM_EBADFD;
2344               goto select_done;
2345             }
2346
2347           rv = vppcom_session_read_ready (session, session_index);
2348           clib_spinlock_unlock (&vcm->sessions_lockp);
2349           if (vcm->ex_bitmap &&
2350               clib_bitmap_get (vcm->ex_bitmap, session_index) && (rv < 0))
2351             {
2352               // TBD: clib_warning
2353               clib_bitmap_set_no_check (except_map, session_index, 1);
2354               bits_set++;
2355             }
2356           else if (rv > 0)
2357             {
2358               // TBD: clib_warning
2359               clib_bitmap_set_no_check (read_map, session_index, 1);
2360               bits_set++;
2361             }
2362         }));
2363
2364       clib_bitmap_foreach (session_index, vcm->wr_bitmap,
2365         ({
2366           clib_spinlock_lock (&vcm->sessions_lockp);
2367           rv = vppcom_session_at_index (session_index, &session);
2368           if (rv < 0)
2369             {
2370               clib_spinlock_unlock (&vcm->sessions_lockp);
2371               if (VPPCOM_DEBUG > 0)
2372                 clib_warning ("[%d] session %d specified in "
2373                               "write_map is closed.", vcm->my_pid,
2374                               session_index);
2375               bits_set = VPPCOM_EBADFD;
2376               goto select_done;
2377             }
2378
2379           rv = vppcom_session_write_ready (session, session_index);
2380           clib_spinlock_unlock (&vcm->sessions_lockp);
2381           if (rv > 0)
2382             {
2383               // TBD: clib_warning
2384               clib_bitmap_set_no_check (write_map, session_index, 1);
2385               bits_set++;
2386             }
2387         }));
2388
2389       clib_bitmap_foreach (session_index, vcm->ex_bitmap,
2390         ({
2391           clib_spinlock_lock (&vcm->sessions_lockp);
2392           rv = vppcom_session_at_index (session_index, &session);
2393           if (rv < 0)
2394             {
2395               clib_spinlock_unlock (&vcm->sessions_lockp);
2396               if (VPPCOM_DEBUG > 1)
2397                 clib_warning ("[%d] session %d specified in "
2398                               "except_map is closed.", vcm->my_pid,
2399                               session_index);
2400               bits_set = VPPCOM_EBADFD;
2401               goto select_done;
2402             }
2403
2404           rv = vppcom_session_read_ready (session, session_index);
2405           clib_spinlock_unlock (&vcm->sessions_lockp);
2406           if (rv < 0)
2407             {
2408               // TBD: clib_warning
2409               clib_bitmap_set_no_check (except_map, session_index, 1);
2410               bits_set++;
2411             }
2412         }));
2413       /* *INDENT-ON* */
2414     }
2415   while (clib_time_now (&vcm->clib_time) < timeout);
2416
2417 select_done:
2418   return (bits_set);
2419 }
2420
2421 /*
2422  * fd.io coding-style-patch-verification: ON
2423  *
2424  * Local Variables:
2425  * eval: (c-set-style "gnu")
2426  * End:
2427  */