libosmocore 1.13.1.1-afb4 Osmocom core library

socket.h
Go to the documentation of this file.
1
4#pragma once
5
10#include <stdint.h>
11#include <stdbool.h>
12#include <stddef.h>
13
14#include <osmocom/core/defs.h>
15#include <osmocom/core/socket_compat.h>
16
18#define OSMO_SOCK_MAX_ADDRS 32
19
21#define OSMO_SOCK_NAME_MAXLEN (2 + INET6_ADDRSTRLEN + 1 + 5 + 3 + 2 + INET6_ADDRSTRLEN + 1 + 5 + 1)
22
26#define OSMO_SOCK_MULTIADDR_PEER_STR_MAXLEN (INET6_ADDRSTRLEN * OSMO_SOCK_MAX_ADDRS + INET6_ADDRSTRLEN + 2 + 6 + 1)
28#define OSMO_SOCK_MULTIADDR_NAME_MAXLEN (OSMO_SOCK_MULTIADDR_PEER_STR_MAXLEN + 7)
29
30 struct osmo_fd;
31 struct sctp_paddrinfo;
32
33 struct osmo_sockaddr {
34 union {
35 struct sockaddr sa;
36 struct sockaddr_storage sas;
37 struct sockaddr_in sin;
38 struct sockaddr_in6 sin6;
39 } u;
40};
41
42 int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen);
43 int osmo_sockaddr_is_any(const struct osmo_sockaddr *addr);
44
53 static inline socklen_t osmo_sockaddr_size(const struct osmo_sockaddr *addr)
54{
55 if (!addr)
56 return 0;
57#if __LIBOSMOCORE_HAVE_SYS_SOCKET_H
58 switch (addr->u.sa.sa_family) {
59 case AF_INET:
60 return sizeof(struct sockaddr_in);
61 case AF_INET6:
62 return sizeof(struct sockaddr_in6);
63 default:
64 return sizeof(struct osmo_sockaddr);
65 }
66#else
67 return 0;
68#endif /* if __LIBOSMOCORE_HAVE_SYS_SOCKET_H */
69}
70
71 unsigned int osmo_sockaddr_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
72 const struct sockaddr *sa);
73 size_t osmo_sockaddr_in_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
74 const struct sockaddr_in *sin);
75
76 const char *osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst);
77uint16_t osmo_sockaddr_port(const struct sockaddr *sa);
78 void osmo_sockaddr_set_port(struct sockaddr *sa, uint16_t port);
79
80 int osmo_sockaddr_local_ip(struct osmo_sockaddr *local_ip,
81 const struct osmo_sockaddr *remote_ip);
82 int osmo_sockaddr_cmp(const struct osmo_sockaddr *a,
83 const struct osmo_sockaddr *b);
84
85 int osmo_sockaddr_to_octets(uint8_t *dst, size_t dst_maxlen, const struct osmo_sockaddr *os);
86 int osmo_sockaddr_from_octets(struct osmo_sockaddr *os, const void *src, size_t src_len);
87 int osmo_sockaddr_from_str_and_uint(struct osmo_sockaddr *osa_out, const char *ipstr, uint16_t port);
88
89 int osmo_sockaddr_netmask_to_prefixlen(const struct osmo_sockaddr *addr);
90
91 const char *osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr);
92 char *osmo_sockaddr_to_str_buf(char *buf, size_t buf_len,
93 const struct osmo_sockaddr *sockaddr);
94 int osmo_sockaddr_to_str_buf2(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr);
95 char *osmo_sockaddr_to_str_c(void *ctx, const struct osmo_sockaddr *sockaddr);
96
97/* flags for osmo_sock_init. */
99#define OSMO_SOCK_F_CONNECT (1 << 0)
101#define OSMO_SOCK_F_BIND (1 << 1)
103#define OSMO_SOCK_F_NONBLOCK (1 << 2)
105#define OSMO_SOCK_F_NO_MCAST_LOOP (1 << 3)
107#define OSMO_SOCK_F_NO_MCAST_ALL (1 << 4)
109#define OSMO_SOCK_F_UDP_REUSEADDR (1 << 5)
110
112#define OSMO_SOCK_F_DSCP(x) (((x)&0x3f) << 24)
113#define GET_OSMO_SOCK_F_DSCP(f) (((f) >> 24) & 0x3f)
114
116#define OSMO_SOCK_F_PRIO(x) (((x)&0xff) << 16)
117#define GET_OSMO_SOCK_F_PRIO(f) (((f) >> 16) & 0xff)
118
119
120 int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto,
121 const char *host, uint16_t port, unsigned int flags);
122
123 int osmo_sock_init2(uint16_t family, uint16_t type, uint8_t proto,
124 const char *local_host, uint16_t local_port,
125 const char *remote_host, uint16_t remote_port, unsigned int flags);
126
127 struct osmo_sock_init2_multiaddr_pars {
128 union {
129 struct {
130 uint8_t version; /* set to 0 */
131 struct {
132 bool set;
133 bool abort_on_failure;
134 uint32_t value;
135 } sockopt_auth_supported;
136 struct {
137 bool set;
138 bool abort_on_failure;
139 uint32_t value;
140 } sockopt_asconf_supported;
141 struct {
142 bool set;
143 bool abort_on_failure;
144 bool num_ostreams_present;
145 bool max_instreams_present;
146 bool max_attempts_present;
147 bool max_init_timeo_present;
148 uint16_t num_ostreams_value;
149 uint16_t max_instreams_value;
150 uint16_t max_attempts_value;
151 uint16_t max_init_timeo_value;
152 } sockopt_initmsg;
153 } sctp;
154 };
155};
156 int osmo_sock_init2_multiaddr(uint16_t family, uint16_t type, uint8_t proto,
157 const char **local_hosts, size_t local_hosts_cnt, uint16_t local_port,
158 const char **remote_hosts, size_t remote_hosts_cnt, uint16_t remote_port, unsigned int flags)
159 OSMO_DEPRECATED_OUTSIDE("Use osmo_sock_init2_multiaddr2() instead");
160 int osmo_sock_init2_multiaddr2(uint16_t family, uint16_t type, uint8_t proto,
161 const char **local_hosts, size_t local_hosts_cnt, uint16_t local_port,
162 const char **remote_hosts, size_t remote_hosts_cnt, uint16_t remote_port,
163 unsigned int flags, struct osmo_sock_init2_multiaddr_pars *pars);
164
165 int osmo_sock_init_osa(uint16_t type, uint8_t proto,
166 const struct osmo_sockaddr *local,
167 const struct osmo_sockaddr *remote,
168 unsigned int flags);
169
170 int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto,
171 const char *host, uint16_t port, unsigned int flags);
172
173 int osmo_sock_init2_ofd(struct osmo_fd *ofd, int family, int type, int proto,
174 const char *local_host, uint16_t local_port,
175 const char *remote_host, uint16_t remote_port, unsigned int flags);
176
177 int osmo_sock_init_osa_ofd(struct osmo_fd *ofd, int type, int proto,
178 const struct osmo_sockaddr *local,
179 const struct osmo_sockaddr *remote,
180 unsigned int flags);
181
182 int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type,
183 uint8_t proto, unsigned int flags);
184
185 int osmo_sock_unix_init(uint16_t type, uint8_t proto,
186 const char *socket_path, unsigned int flags);
187
188 int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto,
189 const char *socket_path, unsigned int flags);
190
191 char *osmo_sock_get_name(const void *ctx, int fd);
192 const char *osmo_sock_get_name2(int fd);
193 char *osmo_sock_get_name2_c(const void *ctx, int fd);
194 int osmo_sock_get_name_buf(char *str, size_t str_len, int fd);
195 int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local);
196 int osmo_sock_get_local_ip(int fd, char *host, size_t len);
197 int osmo_sock_get_local_ip_port(int fd, char *port, size_t len);
198 int osmo_sock_get_remote_ip(int fd, char *host, size_t len);
199 int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len);
200
201 int osmo_sock_multiaddr_get_ip_and_port(int fd, int ip_proto, char *ip, size_t *ip_cnt, size_t ip_len,
202 char *port, size_t port_len, bool local);
203 int osmo_multiaddr_ip_and_port_snprintf(char *str, size_t str_len,
204 const char *ip, size_t ip_cnt, size_t ip_len,
205 const char *portbuf);
206 int osmo_sock_multiaddr_get_name_buf(char *str, size_t str_len, int fd, int sk_proto);
207 int osmo_sock_multiaddr_add_local_addr(int sfd, const char **addrs, size_t addrs_cnt);
208 int osmo_sock_multiaddr_del_local_addr(int sfd, const char **addrs, size_t addrs_cnt);
209
210 int osmo_sock_mcast_loop_set(int fd, bool enable);
211 int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl);
212 int osmo_sock_mcast_all_set(int fd, bool enable);
213 int osmo_sock_mcast_iface_set(int fd, const char *ifname);
214 int osmo_sock_mcast_subscribe(int fd, const char *grp_addr);
215
216 int osmo_sock_local_ip(char *local_ip, const char *remote_ip);
217
218 int osmo_sock_set_dscp(int fd, uint8_t dscp);
219 int osmo_sock_set_priority(int fd, int prio);
220 int osmo_sock_get_nonblock(int fd);
221 int osmo_sock_set_nonblock(int fd, int on);
222
223 int osmo_sock_sctp_get_peer_addr_info(int fd, struct sctp_paddrinfo *pinfo, size_t *pinfo_cnt);
224
defs.h
General definitions that are meant to be included from header files.
type
enum osmo_sub_auth_type type
len
static size_t len(const char *str)
osmo_sockaddr_cmp
int osmo_sockaddr_cmp(const struct osmo_sockaddr *a, const struct osmo_sockaddr *b)
osmo_sockaddr_in_to_str_and_uint
size_t osmo_sockaddr_in_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port, const struct sockaddr_in *sin)
osmo_sock_init_osa
int osmo_sock_init_osa(uint16_t type, uint8_t proto, const struct osmo_sockaddr *local, const struct osmo_sockaddr *remote, unsigned int flags)
osmo_sock_multiaddr_add_local_addr
int osmo_sock_multiaddr_add_local_addr(int sfd, const char **addrs, size_t addrs_cnt)
osmo_sockaddr_size
static socklen_t osmo_sockaddr_size(const struct osmo_sockaddr *addr)
Return the size of the variant used in the address NOTE: This does not return the size of the in{,...
Definition: socket.h:53
osmo_sockaddr_ntop
const char * osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst)
osmo_sock_get_local_ip
int osmo_sock_get_local_ip(int fd, char *host, size_t len)
osmo_sockaddr_set_port
void osmo_sockaddr_set_port(struct sockaddr *sa, uint16_t port)
osmo_sockaddr_to_str_buf
char * osmo_sockaddr_to_str_buf(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr)
osmo_sockaddr_to_str_c
char * osmo_sockaddr_to_str_c(void *ctx, const struct osmo_sockaddr *sockaddr)
osmo_sockaddr_port
uint16_t osmo_sockaddr_port(const struct sockaddr *sa)
osmo_sock_get_name2_c
char * osmo_sock_get_name2_c(const void *ctx, int fd)
osmo_sock_get_name
char * osmo_sock_get_name(const void *ctx, int fd)
osmo_sockaddr_local_ip
int osmo_sockaddr_local_ip(struct osmo_sockaddr *local_ip, const struct osmo_sockaddr *remote_ip)
osmo_sock_get_name_buf
int osmo_sock_get_name_buf(char *str, size_t str_len, int fd)
osmo_sockaddr_is_any
int osmo_sockaddr_is_any(const struct osmo_sockaddr *addr)
osmo_sock_set_priority
int osmo_sock_set_priority(int fd, int prio)
osmo_sock_mcast_loop_set
int osmo_sock_mcast_loop_set(int fd, bool enable)
osmo_sock_get_ip_and_port
int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local)
osmo_sock_multiaddr_del_local_addr
int osmo_sock_multiaddr_del_local_addr(int sfd, const char **addrs, size_t addrs_cnt)
osmo_sockaddr_from_str_and_uint
int osmo_sockaddr_from_str_and_uint(struct osmo_sockaddr *osa_out, const char *ipstr, uint16_t port)
osmo_sock_get_local_ip_port
int osmo_sock_get_local_ip_port(int fd, char *port, size_t len)
osmo_sock_init
int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto, const char *host, uint16_t port, unsigned int flags)
osmo_sock_init_ofd
int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto, const char *host, uint16_t port, unsigned int flags)
osmo_sock_init2_ofd
int osmo_sock_init2_ofd(struct osmo_fd *ofd, int family, int type, int proto, const char *local_host, uint16_t local_port, const char *remote_host, uint16_t remote_port, unsigned int flags)
osmo_sock_sctp_get_peer_addr_info
int osmo_sock_sctp_get_peer_addr_info(int fd, struct sctp_paddrinfo *pinfo, size_t *pinfo_cnt)
osmo_sockaddr_to_octets
int osmo_sockaddr_to_octets(uint8_t *dst, size_t dst_maxlen, const struct osmo_sockaddr *os)
osmo_multiaddr_ip_and_port_snprintf
int osmo_multiaddr_ip_and_port_snprintf(char *str, size_t str_len, const char *ip, size_t ip_cnt, size_t ip_len, const char *portbuf)
osmo_sockaddr_netmask_to_prefixlen
int osmo_sockaddr_netmask_to_prefixlen(const struct osmo_sockaddr *addr)
osmo_sockaddr_to_str
const char * osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr)
osmo_sock_get_name2
const char * osmo_sock_get_name2(int fd)
osmo_sock_get_remote_ip_port
int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len)
osmo_sock_mcast_all_set
int osmo_sock_mcast_all_set(int fd, bool enable)
osmo_sockaddr_to_str_buf2
int osmo_sockaddr_to_str_buf2(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr)
osmo_sockaddr_to_str_and_uint
unsigned int osmo_sockaddr_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port, const struct sockaddr *sa)
osmo_sockaddr_from_octets
int osmo_sockaddr_from_octets(struct osmo_sockaddr *os, const void *src, size_t src_len)
osmo_sock_multiaddr_get_ip_and_port
int osmo_sock_multiaddr_get_ip_and_port(int fd, int ip_proto, char *ip, size_t *ip_cnt, size_t ip_len, char *port, size_t port_len, bool local)
osmo_sock_init2
int osmo_sock_init2(uint16_t family, uint16_t type, uint8_t proto, const char *local_host, uint16_t local_port, const char *remote_host, uint16_t remote_port, unsigned int flags)
osmo_sock_unix_init_ofd
int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto, const char *socket_path, unsigned int flags)
osmo_sock_mcast_ttl_set
int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl)
osmo_sock_set_dscp
int osmo_sock_set_dscp(int fd, uint8_t dscp)
osmo_sock_init2_multiaddr2
int osmo_sock_init2_multiaddr2(uint16_t family, uint16_t type, uint8_t proto, const char **local_hosts, size_t local_hosts_cnt, uint16_t local_port, const char **remote_hosts, size_t remote_hosts_cnt, uint16_t remote_port, unsigned int flags, struct osmo_sock_init2_multiaddr_pars *pars)
osmo_sockaddr_is_local
int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen)
osmo_sock_init2_multiaddr
int osmo_sock_init2_multiaddr(uint16_t family, uint16_t type, uint8_t proto, const char **local_hosts, size_t local_hosts_cnt, uint16_t local_port, const char **remote_hosts, size_t remote_hosts_cnt, uint16_t remote_port, unsigned int flags) OSMO_DEPRECATED_OUTSIDE("Use osmo_sock_init2_multiaddr2() instead")
osmo_sock_get_remote_ip
int osmo_sock_get_remote_ip(int fd, char *host, size_t len)
osmo_sock_mcast_iface_set
int osmo_sock_mcast_iface_set(int fd, const char *ifname)
osmo_sock_init_osa_ofd
int osmo_sock_init_osa_ofd(struct osmo_fd *ofd, int type, int proto, const struct osmo_sockaddr *local, const struct osmo_sockaddr *remote, unsigned int flags)
osmo_sock_unix_init
int osmo_sock_unix_init(uint16_t type, uint8_t proto, const char *socket_path, unsigned int flags)
osmo_sock_init_sa
int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type, uint8_t proto, unsigned int flags)
osmo_sock_get_nonblock
int osmo_sock_get_nonblock(int fd)
osmo_sock_local_ip
int osmo_sock_local_ip(char *local_ip, const char *remote_ip)
osmo_sock_set_nonblock
int osmo_sock_set_nonblock(int fd, int on)
osmo_sock_mcast_subscribe
int osmo_sock_mcast_subscribe(int fd, const char *grp_addr)
osmo_sock_multiaddr_get_name_buf
int osmo_sock_multiaddr_get_name_buf(char *str, size_t str_len, int fd, int sk_proto)
OSMO_DEPRECATED_OUTSIDE
#define OSMO_DEPRECATED_OUTSIDE(text)
Definition: defs.h:49
socket_compat.h
host
osmo_fd
Structure representing a file dsecriptor.
Definition: select.h:31
osmo_sock_init2_multiaddr_pars
Definition: socket.h:127
osmo_sock_init2_multiaddr_pars::version
uint8_t version
Definition: socket.h:130
osmo_sock_init2_multiaddr_pars::max_init_timeo_present
bool max_init_timeo_present
Definition: socket.h:147
osmo_sock_init2_multiaddr_pars::sockopt_auth_supported
struct osmo_sock_init2_multiaddr_pars::@29::@31::@32 sockopt_auth_supported
osmo_sock_init2_multiaddr_pars::abort_on_failure
bool abort_on_failure
Definition: socket.h:133
osmo_sock_init2_multiaddr_pars::set
bool set
Definition: socket.h:132
osmo_sock_init2_multiaddr_pars::max_init_timeo_value
uint16_t max_init_timeo_value
Definition: socket.h:151
osmo_sock_init2_multiaddr_pars::max_instreams_value
uint16_t max_instreams_value
Definition: socket.h:149
osmo_sock_init2_multiaddr_pars::num_ostreams_value
uint16_t num_ostreams_value
Definition: socket.h:148
osmo_sock_init2_multiaddr_pars::max_attempts_present
bool max_attempts_present
Definition: socket.h:146
osmo_sock_init2_multiaddr_pars::value
uint32_t value
Definition: socket.h:134
osmo_sock_init2_multiaddr_pars::num_ostreams_present
bool num_ostreams_present
Definition: socket.h:144
osmo_sock_init2_multiaddr_pars::max_instreams_present
bool max_instreams_present
Definition: socket.h:145
osmo_sock_init2_multiaddr_pars::sctp
struct osmo_sock_init2_multiaddr_pars::@29::@31 sctp
osmo_sock_init2_multiaddr_pars::sockopt_asconf_supported
struct osmo_sock_init2_multiaddr_pars::@29::@31::@33 sockopt_asconf_supported
osmo_sock_init2_multiaddr_pars::max_attempts_value
uint16_t max_attempts_value
Definition: socket.h:150
osmo_sock_init2_multiaddr_pars::sockopt_initmsg
struct osmo_sock_init2_multiaddr_pars::@29::@31::@34 sockopt_initmsg
osmo_sockaddr
Definition: socket.h:33
osmo_sockaddr::sas
struct sockaddr_storage sas
Definition: socket.h:36
osmo_sockaddr::sin
struct sockaddr_in sin
Definition: socket.h:37
osmo_sockaddr::sin6
struct sockaddr_in6 sin6
Definition: socket.h:38
osmo_sockaddr::sa
struct sockaddr sa
Definition: socket.h:35
osmo_sockaddr::u
union osmo_sockaddr::@28 u