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