net.h revision 727d691bba4385eb725204f40dc5ecdaf42da8e9
3e55775bc7a37ebc05e06c04cafb32eee9888e87Timo Sirainen unsigned short family;
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* maxmimum string length of IP address */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen#define IPADDR_IS_V4(ip) ((ip)->family == AF_INET)
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen#define IPADDR_IS_V6(ip) ((ip)->family == AF_INET6)
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen#define IPADDR_BITS(ip) (IPADDR_IS_V4(ip) ? 32 : 128)
a6f281d078ed03d555802c1a8e15fefce80132dcTimo Sirainen /* Try to use SO_REUSEPORT if available. If it's not, this flag is
a6f281d078ed03d555802c1a8e15fefce80132dcTimo Sirainen cleared on return. */
a6f281d078ed03d555802c1a8e15fefce80132dcTimo Sirainen/* INADDR_ANY for IPv4 or IPv6. The IPv6 any address may
a6f281d078ed03d555802c1a8e15fefce80132dcTimo Sirainen include IPv4 depending on the system (Linux yes, BSD no). */
204ee6ed414f5e4eeb6f6c10763b55daf56f11acJosef 'Jeff' Sipek/* Returns TRUE if IPs are the same */
a6f281d078ed03d555802c1a8e15fefce80132dcTimo Sirainenbool net_ip_compare(const struct ip_addr *ip1, const struct ip_addr *ip2);
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* Returns 0 if IPs are the same, -1 or 1 otherwise. */
6967fa47dde9f2726bd86019a50627dacf2d7509Timo Sirainenint net_ip_cmp(const struct ip_addr *ip1, const struct ip_addr *ip2);
6967fa47dde9f2726bd86019a50627dacf2d7509Timo Sirainenunsigned int net_ip_hash(const struct ip_addr *ip);
c1d4780bc0c9017e8e5d366b81e4fad31174c0adTimo Sirainen/* Connect to TCP socket with ip address. The socket and connect() is
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen non-blocking. */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainenint net_connect_ip(const struct ip_addr *ip, in_port_t port,
a94936bafd127680184da114c6a177b37ff656e5Timo Sirainen/* Like net_connect_ip(), but do a blocking connect(). */
a94936bafd127680184da114c6a177b37ff656e5Timo Sirainenint net_connect_ip_blocking(const struct ip_addr *ip, in_port_t port,
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* Like net_connect_ip(), but open a UDP socket. */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainenint net_connect_udp(const struct ip_addr *ip, in_port_t port,
597dba3488c648ffb375ee4a552bd52ac4346979Timo Sirainen/* Returns 0 if we can bind() as given IP, -1 if not. */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* Connect to named UNIX socket */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* Try to connect to UNIX socket for give number of seconds when connect()
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen returns EAGAIN or ECONNREFUSED. */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainenint net_connect_unix_with_retries(const char *path, unsigned int msecs);
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* Disconnect socket */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* Set socket blocking/nonblocking */
7bcb308d0e13dfa48b483b0addccd889a77bb598Timo Sirainen/* Set TCP_CORK if supported, ie. don't send out partial frames.
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen Returns 0 if ok, -1 if failed. */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainenint net_set_cork(int fd, bool cork) ATTR_NOWARN_UNUSED_RESULT;
fcca16701767c6b92227a9ee125de69d257882f6Timo Sirainen/* Set TCP_NODELAY, which disables the Nagle algorithm. */
fcca16701767c6b92227a9ee125de69d257882f6Timo Sirainen/* Set socket kernel buffer sizes */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainenint net_set_send_buffer_size(int fd, size_t size);
3e55775bc7a37ebc05e06c04cafb32eee9888e87Timo Sirainenint net_set_recv_buffer_size(int fd, size_t size);
34830cefe1757de0ffca67acdc529d5bc8b06b66Timo Sirainen/* Listen for connections on a socket */
9e406b04bb5bed7d73aeed375c40c6a3fea1a2cbTimo Sirainenint net_listen(const struct ip_addr *my_ip, in_port_t *port, int backlog);
4307c886579381dbb1897ea1388ae6978c96f560Timo Sirainenint net_listen_full(const struct ip_addr *my_ip, in_port_t *port,
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* Listen for connections on an UNIX socket */
34830cefe1757de0ffca67acdc529d5bc8b06b66Timo Sirainenint net_listen_unix(const char *path, int backlog);
3e55775bc7a37ebc05e06c04cafb32eee9888e87Timo Sirainen/* Like net_listen_unix(), but if socket already exists, try to connect to it.
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen If it fails with ECONNREFUSED, unlink the socket and try creating it
159de4e2ce3f541a9aa745d158b31203a40711e1Timo Sirainenint net_listen_unix_unlink_stale(const char *path, int backlog);
159de4e2ce3f541a9aa745d158b31203a40711e1Timo Sirainen/* Accept a connection on a socket. Returns -1 if the connection got closed,
ac6bba612af5207c24f6f02497d64b0ea03e7bbdTimo Sirainen -2 for other failures. For UNIX sockets addr_r->family=port=0. */
ac6bba612af5207c24f6f02497d64b0ea03e7bbdTimo Sirainenint net_accept(int fd, struct ip_addr *addr_r, in_port_t *port_r)
7bcb308d0e13dfa48b483b0addccd889a77bb598Timo Sirainen/* Read data from socket, return number of bytes read,
7bcb308d0e13dfa48b483b0addccd889a77bb598Timo Sirainen -1 = error, -2 = disconnected */
7bcb308d0e13dfa48b483b0addccd889a77bb598Timo Sirainenssize_t net_receive(int fd, void *buf, size_t len);
7bcb308d0e13dfa48b483b0addccd889a77bb598Timo Sirainen/* Transmit data, return number of bytes sent, -1 = error, -2 = disconnected */
7bcb308d0e13dfa48b483b0addccd889a77bb598Timo Sirainenssize_t net_transmit(int fd, const void *data, size_t len);
7f74811b78f8915e73dffc88bb49009e98b6846dTimo Sirainen/* Get IP addresses for host. ips contains ips_count of IPs, they don't need
7f74811b78f8915e73dffc88bb49009e98b6846dTimo Sirainen to be free'd. Returns 0 = ok, others = error code for net_gethosterror() */
159de4e2ce3f541a9aa745d158b31203a40711e1Timo Sirainenint net_gethostbyname(const char *addr, struct ip_addr **ips,
7bcb308d0e13dfa48b483b0addccd889a77bb598Timo Sirainen unsigned int *ips_count);
7f74811b78f8915e73dffc88bb49009e98b6846dTimo Sirainen/* Return host for the IP address. Returns 0 = ok, others = error code for
7f74811b78f8915e73dffc88bb49009e98b6846dTimo Sirainen net_gethosterror(). */
7f74811b78f8915e73dffc88bb49009e98b6846dTimo Sirainenint net_gethostbyaddr(const struct ip_addr *ip, const char **name_r);
7bcb308d0e13dfa48b483b0addccd889a77bb598Timo Sirainen/* get error of net_gethostname() */
3fe5eaeb32a8bbc31ce0673793b1c37f72d00d47Timo Sirainenconst char *net_gethosterror(int error) ATTR_CONST;
7bcb308d0e13dfa48b483b0addccd889a77bb598Timo Sirainen/* return TRUE if host lookup failed because it didn't exist (ie. not
7bcb308d0e13dfa48b483b0addccd889a77bb598Timo Sirainen some error with name server) */
7bcb308d0e13dfa48b483b0addccd889a77bb598Timo Sirainenint net_hosterror_notfound(int error) ATTR_CONST;
159de4e2ce3f541a9aa745d158b31203a40711e1Timo Sirainen/* Get socket local address/port. For UNIX sockets addr->family=port=0. */
159de4e2ce3f541a9aa745d158b31203a40711e1Timo Sirainenint net_getsockname(int fd, struct ip_addr *addr, in_port_t *port)
159de4e2ce3f541a9aa745d158b31203a40711e1Timo Sirainen/* Get socket remote address/port. For UNIX sockets addr->family=port=0. */
7bcb308d0e13dfa48b483b0addccd889a77bb598Timo Sirainenint net_getpeername(int fd, struct ip_addr *addr, in_port_t *port)
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* Get UNIX socket name. */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainenint net_getunixname(int fd, const char **name_r);
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* Get UNIX socket peer process's credentials. The pid may be (pid_t)-1 if
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen unavailable. */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainenint net_getunixcred(int fd, struct net_unix_cred *cred_r);
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* Returns ip_addr as string, or "" if ip isn't valid IPv4 or IPv6 address. */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainenconst char *net_ip2addr(const struct ip_addr *ip);
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* char* -> struct ip_addr translation. */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainenint net_addr2ip(const char *addr, struct ip_addr *ip);
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* char* -> in_port_t translation */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainenint net_str2port(const char *str, in_port_t *port_r);
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* char* -> in_port_t translation (allows port zero) */
8d56f3334e22619abf56833d290bb1f49ac6722cTimo Sirainenint net_str2port_zero(const char *str, in_port_t *port_r);
8d56f3334e22619abf56833d290bb1f49ac6722cTimo Sirainen/* Parse "host", "host:port", "IPv4", "IPv4:port", "IPv6", "[IPv6]" or
2c42748505ef4aed83ff59b34e50ed5606900c86Timo Sirainen "[IPv6]:port" to its host and port components. [IPv6] address is returned
2c42748505ef4aed83ff59b34e50ed5606900c86Timo Sirainen without []. If no port is given, return default_port. The :port in the
2c42748505ef4aed83ff59b34e50ed5606900c86Timo Sirainen parsed string isn't allowed to be zero, but default_port=0 is passed
b8c009e1639efa53eb9e70720f28ce137d493e5eTimo Sirainenint net_str2hostport(const char *str, in_port_t default_port,
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* Converts ip and port to ipv4:port or [ipv6]:port. Returns -1 if
156736910057b280cb9999d4c6c7221c4c80f5c2Timo Sirainen ip is not valid IPv4 or IPv6 address. */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainenint net_ipport2str(const struct ip_addr *ip, in_port_t port, const char **str_r);
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* Convert IPv6 mapped IPv4 address to an actual IPv4 address. Returns 0 if
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen successful, -1 if the source address isn't IPv6 mapped IPv4 address. */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainenint net_ipv6_mapped_ipv4_convert(const struct ip_addr *src,
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* Get socket error */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* Get name of TCP service */
5069adb2f5b3609fff9a0a705c6edeae56e0030aTimo Sirainenconst char *net_getservbyport(in_port_t port) ATTR_CONST;
3785910c303507db5f629684e6dde2cc7f83668eTimo Sirainenbool is_ipv4_address(const char *addr) ATTR_PURE;
5069adb2f5b3609fff9a0a705c6edeae56e0030aTimo Sirainenbool is_ipv6_address(const char *addr) ATTR_PURE;
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* Parse network as ip/bits. Returns 0 if successful, -1 if invalid input. */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainenint net_parse_range(const char *network, struct ip_addr *ip_r,
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen unsigned int *bits_r);
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen/* Returns TRUE if ip is in net_ip/bits network. IPv4-mapped IPv6 addresses
c09f9f95db314e7482c95e502e1c56ed6c555797Timo Sirainen in "ip" parameter are converted to plain IPv4 addresses before matching.
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainen No conversion is done to net_ip though, so using IPv4-mapped IPv6 addresses
252db51b6c0a605163326b3ea5d09e9936ca3b29Timo Sirainen there will always fail. Invalid IPs (family=0) never match anything. */
2201e2cc1b3f744dac61c2bf8095bcb6b5719540Timo Sirainenbool net_is_in_network(const struct ip_addr *ip, const struct ip_addr *net_ip,