Loading...
Searching...
No Matches
socket.h
Go to the documentation of this file.
#pragma once
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include <osmocom/core/defs.h>
#include <osmocom/core/socket_compat.h>
#define OSMO_SOCK_MAX_ADDRS 32
#define OSMO_SOCK_NAME_MAXLEN (2 + INET6_ADDRSTRLEN + 1 + 5 + 3 + 2 + INET6_ADDRSTRLEN + 1 + 5 + 1)
#define OSMO_SOCK_MULTIADDR_PEER_STR_MAXLEN (INET6_ADDRSTRLEN * OSMO_SOCK_MAX_ADDRS + INET6_ADDRSTRLEN + 2 + 6 + 1)
#define OSMO_SOCK_MULTIADDR_NAME_MAXLEN (OSMO_SOCK_MULTIADDR_PEER_STR_MAXLEN + 7)
struct osmo_fd;
struct sctp_paddrinfo;
struct osmo_sockaddr {
union {
struct sockaddr sa;
struct sockaddr_storage sas;
struct sockaddr_in sin;
struct sockaddr_in6 sin6;
} u;
};
int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen);
int osmo_sockaddr_is_any(const struct osmo_sockaddr *addr);
static inline socklen_t osmo_sockaddr_size(const struct osmo_sockaddr *addr)
{
if (!addr)
return 0;
#if __LIBOSMOCORE_HAVE_SYS_SOCKET_H
switch (addr->u.sa.sa_family) {
case AF_INET:
return sizeof(struct sockaddr_in);
case AF_INET6:
return sizeof(struct sockaddr_in6);
default:
return sizeof(struct osmo_sockaddr);
}
#else
return 0;
#endif /* if __LIBOSMOCORE_HAVE_SYS_SOCKET_H */
}
unsigned int osmo_sockaddr_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
const struct sockaddr *sa);
size_t osmo_sockaddr_in_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
const struct sockaddr_in *sin);
const char *osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst);
uint16_t osmo_sockaddr_port(const struct sockaddr *sa);
void osmo_sockaddr_set_port(struct sockaddr *sa, uint16_t port);
int osmo_sockaddr_local_ip(struct osmo_sockaddr *local_ip,
const struct osmo_sockaddr *remote_ip);
int osmo_sockaddr_cmp(const struct osmo_sockaddr *a,
const struct osmo_sockaddr *b);
int osmo_sockaddr_to_octets(uint8_t *dst, size_t dst_maxlen, const struct osmo_sockaddr *os);
int osmo_sockaddr_from_octets(struct osmo_sockaddr *os, const void *src, size_t src_len);
int osmo_sockaddr_from_str_and_uint(struct osmo_sockaddr *osa_out, const char *ipstr, uint16_t port);
int osmo_sockaddr_netmask_to_prefixlen(const struct osmo_sockaddr *addr);
const char *osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr);
char *osmo_sockaddr_to_str_buf(char *buf, size_t buf_len,
const struct osmo_sockaddr *sockaddr);
int osmo_sockaddr_to_str_buf2(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr);
char *osmo_sockaddr_to_str_c(void *ctx, const struct osmo_sockaddr *sockaddr);
/* flags for osmo_sock_init. */
#define OSMO_SOCK_F_CONNECT (1 << 0)
#define OSMO_SOCK_F_BIND (1 << 1)
#define OSMO_SOCK_F_NONBLOCK (1 << 2)
#define OSMO_SOCK_F_NO_MCAST_LOOP (1 << 3)
#define OSMO_SOCK_F_NO_MCAST_ALL (1 << 4)
#define OSMO_SOCK_F_UDP_REUSEADDR (1 << 5)
#define OSMO_SOCK_F_DSCP(x) (((x)&0x3f) << 24)
#define GET_OSMO_SOCK_F_DSCP(f) (((f) >> 24) & 0x3f)
#define OSMO_SOCK_F_PRIO(x) (((x)&0xff) << 16)
#define GET_OSMO_SOCK_F_PRIO(f) (((f) >> 16) & 0xff)
int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto,
const char *host, uint16_t port, unsigned int flags);
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);
struct osmo_sock_init2_multiaddr_pars {
union {
struct {
uint8_t version; /* set to 0 */
struct {
bool set;
bool abort_on_failure;
uint32_t value;
} sockopt_auth_supported;
struct {
bool set;
bool abort_on_failure;
uint32_t value;
} sockopt_asconf_supported;
struct {
bool set;
bool abort_on_failure;
bool num_ostreams_present;
bool max_instreams_present;
bool max_attempts_present;
bool max_init_timeo_present;
uint16_t num_ostreams_value;
uint16_t max_instreams_value;
uint16_t max_attempts_value;
uint16_t max_init_timeo_value;
} sockopt_initmsg;
} sctp;
};
};
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_DEPRECATED_OUTSIDE("Use osmo_sock_init2_multiaddr2() instead");
int osmo_sock_init2_multiaddr2(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, struct osmo_sock_init2_multiaddr_pars *pars);
int osmo_sock_init_osa(uint16_t type, uint8_t proto,
const struct osmo_sockaddr *local,
const struct osmo_sockaddr *remote,
unsigned int flags);
int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto,
const char *host, uint16_t port, unsigned int flags);
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);
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);
int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type,
uint8_t proto, unsigned int flags);
int osmo_sock_unix_init(uint16_t type, uint8_t proto,
const char *socket_path, unsigned int flags);
int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto,
const char *socket_path, unsigned int flags);
char *osmo_sock_get_name(const void *ctx, int fd);
const char *osmo_sock_get_name2(int fd);
char *osmo_sock_get_name2_c(const void *ctx, int fd);
int osmo_sock_get_name_buf(char *str, size_t str_len, int fd);
int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local);
int osmo_sock_get_local_ip(int fd, char *host, size_t len);
int osmo_sock_get_local_ip_port(int fd, char *port, size_t len);
int osmo_sock_get_remote_ip(int fd, char *host, size_t len);
int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len);
int osmo_sock_multiaddr_get_ip_and_port(int fd, int ip_proto, char *ip, size_t *ip_cnt, size_t ip_len,
char *port, size_t port_len, bool local);
int osmo_multiaddr_ip_and_port_snprintf(char *str, size_t str_len,
const char *ip, size_t ip_cnt, size_t ip_len,
const char *portbuf);
int osmo_sock_multiaddr_get_name_buf(char *str, size_t str_len, int fd, int sk_proto);
int osmo_sock_multiaddr_add_local_addr(int sfd, const char **addrs, size_t addrs_cnt);
int osmo_sock_multiaddr_del_local_addr(int sfd, const char **addrs, size_t addrs_cnt);
int osmo_sock_mcast_loop_set(int fd, bool enable);
int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl);
int osmo_sock_mcast_all_set(int fd, bool enable);
int osmo_sock_mcast_iface_set(int fd, const char *ifname);
int osmo_sock_mcast_subscribe(int fd, const char *grp_addr);
int osmo_sock_local_ip(char *local_ip, const char *remote_ip);
int osmo_sock_set_dscp(int fd, uint8_t dscp);
int osmo_sock_set_priority(int fd, int prio);
int osmo_sock_get_nonblock(int fd);
int osmo_sock_set_nonblock(int fd, int on);
int osmo_sock_sctp_get_peer_addr_info(int fd, struct sctp_paddrinfo *pinfo, size_t *pinfo_cnt);
defs.h
General definitions that are meant to be included from header files.
flags
uint16_t flags
osmo_sockaddr_cmp
int osmo_sockaddr_cmp(const struct osmo_sockaddr *a, const struct osmo_sockaddr *b)
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_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_multiaddr_add_local_addr
int osmo_sock_multiaddr_add_local_addr(int sfd, const char **addrs, size_t addrs_cnt)
osmo_sockaddr_size
static socklen_t osmo_sockaddr_size(const struct osmo_sockaddr *addr)
Return the size of the variant used in the address NOTE: This does not return the size of the in{,...
Definition socket.h:53
osmo_sockaddr_ntop
const char * osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst)
osmo_sock_get_local_ip
int osmo_sock_get_local_ip(int fd, char *host, size_t len)
osmo_sockaddr_set_port
void osmo_sockaddr_set_port(struct sockaddr *sa, uint16_t port)
osmo_sockaddr_to_str_buf
char * osmo_sockaddr_to_str_buf(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr)
osmo_sockaddr_to_str_c
char * osmo_sockaddr_to_str_c(void *ctx, const struct osmo_sockaddr *sockaddr)
osmo_sockaddr_port
uint16_t osmo_sockaddr_port(const struct sockaddr *sa)
osmo_sock_get_name2_c
char * osmo_sock_get_name2_c(const void *ctx, int fd)
osmo_sock_get_name
char * osmo_sock_get_name(const void *ctx, int fd)
osmo_sockaddr_local_ip
int osmo_sockaddr_local_ip(struct osmo_sockaddr *local_ip, const struct osmo_sockaddr *remote_ip)
osmo_sock_get_name_buf
int osmo_sock_get_name_buf(char *str, size_t str_len, int fd)
osmo_sockaddr_is_any
int osmo_sockaddr_is_any(const struct osmo_sockaddr *addr)
osmo_sock_set_priority
int osmo_sock_set_priority(int fd, int prio)
osmo_sock_mcast_loop_set
int osmo_sock_mcast_loop_set(int fd, bool enable)
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_sock_multiaddr_del_local_addr
int osmo_sock_multiaddr_del_local_addr(int sfd, const char **addrs, size_t addrs_cnt)
osmo_sockaddr_from_str_and_uint
int osmo_sockaddr_from_str_and_uint(struct osmo_sockaddr *osa_out, const char *ipstr, uint16_t port)
osmo_sock_get_local_ip_port
int osmo_sock_get_local_ip_port(int fd, char *port, size_t len)
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)
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_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_sock_sctp_get_peer_addr_info
int osmo_sock_sctp_get_peer_addr_info(int fd, struct sctp_paddrinfo *pinfo, size_t *pinfo_cnt)
osmo_sockaddr_to_octets
int osmo_sockaddr_to_octets(uint8_t *dst, size_t dst_maxlen, const struct osmo_sockaddr *os)
osmo_multiaddr_ip_and_port_snprintf
int osmo_multiaddr_ip_and_port_snprintf(char *str, size_t str_len, const char *ip, size_t ip_cnt, size_t ip_len, const char *portbuf)
osmo_sockaddr_netmask_to_prefixlen
int osmo_sockaddr_netmask_to_prefixlen(const struct osmo_sockaddr *addr)
osmo_sockaddr_to_str
const char * osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr)
osmo_sock_get_name2
const char * osmo_sock_get_name2(int fd)
osmo_sock_get_remote_ip_port
int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len)
osmo_sock_mcast_all_set
int osmo_sock_mcast_all_set(int fd, bool enable)
osmo_sockaddr_to_str_buf2
int osmo_sockaddr_to_str_buf2(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr)
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_sockaddr_from_octets
int osmo_sockaddr_from_octets(struct osmo_sockaddr *os, const void *src, size_t src_len)
osmo_sock_multiaddr_get_ip_and_port
int osmo_sock_multiaddr_get_ip_and_port(int fd, int ip_proto, char *ip, size_t *ip_cnt, size_t ip_len, char *port, size_t port_len, bool local)
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_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_mcast_ttl_set
int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl)
osmo_sock_set_dscp
int osmo_sock_set_dscp(int fd, uint8_t dscp)
osmo_sock_init2_multiaddr2
int osmo_sock_init2_multiaddr2(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, struct osmo_sock_init2_multiaddr_pars *pars)
osmo_sockaddr_is_local
int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen)
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_DEPRECATED_OUTSIDE("Use osmo_sock_init2_multiaddr2() instead")
osmo_sock_get_remote_ip
int osmo_sock_get_remote_ip(int fd, char *host, size_t len)
osmo_sock_mcast_iface_set
int osmo_sock_mcast_iface_set(int fd, const char *ifname)
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_unix_init
int osmo_sock_unix_init(uint16_t type, uint8_t proto, const char *socket_path, unsigned int flags)
osmo_sock_init_sa
int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type, uint8_t proto, unsigned int flags)
osmo_sock_get_nonblock
int osmo_sock_get_nonblock(int fd)
osmo_sock_local_ip
int osmo_sock_local_ip(char *local_ip, const char *remote_ip)
osmo_sock_set_nonblock
int osmo_sock_set_nonblock(int fd, int on)
osmo_sock_mcast_subscribe
int osmo_sock_mcast_subscribe(int fd, const char *grp_addr)
osmo_sock_multiaddr_get_name_buf
int osmo_sock_multiaddr_get_name_buf(char *str, size_t str_len, int fd, int sk_proto)
OSMO_DEPRECATED_OUTSIDE
#define OSMO_DEPRECATED_OUTSIDE(text)
Definition defs.h:49
type
uint8_t type
len
uint8_t len
proto
uint8_t proto
socket_compat.h
host
osmo_fd
Structure representing a file dsecriptor.
Definition select.h:31
osmo_sock_init2_multiaddr_pars
Definition socket.h:127
osmo_sock_init2_multiaddr_pars::sockopt_asconf_supported
struct osmo_sock_init2_multiaddr_pars::@013314032204163361065045065316156136211335116256::@362356115315357053165370110274344161055360220043::@040121362066232217341077000255172313246146014026 sockopt_asconf_supported
osmo_sock_init2_multiaddr_pars::version
uint8_t version
Definition socket.h:130
osmo_sock_init2_multiaddr_pars::max_init_timeo_present
bool max_init_timeo_present
Definition socket.h:147
osmo_sock_init2_multiaddr_pars::abort_on_failure
bool abort_on_failure
Definition socket.h:133
osmo_sock_init2_multiaddr_pars::set
bool set
Definition socket.h:132
osmo_sock_init2_multiaddr_pars::sockopt_initmsg
struct osmo_sock_init2_multiaddr_pars::@013314032204163361065045065316156136211335116256::@362356115315357053165370110274344161055360220043::@201364306262373173174166311302017002301104213063 sockopt_initmsg
osmo_sock_init2_multiaddr_pars::max_init_timeo_value
uint16_t max_init_timeo_value
Definition socket.h:151
osmo_sock_init2_multiaddr_pars::max_instreams_value
uint16_t max_instreams_value
Definition socket.h:149
osmo_sock_init2_multiaddr_pars::num_ostreams_value
uint16_t num_ostreams_value
Definition socket.h:148
osmo_sock_init2_multiaddr_pars::sctp
struct osmo_sock_init2_multiaddr_pars::@013314032204163361065045065316156136211335116256::@362356115315357053165370110274344161055360220043 sctp
osmo_sock_init2_multiaddr_pars::max_attempts_present
bool max_attempts_present
Definition socket.h:146
osmo_sock_init2_multiaddr_pars::value
uint32_t value
Definition socket.h:134
osmo_sock_init2_multiaddr_pars::sockopt_auth_supported
struct osmo_sock_init2_multiaddr_pars::@013314032204163361065045065316156136211335116256::@362356115315357053165370110274344161055360220043::@275061365157253352007267326026230350230026040324 sockopt_auth_supported
osmo_sock_init2_multiaddr_pars::num_ostreams_present
bool num_ostreams_present
Definition socket.h:144
osmo_sock_init2_multiaddr_pars::max_instreams_present
bool max_instreams_present
Definition socket.h:145
osmo_sock_init2_multiaddr_pars::max_attempts_value
uint16_t max_attempts_value
Definition socket.h:150
osmo_sockaddr
Definition socket.h:33
osmo_sockaddr::sas
struct sockaddr_storage sas
Definition socket.h:36
osmo_sockaddr::u
union osmo_sockaddr::@010045150164115123266360317223041100224347340175 u
osmo_sockaddr::sin
struct sockaddr_in sin
Definition socket.h:37
osmo_sockaddr::sin6
struct sockaddr_in6 sin6
Definition socket.h:38
osmo_sockaddr::sa
struct sockaddr sa
Definition socket.h:35