Coverage Report

Created: 2026-05-30 06:26

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openvswitch/lib/socket-util.h
Line
Count
Source
1
/*
2
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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 <sys/un.h>
25
#include <netinet/in.h>
26
#include <stdbool.h>
27
#include "openvswitch/types.h"
28
#include <netinet/in_systm.h>
29
#include <netinet/ip.h>
30
31
struct ds;
32
33
int set_nonblocking(int fd);
34
void xset_nonblocking(int fd);
35
void setsockopt_tcp_nodelay(int fd);
36
int set_dscp(int fd, int family, uint8_t dscp);
37
38
bool addr_is_ipv6(const char *host_name);
39
int lookup_ip(const char *host_name, struct in_addr *address);
40
int lookup_ipv6(const char *host_name, struct in6_addr *address);
41
42
int lookup_hostname(const char *host_name, struct in_addr *);
43
44
int get_socket_rcvbuf(int sock);
45
int check_connection_completion(int fd);
46
void drain_fd(int fd, size_t n_packets);
47
ovs_be32 guess_netmask(ovs_be32 ip);
48
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);
51
bool inet_parse_active(const char *target, int default_port,
52
                       struct sockaddr_storage *ssp,
53
                       bool resolve_host, bool *dns_failure);
54
int inet_open_active(int style, const char *target, int default_port,
55
                     struct sockaddr_storage *ssp, int *fdp, uint8_t dscp);
56
57
bool inet_parse_passive(const char *target, int default_port,
58
                        struct sockaddr_storage *ssp,
59
                        bool resolve_host, bool *dns_failure);
60
int inet_open_passive(int style, const char *target, int default_port,
61
                      struct sockaddr_storage *ssp, uint8_t dscp,
62
                      bool kernel_print_port);
63
64
bool inet_parse_address(const char *target, struct sockaddr_storage *);
65
66
int read_fully(int fd, void *, size_t, size_t *bytes_read);
67
int write_fully(int fd, const void *, size_t, size_t *bytes_written);
68
69
int fsync_parent_dir(const char *file_name);
70
int get_mtime(const char *file_name, struct timespec *mtime);
71
72
char *describe_fd(int fd);
73
74
/* Default value of dscp bits for connection between controller and manager.
75
 * Value of IPTOS_PREC_INTERNETCONTROL = 0xc0 which is defined
76
 * in <netinet/ip.h> is used. */
77
0
#define DSCP_DEFAULT (IPTOS_PREC_INTERNETCONTROL >> 2)
78
79
/* Functions for working with sockaddr that might contain an IPv4 or
80
 * IPv6 address. */
81
bool sa_is_ip(const struct sockaddr *);
82
uint16_t sa_get_port(const struct sockaddr *);
83
struct in6_addr sa_get_address(const struct sockaddr *);
84
void sa_format_address(const struct sockaddr *, struct ds *);
85
void sa_format_address_nobracks(const struct sockaddr *, struct ds *);
86
size_t sa_length(const struct sockaddr *);
87
88
/* Functions for working with sockaddr_storage that might contain an IPv4 or
89
 * IPv6 address. */
90
bool ss_is_ip(const struct sockaddr_storage *);
91
uint16_t ss_get_port(const struct sockaddr_storage *);
92
struct in6_addr ss_get_address(const struct sockaddr_storage *);
93
void ss_format_address(const struct sockaddr_storage *, struct ds *);
94
void ss_format_address_nobracks(const struct sockaddr_storage *, struct ds *);
95
size_t ss_length(const struct sockaddr_storage *);
96
97
const char *sock_strerror(int error);
98
99
void xpipe(int fds[2]);
100
void xpipe_nonblocking(int fds[2]);
101
102
int drain_rcvbuf(int fd);
103
104
int make_unix_socket(int style, bool nonblock,
105
                     const char *bind_path, const char *connect_path);
106
int get_unix_name_len(const struct sockaddr_un *sun, socklen_t sun_len);
107
108
/* Universal sendmmsg and recvmmsg support on Linux.
109
 *
110
 * New enough Linux supports sendmmsg and recvmmsg, but older versions do not.
111
 * We add the following infrastructure to allow all code on Linux to use
112
 * sendmmsg and recvmmsg, regardless of platform support:
113
 *
114
 * - For platforms that lack these functions entirely, we emulate them.
115
 *
116
 * - With newer glibc but an old kernel, sendmmsg() and recvmmsg() fail with
117
 *   ENOSYS.  To compensate, even if these functions appear to be available, we
118
 *   wrap them with handlers that use our emulation in this case.
119
 */
120
#ifdef __linux__
121
#ifndef HAVE_STRUCT_MMSGHDR_MSG_LEN
122
struct mmsghdr {
123
    struct msghdr msg_hdr;
124
    unsigned int msg_len;
125
};
126
#endif
127
128
#ifndef HAVE_SENDMMSG
129
int sendmmsg(int, struct mmsghdr *, unsigned int, unsigned int);
130
int recvmmsg(int, struct mmsghdr *, unsigned int, int, struct timespec *);
131
#else
132
#define sendmmsg wrap_sendmmsg
133
int wrap_sendmmsg(int, struct mmsghdr *, unsigned int, unsigned int);
134
#define recvmmsg wrap_recvmmsg
135
int wrap_recvmmsg(int, struct mmsghdr *, unsigned int, int, struct timespec *);
136
#endif
137
#endif /* __linux__ */
138
139
/* Helpers for calling ioctl() on an AF_INET socket. */
140
struct ifreq;
141
int af_inet_ioctl(unsigned long int command, const void *arg);
142
int af_inet_ifreq_ioctl(const char *name, struct ifreq *,
143
                        unsigned long int cmd, const char *cmd_name);
144
145
0
#define closesocket close
146
147
static inline int sock_errno(void)
148
0
{
149
    return errno;
150
0
}
Unexecuted instantiation: jsonrpc.c:sock_errno
Unexecuted instantiation: ovs-thread.c:sock_errno
Unexecuted instantiation: poll-loop.c:sock_errno
Unexecuted instantiation: socket-util.c:sock_errno
Unexecuted instantiation: stream.c:sock_errno
Unexecuted instantiation: unixctl.c:sock_errno
Unexecuted instantiation: util.c:sock_errno
Unexecuted instantiation: vlog.c:sock_errno
Unexecuted instantiation: latch-unix.c:sock_errno
Unexecuted instantiation: socket-util-unix.c:sock_errno
Unexecuted instantiation: stream-unix.c:sock_errno
Unexecuted instantiation: stream-ssl.c:sock_errno
Unexecuted instantiation: entropy.c:sock_errno
Unexecuted instantiation: fatal-signal.c:sock_errno
Unexecuted instantiation: stream-fd.c:sock_errno
Unexecuted instantiation: stream-replay.c:sock_errno
Unexecuted instantiation: stream-tcp.c:sock_errno
Unexecuted instantiation: syslog-direct.c:sock_errno
Unexecuted instantiation: syslog-libc.c:sock_errno
Unexecuted instantiation: daemon-unix.c:sock_errno
Unexecuted instantiation: signals.c:sock_errno
Unexecuted instantiation: process.c:sock_errno
151
152
#endif /* socket-util.h */