vcom_socket_wrapper.h revision dc217c26
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/uio.h>
66#include <stdlib.h>
67
68
69/* GCC have printf type attribute check. */
70#ifdef HAVE_FUNCTION_ATTRIBUTE_FORMAT
71#define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
72#else
73#define PRINTF_ATTRIBUTE(a,b)
74#endif /* HAVE_FUNCTION_ATTRIBUTE_FORMAT */
75
76#define HAVE_CONSTRUCTOR_ATTRIBUTE
77#ifdef HAVE_CONSTRUCTOR_ATTRIBUTE
78#define CONSTRUCTOR_ATTRIBUTE __attribute__ ((constructor))
79#else
80#define CONSTRUCTOR_ATTRIBUTE
81#endif /* HAVE_CONSTRUCTOR_ATTRIBUTE */
82
83#define HAVE_DESTRUCTOR_ATTRIBUTE
84#ifdef HAVE_DESTRUCTOR_ATTRIBUTE
85#define DESTRUCTOR_ATTRIBUTE __attribute__ ((destructor))
86#else
87#define DESTRUCTOR_ATTRIBUTE
88#endif
89
90#define HAVE_ADDRESS_SANITIZER_ATTRIBUTE
91#ifdef HAVE_ADDRESS_SANITIZER_ATTRIBUTE
92#define DO_NOT_SANITIZE_ADDRESS_ATTRIBUTE __attribute__((no_sanitize_address))
93#else
94#define DO_NOT_SANITIZE_ADDRESS_ATTRIBUTE
95#endif
96
97/*
98 * IMPORTANT
99 *
100 * Functions especially from libc need to be loaded individually, you can't load
101 * all at once or gdb will segfault at startup. The same applies to valgrind and
102 * has probably something todo with with the linker.
103 * So we need load each function at the point it is called the first time.
104 */
105#ifdef HAVE_ACCEPT4
106int
107libc_accept4 (int sockfd,
108	      struct sockaddr *addr, socklen_t * addrlen, int flags);
109#else /* HAVE_ACCEPT4 */
110int libc_accept (int sockfd, struct sockaddr *addr, socklen_t * addrlen);
111#endif /* HAVE_ACCEPT4 */
112
113int libc_bind (int sockfd, const struct sockaddr *addr, socklen_t addrlen);
114
115int libc_close (int fd);
116
117int libc_connect (int sockfd, const struct sockaddr *addr, socklen_t addrlen);
118
119#if 0
120/* TBD: dup and dup2 to be implemented later */
121int libc_dup (int fd);
122
123int libc_dup2 (int oldfd, int newfd);
124#endif
125
126#ifdef HAVE_EVENTFD
127int libc_eventfd (int count, int flags);
128#endif
129
130DO_NOT_SANITIZE_ADDRESS_ATTRIBUTE int
131libc_vfcntl (int fd, int cmd, va_list ap);
132
133int libc_getpeername (int sockfd, struct sockaddr *addr, socklen_t * addrlen);
134
135int libc_getsockname (int sockfd, struct sockaddr *addr, socklen_t * addrlen);
136
137int
138libc_getsockopt (int sockfd,
139		 int level, int optname, void *optval, socklen_t * optlen);
140
141int libc_listen (int sockfd, int backlog);
142
143int libc_read (int fd, void *buf, size_t count);
144
145ssize_t libc_readv (int fd, const struct iovec *iov, int iovcnt);
146
147int libc_recv (int sockfd, void *buf, size_t len, int flags);
148
149int
150libc_recvfrom (int sockfd,
151	       void *buf,
152	       size_t len,
153	       int flags, struct sockaddr *src_addr, socklen_t * addrlen);
154
155int libc_recvmsg (int sockfd, struct msghdr *msg, int flags);
156
157int libc_send (int sockfd, const void *buf, size_t len, int flags);
158
159int libc_sendmsg (int sockfd, const struct msghdr *msg, int flags);
160
161int
162libc_sendto (int sockfd,
163	     const void *buf,
164	     size_t len,
165	     int flags, const struct sockaddr *dst_addr, socklen_t addrlen);
166
167int
168libc_setsockopt (int sockfd,
169		 int level, int optname, const void *optval,
170		 socklen_t optlen);
171
172int libc_socket (int domain, int type, int protocol);
173
174int libc_socketpair (int domain, int type, int protocol, int sv[2]);
175
176ssize_t libc_write (int fd, const void *buf, size_t count);
177
178ssize_t libc_writev (int fd, const struct iovec *iov, int iovcnt);
179
180int libc_shutdown (int fd, int how);
181
182int
183libc_select (int __nfds, fd_set * __restrict __readfds,
184	     fd_set * __restrict __writefds,
185	     fd_set * __restrict __exceptfds,
186	     struct timeval *__restrict __timeout);
187
188#ifdef __USE_XOPEN2K
189int
190libc_pselect (int __nfds, fd_set * __restrict __readfds,
191	      fd_set * __restrict __writefds,
192	      fd_set * __restrict __exceptfds,
193	      const struct timespec *__restrict __timeout,
194	      const __sigset_t * __restrict __sigmask);
195#endif
196
197void swrap_constructor (void);
198
199void swrap_destructor (void);
200
201#endif /* included_vcom_socket_wrapper_h */
202
203/*
204 * fd.io coding-style-patch-verification: ON
205 *
206 * Local Variables:
207 * eval: (c-set-style "gnu")
208 * End:
209 */
210