vcom_socket_wrapper.h revision 34956cc3
1/*
2 * Copyright (c) 2017 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this 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
16/*
17 * Copyright (c) 2005-2008 Jelmer Vernooij <jelmer@samba.org>
18 * Copyright (C) 2006-2014 Stefan Metzmacher <metze@samba.org>
19 * Copyright (C) 2013-2014 Andreas Schneider <asn@samba.org>
20 *
21 * All rights reserved.
22 *
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
25 * are met:
26 *
27 * 1. Redistributions of source code must retain the above copyright
28 *    notice, this list of conditions and the following disclaimer.
29 *
30 * 2. Redistributions in binary form must reproduce the above copyright
31 *    notice, this list of conditions and the following disclaimer in the
32 *    documentation and/or other materials provided with the distribution.
33 *
34 * 3. Neither the name of the author nor the names of its contributors
35 *    may be used to endorse or promote products derived from this software
36 *    without specific prior written permission.
37 *
38 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
39 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
41 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
42 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
43 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
44 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
45 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
46 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
47 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48 * SUCH DAMAGE.
49 *
50 */
51
52/*
53   Socket wrapper library. Passes all socket communication over
54   unix domain sockets if the environment variable SOCKET_WRAPPER_DIR
55   is set.
56*/
57
58#ifndef included_vcom_socket_wrapper_h
59#define included_vcom_socket_wrapper_h
60
61#include <sys/types.h>
62#include <sys/socket.h>
63#include <sys/ioctl.h>
64#include <sys/select.h>
65#include <sys/epoll.h>
66#include <sys/uio.h>
67#include <stdlib.h>
68
69
70/* GCC have printf type attribute check. */
71#ifdef HAVE_FUNCTION_ATTRIBUTE_FORMAT
72#define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
73#else
74#define PRINTF_ATTRIBUTE(a,b)
75#endif /* HAVE_FUNCTION_ATTRIBUTE_FORMAT */
76
77#define HAVE_CONSTRUCTOR_ATTRIBUTE
78#ifdef HAVE_CONSTRUCTOR_ATTRIBUTE
79#define CONSTRUCTOR_ATTRIBUTE __attribute__ ((constructor))
80#else
81#define CONSTRUCTOR_ATTRIBUTE
82#endif /* HAVE_CONSTRUCTOR_ATTRIBUTE */
83
84#define HAVE_DESTRUCTOR_ATTRIBUTE
85#ifdef HAVE_DESTRUCTOR_ATTRIBUTE
86#define DESTRUCTOR_ATTRIBUTE __attribute__ ((destructor))
87#else
88#define DESTRUCTOR_ATTRIBUTE
89#endif
90
91#define HAVE_ADDRESS_SANITIZER_ATTRIBUTE
92#ifdef HAVE_ADDRESS_SANITIZER_ATTRIBUTE
93#define DO_NOT_SANITIZE_ADDRESS_ATTRIBUTE __attribute__((no_sanitize_address))
94#else
95#define DO_NOT_SANITIZE_ADDRESS_ATTRIBUTE
96#endif
97
98/*
99 * IMPORTANT
100 *
101 * Functions especially from libc need to be loaded individually, you can't load
102 * all at once or gdb will segfault at startup. The same applies to valgrind and
103 * has probably something todo with with the linker.
104 * So we need load each function at the point it is called the first time.
105 */
106#ifdef HAVE_ACCEPT4
107int
108libc_accept4 (int sockfd,
109              struct sockaddr *addr, socklen_t * addrlen, int flags);
110#else /* HAVE_ACCEPT4 */
111int libc_accept (int sockfd, struct sockaddr *addr, socklen_t * addrlen);
112#endif /* HAVE_ACCEPT4 */
113
114int libc_bind (int sockfd, const struct sockaddr *addr, socklen_t addrlen);
115
116int libc_close (int fd);
117
118int libc_connect (int sockfd, const struct sockaddr *addr, socklen_t addrlen);
119
120#if 0
121/* TBD: dup and dup2 to be implemented later */
122int libc_dup (int fd);
123
124int libc_dup2 (int oldfd, int newfd);
125#endif
126
127#ifdef HAVE_EVENTFD
128int libc_eventfd (int count, int flags);
129#endif
130
131DO_NOT_SANITIZE_ADDRESS_ATTRIBUTE int
132libc_vfcntl (int fd, int cmd, va_list ap);
133
134int libc_getpeername (int sockfd, struct sockaddr *addr, socklen_t * addrlen);
135
136int libc_getsockname (int sockfd, struct sockaddr *addr, socklen_t * addrlen);
137
138int
139libc_getsockopt (int sockfd,
140                 int level, int optname, void *optval, socklen_t * optlen);
141
142int libc_listen (int sockfd, int backlog);
143
144int libc_read (int fd, void *buf, size_t count);
145
146int libc_recv (int sockfd, void *buf, size_t len, int flags);
147
148int
149libc_recvfrom (int sockfd,
150               void *buf,
151               size_t len,
152               int flags, struct sockaddr *src_addr, socklen_t * addrlen);
153
154int libc_recvmsg (int sockfd, struct msghdr *msg, int flags);
155
156int libc_send (int sockfd, const void *buf, size_t len, int flags);
157
158int libc_sendmsg (int sockfd, const struct msghdr *msg, int flags);
159
160int
161libc_sendto (int sockfd,
162             const void *buf,
163             size_t len,
164             int flags, const struct sockaddr *dst_addr, socklen_t addrlen);
165
166int
167libc_setsockopt (int sockfd,
168                 int level, int optname, const void *optval,
169                 socklen_t optlen);
170
171int libc_socket (int domain, int type, int protocol);
172
173int libc_socketpair (int domain, int type, int protocol, int sv[2]);
174
175ssize_t libc_write (int fd, const void *buf, size_t count);
176
177int libc_shutdown (int fd, int how);
178
179int
180libc_select (int __nfds, fd_set * __restrict __readfds,
181             fd_set * __restrict __writefds,
182             fd_set * __restrict __exceptfds,
183             struct timeval *__restrict __timeout);
184
185#ifdef __USE_XOPEN2K
186int
187libc_pselect (int __nfds, fd_set * __restrict __readfds,
188              fd_set * __restrict __writefds,
189              fd_set * __restrict __exceptfds,
190              const struct timespec *__restrict __timeout,
191              const __sigset_t * __restrict __sigmask);
192#endif
193
194int libc_epoll_create (int __size);
195
196int libc_epoll_create1 (int __flags);
197
198int libc_epoll_ctl (int __epfd, int __op, int __fd,
199                    struct epoll_event *__event);
200
201int libc_epoll_wait (int __epfd, struct epoll_event *__events,
202                     int __maxevents, int __timeout);
203
204int libc_epoll_pwait (int __epfd, struct epoll_event *__events,
205                      int __maxevents, int __timeout,
206                      const __sigset_t *__ss);
207
208void swrap_constructor (void);
209
210void swrap_destructor (void);
211
212#endif /* included_vcom_socket_wrapper_h */
213
214/*
215 * fd.io coding-style-patch-verification: ON
216 *
217 * Local Variables:
218 * eval: (c-set-style "gnu")
219 * End:
220 */
221