126f730f66d9a69a271068111b73fb5523fca0e1
[sliver-openvswitch.git] / lib / socket-util.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
3  *
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:
7  *
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.
15  */
16
17 #ifndef SOCKET_UTIL_H
18 #define SOCKET_UTIL_H 1
19
20 #include <errno.h>
21 #include <sys/types.h>
22 #include <sys/socket.h>
23 #include <sys/time.h>
24 #include <netinet/in.h>
25 #include <stdbool.h>
26 #include "openvswitch/types.h"
27 #include <netinet/in_systm.h>
28 #include <netinet/ip.h>
29
30 int set_nonblocking(int fd);
31 void xset_nonblocking(int fd);
32 int set_dscp(int fd, uint8_t dscp);
33
34 int get_max_fds(void);
35
36 int lookup_ip(const char *host_name, struct in_addr *address);
37 int lookup_ipv6(const char *host_name, struct in6_addr *address);
38
39 int lookup_hostname(const char *host_name, struct in_addr *);
40
41 int get_socket_rcvbuf(int sock);
42 int check_connection_completion(int fd);
43 int drain_rcvbuf(int fd);
44 void drain_fd(int fd, size_t n_packets);
45 int make_unix_socket(int style, bool nonblock,
46                      const char *bind_path, const char *connect_path);
47 int get_unix_name_len(socklen_t sun_len);
48 ovs_be32 guess_netmask(ovs_be32 ip);
49 int get_null_fd(void);
50
51 bool inet_parse_active(const char *target, uint16_t default_port,
52                        struct sockaddr_storage *ssp);
53 int inet_open_active(int style, const char *target, uint16_t default_port,
54                      struct sockaddr_storage *ssp, int *fdp, uint8_t dscp);
55
56 bool inet_parse_passive(const char *target, int default_port,
57                         struct sockaddr_storage *ssp);
58 int inet_open_passive(int style, const char *target, int default_port,
59                       struct sockaddr_storage *ssp, uint8_t dscp);
60
61 int read_fully(int fd, void *, size_t, size_t *bytes_read);
62 int write_fully(int fd, const void *, size_t, size_t *bytes_written);
63
64 int fsync_parent_dir(const char *file_name);
65 int get_mtime(const char *file_name, struct timespec *mtime);
66
67 void xpipe(int fds[2]);
68 void xpipe_nonblocking(int fds[2]);
69
70 char *describe_fd(int fd);
71
72 /* Default value of dscp bits for connection between controller and manager.
73  * Value of IPTOS_PREC_INTERNETCONTROL = 0xc0 which is defined
74  * in <netinet/ip.h> is used. */
75 #define DSCP_DEFAULT (IPTOS_PREC_INTERNETCONTROL >> 2)
76
77 /* Helpers for calling ioctl() on an AF_INET socket. */
78 struct ifreq;
79 int af_inet_ioctl(unsigned long int command, const void *arg);
80 int af_inet_ifreq_ioctl(const char *name, struct ifreq *,
81                         unsigned long int cmd, const char *cmd_name);
82
83 /* Functions for working with sockaddr_storage that might contain an IPv4 or
84  * IPv6 address. */
85 uint16_t ss_get_port(const struct sockaddr_storage *);
86 #define SS_NTOP_BUFSIZE (1 + INET6_ADDRSTRLEN + 1)
87 char *ss_format_address(const struct sockaddr_storage *,
88                         char *buf, size_t bufsize);
89 size_t ss_length(const struct sockaddr_storage *);
90 const char *sock_strerror(int error);
91
92 #ifdef _WIN32
93 /* Windows defines the 'optval' argument as char * instead of void *. */
94 #define setsockopt(sock, level, optname, optval, optlen) \
95     rpl_setsockopt(sock, level, optname, optval, optlen)
96 static inline int rpl_setsockopt(int sock, int level, int optname,
97                                  const void *optval, socklen_t optlen)
98 {
99     return (setsockopt)(sock, level, optname, optval, optlen);
100 }
101
102 #define getsockopt(sock, level, optname, optval, optlen) \
103     rpl_getsockopt(sock, level, optname, optval, optlen)
104 static inline int rpl_getsockopt(int sock, int level, int optname,
105                                  void *optval, socklen_t *optlen)
106 {
107     return (getsockopt)(sock, level, optname, optval, optlen);
108 }
109 #endif
110
111 /* In Windows platform, errno is not set for socket calls.
112  * The last error has to be gotten from WSAGetLastError(). */
113 static inline int sock_errno(void)
114 {
115 #ifdef _WIN32
116     return WSAGetLastError();
117 #else
118     return errno;
119 #endif
120 }
121
122 #ifndef _WIN32
123 #define closesocket close
124 #endif
125
126 #endif /* socket-util.h */