Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 1 | /*! \file socket.h |
| 2 | * Osmocom socket convenience functions. */ |
| 3 | |
Sylvain Munaut | 12ba778 | 2014-06-16 10:13:40 +0200 | [diff] [blame] | 4 | #pragma once |
Alexander Couzens | 8419bb2 | 2020-06-07 18:10:13 +0200 | [diff] [blame] | 5 | #if (!EMBEDDED) |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 6 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 7 | /*! \defgroup socket Socket convenience functions |
| 8 | * @{ |
Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 9 | * \file socket.h */ |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 10 | |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 11 | #include <stdint.h> |
Harald Welte | e30d7e6 | 2017-07-13 16:02:50 +0200 | [diff] [blame] | 12 | #include <stdbool.h> |
Oliver Smith | 7acd5d0 | 2018-10-25 11:16:36 +0200 | [diff] [blame] | 13 | #include <stddef.h> |
Harald Welte | e476442 | 2011-05-22 12:25:57 +0200 | [diff] [blame] | 14 | |
Max | b3e9b31 | 2019-02-04 14:06:31 +0100 | [diff] [blame] | 15 | #include <arpa/inet.h> |
| 16 | |
Pau Espin Pedrol | 658c509 | 2023-09-08 13:02:14 +0200 | [diff] [blame] | 17 | #include <osmocom/core/defs.h> |
| 18 | |
Pau Espin Pedrol | a37921a | 2023-12-12 14:00:10 +0100 | [diff] [blame] | 19 | /*! maximum number of local or remote addresses supported by an osmo_sock instance */ |
| 20 | #define OSMO_SOCK_MAX_ADDRS 32 |
| 21 | |
Max | b3e9b31 | 2019-02-04 14:06:31 +0100 | [diff] [blame] | 22 | /*! maximum length of a socket name ("r=1.2.3.4:123<->l=5.6.7.8:987") */ |
| 23 | #define OSMO_SOCK_NAME_MAXLEN (2 + INET6_ADDRSTRLEN + 1 + 5 + 3 + 2 + INET6_ADDRSTRLEN + 1 + 5 + 1) |
Max | b3e9b31 | 2019-02-04 14:06:31 +0100 | [diff] [blame] | 24 | |
Pau Espin Pedrol | a37921a | 2023-12-12 14:00:10 +0100 | [diff] [blame] | 25 | /*! maximum length of a multi-address socket peer (endpoint) name: (5.6.7.8|::9):987 |
| 26 | * char '(' + OSMO_STREAM_MAX_ADDRS - 1 addr separators + chars "):" + port buffer + char '\0' |
| 27 | */ |
| 28 | #define OSMO_SOCK_MULTIADDR_PEER_STR_MAXLEN (INET6_ADDRSTRLEN * OSMO_SOCK_MAX_ADDRS + INET6_ADDRSTRLEN + 2 + 6 + 1) |
| 29 | /*! maximum length of a multia-address socket name ("r=(::2|1.2.3.4):123<->l=(5.6.7.8|::9):987") */ |
| 30 | #define OSMO_SOCK_MULTIADDR_NAME_MAXLEN (OSMO_SOCK_MULTIADDR_PEER_STR_MAXLEN + 7) |
| 31 | |
| 32 | |
Max | 9d7a247 | 2018-11-20 15:18:31 +0100 | [diff] [blame] | 33 | struct sockaddr_in; |
Harald Welte | e476442 | 2011-05-22 12:25:57 +0200 | [diff] [blame] | 34 | struct sockaddr; |
Holger Hans Peter Freyther | 58d3153 | 2012-03-16 09:18:12 +0100 | [diff] [blame] | 35 | struct osmo_fd; |
Pau Espin Pedrol | 19f27bb | 2023-12-08 14:58:51 +0100 | [diff] [blame] | 36 | struct sctp_paddrinfo; |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 37 | |
Alexander Couzens | 8419bb2 | 2020-06-07 18:10:13 +0200 | [diff] [blame] | 38 | struct osmo_sockaddr { |
| 39 | union { |
| 40 | struct sockaddr sa; |
| 41 | struct sockaddr_storage sas; |
| 42 | struct sockaddr_in sin; |
| 43 | struct sockaddr_in6 sin6; |
| 44 | } u; |
| 45 | }; |
| 46 | |
Pau Espin Pedrol | 3c12f55 | 2022-10-04 12:31:00 +0200 | [diff] [blame] | 47 | int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen); |
Pau Espin Pedrol | 3b3955b | 2022-10-04 12:38:49 +0200 | [diff] [blame] | 48 | int osmo_sockaddr_is_any(const struct osmo_sockaddr *addr); |
Pau Espin Pedrol | 3c12f55 | 2022-10-04 12:31:00 +0200 | [diff] [blame] | 49 | |
Daniel Willmann | 45ae1c5 | 2023-01-25 09:55:57 +0100 | [diff] [blame] | 50 | /*! Return the size of the variant used in the address |
| 51 | * NOTE: This does not return the size of the in{,6}_addr, but rather the size of the |
| 52 | * surrounding sockaddr_in{,6}. |
| 53 | * \param[in] addr the osmo_sockaddr to get the size of |
| 54 | * \return the size of the struct variant being used. If the value in sa_family is unsupported it will return |
| 55 | * the size of struct osmo_sockaddr. Returns 0 if addr is NULL. This way it can simply be a wrapper for sendto() |
| 56 | * which can be called with NULL/0 for dest_addr / addrlen (and then behaves like a send() call). |
| 57 | */ |
| 58 | static inline socklen_t osmo_sockaddr_size(const struct osmo_sockaddr *addr) |
| 59 | { |
| 60 | if (!addr) |
| 61 | return 0; |
| 62 | |
| 63 | switch (addr->u.sa.sa_family) { |
| 64 | case AF_INET: |
| 65 | return sizeof(struct sockaddr_in); |
| 66 | case AF_INET6: |
| 67 | return sizeof(struct sockaddr_in6); |
| 68 | default: |
| 69 | return sizeof(struct osmo_sockaddr); |
| 70 | } |
| 71 | } |
| 72 | |
Pau Espin Pedrol | 3c12f55 | 2022-10-04 12:31:00 +0200 | [diff] [blame] | 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 | const char *osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst); |
| 79 | uint16_t osmo_sockaddr_port(const struct sockaddr *sa); |
| 80 | void osmo_sockaddr_set_port(struct sockaddr *sa, uint16_t port); |
| 81 | |
| 82 | int osmo_sockaddr_local_ip(struct osmo_sockaddr *local_ip, |
| 83 | const struct osmo_sockaddr *remote_ip); |
| 84 | int osmo_sockaddr_cmp(const struct osmo_sockaddr *a, |
| 85 | const struct osmo_sockaddr *b); |
| 86 | |
| 87 | int osmo_sockaddr_to_octets(uint8_t *dst, size_t dst_maxlen, const struct osmo_sockaddr *os); |
| 88 | int osmo_sockaddr_from_octets(struct osmo_sockaddr *os, const void *src, size_t src_len); |
Harald Welte | 641cc3c | 2023-11-21 19:45:57 +0100 | [diff] [blame] | 89 | int osmo_sockaddr_from_str_and_uint(struct osmo_sockaddr *osa_out, const char *ipstr, uint16_t port); |
Pau Espin Pedrol | 3c12f55 | 2022-10-04 12:31:00 +0200 | [diff] [blame] | 90 | |
Pau Espin Pedrol | cc296c9 | 2023-01-16 14:54:55 +0100 | [diff] [blame] | 91 | int osmo_sockaddr_netmask_to_prefixlen(const struct osmo_sockaddr *addr); |
| 92 | |
Pau Espin Pedrol | 3c12f55 | 2022-10-04 12:31:00 +0200 | [diff] [blame] | 93 | const char *osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr); |
| 94 | char *osmo_sockaddr_to_str_buf(char *buf, size_t buf_len, |
| 95 | const struct osmo_sockaddr *sockaddr); |
| 96 | int osmo_sockaddr_to_str_buf2(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr); |
| 97 | char *osmo_sockaddr_to_str_c(void *ctx, const struct osmo_sockaddr *sockaddr); |
| 98 | |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 99 | /* flags for osmo_sock_init. */ |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 100 | /*! connect the socket to a remote peer */ |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 101 | #define OSMO_SOCK_F_CONNECT (1 << 0) |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 102 | /*! bind the socket to a local address/port */ |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 103 | #define OSMO_SOCK_F_BIND (1 << 1) |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 104 | /*! switch socket to non-blocking mode */ |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 105 | #define OSMO_SOCK_F_NONBLOCK (1 << 2) |
Harald Welte | bc43a62 | 2017-07-13 16:20:21 +0200 | [diff] [blame] | 106 | /*! disable multiast loop (IP_MULTICAST_LOOP) */ |
| 107 | #define OSMO_SOCK_F_NO_MCAST_LOOP (1 << 3) |
Harald Welte | 37d204a | 2017-07-13 16:33:16 +0200 | [diff] [blame] | 108 | /*! disable receiving all multiast even for non-subscribed groups */ |
| 109 | #define OSMO_SOCK_F_NO_MCAST_ALL (1 << 4) |
Philipp Maier | 73196e7 | 2018-08-23 20:11:50 +0200 | [diff] [blame] | 110 | /*! use SO_REUSEADDR on UDP ports (required for multicast) */ |
| 111 | #define OSMO_SOCK_F_UDP_REUSEADDR (1 << 5) |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 112 | |
Harald Welte | c545ff6 | 2021-04-28 13:09:49 +0200 | [diff] [blame] | 113 | /*! use OSMO_SOCK_F_DSCP(x) to set IP DSCP 'x' for packets transmitted on the socket */ |
| 114 | #define OSMO_SOCK_F_DSCP(x) (((x)&0x3f) << 24) |
| 115 | #define GET_OSMO_SOCK_F_DSCP(f) (((f) >> 24) & 0x3f) |
| 116 | |
| 117 | /*! use OSMO_SOCK_F_PRIO(x) to set priority 'x' for packets transmitted on the socket */ |
| 118 | #define OSMO_SOCK_F_PRIO(x) (((x)&0xff) << 16) |
| 119 | #define GET_OSMO_SOCK_F_PRIO(f) (((f) >> 16) & 0xff) |
| 120 | |
| 121 | |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 122 | int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto, |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 123 | const char *host, uint16_t port, unsigned int flags); |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 124 | |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 125 | int osmo_sock_init2(uint16_t family, uint16_t type, uint8_t proto, |
| 126 | const char *local_host, uint16_t local_port, |
| 127 | const char *remote_host, uint16_t remote_port, unsigned int flags); |
| 128 | |
Pau Espin Pedrol | 658c509 | 2023-09-08 13:02:14 +0200 | [diff] [blame] | 129 | struct osmo_sock_init2_multiaddr_pars { |
| 130 | union { |
| 131 | struct { |
| 132 | uint8_t version; /* set to 0 */ |
| 133 | struct { |
| 134 | bool set; |
| 135 | bool abort_on_failure; |
| 136 | uint32_t value; |
| 137 | } sockopt_auth_supported; |
| 138 | struct { |
| 139 | bool set; |
| 140 | bool abort_on_failure; |
| 141 | uint32_t value; |
| 142 | } sockopt_asconf_supported; |
Pau Espin Pedrol | a45b0be | 2023-09-08 13:42:50 +0200 | [diff] [blame] | 143 | struct { |
| 144 | bool set; |
| 145 | bool abort_on_failure; |
| 146 | bool num_ostreams_present; |
| 147 | bool max_instreams_present; |
| 148 | bool max_attempts_present; |
| 149 | bool max_init_timeo_present; |
| 150 | uint16_t num_ostreams_value; |
| 151 | uint16_t max_instreams_value; |
| 152 | uint16_t max_attempts_value; |
| 153 | uint16_t max_init_timeo_value; |
| 154 | } sockopt_initmsg; |
Pau Espin Pedrol | 658c509 | 2023-09-08 13:02:14 +0200 | [diff] [blame] | 155 | } sctp; |
| 156 | }; |
| 157 | }; |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 158 | int osmo_sock_init2_multiaddr(uint16_t family, uint16_t type, uint8_t proto, |
| 159 | const char **local_hosts, size_t local_hosts_cnt, uint16_t local_port, |
Pau Espin Pedrol | 658c509 | 2023-09-08 13:02:14 +0200 | [diff] [blame] | 160 | const char **remote_hosts, size_t remote_hosts_cnt, uint16_t remote_port, unsigned int flags) |
| 161 | OSMO_DEPRECATED_OUTSIDE("Use osmo_sock_init2_multiaddr2() instead"); |
| 162 | int osmo_sock_init2_multiaddr2(uint16_t family, uint16_t type, uint8_t proto, |
| 163 | const char **local_hosts, size_t local_hosts_cnt, uint16_t local_port, |
| 164 | const char **remote_hosts, size_t remote_hosts_cnt, uint16_t remote_port, |
| 165 | unsigned int flags, struct osmo_sock_init2_multiaddr_pars *pars); |
| 166 | |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 167 | int osmo_sock_init_osa(uint16_t type, uint8_t proto, |
| 168 | const struct osmo_sockaddr *local, |
| 169 | const struct osmo_sockaddr *remote, |
| 170 | unsigned int flags); |
| 171 | |
Harald Welte | 68b1574 | 2011-05-22 21:47:29 +0200 | [diff] [blame] | 172 | int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto, |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 173 | const char *host, uint16_t port, unsigned int flags); |
Harald Welte | 68b1574 | 2011-05-22 21:47:29 +0200 | [diff] [blame] | 174 | |
Pau Espin Pedrol | 75989e6 | 2017-05-26 12:39:53 +0200 | [diff] [blame] | 175 | int osmo_sock_init2_ofd(struct osmo_fd *ofd, int family, int type, int proto, |
| 176 | const char *local_host, uint16_t local_port, |
| 177 | const char *remote_host, uint16_t remote_port, unsigned int flags); |
| 178 | |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 179 | int osmo_sock_init_osa_ofd(struct osmo_fd *ofd, int type, int proto, |
| 180 | const struct osmo_sockaddr *local, |
| 181 | const struct osmo_sockaddr *remote, |
| 182 | unsigned int flags); |
| 183 | |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 184 | int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type, |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 185 | uint8_t proto, unsigned int flags); |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 186 | |
Álvaro Neira Ayuso | 5ade61a | 2014-03-24 13:02:00 +0100 | [diff] [blame] | 187 | int osmo_sock_unix_init(uint16_t type, uint8_t proto, |
| 188 | const char *socket_path, unsigned int flags); |
| 189 | |
| 190 | int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto, |
| 191 | const char *socket_path, unsigned int flags); |
| 192 | |
Harald Welte | c0dfc9d | 2019-03-18 18:29:43 +0100 | [diff] [blame] | 193 | char *osmo_sock_get_name(const void *ctx, int fd); |
Neels Hofmeyr | 0145751 | 2018-12-12 01:48:54 +0100 | [diff] [blame] | 194 | const char *osmo_sock_get_name2(int fd); |
Harald Welte | 179f357 | 2019-03-18 18:38:47 +0100 | [diff] [blame] | 195 | char *osmo_sock_get_name2_c(const void *ctx, int fd); |
Neels Hofmeyr | 0145751 | 2018-12-12 01:48:54 +0100 | [diff] [blame] | 196 | int osmo_sock_get_name_buf(char *str, size_t str_len, int fd); |
| 197 | int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local); |
Oliver Smith | 7acd5d0 | 2018-10-25 11:16:36 +0200 | [diff] [blame] | 198 | int osmo_sock_get_local_ip(int fd, char *host, size_t len); |
| 199 | int osmo_sock_get_local_ip_port(int fd, char *port, size_t len); |
| 200 | int osmo_sock_get_remote_ip(int fd, char *host, size_t len); |
| 201 | int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len); |
| 202 | |
Pau Espin Pedrol | 6a2975c | 2023-11-30 18:15:30 +0100 | [diff] [blame] | 203 | int osmo_sock_multiaddr_get_ip_and_port(int fd, int ip_proto, char *ip, size_t *ip_cnt, size_t ip_len, |
| 204 | char *port, size_t port_len, bool local); |
Pau Espin Pedrol | 5ac8aa5 | 2023-11-30 19:12:16 +0100 | [diff] [blame] | 205 | int osmo_multiaddr_ip_and_port_snprintf(char *str, size_t str_len, |
| 206 | const char *ip, size_t ip_cnt, size_t ip_len, |
| 207 | const char *portbuf); |
| 208 | int osmo_sock_multiaddr_get_name_buf(char *str, size_t str_len, int fd, int sk_proto); |
Pau Espin Pedrol | 64ba9ed | 2023-09-29 19:21:10 +0200 | [diff] [blame] | 209 | int osmo_sock_multiaddr_add_local_addr(int sfd, const char **addrs, size_t addrs_cnt); |
| 210 | int osmo_sock_multiaddr_del_local_addr(int sfd, const char **addrs, size_t addrs_cnt); |
Harald Welte | 48f5583 | 2017-01-26 00:03:10 +0100 | [diff] [blame] | 211 | |
Harald Welte | e30d7e6 | 2017-07-13 16:02:50 +0200 | [diff] [blame] | 212 | int osmo_sock_mcast_loop_set(int fd, bool enable); |
| 213 | int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl); |
| 214 | int osmo_sock_mcast_all_set(int fd, bool enable); |
Harald Welte | 44b9926 | 2020-03-07 14:59:05 +0100 | [diff] [blame] | 215 | int osmo_sock_mcast_iface_set(int fd, const char *ifname); |
Harald Welte | e30d7e6 | 2017-07-13 16:02:50 +0200 | [diff] [blame] | 216 | int osmo_sock_mcast_subscribe(int fd, const char *grp_addr); |
| 217 | |
Philipp Maier | 2d2490e | 2017-10-20 19:41:26 +0200 | [diff] [blame] | 218 | int osmo_sock_local_ip(char *local_ip, const char *remote_ip); |
| 219 | |
Harald Welte | ce53e03 | 2021-04-27 21:44:34 +0200 | [diff] [blame] | 220 | int osmo_sock_set_dscp(int fd, uint8_t dscp); |
Harald Welte | ecc0bd8 | 2021-04-27 22:24:08 +0200 | [diff] [blame] | 221 | int osmo_sock_set_priority(int fd, int prio); |
Harald Welte | ce53e03 | 2021-04-27 21:44:34 +0200 | [diff] [blame] | 222 | |
Pau Espin Pedrol | 19f27bb | 2023-12-08 14:58:51 +0100 | [diff] [blame] | 223 | int osmo_sock_sctp_get_peer_addr_info(int fd, struct sctp_paddrinfo *pinfo, size_t *pinfo_cnt); |
| 224 | |
Alexander Couzens | 8419bb2 | 2020-06-07 18:10:13 +0200 | [diff] [blame] | 225 | #endif /* (!EMBEDDED) */ |
Sylvain Munaut | dca7d2c | 2012-04-18 21:53:23 +0200 | [diff] [blame] | 226 | /*! @} */ |