src/vcl/vcom_socket.c

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   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 #include <unistd.h>
  16 #include <stdio.h>
  17 #include <sys/uio.h>
  18 #include <limits.h>
  19 #define __need_IOV_MAX
  20 #include <bits/stdio_lim.h>
  21 #include <netinet/tcp.h>
  22
  23 #include <vppinfra/types.h>
  24 #include <vppinfra/hash.h>
  25 #include <vppinfra/pool.h>
  26
  27 #include <vcl/vcom_socket.h>
  28 #include <vcl/vcom_socket_wrapper.h>
  29 #include <vcl/vcom.h>
  30
  31 #include <vcl/vppcom.h>
  32
  33
  34 /*
  35  * VCOM_SOCKET Private definitions and functions.
  36  */
  37
  38 typedef struct vcom_socket_main_t_
  39 {
  40   u8 init;
  41
  42   /* vcom_socket pool */
  43   vcom_socket_t *vsockets;
  44
  45   /* Hash table for socketidx to fd mapping */
  46   uword *sockidx_by_fd;
  47
  48   /* vcom_epoll pool */
  49   vcom_epoll_t *vepolls;
  50
  51   /* Hash table for epollidx to epfd mapping */
  52   uword *epollidx_by_epfd;
  53
  54
  55   /* common epitem poll for all epfd */
  56   /* TBD: epitem poll per epfd */
  57   /* vcom_epitem pool */
  58   vcom_epitem_t *vepitems;
  59
  60   /* Hash table for epitemidx to epfdfd mapping */
  61   uword *epitemidx_by_epfdfd;
  62
  63   /* Hash table - key:epfd, value:vec of epitemidx */
  64   uword *epitemidxs_by_epfd;
  65   /* Hash table - key:fd, value:vec of epitemidx */
  66   uword *epitemidxs_by_fd;
  67
  68 } vcom_socket_main_t;
  69
  70 vcom_socket_main_t vcom_socket_main;
  71
  72
  73 static int
  74 vcom_socket_open_socket (int domain, int type, int protocol)
  75 {
  76   int rv = -1;
  77
  78   /* handle domains implemented by vpp */
  79   switch (domain)
  80     {
  81     case AF_INET:
  82     case AF_INET6:
  83       /* get socket type and
  84        * handle the socket types supported by vpp */
  85       switch (type & ~(SOCK_CLOEXEC | SOCK_NONBLOCK))
  86         {
  87         case SOCK_STREAM:
  88         case SOCK_DGRAM:
  89           /* the type argument serves a second purpose,
  90            * in addition to specifying a socket type,
  91            * it may include the bitwise OR of any of
  92            * SOCK_NONBLOCK and SOCK_CLOEXEC, to modify
  93            * the behavior of socket. */
  94           rv = libc_socket (domain, type, protocol);
  95           if (rv == -1)
  96             rv = -errno;
  97           break;
  98
  99         default:
 100           break;
 101         }
 102
 103       break;
 104
 105     default:
 106       break;
 107     }
 108
 109   return rv;
 110 }
 111
 112 static int
 113 vcom_socket_open_epoll (int flags)
 114 {
 115   int rv = -1;
 116
 117   if (flags < 0)
 118     {
 119       return -EINVAL;
 120     }
 121   if (flags && (flags & ~EPOLL_CLOEXEC))
 122     {
 123       return -EINVAL;
 124     }
 125
 126   /* flags can be either zero or EPOLL_CLOEXEC */
 127   rv = libc_epoll_create1 (flags);
 128   if (rv == -1)
 129     rv = -errno;
 130
 131   return rv;
 132 }
 133
 134 static int
 135 vcom_socket_close_socket (int fd)
 136 {
 137   int rv;
 138
 139   rv = libc_close (fd);
 140   if (rv == -1)
 141     rv = -errno;
 142
 143   return rv;
 144 }
 145
 146 static int
 147 vcom_socket_close_epoll (int epfd)
 148 {
 149   int rv;
 150
 151   rv = libc_close (epfd);
 152   if (rv == -1)
 153     rv = -errno;
 154
 155   return rv;
 156 }
 157
 158 /*
 159  * Public API functions
 160  */
 161
 162
 163 int
 164 vcom_socket_is_vcom_fd (int fd)
 165 {
 166   vcom_socket_main_t *vsm = &vcom_socket_main;
 167   uword *p;
 168   vcom_socket_t *vsock;
 169
 170   p = hash_get (vsm->sockidx_by_fd, fd);
 171
 172   if (p)
 173     {
 174       vsock = pool_elt_at_index (vsm->vsockets, p[0]);
 175       if (vsock && vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
 176         return 1;
 177     }
 178   return 0;
 179 }
 180
 181 int
 182 vcom_socket_is_vcom_epfd (int epfd)
 183 {
 184   vcom_socket_main_t *vsm = &vcom_socket_main;
 185   uword *p;
 186   vcom_epoll_t *vepoll;
 187
 188   p = hash_get (vsm->epollidx_by_epfd, epfd);
 189
 190   if (p)
 191     {
 192       vepoll = pool_elt_at_index (vsm->vepolls, p[0]);
 193       if (vepoll && vepoll->type == EPOLL_TYPE_VPPCOM_BOUND)
 194         return 1;
 195     }
 196   return 0;
 197 }
 198
 199 static inline int
 200 vcom_socket_get_sid (int fd)
 201 {
 202   vcom_socket_main_t *vsm = &vcom_socket_main;
 203   uword *p;
 204   vcom_socket_t *vsock;
 205
 206   p = hash_get (vsm->sockidx_by_fd, fd);
 207
 208   if (p)
 209     {
 210       vsock = pool_elt_at_index (vsm->vsockets, p[0]);
 211       if (vsock && vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
 212         return vsock->sid;
 213     }
 214   return INVALID_SESSION_ID;
 215 }
 216
 217 static inline int
 218 vcom_socket_get_vep_idx (int epfd)
 219 {
 220   vcom_socket_main_t *vsm = &vcom_socket_main;
 221   uword *p;
 222   vcom_epoll_t *vepoll;
 223
 224   p = hash_get (vsm->epollidx_by_epfd, epfd);
 225
 226   if (p)
 227     {
 228       vepoll = pool_elt_at_index (vsm->vepolls, p[0]);
 229       if (vepoll && vepoll->type == EPOLL_TYPE_VPPCOM_BOUND)
 230         return vepoll->vep_idx;
 231     }
 232   return INVALID_VEP_IDX;
 233 }
 234
 235 static inline int
 236 vcom_socket_get_sid_and_vsock (int fd, vcom_socket_t ** vsockp)
 237 {
 238   vcom_socket_main_t *vsm = &vcom_socket_main;
 239   uword *p;
 240   vcom_socket_t *vsock;
 241
 242   p = hash_get (vsm->sockidx_by_fd, fd);
 243
 244   if (p)
 245     {
 246       vsock = pool_elt_at_index (vsm->vsockets, p[0]);
 247       if (vsock && vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
 248         {
 249           *vsockp = vsock;
 250           return vsock->sid;
 251         }
 252     }
 253   return INVALID_SESSION_ID;
 254 }
 255
 256 static inline int
 257 vcom_socket_get_vep_idx_and_vepoll (int epfd, vcom_epoll_t ** vepollp)
 258 {
 259   vcom_socket_main_t *vsm = &vcom_socket_main;
 260   uword *p;
 261   vcom_epoll_t *vepoll;
 262
 263   p = hash_get (vsm->epollidx_by_epfd, epfd);
 264
 265   if (p)
 266     {
 267       vepoll = pool_elt_at_index (vsm->vepolls, p[0]);
 268       if (vepoll && vepoll->type == EPOLL_TYPE_VPPCOM_BOUND)
 269         {
 270           *vepollp = vepoll;
 271           return vepoll->vep_idx;
 272         }
 273     }
 274   return INVALID_VEP_IDX;
 275 }
 276
 277
 278 static int
 279 vcom_socket_close_vepoll (int epfd)
 280 {
 281   int rv = -1;
 282   vcom_socket_main_t *vsm = &vcom_socket_main;
 283   uword *p;
 284   vcom_epoll_t *vepoll;
 285
 286   p = hash_get (vsm->epollidx_by_epfd, epfd);
 287   if (!p)
 288     return -EBADF;
 289
 290   vepoll = pool_elt_at_index (vsm->vepolls, p[0]);
 291   if (!vepoll)
 292     return -EBADF;
 293
 294   if (vepoll->type != EPOLL_TYPE_VPPCOM_BOUND)
 295     return -EINVAL;
 296
 297   if (vepoll->count)
 298     {
 299       if (!vepoll->close)
 300         {
 301           vepoll->close = 1;
 302           return 0;
 303         }
 304       else
 305         {
 306           return -EBADF;
 307         }
 308     }
 309
 310   /* count is zero */
 311   rv = vppcom_session_close (vepoll->vep_idx);
 312   rv = vcom_socket_close_epoll (vepoll->epfd);
 313
 314   vepoll_init (vepoll);
 315   hash_unset (vsm->epollidx_by_epfd, epfd);
 316   pool_put (vsm->vepolls, vepoll);
 317
 318   return rv;
 319 }
 320
 321 static int
 322 vcom_socket_close_vsock (int fd)
 323 {
 324   int rv = -1;
 325   vcom_socket_main_t *vsm = &vcom_socket_main;
 326   uword *p;
 327   vcom_socket_t *vsock;
 328
 329   vcom_epitem_t *vepitem;
 330
 331   i32 *vepitemidxs = 0;
 332   i32 *vepitemidxs_var = 0;
 333
 334   p = hash_get (vsm->sockidx_by_fd, fd);
 335   if (!p)
 336     return -EBADF;
 337
 338   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
 339   if (!vsock)
 340     return -ENOTSOCK;
 341
 342   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
 343     return -EINVAL;
 344
 345   rv = vppcom_session_close (vsock->sid);
 346   rv = vcom_socket_close_socket (vsock->fd);
 347
 348   vsocket_init (vsock);
 349   hash_unset (vsm->sockidx_by_fd, fd);
 350   pool_put (vsm->vsockets, vsock);
 351
 352   /*
 353    * NOTE:
 354    * Before calling close(), user should remove
 355    * this fd from the epoll-set of all epoll instances,
 356    * otherwise resource(epitems) leaks ensues.
 357    */
 358
 359   /*
 360    * 00. close all epoll instances that are marked as "close"
 361    *     of which this fd is the "last" remaining member.
 362    * 01. epitems associated with this fd are intentionally
 363    *     not removed, see NOTE: above.
 364    * */
 365
 366   /* does this fd participate in epoll */
 367   p = hash_get (vsm->epitemidxs_by_fd, fd);
 368   if (p)
 369     {
 370       vepitemidxs = *(i32 **) p;
 371       vec_foreach (vepitemidxs_var, vepitemidxs)
 372       {
 373         vepitem = pool_elt_at_index (vsm->vepitems, vepitemidxs_var[0]);
 374         if (vepitem && vepitem->fd == fd &&
 375             vepitem->type == FD_TYPE_VCOM_SOCKET)
 376           {
 377             i32 vep_idx;
 378             vcom_epoll_t *vepoll;
 379             if ((vep_idx =
 380                  vcom_socket_get_vep_idx_and_vepoll (vepitem->epfd,
 381                                                      &vepoll)) !=
 382                 INVALID_VEP_IDX)
 383               {
 384                 if (vepoll->close)
 385                   {
 386                     if (vepoll->count == 1)
 387                       {
 388                         /*
 389                          * force count to zero and
 390                          * close this epoll instance
 391                          * */
 392                         vepoll->count = 0;
 393                         vcom_socket_close_vepoll (vepoll->epfd);
 394                       }
 395                     else
 396                       {
 397                         vepoll->count -= 1;
 398                       }
 399                   }
 400               }
 401           }
 402
 403       }
 404     }
 405
 406   return rv;
 407 }
 408
 409 int
 410 vcom_socket_close (int __fd)
 411 {
 412   int rv;
 413
 414   if (vcom_socket_is_vcom_fd (__fd))
 415     {
 416       rv = vcom_socket_close_vsock (__fd);
 417     }
 418   else if (vcom_socket_is_vcom_epfd (__fd))
 419     {
 420       rv = vcom_socket_close_vepoll (__fd);
 421     }
 422   else
 423     {
 424       rv = -EBADF;
 425     }
 426
 427   return rv;
 428 }
 429
 430 ssize_t
 431 vcom_socket_read (int __fd, void *__buf, size_t __nbytes)
 432 {
 433   int rv = -1;
 434   vcom_socket_main_t *vsm = &vcom_socket_main;
 435   uword *p;
 436   vcom_socket_t *vsock;
 437
 438   p = hash_get (vsm->sockidx_by_fd, __fd);
 439   if (!p)
 440     return -EBADF;
 441
 442   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
 443   if (!vsock)
 444     return -ENOTSOCK;
 445
 446   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
 447     return -EINVAL;
 448
 449   if (!__buf)
 450     {
 451       return -EINVAL;
 452     }
 453
 454   rv = vcom_fcntl (__fd, F_GETFL, 0);
 455   if (rv < 0)
 456     {
 457       return rv;
 458
 459     }
 460
 461   /* is blocking */
 462   if (!(rv & O_NONBLOCK))
 463     {
 464       do
 465         {
 466           rv = vppcom_session_read (vsock->sid, __buf, __nbytes);
 467         }
 468       /* coverity[CONSTANT_EXPRESSION_RESULT] */
 469       while (rv == -EAGAIN || rv == -EWOULDBLOCK);
 470       return rv;
 471     }
 472   /* The file descriptor refers to a socket and has been
 473    * marked nonblocking(O_NONBLOCK) and the read would
 474    * block.
 475    * */
 476   /* is non blocking */
 477   rv = vppcom_session_read (vsock->sid, __buf, __nbytes);
 478   return rv;
 479 }
 480
 481 ssize_t
 482 vcom_socket_readv (int __fd, const struct iovec * __iov, int __iovcnt)
 483 {
 484   int rv;
 485   vcom_socket_main_t *vsm = &vcom_socket_main;
 486   uword *p;
 487   vcom_socket_t *vsock;
 488   ssize_t total = 0, len = 0;
 489   int i;
 490
 491   p = hash_get (vsm->sockidx_by_fd, __fd);
 492   if (!p)
 493     return -EBADF;
 494
 495   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
 496   if (!vsock)
 497     return -ENOTSOCK;
 498
 499   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
 500     return -EINVAL;
 501
 502   if (__iov == 0 || __iovcnt == 0 || __iovcnt > IOV_MAX)
 503     return -EINVAL;
 504
 505   /* Sanity check */
 506   for (i = 0; i < __iovcnt; ++i)
 507     {
 508       if (SSIZE_MAX - len < __iov[i].iov_len)
 509         return -EINVAL;
 510       len += __iov[i].iov_len;
 511     }
 512
 513   rv = vcom_fcntl (__fd, F_GETFL, 0);
 514   if (rv < 0)
 515     {
 516       return rv;
 517     }
 518
 519   /* is blocking */
 520   if (!(rv & O_NONBLOCK))
 521     {
 522       do
 523         {
 524           for (i = 0; i < __iovcnt; ++i)
 525             {
 526               rv = vppcom_session_read (vsock->sid, __iov[i].iov_base,
 527                                         __iov[i].iov_len);
 528               if (rv < 0)
 529                 break;
 530               else
 531                 {
 532                   total += rv;
 533                   if (rv < __iov[i].iov_len)
 534                     /* Read less than buffer provided, no point to continue */
 535                     break;
 536                 }
 537             }
 538         }
 539       /* coverity[CONSTANT_EXPRESSION_RESULT] */
 540       while ((rv == -EAGAIN || rv == -EWOULDBLOCK) && total == 0);
 541       return total;
 542     }
 543
 544   /* is non blocking */
 545   for (i = 0; i < __iovcnt; ++i)
 546     {
 547       rv = vppcom_session_read (vsock->sid, __iov[i].iov_base,
 548                                 __iov[i].iov_len);
 549       if (rv < 0)
 550         {
 551           if (total > 0)
 552             break;
 553           else
 554             {
 555               errno = rv;
 556               return rv;
 557             }
 558         }
 559       else
 560         {
 561           total += rv;
 562           if (rv < __iov[i].iov_len)
 563             /* Read less than buffer provided, no point to continue */
 564             break;
 565         }
 566     }
 567   return total;
 568 }
 569
 570 ssize_t
 571 vcom_socket_write (int __fd, const void *__buf, size_t __n)
 572 {
 573   int rv = -1;
 574   vcom_socket_main_t *vsm = &vcom_socket_main;
 575   uword *p;
 576   vcom_socket_t *vsock;
 577
 578   if (!__buf)
 579     {
 580       return -EINVAL;
 581     }
 582
 583   p = hash_get (vsm->sockidx_by_fd, __fd);
 584   if (!p)
 585     return -EBADF;
 586
 587   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
 588   if (!vsock)
 589     return -ENOTSOCK;
 590
 591   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
 592     return -EINVAL;
 593
 594   rv = vppcom_session_write (vsock->sid, (void *) __buf, __n);
 595   return rv;
 596 }
 597
 598 ssize_t
 599 vcom_socket_writev (int __fd, const struct iovec * __iov, int __iovcnt)
 600 {
 601   int rv = -1;
 602   ssize_t total = 0;
 603   vcom_socket_main_t *vsm = &vcom_socket_main;
 604   uword *p;
 605   vcom_socket_t *vsock;
 606   int i;
 607
 608   p = hash_get (vsm->sockidx_by_fd, __fd);
 609   if (!p)
 610     return -EBADF;
 611
 612   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
 613   if (!vsock)
 614     return -ENOTSOCK;
 615
 616   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
 617     return -EINVAL;
 618
 619   if (__iov == 0 || __iovcnt == 0 || __iovcnt > IOV_MAX)
 620     return -EINVAL;
 621
 622   for (i = 0; i < __iovcnt; ++i)
 623     {
 624       rv = vppcom_session_write (vsock->sid, __iov[i].iov_base,
 625                                  __iov[i].iov_len);
 626       if (rv < 0)
 627         {
 628           if (total > 0)
 629             break;
 630           else
 631             return rv;
 632         }
 633       else
 634         total += rv;
 635     }
 636   return total;
 637 }
 638
 639 /*
 640  * RETURN:  0 - invalid cmd
 641  *          1 - cmd not handled by vcom and vppcom
 642  *          2 - cmd handled by vcom socket resource
 643  *          3 - cmd handled by vppcom
 644  * */
 645 /* TBD: incomplete list of cmd */
 646 static int
 647 vcom_socket_check_fcntl_cmd (int __cmd)
 648 {
 649   switch (__cmd)
 650     {
 651       /*cmd not handled by vcom and vppcom */
 652       /* Fallthrough */
 653     case F_DUPFD:
 654     case F_DUPFD_CLOEXEC:
 655       return 1;
 656
 657       /* cmd handled by vcom socket resource */
 658       /* Fallthrough */
 659     case F_GETFD:
 660     case F_SETFD:
 661     case F_GETLK:
 662     case F_SETLK:
 663     case F_SETLKW:
 664     case F_GETOWN:
 665     case F_SETOWN:
 666       return 2;
 667
 668       /* cmd handled by vcom and vppcom */
 669     case F_SETFL:
 670     case F_GETFL:
 671       return 3;
 672
 673       /* cmd not handled by vcom and vppcom */
 674     default:
 675       return 1;
 676     }
 677   return 0;
 678 }
 679
 680 static inline int
 681 vcom_session_fcntl_va (int __sid, int __cmd, va_list __ap)
 682 {
 683   int flags = va_arg (__ap, int);
 684   int rv = -EOPNOTSUPP;
 685   uint32_t size;
 686
 687   size = sizeof (flags);
 688   if (__cmd == F_SETFL)
 689     {
 690       rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_FLAGS, &flags, &size);
 691     }
 692   else if (__cmd == F_GETFL)
 693     {
 694       rv = vppcom_session_attr (__sid, VPPCOM_ATTR_GET_FLAGS, &flags, &size);
 695       if (rv == VPPCOM_OK)
 696         rv = flags;
 697     }
 698
 699   return rv;
 700 }
 701
 702 int
 703 vcom_socket_fcntl_va (int __fd, int __cmd, va_list __ap)
 704 {
 705   int rv = -EBADF;
 706   vcom_socket_main_t *vsm = &vcom_socket_main;
 707   uword *p;
 708   vcom_socket_t *vsock;
 709
 710   p = hash_get (vsm->sockidx_by_fd, __fd);
 711   if (!p)
 712     return -EBADF;
 713
 714   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
 715   if (!vsock)
 716     return -ENOTSOCK;
 717
 718   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
 719     return -EINVAL;
 720
 721   switch (vcom_socket_check_fcntl_cmd (__cmd))
 722     {
 723       /* invalid cmd */
 724     case 0:
 725       rv = -EBADF;
 726       break;
 727       /*cmd not handled by vcom and vppcom */
 728     case 1:
 729       rv = libc_vfcntl (vsock->fd, __cmd, __ap);
 730       break;
 731       /* cmd handled by vcom socket resource */
 732     case 2:
 733       rv = libc_vfcntl (vsock->fd, __cmd, __ap);
 734       break;
 735       /* cmd handled by vppcom */
 736     case 3:
 737       rv = vcom_session_fcntl_va (vsock->sid, __cmd, __ap);
 738       break;
 739
 740     default:
 741       rv = -EINVAL;
 742       break;
 743     }
 744
 745   return rv;
 746 }
 747
 748 /*
 749  * RETURN:  0 - invalid cmd
 750  *          1 - cmd not handled by vcom and vppcom
 751  *          2 - cmd handled by vcom socket resource
 752  *          3 - cmd handled by vppcom
 753  */
 754 static int
 755 vcom_socket_check_ioctl_cmd (unsigned long int __cmd)
 756 {
 757   int rc;
 758
 759   switch (__cmd)
 760     {
 761       /* cmd handled by vppcom */
 762     case FIONREAD:
 763       rc = 3;
 764       break;
 765
 766       /* cmd not handled by vcom and vppcom */
 767     default:
 768       rc = 1;
 769       break;
 770     }
 771   return rc;
 772 }
 773
 774 static inline int
 775 vcom_session_ioctl_va (int __sid, int __cmd, va_list __ap)
 776 {
 777   int rv;
 778
 779   if (__cmd == FIONREAD)
 780     rv = vppcom_session_attr (__sid, VPPCOM_ATTR_GET_NREAD, 0, 0);
 781   else
 782     rv = -EOPNOTSUPP;
 783   return rv;
 784 }
 785
 786 int
 787 vcom_socket_ioctl_va (int __fd, unsigned long int __cmd, va_list __ap)
 788 {
 789   int rv = -EBADF;
 790   vcom_socket_main_t *vsm = &vcom_socket_main;
 791   uword *p;
 792   vcom_socket_t *vsock;
 793
 794   p = hash_get (vsm->sockidx_by_fd, __fd);
 795   if (!p)
 796     return -EBADF;
 797
 798   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
 799   if (!vsock)
 800     return -ENOTSOCK;
 801
 802   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
 803     return -EINVAL;
 804
 805   switch (vcom_socket_check_ioctl_cmd (__cmd))
 806     {
 807       /* Not supported cmd */
 808     case 0:
 809       rv = -EOPNOTSUPP;
 810       break;
 811
 812       /* cmd not handled by vcom and vppcom */
 813     case 1:
 814       rv = libc_vioctl (vsock->fd, __cmd, __ap);
 815       break;
 816
 817       /* cmd handled by vcom socket resource */
 818     case 2:
 819       rv = libc_vioctl (vsock->fd, __cmd, __ap);
 820       break;
 821
 822       /* cmd handled by vppcom */
 823     case 3:
 824       rv = vcom_session_ioctl_va (vsock->sid, __cmd, __ap);
 825       break;
 826
 827     default:
 828       rv = -EINVAL;
 829       break;
 830     }
 831
 832   return rv;
 833 }
 834
 835 static inline int
 836 vcom_socket_fds_2_sid_fds (
 837                             /* dest */
 838                             int *vcom_nsid_fds,
 839                             fd_set * __restrict vcom_rd_sid_fds,
 840                             fd_set * __restrict vcom_wr_sid_fds,
 841                             fd_set * __restrict vcom_ex_sid_fds,
 842                             /* src */
 843                             int vcom_nfds,
 844                             fd_set * __restrict vcom_readfds,
 845                             fd_set * __restrict vcom_writefds,
 846                             fd_set * __restrict vcom_exceptfds)
 847 {
 848   int rv = 0;
 849   int fd;
 850   int sid;
 851   /* invalid max_sid is -1 */
 852   int max_sid = -1;
 853   int nsid = 0;
 854
 855   /*
 856    *  set sid in sid sets corresponding to fd's in fd sets
 857    *  compute nsid and vcom_nsid_fds from sid sets
 858    */
 859
 860   for (fd = 0; fd < vcom_nfds; fd++)
 861     {
 862       /*
 863        * F fd set, src
 864        * S sid set, dest
 865        */
 866 #define _(S,F)                              \
 867       if ((F) && (S) && FD_ISSET (fd, (F))) \
 868         {                                   \
 869           sid = vcom_socket_get_sid (fd);   \
 870           if (sid != INVALID_SESSION_ID)    \
 871             {                               \
 872               FD_SET (sid, (S));            \
 873               if (sid > max_sid)            \
 874                 {                           \
 875                   max_sid = sid;            \
 876                 }                           \
 877               ++nsid;                       \
 878             }                               \
 879           else                              \
 880             {                               \
 881               rv = -EBADFD;                 \
 882               goto done;                    \
 883             }                               \
 884         }
 885
 886
 887       _(vcom_rd_sid_fds, vcom_readfds);
 888       _(vcom_wr_sid_fds, vcom_writefds);
 889       _(vcom_ex_sid_fds, vcom_exceptfds);
 890 #undef _
 891     }
 892
 893   *vcom_nsid_fds = max_sid != -1 ? max_sid + 1 : 0;
 894   rv = nsid;
 895
 896 done:
 897   return rv;
 898 }
 899
 900 /*
 901  * PRE: 00. sid sets were derived from fd sets
 902  *      01. sid sets were updated with sids that actually changed
 903  *          status
 904  *      02. fd sets still has watched fds
 905  *
 906  * This function will modify in place fd sets to indicate which fd's
 907  * actually changed status(inferred from sid sets)
 908  */
 909 static inline int
 910 vcom_socket_sid_fds_2_fds (
 911                             /* dest */
 912                             int *new_vcom_nfds,
 913                             int vcom_nfds,
 914                             fd_set * __restrict vcom_readfds,
 915                             fd_set * __restrict vcom_writefds,
 916                             fd_set * __restrict vcom_exceptfds,
 917                             /* src */
 918                             int vcom_nsid_fds,
 919                             fd_set * __restrict vcom_rd_sid_fds,
 920                             fd_set * __restrict vcom_wr_sid_fds,
 921                             fd_set * __restrict vcom_ex_sid_fds)
 922 {
 923   int rv = 0;
 924   int fd;
 925   int sid;
 926   /* invalid max_fd is -1 */
 927   int max_fd = -1;
 928   int nfd = 0;
 929
 930
 931   /*
 932    *  modify in place fd sets to indicate which fd's
 933    * actually changed status(inferred from sid sets)
 934    */
 935   for (fd = 0; fd < vcom_nfds; fd++)
 936     {
 937       /*
 938        * F fd set, dest
 939        * S sid set, src
 940        */
 941 #define _(S,F)                              \
 942       if ((F) && (S) && FD_ISSET (fd, (F))) \
 943         {                                   \
 944           sid = vcom_socket_get_sid (fd);   \
 945           if (sid != INVALID_SESSION_ID)    \
 946             {                               \
 947               if (!FD_ISSET (sid, (S)))     \
 948                 {                           \
 949                    FD_CLR(fd, (F));         \
 950                 }                           \
 951             }                               \
 952           else                              \
 953             {                               \
 954               rv = -EBADFD;                 \
 955               goto done;                    \
 956             }                               \
 957         }
 958
 959
 960       _(vcom_rd_sid_fds, vcom_readfds);
 961       _(vcom_wr_sid_fds, vcom_writefds);
 962       _(vcom_ex_sid_fds, vcom_exceptfds);
 963 #undef _
 964     }
 965
 966   /*
 967    *  compute nfd and new_vcom_nfds from fd sets
 968    */
 969   for (fd = 0; fd < vcom_nfds; fd++)
 970     {
 971
 972 #define _(F)                                \
 973       if ((F) && FD_ISSET (fd, (F)))        \
 974         {                                   \
 975           if (fd > max_fd)                  \
 976             {                               \
 977               max_fd = fd;                  \
 978             }                               \
 979           ++nfd;                            \
 980         }
 981
 982
 983       _(vcom_readfds);
 984       _(vcom_writefds);
 985       _(vcom_exceptfds);
 986 #undef _
 987
 988     }
 989
 990   *new_vcom_nfds = max_fd != -1 ? max_fd + 1 : 0;
 991   rv = nfd;
 992
 993 done:
 994   return rv;
 995 }
 996
 997 /*
 998  * PRE:
 999  * vom_socket_select is always called with
1000  * timeout->tv_sec and timeout->tv_usec set to zero.
1001  * hence vppcom_select return immediately.
1002  */
1003 /*
1004  * TBD: do{body;} while(timeout conditional); timeout loop
1005  */
1006 int
1007 vcom_socket_select (int vcom_nfds, fd_set * __restrict vcom_readfds,
1008                     fd_set * __restrict vcom_writefds,
1009                     fd_set * __restrict vcom_exceptfds,
1010                     struct timeval *__restrict timeout)
1011 {
1012   static unsigned long vcom_nsid_fds = 0;
1013   int vcom_nsid = 0;
1014   int rv = -EBADF;
1015   pid_t pid = getpid ();
1016
1017   int new_vcom_nfds = 0;
1018   int new_vcom_nfd = 0;
1019
1020   /* vcom sid fds */
1021   fd_set vcom_rd_sid_fds;
1022   fd_set vcom_wr_sid_fds;
1023   fd_set vcom_ex_sid_fds;
1024
1025   /* in seconds eg. 3.123456789 seconds */
1026   double time_to_wait = (double) 0;
1027
1028   /* validate inputs */
1029   if (vcom_nfds < 0)
1030     {
1031       return -EINVAL;
1032     }
1033
1034   /* convert timeval timeout to double time_to_wait */
1035   if (timeout)
1036     {
1037       if (timeout->tv_sec == 0 && timeout->tv_usec == 0)
1038         {
1039           /* polling: vppcom_select returns immediately */
1040           time_to_wait = (double) 0;
1041         }
1042       else
1043         {
1044           /*TBD:  use timeval api */
1045           time_to_wait = (double) timeout->tv_sec +
1046             (double) timeout->tv_usec / (double) 1000000 +
1047             (double) (timeout->tv_usec % 1000000) / (double) 1000000;
1048         }
1049     }
1050   else
1051     {
1052       /*
1053        * no timeout: vppcom_select can block indefinitely
1054        * waiting for a file descriptor to become ready
1055        * */
1056       /* set to a phantom value */
1057       time_to_wait = ~0;
1058     }
1059
1060   /* zero the sid_sets */
1061   /*
1062    * F fd set
1063    * S sid set
1064    */
1065 #define _(S,F)                          \
1066   if ((F))                              \
1067     {                                   \
1068       FD_ZERO ((S));                    \
1069     }
1070
1071
1072   _(&vcom_rd_sid_fds, vcom_readfds);
1073   _(&vcom_wr_sid_fds, vcom_writefds);
1074   _(&vcom_ex_sid_fds, vcom_exceptfds);
1075 #undef _
1076
1077   if (vcom_nfds == 0)
1078     {
1079       if (time_to_wait > 0)
1080         {
1081           if (VCOM_DEBUG > 0)
1082             fprintf (stderr,
1083                      "[%d] vcom_socket_select called to "
1084                      "emulate delay_ns()!\n", pid);
1085           rv = vppcom_select (0, NULL, NULL, NULL, time_to_wait);
1086         }
1087       else
1088         {
1089           fprintf (stderr, "[%d] vcom_socket_select called vcom_nfds = 0 "
1090                    "and invalid time_to_wait (%f)!\n", pid, time_to_wait);
1091         }
1092       return 0;
1093     }
1094
1095   /* populate read, write and except sid_sets */
1096   vcom_nsid = vcom_socket_fds_2_sid_fds (
1097                                           /* dest */
1098                                           vcom_readfds || vcom_writefds
1099                                           || vcom_exceptfds ? (int *)
1100                                           &vcom_nsid_fds : NULL,
1101                                           vcom_readfds ? &vcom_rd_sid_fds :
1102                                           NULL,
1103                                           vcom_writefds ? &vcom_wr_sid_fds :
1104                                           NULL,
1105                                           vcom_exceptfds ? &vcom_ex_sid_fds :
1106                                           NULL,
1107                                           /* src */
1108                                           vcom_nfds,
1109                                           vcom_readfds,
1110                                           vcom_writefds, vcom_exceptfds);
1111   if (vcom_nsid < 0)
1112     {
1113       return vcom_nsid;
1114     }
1115
1116   rv = vppcom_select (vcom_nsid_fds,
1117                       vcom_readfds ? (unsigned long *) &vcom_rd_sid_fds :
1118                       NULL,
1119                       vcom_writefds ? (unsigned long *) &vcom_wr_sid_fds :
1120                       NULL,
1121                       vcom_exceptfds ? (unsigned long *) &vcom_ex_sid_fds :
1122                       NULL, time_to_wait);
1123   if (VCOM_DEBUG > 2)
1124     fprintf (stderr, "[%d] called vppcom_select(): "
1125              "'%04d'='%04d'\n", pid, rv, (int) vcom_nsid_fds);
1126
1127   /* check if any file descriptors changed status */
1128   if (rv > 0)
1129     {
1130       /*
1131        * on exit, sets are modified in place to indicate which
1132        * file descriptors actually changed status
1133        * */
1134
1135       /*
1136        * comply with pre-condition
1137        * do not clear vcom fd sets befor calling
1138        * vcom_socket_sid_fds_2_fds
1139        */
1140       new_vcom_nfd = vcom_socket_sid_fds_2_fds (
1141                                                  /* dest */
1142                                                  &new_vcom_nfds,
1143                                                  vcom_nfds,
1144                                                  vcom_readfds,
1145                                                  vcom_writefds,
1146                                                  vcom_exceptfds,
1147                                                  /* src */
1148                                                  vcom_nsid_fds,
1149                                                  vcom_readfds ?
1150                                                  &vcom_rd_sid_fds : NULL,
1151                                                  vcom_writefds ?
1152                                                  &vcom_wr_sid_fds : NULL,
1153                                                  vcom_exceptfds ?
1154                                                  &vcom_ex_sid_fds : NULL);
1155       if (new_vcom_nfd < 0)
1156         {
1157           return new_vcom_nfd;
1158         }
1159       if (new_vcom_nfds < 0)
1160         {
1161           return -EINVAL;
1162         }
1163       rv = new_vcom_nfd;
1164     }
1165   return rv;
1166 }
1167
1168
1169 int
1170 vcom_socket_socket (int __domain, int __type, int __protocol)
1171 {
1172   int rv = -1;
1173   vcom_socket_main_t *vsm = &vcom_socket_main;
1174   vcom_socket_t *vsock;
1175
1176   i32 fd;
1177   i32 sid;
1178   i32 sockidx;
1179   u8 is_nonblocking = __type & SOCK_NONBLOCK ? 1 : 0;
1180   int type = __type & ~(SOCK_NONBLOCK | SOCK_CLOEXEC);
1181
1182   fd = vcom_socket_open_socket (__domain, __type, __protocol);
1183   if (fd < 0)
1184     {
1185       rv = fd;
1186       goto out;
1187     }
1188
1189   sid = vppcom_session_create (VPPCOM_VRF_DEFAULT,
1190                                (type == SOCK_DGRAM) ?
1191                                VPPCOM_PROTO_UDP : VPPCOM_PROTO_TCP,
1192                                is_nonblocking);
1193   if (sid < 0)
1194     {
1195       rv = sid;
1196       goto out_close_socket;
1197     }
1198
1199   pool_get (vsm->vsockets, vsock);
1200   vsocket_init (vsock);
1201
1202   sockidx = vsock - vsm->vsockets;
1203   hash_set (vsm->sockidx_by_fd, fd, sockidx);
1204
1205   vsocket_set (vsock, fd, sid, SOCKET_TYPE_VPPCOM_BOUND);
1206   return fd;
1207
1208 out_close_socket:
1209   vcom_socket_close_socket (fd);
1210 out:
1211   return rv;
1212 }
1213
1214 int
1215 vcom_socket_socketpair (int __domain, int __type, int __protocol,
1216                         int __fds[2])
1217 {
1218 /* TBD: */
1219   return 0;
1220 }
1221
1222 int
1223 vcom_socket_bind (int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len)
1224 {
1225   int rv = -1;
1226   vcom_socket_main_t *vsm = &vcom_socket_main;
1227   uword *p;
1228   vcom_socket_t *vsock;
1229
1230   vppcom_endpt_t ep;
1231
1232   p = hash_get (vsm->sockidx_by_fd, __fd);
1233   if (!p)
1234     return -EBADF;
1235
1236   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1237   if (!vsock)
1238     return -ENOTSOCK;
1239
1240   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1241     return -EINVAL;
1242
1243   if (!__addr)
1244     {
1245       return -EINVAL;
1246     }
1247
1248   ep.vrf = VPPCOM_VRF_DEFAULT;
1249   switch (__addr->sa_family)
1250     {
1251     case AF_INET:
1252       if (__len != sizeof (struct sockaddr_in))
1253         {
1254           return -EINVAL;
1255         }
1256       ep.is_ip4 = VPPCOM_IS_IP4;
1257       ep.ip = (u8 *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1258       ep.port = (u16) ((const struct sockaddr_in *) __addr)->sin_port;
1259       break;
1260
1261     case AF_INET6:
1262       if (__len != sizeof (struct sockaddr_in6))
1263         {
1264           return -EINVAL;
1265         }
1266       ep.is_ip4 = VPPCOM_IS_IP6;
1267       ep.ip = (u8 *) & ((const struct sockaddr_in6 *) __addr)->sin6_addr;
1268       ep.port = (u16) ((const struct sockaddr_in6 *) __addr)->sin6_port;
1269       break;
1270
1271     default:
1272       return -1;
1273       break;
1274     }
1275
1276   rv = vppcom_session_bind (vsock->sid, &ep);
1277   return rv;
1278 }
1279
1280 static inline int
1281 vcom_session_getsockname (int sid, vppcom_endpt_t * ep)
1282 {
1283   int rv;
1284   uint32_t size = sizeof (*ep);
1285
1286   rv = vppcom_session_attr (sid, VPPCOM_ATTR_GET_LCL_ADDR, ep, &size);
1287   return rv;
1288 }
1289
1290 int
1291 vcom_socket_getsockname (int __fd, __SOCKADDR_ARG __addr,
1292                          socklen_t * __restrict __len)
1293 {
1294   int rv = -1;
1295   vcom_socket_main_t *vsm = &vcom_socket_main;
1296   uword *p;
1297   vcom_socket_t *vsock;
1298
1299
1300   p = hash_get (vsm->sockidx_by_fd, __fd);
1301   if (!p)
1302     return -EBADF;
1303
1304   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1305   if (!vsock)
1306     return -ENOTSOCK;
1307
1308   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1309     return -EINVAL;
1310
1311   if (!__addr || !__len)
1312     return -EFAULT;
1313
1314   vppcom_endpt_t ep;
1315   ep.ip = (u8 *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1316   rv = vcom_session_getsockname (vsock->sid, &ep);
1317   if (rv == 0)
1318     {
1319       if (ep.vrf == VPPCOM_VRF_DEFAULT)
1320         {
1321           __addr->sa_family = ep.is_ip4 == VPPCOM_IS_IP4 ? AF_INET : AF_INET6;
1322           switch (__addr->sa_family)
1323             {
1324             case AF_INET:
1325               ((struct sockaddr_in *) __addr)->sin_port = ep.port;
1326               *__len = sizeof (struct sockaddr_in);
1327               break;
1328
1329             case AF_INET6:
1330               ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
1331               *__len = sizeof (struct sockaddr_in6);
1332               break;
1333
1334             default:
1335               break;
1336             }
1337         }
1338     }
1339
1340   return rv;
1341 }
1342
1343 int
1344 vcom_socket_connect (int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len)
1345 {
1346   int rv = -1;
1347   vcom_socket_main_t *vsm = &vcom_socket_main;
1348   uword *p;
1349   vcom_socket_t *vsock;
1350
1351   vppcom_endpt_t ep;
1352
1353   p = hash_get (vsm->sockidx_by_fd, __fd);
1354   if (p)
1355     {
1356       vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1357
1358       ep.vrf = VPPCOM_VRF_DEFAULT;
1359       switch (__addr->sa_family)
1360         {
1361         case AF_INET:
1362           ep.is_ip4 = VPPCOM_IS_IP4;
1363           ep.ip =
1364             (uint8_t *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1365           ep.port =
1366             (uint16_t) ((const struct sockaddr_in *) __addr)->sin_port;
1367           break;
1368
1369         case AF_INET6:
1370           ep.is_ip4 = VPPCOM_IS_IP6;
1371           ep.ip =
1372             (uint8_t *) & ((const struct sockaddr_in6 *) __addr)->sin6_addr;
1373           ep.port =
1374             (uint16_t) ((const struct sockaddr_in6 *) __addr)->sin6_port;
1375           break;
1376
1377         default:
1378           return -1;
1379           break;
1380         }
1381
1382       rv = vppcom_session_connect (vsock->sid, &ep);
1383     }
1384   return rv;
1385 }
1386
1387 static inline int
1388 vcom_session_getpeername (int sid, vppcom_endpt_t * ep)
1389 {
1390   int rv;
1391   uint32_t size = sizeof (*ep);
1392
1393   rv = vppcom_session_attr (sid, VPPCOM_ATTR_GET_PEER_ADDR, ep, &size);
1394   return rv;
1395 }
1396
1397 int
1398 vcom_socket_getpeername (int __fd, __SOCKADDR_ARG __addr,
1399                          socklen_t * __restrict __len)
1400 {
1401   int rv = -1;
1402   vcom_socket_main_t *vsm = &vcom_socket_main;
1403   uword *p;
1404   vcom_socket_t *vsock;
1405
1406
1407   p = hash_get (vsm->sockidx_by_fd, __fd);
1408   if (!p)
1409     return -EBADF;
1410
1411   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1412   if (!vsock)
1413     return -ENOTSOCK;
1414
1415   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1416     return -EINVAL;
1417
1418   if (!__addr || !__len)
1419     return -EFAULT;
1420
1421   vppcom_endpt_t ep;
1422   ep.ip = (u8 *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1423   rv = vcom_session_getpeername (vsock->sid, &ep);
1424   if (rv == 0)
1425     {
1426       if (ep.vrf == VPPCOM_VRF_DEFAULT)
1427         {
1428           __addr->sa_family = ep.is_ip4 == VPPCOM_IS_IP4 ? AF_INET : AF_INET6;
1429           switch (__addr->sa_family)
1430             {
1431             case AF_INET:
1432               ((struct sockaddr_in *) __addr)->sin_port = ep.port;
1433               *__len = sizeof (struct sockaddr_in);
1434               break;
1435
1436             case AF_INET6:
1437               ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
1438               *__len = sizeof (struct sockaddr_in6);
1439               break;
1440
1441             default:
1442               break;
1443             }
1444         }
1445     }
1446
1447   return rv;
1448 }
1449
1450 ssize_t
1451 vcom_socket_send (int __fd, const void *__buf, size_t __n, int __flags)
1452 {
1453   return vcom_socket_sendto (__fd, __buf, __n, __flags, NULL, 0);
1454 }
1455
1456 ssize_t
1457 vcom_socket_recv (int __fd, void *__buf, size_t __n, int __flags)
1458 {
1459   int rv = -1;
1460   rv = vcom_socket_recvfrom (__fd, __buf, __n, __flags, NULL, 0);
1461   return rv;
1462 }
1463
1464 /*
1465  * RETURN   1 if __fd is (SOCK_STREAM, SOCK_SEQPACKET),
1466  * 0 otherwise
1467  * */
1468 int
1469 vcom_socket_is_connection_mode_socket (int __fd)
1470 {
1471   int rv = -1;
1472   /* TBD define new vppcom api */
1473   vcom_socket_main_t *vsm = &vcom_socket_main;
1474   uword *p;
1475   vcom_socket_t *vsock;
1476
1477   int type;
1478   socklen_t optlen;
1479
1480   p = hash_get (vsm->sockidx_by_fd, __fd);
1481
1482   if (p)
1483     {
1484       vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1485       if (vsock && vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
1486         {
1487           optlen = sizeof (type);
1488           rv = libc_getsockopt (__fd, SOL_SOCKET, SO_TYPE, &type, &optlen);
1489           if (rv != 0)
1490             {
1491               return 0;
1492             }
1493           /* get socket type */
1494           switch (type & ~(SOCK_CLOEXEC | SOCK_NONBLOCK))
1495             {
1496             case SOCK_STREAM:
1497             case SOCK_SEQPACKET:
1498               return 1;
1499               break;
1500
1501             default:
1502               return 0;
1503               break;
1504             }
1505         }
1506     }
1507   return 0;
1508 }
1509
1510 static inline ssize_t
1511 vcom_session_sendto (int __sid, void *__buf, size_t __n,
1512                      int __flags, __CONST_SOCKADDR_ARG __addr,
1513                      socklen_t __addr_len)
1514 {
1515   vppcom_endpt_t *ep = 0;
1516   vppcom_endpt_t _ep;
1517
1518   if (__addr)
1519     {
1520       ep = &_ep;
1521       ep->vrf = VPPCOM_VRF_DEFAULT;
1522       switch (__addr->sa_family)
1523         {
1524         case AF_INET:
1525           ep->is_ip4 = VPPCOM_IS_IP4;
1526           ep->ip =
1527             (uint8_t *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1528           ep->port =
1529             (uint16_t) ((const struct sockaddr_in *) __addr)->sin_port;
1530           break;
1531
1532         case AF_INET6:
1533           ep->is_ip4 = VPPCOM_IS_IP6;
1534           ep->ip =
1535             (uint8_t *) & ((const struct sockaddr_in6 *) __addr)->sin6_addr;
1536           ep->port =
1537             (uint16_t) ((const struct sockaddr_in6 *) __addr)->sin6_port;
1538           break;
1539
1540         default:
1541           return -EAFNOSUPPORT;
1542         }
1543     }
1544
1545   return vppcom_session_sendto (__sid, __buf, __n, __flags, ep);;
1546 }
1547
1548 ssize_t
1549 vcom_socket_sendto (int __fd, const void *__buf, size_t __n,
1550                     int __flags, __CONST_SOCKADDR_ARG __addr,
1551                     socklen_t __addr_len)
1552 {
1553   vcom_socket_main_t *vsm = &vcom_socket_main;
1554   uword *p;
1555   vcom_socket_t *vsock;
1556
1557   if (!__buf)
1558     {
1559       return -EINVAL;
1560     }
1561
1562   p = hash_get (vsm->sockidx_by_fd, __fd);
1563   if (!p)
1564     return -EBADF;
1565
1566   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1567   if (!vsock)
1568     return -ENOTSOCK;
1569
1570   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1571     {
1572       return -EINVAL;
1573     }
1574
1575   if (vcom_socket_is_connection_mode_socket (__fd))
1576     {
1577       /* ignore __addr and _addr_len */
1578       /* and EISCONN may be returned when they are not NULL and 0 */
1579       if ((__addr != NULL) || (__addr_len != 0))
1580         {
1581           return -EISCONN;
1582         }
1583     }
1584   else
1585     {
1586       if (!__addr)
1587         {
1588           return -EDESTADDRREQ;
1589         }
1590       /* not a vppcom supported address family */
1591       if (!((__addr->sa_family == AF_INET) ||
1592             (__addr->sa_family == AF_INET6)))
1593         {
1594           return -EINVAL;
1595         }
1596     }
1597
1598   return vcom_session_sendto (vsock->sid, (void *) __buf, (int) __n,
1599                               __flags, __addr, __addr_len);
1600 }
1601
1602 static inline ssize_t
1603 vcom_session_recvfrom (int __sid, void *__restrict __buf, size_t __n,
1604                        int __flags, __SOCKADDR_ARG __addr,
1605                        socklen_t * __restrict __addr_len)
1606 {
1607   int rv;
1608   vppcom_endpt_t ep;
1609   u8 src_addr[sizeof (struct sockaddr_in6)];
1610
1611   if (__addr)
1612     {
1613       ep.ip = src_addr;
1614       rv = vppcom_session_recvfrom (__sid, __buf, __n, __flags, &ep);
1615
1616       if (rv > 0)
1617         {
1618           if (ep.vrf == VPPCOM_VRF_DEFAULT)
1619             {
1620               __addr->sa_family =
1621                 ep.is_ip4 == VPPCOM_IS_IP4 ? AF_INET : AF_INET6;
1622               switch (__addr->sa_family)
1623                 {
1624                 case AF_INET:
1625                   ((struct sockaddr_in *) __addr)->sin_port = ep.port;
1626                   memcpy (&((struct sockaddr_in *) __addr)->sin_addr,
1627                           src_addr, sizeof (struct in_addr));
1628
1629                   *__addr_len = sizeof (struct sockaddr_in);
1630                   break;
1631
1632                 case AF_INET6:
1633                   ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
1634                   memcpy (((struct sockaddr_in6 *) __addr)->sin6_addr.
1635                           __in6_u.__u6_addr8, src_addr,
1636                           sizeof (struct in6_addr));
1637                   *__addr_len = sizeof (struct sockaddr_in6);
1638                   break;
1639
1640                 default:
1641                   rv = -EAFNOSUPPORT;
1642                   break;
1643                 }
1644             }
1645           else
1646             rv = -1;
1647         }
1648     }
1649   else
1650     rv = vppcom_session_recvfrom (__sid, __buf, __n, __flags, NULL);
1651
1652   return rv;
1653 }
1654
1655 ssize_t
1656 vcom_socket_recvfrom (int __fd, void *__restrict __buf, size_t __n,
1657                       int __flags, __SOCKADDR_ARG __addr,
1658                       socklen_t * __restrict __addr_len)
1659 {
1660   int rv = -1;
1661   vcom_socket_main_t *vsm = &vcom_socket_main;
1662   uword *p;
1663   vcom_socket_t *vsock;
1664
1665   if (__addr && !__addr_len)
1666     return -EINVAL;
1667
1668   p = hash_get (vsm->sockidx_by_fd, __fd);
1669   if (!p)
1670     return -EBADF;
1671
1672   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1673   if (!vsock)
1674     return -ENOTSOCK;
1675
1676   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1677     {
1678       return -EINVAL;
1679     }
1680
1681   rv = vcom_session_recvfrom (vsock->sid, __buf, __n,
1682                               __flags, __addr, __addr_len);
1683   return rv;
1684 }
1685
1686 /* TBD: move it to vppcom */
1687 static inline ssize_t
1688 vcom_session_sendmsg (int __sid, const struct msghdr *__message, int __flags)
1689 {
1690   int rv = -1;
1691   /* rv = vppcom_session_write (__sid, (void *) __message->__buf,
1692      (int)__n); */
1693   return rv;
1694 }
1695
1696 ssize_t
1697 vcom_socket_sendmsg (int __fd, const struct msghdr * __message, int __flags)
1698 {
1699   int rv = -1;
1700   vcom_socket_main_t *vsm = &vcom_socket_main;
1701   uword *p;
1702   vcom_socket_t *vsock;
1703
1704   p = hash_get (vsm->sockidx_by_fd, __fd);
1705   if (!p)
1706     return -EBADF;
1707
1708   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1709   if (!vsock)
1710     return -ENOTSOCK;
1711
1712   if (vcom_socket_is_connection_mode_socket (__fd))
1713     {
1714       /* ignore __addr and _addr_len */
1715       /* and EISCONN may be returned when they are not NULL and 0 */
1716       if ((__message->msg_name != NULL) || (__message->msg_namelen != 0))
1717         {
1718           return -EISCONN;
1719         }
1720     }
1721   else
1722     {
1723       /* TBD: validate __message->msg_name and __message->msg_namelen
1724        * and return -EINVAL on validation error
1725        * */
1726       ;
1727     }
1728
1729   rv = vcom_session_sendmsg (vsock->sid, __message, __flags);
1730
1731   return rv;
1732 }
1733
1734 #ifdef __USE_GNU
1735 int
1736 vcom_socket_sendmmsg (int __fd, struct mmsghdr *__vmessages,
1737                       unsigned int __vlen, int __flags)
1738 {
1739
1740   /* TBD: define a new vppcom api */
1741   return 0;
1742 }
1743 #endif
1744
1745 /* TBD: move it to vppcom */
1746 static inline ssize_t
1747 vcom_session_recvmsg (int __sid, struct msghdr *__message, int __flags)
1748 {
1749   int rv = -1;
1750   /* rv = vppcom_session_read (__sid, (void *) __message->__buf,
1751      (int)__n); */
1752   rv = -EOPNOTSUPP;
1753   return rv;
1754 }
1755
1756 ssize_t
1757 vcom_socket_recvmsg (int __fd, struct msghdr * __message, int __flags)
1758 {
1759   int rv = -1;
1760   vcom_socket_main_t *vsm = &vcom_socket_main;
1761   uword *p;
1762   vcom_socket_t *vsock;
1763
1764   p = hash_get (vsm->sockidx_by_fd, __fd);
1765   if (!p)
1766     return -EBADF;
1767
1768   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1769   if (!vsock)
1770     return -ENOTSOCK;
1771
1772   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1773     return -EINVAL;
1774
1775   if (!__message)
1776     {
1777       return -EINVAL;
1778     }
1779
1780   /* validate __flags */
1781
1782   rv = vcom_session_recvmsg (vsock->sid, __message, __flags);
1783   return rv;
1784 }
1785
1786 #ifdef __USE_GNU
1787 int
1788 vcom_socket_recvmmsg (int __fd, struct mmsghdr *__vmessages,
1789                       unsigned int __vlen, int __flags,
1790                       struct timespec *__tmo)
1791 {
1792   /* TBD: define a new vppcom api */
1793   return 0;
1794 }
1795 #endif
1796
1797 /* TBD: move it to vppcom */
1798 static inline int
1799 vcom_session_get_sockopt (int __sid, int __level, int __optname,
1800                           void *__restrict __optval,
1801                           socklen_t * __restrict __optlen)
1802 {
1803   int rv = 0;
1804
1805   /* 1. for socket level options that are NOT socket attributes
1806    *    and that has corresponding vpp options get from vppcom */
1807   switch (__level)
1808     {
1809     case SOL_SOCKET:
1810       switch (__optname)
1811         {
1812         case SO_ERROR:
1813           *(int *) __optval = 0;
1814           break;
1815         default:
1816           break;
1817         }
1818     default:
1819       break;
1820     }
1821   /* 2. unhandled options */
1822   return rv;
1823 }
1824
1825 int
1826 vcom_socket_getsockopt (int __fd, int __level, int __optname,
1827                         void *__restrict __optval,
1828                         socklen_t * __restrict __optlen)
1829 {
1830   int rv = -1;
1831   vcom_socket_main_t *vsm = &vcom_socket_main;
1832   uword *p;
1833   vcom_socket_t *vsock;
1834
1835   if (!__optval || !__optlen)
1836     return -EINVAL;
1837
1838   p = hash_get (vsm->sockidx_by_fd, __fd);
1839   if (!p)
1840     return -EBADF;
1841
1842   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1843   if (!vsock)
1844     return -ENOTSOCK;
1845
1846   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1847     return -EINVAL;
1848
1849   switch (__level)
1850     {
1851     case SOL_SOCKET:
1852       switch (__optname)
1853         {
1854 /*
1855  *  1. for socket level options that are socket attributes,
1856  *     get from libc_getsockopt.
1857  *  2. for socket level options that are NOT socket
1858  *     attributes and that has corresponding vpp options
1859  *     get from vppcom.
1860  *  3. for socket level options unimplemented
1861  *     return -ENOPROTOOPT */
1862         case SO_DEBUG:
1863         case SO_DONTROUTE:
1864         case SO_BROADCAST:
1865         case SO_SNDBUF:
1866         case SO_RCVBUF:
1867         case SO_REUSEADDR:
1868         case SO_REUSEPORT:
1869         case SO_KEEPALIVE:
1870         case SO_TYPE:
1871         case SO_PROTOCOL:
1872         case SO_DOMAIN:
1873         case SO_OOBINLINE:
1874         case SO_NO_CHECK:
1875         case SO_PRIORITY:
1876         case SO_LINGER:
1877         case SO_BSDCOMPAT:
1878         case SO_TIMESTAMP:
1879         case SO_TIMESTAMPNS:
1880         case SO_TIMESTAMPING:
1881         case SO_RCVTIMEO:
1882         case SO_SNDTIMEO:
1883         case SO_RCVLOWAT:
1884         case SO_SNDLOWAT:
1885         case SO_PASSCRED:
1886         case SO_PEERCRED:
1887         case SO_PEERNAME:
1888         case SO_ACCEPTCONN:
1889         case SO_PASSSEC:
1890         case SO_PEERSEC:
1891         case SO_MARK:
1892         case SO_RXQ_OVFL:
1893         case SO_WIFI_STATUS:
1894         case SO_PEEK_OFF:
1895         case SO_NOFCS:
1896         case SO_BINDTODEVICE:
1897         case SO_GET_FILTER:
1898         case SO_LOCK_FILTER:
1899         case SO_BPF_EXTENSIONS:
1900         case SO_SELECT_ERR_QUEUE:
1901 #ifdef CONFIG_NET_RX_BUSY_POLL
1902         case SO_BUSY_POLL:
1903 #endif
1904         case SO_MAX_PACING_RATE:
1905 #ifdef SO_INCOMING_CPU
1906         case SO_INCOMING_CPU:
1907 #endif
1908           rv = libc_getsockopt (__fd, __level, __optname, __optval, __optlen);
1909           if (rv != 0)
1910             {
1911               rv = -errno;
1912               return rv;
1913             }
1914           break;
1915
1916         case SO_ERROR:
1917           rv = vcom_session_get_sockopt (vsock->sid, __level, __optname,
1918                                          __optval, __optlen);
1919           break;
1920
1921         default:
1922           /* We implement the SO_SNDLOWAT etc to not be settable
1923            * (1003.1g 7).
1924            */
1925           return -ENOPROTOOPT;
1926         }
1927
1928       break;
1929
1930     default:
1931       /* 1. handle options that are NOT socket level options,
1932        *    but have corresponding vpp otions. */
1933       rv = vcom_session_get_sockopt (vsock->sid, __level, __optname,
1934                                      __optval, __optlen);
1935       break;
1936     }
1937
1938   return rv;
1939 }
1940
1941 /* TBD: move it to vppcom */
1942 static inline int
1943 vcom_session_setsockopt (int __sid, int __level, int __optname,
1944                          const void *__optval, socklen_t __optlen)
1945 {
1946   int rv = -EOPNOTSUPP;
1947
1948   switch (__level)
1949     {
1950     case SOL_TCP:
1951       switch (__optname)
1952         {
1953         case TCP_KEEPIDLE:
1954           rv =
1955             vppcom_session_attr (__sid, VPPCOM_ATTR_SET_TCP_KEEPIDLE, 0, 0);
1956           break;
1957         case TCP_KEEPINTVL:
1958           rv =
1959             vppcom_session_attr (__sid, VPPCOM_ATTR_SET_TCP_KEEPINTVL, 0, 0);
1960           break;
1961         default:
1962           break;
1963         }
1964       break;
1965     case SOL_IPV6:
1966       switch (__optname)
1967         {
1968         case IPV6_V6ONLY:
1969           rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_V6ONLY, 0, 0);
1970           break;
1971         default:
1972           break;
1973         }
1974       break;
1975     case SOL_SOCKET:
1976       switch (__optname)
1977         {
1978         case SO_KEEPALIVE:
1979           rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_KEEPALIVE, 0, 0);
1980           break;
1981         case SO_REUSEADDR:
1982           rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_REUSEADDR, 0, 0);
1983           break;
1984         case SO_BROADCAST:
1985           rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_BROADCAST, 0, 0);
1986           break;
1987         default:
1988           break;
1989         }
1990       break;
1991     default:
1992       break;
1993     }
1994
1995   return rv;
1996 }
1997
1998 int
1999 vcom_socket_setsockopt (int __fd, int __level, int __optname,
2000                         const void *__optval, socklen_t __optlen)
2001 {
2002   int rv = -1;
2003   vcom_socket_main_t *vsm = &vcom_socket_main;
2004   uword *p;
2005   vcom_socket_t *vsock;
2006
2007   p = hash_get (vsm->sockidx_by_fd, __fd);
2008   if (!p)
2009     return -EBADF;
2010
2011   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2012   if (!vsock)
2013     return -ENOTSOCK;
2014
2015   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
2016     return -EINVAL;
2017
2018   /*
2019    *      Options without arguments
2020    */
2021
2022   if (__optname == SO_BINDTODEVICE)
2023     {
2024       rv = libc_setsockopt (__fd, __level, __optname, __optval, __optlen);
2025       if (rv != 0)
2026         {
2027           rv = -errno;
2028         }
2029       return rv;
2030     }
2031
2032   if (!__optval)
2033     return -EFAULT;
2034
2035   if (__optlen < sizeof (int))
2036     return -EINVAL;
2037
2038   switch (__level)
2039     {
2040     case SOL_IPV6:
2041       switch (__optname)
2042         {
2043         case IPV6_V6ONLY:
2044           rv = vcom_session_setsockopt (vsock->sid, __level, __optname,
2045                                         __optval, __optlen);
2046           break;
2047         default:
2048           return -EOPNOTSUPP;
2049         }
2050       break;
2051     case SOL_TCP:
2052       switch (__optname)
2053         {
2054         case TCP_NODELAY:
2055           return 0;
2056         case TCP_KEEPIDLE:
2057         case TCP_KEEPINTVL:
2058           rv = vcom_session_setsockopt (vsock->sid, __level, __optname,
2059                                         __optval, __optlen);
2060           break;
2061         default:
2062           return -EOPNOTSUPP;
2063         }
2064       break;
2065       /* handle options at socket level */
2066     case SOL_SOCKET:
2067       switch (__optname)
2068         {
2069         case SO_REUSEADDR:
2070         case SO_BROADCAST:
2071         case SO_KEEPALIVE:
2072           rv = vcom_session_setsockopt (vsock->sid, __level, __optname,
2073                                         __optval, __optlen);
2074           break;
2075
2076           /*
2077            * 1. for socket level options that are socket attributes,
2078            *    set it from libc_getsockopt
2079            * 2. for socket level options that are NOT socket
2080            *    attributes and that has corresponding vpp options
2081            *    set it from vppcom
2082            * 3. for socket level options unimplemented
2083            *    return -ENOPROTOOPT */
2084         case SO_DEBUG:
2085         case SO_DONTROUTE:
2086         case SO_SNDBUF:
2087         case SO_RCVBUF:
2088         case SO_REUSEPORT:
2089         case SO_TYPE:
2090         case SO_PROTOCOL:
2091         case SO_DOMAIN:
2092         case SO_ERROR:
2093         case SO_OOBINLINE:
2094         case SO_NO_CHECK:
2095         case SO_PRIORITY:
2096         case SO_LINGER:
2097         case SO_BSDCOMPAT:
2098         case SO_TIMESTAMP:
2099         case SO_TIMESTAMPNS:
2100         case SO_TIMESTAMPING:
2101         case SO_RCVTIMEO:
2102         case SO_SNDTIMEO:
2103         case SO_RCVLOWAT:
2104         case SO_SNDLOWAT:
2105         case SO_PASSCRED:
2106         case SO_PEERCRED:
2107         case SO_PEERNAME:
2108         case SO_ACCEPTCONN:
2109         case SO_PASSSEC:
2110         case SO_PEERSEC:
2111         case SO_MARK:
2112         case SO_RXQ_OVFL:
2113         case SO_WIFI_STATUS:
2114         case SO_PEEK_OFF:
2115         case SO_NOFCS:
2116           /*
2117            * SO_BINDTODEVICE already handled as
2118            * "Options without arguments" */
2119           /* case SO_BINDTODEVICE: */
2120         case SO_GET_FILTER:
2121         case SO_LOCK_FILTER:
2122         case SO_BPF_EXTENSIONS:
2123         case SO_SELECT_ERR_QUEUE:
2124 #ifdef CONFIG_NET_RX_BUSY_POLL
2125         case SO_BUSY_POLL:
2126 #endif
2127         case SO_MAX_PACING_RATE:
2128 #ifdef SO_INCOMING_CPU
2129         case SO_INCOMING_CPU:
2130 #endif
2131           rv = libc_setsockopt (__fd, __level, __optname, __optval, __optlen);
2132           if (rv != 0)
2133             {
2134               rv = -errno;
2135               return rv;
2136             }
2137           break;
2138
2139         default:
2140           /* We implement the SO_SNDLOWAT etc to not be settable
2141            * (1003.1g 7).
2142            */
2143           return -ENOPROTOOPT;
2144         }
2145
2146       break;
2147
2148     default:
2149       return -ENOPROTOOPT;
2150     }
2151
2152   return rv;
2153 }
2154
2155 int
2156 vcom_socket_listen (int __fd, int __n)
2157 {
2158   int rv = -1;
2159   vcom_socket_main_t *vsm = &vcom_socket_main;
2160   uword *p;
2161   vcom_socket_t *vsock;
2162
2163   p = hash_get (vsm->sockidx_by_fd, __fd);
2164   if (p)
2165     {
2166       vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2167
2168       /* TBD vppcom to accept __n parameter */
2169       rv = vppcom_session_listen (vsock->sid, __n);
2170     }
2171
2172   return rv;
2173 }
2174
2175 static int
2176 vcom_socket_connected_socket (int __fd, int __sid,
2177                               int *__domain,
2178                               int *__type, int *__protocol, int flags)
2179 {
2180   int rv = -1;
2181   vcom_socket_main_t *vsm = &vcom_socket_main;
2182   vcom_socket_t *vsock;
2183
2184   i32 fd;
2185   i32 sockidx;
2186
2187   socklen_t optlen;
2188
2189   optlen = sizeof (*__domain);
2190   rv = libc_getsockopt (__fd, SOL_SOCKET, SO_DOMAIN, __domain, &optlen);
2191   if (rv != 0)
2192     {
2193       rv = -errno;
2194       goto out;
2195     }
2196
2197   optlen = sizeof (*__type);
2198   rv = libc_getsockopt (__fd, SOL_SOCKET, SO_TYPE, __type, &optlen);
2199   if (rv != 0)
2200     {
2201       rv = -errno;
2202       goto out;
2203     }
2204
2205   optlen = sizeof (*__protocol);
2206   rv = libc_getsockopt (__fd, SOL_SOCKET, SO_PROTOCOL, __protocol, &optlen);
2207   if (rv != 0)
2208     {
2209       rv = -errno;
2210       goto out;
2211     }
2212
2213   fd = vcom_socket_open_socket (*__domain, *__type | flags, *__protocol);
2214   if (fd < 0)
2215     {
2216       rv = fd;
2217       goto out;
2218     }
2219
2220   pool_get (vsm->vsockets, vsock);
2221   vsocket_init (vsock);
2222
2223   sockidx = vsock - vsm->vsockets;
2224   hash_set (vsm->sockidx_by_fd, fd, sockidx);
2225
2226   vsocket_set (vsock, fd, __sid, SOCKET_TYPE_VPPCOM_BOUND);
2227   return fd;
2228
2229 out:
2230   return rv;
2231 }
2232
2233 /* If flag is 0, then accept4() is the same as accept().
2234  * SOCK_NONBLOCK and SOCK_CLOEXEC can be bitwise ORed in flags
2235  */
2236 static int
2237 vcom_socket_accept_flags (int __fd, __SOCKADDR_ARG __addr,
2238                           socklen_t * __restrict __addr_len, int flags)
2239 {
2240   int rv = -1;
2241   vcom_socket_main_t *vsm = &vcom_socket_main;
2242   uword *p;
2243   vcom_socket_t *vsock;
2244
2245   int fd;
2246   int sid;
2247   int domain;
2248   int type;
2249   int protocol;
2250
2251   uint8_t addr8[sizeof (struct in6_addr)];
2252   vppcom_endpt_t ep;
2253
2254   ep.ip = addr8;
2255
2256   /* validate flags */
2257
2258   /*
2259    * for documentation
2260    *  switch (flags)
2261    *   {
2262    *   case 0:
2263    *   case SOCK_NONBLOCK:
2264    *   case SOCK_CLOEXEC:
2265    *   case SOCK_NONBLOCK | SOCK_CLOEXEC:
2266    *     break;
2267    *
2268    *   default:
2269    *     return -1;
2270    *   }
2271    */
2272   /* flags can be 0 or can be bitwise OR
2273    * of any of SOCK_NONBLOCK and SOCK_CLOEXEC */
2274
2275   if (!(!flags || (flags & (SOCK_NONBLOCK | SOCK_CLOEXEC))))
2276     {
2277       /* TBD: return proper error code */
2278       return -1;
2279     }
2280
2281   /* TBD: return proper error code */
2282
2283   if (!vcom_socket_is_connection_mode_socket (__fd))
2284     {
2285       return -EOPNOTSUPP;
2286     }
2287
2288   p = hash_get (vsm->sockidx_by_fd, __fd);
2289   if (p)
2290     {
2291       vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2292
2293
2294       rv = vcom_fcntl (vsock->fd, F_GETFL, 0);
2295       if (rv < 0)
2296         {
2297           return rv;
2298         }
2299
2300       /* is blocking */
2301       if (!(rv & O_NONBLOCK))
2302         {
2303           /* socket is not marked as nonblocking
2304            * and no pending connections are present
2305            * on the queue, accept () blocks the caller
2306            * until a connection is present.
2307            */
2308           rv = vppcom_session_accept (vsock->sid, &ep,
2309                                       -1.0 /* wait forever */ );
2310         }
2311       else
2312         {
2313           /* The file descriptor refers to a socket and has been
2314            * marked nonblocking(O_NONBLOCK) and the accept would
2315            * block.
2316            * */
2317           /* is non blocking */
2318           rv = vppcom_session_accept (vsock->sid, &ep, 0);
2319           /* If the socket is marked nonblocking and
2320            * no pending connections are present on the
2321            * queue, accept fails with the error
2322            * EAGAIN or EWOULDBLOCK
2323            */
2324           if (rv == VPPCOM_ETIMEDOUT)
2325             {
2326               rv = VPPCOM_EAGAIN;
2327             }
2328         }
2329       if (rv < 0)
2330         {
2331           return rv;
2332         }
2333
2334       sid = rv;
2335
2336       /* create a new connected socket resource and set flags
2337        * on the new file descriptor.
2338        * update vsockets and sockidx_by_fd table
2339        * */
2340       fd = vcom_socket_connected_socket (__fd, sid,
2341                                          &domain, &type, &protocol, flags);
2342       if (fd < 0)
2343         {
2344           return fd;
2345         }
2346
2347       rv = fd;
2348
2349       /* TBD populate __addr and __addr_len */
2350       /* TBD: The returned address is truncated if the buffer
2351        * provided is too small, in this case, __addr_len will
2352        * return a value greater than was supplied to the call.*/
2353       if (__addr)
2354         {
2355           if (ep.is_cut_thru)
2356             {
2357               /* TBD populate __addr and __addr_len */
2358               switch (domain)
2359                 {
2360                 case AF_INET:
2361                   ((struct sockaddr_in *) __addr)->sin_family = AF_INET;
2362                   ((struct sockaddr_in *) __addr)->sin_port = ep.port;
2363                   memcpy (&((struct sockaddr_in *) __addr)->sin_addr,
2364                           addr8, sizeof (struct in_addr));
2365                   /* TBD: populate __addr_len */
2366                   if (__addr_len)
2367                     {
2368                       *__addr_len = sizeof (struct sockaddr_in);
2369                     }
2370                   break;
2371
2372                 case AF_INET6:
2373                   ((struct sockaddr_in6 *) __addr)->sin6_family = AF_INET6;
2374                   ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
2375                   memcpy (((struct sockaddr_in6 *) __addr)->sin6_addr.
2376                           __in6_u.__u6_addr8, addr8,
2377                           sizeof (struct in6_addr));
2378                   /* TBD: populate __addr_len */
2379                   if (__addr_len)
2380                     {
2381                       *__addr_len = sizeof (struct sockaddr_in6);
2382                     }
2383                   break;
2384
2385                 default:
2386                   return -EAFNOSUPPORT;
2387                 }
2388             }
2389           else
2390             {
2391               switch (ep.is_ip4)
2392                 {
2393                 case VPPCOM_IS_IP4:
2394                   ((struct sockaddr_in *) __addr)->sin_family = AF_INET;
2395                   ((struct sockaddr_in *) __addr)->sin_port = ep.port;
2396                   memcpy (&((struct sockaddr_in *) __addr)->sin_addr,
2397                           addr8, sizeof (struct in_addr));
2398                   /* TBD: populate __addr_len */
2399                   if (__addr_len)
2400                     {
2401                       *__addr_len = sizeof (struct sockaddr_in);
2402                     }
2403                   break;
2404
2405                 case VPPCOM_IS_IP6:
2406                   ((struct sockaddr_in6 *) __addr)->sin6_family = AF_INET6;
2407                   ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
2408                   memcpy (((struct sockaddr_in6 *) __addr)->sin6_addr.
2409                           __in6_u.__u6_addr8, addr8,
2410                           sizeof (struct in6_addr));
2411                   /* TBD: populate __addr_len */
2412                   if (__addr_len)
2413                     {
2414                       *__addr_len = sizeof (struct sockaddr_in6);
2415                     }
2416                   break;
2417
2418                 default:
2419                   return -EAFNOSUPPORT;
2420                 }
2421             }
2422         }
2423       else
2424         {
2425           /* when __addr is NULL, nothing is filled in,
2426            * in this case, __addr_len is not used,
2427            * and should also be null
2428            * */
2429           if (__addr_len)
2430             {
2431               /* TBD: return proper error code */
2432               return -1;
2433             }
2434         }
2435     }
2436
2437   return rv;
2438 }
2439
2440 int
2441 vcom_socket_accept (int __fd, __SOCKADDR_ARG __addr,
2442                     socklen_t * __restrict __addr_len)
2443 {
2444   /* set flags to 0 for accept() */
2445   return vcom_socket_accept_flags (__fd, __addr, __addr_len, 0);
2446 }
2447
2448 #ifdef __USE_GNU
2449 int
2450 vcom_socket_accept4 (int __fd, __SOCKADDR_ARG __addr,
2451                      socklen_t * __restrict __addr_len, int __flags)
2452 {
2453   /*  SOCK_NONBLOCK and SOCK_CLOEXEC can be bitwise ORed in flags */
2454   return vcom_socket_accept_flags (__fd, __addr, __addr_len, __flags);
2455 }
2456 #endif
2457
2458 /* TBD: move it to vppcom */
2459 static inline int
2460 vcom_session_shutdown (int __fd, int __how)
2461 {
2462   return 0;
2463 }
2464
2465 int
2466 vcom_socket_shutdown (int __fd, int __how)
2467 {
2468   int rv = -1;
2469   vcom_socket_main_t *vsm = &vcom_socket_main;
2470   uword *p;
2471   vcom_socket_t *vsock;
2472
2473   p = hash_get (vsm->sockidx_by_fd, __fd);
2474   if (p)
2475     {
2476       vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2477       switch (__how)
2478         {
2479         case SHUT_RD:
2480         case SHUT_WR:
2481         case SHUT_RDWR:
2482           rv = vcom_session_shutdown (vsock->sid, __how);
2483           return rv;
2484           break;
2485
2486         default:
2487           return -EINVAL;
2488           break;
2489         }
2490     }
2491
2492   return rv;
2493 }
2494
2495 int
2496 vcom_socket_epoll_create1 (int __flags)
2497 {
2498   int rv = -1;
2499   vcom_socket_main_t *vsm = &vcom_socket_main;
2500   vcom_epoll_t *vepoll;
2501
2502   i32 epfd;
2503   i32 vep_idx;
2504   i32 epollidx;
2505
2506   epfd = vcom_socket_open_epoll (__flags);
2507   if (epfd < 0)
2508     {
2509       rv = epfd;
2510       goto out;
2511     }
2512
2513   vep_idx = vppcom_epoll_create ();
2514   if (vep_idx < 0)
2515     {
2516       rv = vep_idx;
2517       goto out_close_epoll;
2518     }
2519
2520   pool_get (vsm->vepolls, vepoll);
2521   vepoll_init (vepoll);
2522
2523   epollidx = vepoll - vsm->vepolls;
2524   hash_set (vsm->epollidx_by_epfd, epfd, epollidx);
2525
2526   vepoll_set (vepoll, epfd, vep_idx, EPOLL_TYPE_VPPCOM_BOUND, __flags, 0, 0);
2527
2528   return epfd;
2529
2530 out_close_epoll:
2531   vcom_socket_close_epoll (epfd);
2532 out:
2533   return rv;
2534 }
2535
2536 /*
2537  * PRE: vppcom_epoll_ctl() is successful
2538  * free_vepitem_on_del : 0 - no_pool_put, 1 - pool_put
2539  */
2540 int
2541 vcom_socket_ctl_vepitem (int __epfd, int __op, int __fd,
2542                          struct epoll_event *__event,
2543                          i32 vep_idx, vcom_epoll_t * vepoll,
2544                          i32 vfd_id, void *vfd, vcom_fd_type_t type,
2545                          int free_vepitem_on_del)
2546 {
2547   int rv = -1;
2548   vcom_socket_main_t *vsm = &vcom_socket_main;
2549   vcom_epitem_t *vepitem;
2550
2551   vcom_epitem_key_t epfdfd = {.epfd = __epfd,.fd = __fd };
2552   uword *p;
2553   i32 vepitemidx;
2554
2555   i32 *vepitemidxs = 0;
2556
2557   struct epoll_event revent = {.events = 0,.data.fd = INVALID_FD };
2558
2559   i32 vec_idx;
2560
2561   /* perform control operations on the epoll instance */
2562   switch (__op)
2563     {
2564     case EPOLL_CTL_ADD:
2565       /*
2566        * supplied file descriptor is already
2567        * registered with this epoll instance
2568        * */
2569       /* vepitem exists */
2570       p = hash_get (vsm->epitemidx_by_epfdfd, epfdfd.key);
2571       if (p)
2572         {
2573           rv = -EEXIST;
2574           goto out;
2575         }
2576
2577       /* add a new vepitem */
2578       pool_get (vsm->vepitems, vepitem);
2579       vepitem_init (vepitem);
2580
2581       vepitemidx = vepitem - vsm->vepitems;
2582       hash_set (vsm->epitemidx_by_epfdfd, epfdfd.key, vepitemidx);
2583       vepitem_set (vepitem, __epfd, __fd, __fd, __fd, type, *__event, revent);
2584
2585       /* update epitemidxs */
2586       /* by_epfd */
2587       p = hash_get (vsm->epitemidxs_by_epfd, __epfd);
2588       if (!p)                   /*  not exist */
2589         {
2590           vepitemidxs = 0;
2591           vec_add1 (vepitemidxs, vepitemidx);
2592           hash_set (vsm->epitemidxs_by_epfd, __epfd, vepitemidxs);
2593         }
2594       else                      /*  exists */
2595         {
2596           vepitemidxs = *(i32 **) p;
2597           vec_add1 (vepitemidxs, vepitemidx);
2598           hash_set3 (vsm->epitemidxs_by_epfd, __epfd, vepitemidxs, 0);
2599         }
2600       /* update epitemidxs */
2601       /* by_fd */
2602       p = hash_get (vsm->epitemidxs_by_fd, __fd);
2603       if (!p)                   /*  not exist */
2604         {
2605           vepitemidxs = 0;
2606           vec_add1 (vepitemidxs, vepitemidx);
2607           hash_set (vsm->epitemidxs_by_fd, __fd, vepitemidxs);
2608         }
2609       else                      /*  exists */
2610         {
2611           vepitemidxs = *(i32 **) p;
2612           vec_add1 (vepitemidxs, vepitemidx);
2613           hash_set3 (vsm->epitemidxs_by_fd, __fd, vepitemidxs, 0);
2614         }
2615
2616       /* increment vepoll fd count by 1 */
2617       vepoll->count += 1;
2618
2619       rv = 0;
2620       goto out;
2621       break;
2622
2623     case EPOLL_CTL_MOD:
2624       /*
2625        * supplied file descriptor is not
2626        * registered with this epoll instance
2627        * */
2628       /* vepitem not exist */
2629       p = hash_get (vsm->epitemidx_by_epfdfd, epfdfd.key);
2630       if (!p)
2631         {
2632           rv = -ENOENT;
2633           goto out;
2634         }
2635       vepitem = pool_elt_at_index (vsm->vepitems, p[0]);
2636       if (vepitem)
2637         {
2638           vepitem->event = *__event;
2639           vepitem->revent = revent;
2640         }
2641
2642       rv = 0;
2643       goto out;
2644       break;
2645
2646     case EPOLL_CTL_DEL:
2647       /*
2648        * supplied file descriptor is not
2649        * registered with this epoll instance
2650        * */
2651       /* vepitem not exist */
2652       p = hash_get (vsm->epitemidx_by_epfdfd, epfdfd.key);
2653       if (!p)
2654         {
2655           rv = -ENOENT;
2656           goto out;
2657         }
2658       vepitemidx = *(i32 *) p;
2659       hash_unset (vsm->epitemidx_by_epfdfd, epfdfd.key);
2660
2661       /* update epitemidxs */
2662       /* by_epfd */
2663       p = hash_get (vsm->epitemidxs_by_epfd, __epfd);
2664       if (!p)                   /*  not exist */
2665         {
2666           rv = -ENOENT;
2667           goto out;
2668         }
2669       else                      /*  exists */
2670         {
2671           vepitemidxs = *(i32 **) p;
2672           vec_idx = vec_search (vepitemidxs, vepitemidx);
2673           if (vec_idx != ~0)
2674             {
2675               vec_del1 (vepitemidxs, vec_idx);
2676               if (!vec_len (vepitemidxs))
2677                 {
2678                   vec_free (vepitemidxs);
2679                   hash_unset (vsm->epitemidxs_by_epfd, __epfd);
2680                 }
2681             }
2682         }
2683
2684       /* update epitemidxs */
2685       /* by_fd */
2686       p = hash_get (vsm->epitemidxs_by_fd, __fd);
2687       if (!p)                   /*  not exist */
2688         {
2689           rv = -ENOENT;
2690           goto out;
2691         }
2692       else                      /*  exists */
2693         {
2694           vepitemidxs = *(i32 **) p;
2695           vec_idx = vec_search (vepitemidxs, vepitemidx);
2696           if (vec_idx != ~0)
2697             {
2698               vec_del1 (vepitemidxs, vec_idx);
2699               if (!vec_len (vepitemidxs))
2700                 {
2701                   vec_free (vepitemidxs);
2702                   hash_unset (vsm->epitemidxs_by_fd, __fd);
2703                 }
2704             }
2705         }
2706
2707       /* pool put vepitem */
2708       vepitem = pool_elt_at_index (vsm->vepitems, vepitemidx);
2709       if (free_vepitem_on_del)
2710         {
2711           if (!vepitem)
2712             {
2713               rv = -ENOENT;
2714               goto out;
2715             }
2716           vepitem_init (vepitem);
2717           pool_put (vsm->vepitems, vepitem);
2718         }
2719       else
2720         {
2721           if (!vepitem)
2722             {
2723               vepitem_init (vepitem);
2724             }
2725         }
2726
2727       /* decrement vepoll fd count by 1 */
2728       vepoll->count -= 1;
2729
2730       rv = 0;
2731       goto out;
2732       break;
2733
2734     default:
2735       rv = -EINVAL;
2736       goto out;
2737       break;
2738     }
2739
2740 out:
2741   return rv;
2742 }
2743
2744 /*
2745  * PRE: 00. null pointer check on __event
2746  *      01. all other parameters are validated
2747  */
2748
2749 static int
2750 vcom_socket_epoll_ctl_internal (int __epfd, int __op, int __fd,
2751                                 struct epoll_event *__event,
2752                                 int free_vepitem_on_del)
2753 {
2754   int rv = -1;
2755
2756   /* vcom_socket_main_t *vsm = &vcom_socket_main; */
2757   vcom_epoll_t *vepoll;
2758
2759   /*__fd could could be vcom socket or vcom epoll or kernel fd */
2760   void *vfd;
2761   vcom_epoll_t *vfd_vepoll;
2762   vcom_socket_t *vfd_vsock;
2763
2764   i32 vep_idx;
2765   i32 vfd_id;
2766
2767   vcom_fd_type_t type = FD_TYPE_INVALID;
2768
2769   /* validate __event */
2770
2771   /* get vep_idx and vepoll */
2772   vep_idx = vcom_socket_get_vep_idx_and_vepoll (__epfd, &vepoll);
2773   if (vep_idx == INVALID_VEP_IDX)
2774     {
2775       return -EBADF;
2776     }
2777
2778   /* get vcom fd type, vfd_id and vfd */
2779   vfd_id = vcom_socket_get_sid_and_vsock (__fd, &vfd_vsock);
2780   if (vfd_id != INVALID_SESSION_ID)
2781     {
2782       type = FD_TYPE_VCOM_SOCKET;
2783       vfd = vfd_vsock;
2784     }
2785   else if ((vfd_id = vcom_socket_get_vep_idx_and_vepoll (__fd, &vfd_vepoll))
2786            != INVALID_VEP_IDX)
2787     {
2788       type = FD_TYPE_EPOLL;
2789       vfd = vfd_vepoll;
2790     }
2791   else
2792     {
2793       /* FD_TYPE_KERNEL not supported by epoll instance */
2794       type = FD_TYPE_INVALID;
2795       return -EBADF;
2796     }
2797
2798
2799   /* vepoll and vsock are now valid */
2800   rv = vppcom_epoll_ctl (vep_idx, __op, vfd_id, __event);
2801   if (rv < 0)
2802     {
2803       return rv;
2804     }
2805
2806   rv = vcom_socket_ctl_vepitem (__epfd, __op, __fd,
2807                                 __event,
2808                                 vep_idx, vepoll,
2809                                 vfd_id, vfd, type, free_vepitem_on_del);
2810   return rv;
2811 }
2812
2813 int
2814 vcom_socket_epoll_ctl (int __epfd, int __op, int __fd,
2815                        struct epoll_event *__event)
2816 {
2817   int rv = -1;
2818
2819   rv = vcom_socket_epoll_ctl_internal (__epfd, __op, __fd, __event, 1);
2820   return rv;
2821 }
2822
2823 static int
2824 vcom_socket_epoll_ctl1 (int __epfd, int __op, int __fd,
2825                         struct epoll_event *__event)
2826 {
2827   int rv = -1;
2828
2829   rv = vcom_socket_epoll_ctl_internal (__epfd, __op, __fd, __event, 0);
2830   return rv;
2831 }
2832
2833 int
2834 vcom_socket_epoll_pwait (int __epfd, struct epoll_event *__events,
2835                          int __maxevents, int __timeout,
2836                          const __sigset_t * __ss)
2837 {
2838   int rv = -EBADF;
2839
2840   /* in seconds eg. 3.123456789 seconds */
2841   double time_to_wait = (double) 0;
2842
2843   i32 vep_idx;
2844
2845   /* validate __event */
2846   if (!__events)
2847     {
2848       rv = -EFAULT;
2849       goto out;
2850     }
2851
2852   /* validate __timeout */
2853   if (__timeout > 0)
2854     {
2855       time_to_wait = (double) __timeout / (double) 1000;
2856     }
2857   else if (__timeout == 0)
2858     {
2859       time_to_wait = (double) 0;
2860     }
2861   else if (__timeout == -1)
2862     {
2863       time_to_wait = ~0;
2864     }
2865   else
2866     {
2867       rv = -EBADF;
2868       goto out;
2869     }
2870
2871   /* get vep_idx */
2872   vep_idx = vcom_socket_get_vep_idx (__epfd);
2873   if (vep_idx != INVALID_VEP_IDX)
2874     {
2875       rv = vppcom_epoll_wait (vep_idx, __events, __maxevents, time_to_wait);
2876     }
2877 out:
2878   return rv;
2879 }
2880
2881 static inline void
2882 vcom_pollfds_2_selectfds (
2883                            /* src */
2884                            struct pollfd *__fds, nfds_t __nfds,
2885                            /* dest */
2886                            int vcom_nfds,
2887                            fd_set * __restrict vcom_readfds,
2888                            fd_set * __restrict vcom_writefds,
2889                            fd_set * __restrict vcom_exceptfds)
2890 {
2891   nfds_t fds_idx = 0;
2892
2893   for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
2894     {
2895       /* ignore negative fds */
2896       if (__fds[fds_idx].fd < 0)
2897         {
2898           continue;
2899         }
2900
2901       /* for POLLRDHUP, POLLERR, POLLHUP and  POLLNVAL */
2902       FD_SET (__fds[fds_idx].fd, vcom_exceptfds);
2903
2904       /* requested events */
2905       if (__fds[fds_idx].events)
2906         {
2907           if (__fds[fds_idx].events & POLLIN)
2908             {
2909               FD_SET (__fds[fds_idx].fd, vcom_readfds);
2910             }
2911           if (__fds[fds_idx].events & POLLPRI)
2912             {
2913               FD_SET (__fds[fds_idx].fd, vcom_readfds);
2914             }
2915           if (__fds[fds_idx].events & POLLOUT)
2916             {
2917               FD_SET (__fds[fds_idx].fd, vcom_writefds);
2918             }
2919 #if defined __USE_XOPEN || defined __USE_XOPEN2K8
2920           if (__fds[fds_idx].events & POLLRDNORM)
2921             {
2922               FD_SET (__fds[fds_idx].fd, vcom_readfds);
2923             }
2924           if (__fds[fds_idx].events & POLLRDBAND)
2925             {
2926               FD_SET (__fds[fds_idx].fd, vcom_readfds);
2927             }
2928           if (__fds[fds_idx].events & POLLWRNORM)
2929             {
2930               FD_SET (__fds[fds_idx].fd, vcom_writefds);
2931             }
2932           if (__fds[fds_idx].events & POLLWRBAND)
2933             {
2934               FD_SET (__fds[fds_idx].fd, vcom_writefds);
2935             }
2936 #endif
2937         }
2938     }                           /* for (fds_idx = 0; fds_idx < __nfds; fds_idx++) */
2939 }
2940
2941 static inline void
2942 vcom_selectfds_2_pollfds (
2943                            /* dest */
2944                            struct pollfd *__fds, nfds_t __nfds, int *nfd,
2945                            /* src */
2946                            int vcom_nfds,
2947                            fd_set * __restrict vcom_readfds,
2948                            fd_set * __restrict vcom_writefds,
2949                            fd_set * __restrict vcom_exceptfds)
2950 {
2951   nfds_t fds_idx = 0;
2952
2953
2954   for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
2955     {
2956       /* ignore negative fds */
2957       if (__fds[fds_idx].fd < 0)
2958         {
2959           __fds[fds_idx].revents = 0;
2960         }
2961
2962       /* for POLLRDHUP, POLLERR, POLLHUP and  POLLNVAL */
2963       if (FD_ISSET (__fds[fds_idx].fd, vcom_exceptfds))
2964         {
2965           /*
2966            * TBD: for now any select exception
2967            *      is flagged as POLLERR
2968            * */
2969           __fds[fds_idx].revents |= POLLERR;
2970         }
2971
2972       /* requested events */
2973       if (__fds[fds_idx].events & POLLIN)
2974         {
2975           if (FD_ISSET (__fds[fds_idx].fd, vcom_readfds))
2976             {
2977               __fds[fds_idx].revents |= POLLIN;
2978             }
2979         }
2980       if (__fds[fds_idx].events & POLLPRI)
2981         {
2982           if (FD_ISSET (__fds[fds_idx].fd, vcom_readfds))
2983             {
2984               __fds[fds_idx].revents |= POLLIN;
2985             }
2986         }
2987       if (__fds[fds_idx].events & POLLOUT)
2988         {
2989           if (FD_ISSET (__fds[fds_idx].fd, vcom_writefds))
2990             {
2991               __fds[fds_idx].revents |= POLLOUT;
2992             }
2993         }
2994 #if defined __USE_XOPEN || defined __USE_XOPEN2K8
2995       if (__fds[fds_idx].events & POLLRDNORM)
2996         {
2997           if (FD_ISSET (__fds[fds_idx].fd, vcom_readfds))
2998             {
2999               __fds[fds_idx].revents |= POLLRDNORM;
3000             }
3001         }
3002       if (__fds[fds_idx].events & POLLRDBAND)
3003         {
3004           if (FD_ISSET (__fds[fds_idx].fd, vcom_readfds))
3005             {
3006               __fds[fds_idx].revents |= POLLRDBAND;
3007             }
3008         }
3009       if (__fds[fds_idx].events & POLLWRNORM)
3010         {
3011           if (FD_ISSET (__fds[fds_idx].fd, vcom_writefds))
3012             {
3013               __fds[fds_idx].revents |= POLLWRNORM;
3014             }
3015         }
3016       if (__fds[fds_idx].events & POLLWRBAND)
3017         {
3018           if (FD_ISSET (__fds[fds_idx].fd, vcom_writefds))
3019             {
3020               __fds[fds_idx].revents |= POLLWRBAND;
3021             }
3022         }
3023 #endif
3024     }                           /* for (fds_idx = 0; fds_idx < __nfds; fds_idx++) */
3025
3026   /*
3027    * nfd:
3028    * the number of structures which have nonzero revents  fields
3029    * (in  other  words,  those  descriptors  with events or
3030    * errors reported)
3031    * */
3032   *nfd = 0;
3033   for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
3034     {
3035       /* ignore negative fds */
3036       if (__fds[fds_idx].fd < 0)
3037         {
3038           continue;
3039         }
3040
3041       if (__fds[fds_idx].revents)
3042         {
3043           (*nfd)++;
3044         }
3045     }
3046 }
3047
3048 /*
3049  * PRE: parameters are validated,
3050  *      vcom_socket_poll is always called with __timeout set to zero
3051  *      hence returns immediately
3052  *
3053  * ACTION: handle non negative validated vcom fds and ignore rest
3054  */
3055
3056 /*
3057  * implements vcom_socket_poll () interface
3058  *
3059  * internally uses vcom_socket_select ()
3060  * to realize the behavior
3061  * */
3062 int
3063 vcom_socket_poll_select_impl (struct pollfd *__fds, nfds_t __nfds,
3064                               int __timeout)
3065 {
3066   int rv;
3067   pid_t pid = getpid ();
3068
3069   nfds_t fds_idx = 0;
3070   int nfd = 0;
3071
3072   /* vcom */
3073   int vcom_nfds = 0;
3074   fd_set vcom_readfds;
3075   fd_set vcom_writefds;
3076   fd_set vcom_exceptfds;
3077   int vcom_nfd = -1;
3078   /* invalid max_vcom_fd is -1 */
3079   int max_vcom_fd = -1;
3080
3081   /* __timeout is zero to get ready events and return immediately */
3082   struct timeval tv = {.tv_sec = 0,.tv_usec = 0 };
3083
3084   /* validate __nfds from select perspective */
3085   if (__nfds > FD_SETSIZE)
3086     {
3087       rv = -EINVAL;
3088       goto poll_done;
3089     }
3090
3091   /* zero vcom fd sets */
3092   /*
3093    * V vcom fd set
3094    */
3095 #define _(V)      \
3096     FD_ZERO ((V))
3097
3098   _(&vcom_readfds);
3099   _(&vcom_writefds);
3100   _(&vcom_exceptfds);
3101 #undef _
3102
3103   vcom_nfds = 0;
3104   vcom_nfd = -1;
3105
3106
3107   for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
3108     {
3109       /* ignore negative fds */
3110       if (__fds[fds_idx].fd < 0)
3111         {
3112           continue;
3113         }
3114
3115       /* non negative validated vcom fds */
3116       if (__fds[fds_idx].fd > FD_SETSIZE)
3117         {
3118           rv = -EINVAL;
3119           goto poll_done;
3120         }
3121
3122       /* max_vcom_fd and vcom_nfd */
3123       if (__fds[fds_idx].fd > max_vcom_fd)
3124         {
3125           /* requested events */
3126           if (__fds[fds_idx].events)
3127             {
3128               max_vcom_fd = __fds[fds_idx].fd;
3129             }
3130         }
3131       ++vcom_nfd;
3132     }
3133
3134   vcom_nfds = max_vcom_fd != -1 ? max_vcom_fd + 1 : 0;
3135
3136   if (!vcom_nfds)
3137     {
3138       rv = vcom_nfds;
3139       goto poll_done;
3140     }
3141
3142   vcom_pollfds_2_selectfds (
3143                              /* src */
3144                              __fds, __nfds,
3145                              /* dest */
3146                              vcom_nfds,
3147                              &vcom_readfds, &vcom_writefds, &vcom_exceptfds);
3148
3149   /* select on vcom fds */
3150   vcom_nfd = vcom_socket_select (vcom_nfds,
3151                                  &vcom_readfds,
3152                                  &vcom_writefds, &vcom_exceptfds, &tv);
3153   if (VCOM_DEBUG > 2)
3154     fprintf (stderr,
3155              "[%d] vcom_socket_select: "
3156              "'%04d'='%04d'\n", pid, vcom_nfd, vcom_nfds);
3157
3158   if (vcom_nfd < 0)
3159     {
3160       rv = vcom_nfd;
3161       goto poll_done;
3162     }
3163
3164   vcom_selectfds_2_pollfds (
3165                              /* dest */
3166                              __fds, __nfds, &nfd,
3167                              /* src */
3168                              vcom_nfds,
3169                              &vcom_readfds, &vcom_writefds, &vcom_exceptfds);
3170
3171   rv = nfd;
3172
3173 poll_done:
3174   return rv;
3175 }
3176
3177 /*
3178  * TBD: remove this static function once vppcom
3179  *      has an implementation in place
3180  *
3181  * ACTION:
3182  */
3183 static int
3184 vppcom_poll (struct pollfd *__fds, nfds_t __nfds, double time_to_wait)
3185 {
3186   return -EOPNOTSUPP;
3187 }
3188
3189 int
3190 vcom_socket_poll_vppcom_impl (struct pollfd *__fds, nfds_t __nfds,
3191                               int __timeout)
3192 {
3193   nfds_t fds_idx = 0;
3194
3195   /* in seconds eg. 3.123456789 seconds */
3196   double time_to_wait = (double) 0;
3197
3198   i32 sid;
3199   i32 vep_idx;
3200
3201   /* replace vcom fd with session idx */
3202   for (fds_idx = 0; fds_idx < __nfds; fds_idx++)
3203     {
3204       /* ignore negative fds */
3205       if (__fds[fds_idx].fd < 0)
3206         {
3207           continue;
3208         }
3209
3210       /* non negative validated vcom fds */
3211       sid = vcom_socket_get_sid (__fds[fds_idx].fd);
3212       if (sid != INVALID_SESSION_ID)
3213         {
3214           __fds[fds_idx].fd = sid;
3215         }
3216       else
3217         {
3218           /* get vep_idx */
3219           vep_idx = vcom_socket_get_vep_idx (__fds[fds_idx].fd);
3220           if (vep_idx != INVALID_VEP_IDX)
3221             {
3222               __fds[fds_idx].fd = vep_idx;
3223             }
3224           else
3225             {
3226               return -EBADF;
3227             }
3228         }
3229     }
3230
3231   /* validate __timeout */
3232   if (__timeout > 0)
3233     {
3234       time_to_wait = (double) __timeout / (double) 1000;
3235     }
3236   else if (__timeout == 0)
3237     {
3238       time_to_wait = (double) 0;
3239     }
3240   else
3241     {
3242       time_to_wait = ~0;
3243     }
3244
3245   return vppcom_poll (__fds, __nfds, time_to_wait);
3246 }
3247
3248 int
3249 vcom_socket_poll (struct pollfd *__fds, nfds_t __nfds, int __timeout)
3250 {
3251   /* select an implementation */
3252
3253   /* return vcom_socket_poll_vppcom_impl (__fds, __nfds, __timeout); */
3254   return vcom_socket_poll_select_impl (__fds, __nfds, __timeout);
3255 }
3256
3257 #ifdef __USE_GNU
3258 int
3259 vcom_socket_ppoll (struct pollfd *__fds, nfds_t __nfds,
3260                    const struct timespec *__timeout, const __sigset_t * __ss)
3261 {
3262   return -EOPNOTSUPP;
3263 }
3264 #endif
3265
3266 int
3267 vcom_socket_main_init (void)
3268 {
3269   vcom_socket_main_t *vsm = &vcom_socket_main;
3270
3271   if (VCOM_DEBUG > 0)
3272     printf ("vcom_socket_main_init\n");
3273
3274   if (!vsm->init)
3275     {
3276       /* TBD: define FD_MAXSIZE and use it here */
3277       pool_alloc (vsm->vsockets, FD_SETSIZE);
3278       vsm->sockidx_by_fd = hash_create (0, sizeof (i32));
3279
3280       pool_alloc (vsm->vepolls, FD_SETSIZE);
3281       vsm->epollidx_by_epfd = hash_create (0, sizeof (i32));
3282
3283       pool_alloc (vsm->vepitems, FD_SETSIZE);
3284       vsm->epitemidx_by_epfdfd = hash_create (0, sizeof (i32));
3285
3286       vsm->epitemidxs_by_epfd = hash_create (0, sizeof (i32 *));
3287       vsm->epitemidxs_by_fd = hash_create (0, sizeof (i32 *));
3288
3289       vsm->init = 1;
3290     }
3291
3292   return 0;
3293 }
3294
3295
3296 void
3297 vcom_socket_main_show (void)
3298 {
3299   vcom_socket_main_t *vsm = &vcom_socket_main;
3300   vcom_socket_t *vsock;
3301
3302   vcom_epoll_t *vepoll;
3303
3304   vcom_epitem_t *vepitem;
3305
3306   i32 epfd;
3307   i32 fd;
3308   i32 *vepitemidxs, *vepitemidxs_var;
3309
3310   if (vsm->init)
3311     {
3312       /* from active list of vsockets show vsock */
3313
3314       /* *INDENT-OFF* */
3315       pool_foreach (vsock, vsm->vsockets,
3316         ({
3317           printf(
3318                  "fd='%04d', sid='%08x',type='%-30s'\n",
3319                  vsock->fd, vsock->sid,
3320                  vcom_socket_type_str (vsock->type));
3321         }));
3322       /* *INDENT-ON* */
3323
3324       /* from active list of vepolls, show vepoll */
3325
3326       /* *INDENT-OFF* */
3327       pool_foreach (vepoll, vsm->vepolls,
3328         ({
3329           printf(
3330                  "epfd='%04d', vep_idx='%08x', "
3331                  "type='%-30s', "
3332                  "flags='%d', count='%d', close='%d'\n",
3333                  vepoll->epfd, vepoll->vep_idx,
3334                  vcom_socket_epoll_type_str (vepoll->type),
3335                  vepoll->flags, vepoll->count, vepoll->close);
3336         }));
3337       /* *INDENT-ON* */
3338
3339       /* from active list of vepitems, show vepitem */
3340
3341       /* *INDENT-OFF* */
3342       pool_foreach (vepitem, vsm->vepitems,
3343         ({
3344           printf(
3345                  "epfd='%04d', fd='%04d', "
3346                  "next_fd='%04d', prev_fd='%04d', "
3347                  "type='%-30s', "
3348                  "events='%04x', revents='%04x'\n",
3349                  vepitem->epfd, vepitem->fd,
3350                  vepitem->next_fd, vepitem->prev_fd,
3351                  vcom_socket_vcom_fd_type_str (vepitem->type),
3352                  vepitem->event.events, vepitem->revent.events);
3353         }));
3354
3355       /* *INDENT-ON* */
3356
3357       /* show epitemidxs for epfd */
3358       /* *INDENT-OFF* */
3359       hash_foreach (epfd, vepitemidxs,
3360                     vsm->epitemidxs_by_epfd,
3361       ({
3362         printf("\n[ '%04d': ", epfd);
3363         vec_foreach (vepitemidxs_var,vepitemidxs)
3364         {
3365           printf("'%04d' ", (int)vepitemidxs_var[0]);
3366         }
3367         printf("]\n");
3368       }));
3369       /* *INDENT-ON* */
3370
3371       /* show epitemidxs for fd */
3372       /* *INDENT-OFF* */
3373       hash_foreach (fd, vepitemidxs,
3374                     vsm->epitemidxs_by_fd,
3375       ({
3376         printf("\n{ '%04d': ", fd);
3377         vec_foreach (vepitemidxs_var,vepitemidxs)
3378         {
3379           printf("'%04d' ", (int)vepitemidxs_var[0]);
3380         }
3381         printf("}\n");
3382       }));
3383       /* *INDENT-ON* */
3384
3385     }
3386 }
3387
3388 void
3389 vcom_socket_main_destroy (void)
3390 {
3391   vcom_socket_main_t *vsm = &vcom_socket_main;
3392   vcom_socket_t *vsock;
3393
3394   vcom_epoll_t *vepoll;
3395
3396   vcom_epitem_t *vepitem;
3397
3398   i32 epfd;
3399   i32 fd;
3400   i32 *vepitemidxs;
3401
3402
3403   if (VCOM_DEBUG > 0)
3404     printf ("vcom_socket_main_destroy\n");
3405
3406   if (vsm->init)
3407     {
3408
3409       /*
3410        * from active list of vepitems,
3411        * remove all "vepitem" elements from the pool in a safe way
3412        * */
3413
3414       /* *INDENT-OFF* */
3415       pool_flush (vepitem, vsm->vepitems,
3416         ({
3417           if ((vepitem->type == FD_TYPE_EPOLL) ||
3418               (vepitem->type == FD_TYPE_VCOM_SOCKET))
3419           {
3420              vcom_socket_epoll_ctl1 (vepitem->epfd, EPOLL_CTL_DEL,
3421                                      vepitem->fd, NULL);
3422              vepitem_init (vepitem);
3423           }
3424         }));
3425       /* *INDENT-ON* */
3426
3427       pool_free (vsm->vepitems);
3428       hash_free (vsm->epitemidx_by_epfdfd);
3429
3430       /* free vepitemidxs for each epfd */
3431       /* *INDENT-OFF* */
3432       hash_foreach (epfd, vepitemidxs,
3433                     vsm->epitemidxs_by_epfd,
3434       ({
3435         vec_free (vepitemidxs);
3436       }));
3437       /* *INDENT-ON* */
3438       hash_free (vsm->epitemidxs_by_epfd);
3439
3440       /* free vepitemidxs for each fd */
3441       /* *INDENT-OFF* */
3442       hash_foreach (fd, vepitemidxs,
3443                     vsm->epitemidxs_by_fd,
3444       ({
3445         vec_free (vepitemidxs);
3446       }));
3447       /* *INDENT-ON* */
3448       hash_free (vsm->epitemidxs_by_fd);
3449
3450
3451       /*
3452        * from active list of vsockets,
3453        * close socket and vppcom session
3454        * */
3455
3456       /* *INDENT-OFF* */
3457       pool_foreach (vsock, vsm->vsockets,
3458         ({
3459           if (vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
3460             {
3461               vppcom_session_close (vsock->sid);
3462               vcom_socket_close_socket (vsock->fd);
3463               vsocket_init (vsock);
3464             }
3465         }));
3466       /* *INDENT-ON* */
3467
3468       /*
3469        * return vsocket element to the pool
3470        * */
3471
3472       /* *INDENT-OFF* */
3473       pool_flush (vsock, vsm->vsockets,
3474         ({
3475           // vsocket_init(vsock);
3476           ;
3477         }));
3478       /* *INDENT-ON* */
3479
3480       pool_free (vsm->vsockets);
3481       hash_free (vsm->sockidx_by_fd);
3482
3483       /*
3484        * from active list of vepolls,
3485        * close epoll and vppcom_epoll
3486        * */
3487
3488       /* *INDENT-OFF* */
3489       pool_foreach (vepoll, vsm->vepolls,
3490         ({
3491           if (vepoll->type == EPOLL_TYPE_VPPCOM_BOUND)
3492             {
3493               vppcom_session_close (vepoll->vep_idx);
3494               vcom_socket_close_epoll (vepoll->epfd); /* TBD: */
3495               vepoll_init (vepoll);
3496             }
3497         }));
3498       /* *INDENT-ON* */
3499
3500       /*
3501        * return vepoll element to the pool
3502        * */
3503
3504       /* *INDENT-OFF* */
3505       pool_flush (vepoll, vsm->vepolls,
3506         ({
3507           // vepoll_init(vepoll);
3508           ;
3509         }));
3510       /* *INDENT-ON* */
3511
3512       pool_free (vsm->vepolls);
3513       hash_free (vsm->epollidx_by_epfd);
3514
3515       vsm->init = 0;
3516     }
3517 }
3518
3519
3520 /*
3521  * fd.io coding-style-patch-verification: ON
3522  *
3523  * Local Variables:
3524  * eval: (c-set-style "gnu")
3525  * End:
3526  */