libosmocore  1.9.0.20-4ca0f.202310312026
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_NAME_MAXLEN (2 + INET6_ADDRSTRLEN + 1 + 5 + 3 + 2 + INET6_ADDRSTRLEN + 1 + 5 + 1)
21 
22 struct sockaddr_in;
23 struct sockaddr;
24 struct osmo_fd;
25 
26 struct osmo_sockaddr {
27  union {
28  struct sockaddr sa;
29  struct sockaddr_storage sas;
30  struct sockaddr_in sin;
31  struct sockaddr_in6 sin6;
32  } u;
33 };
34 
35 int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen);
36 int osmo_sockaddr_is_any(const struct osmo_sockaddr *addr);
37 
46 static inline socklen_t osmo_sockaddr_size(const struct osmo_sockaddr *addr)
47 {
48  if (!addr)
49  return 0;
50 
51  switch (addr->u.sa.sa_family) {
52  case AF_INET:
53  return sizeof(struct sockaddr_in);
54  case AF_INET6:
55  return sizeof(struct sockaddr_in6);
56  default:
57  return sizeof(struct osmo_sockaddr);
58  }
59 }
60 
61 unsigned int osmo_sockaddr_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
62  const struct sockaddr *sa);
63 size_t osmo_sockaddr_in_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
64  const struct sockaddr_in *sin);
65 
66 const char *osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst);
67 uint16_t osmo_sockaddr_port(const struct sockaddr *sa);
68 void osmo_sockaddr_set_port(struct sockaddr *sa, uint16_t port);
69 
71  const struct osmo_sockaddr *remote_ip);
72 int osmo_sockaddr_cmp(const struct osmo_sockaddr *a,
73  const struct osmo_sockaddr *b);
74 
75 int osmo_sockaddr_to_octets(uint8_t *dst, size_t dst_maxlen, const struct osmo_sockaddr *os);
76 int osmo_sockaddr_from_octets(struct osmo_sockaddr *os, const void *src, size_t src_len);
77 
79 
80 const char *osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr);
81 char *osmo_sockaddr_to_str_buf(char *buf, size_t buf_len,
82  const struct osmo_sockaddr *sockaddr);
83 int osmo_sockaddr_to_str_buf2(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr);
84 char *osmo_sockaddr_to_str_c(void *ctx, const struct osmo_sockaddr *sockaddr);
85 
86 /* flags for osmo_sock_init. */
88 #define OSMO_SOCK_F_CONNECT (1 << 0)
90 #define OSMO_SOCK_F_BIND (1 << 1)
92 #define OSMO_SOCK_F_NONBLOCK (1 << 2)
94 #define OSMO_SOCK_F_NO_MCAST_LOOP (1 << 3)
96 #define OSMO_SOCK_F_NO_MCAST_ALL (1 << 4)
98 #define OSMO_SOCK_F_UDP_REUSEADDR (1 << 5)
99 
101 #define OSMO_SOCK_F_DSCP(x) (((x)&0x3f) << 24)
102 #define GET_OSMO_SOCK_F_DSCP(f) (((f) >> 24) & 0x3f)
103 
105 #define OSMO_SOCK_F_PRIO(x) (((x)&0xff) << 16)
106 #define GET_OSMO_SOCK_F_PRIO(f) (((f) >> 16) & 0xff)
107 
108 
110 #define OSMO_SOCK_MAX_ADDRS 32
111 
112 int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto,
113  const char *host, uint16_t port, unsigned int flags);
114 
115 int osmo_sock_init2(uint16_t family, uint16_t type, uint8_t proto,
116  const char *local_host, uint16_t local_port,
117  const char *remote_host, uint16_t remote_port, unsigned int flags);
118 
120  union {
121  struct {
122  uint8_t version; /* set to 0 */
123  struct {
124  bool set;
126  uint32_t value;
128  struct {
129  bool set;
130  bool abort_on_failure;
131  uint32_t value;
133  struct {
134  bool set;
135  bool abort_on_failure;
145  } sctp;
146  };
147 };
148 int osmo_sock_init2_multiaddr(uint16_t family, uint16_t type, uint8_t proto,
149  const char **local_hosts, size_t local_hosts_cnt, uint16_t local_port,
150  const char **remote_hosts, size_t remote_hosts_cnt, uint16_t remote_port, unsigned int flags)
151  OSMO_DEPRECATED_OUTSIDE("Use osmo_sock_init2_multiaddr2() instead");
152 int osmo_sock_init2_multiaddr2(uint16_t family, uint16_t type, uint8_t proto,
153  const char **local_hosts, size_t local_hosts_cnt, uint16_t local_port,
154  const char **remote_hosts, size_t remote_hosts_cnt, uint16_t remote_port,
155  unsigned int flags, struct osmo_sock_init2_multiaddr_pars *pars);
156 
157 int osmo_sock_init_osa(uint16_t type, uint8_t proto,
158  const struct osmo_sockaddr *local,
159  const struct osmo_sockaddr *remote,
160  unsigned int flags);
161 
162 int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto,
163  const char *host, uint16_t port, unsigned int flags);
164 
165 int osmo_sock_init2_ofd(struct osmo_fd *ofd, int family, int type, int proto,
166  const char *local_host, uint16_t local_port,
167  const char *remote_host, uint16_t remote_port, unsigned int flags);
168 
169 int osmo_sock_init_osa_ofd(struct osmo_fd *ofd, int type, int proto,
170  const struct osmo_sockaddr *local,
171  const struct osmo_sockaddr *remote,
172  unsigned int flags);
173 
174 int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type,
175  uint8_t proto, unsigned int flags);
176 
177 int osmo_sock_unix_init(uint16_t type, uint8_t proto,
178  const char *socket_path, unsigned int flags);
179 
180 int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto,
181  const char *socket_path, unsigned int flags);
182 
183 char *osmo_sock_get_name(const void *ctx, int fd);
184 const char *osmo_sock_get_name2(int fd);
185 char *osmo_sock_get_name2_c(const void *ctx, int fd);
186 int osmo_sock_get_name_buf(char *str, size_t str_len, int fd);
187 int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local);
188 int osmo_sock_get_local_ip(int fd, char *host, size_t len);
189 int osmo_sock_get_local_ip_port(int fd, char *port, size_t len);
190 int osmo_sock_get_remote_ip(int fd, char *host, size_t len);
191 int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len);
192 
193 int osmo_sock_multiaddr_add_local_addr(int sfd, const char **addrs, size_t addrs_cnt);
194 int osmo_sock_multiaddr_del_local_addr(int sfd, const char **addrs, size_t addrs_cnt);
195 
196 int osmo_sock_mcast_loop_set(int fd, bool enable);
197 int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl);
198 int osmo_sock_mcast_all_set(int fd, bool enable);
199 int osmo_sock_mcast_iface_set(int fd, const char *ifname);
200 int osmo_sock_mcast_subscribe(int fd, const char *grp_addr);
201 
202 int osmo_sock_local_ip(char *local_ip, const char *remote_ip);
203 
204 int osmo_sock_set_dscp(int fd, uint8_t dscp);
205 int osmo_sock_set_priority(int fd, int prio);
206 
207 #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:46
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_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_sockaddr_to_octets(uint8_t *dst, size_t dst_maxlen, const struct osmo_sockaddr *os)
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_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)
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:119
uint8_t version
Definition: socket.h:122
bool max_init_timeo_present
Definition: socket.h:139
struct osmo_sock_init2_multiaddr_pars::@29::@31::@32 sockopt_auth_supported
bool abort_on_failure
Definition: socket.h:125
bool set
Definition: socket.h:124
uint16_t max_init_timeo_value
Definition: socket.h:143
uint16_t max_instreams_value
Definition: socket.h:141
uint16_t num_ostreams_value
Definition: socket.h:140
bool max_attempts_present
Definition: socket.h:138
uint32_t value
Definition: socket.h:126
bool num_ostreams_present
Definition: socket.h:136
bool max_instreams_present
Definition: socket.h:137
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:142
struct osmo_sock_init2_multiaddr_pars::@29::@31::@34 sockopt_initmsg
Definition: socket.h:26
struct sockaddr_storage sas
Definition: socket.h:29
struct sockaddr_in sin
Definition: socket.h:30
struct sockaddr_in6 sin6
Definition: socket.h:31
struct sockaddr sa
Definition: socket.h:28
union osmo_sockaddr::@28 u