2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #define SOCKET_UTIL_H 1
20 #include <sys/types.h>
21 #include <sys/socket.h>
23 #include <netinet/in.h>
25 #include "openvswitch/types.h"
26 #include <netinet/ip.h>
28 int set_nonblocking(int fd);
29 void xset_nonblocking(int fd);
31 int get_max_fds(void);
33 int lookup_ip(const char *host_name, struct in_addr *address);
34 int lookup_ipv6(const char *host_name, struct in6_addr *address);
36 int lookup_hostname(const char *host_name, struct in_addr *);
38 int get_socket_error(int sock);
39 int get_socket_rcvbuf(int sock);
40 int check_connection_completion(int fd);
41 int drain_rcvbuf(int fd);
42 void drain_fd(int fd, size_t n_packets);
43 int make_unix_socket(int style, bool nonblock,
44 const char *bind_path, const char *connect_path);
45 int get_unix_name_len(socklen_t sun_len);
46 ovs_be32 guess_netmask(ovs_be32 ip);
47 int get_null_fd(void);
49 bool inet_parse_active(const char *target, uint16_t default_port,
50 struct sockaddr_in *sinp);
51 int inet_open_active(int style, const char *target, uint16_t default_port,
52 struct sockaddr_in *sinp, int *fdp, uint8_t dscp);
54 bool inet_parse_passive(const char *target, int default_port,
55 struct sockaddr_in *sinp);
56 int inet_open_passive(int style, const char *target, int default_port,
57 struct sockaddr_in *sinp, uint8_t dscp);
59 int read_fully(int fd, void *, size_t, size_t *bytes_read);
60 int write_fully(int fd, const void *, size_t, size_t *bytes_written);
62 int fsync_parent_dir(const char *file_name);
63 int get_mtime(const char *file_name, struct timespec *mtime);
65 void xpipe(int fds[2]);
67 char *describe_fd(int fd);
69 /* Default value of dscp bits for connection between controller and manager.
70 * Value of IPTOS_PREC_INTERNETCONTROL = 0xc0 which is defined
71 * in <netinet/ip.h> is used. */
72 #define DSCP_DEFAULT (IPTOS_PREC_INTERNETCONTROL >> 2)
74 /* Maximum number of fds that we support sending or receiving at one time
75 * across a Unix domain socket. */
76 #define SOUTIL_MAX_FDS 8
79 size_t iovec_len(const struct iovec *iovs, size_t n_iovs);
80 bool iovec_is_empty(const struct iovec *iovs, size_t n_iovs);
82 /* Functions particularly useful for Unix domain sockets. */
83 void xsocketpair(int domain, int type, int protocol, int fds[2]);
84 int send_iovec_and_fds(int sock,
85 const struct iovec *iovs, size_t n_iovs,
86 const int fds[], size_t n_fds);
87 int send_iovec_and_fds_fully(int sock,
88 const struct iovec *iovs, size_t n_iovs,
89 const int fds[], size_t n_fds,
90 size_t skip_bytes, size_t *bytes_sent);
91 int send_iovec_and_fds_fully_block(int sock,
92 const struct iovec *iovs, size_t n_iovs,
93 const int fds[], size_t n_fds);
94 int recv_data_and_fds(int sock,
95 void *data, size_t size,
96 int fds[SOUTIL_MAX_FDS], size_t *n_fdsp);
98 #endif /* socket-util.h */