libosmocore  1.8.0
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 
36 unsigned int osmo_sockaddr_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
37  const struct sockaddr *sa);
38 size_t osmo_sockaddr_in_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
39  const struct sockaddr_in *sin);
40 
41 const char *osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst);
42 uint16_t osmo_sockaddr_port(const struct sockaddr *sa);
43 void osmo_sockaddr_set_port(struct sockaddr *sa, uint16_t port);
44 
45 int osmo_sockaddr_local_ip(struct osmo_sockaddr *local_ip,
46  const struct osmo_sockaddr *remote_ip);
47 int osmo_sockaddr_cmp(const struct osmo_sockaddr *a,
48  const struct osmo_sockaddr *b);
49 
50 int osmo_sockaddr_to_octets(uint8_t *dst, size_t dst_maxlen, const struct osmo_sockaddr *os);
51 int osmo_sockaddr_from_octets(struct osmo_sockaddr *os, const void *src, size_t src_len);
52 
54 
55 const char *osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr);
56 char *osmo_sockaddr_to_str_buf(char *buf, size_t buf_len,
57  const struct osmo_sockaddr *sockaddr);
58 int osmo_sockaddr_to_str_buf2(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr);
59 char *osmo_sockaddr_to_str_c(void *ctx, const struct osmo_sockaddr *sockaddr);
60 
61 /* flags for osmo_sock_init. */
63 #define OSMO_SOCK_F_CONNECT (1 << 0)
64 
65 #define OSMO_SOCK_F_BIND (1 << 1)
66 
67 #define OSMO_SOCK_F_NONBLOCK (1 << 2)
68 
69 #define OSMO_SOCK_F_NO_MCAST_LOOP (1 << 3)
70 
71 #define OSMO_SOCK_F_NO_MCAST_ALL (1 << 4)
72 
73 #define OSMO_SOCK_F_UDP_REUSEADDR (1 << 5)
74 
76 #define OSMO_SOCK_F_DSCP(x) (((x)&0x3f) << 24)
77 #define GET_OSMO_SOCK_F_DSCP(f) (((f) >> 24) & 0x3f)
78 
80 #define OSMO_SOCK_F_PRIO(x) (((x)&0xff) << 16)
81 #define GET_OSMO_SOCK_F_PRIO(f) (((f) >> 16) & 0xff)
82 
83 
85 #define OSMO_SOCK_MAX_ADDRS 32
86 
87 int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto,
88  const char *host, uint16_t port, unsigned int flags);
89 
90 int osmo_sock_init2(uint16_t family, uint16_t type, uint8_t proto,
91  const char *local_host, uint16_t local_port,
92  const char *remote_host, uint16_t remote_port, unsigned int flags);
93 
94 int osmo_sock_init2_multiaddr(uint16_t family, uint16_t type, uint8_t proto,
95  const char **local_hosts, size_t local_hosts_cnt, uint16_t local_port,
96  const char **remote_hosts, size_t remote_hosts_cnt, uint16_t remote_port, unsigned int flags);
97 
98 int osmo_sock_init_osa(uint16_t type, uint8_t proto,
99  const struct osmo_sockaddr *local,
100  const struct osmo_sockaddr *remote,
101  unsigned int flags);
102 
103 int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto,
104  const char *host, uint16_t port, unsigned int flags);
105 
106 int osmo_sock_init2_ofd(struct osmo_fd *ofd, int family, int type, int proto,
107  const char *local_host, uint16_t local_port,
108  const char *remote_host, uint16_t remote_port, unsigned int flags);
109 
110 int osmo_sock_init_osa_ofd(struct osmo_fd *ofd, int type, int proto,
111  const struct osmo_sockaddr *local,
112  const struct osmo_sockaddr *remote,
113  unsigned int flags);
114 
115 int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type,
116  uint8_t proto, unsigned int flags);
117 
118 int osmo_sock_unix_init(uint16_t type, uint8_t proto,
119  const char *socket_path, unsigned int flags);
120 
121 int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto,
122  const char *socket_path, unsigned int flags);
123 
124 char *osmo_sock_get_name(const void *ctx, int fd);
125 const char *osmo_sock_get_name2(int fd);
126 char *osmo_sock_get_name2_c(const void *ctx, int fd);
127 int osmo_sock_get_name_buf(char *str, size_t str_len, int fd);
128 int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local);
129 int osmo_sock_get_local_ip(int fd, char *host, size_t len);
130 int osmo_sock_get_local_ip_port(int fd, char *port, size_t len);
131 int osmo_sock_get_remote_ip(int fd, char *host, size_t len);
132 int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len);
133 
134 
135 int osmo_sock_mcast_loop_set(int fd, bool enable);
136 int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl);
137 int osmo_sock_mcast_all_set(int fd, bool enable);
138 int osmo_sock_mcast_iface_set(int fd, const char *ifname);
139 int osmo_sock_mcast_subscribe(int fd, const char *grp_addr);
140 
141 int osmo_sock_local_ip(char *local_ip, const char *remote_ip);
142 
143 int osmo_sock_set_dscp(int fd, uint8_t dscp);
144 int osmo_sock_set_priority(int fd, int prio);
145 
146 #endif /* (!EMBEDDED) */
147 
osmo_sock_mcast_loop_set
int osmo_sock_mcast_loop_set(int fd, bool enable)
osmo_sockaddr::sa
struct sockaddr sa
Definition: socket.h:26
osmo_sockaddr_cmp
int osmo_sockaddr_cmp(const struct osmo_sockaddr *a, const struct osmo_sockaddr *b)
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_get_name2_c
char * osmo_sock_get_name2_c(const void *ctx, int fd)
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)
len
static size_t len(const char *str)
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_get_name2
const char * osmo_sock_get_name2(int fd)
osmo_sock_set_priority
int osmo_sock_set_priority(int fd, int prio)
osmo_sockaddr_port
uint16_t osmo_sockaddr_port(const struct sockaddr *sa)
osmo_sockaddr
Definition: socket.h:24
osmo_sock_get_name
char * osmo_sock_get_name(const void *ctx, int fd)
osmo_sockaddr::sin6
struct sockaddr_in6 sin6
Definition: socket.h:29
osmo_sock_unix_init
int osmo_sock_unix_init(uint16_t type, uint8_t proto, const char *socket_path, unsigned int flags)
osmo_sock_mcast_all_set
int osmo_sock_mcast_all_set(int fd, bool enable)
osmo_sockaddr_to_str_buf
char * osmo_sockaddr_to_str_buf(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr)
osmo_sock_get_local_ip_port
int osmo_sock_get_local_ip_port(int fd, char *port, size_t len)
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_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_mcast_ttl_set
int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl)
osmo_sockaddr_to_octets
int osmo_sockaddr_to_octets(uint8_t *dst, size_t dst_maxlen, const struct osmo_sockaddr *os)
osmo_sockaddr_set_port
void osmo_sockaddr_set_port(struct sockaddr *sa, uint16_t port)
osmo_sock_mcast_subscribe
int osmo_sock_mcast_subscribe(int fd, const char *grp_addr)
osmo_sockaddr_to_str_buf2
int osmo_sockaddr_to_str_buf2(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr)
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_sockaddr_from_octets
int osmo_sockaddr_from_octets(struct osmo_sockaddr *os, const void *src, size_t src_len)
osmo_sockaddr_is_local
int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen)
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_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_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_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_sockaddr::u
union osmo_sockaddr::@22 u
osmo_sock_local_ip
int osmo_sock_local_ip(char *local_ip, const char *remote_ip)
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_sockaddr_netmask_to_prefixlen
int osmo_sockaddr_netmask_to_prefixlen(const struct osmo_sockaddr *addr)
osmo_sockaddr::sin
struct sockaddr_in sin
Definition: socket.h:28
host
osmo_sock_set_dscp
int osmo_sock_set_dscp(int fd, uint8_t dscp)
type
enum osmo_sub_auth_type type
osmo_sock_get_name_buf
int osmo_sock_get_name_buf(char *str, size_t str_len, int fd)
osmo_sock_get_remote_ip_port
int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len)
osmo_sockaddr::sas
struct sockaddr_storage sas
Definition: socket.h:27
osmo_fd
Structure representing a file dsecriptor.
Definition: select.h:31
osmo_sock_get_remote_ip
int osmo_sock_get_remote_ip(int fd, char *host, size_t len)
osmo_sock_get_local_ip
int osmo_sock_get_local_ip(int fd, char *host, size_t len)
osmo_sockaddr_local_ip
int osmo_sockaddr_local_ip(struct osmo_sockaddr *local_ip, const struct osmo_sockaddr *remote_ip)
osmo_sock_init_sa
int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type, uint8_t proto, unsigned int flags)
osmo_sock_mcast_iface_set
int osmo_sock_mcast_iface_set(int fd, const char *ifname)
osmo_sockaddr_to_str_c
char * osmo_sockaddr_to_str_c(void *ctx, const struct osmo_sockaddr *sockaddr)
osmo_sockaddr_ntop
const char * osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst)
osmo_sockaddr_is_any
int osmo_sockaddr_is_any(const struct osmo_sockaddr *addr)
osmo_sockaddr_to_str
const char * osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr)