libosmocore  1.7.0.61-0d9b6.202211030053
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 
53 const char *osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr);
54 char *osmo_sockaddr_to_str_buf(char *buf, size_t buf_len,
55  const struct osmo_sockaddr *sockaddr);
56 int osmo_sockaddr_to_str_buf2(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr);
57 char *osmo_sockaddr_to_str_c(void *ctx, const struct osmo_sockaddr *sockaddr);
58 
59 /* flags for osmo_sock_init. */
61 #define OSMO_SOCK_F_CONNECT (1 << 0)
62 
63 #define OSMO_SOCK_F_BIND (1 << 1)
64 
65 #define OSMO_SOCK_F_NONBLOCK (1 << 2)
66 
67 #define OSMO_SOCK_F_NO_MCAST_LOOP (1 << 3)
68 
69 #define OSMO_SOCK_F_NO_MCAST_ALL (1 << 4)
70 
71 #define OSMO_SOCK_F_UDP_REUSEADDR (1 << 5)
72 
74 #define OSMO_SOCK_F_DSCP(x) (((x)&0x3f) << 24)
75 #define GET_OSMO_SOCK_F_DSCP(f) (((f) >> 24) & 0x3f)
76 
78 #define OSMO_SOCK_F_PRIO(x) (((x)&0xff) << 16)
79 #define GET_OSMO_SOCK_F_PRIO(f) (((f) >> 16) & 0xff)
80 
81 
83 #define OSMO_SOCK_MAX_ADDRS 32
84 
85 int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto,
86  const char *host, uint16_t port, unsigned int flags);
87 
88 int osmo_sock_init2(uint16_t family, uint16_t type, uint8_t proto,
89  const char *local_host, uint16_t local_port,
90  const char *remote_host, uint16_t remote_port, unsigned int flags);
91 
92 int osmo_sock_init2_multiaddr(uint16_t family, uint16_t type, uint8_t proto,
93  const char **local_hosts, size_t local_hosts_cnt, uint16_t local_port,
94  const char **remote_hosts, size_t remote_hosts_cnt, uint16_t remote_port, unsigned int flags);
95 
96 int osmo_sock_init_osa(uint16_t type, uint8_t proto,
97  const struct osmo_sockaddr *local,
98  const struct osmo_sockaddr *remote,
99  unsigned int flags);
100 
101 int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto,
102  const char *host, uint16_t port, unsigned int flags);
103 
104 int osmo_sock_init2_ofd(struct osmo_fd *ofd, int family, int type, int proto,
105  const char *local_host, uint16_t local_port,
106  const char *remote_host, uint16_t remote_port, unsigned int flags);
107 
108 int osmo_sock_init_osa_ofd(struct osmo_fd *ofd, int type, int proto,
109  const struct osmo_sockaddr *local,
110  const struct osmo_sockaddr *remote,
111  unsigned int flags);
112 
113 int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type,
114  uint8_t proto, unsigned int flags);
115 
116 int osmo_sock_unix_init(uint16_t type, uint8_t proto,
117  const char *socket_path, unsigned int flags);
118 
119 int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto,
120  const char *socket_path, unsigned int flags);
121 
122 char *osmo_sock_get_name(const void *ctx, int fd);
123 const char *osmo_sock_get_name2(int fd);
124 char *osmo_sock_get_name2_c(const void *ctx, int fd);
125 int osmo_sock_get_name_buf(char *str, size_t str_len, int fd);
126 int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local);
127 int osmo_sock_get_local_ip(int fd, char *host, size_t len);
128 int osmo_sock_get_local_ip_port(int fd, char *port, size_t len);
129 int osmo_sock_get_remote_ip(int fd, char *host, size_t len);
130 int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len);
131 
132 
133 int osmo_sock_mcast_loop_set(int fd, bool enable);
134 int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl);
135 int osmo_sock_mcast_all_set(int fd, bool enable);
136 int osmo_sock_mcast_iface_set(int fd, const char *ifname);
137 int osmo_sock_mcast_subscribe(int fd, const char *grp_addr);
138 
139 int osmo_sock_local_ip(char *local_ip, const char *remote_ip);
140 
141 int osmo_sock_set_dscp(int fd, uint8_t dscp);
142 int osmo_sock_set_priority(int fd, int prio);
143 
144 #endif /* (!EMBEDDED) */
145 
osmo_sock_mcast_loop_set
int osmo_sock_mcast_loop_set(int fd, bool enable)
Activate or de-activate local loop-back of transmitted multicast packets.
Definition: socket.c:1555
osmo_sockaddr_ntop
const char * osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst)
inet_ntop() wrapper for a struct sockaddr.
Definition: socket.c:1251
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)
Compare two osmo_sockaddr.
Definition: socket.c:1837
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)
Initialize a socket (including bind and/or connect)
Definition: socket.c:517
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)
Initialize a socket (including bind/connect)
Definition: socket.c:889
osmo_sock_get_remote_ip
int osmo_sock_get_remote_ip(int fd, char *host, size_t len)
Get remote IP address on socket.
Definition: socket.c:1446
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)
Definition: socket.c:1047
osmo_sock_get_name2_c
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:1522
osmo_sock_set_priority
int osmo_sock_set_priority(int fd, int prio)
Set the priority value of a socket.
Definition: socket.c:1997
osmo_sockaddr_port
uint16_t osmo_sockaddr_port(const struct sockaddr *sa)
Get sockaddr port content (in host byte order)
Definition: socket.c:1265
osmo_sockaddr
Definition: socket.h:24
osmo_sockaddr_to_str
const char * osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr)
string-format a given osmo_sockaddr address
Definition: socket.c:1866
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)
Initialize a unix domain socket (including bind/connect)
Definition: socket.c:1308
osmo_sock_mcast_all_set
int osmo_sock_mcast_all_set(int fd, bool enable)
Enable/disable receiving all multicast packets, even for non-subscribed groups.
Definition: socket.c:1623
osmo_sockaddr_to_str_buf
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:1930
osmo_sock_get_local_ip_port
int osmo_sock_get_local_ip_port(int fd, char *port, size_t len)
Get local port on socket.
Definition: socket.c:1435
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)
Initialize a unix domain socket and fill osmo_fd.
Definition: socket.c:1379
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)
Initialize a socket and fill osmo_fd.
Definition: socket.c:1018
osmo_sock_mcast_ttl_set
int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl)
Set the TTL of outbound multicast packets.
Definition: socket.c:1580
osmo_sockaddr_to_octets
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:1780
osmo_sockaddr_set_port
void osmo_sockaddr_set_port(struct sockaddr *sa, uint16_t port)
Set sockaddr port content (to network byte order).
Definition: socket.c:1281
osmo_sock_mcast_subscribe
int osmo_sock_mcast_subscribe(int fd, const char *grp_addr)
Subscribe to the given IP multicast group.
Definition: socket.c:1655
osmo_sockaddr_to_str_buf2
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:1881
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)
Convert sockaddr_in to IP address as char string and port as uint16_t.
Definition: socket.c:1205
osmo_sockaddr_from_octets
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:1809
osmo_sockaddr_is_local
int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen)
Determine if the given address is a local address.
Definition: socket.c:1152
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)
Initialize a socket (including bind and/or connect)
Definition: socket.c:308
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)
Initialize a socket (including bind and/or connect) with multiple local or remote addresses.
Definition: socket.c:716
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)
Convert sockaddr to IP address as char string and port as uint16_t.
Definition: socket.c:1224
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)
Get the IP and/or port number on socket in separate string buffers.
Definition: socket.c:1394
osmo_sockaddr_to_str_c
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:1918
osmo_sockaddr::u
union osmo_sockaddr::@22 u
osmo_sock_local_ip
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:1694
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)
Initialize a socket and fill osmo_fd.
Definition: socket.c:1039
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)
Set the DSCP (differentiated services code point) of a socket.
Definition: socket.c:1942
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)
Get address/port information on socket in provided string buffer, like "r=1.2.3.4:5<->l=6....
Definition: socket.c:1486
osmo_sock_get_remote_ip_port
int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len)
Get remote port on socket.
Definition: socket.c:1457
osmo_sockaddr::sas
struct sockaddr_storage sas
Definition: socket.h:27
osmo_sock_get_name
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:1469
osmo_fd
Structure representing a file dsecriptor.
Definition: select.h:31
osmo_sockaddr_local_ip
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:1755
osmo_sock_init_sa
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
osmo_sock_mcast_iface_set
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:1602
osmo_sock_get_name2
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:1510
osmo_sock_get_local_ip
int osmo_sock_get_local_ip(int fd, char *host, size_t len)
Get local IP address on socket.
Definition: socket.c:1424
osmo_sockaddr_is_any
int osmo_sockaddr_is_any(const struct osmo_sockaddr *addr)
Determine if the given address is an ANY address ("0.0.0.0", "::").
Definition: socket.c:1183