libosmocore  1.8.0.79-b394d
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 
18 #define OSMO_SOCK_NAME_MAXLEN (2 + INET6_ADDRSTRLEN + 1 + 5 + 3 + 2 + INET6_ADDRSTRLEN + 1 + 5 + 1)
19 
20 struct sockaddr_in;
21 struct sockaddr;
22 struct osmo_fd;
23 
24 struct osmo_sockaddr {
25  union {
26  struct sockaddr sa;
27  struct sockaddr_storage sas;
28  struct sockaddr_in sin;
29  struct sockaddr_in6 sin6;
30  } u;
31 };
32 
33 int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen);
34 int osmo_sockaddr_is_any(const struct osmo_sockaddr *addr);
35 
44 static inline socklen_t osmo_sockaddr_size(const struct osmo_sockaddr *addr)
45 {
46  if (!addr)
47  return 0;
48 
49  switch (addr->u.sa.sa_family) {
50  case AF_INET:
51  return sizeof(struct sockaddr_in);
52  case AF_INET6:
53  return sizeof(struct sockaddr_in6);
54  default:
55  return sizeof(struct osmo_sockaddr);
56  }
57 }
58 
59 unsigned int osmo_sockaddr_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
60  const struct sockaddr *sa);
61 size_t osmo_sockaddr_in_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
62  const struct sockaddr_in *sin);
63 
64 const char *osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst);
65 uint16_t osmo_sockaddr_port(const struct sockaddr *sa);
66 void osmo_sockaddr_set_port(struct sockaddr *sa, uint16_t port);
67 
69  const struct osmo_sockaddr *remote_ip);
70 int osmo_sockaddr_cmp(const struct osmo_sockaddr *a,
71  const struct osmo_sockaddr *b);
72 
73 int osmo_sockaddr_to_octets(uint8_t *dst, size_t dst_maxlen, const struct osmo_sockaddr *os);
74 int osmo_sockaddr_from_octets(struct osmo_sockaddr *os, const void *src, size_t src_len);
75 
77 
78 const char *osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr);
79 char *osmo_sockaddr_to_str_buf(char *buf, size_t buf_len,
80  const struct osmo_sockaddr *sockaddr);
81 int osmo_sockaddr_to_str_buf2(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr);
82 char *osmo_sockaddr_to_str_c(void *ctx, const struct osmo_sockaddr *sockaddr);
83 
84 /* flags for osmo_sock_init. */
86 #define OSMO_SOCK_F_CONNECT (1 << 0)
88 #define OSMO_SOCK_F_BIND (1 << 1)
90 #define OSMO_SOCK_F_NONBLOCK (1 << 2)
92 #define OSMO_SOCK_F_NO_MCAST_LOOP (1 << 3)
94 #define OSMO_SOCK_F_NO_MCAST_ALL (1 << 4)
96 #define OSMO_SOCK_F_UDP_REUSEADDR (1 << 5)
97 
99 #define OSMO_SOCK_F_DSCP(x) (((x)&0x3f) << 24)
100 #define GET_OSMO_SOCK_F_DSCP(f) (((f) >> 24) & 0x3f)
101 
103 #define OSMO_SOCK_F_PRIO(x) (((x)&0xff) << 16)
104 #define GET_OSMO_SOCK_F_PRIO(f) (((f) >> 16) & 0xff)
105 
106 
108 #define OSMO_SOCK_MAX_ADDRS 32
109 
110 int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto,
111  const char *host, uint16_t port, unsigned int flags);
112 
113 int osmo_sock_init2(uint16_t family, uint16_t type, uint8_t proto,
114  const char *local_host, uint16_t local_port,
115  const char *remote_host, uint16_t remote_port, unsigned int flags);
116 
117 int osmo_sock_init2_multiaddr(uint16_t family, uint16_t type, uint8_t proto,
118  const char **local_hosts, size_t local_hosts_cnt, uint16_t local_port,
119  const char **remote_hosts, size_t remote_hosts_cnt, uint16_t remote_port, unsigned int flags);
120 
121 int osmo_sock_init_osa(uint16_t type, uint8_t proto,
122  const struct osmo_sockaddr *local,
123  const struct osmo_sockaddr *remote,
124  unsigned int flags);
125 
126 int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto,
127  const char *host, uint16_t port, unsigned int flags);
128 
129 int osmo_sock_init2_ofd(struct osmo_fd *ofd, int family, int type, int proto,
130  const char *local_host, uint16_t local_port,
131  const char *remote_host, uint16_t remote_port, unsigned int flags);
132 
133 int osmo_sock_init_osa_ofd(struct osmo_fd *ofd, int type, int proto,
134  const struct osmo_sockaddr *local,
135  const struct osmo_sockaddr *remote,
136  unsigned int flags);
137 
138 int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type,
139  uint8_t proto, unsigned int flags);
140 
141 int osmo_sock_unix_init(uint16_t type, uint8_t proto,
142  const char *socket_path, unsigned int flags);
143 
144 int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto,
145  const char *socket_path, unsigned int flags);
146 
147 char *osmo_sock_get_name(const void *ctx, int fd);
148 const char *osmo_sock_get_name2(int fd);
149 char *osmo_sock_get_name2_c(const void *ctx, int fd);
150 int osmo_sock_get_name_buf(char *str, size_t str_len, int fd);
151 int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local);
152 int osmo_sock_get_local_ip(int fd, char *host, size_t len);
153 int osmo_sock_get_local_ip_port(int fd, char *port, size_t len);
154 int osmo_sock_get_remote_ip(int fd, char *host, size_t len);
155 int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len);
156 
157 
158 int osmo_sock_mcast_loop_set(int fd, bool enable);
159 int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl);
160 int osmo_sock_mcast_all_set(int fd, bool enable);
161 int osmo_sock_mcast_iface_set(int fd, const char *ifname);
162 int osmo_sock_mcast_subscribe(int fd, const char *grp_addr);
163 
164 int osmo_sock_local_ip(char *local_ip, const char *remote_ip);
165 
166 int osmo_sock_set_dscp(int fd, uint8_t dscp);
167 int osmo_sock_set_priority(int fd, int prio);
168 
169 #endif /* (!EMBEDDED) */
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)
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:44
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)
char * osmo_sockaddr_to_str_c(void *ctx, 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)
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_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_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)
Structure representing a file dsecriptor.
Definition: select.h:31
Definition: socket.h:24
struct sockaddr_storage sas
Definition: socket.h:27
struct sockaddr_in sin
Definition: socket.h:28
struct sockaddr_in6 sin6
Definition: socket.h:29
union osmo_sockaddr::@22 u
struct sockaddr sa
Definition: socket.h:26