libosmocore  1.5.1.129-442f
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 /* flags for osmo_sock_init. */
35 #define OSMO_SOCK_F_CONNECT (1 << 0)
36 
37 #define OSMO_SOCK_F_BIND (1 << 1)
38 
39 #define OSMO_SOCK_F_NONBLOCK (1 << 2)
40 
41 #define OSMO_SOCK_F_NO_MCAST_LOOP (1 << 3)
42 
43 #define OSMO_SOCK_F_NO_MCAST_ALL (1 << 4)
44 
45 #define OSMO_SOCK_F_UDP_REUSEADDR (1 << 5)
46 
48 #define OSMO_SOCK_F_DSCP(x) (((x)&0x3f) << 24)
49 #define GET_OSMO_SOCK_F_DSCP(f) (((f) >> 24) & 0x3f)
50 
52 #define OSMO_SOCK_F_PRIO(x) (((x)&0xff) << 16)
53 #define GET_OSMO_SOCK_F_PRIO(f) (((f) >> 16) & 0xff)
54 
55 
57 #define OSMO_SOCK_MAX_ADDRS 32
58 
59 int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto,
60  const char *host, uint16_t port, unsigned int flags);
61 
62 int osmo_sock_init2(uint16_t family, uint16_t type, uint8_t proto,
63  const char *local_host, uint16_t local_port,
64  const char *remote_host, uint16_t remote_port, unsigned int flags);
65 
66 int osmo_sock_init2_multiaddr(uint16_t family, uint16_t type, uint8_t proto,
67  const char **local_hosts, size_t local_hosts_cnt, uint16_t local_port,
68  const char **remote_hosts, size_t remote_hosts_cnt, uint16_t remote_port, unsigned int flags);
69 
70 int osmo_sock_init_osa(uint16_t type, uint8_t proto,
71  const struct osmo_sockaddr *local,
72  const struct osmo_sockaddr *remote,
73  unsigned int flags);
74 
75 int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto,
76  const char *host, uint16_t port, unsigned int flags);
77 
78 int osmo_sock_init2_ofd(struct osmo_fd *ofd, int family, int type, int proto,
79  const char *local_host, uint16_t local_port,
80  const char *remote_host, uint16_t remote_port, unsigned int flags);
81 
82 int osmo_sock_init_osa_ofd(struct osmo_fd *ofd, int type, int proto,
83  const struct osmo_sockaddr *local,
84  const struct osmo_sockaddr *remote,
85  unsigned int flags);
86 
87 int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type,
88  uint8_t proto, unsigned int flags);
89 
90 int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen);
91 
92 unsigned int osmo_sockaddr_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
93  const struct sockaddr *sa);
94 size_t osmo_sockaddr_in_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
95  const struct sockaddr_in *sin);
96 
97 const char *osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst);
98 uint16_t osmo_sockaddr_port(const struct sockaddr *sa);
99 
100 int osmo_sock_unix_init(uint16_t type, uint8_t proto,
101  const char *socket_path, unsigned int flags);
102 
103 int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto,
104  const char *socket_path, unsigned int flags);
105 
106 char *osmo_sock_get_name(const void *ctx, int fd);
107 const char *osmo_sock_get_name2(int fd);
108 char *osmo_sock_get_name2_c(const void *ctx, int fd);
109 int osmo_sock_get_name_buf(char *str, size_t str_len, int fd);
110 int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local);
111 int osmo_sock_get_local_ip(int fd, char *host, size_t len);
112 int osmo_sock_get_local_ip_port(int fd, char *port, size_t len);
113 int osmo_sock_get_remote_ip(int fd, char *host, size_t len);
114 int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len);
115 
116 
117 int osmo_sock_mcast_loop_set(int fd, bool enable);
118 int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl);
119 int osmo_sock_mcast_all_set(int fd, bool enable);
120 int osmo_sock_mcast_iface_set(int fd, const char *ifname);
121 int osmo_sock_mcast_subscribe(int fd, const char *grp_addr);
122 
123 int osmo_sock_local_ip(char *local_ip, const char *remote_ip);
124 
125 int osmo_sockaddr_local_ip(struct osmo_sockaddr *local_ip,
126  const struct osmo_sockaddr *remote_ip);
127 int osmo_sockaddr_cmp(const struct osmo_sockaddr *a,
128  const struct osmo_sockaddr *b);
129 
130 const char *osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr);
131 char *osmo_sockaddr_to_str_buf(char *buf, size_t buf_len,
132  const struct osmo_sockaddr *sockaddr);
133 
134 int osmo_sock_set_dscp(int fd, uint8_t dscp);
135 int osmo_sock_set_priority(int fd, int prio);
136 
137 #endif /* (!EMBEDDED) */
138 
int osmo_sockaddr_cmp(const struct osmo_sockaddr *a, const struct osmo_sockaddr *b)
Compare two osmo_sockaddr.
Definition: socket.c:1721
int osmo_sock_init_osa(uint16_t type, uint8_t proto, const struct osmo_sockaddr *local, const struct osmo_sockaddr *remote, unsigned int flags)
Initialize a socket (including bind and/or connect)
Definition: socket.c:520
char * osmo_sockaddr_to_str_buf(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr)
string-format a given osmo_sockaddr address into a user-supplied buffer
Definition: socket.c:1764
int osmo_sock_get_local_ip_port(int fd, char *port, size_t len)
Get local port on socket.
Definition: socket.c:1378
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)
Initialize a socket (including bind and/or connect) with multiple local or remote addresses...
Definition: socket.c:720
struct sockaddr_storage sas
Definition: socket.h:27
unsigned int osmo_sockaddr_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port, const struct sockaddr *sa)
Convert sockaddr to IP address as char string and port as uint16_t.
Definition: socket.c:1184
Definition: socket.h:24
int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto, const char *host, uint16_t port, unsigned int flags)
Initialize a socket and fill osmo_fd.
Definition: socket.c:1020
const char * osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr)
string-format a given osmo_sockaddr address
Definition: socket.c:1750
int osmo_sock_get_remote_ip(int fd, char *host, size_t len)
Get remote IP address on socket.
Definition: socket.c:1389
int osmo_sock_mcast_loop_set(int fd, bool enable)
Activate or de-activate local loop-back of transmitted multicast packets.
Definition: socket.c:1498
struct sockaddr sa
Definition: socket.h:26
int osmo_sock_set_dscp(int fd, uint8_t dscp)
Set the DSCP (differentiated services code point) of a socket.
Definition: socket.c:1810
int osmo_sock_get_name_buf(char *str, size_t str_len, int fd)
Get address/port information on socket in provided string buffer, like "r=1.2.3.4:5<->l=6.7.8.9:10".
Definition: socket.c:1429
union osmo_sockaddr::@22 u
size_t osmo_sockaddr_in_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port, const struct sockaddr_in *sin)
Convert sockaddr_in to IP address as char string and port as uint16_t.
Definition: socket.c:1165
int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local)
Get the IP and/or port number on socket in separate string buffers.
Definition: socket.c:1337
uint16_t osmo_sockaddr_port(const struct sockaddr *sa)
Get sockaddr port content (in host byte order)
Definition: socket.c:1225
int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl)
Set the TTL of outbound multicast packets.
Definition: socket.c:1523
int osmo_sock_local_ip(char *local_ip, const char *remote_ip)
Determine the matching local IP-address for a given remote IP-Address.
Definition: socket.c:1637
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)
Initialize a socket and fill osmo_fd.
Definition: socket.c:1041
char * osmo_sock_get_name2_c(const void *ctx, int fd)
Get address/port information on socket in static string, like "r=1.2.3.4:5<->l=6.7.8.9:10".
Definition: socket.c:1465
int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto, const char *host, uint16_t port, unsigned int flags)
Initialize a socket (including bind/connect)
Definition: socket.c:893
int osmo_sock_mcast_all_set(int fd, bool enable)
Enable/disable receiving all multicast packets, even for non-subscribed groups.
Definition: socket.c:1566
int osmo_sockaddr_local_ip(struct osmo_sockaddr *local_ip, const struct osmo_sockaddr *remote_ip)
Determine the matching local address for a given remote address.
Definition: socket.c:1698
int osmo_sock_mcast_subscribe(int fd, const char *grp_addr)
Subscribe to the given IP multicast group.
Definition: socket.c:1598
int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type, uint8_t proto, unsigned int flags)
Initialize a socket and fill sockaddr.
Definition: socket.c:1066
int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen)
Determine if the given address is a local address.
Definition: socket.c:1135
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)
Initialize a socket (including bind and/or connect)
Definition: socket.c:311
struct sockaddr_in sin
Definition: socket.h:28
int osmo_sock_set_priority(int fd, int prio)
Set the priority value of a socket.
Definition: socket.c:1865
int osmo_sock_mcast_iface_set(int fd, const char *ifname)
Set the network device to which we should bind the multicast socket.
Definition: socket.c:1545
int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len)
Get remote port on socket.
Definition: socket.c:1400
const char * osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst)
inet_ntop() wrapper for a struct sockaddr.
Definition: socket.c:1211
uint8_t type
see GSMTAP_TYPE_*
Definition: gsmtap.h:122
char * osmo_sock_get_name(const void *ctx, int fd)
Get address/port information on socket in dyn-alloc string like "(r=1.2.3.4:5<->l=6.7.8.9:10)".
Definition: socket.c:1412
static size_t len(const char *str)
int osmo_sock_get_local_ip(int fd, char *host, size_t len)
Get local IP address on socket.
Definition: socket.c:1367
int osmo_sock_unix_init(uint16_t type, uint8_t proto, const char *socket_path, unsigned int flags)
Initialize a unix domain socket (including bind/connect)
Definition: socket.c:1251
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)
Definition: socket.c:1049
Structure representing a file dsecriptor.
Definition: select.h:31
int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto, const char *socket_path, unsigned int flags)
Initialize a unix domain socket and fill osmo_fd.
Definition: socket.c:1322
const char * osmo_sock_get_name2(int fd)
Get address/port information on socket in static string, like "r=1.2.3.4:5<->l=6.7.8.9:10".
Definition: socket.c:1453
struct sockaddr_in6 sin6
Definition: socket.h:29