c8a9d623a9ba9cbbca3d0e07ffccd888908f36d6
[vpp.git] / extras / vcl-ldpreload / src / libvcl-ldpreload / 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 <libvcl-ldpreload/vcom_socket.h>
28 #include <libvcl-ldpreload/vcom_socket_wrapper.h>
29 #include <libvcl-ldpreload/vcom.h>
30
31 #include <uri/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 || __nbytes < 0)
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       while (rv == -EAGAIN || rv == -EWOULDBLOCK);
469       return rv;
470     }
471   /* The file descriptor refers to a socket and has been
472    * marked nonblocking(O_NONBLOCK) and the read would
473    * block.
474    * */
475   /* is non blocking */
476   rv = vppcom_session_read (vsock->sid, __buf, __nbytes);
477   return rv;
478 }
479
480 ssize_t
481 vcom_socket_readv (int __fd, const struct iovec * __iov, int __iovcnt)
482 {
483   int rv;
484   vcom_socket_main_t *vsm = &vcom_socket_main;
485   uword *p;
486   vcom_socket_t *vsock;
487   ssize_t total = 0, len = 0;
488
489   p = hash_get (vsm->sockidx_by_fd, __fd);
490   if (!p)
491     return -EBADF;
492
493   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
494   if (!vsock)
495     return -ENOTSOCK;
496
497   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
498     return -EINVAL;
499
500   if (__iov == 0 || __iovcnt == 0 || __iovcnt > IOV_MAX)
501     return -EINVAL;
502
503   /* Sanity check */
504   for (int i = 0; i < __iovcnt; ++i)
505     {
506       if (SSIZE_MAX - len < __iov[i].iov_len)
507         return -EINVAL;
508       len += __iov[i].iov_len;
509     }
510
511   rv = vcom_fcntl (__fd, F_GETFL, 0);
512   if (rv < 0)
513     {
514       return rv;
515     }
516
517   /* is blocking */
518   if (!(rv & O_NONBLOCK))
519     {
520       do
521         {
522           for (int i = 0; i < __iovcnt; ++i)
523             {
524               rv = vppcom_session_read (vsock->sid, __iov[i].iov_base,
525                                         __iov[i].iov_len);
526               if (rv < 0)
527                 break;
528               else
529                 {
530                   total += rv;
531                   if (rv < __iov[i].iov_len)
532                     /* Read less than buffer provided, no point to continue */
533                     break;
534                 }
535             }
536         }
537       while ((rv == -EAGAIN || rv == -EWOULDBLOCK) && total == 0);
538       return total;
539     }
540
541   /* is non blocking */
542   for (int i = 0; i < __iovcnt; ++i)
543     {
544       rv = vppcom_session_read (vsock->sid, __iov[i].iov_base,
545                                 __iov[i].iov_len);
546       if (rv < 0)
547         {
548           if (total > 0)
549             break;
550           else
551             {
552               errno = rv;
553               return rv;
554             }
555         }
556       else
557         {
558           total += rv;
559           if (rv < __iov[i].iov_len)
560             /* Read less than buffer provided, no point to continue */
561             break;
562         }
563     }
564   return total;
565 }
566
567 ssize_t
568 vcom_socket_write (int __fd, const void *__buf, size_t __n)
569 {
570   int rv = -1;
571   vcom_socket_main_t *vsm = &vcom_socket_main;
572   uword *p;
573   vcom_socket_t *vsock;
574
575   p = hash_get (vsm->sockidx_by_fd, __fd);
576   if (!p)
577     return -EBADF;
578
579   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
580   if (!vsock)
581     return -ENOTSOCK;
582
583   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
584     return -EINVAL;
585
586   if (!__buf || __n < 0)
587     {
588       return -EINVAL;
589     }
590
591   rv = vppcom_session_write (vsock->sid, (void *) __buf, __n);
592   return rv;
593 }
594
595 ssize_t
596 vcom_socket_writev (int __fd, const struct iovec * __iov, int __iovcnt)
597 {
598   int rv = -1;
599   ssize_t total = 0;
600   vcom_socket_main_t *vsm = &vcom_socket_main;
601   uword *p;
602   vcom_socket_t *vsock;
603
604   p = hash_get (vsm->sockidx_by_fd, __fd);
605   if (!p)
606     return -EBADF;
607
608   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
609   if (!vsock)
610     return -ENOTSOCK;
611
612   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
613     return -EINVAL;
614
615   if (__iov == 0 || __iovcnt == 0 || __iovcnt > IOV_MAX)
616     return -EINVAL;
617
618   for (int i = 0; i < __iovcnt; ++i)
619     {
620       rv = vppcom_session_write (vsock->sid, __iov[i].iov_base,
621                                  __iov[i].iov_len);
622       if (rv < 0)
623         {
624           if (total > 0)
625             break;
626           else
627             return rv;
628         }
629       else
630         total += rv;
631     }
632   return total;
633 }
634
635 /*
636  * RETURN:  0 - invalid cmd
637  *          1 - cmd not handled by vcom and vppcom
638  *          2 - cmd handled by vcom socket resource
639  *          3 - cmd handled by vppcom
640  * */
641 /* TBD: incomplete list of cmd */
642 static int
643 vcom_socket_check_fcntl_cmd (int __cmd)
644 {
645   switch (__cmd)
646     {
647       /*cmd not handled by vcom and vppcom */
648       /* Fallthrough */
649     case F_DUPFD:
650     case F_DUPFD_CLOEXEC:
651       return 1;
652
653       /* cmd handled by vcom socket resource */
654       /* Fallthrough */
655     case F_GETFD:
656     case F_SETFD:
657     case F_GETLK:
658     case F_SETLK:
659     case F_SETLKW:
660     case F_GETOWN:
661     case F_SETOWN:
662       return 2;
663
664       /* cmd handled by vcom and vppcom */
665     case F_SETFL:
666     case F_GETFL:
667       return 3;
668
669       /* cmd not handled by vcom and vppcom */
670     default:
671       return 1;
672     }
673   return 0;
674 }
675
676 static int
677 vppcom_session_fcntl_va (int __sid, int __cmd, va_list __ap)
678 {
679   int flags = va_arg (__ap, int);
680   int rv = -EOPNOTSUPP;
681   uint32_t size;
682
683   size = sizeof (flags);
684   if (__cmd == F_SETFL)
685     {
686       rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_FLAGS, &flags, &size);
687     }
688   else if (__cmd == F_GETFL)
689     {
690       rv = vppcom_session_attr (__sid, VPPCOM_ATTR_GET_FLAGS, &flags, &size);
691       if (rv == VPPCOM_OK)
692         rv = flags;
693     }
694
695   return rv;
696 }
697
698 int
699 vcom_socket_fcntl_va (int __fd, int __cmd, va_list __ap)
700 {
701   int rv = -EBADF;
702   vcom_socket_main_t *vsm = &vcom_socket_main;
703   uword *p;
704   vcom_socket_t *vsock;
705
706   p = hash_get (vsm->sockidx_by_fd, __fd);
707   if (!p)
708     return -EBADF;
709
710   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
711   if (!vsock)
712     return -ENOTSOCK;
713
714   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
715     return -EINVAL;
716
717   switch (vcom_socket_check_fcntl_cmd (__cmd))
718     {
719       /* invalid cmd */
720     case 0:
721       rv = -EBADF;
722       break;
723       /*cmd not handled by vcom and vppcom */
724     case 1:
725       rv = libc_vfcntl (vsock->fd, __cmd, __ap);
726       break;
727       /* cmd handled by vcom socket resource */
728     case 2:
729       rv = libc_vfcntl (vsock->fd, __cmd, __ap);
730       break;
731       /* cmd handled by vppcom */
732     case 3:
733       rv = vppcom_session_fcntl_va (vsock->sid, __cmd, __ap);
734       break;
735
736     default:
737       rv = -EINVAL;
738       break;
739     }
740
741   return rv;
742 }
743
744 /*
745  * RETURN:  0 - invalid cmd
746  *          1 - cmd not handled by vcom and vppcom
747  *          2 - cmd handled by vcom socket resource
748  *          3 - cmd handled by vppcom
749  */
750 static int
751 vcom_socket_check_ioctl_cmd (unsigned long int __cmd)
752 {
753   int rc;
754
755   switch (__cmd)
756     {
757       /* cmd handled by vppcom */
758     case FIONREAD:
759       rc = 3;
760       break;
761
762       /* cmd not handled by vcom and vppcom */
763     default:
764       rc = 1;
765       break;
766     }
767   return rc;
768 }
769
770 static int
771 vppcom_session_ioctl_va (int __sid, int __cmd, va_list __ap)
772 {
773   int rv;
774
775   if (__cmd == FIONREAD)
776     rv = vppcom_session_attr (__sid, VPPCOM_ATTR_GET_NREAD, 0, 0);
777   else
778     rv = -EOPNOTSUPP;
779   return rv;
780 }
781
782 int
783 vcom_socket_ioctl_va (int __fd, unsigned long int __cmd, va_list __ap)
784 {
785   int rv = -EBADF;
786   vcom_socket_main_t *vsm = &vcom_socket_main;
787   uword *p;
788   vcom_socket_t *vsock;
789
790   p = hash_get (vsm->sockidx_by_fd, __fd);
791   if (!p)
792     return -EBADF;
793
794   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
795   if (!vsock)
796     return -ENOTSOCK;
797
798   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
799     return -EINVAL;
800
801   switch (vcom_socket_check_ioctl_cmd (__cmd))
802     {
803       /* Not supported cmd */
804     case 0:
805       rv = -EOPNOTSUPP;
806       break;
807
808       /* cmd not handled by vcom and vppcom */
809     case 1:
810       rv = libc_vioctl (vsock->fd, __cmd, __ap);
811       break;
812
813       /* cmd handled by vcom socket resource */
814     case 2:
815       rv = libc_vioctl (vsock->fd, __cmd, __ap);
816       break;
817
818       /* cmd handled by vppcom */
819     case 3:
820       rv = vppcom_session_ioctl_va (vsock->sid, __cmd, __ap);
821       break;
822
823     default:
824       rv = -EINVAL;
825       break;
826     }
827
828   return rv;
829 }
830
831 static inline int
832 vcom_socket_fds_2_sid_fds (
833                             /* dest */
834                             int *vcom_nsid_fds,
835                             fd_set * __restrict vcom_rd_sid_fds,
836                             fd_set * __restrict vcom_wr_sid_fds,
837                             fd_set * __restrict vcom_ex_sid_fds,
838                             /* src */
839                             int vcom_nfds,
840                             fd_set * __restrict vcom_readfds,
841                             fd_set * __restrict vcom_writefds,
842                             fd_set * __restrict vcom_exceptfds)
843 {
844   int rv = 0;
845   int fd;
846   int sid;
847   /* invalid max_sid is -1 */
848   int max_sid = -1;
849   int nsid = 0;
850
851   /*
852    *  set sid in sid sets corresponding to fd's in fd sets
853    *  compute nsid and vcom_nsid_fds from sid sets
854    */
855
856   for (fd = 0; fd < vcom_nfds; fd++)
857     {
858       /*
859        * F fd set, src
860        * S sid set, dest
861        */
862 #define _(S,F)                              \
863       if ((F) && (S) && FD_ISSET (fd, (F))) \
864         {                                   \
865           sid = vcom_socket_get_sid (fd);   \
866           if (sid != INVALID_SESSION_ID)    \
867             {                               \
868               FD_SET (sid, (S));            \
869               if (sid > max_sid)            \
870                 {                           \
871                   max_sid = sid;            \
872                 }                           \
873               ++nsid;                       \
874             }                               \
875           else                              \
876             {                               \
877               rv = -EBADFD;                 \
878               goto done;                    \
879             }                               \
880         }
881
882
883       _(vcom_rd_sid_fds, vcom_readfds);
884       _(vcom_wr_sid_fds, vcom_writefds);
885       _(vcom_ex_sid_fds, vcom_exceptfds);
886 #undef _
887     }
888
889   *vcom_nsid_fds = max_sid != -1 ? max_sid + 1 : 0;
890   rv = nsid;
891
892 done:
893   return rv;
894 }
895
896 /*
897  * PRE: 00. sid sets were derived from fd sets
898  *      01. sid sets were updated with sids that actually changed
899  *          status
900  *      02. fd sets still has watched fds
901  *
902  * This function will modify in place fd sets to indicate which fd's
903  * actually changed status(inferred from sid sets)
904  */
905 static inline int
906 vcom_socket_sid_fds_2_fds (
907                             /* dest */
908                             int *new_vcom_nfds,
909                             int vcom_nfds,
910                             fd_set * __restrict vcom_readfds,
911                             fd_set * __restrict vcom_writefds,
912                             fd_set * __restrict vcom_exceptfds,
913                             /* src */
914                             int vcom_nsid_fds,
915                             fd_set * __restrict vcom_rd_sid_fds,
916                             fd_set * __restrict vcom_wr_sid_fds,
917                             fd_set * __restrict vcom_ex_sid_fds)
918 {
919   int rv = 0;
920   int fd;
921   int sid;
922   /* invalid max_fd is -1 */
923   int max_fd = -1;
924   int nfd = 0;
925
926
927   /*
928    *  modify in place fd sets to indicate which fd's
929    * actually changed status(inferred from sid sets)
930    */
931   for (fd = 0; fd < vcom_nfds; fd++)
932     {
933       /*
934        * F fd set, dest
935        * S sid set, src
936        */
937 #define _(S,F)                              \
938       if ((F) && (S) && FD_ISSET (fd, (F))) \
939         {                                   \
940           sid = vcom_socket_get_sid (fd);   \
941           if (sid != INVALID_SESSION_ID)    \
942             {                               \
943               if (!FD_ISSET (sid, (S)))     \
944                 {                           \
945                    FD_CLR(fd, (F));         \
946                 }                           \
947             }                               \
948           else                              \
949             {                               \
950               rv = -EBADFD;                 \
951               goto done;                    \
952             }                               \
953         }
954
955
956       _(vcom_rd_sid_fds, vcom_readfds);
957       _(vcom_wr_sid_fds, vcom_writefds);
958       _(vcom_ex_sid_fds, vcom_exceptfds);
959 #undef _
960     }
961
962   /*
963    *  compute nfd and new_vcom_nfds from fd sets
964    */
965   for (fd = 0; fd < vcom_nfds; fd++)
966     {
967
968 #define _(F)                                \
969       if ((F) && FD_ISSET (fd, (F)))        \
970         {                                   \
971           if (fd > max_fd)                  \
972             {                               \
973               max_fd = fd;                  \
974             }                               \
975           ++nfd;                            \
976         }
977
978
979       _(vcom_readfds);
980       _(vcom_writefds);
981       _(vcom_exceptfds);
982 #undef _
983
984     }
985
986   *new_vcom_nfds = max_fd != -1 ? max_fd + 1 : 0;
987   rv = nfd;
988
989 done:
990   return rv;
991 }
992
993 /*
994  * PRE:
995  * vom_socket_select is always called with
996  * timeout->tv_sec and timeout->tv_usec set to zero.
997  * hence vppcom_select return immediately.
998  */
999 /*
1000  * TBD: do{body;} while(timeout conditional); timeout loop
1001  */
1002 int
1003 vcom_socket_select (int vcom_nfds, fd_set * __restrict vcom_readfds,
1004                     fd_set * __restrict vcom_writefds,
1005                     fd_set * __restrict vcom_exceptfds,
1006                     struct timeval *__restrict timeout)
1007 {
1008   int rv = -EBADF;
1009   pid_t pid = getpid ();
1010
1011   int new_vcom_nfds = 0;
1012   int new_vcom_nfd = 0;
1013
1014   /* vcom sid fds */
1015   fd_set vcom_rd_sid_fds;
1016   fd_set vcom_wr_sid_fds;
1017   fd_set vcom_ex_sid_fds;
1018   unsigned long vcom_nsid_fds = 0;
1019   int vcom_nsid = 0;
1020
1021   /* in seconds eg. 3.123456789 seconds */
1022   double time_to_wait = (double) 0;
1023
1024   /* validate inputs */
1025   if (vcom_nfds < 0)
1026     {
1027       return -EINVAL;
1028     }
1029
1030   /* convert timeval timeout to double time_to_wait */
1031   if (timeout)
1032     {
1033       if (timeout->tv_sec == 0 && timeout->tv_usec == 0)
1034         {
1035           /* polling: vppcom_select returns immediately */
1036           time_to_wait = (double) 0;
1037         }
1038       else
1039         {
1040           /*TBD:  use timeval api */
1041           time_to_wait = (double) timeout->tv_sec +
1042             (double) timeout->tv_usec / (double) 1000000 +
1043             (double) (timeout->tv_usec % 1000000) / (double) 1000000;
1044         }
1045     }
1046   else
1047     {
1048       /*
1049        * no timeout: vppcom_select can block indefinitely
1050        * waiting for a file descriptor to become ready
1051        * */
1052       /* set to a phantom value */
1053       time_to_wait = ~0;
1054     }
1055
1056   /* zero the sid_sets */
1057   /*
1058    * F fd set
1059    * S sid set
1060    */
1061 #define _(S,F)                          \
1062   if ((F))                              \
1063     {                                   \
1064       FD_ZERO ((S));                    \
1065     }
1066
1067
1068   _(&vcom_rd_sid_fds, vcom_readfds);
1069   _(&vcom_wr_sid_fds, vcom_writefds);
1070   _(&vcom_ex_sid_fds, vcom_exceptfds);
1071 #undef _
1072
1073   /* populate read, write and except sid_sets */
1074   vcom_nsid = vcom_socket_fds_2_sid_fds (
1075                                           /* dest */
1076                                           vcom_readfds || vcom_writefds
1077                                           || vcom_exceptfds ? (int *)
1078                                           &vcom_nsid_fds : NULL,
1079                                           vcom_readfds ? &vcom_rd_sid_fds :
1080                                           NULL,
1081                                           vcom_writefds ? &vcom_wr_sid_fds :
1082                                           NULL,
1083                                           vcom_exceptfds ? &vcom_ex_sid_fds :
1084                                           NULL,
1085                                           /* src */
1086                                           vcom_nfds,
1087                                           vcom_readfds,
1088                                           vcom_writefds, vcom_exceptfds);
1089   if (vcom_nsid < 0)
1090     {
1091       return vcom_nsid;
1092     }
1093   if (vcom_nsid_fds < 0)
1094     {
1095       return -EINVAL;
1096     }
1097
1098   rv = vppcom_select (vcom_nsid_fds,
1099                       vcom_readfds ? (unsigned long *) &vcom_rd_sid_fds :
1100                       NULL,
1101                       vcom_writefds ? (unsigned long *) &vcom_wr_sid_fds :
1102                       NULL,
1103                       vcom_exceptfds ? (unsigned long *) &vcom_ex_sid_fds :
1104                       NULL, time_to_wait);
1105   if (VCOM_DEBUG > 0)
1106     fprintf (stderr, "[%d] vppcom_select: "
1107              "'%04d'='%04d'\n", pid, rv, (int) vcom_nsid_fds);
1108
1109   /* check if any file descriptors changed status */
1110   if (rv > 0)
1111     {
1112       /*
1113        * on exit, sets are modified in place to indicate which
1114        * file descriptors actually changed status
1115        * */
1116
1117       /*
1118        * comply with pre-condition
1119        * do not clear vcom fd sets befor calling
1120        * vcom_socket_sid_fds_2_fds
1121        */
1122       new_vcom_nfd = vcom_socket_sid_fds_2_fds (
1123                                                  /* dest */
1124                                                  &new_vcom_nfds,
1125                                                  vcom_nfds,
1126                                                  vcom_readfds,
1127                                                  vcom_writefds,
1128                                                  vcom_exceptfds,
1129                                                  /* src */
1130                                                  vcom_nsid_fds,
1131                                                  vcom_readfds ?
1132                                                  &vcom_rd_sid_fds : NULL,
1133                                                  vcom_writefds ?
1134                                                  &vcom_wr_sid_fds : NULL,
1135                                                  vcom_exceptfds ?
1136                                                  &vcom_ex_sid_fds : NULL);
1137       if (new_vcom_nfd < 0)
1138         {
1139           return new_vcom_nfd;
1140         }
1141       if (new_vcom_nfds < 0)
1142         {
1143           return -EINVAL;
1144         }
1145       rv = new_vcom_nfd;
1146     }
1147   return rv;
1148 }
1149
1150
1151 int
1152 vcom_socket_socket (int __domain, int __type, int __protocol)
1153 {
1154   int rv = -1;
1155   vcom_socket_main_t *vsm = &vcom_socket_main;
1156   vcom_socket_t *vsock;
1157
1158   i32 fd;
1159   i32 sid;
1160   i32 sockidx;
1161   u8 is_nonblocking = __type & SOCK_NONBLOCK ? 1 : 0;
1162   int type = __type & ~(SOCK_NONBLOCK | SOCK_CLOEXEC);
1163
1164   fd = vcom_socket_open_socket (__domain, __type, __protocol);
1165   if (fd < 0)
1166     {
1167       rv = fd;
1168       goto out;
1169     }
1170
1171   sid = vppcom_session_create (VPPCOM_VRF_DEFAULT,
1172                                (type == SOCK_DGRAM) ?
1173                                VPPCOM_PROTO_UDP : VPPCOM_PROTO_TCP,
1174                                is_nonblocking);
1175   if (sid < 0)
1176     {
1177       rv = sid;
1178       goto out_close_socket;
1179     }
1180
1181   pool_get (vsm->vsockets, vsock);
1182   vsocket_init (vsock);
1183
1184   sockidx = vsock - vsm->vsockets;
1185   hash_set (vsm->sockidx_by_fd, fd, sockidx);
1186
1187   vsocket_set (vsock, fd, sid, SOCKET_TYPE_VPPCOM_BOUND);
1188   return fd;
1189
1190 out_close_socket:
1191   vcom_socket_close_socket (fd);
1192 out:
1193   return rv;
1194 }
1195
1196 int
1197 vcom_socket_socketpair (int __domain, int __type, int __protocol,
1198                         int __fds[2])
1199 {
1200 /* TBD: */
1201   return 0;
1202 }
1203
1204 int
1205 vcom_socket_bind (int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len)
1206 {
1207   int rv = -1;
1208   vcom_socket_main_t *vsm = &vcom_socket_main;
1209   uword *p;
1210   vcom_socket_t *vsock;
1211
1212   vppcom_endpt_t ep;
1213
1214   p = hash_get (vsm->sockidx_by_fd, __fd);
1215   if (!p)
1216     return -EBADF;
1217
1218   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1219   if (!vsock)
1220     return -ENOTSOCK;
1221
1222   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1223     return -EINVAL;
1224
1225   if (!__addr)
1226     {
1227       return -EINVAL;
1228     }
1229
1230   ep.vrf = VPPCOM_VRF_DEFAULT;
1231   switch (__addr->sa_family)
1232     {
1233     case AF_INET:
1234       if (__len != sizeof (struct sockaddr_in))
1235         {
1236           return -EINVAL;
1237         }
1238       ep.is_ip4 = VPPCOM_IS_IP4;
1239       ep.ip = (u8 *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1240       ep.port = (u16) ((const struct sockaddr_in *) __addr)->sin_port;
1241       break;
1242
1243     case AF_INET6:
1244       if (__len != sizeof (struct sockaddr_in6))
1245         {
1246           return -EINVAL;
1247         }
1248       ep.is_ip4 = VPPCOM_IS_IP6;
1249       ep.ip = (u8 *) & ((const struct sockaddr_in6 *) __addr)->sin6_addr;
1250       ep.port = (u16) ((const struct sockaddr_in6 *) __addr)->sin6_port;
1251       break;
1252
1253     default:
1254       return -1;
1255       break;
1256     }
1257
1258   rv = vppcom_session_bind (vsock->sid, &ep);
1259   /* TBD: remove libc_bind code snippet
1260    * once vppcom implements vppcom_session_getsockname */
1261   if (rv == 0)
1262     {
1263       rv = libc_bind (__fd, __addr, __len);
1264       if (rv != 0)
1265         {
1266           rv = -errno;
1267         }
1268     }
1269   return rv;
1270 }
1271
1272 int
1273 vppcom_session_getsockname (int sid, vppcom_endpt_t * ep)
1274 {
1275   int rv;
1276   uint32_t size = sizeof (*ep);
1277
1278   rv = vppcom_session_attr (sid, VPPCOM_ATTR_GET_LCL_ADDR, ep, &size);
1279   return rv;
1280 }
1281
1282 int
1283 vcom_socket_getsockname (int __fd, __SOCKADDR_ARG __addr,
1284                          socklen_t * __restrict __len)
1285 {
1286   int rv = -1;
1287   vcom_socket_main_t *vsm = &vcom_socket_main;
1288   uword *p;
1289   vcom_socket_t *vsock;
1290
1291
1292   p = hash_get (vsm->sockidx_by_fd, __fd);
1293   if (!p)
1294     return -EBADF;
1295
1296   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1297   if (!vsock)
1298     return -ENOTSOCK;
1299
1300   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1301     return -EINVAL;
1302
1303   if (!__addr || !__len)
1304     return -EFAULT;
1305
1306   if (*__len < 0)
1307     {
1308       return -EINVAL;
1309     }
1310
1311   vppcom_endpt_t ep;
1312   ep.ip = (u8 *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1313   rv = vppcom_session_getsockname (vsock->sid, &ep);
1314   if (rv == 0)
1315     {
1316       if (ep.vrf == VPPCOM_VRF_DEFAULT)
1317         {
1318           __addr->sa_family = ep.is_ip4 == VPPCOM_IS_IP4 ? AF_INET : AF_INET6;
1319           switch (__addr->sa_family)
1320             {
1321             case AF_INET:
1322               ((struct sockaddr_in *) __addr)->sin_port = ep.port;
1323               *__len = sizeof (struct sockaddr_in);
1324               break;
1325
1326             case AF_INET6:
1327               ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
1328               *__len = sizeof (struct sockaddr_in6);
1329               break;
1330
1331             default:
1332               break;
1333             }
1334         }
1335     }
1336
1337   return rv;
1338 }
1339
1340 int
1341 vcom_socket_connect (int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len)
1342 {
1343   int rv = -1;
1344   vcom_socket_main_t *vsm = &vcom_socket_main;
1345   uword *p;
1346   vcom_socket_t *vsock;
1347
1348   vppcom_endpt_t ep;
1349
1350   p = hash_get (vsm->sockidx_by_fd, __fd);
1351   if (p)
1352     {
1353       vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1354
1355       ep.vrf = VPPCOM_VRF_DEFAULT;
1356       switch (__addr->sa_family)
1357         {
1358         case AF_INET:
1359           ep.is_ip4 = VPPCOM_IS_IP4;
1360           ep.ip =
1361             (uint8_t *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1362           ep.port =
1363             (uint16_t) ((const struct sockaddr_in *) __addr)->sin_port;
1364           break;
1365
1366         case AF_INET6:
1367           ep.is_ip4 = VPPCOM_IS_IP6;
1368           ep.ip =
1369             (uint8_t *) & ((const struct sockaddr_in6 *) __addr)->sin6_addr;
1370           ep.port =
1371             (uint16_t) ((const struct sockaddr_in6 *) __addr)->sin6_port;
1372           break;
1373
1374         default:
1375           return -1;
1376           break;
1377         }
1378
1379       rv = vppcom_session_connect (vsock->sid, &ep);
1380     }
1381   return rv;
1382 }
1383
1384 int
1385 vppcom_session_getpeername (int sid, vppcom_endpt_t * ep)
1386 {
1387   int rv;
1388   uint32_t size = sizeof (*ep);
1389
1390   rv = vppcom_session_attr (sid, VPPCOM_ATTR_GET_PEER_ADDR, ep, &size);
1391   return rv;
1392 }
1393
1394 int
1395 vcom_socket_getpeername (int __fd, __SOCKADDR_ARG __addr,
1396                          socklen_t * __restrict __len)
1397 {
1398   int rv = -1;
1399   vcom_socket_main_t *vsm = &vcom_socket_main;
1400   uword *p;
1401   vcom_socket_t *vsock;
1402
1403
1404   p = hash_get (vsm->sockidx_by_fd, __fd);
1405   if (!p)
1406     return -EBADF;
1407
1408   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1409   if (!vsock)
1410     return -ENOTSOCK;
1411
1412   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1413     return -EINVAL;
1414
1415   if (!__addr || !__len)
1416     return -EFAULT;
1417
1418   if (*__len < 0)
1419     {
1420       return -EINVAL;
1421     }
1422
1423   vppcom_endpt_t ep;
1424   ep.ip = (u8 *) & ((const struct sockaddr_in *) __addr)->sin_addr;
1425   rv = vppcom_session_getpeername (vsock->sid, &ep);
1426   if (rv == 0)
1427     {
1428       if (ep.vrf == VPPCOM_VRF_DEFAULT)
1429         {
1430           __addr->sa_family = ep.is_ip4 == VPPCOM_IS_IP4 ? AF_INET : AF_INET6;
1431           switch (__addr->sa_family)
1432             {
1433             case AF_INET:
1434               ((struct sockaddr_in *) __addr)->sin_port = ep.port;
1435               *__len = sizeof (struct sockaddr_in);
1436               break;
1437
1438             case AF_INET6:
1439               ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
1440               *__len = sizeof (struct sockaddr_in6);
1441               break;
1442
1443             default:
1444               break;
1445             }
1446         }
1447     }
1448
1449   return rv;
1450 }
1451
1452 ssize_t
1453 vcom_socket_send (int __fd, const void *__buf, size_t __n, int __flags)
1454 {
1455   return vcom_socket_sendto (__fd, __buf, __n, __flags, NULL, 0);
1456 }
1457
1458 ssize_t
1459 vcom_socket_recv (int __fd, void *__buf, size_t __n, int __flags)
1460 {
1461   int rv = -1;
1462   rv = vcom_socket_recvfrom (__fd, __buf, __n, __flags, NULL, 0);
1463   return rv;
1464 }
1465
1466 /*
1467  * RETURN   1 if __fd is (SOCK_STREAM, SOCK_SEQPACKET),
1468  * 0 otherwise
1469  * */
1470 int
1471 vcom_socket_is_connection_mode_socket (int __fd)
1472 {
1473   int rv = -1;
1474   /* TBD define new vppcom api */
1475   vcom_socket_main_t *vsm = &vcom_socket_main;
1476   uword *p;
1477   vcom_socket_t *vsock;
1478
1479   int type;
1480   socklen_t optlen;
1481
1482   p = hash_get (vsm->sockidx_by_fd, __fd);
1483
1484   if (p)
1485     {
1486       vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1487       if (vsock && vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
1488         {
1489           optlen = sizeof (type);
1490           rv = libc_getsockopt (__fd, SOL_SOCKET, SO_TYPE, &type, &optlen);
1491           if (rv != 0)
1492             {
1493               return 0;
1494             }
1495           /* get socket type */
1496           switch (type & ~(SOCK_CLOEXEC | SOCK_NONBLOCK))
1497             {
1498             case SOCK_STREAM:
1499             case SOCK_SEQPACKET:
1500               return 1;
1501               break;
1502
1503             default:
1504               return 0;
1505               break;
1506             }
1507         }
1508     }
1509   return 0;
1510 }
1511
1512 ssize_t
1513 vvppcom_session_sendto (int __sid, const void *__buf, size_t __n,
1514                         int __flags, __CONST_SOCKADDR_ARG __addr,
1515                         socklen_t __addr_len)
1516 {
1517   int rv = -1;
1518   /* TBD add new vpp api  */
1519   /* TBD add flags parameter */
1520   rv = vppcom_session_write (__sid, (void *) __buf, (int) __n);
1521   return rv;
1522 }
1523
1524 ssize_t
1525 vcom_socket_sendto (int __fd, const void *__buf, size_t __n,
1526                     int __flags, __CONST_SOCKADDR_ARG __addr,
1527                     socklen_t __addr_len)
1528 {
1529   int rv = -1;
1530   vcom_socket_main_t *vsm = &vcom_socket_main;
1531   uword *p;
1532   vcom_socket_t *vsock;
1533
1534   p = hash_get (vsm->sockidx_by_fd, __fd);
1535   if (!p)
1536     return -EBADF;
1537
1538   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1539   if (!vsock)
1540     return -ENOTSOCK;
1541
1542   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1543     return -EINVAL;
1544
1545   if (!__buf || __n < 0)
1546     {
1547       return -EINVAL;
1548     }
1549
1550   if (vcom_socket_is_connection_mode_socket (__fd))
1551     {
1552       /* ignore __addr and _addr_len */
1553       /* and EISCONN may be returned when they are not NULL and 0 */
1554       if ((__addr != NULL) || (__addr_len != 0))
1555         {
1556           return -EISCONN;
1557         }
1558     }
1559   else
1560     {
1561       if (!__addr || __addr_len < 0)
1562         {
1563           return -EDESTADDRREQ;
1564         }
1565       /* not a vppcom supported address family */
1566       if ((__addr->sa_family != AF_INET) || (__addr->sa_family != AF_INET6))
1567         {
1568           return -EINVAL;
1569         }
1570     }
1571
1572   rv = vvppcom_session_sendto (vsock->sid, (void *) __buf, (int) __n,
1573                                __flags, __addr, __addr_len);
1574   return rv;
1575 }
1576
1577 /* TBD: move it to vppcom */
1578 static ssize_t
1579 vppcom_session_recvfrom (int __sid, void *__restrict __buf, size_t __n,
1580                          int __flags, __SOCKADDR_ARG __addr,
1581                          socklen_t * __restrict __addr_len)
1582 {
1583   int rv = -1;
1584
1585   /* TBD add flags parameter */
1586   rv = vppcom_session_read (__sid, __buf, __n);
1587   return rv;
1588 }
1589
1590 ssize_t
1591 vcom_socket_recvfrom (int __fd, void *__restrict __buf, size_t __n,
1592                       int __flags, __SOCKADDR_ARG __addr,
1593                       socklen_t * __restrict __addr_len)
1594 {
1595   int rv = -1;
1596   vcom_socket_main_t *vsm = &vcom_socket_main;
1597   uword *p;
1598   vcom_socket_t *vsock;
1599
1600   p = hash_get (vsm->sockidx_by_fd, __fd);
1601   if (!p)
1602     return -EBADF;
1603
1604   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1605   if (!vsock)
1606     return -ENOTSOCK;
1607
1608   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1609     return -EINVAL;
1610
1611   if (!__buf || __n < 0)
1612     {
1613       return -EINVAL;
1614     }
1615
1616   if (__addr || __addr_len < 0)
1617     {
1618       return -EINVAL;
1619     }
1620
1621   rv = vppcom_session_recvfrom (vsock->sid, __buf, __n,
1622                                 __flags, __addr, __addr_len);
1623   return rv;
1624 }
1625
1626 /* TBD: move it to vppcom */
1627 static ssize_t
1628 vppcom_sendmsg (int __sid, const struct msghdr *__message, int __flags)
1629 {
1630   int rv = -1;
1631   /* rv = vppcom_session_write (__sid, (void *) __message->__buf,
1632      (int)__n); */
1633   return rv;
1634 }
1635
1636 ssize_t
1637 vcom_socket_sendmsg (int __fd, const struct msghdr * __message, int __flags)
1638 {
1639   int rv = -1;
1640   vcom_socket_main_t *vsm = &vcom_socket_main;
1641   uword *p;
1642   vcom_socket_t *vsock;
1643
1644   p = hash_get (vsm->sockidx_by_fd, __fd);
1645   if (!p)
1646     return -EBADF;
1647
1648   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1649   if (!vsock)
1650     return -ENOTSOCK;
1651
1652   if (vcom_socket_is_connection_mode_socket (__fd))
1653     {
1654       /* ignore __addr and _addr_len */
1655       /* and EISCONN may be returned when they are not NULL and 0 */
1656       if ((__message->msg_name != NULL) || (__message->msg_namelen != 0))
1657         {
1658           return -EISCONN;
1659         }
1660     }
1661   else
1662     {
1663       /* TBD: validate __message->msg_name and __message->msg_namelen
1664        * and return -EINVAL on validation error
1665        * */
1666       ;
1667     }
1668
1669   rv = vppcom_sendmsg (vsock->sid, __message, __flags);
1670
1671   return rv;
1672 }
1673
1674 #ifdef __USE_GNU
1675 int
1676 vcom_socket_sendmmsg (int __fd, struct mmsghdr *__vmessages,
1677                       unsigned int __vlen, int __flags)
1678 {
1679
1680   /* TBD: define a new vppcom api */
1681   return 0;
1682 }
1683 #endif
1684
1685 /* TBD: move it to vppcom */
1686 static ssize_t
1687 vppcom_recvmsg (int __sid, struct msghdr *__message, int __flags)
1688 {
1689   int rv = -1;
1690   /* rv = vppcom_session_read (__sid, (void *) __message->__buf,
1691      (int)__n); */
1692   rv = -EOPNOTSUPP;
1693   return rv;
1694 }
1695
1696 ssize_t
1697 vcom_socket_recvmsg (int __fd, 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 (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1713     return -EINVAL;
1714
1715   if (!__message)
1716     {
1717       return -EINVAL;
1718     }
1719
1720   /* validate __flags */
1721
1722   rv = vppcom_recvmsg (vsock->sid, __message, __flags);
1723   return rv;
1724 }
1725
1726 #ifdef __USE_GNU
1727 int
1728 vcom_socket_recvmmsg (int __fd, struct mmsghdr *__vmessages,
1729                       unsigned int __vlen, int __flags,
1730                       struct timespec *__tmo)
1731 {
1732   /* TBD: define a new vppcom api */
1733   return 0;
1734 }
1735 #endif
1736
1737 /* TBD: move it to vppcom */
1738 static int
1739 vppcom_getsockopt (int __sid, int __level, int __optname,
1740                    void *__restrict __optval, socklen_t * __restrict __optlen)
1741 {
1742   /* 1. for socket level options that are NOT socket attributes
1743    *    and that has corresponding vpp options get from vppcom */
1744 #if 0
1745   return 0;
1746 #endif
1747
1748   /* 2. unhandled options */
1749   return -ENOPROTOOPT;
1750 }
1751
1752 int
1753 vcom_socket_getsockopt (int __fd, int __level, int __optname,
1754                         void *__restrict __optval,
1755                         socklen_t * __restrict __optlen)
1756 {
1757   int rv = -1;
1758   vcom_socket_main_t *vsm = &vcom_socket_main;
1759   uword *p;
1760   vcom_socket_t *vsock;
1761
1762   p = hash_get (vsm->sockidx_by_fd, __fd);
1763   if (!p)
1764     return -EBADF;
1765
1766   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1767   if (!vsock)
1768     return -ENOTSOCK;
1769
1770   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1771     return -EINVAL;
1772
1773   if (!__optval && !__optlen)
1774     return -EFAULT;
1775
1776   if (*__optlen < 0)
1777     {
1778       return -EINVAL;
1779     }
1780
1781   switch (__level)
1782     {
1783       /* handle options at socket level */
1784     case SOL_SOCKET:
1785       switch (__optname)
1786         {
1787 /*
1788  *  1. for socket level options that are socket attributes,
1789  *     get from libc_getsockopt.
1790  *  2. for socket level options that are NOT socket
1791  *     attributes and that has corresponding vpp options
1792  *     get from vppcom.
1793  *  3. for socket level options unimplemented
1794  *     return -ENOPROTOOPT */
1795         case SO_DEBUG:
1796         case SO_DONTROUTE:
1797         case SO_BROADCAST:
1798         case SO_SNDBUF:
1799         case SO_RCVBUF:
1800         case SO_REUSEADDR:
1801         case SO_REUSEPORT:
1802         case SO_KEEPALIVE:
1803         case SO_TYPE:
1804         case SO_PROTOCOL:
1805         case SO_DOMAIN:
1806         case SO_ERROR:
1807         case SO_OOBINLINE:
1808         case SO_NO_CHECK:
1809         case SO_PRIORITY:
1810         case SO_LINGER:
1811         case SO_BSDCOMPAT:
1812         case SO_TIMESTAMP:
1813         case SO_TIMESTAMPNS:
1814         case SO_TIMESTAMPING:
1815         case SO_RCVTIMEO:
1816         case SO_SNDTIMEO:
1817         case SO_RCVLOWAT:
1818         case SO_SNDLOWAT:
1819         case SO_PASSCRED:
1820         case SO_PEERCRED:
1821         case SO_PEERNAME:
1822         case SO_ACCEPTCONN:
1823         case SO_PASSSEC:
1824         case SO_PEERSEC:
1825         case SO_MARK:
1826         case SO_RXQ_OVFL:
1827         case SO_WIFI_STATUS:
1828         case SO_PEEK_OFF:
1829         case SO_NOFCS:
1830         case SO_BINDTODEVICE:
1831         case SO_GET_FILTER:
1832         case SO_LOCK_FILTER:
1833         case SO_BPF_EXTENSIONS:
1834         case SO_SELECT_ERR_QUEUE:
1835 #ifdef CONFIG_NET_RX_BUSY_POLL
1836         case SO_BUSY_POLL:
1837 #endif
1838         case SO_MAX_PACING_RATE:
1839         case SO_INCOMING_CPU:
1840           rv = libc_getsockopt (__fd, __level, __optname, __optval, __optlen);
1841           if (rv != 0)
1842             {
1843               rv = -errno;
1844               return rv;
1845             }
1846           break;
1847
1848         default:
1849           /* We implement the SO_SNDLOWAT etc to not be settable
1850            * (1003.1g 7).
1851            */
1852           return -ENOPROTOOPT;
1853         }
1854
1855       break;
1856
1857     default:
1858       /* 1. handle options that are NOT socket level options,
1859        *    but have corresponding vpp otions. */
1860       rv = vppcom_getsockopt (vsock->sid, __level, __optname,
1861                               __optval, __optlen);
1862
1863       return rv;
1864 #if 0
1865       /* 2. unhandled options */
1866       return -ENOPROTOOPT;
1867 #endif
1868     }
1869
1870   return rv;
1871 }
1872
1873 /* TBD: move it to vppcom */
1874 int
1875 vppcom_session_setsockopt (int __sid, int __level, int __optname,
1876                            const void *__optval, socklen_t __optlen)
1877 {
1878   int rv = -EOPNOTSUPP;
1879
1880   switch (__level)
1881     {
1882     case SOL_TCP:
1883       switch (__optname)
1884         {
1885         case TCP_KEEPIDLE:
1886           rv =
1887             vppcom_session_attr (__sid, VPPCOM_ATTR_SET_TCP_KEEPIDLE, 0, 0);
1888           break;
1889         case TCP_KEEPINTVL:
1890           rv =
1891             vppcom_session_attr (__sid, VPPCOM_ATTR_SET_TCP_KEEPINTVL, 0, 0);
1892           break;
1893         default:
1894           break;
1895         }
1896       break;
1897     case SOL_IPV6:
1898       switch (__optname)
1899         {
1900         case IPV6_V6ONLY:
1901           rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_V6ONLY, 0, 0);
1902           break;
1903         default:
1904           break;
1905         }
1906       break;
1907     case SOL_SOCKET:
1908       switch (__optname)
1909         {
1910         case SO_KEEPALIVE:
1911           rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_KEEPALIVE, 0, 0);
1912           break;
1913         case SO_REUSEADDR:
1914           rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_REUSEADDR, 0, 0);
1915           break;
1916         case SO_BROADCAST:
1917           rv = vppcom_session_attr (__sid, VPPCOM_ATTR_SET_BROADCAST, 0, 0);
1918           break;
1919         default:
1920           break;
1921         }
1922       break;
1923     default:
1924       break;
1925     }
1926
1927   return rv;
1928 }
1929
1930 int
1931 vcom_socket_setsockopt (int __fd, int __level, int __optname,
1932                         const void *__optval, socklen_t __optlen)
1933 {
1934   int rv = -1;
1935   vcom_socket_main_t *vsm = &vcom_socket_main;
1936   uword *p;
1937   vcom_socket_t *vsock;
1938
1939   p = hash_get (vsm->sockidx_by_fd, __fd);
1940   if (!p)
1941     return -EBADF;
1942
1943   vsock = pool_elt_at_index (vsm->vsockets, p[0]);
1944   if (!vsock)
1945     return -ENOTSOCK;
1946
1947   if (vsock->type != SOCKET_TYPE_VPPCOM_BOUND)
1948     return -EINVAL;
1949
1950   /*
1951    *      Options without arguments
1952    */
1953
1954   if (__optname == SO_BINDTODEVICE)
1955     {
1956       rv = libc_setsockopt (__fd, __level, __optname, __optval, __optlen);
1957       if (rv != 0)
1958         {
1959           rv = -errno;
1960         }
1961       return rv;
1962     }
1963
1964   if (!__optval)
1965     return -EFAULT;
1966
1967   if ((__optlen < 0) || (__optlen < sizeof (int)))
1968     return -EINVAL;
1969
1970   switch (__level)
1971     {
1972     case SOL_IPV6:
1973       switch (__optname)
1974         {
1975         case IPV6_V6ONLY:
1976           rv = vppcom_session_setsockopt (vsock->sid, __level, __optname,
1977                                           __optval, __optlen);
1978           break;
1979         default:
1980           return -EOPNOTSUPP;
1981         }
1982       break;
1983     case SOL_TCP:
1984       switch (__optname)
1985         {
1986         case TCP_NODELAY:
1987           return 0;
1988         case TCP_KEEPIDLE:
1989         case TCP_KEEPINTVL:
1990           rv = vppcom_session_setsockopt (vsock->sid, __level, __optname,
1991                                           __optval, __optlen);
1992           break;
1993         default:
1994           return -EOPNOTSUPP;
1995         }
1996       break;
1997       /* handle options at socket level */
1998     case SOL_SOCKET:
1999       switch (__optname)
2000         {
2001         case SO_REUSEADDR:
2002         case SO_BROADCAST:
2003         case SO_KEEPALIVE:
2004           rv = vppcom_session_setsockopt (vsock->sid, __level, __optname,
2005                                           __optval, __optlen);
2006           break;
2007
2008           /*
2009            * 1. for socket level options that are socket attributes,
2010            *    set it from libc_getsockopt
2011            * 2. for socket level options that are NOT socket
2012            *    attributes and that has corresponding vpp options
2013            *    set it from vppcom
2014            * 3. for socket level options unimplemented
2015            *    return -ENOPROTOOPT */
2016         case SO_DEBUG:
2017         case SO_DONTROUTE:
2018         case SO_SNDBUF:
2019         case SO_RCVBUF:
2020         case SO_REUSEPORT:
2021         case SO_TYPE:
2022         case SO_PROTOCOL:
2023         case SO_DOMAIN:
2024         case SO_ERROR:
2025         case SO_OOBINLINE:
2026         case SO_NO_CHECK:
2027         case SO_PRIORITY:
2028         case SO_LINGER:
2029         case SO_BSDCOMPAT:
2030         case SO_TIMESTAMP:
2031         case SO_TIMESTAMPNS:
2032         case SO_TIMESTAMPING:
2033         case SO_RCVTIMEO:
2034         case SO_SNDTIMEO:
2035         case SO_RCVLOWAT:
2036         case SO_SNDLOWAT:
2037         case SO_PASSCRED:
2038         case SO_PEERCRED:
2039         case SO_PEERNAME:
2040         case SO_ACCEPTCONN:
2041         case SO_PASSSEC:
2042         case SO_PEERSEC:
2043         case SO_MARK:
2044         case SO_RXQ_OVFL:
2045         case SO_WIFI_STATUS:
2046         case SO_PEEK_OFF:
2047         case SO_NOFCS:
2048           /*
2049            * SO_BINDTODEVICE already handled as
2050            * "Options without arguments" */
2051           /* case SO_BINDTODEVICE: */
2052         case SO_GET_FILTER:
2053         case SO_LOCK_FILTER:
2054         case SO_BPF_EXTENSIONS:
2055         case SO_SELECT_ERR_QUEUE:
2056 #ifdef CONFIG_NET_RX_BUSY_POLL
2057         case SO_BUSY_POLL:
2058 #endif
2059         case SO_MAX_PACING_RATE:
2060         case SO_INCOMING_CPU:
2061           rv = libc_setsockopt (__fd, __level, __optname, __optval, __optlen);
2062           if (rv != 0)
2063             {
2064               rv = -errno;
2065               return rv;
2066             }
2067           break;
2068
2069         default:
2070           /* We implement the SO_SNDLOWAT etc to not be settable
2071            * (1003.1g 7).
2072            */
2073           return -ENOPROTOOPT;
2074         }
2075
2076       break;
2077
2078     default:
2079       return -ENOPROTOOPT;
2080     }
2081
2082   return rv;
2083 }
2084
2085 int
2086 vcom_socket_listen (int __fd, int __n)
2087 {
2088   int rv = -1;
2089   vcom_socket_main_t *vsm = &vcom_socket_main;
2090   uword *p;
2091   vcom_socket_t *vsock;
2092
2093   p = hash_get (vsm->sockidx_by_fd, __fd);
2094   if (p)
2095     {
2096       vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2097
2098       /* TBD vppcom to accept __n parameter */
2099       rv = vppcom_session_listen (vsock->sid, __n);
2100     }
2101
2102   return rv;
2103 }
2104
2105 static int
2106 vcom_socket_connected_socket (int __fd, int __sid,
2107                               int *__domain,
2108                               int *__type, int *__protocol, int flags)
2109 {
2110   int rv = -1;
2111   vcom_socket_main_t *vsm = &vcom_socket_main;
2112   vcom_socket_t *vsock;
2113
2114   i32 fd;
2115   i32 sockidx;
2116
2117   socklen_t optlen;
2118
2119   optlen = sizeof (*__domain);
2120   rv = libc_getsockopt (__fd, SOL_SOCKET, SO_DOMAIN, __domain, &optlen);
2121   if (rv != 0)
2122     {
2123       rv = -errno;
2124       goto out;
2125     }
2126
2127   optlen = sizeof (*__type);
2128   rv = libc_getsockopt (__fd, SOL_SOCKET, SO_TYPE, __type, &optlen);
2129   if (rv != 0)
2130     {
2131       rv = -errno;
2132       goto out;
2133     }
2134
2135   optlen = sizeof (*__protocol);
2136   rv = libc_getsockopt (__fd, SOL_SOCKET, SO_PROTOCOL, __protocol, &optlen);
2137   if (rv != 0)
2138     {
2139       rv = -errno;
2140       goto out;
2141     }
2142
2143   fd = vcom_socket_open_socket (*__domain, *__type | flags, *__protocol);
2144   if (fd < 0)
2145     {
2146       rv = fd;
2147       goto out;
2148     }
2149
2150   pool_get (vsm->vsockets, vsock);
2151   vsocket_init (vsock);
2152
2153   sockidx = vsock - vsm->vsockets;
2154   hash_set (vsm->sockidx_by_fd, fd, sockidx);
2155
2156   vsocket_set (vsock, fd, __sid, SOCKET_TYPE_VPPCOM_BOUND);
2157   return fd;
2158
2159 out:
2160   return rv;
2161 }
2162
2163 /* If flag is 0, then accept4() is the same as accept().
2164  * SOCK_NONBLOCK and SOCK_CLOEXEC can be bitwise ORed in flags
2165  */
2166 static int
2167 vcom_socket_accept_flags (int __fd, __SOCKADDR_ARG __addr,
2168                           socklen_t * __restrict __addr_len, int flags)
2169 {
2170   int rv = -1;
2171   vcom_socket_main_t *vsm = &vcom_socket_main;
2172   uword *p;
2173   vcom_socket_t *vsock;
2174
2175   int fd;
2176   int sid;
2177   int domain;
2178   int type;
2179   int protocol;
2180
2181   uint8_t addr8[sizeof (struct in6_addr)];
2182   vppcom_endpt_t ep;
2183
2184   ep.ip = addr8;
2185
2186   /* validate flags */
2187
2188   /*
2189    * for documentation
2190    *  switch (flags)
2191    *   {
2192    *   case 0:
2193    *   case SOCK_NONBLOCK:
2194    *   case SOCK_CLOEXEC:
2195    *   case SOCK_NONBLOCK | SOCK_CLOEXEC:
2196    *     break;
2197    *
2198    *   default:
2199    *     return -1;
2200    *   }
2201    */
2202   /* flags can be 0 or can be bitwise OR
2203    * of any of SOCK_NONBLOCK and SOCK_CLOEXEC */
2204
2205   if (!(!flags || (flags & (SOCK_NONBLOCK | SOCK_CLOEXEC))))
2206     {
2207       /* TBD: return proper error code */
2208       return -1;
2209     }
2210
2211   /* TBD: return proper error code */
2212
2213   if (!vcom_socket_is_connection_mode_socket (__fd))
2214     {
2215       return -EOPNOTSUPP;
2216     }
2217
2218   p = hash_get (vsm->sockidx_by_fd, __fd);
2219   if (p)
2220     {
2221       vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2222
2223
2224       rv = vcom_fcntl (vsock->fd, F_GETFL, 0);
2225       if (rv < 0)
2226         {
2227           return rv;
2228         }
2229
2230       /* is blocking */
2231       if (!(rv & O_NONBLOCK))
2232         {
2233           /* socket is not marked as nonblocking
2234            * and no pending connections are present
2235            * on the queue, accept () blocks the caller
2236            * until a connection is present.
2237            */
2238           rv = vppcom_session_accept (vsock->sid, &ep,
2239                                       -1.0 /* wait forever */ );
2240         }
2241       else
2242         {
2243           /* The file descriptor refers to a socket and has been
2244            * marked nonblocking(O_NONBLOCK) and the accept would
2245            * block.
2246            * */
2247           /* is non blocking */
2248           rv = vppcom_session_accept (vsock->sid, &ep, 0);
2249           /* If the socket is marked nonblocking and
2250            * no pending connections are present on the
2251            * queue, accept fails with the error
2252            * EAGAIN or EWOULDBLOCK
2253            */
2254           if (rv == VPPCOM_ETIMEDOUT)
2255             {
2256               rv = VPPCOM_EAGAIN;
2257             }
2258         }
2259       if (rv < 0)
2260         {
2261           return rv;
2262         }
2263
2264       sid = rv;
2265
2266       /* create a new connected socket resource and set flags
2267        * on the new file descriptor.
2268        * update vsockets and sockidx_by_fd table
2269        * */
2270       fd = vcom_socket_connected_socket (__fd, sid,
2271                                          &domain, &type, &protocol, flags);
2272       if (fd < 0)
2273         {
2274           return fd;
2275         }
2276
2277       rv = fd;
2278
2279       /* TBD populate __addr and __addr_len */
2280       /* TBD: The returned address is truncated if the buffer
2281        * provided is too small, in this case, __addr_len will
2282        * return a value greater than was supplied to the call.*/
2283       if (__addr)
2284         {
2285           if (ep.is_cut_thru)
2286             {
2287               /* TBD populate __addr and __addr_len */
2288               switch (domain)
2289                 {
2290                 case AF_INET:
2291                   ((struct sockaddr_in *) __addr)->sin_family = AF_INET;
2292                   ((struct sockaddr_in *) __addr)->sin_port = ep.port;
2293                   memcpy (&((struct sockaddr_in *) __addr)->sin_addr,
2294                           addr8, sizeof (struct in_addr));
2295                   /* TBD: populate __addr_len */
2296                   if (__addr_len)
2297                     {
2298                       *__addr_len = sizeof (struct sockaddr_in);
2299                     }
2300                   break;
2301
2302                 case AF_INET6:
2303                   ((struct sockaddr_in6 *) __addr)->sin6_family = AF_INET6;
2304                   ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
2305                   memcpy (((struct sockaddr_in6 *) __addr)->sin6_addr.
2306                           __in6_u.__u6_addr8, addr8,
2307                           sizeof (struct in6_addr));
2308                   /* TBD: populate __addr_len */
2309                   if (__addr_len)
2310                     {
2311                       *__addr_len = sizeof (struct sockaddr_in6);
2312                     }
2313                   break;
2314
2315                 default:
2316                   return -EAFNOSUPPORT;
2317                 }
2318             }
2319           else
2320             {
2321               switch (ep.is_ip4)
2322                 {
2323                 case VPPCOM_IS_IP4:
2324                   ((struct sockaddr_in *) __addr)->sin_family = AF_INET;
2325                   ((struct sockaddr_in *) __addr)->sin_port = ep.port;
2326                   memcpy (&((struct sockaddr_in *) __addr)->sin_addr,
2327                           addr8, sizeof (struct in_addr));
2328                   /* TBD: populate __addr_len */
2329                   if (__addr_len)
2330                     {
2331                       *__addr_len = sizeof (struct sockaddr_in);
2332                     }
2333                   break;
2334
2335                 case VPPCOM_IS_IP6:
2336                   ((struct sockaddr_in6 *) __addr)->sin6_family = AF_INET6;
2337                   ((struct sockaddr_in6 *) __addr)->sin6_port = ep.port;
2338                   memcpy (((struct sockaddr_in6 *) __addr)->sin6_addr.
2339                           __in6_u.__u6_addr8, addr8,
2340                           sizeof (struct in6_addr));
2341                   /* TBD: populate __addr_len */
2342                   if (__addr_len)
2343                     {
2344                       *__addr_len = sizeof (struct sockaddr_in6);
2345                     }
2346                   break;
2347
2348                 default:
2349                   return -EAFNOSUPPORT;
2350                 }
2351             }
2352         }
2353       else
2354         {
2355           /* when __addr is NULL, nothing is filled in,
2356            * in this case, __addr_len is not used,
2357            * and should also be null
2358            * */
2359           if (__addr_len)
2360             {
2361               /* TBD: return proper error code */
2362               return -1;
2363             }
2364         }
2365     }
2366
2367   return rv;
2368 }
2369
2370 int
2371 vcom_socket_accept (int __fd, __SOCKADDR_ARG __addr,
2372                     socklen_t * __restrict __addr_len)
2373 {
2374   /* set flags to 0 for accept() */
2375   return vcom_socket_accept_flags (__fd, __addr, __addr_len, 0);
2376 }
2377
2378 #ifdef __USE_GNU
2379 int
2380 vcom_socket_accept4 (int __fd, __SOCKADDR_ARG __addr,
2381                      socklen_t * __restrict __addr_len, int __flags)
2382 {
2383   /*  SOCK_NONBLOCK and SOCK_CLOEXEC can be bitwise ORed in flags */
2384   return vcom_socket_accept_flags (__fd, __addr, __addr_len, __flags);
2385 }
2386 #endif
2387
2388 /* TBD: move it to vppcom */
2389 int
2390 vppcom_session_shutdown (int __fd, int __how)
2391 {
2392   return 0;
2393 }
2394
2395 int
2396 vcom_socket_shutdown (int __fd, int __how)
2397 {
2398   int rv = -1;
2399   vcom_socket_main_t *vsm = &vcom_socket_main;
2400   uword *p;
2401   vcom_socket_t *vsock;
2402
2403   p = hash_get (vsm->sockidx_by_fd, __fd);
2404   if (p)
2405     {
2406       vsock = pool_elt_at_index (vsm->vsockets, p[0]);
2407       switch (__how)
2408         {
2409         case SHUT_RD:
2410         case SHUT_WR:
2411         case SHUT_RDWR:
2412           rv = vppcom_session_shutdown (vsock->sid, __how);
2413           return rv;
2414           break;
2415
2416         default:
2417           return -EINVAL;
2418           break;
2419         }
2420     }
2421
2422   return rv;
2423 }
2424
2425 int
2426 vcom_socket_epoll_create1 (int __flags)
2427 {
2428   int rv = -1;
2429   vcom_socket_main_t *vsm = &vcom_socket_main;
2430   vcom_epoll_t *vepoll;
2431
2432   i32 epfd;
2433   i32 vep_idx;
2434   i32 epollidx;
2435
2436   epfd = vcom_socket_open_epoll (__flags);
2437   if (epfd < 0)
2438     {
2439       rv = epfd;
2440       goto out;
2441     }
2442
2443   vep_idx = vppcom_epoll_create ();
2444   if (vep_idx < 0)
2445     {
2446       rv = vep_idx;
2447       goto out_close_epoll;
2448     }
2449
2450   pool_get (vsm->vepolls, vepoll);
2451   vepoll_init (vepoll);
2452
2453   epollidx = vepoll - vsm->vepolls;
2454   hash_set (vsm->epollidx_by_epfd, epfd, epollidx);
2455
2456   vepoll_set (vepoll, epfd, vep_idx, EPOLL_TYPE_VPPCOM_BOUND, __flags, 0, 0);
2457
2458   return epfd;
2459
2460 out_close_epoll:
2461   vcom_socket_close_epoll (epfd);
2462 out:
2463   return rv;
2464 }
2465
2466 /*
2467  * PRE: vppcom_epoll_ctl() is successful
2468  * free_vepitem_on_del : 0 - no_pool_put, 1 - pool_put
2469  */
2470 int
2471 vcom_socket_ctl_vepitem (int __epfd, int __op, int __fd,
2472                          struct epoll_event *__event,
2473                          i32 vep_idx, vcom_epoll_t * vepoll,
2474                          i32 vfd_id, void *vfd, vcom_fd_type_t type,
2475                          int free_vepitem_on_del)
2476 {
2477   int rv = -1;
2478   vcom_socket_main_t *vsm = &vcom_socket_main;
2479   vcom_epitem_t *vepitem;
2480
2481   vcom_epitem_key_t epfdfd = {.epfd = __epfd,.fd = __fd };
2482   uword *p;
2483   i32 vepitemidx;
2484
2485   i32 *vepitemidxs = 0;
2486
2487   struct epoll_event revent = {.events = 0,.data.fd = INVALID_FD };
2488
2489   i32 vec_idx;
2490
2491   /* perform control operations on the epoll instance */
2492   switch (__op)
2493     {
2494     case EPOLL_CTL_ADD:
2495       /*
2496        * supplied file descriptor is already
2497        * registered with this epoll instance
2498        * */
2499       /* vepitem exists */
2500       p = hash_get (vsm->epitemidx_by_epfdfd, epfdfd.key);
2501       if (p)
2502         {
2503           rv = -EEXIST;
2504           goto out;
2505         }
2506
2507       /* add a new vepitem */
2508       pool_get (vsm->vepitems, vepitem);
2509       vepitem_init (vepitem);
2510
2511       vepitemidx = vepitem - vsm->vepitems;
2512       hash_set (vsm->epitemidx_by_epfdfd, epfdfd.key, vepitemidx);
2513       vepitem_set (vepitem, __epfd, __fd, __fd, __fd, type, *__event, revent);
2514
2515       /* update epitemidxs */
2516       /* by_epfd */
2517       p = hash_get (vsm->epitemidxs_by_epfd, __epfd);
2518       if (!p)                   /*  not exist */
2519         {
2520           vepitemidxs = 0;
2521           vec_add1 (vepitemidxs, vepitemidx);
2522           hash_set (vsm->epitemidxs_by_epfd, __epfd, vepitemidxs);
2523         }
2524       else                      /*  exists */
2525         {
2526           vepitemidxs = *(i32 **) p;
2527           vec_add1 (vepitemidxs, vepitemidx);
2528           hash_set3 (vsm->epitemidxs_by_epfd, __epfd, vepitemidxs, 0);
2529         }
2530       /* update epitemidxs */
2531       /* by_fd */
2532       p = hash_get (vsm->epitemidxs_by_fd, __fd);
2533       if (!p)                   /*  not exist */
2534         {
2535           vepitemidxs = 0;
2536           vec_add1 (vepitemidxs, vepitemidx);
2537           hash_set (vsm->epitemidxs_by_fd, __fd, vepitemidxs);
2538         }
2539       else                      /*  exists */
2540         {
2541           vepitemidxs = *(i32 **) p;
2542           vec_add1 (vepitemidxs, vepitemidx);
2543           hash_set3 (vsm->epitemidxs_by_fd, __fd, vepitemidxs, 0);
2544         }
2545
2546       /* increment vepoll fd count by 1 */
2547       vepoll->count += 1;
2548
2549       rv = 0;
2550       goto out;
2551       break;
2552
2553     case EPOLL_CTL_MOD:
2554       /*
2555        * supplied file descriptor is not
2556        * registered with this epoll instance
2557        * */
2558       /* vepitem not exist */
2559       p = hash_get (vsm->epitemidx_by_epfdfd, epfdfd.key);
2560       if (!p)
2561         {
2562           rv = -ENOENT;
2563           goto out;
2564         }
2565       vepitem = pool_elt_at_index (vsm->vepitems, p[0]);
2566       if (vepitem)
2567         {
2568           vepitem->event = *__event;
2569           vepitem->revent = revent;
2570         }
2571
2572       rv = 0;
2573       goto out;
2574       break;
2575
2576     case EPOLL_CTL_DEL:
2577       /*
2578        * supplied file descriptor is not
2579        * registered with this epoll instance
2580        * */
2581       /* vepitem not exist */
2582       p = hash_get (vsm->epitemidx_by_epfdfd, epfdfd.key);
2583       if (!p)
2584         {
2585           rv = -ENOENT;
2586           goto out;
2587         }
2588       vepitemidx = *(i32 *) p;
2589       hash_unset (vsm->epitemidx_by_epfdfd, epfdfd.key);
2590
2591       /* update epitemidxs */
2592       /* by_epfd */
2593       p = hash_get (vsm->epitemidxs_by_epfd, __epfd);
2594       if (!p)                   /*  not exist */
2595         {
2596           rv = -ENOENT;
2597           goto out;
2598         }
2599       else                      /*  exists */
2600         {
2601           vepitemidxs = *(i32 **) p;
2602           vec_idx = vec_search (vepitemidxs, vepitemidx);
2603           if (vec_idx != ~0)
2604             {
2605               vec_del1 (vepitemidxs, vec_idx);
2606               if (!vec_len (vepitemidxs))
2607                 {
2608                   vec_free (vepitemidxs);
2609                   hash_unset (vsm->epitemidxs_by_epfd, __epfd);
2610                 }
2611             }
2612         }
2613
2614       /* update epitemidxs */
2615       /* by_fd */
2616       p = hash_get (vsm->epitemidxs_by_fd, __fd);
2617       if (!p)                   /*  not exist */
2618         {
2619           rv = -ENOENT;
2620           goto out;
2621         }
2622       else                      /*  exists */
2623         {
2624           vepitemidxs = *(i32 **) p;
2625           vec_idx = vec_search (vepitemidxs, vepitemidx);
2626           if (vec_idx != ~0)
2627             {
2628               vec_del1 (vepitemidxs, vec_idx);
2629               if (!vec_len (vepitemidxs))
2630                 {
2631                   vec_free (vepitemidxs);
2632                   hash_unset (vsm->epitemidxs_by_fd, __fd);
2633                 }
2634             }
2635         }
2636
2637       /* pool put vepitem */
2638       vepitem = pool_elt_at_index (vsm->vepitems, vepitemidx);
2639       if (free_vepitem_on_del)
2640         {
2641           if (!vepitem)
2642             {
2643               rv = -ENOENT;
2644               goto out;
2645             }
2646           vepitem_init (vepitem);
2647           pool_put (vsm->vepitems, vepitem);
2648         }
2649       else
2650         {
2651           if (!vepitem)
2652             {
2653               vepitem_init (vepitem);
2654             }
2655         }
2656
2657       /* decrement vepoll fd count by 1 */
2658       vepoll->count -= 1;
2659
2660       rv = 0;
2661       goto out;
2662       break;
2663
2664     default:
2665       rv = -EINVAL;
2666       goto out;
2667       break;
2668     }
2669
2670 out:
2671   return rv;
2672 }
2673
2674 /*
2675  * PRE: 00. null pointer check on __event
2676  *      01. all other parameters are validated
2677  */
2678
2679 static int
2680 vcom_socket_epoll_ctl_internal (int __epfd, int __op, int __fd,
2681                                 struct epoll_event *__event,
2682                                 int free_vepitem_on_del)
2683 {
2684   int rv = -1;
2685
2686   /* vcom_socket_main_t *vsm = &vcom_socket_main; */
2687   vcom_epoll_t *vepoll;
2688
2689   /*__fd could could be vcom socket or vcom epoll or kernel fd */
2690   void *vfd;
2691   vcom_epoll_t *vfd_vepoll;
2692   vcom_socket_t *vfd_vsock;
2693
2694   i32 vep_idx;
2695   i32 vfd_id;
2696
2697   vcom_fd_type_t type = FD_TYPE_INVALID;
2698
2699   /* validate __event */
2700
2701   /* get vep_idx and vepoll */
2702   vep_idx = vcom_socket_get_vep_idx_and_vepoll (__epfd, &vepoll);
2703   if (vep_idx == INVALID_VEP_IDX)
2704     {
2705       return -EBADF;
2706     }
2707
2708   /* get vcom fd type, vfd_id and vfd */
2709   vfd_id = vcom_socket_get_sid_and_vsock (__fd, &vfd_vsock);
2710   if (vfd_id != INVALID_SESSION_ID)
2711     {
2712       type = FD_TYPE_VCOM_SOCKET;
2713       vfd = vfd_vsock;
2714     }
2715   else if ((vfd_id = vcom_socket_get_vep_idx_and_vepoll (__fd, &vfd_vepoll))
2716            != INVALID_VEP_IDX)
2717     {
2718       type = FD_TYPE_EPOLL;
2719       vfd = vfd_vepoll;
2720     }
2721   else
2722     {
2723       /* FD_TYPE_KERNEL not supported by epoll instance */
2724       type = FD_TYPE_INVALID;
2725       return -EBADF;
2726     }
2727
2728
2729   /* vepoll and vsock are now valid */
2730   rv = vppcom_epoll_ctl (vep_idx, __op, vfd_id, __event);
2731   if (rv < 0)
2732     {
2733       return rv;
2734     }
2735
2736   rv = vcom_socket_ctl_vepitem (__epfd, __op, __fd,
2737                                 __event,
2738                                 vep_idx, vepoll,
2739                                 vfd_id, vfd, type, free_vepitem_on_del);
2740   return rv;
2741 }
2742
2743 int
2744 vcom_socket_epoll_ctl (int __epfd, int __op, int __fd,
2745                        struct epoll_event *__event)
2746 {
2747   int rv = -1;
2748
2749   rv = vcom_socket_epoll_ctl_internal (__epfd, __op, __fd, __event, 1);
2750   return rv;
2751 }
2752
2753 static int
2754 vcom_socket_epoll_ctl1 (int __epfd, int __op, int __fd,
2755                         struct epoll_event *__event)
2756 {
2757   int rv = -1;
2758
2759   rv = vcom_socket_epoll_ctl_internal (__epfd, __op, __fd, __event, 0);
2760   return rv;
2761 }
2762
2763 int
2764 vcom_socket_epoll_pwait (int __epfd, struct epoll_event *__events,
2765                          int __maxevents, int __timeout,
2766                          const __sigset_t * __ss)
2767 {
2768   int rv = -EBADF;
2769
2770   /* in seconds eg. 3.123456789 seconds */
2771   double time_to_wait = (double) 0;
2772
2773   i32 vep_idx;
2774
2775   /* validate __event */
2776   if (!__events)
2777     {
2778       rv = -EFAULT;
2779       goto out;
2780     }
2781
2782   /* validate __timeout */
2783   if (__timeout > 0)
2784     {
2785       time_to_wait = (double) __timeout / (double) 1000;
2786     }
2787   else if (__timeout == 0)
2788     {
2789       time_to_wait = (double) 0;
2790     }
2791   else if (__timeout == -1)
2792     {
2793       time_to_wait = ~0;
2794     }
2795   else
2796     {
2797       rv = -EBADF;
2798       goto out;
2799     }
2800
2801   /* get vep_idx */
2802   vep_idx = vcom_socket_get_vep_idx (__epfd);
2803   if (vep_idx != INVALID_VEP_IDX)
2804     {
2805       rv = vppcom_epoll_wait (vep_idx, __events, __maxevents, time_to_wait);
2806     }
2807 out:
2808   return rv;
2809 }
2810
2811 int
2812 vcom_socket_main_init (void)
2813 {
2814   vcom_socket_main_t *vsm = &vcom_socket_main;
2815
2816   if (VCOM_DEBUG > 0)
2817     printf ("vcom_socket_main_init\n");
2818
2819   if (!vsm->init)
2820     {
2821       /* TBD: define FD_MAXSIZE and use it here */
2822       pool_alloc (vsm->vsockets, FD_SETSIZE);
2823       vsm->sockidx_by_fd = hash_create (0, sizeof (i32));
2824
2825       pool_alloc (vsm->vepolls, FD_SETSIZE);
2826       vsm->epollidx_by_epfd = hash_create (0, sizeof (i32));
2827
2828       pool_alloc (vsm->vepitems, FD_SETSIZE);
2829       vsm->epitemidx_by_epfdfd = hash_create (0, sizeof (i32));
2830
2831       vsm->epitemidxs_by_epfd = hash_create (0, sizeof (i32 *));
2832       vsm->epitemidxs_by_fd = hash_create (0, sizeof (i32 *));
2833
2834       vsm->init = 1;
2835     }
2836
2837   return 0;
2838 }
2839
2840
2841 void
2842 vcom_socket_main_show (void)
2843 {
2844   vcom_socket_main_t *vsm = &vcom_socket_main;
2845   vcom_socket_t *vsock;
2846
2847   vcom_epoll_t *vepoll;
2848
2849   vcom_epitem_t *vepitem;
2850
2851   i32 epfd;
2852   i32 fd;
2853   i32 *vepitemidxs, *vepitemidxs_var;
2854
2855   if (vsm->init)
2856     {
2857       /* from active list of vsockets show vsock */
2858
2859       /* *INDENT-OFF* */
2860       pool_foreach (vsock, vsm->vsockets,
2861         ({
2862           printf(
2863                  "fd='%04d', sid='%08x',type='%-30s'\n",
2864                  vsock->fd, vsock->sid,
2865                  vcom_socket_type_str (vsock->type));
2866         }));
2867       /* *INDENT-ON* */
2868
2869       /* from active list of vepolls, show vepoll */
2870
2871       /* *INDENT-OFF* */
2872       pool_foreach (vepoll, vsm->vepolls,
2873         ({
2874           printf(
2875                  "epfd='%04d', vep_idx='%08x', "
2876                  "type='%-30s', "
2877                  "flags='%d', count='%d', close='%d'\n",
2878                  vepoll->epfd, vepoll->vep_idx,
2879                  vcom_socket_epoll_type_str (vepoll->type),
2880                  vepoll->flags, vepoll->count, vepoll->close);
2881         }));
2882       /* *INDENT-ON* */
2883
2884       /* from active list of vepitems, show vepitem */
2885
2886       /* *INDENT-OFF* */
2887       pool_foreach (vepitem, vsm->vepitems,
2888         ({
2889           printf(
2890                  "epfd='%04d', fd='%04d', "
2891                  "next_fd='%04d', prev_fd='%04d', "
2892                  "type='%-30s', "
2893                  "events='%04x', revents='%04x'\n",
2894                  vepitem->epfd, vepitem->fd,
2895                  vepitem->next_fd, vepitem->prev_fd,
2896                  vcom_socket_vcom_fd_type_str (vepitem->type),
2897                  vepitem->event.events, vepitem->revent.events);
2898         }));
2899
2900       /* *INDENT-ON* */
2901
2902       /* show epitemidxs for epfd */
2903       /* *INDENT-OFF* */
2904       hash_foreach (epfd, vepitemidxs,
2905                     vsm->epitemidxs_by_epfd,
2906       ({
2907         printf("\n[ '%04d': ", epfd);
2908         vec_foreach (vepitemidxs_var,vepitemidxs)
2909         {
2910           printf("'%04d' ", (int)vepitemidxs_var[0]);
2911         }
2912         printf("]\n");
2913       }));
2914       /* *INDENT-ON* */
2915
2916       /* show epitemidxs for fd */
2917       /* *INDENT-OFF* */
2918       hash_foreach (fd, vepitemidxs,
2919                     vsm->epitemidxs_by_fd,
2920       ({
2921         printf("\n{ '%04d': ", fd);
2922         vec_foreach (vepitemidxs_var,vepitemidxs)
2923         {
2924           printf("'%04d' ", (int)vepitemidxs_var[0]);
2925         }
2926         printf("}\n");
2927       }));
2928       /* *INDENT-ON* */
2929
2930     }
2931 }
2932
2933 void
2934 vcom_socket_main_destroy (void)
2935 {
2936   vcom_socket_main_t *vsm = &vcom_socket_main;
2937   vcom_socket_t *vsock;
2938
2939   vcom_epoll_t *vepoll;
2940
2941   vcom_epitem_t *vepitem;
2942
2943   i32 epfd;
2944   i32 fd;
2945   i32 *vepitemidxs;
2946
2947
2948   if (VCOM_DEBUG > 0)
2949     printf ("vcom_socket_main_destroy\n");
2950
2951   if (vsm->init)
2952     {
2953
2954       /*
2955        * from active list of vepitems,
2956        * remove all "vepitem" elements from the pool in a safe way
2957        * */
2958
2959       /* *INDENT-OFF* */
2960       pool_flush (vepitem, vsm->vepitems,
2961         ({
2962           if (vepitem->type == FD_TYPE_EPOLL || FD_TYPE_VCOM_SOCKET)
2963           {
2964               vcom_socket_epoll_ctl1 (vepitem->epfd, EPOLL_CTL_DEL,
2965                                      vepitem->fd, NULL);
2966              vepitem_init (vepitem);
2967           }
2968         }));
2969       /* *INDENT-ON* */
2970
2971       pool_free (vsm->vepitems);
2972       hash_free (vsm->epitemidx_by_epfdfd);
2973
2974       /* free vepitemidxs for each epfd */
2975       /* *INDENT-OFF* */
2976       hash_foreach (epfd, vepitemidxs,
2977                     vsm->epitemidxs_by_epfd,
2978       ({
2979         vec_free (vepitemidxs);
2980       }));
2981       /* *INDENT-ON* */
2982       hash_free (vsm->epitemidxs_by_epfd);
2983
2984       /* free vepitemidxs for each fd */
2985       /* *INDENT-OFF* */
2986       hash_foreach (fd, vepitemidxs,
2987                     vsm->epitemidxs_by_fd,
2988       ({
2989         vec_free (vepitemidxs);
2990       }));
2991       /* *INDENT-ON* */
2992       hash_free (vsm->epitemidxs_by_fd);
2993
2994
2995       /*
2996        * from active list of vsockets,
2997        * close socket and vppcom session
2998        * */
2999
3000       /* *INDENT-OFF* */
3001       pool_foreach (vsock, vsm->vsockets,
3002         ({
3003           if (vsock->type == SOCKET_TYPE_VPPCOM_BOUND)
3004             {
3005               vppcom_session_close (vsock->sid);
3006               vcom_socket_close_socket (vsock->fd);
3007               vsocket_init (vsock);
3008             }
3009         }));
3010       /* *INDENT-ON* */
3011
3012       /*
3013        * return vsocket element to the pool
3014        * */
3015
3016       /* *INDENT-OFF* */
3017       pool_flush (vsock, vsm->vsockets,
3018         ({
3019           // vsocket_init(vsock);
3020           ;
3021         }));
3022       /* *INDENT-ON* */
3023
3024       pool_free (vsm->vsockets);
3025       hash_free (vsm->sockidx_by_fd);
3026
3027       /*
3028        * from active list of vepolls,
3029        * close epoll and vppcom_epoll
3030        * */
3031
3032       /* *INDENT-OFF* */
3033       pool_foreach (vepoll, vsm->vepolls,
3034         ({
3035           if (vepoll->type == EPOLL_TYPE_VPPCOM_BOUND)
3036             {
3037               vppcom_session_close (vepoll->vep_idx);
3038               vcom_socket_close_epoll (vepoll->epfd); /* TBD: */
3039               vepoll_init (vepoll);
3040             }
3041         }));
3042       /* *INDENT-ON* */
3043
3044       /*
3045        * return vepoll element to the pool
3046        * */
3047
3048       /* *INDENT-OFF* */
3049       pool_flush (vepoll, vsm->vepolls,
3050         ({
3051           // vepoll_init(vepoll);
3052           ;
3053         }));
3054       /* *INDENT-ON* */
3055
3056       pool_free (vsm->vepolls);
3057       hash_free (vsm->epollidx_by_epfd);
3058
3059       vsm->init = 0;
3060     }
3061 }
3062
3063
3064 /*
3065  * fd.io coding-style-patch-verification: ON
3066  *
3067  * Local Variables:
3068  * eval: (c-set-style "gnu")
3069  * End:
3070  */