]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
ce04c33d | 2 | * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Nicira, Inc. |
064af421 | 3 | * |
a14bc59f BP |
4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
5 | * you may not use this file except in compliance with the License. | |
6 | * You may obtain a copy of the License at: | |
064af421 | 7 | * |
a14bc59f BP |
8 | * http://www.apache.org/licenses/LICENSE-2.0 |
9 | * | |
10 | * Unless required by applicable law or agreed to in writing, software | |
11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
13 | * See the License for the specific language governing permissions and | |
14 | * limitations under the License. | |
064af421 BP |
15 | */ |
16 | ||
17 | #ifndef SOCKET_UTIL_H | |
18 | #define SOCKET_UTIL_H 1 | |
19 | ||
0f0b5401 | 20 | #include <errno.h> |
064af421 | 21 | #include <sys/types.h> |
8e47be77 | 22 | #include <sys/socket.h> |
72af4a85 | 23 | #include <sys/time.h> |
dd23522f | 24 | #include <sys/un.h> |
064af421 BP |
25 | #include <netinet/in.h> |
26 | #include <stdbool.h> | |
dbba996b | 27 | #include "openvswitch/types.h" |
14235530 | 28 | #include <netinet/in_systm.h> |
f125905c | 29 | #include <netinet/ip.h> |
064af421 | 30 | |
fd245f1d BP |
31 | struct ds; |
32 | ||
064af421 | 33 | int set_nonblocking(int fd); |
a0505c49 | 34 | void xset_nonblocking(int fd); |
b7cefbf7 | 35 | void setsockopt_tcp_nodelay(int fd); |
afc1d536 | 36 | int set_dscp(int fd, int family, uint8_t dscp); |
a0505c49 | 37 | |
9835576b | 38 | bool addr_is_ipv6(const char *host_name); |
064af421 | 39 | int lookup_ip(const char *host_name, struct in_addr *address); |
d31f1109 | 40 | int lookup_ipv6(const char *host_name, struct in6_addr *address); |
13f2ef97 BP |
41 | |
42 | int lookup_hostname(const char *host_name, struct in_addr *); | |
43 | ||
c1c19657 | 44 | int get_socket_rcvbuf(int sock); |
064af421 | 45 | int check_connection_completion(int fd); |
064af421 | 46 | void drain_fd(int fd, size_t n_packets); |
dbba996b | 47 | ovs_be32 guess_netmask(ovs_be32 ip); |
064af421 | 48 | |
0b043300 BP |
49 | void inet_parse_host_port_tokens(char *s, char **hostp, char **portp); |
50 | void inet_parse_port_host_tokens(char *s, char **portp, char **hostp); | |
1bb01121 | 51 | bool inet_parse_active(const char *target, int default_port, |
f31b8ae7 | 52 | struct sockaddr_storage *ssp, bool resolve_host); |
1bb01121 | 53 | int inet_open_active(int style, const char *target, int default_port, |
e731d71b | 54 | struct sockaddr_storage *ssp, int *fdp, uint8_t dscp); |
d98fa503 | 55 | |
995337c4 | 56 | bool inet_parse_passive(const char *target, int default_port, |
e731d71b | 57 | struct sockaddr_storage *ssp); |
36775dad | 58 | int inet_open_passive(int style, const char *target, int default_port, |
b52ecd96 GS |
59 | struct sockaddr_storage *ssp, uint8_t dscp, |
60 | bool kernel_print_port); | |
78ff0270 | 61 | |
3a974b92 BP |
62 | bool inet_parse_address(const char *target, struct sockaddr_storage *); |
63 | ||
064af421 BP |
64 | int read_fully(int fd, void *, size_t, size_t *bytes_read); |
65 | int write_fully(int fd, const void *, size_t, size_t *bytes_written); | |
66 | ||
8e71cf88 | 67 | int fsync_parent_dir(const char *file_name); |
26efd256 | 68 | int get_mtime(const char *file_name, struct timespec *mtime); |
8e71cf88 | 69 | |
f89ffb0e BP |
70 | char *describe_fd(int fd); |
71 | ||
f125905c MM |
72 | /* Default value of dscp bits for connection between controller and manager. |
73 | * Value of IPTOS_PREC_INTERNETCONTROL = 0xc0 which is defined | |
cea15768 EJ |
74 | * in <netinet/ip.h> is used. */ |
75 | #define DSCP_DEFAULT (IPTOS_PREC_INTERNETCONTROL >> 2) | |
f125905c | 76 | |
93b7faf1 BP |
77 | /* Functions for working with sockaddr that might contain an IPv4 or |
78 | * IPv6 address. */ | |
79 | bool sa_is_ip(const struct sockaddr *); | |
80 | uint16_t sa_get_port(const struct sockaddr *); | |
81 | struct in6_addr sa_get_address(const struct sockaddr *); | |
82 | void sa_format_address(const struct sockaddr *, struct ds *); | |
83 | void sa_format_address_nobracks(const struct sockaddr *, struct ds *); | |
84 | size_t sa_length(const struct sockaddr *); | |
85 | ||
e731d71b AS |
86 | /* Functions for working with sockaddr_storage that might contain an IPv4 or |
87 | * IPv6 address. */ | |
93b7faf1 | 88 | bool ss_is_ip(const struct sockaddr_storage *); |
e731d71b | 89 | uint16_t ss_get_port(const struct sockaddr_storage *); |
93b7faf1 | 90 | struct in6_addr ss_get_address(const struct sockaddr_storage *); |
fd245f1d | 91 | void ss_format_address(const struct sockaddr_storage *, struct ds *); |
51b8505b | 92 | void ss_format_address_nobracks(const struct sockaddr_storage *, struct ds *); |
e731d71b | 93 | size_t ss_length(const struct sockaddr_storage *); |
93b7faf1 | 94 | |
b26f46a4 | 95 | const char *sock_strerror(int error); |
e731d71b | 96 | |
7f1e1c7f GS |
97 | #ifndef _WIN32 |
98 | void xpipe(int fds[2]); | |
99 | void xpipe_nonblocking(int fds[2]); | |
100 | ||
101 | int drain_rcvbuf(int fd); | |
102 | ||
103 | int make_unix_socket(int style, bool nonblock, | |
104 | const char *bind_path, const char *connect_path); | |
dd23522f | 105 | int get_unix_name_len(const struct sockaddr_un *sun, socklen_t sun_len); |
7f1e1c7f | 106 | |
b9b7b989 | 107 | /* Universal sendmmsg and recvmmsg support on Linux. |
8a8c1b93 | 108 | * |
b9b7b989 BP |
109 | * New enough Linux supports sendmmsg and recvmmsg, but older versions do not. |
110 | * We add the following infrastructure to allow all code on Linux to use | |
111 | * sendmmsg and recvmmsg, regardless of platform support: | |
8a8c1b93 | 112 | * |
b9018984 | 113 | * - For platforms that lack these functions entirely, we emulate them. |
8a8c1b93 | 114 | * |
b9b7b989 BP |
115 | * - With newer glibc but an old kernel, sendmmsg() and recvmmsg() fail with |
116 | * ENOSYS. To compensate, even if these functions appear to be available, we | |
117 | * wrap them with handlers that use our emulation in this case. | |
8a8c1b93 | 118 | */ |
b9b7b989 | 119 | #ifdef __linux__ |
8a8c1b93 BP |
120 | #ifndef HAVE_STRUCT_MMSGHDR_MSG_LEN |
121 | struct mmsghdr { | |
122 | struct msghdr msg_hdr; | |
123 | unsigned int msg_len; | |
124 | }; | |
125 | #endif | |
b9b7b989 | 126 | |
8a8c1b93 BP |
127 | #ifndef HAVE_SENDMMSG |
128 | int sendmmsg(int, struct mmsghdr *, unsigned int, unsigned int); | |
b9018984 | 129 | int recvmmsg(int, struct mmsghdr *, unsigned int, int, struct timespec *); |
8a8c1b93 BP |
130 | #else |
131 | #define sendmmsg wrap_sendmmsg | |
132 | int wrap_sendmmsg(int, struct mmsghdr *, unsigned int, unsigned int); | |
b9018984 BP |
133 | #define recvmmsg wrap_recvmmsg |
134 | int wrap_recvmmsg(int, struct mmsghdr *, unsigned int, int, struct timespec *); | |
8a8c1b93 | 135 | #endif |
b9b7b989 | 136 | #endif /* __linux__ */ |
8a8c1b93 | 137 | |
7f1e1c7f GS |
138 | /* Helpers for calling ioctl() on an AF_INET socket. */ |
139 | struct ifreq; | |
140 | int af_inet_ioctl(unsigned long int command, const void *arg); | |
141 | int af_inet_ifreq_ioctl(const char *name, struct ifreq *, | |
142 | unsigned long int cmd, const char *cmd_name); | |
143 | ||
144 | #define closesocket close | |
145 | #endif | |
146 | ||
5ea1366b | 147 | #ifdef _WIN32 |
a35f3d61 AS |
148 | static inline int make_unix_socket(int style, bool nonblock, |
149 | const char *bind_path, | |
150 | const char *connect_path) | |
151 | { | |
152 | return -EINVAL; | |
153 | } | |
154 | ||
5ea1366b GS |
155 | /* Windows defines the 'optval' argument as char * instead of void *. */ |
156 | #define setsockopt(sock, level, optname, optval, optlen) \ | |
157 | rpl_setsockopt(sock, level, optname, optval, optlen) | |
158 | static inline int rpl_setsockopt(int sock, int level, int optname, | |
159 | const void *optval, socklen_t optlen) | |
160 | { | |
8bfc3c10 | 161 | return (setsockopt)(sock, level, optname, (const char *)optval, optlen); |
5ea1366b | 162 | } |
9390ef7f GS |
163 | |
164 | #define getsockopt(sock, level, optname, optval, optlen) \ | |
165 | rpl_getsockopt(sock, level, optname, optval, optlen) | |
166 | static inline int rpl_getsockopt(int sock, int level, int optname, | |
167 | void *optval, socklen_t *optlen) | |
168 | { | |
8bfc3c10 | 169 | return (getsockopt)(sock, level, optname, (char *)optval, optlen); |
9390ef7f | 170 | } |
5ea1366b GS |
171 | #endif |
172 | ||
0f0b5401 GS |
173 | /* In Windows platform, errno is not set for socket calls. |
174 | * The last error has to be gotten from WSAGetLastError(). */ | |
175 | static inline int sock_errno(void) | |
176 | { | |
177 | #ifdef _WIN32 | |
178 | return WSAGetLastError(); | |
179 | #else | |
180 | return errno; | |
181 | #endif | |
182 | } | |
183 | ||
064af421 | 184 | #endif /* socket-util.h */ |