libosmocore 1.7.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
20struct sockaddr_in;
21struct sockaddr;
22struct osmo_fd;
23
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)
37#define OSMO_SOCK_F_BIND (1 << 1)
39#define OSMO_SOCK_F_NONBLOCK (1 << 2)
41#define OSMO_SOCK_F_NO_MCAST_LOOP (1 << 3)
43#define OSMO_SOCK_F_NO_MCAST_ALL (1 << 4)
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
59int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto,
60 const char *host, uint16_t port, unsigned int flags);
61
62int 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
66int 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
70int 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
75int 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
78int 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
82int 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
87int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type,
88 uint8_t proto, unsigned int flags);
89
90int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen);
91
92unsigned int osmo_sockaddr_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
93 const struct sockaddr *sa);
94size_t osmo_sockaddr_in_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
95 const struct sockaddr_in *sin);
96
97const char *osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst);
98uint16_t osmo_sockaddr_port(const struct sockaddr *sa);
99void osmo_sockaddr_set_port(struct sockaddr *sa, uint16_t port);
100
101int osmo_sock_unix_init(uint16_t type, uint8_t proto,
102 const char *socket_path, unsigned int flags);
103
104int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto,
105 const char *socket_path, unsigned int flags);
106
107char *osmo_sock_get_name(const void *ctx, int fd);
108const char *osmo_sock_get_name2(int fd);
109char *osmo_sock_get_name2_c(const void *ctx, int fd);
110int osmo_sock_get_name_buf(char *str, size_t str_len, int fd);
111int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local);
112int osmo_sock_get_local_ip(int fd, char *host, size_t len);
113int osmo_sock_get_local_ip_port(int fd, char *port, size_t len);
114int osmo_sock_get_remote_ip(int fd, char *host, size_t len);
115int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len);
116
117
118int osmo_sock_mcast_loop_set(int fd, bool enable);
119int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl);
120int osmo_sock_mcast_all_set(int fd, bool enable);
121int osmo_sock_mcast_iface_set(int fd, const char *ifname);
122int osmo_sock_mcast_subscribe(int fd, const char *grp_addr);
123
124int osmo_sock_local_ip(char *local_ip, const char *remote_ip);
125
126int osmo_sockaddr_local_ip(struct osmo_sockaddr *local_ip,
127 const struct osmo_sockaddr *remote_ip);
128int osmo_sockaddr_cmp(const struct osmo_sockaddr *a,
129 const struct osmo_sockaddr *b);
130
131int osmo_sockaddr_to_octets(uint8_t *dst, size_t dst_maxlen, const struct osmo_sockaddr *os);
132int osmo_sockaddr_from_octets(struct osmo_sockaddr *os, const void *src, size_t src_len);
133
134const char *osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr);
135char *osmo_sockaddr_to_str_buf(char *buf, size_t buf_len,
136 const struct osmo_sockaddr *sockaddr);
137int osmo_sockaddr_to_str_buf2(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr);
138char *osmo_sockaddr_to_str_c(void *ctx, const struct osmo_sockaddr *sockaddr);
139
140int osmo_sock_set_dscp(int fd, uint8_t dscp);
141int osmo_sock_set_priority(int fd, int prio);
142
143#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)
Compare two osmo_sockaddr.
Definition: socket.c:1817
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:1185
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:517
int osmo_sock_get_local_ip(int fd, char *host, size_t len)
Get local IP address on socket.
Definition: socket.c:1404
const char * osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst)
inet_ntop() wrapper for a struct sockaddr.
Definition: socket.c:1231
void osmo_sockaddr_set_port(struct sockaddr *sa, uint16_t port)
Set sockaddr port content (to network byte order).
Definition: socket.c:1261
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:1910
char * osmo_sockaddr_to_str_c(void *ctx, const struct osmo_sockaddr *sockaddr)
string-format a given osmo_sockaddr address into a talloc allocated buffer.
Definition: socket.c:1898
uint16_t osmo_sockaddr_port(const struct sockaddr *sa)
Get sockaddr port content (in host byte order)
Definition: socket.c:1245
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....
Definition: socket.c:1502
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....
Definition: socket.c:1449
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:1735
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....
Definition: socket.c:1466
int osmo_sock_set_priority(int fd, int prio)
Set the priority value of a socket.
Definition: socket.c:1977
int osmo_sock_mcast_loop_set(int fd, bool enable)
Activate or de-activate local loop-back of transmitted multicast packets.
Definition: socket.c:1535
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:1374
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:716
int osmo_sock_get_local_ip_port(int fd, char *port, size_t len)
Get local port on socket.
Definition: socket.c:1415
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:889
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:1018
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:1039
int osmo_sockaddr_to_octets(uint8_t *dst, size_t dst_maxlen, const struct osmo_sockaddr *os)
Copy the addr part, the IP address octets in network byte order, to a buffer.
Definition: socket.c:1760
const char * osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr)
string-format a given osmo_sockaddr address
Definition: socket.c:1846
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....
Definition: socket.c:1490
int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len)
Get remote port on socket.
Definition: socket.c:1437
int osmo_sock_mcast_all_set(int fd, bool enable)
Enable/disable receiving all multicast packets, even for non-subscribed groups.
Definition: socket.c:1603
int osmo_sockaddr_to_str_buf2(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:1861
int osmo_sock_get_remote_ip(int fd, char *host, size_t len)
Get remote IP address on socket.
Definition: socket.c:1426
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:1204
int osmo_sockaddr_from_octets(struct osmo_sockaddr *os, const void *src, size_t src_len)
Copy the addr part, the IP address octets in network byte order, from a buffer.
Definition: socket.c:1789
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:308
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:1359
int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl)
Set the TTL of outbound multicast packets.
Definition: socket.c:1560
int osmo_sock_set_dscp(int fd, uint8_t dscp)
Set the DSCP (differentiated services code point) of a socket.
Definition: socket.c:1922
int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen)
Determine if the given address is a local address.
Definition: socket.c:1152
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:1582
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:1047
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:1288
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:1064
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:1674
int osmo_sock_mcast_subscribe(int fd, const char *grp_addr)
Subscribe to the given IP multicast group.
Definition: socket.c:1635
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