libosmocore  1.4.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 /* 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_MAX_ADDRS 32
49 
50 int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto,
51  const char *host, uint16_t port, unsigned int flags);
52 
53 int osmo_sock_init2(uint16_t family, uint16_t type, uint8_t proto,
54  const char *local_host, uint16_t local_port,
55  const char *remote_host, uint16_t remote_port, unsigned int flags);
56 
57 int osmo_sock_init2_multiaddr(uint16_t family, uint16_t type, uint8_t proto,
58  const char **local_hosts, size_t local_hosts_cnt, uint16_t local_port,
59  const char **remote_hosts, size_t remote_hosts_cnt, uint16_t remote_port, unsigned int flags);
60 
61 int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto,
62  const char *host, uint16_t port, unsigned int flags);
63 
64 int osmo_sock_init2_ofd(struct osmo_fd *ofd, int family, int type, int proto,
65  const char *local_host, uint16_t local_port,
66  const char *remote_host, uint16_t remote_port, unsigned int flags);
67 
68 int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type,
69  uint8_t proto, unsigned int flags);
70 
71 int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen);
72 
73 unsigned int osmo_sockaddr_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
74  const struct sockaddr *sa);
75 size_t osmo_sockaddr_in_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
76  const struct sockaddr_in *sin);
77 
78 int osmo_sock_unix_init(uint16_t type, uint8_t proto,
79  const char *socket_path, unsigned int flags);
80 
81 int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto,
82  const char *socket_path, unsigned int flags);
83 
84 char *osmo_sock_get_name(const void *ctx, int fd);
85 const char *osmo_sock_get_name2(int fd);
86 char *osmo_sock_get_name2_c(const void *ctx, int fd);
87 int osmo_sock_get_name_buf(char *str, size_t str_len, int fd);
88 int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local);
89 int osmo_sock_get_local_ip(int fd, char *host, size_t len);
90 int osmo_sock_get_local_ip_port(int fd, char *port, size_t len);
91 int osmo_sock_get_remote_ip(int fd, char *host, size_t len);
92 int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len);
93 
94 
95 int osmo_sock_mcast_loop_set(int fd, bool enable);
96 int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl);
97 int osmo_sock_mcast_all_set(int fd, bool enable);
98 int osmo_sock_mcast_iface_set(int fd, const char *ifname);
99 int osmo_sock_mcast_subscribe(int fd, const char *grp_addr);
100 
101 int osmo_sock_local_ip(char *local_ip, const char *remote_ip);
102 
103 #endif /* (!EMBEDDED) */
104 
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:1219
osmo_sockaddr::sa
struct sockaddr sa
Definition: socket.h:26
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:666
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:1110
len
static size_t len(const char *str)
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:1186
osmo_sockaddr
Definition: socket.h:24
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:966
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:1287
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:1099
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:1043
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:787
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:1244
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:1319
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:925
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:895
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:259
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:480
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:944
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:1058
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:1358
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:808
osmo_sockaddr::sin
struct sockaddr_in sin
Definition: socket.h:28
host
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:1150
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:1121
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:1133
osmo_fd
Structure representing a file dsecriptor.
Definition: select.h:29
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:826
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:1266
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:1174
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:1088
osmo_sockaddr::u
union osmo_sockaddr::@21 u