Neels Hofmeyr | 0c7826e | 2019-02-25 02:45:06 +0100 | [diff] [blame] | 1 | /*! \file sockaddr_str.h |
| 2 | * Common API to store an IP address and port. |
| 3 | */ |
| 4 | /* |
| 5 | * (C) 2019 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de> |
| 6 | * |
| 7 | * Author: neels@hofmeyr.de |
| 8 | * |
| 9 | * All Rights Reserved |
| 10 | * |
| 11 | * SPDX-License-Identifier: GPL-2.0+ |
| 12 | * |
| 13 | * This program is free software; you can redistribute it and/or modify |
| 14 | * it under the terms of the GNU General Public License as published by |
| 15 | * the Free Software Foundation; either version 2 of the License, or |
| 16 | * (at your option) any later version. |
| 17 | * |
| 18 | * This program is distributed in the hope that it will be useful, |
| 19 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 20 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 21 | * GNU General Public License for more details. |
| 22 | * |
Neels Hofmeyr | 0c7826e | 2019-02-25 02:45:06 +0100 | [diff] [blame] | 23 | */ |
| 24 | |
| 25 | #pragma once |
| 26 | |
| 27 | #include <stdint.h> |
| 28 | #include <stdbool.h> |
| 29 | #include <arpa/inet.h> |
Neels Hofmeyr | 951d32b | 2019-11-11 19:20:42 +0100 | [diff] [blame] | 30 | #include <osmocom/core/defs.h> |
Neels Hofmeyr | 0c7826e | 2019-02-25 02:45:06 +0100 | [diff] [blame] | 31 | |
| 32 | struct in_addr; |
| 33 | struct in6_addr; |
| 34 | struct sockaddr_storage; |
| 35 | struct sockaddr_in; |
| 36 | struct sockaddr_in6; |
| 37 | |
| 38 | /*! \defgroup sockaddr_str IP address/port utilities. |
| 39 | * @{ |
| 40 | * \file sockaddr_str.h |
| 41 | */ |
| 42 | |
| 43 | int osmo_ip_str_type(const char *ip); |
| 44 | |
| 45 | struct osmo_sockaddr_str { |
| 46 | /*! AF_INET for IPv4 address, or AF_INET6 for IPv6 address. */ |
| 47 | int af; |
| 48 | /*! NUL terminated string of the IPv4 or IPv6 address. */ |
| 49 | char ip[INET6_ADDRSTRLEN]; |
| 50 | /*! Port number */ |
| 51 | uint16_t port; |
| 52 | }; |
| 53 | |
| 54 | /*! Format string to print an osmo_sockaddr_str. |
| 55 | * |
| 56 | * For example: |
| 57 | * |
| 58 | * struct osmo_sockaddr_str *my_sockaddr_str = ...; |
| 59 | * printf("got " OSMO_SOCKADDR_STR_FMT "\n", OSMO_SOCKADDR_STR_FMT_ARGS(my_sockaddr_str)); |
| 60 | */ |
Neels Hofmeyr | d0e8d6b | 2019-10-24 04:08:16 +0200 | [diff] [blame] | 61 | #define OSMO_SOCKADDR_STR_FMT "%s%s%s:%u" |
| 62 | #define OSMO_SOCKADDR_STR_FMT_ARGS(R) \ |
| 63 | ((R) && (R)->af == AF_INET6)? "[" : "", \ |
| 64 | (R)? (R)->ip : "NULL", \ |
| 65 | ((R) && (R)->af == AF_INET6)? "]" : "", \ |
| 66 | (R)? (R)->port : 0 |
Neels Hofmeyr | 0c7826e | 2019-02-25 02:45:06 +0100 | [diff] [blame] | 67 | |
| 68 | bool osmo_sockaddr_str_is_set(const struct osmo_sockaddr_str *sockaddr_str); |
Neels Hofmeyr | 2ceb758 | 2019-10-05 05:12:33 +0200 | [diff] [blame] | 69 | bool osmo_sockaddr_str_is_nonzero(const struct osmo_sockaddr_str *sockaddr_str); |
Neels Hofmeyr | 002a51d | 2019-10-30 04:37:47 +0100 | [diff] [blame] | 70 | int osmo_sockaddr_str_cmp(const struct osmo_sockaddr_str *a, const struct osmo_sockaddr_str *b); |
Neels Hofmeyr | 0c7826e | 2019-02-25 02:45:06 +0100 | [diff] [blame] | 71 | |
| 72 | int osmo_sockaddr_str_from_str(struct osmo_sockaddr_str *sockaddr_str, const char *ip, uint16_t port); |
Alexander Couzens | d95f5d4 | 2020-06-08 01:27:20 +0200 | [diff] [blame] | 73 | int osmo_sockaddr_str_from_str2(struct osmo_sockaddr_str *sockaddr_str, const char *ip); |
Neels Hofmeyr | 0c7826e | 2019-02-25 02:45:06 +0100 | [diff] [blame] | 74 | |
| 75 | int osmo_sockaddr_str_from_in_addr(struct osmo_sockaddr_str *sockaddr_str, const struct in_addr *addr, uint16_t port); |
| 76 | int osmo_sockaddr_str_from_in6_addr(struct osmo_sockaddr_str *sockaddr_str, const struct in6_addr *addr, uint16_t port); |
| 77 | int osmo_sockaddr_str_from_32(struct osmo_sockaddr_str *sockaddr_str, uint32_t ip, uint16_t port); |
Neels Hofmeyr | 951d32b | 2019-11-11 19:20:42 +0100 | [diff] [blame] | 78 | int osmo_sockaddr_str_from_32h(struct osmo_sockaddr_str *sockaddr_str, uint32_t ip, uint16_t port); |
Neels Hofmeyr | 0c7826e | 2019-02-25 02:45:06 +0100 | [diff] [blame] | 79 | int osmo_sockaddr_str_from_sockaddr_in(struct osmo_sockaddr_str *sockaddr_str, const struct sockaddr_in *src); |
| 80 | int osmo_sockaddr_str_from_sockaddr_in6(struct osmo_sockaddr_str *sockaddr_str, const struct sockaddr_in6 *src); |
| 81 | int osmo_sockaddr_str_from_sockaddr(struct osmo_sockaddr_str *sockaddr_str, const struct sockaddr_storage *src); |
| 82 | |
| 83 | int osmo_sockaddr_str_to_in_addr(const struct osmo_sockaddr_str *sockaddr_str, struct in_addr *dst); |
| 84 | int osmo_sockaddr_str_to_in6_addr(const struct osmo_sockaddr_str *sockaddr_str, struct in6_addr *dst); |
| 85 | int osmo_sockaddr_str_to_32(const struct osmo_sockaddr_str *sockaddr_str, uint32_t *ip); |
Neels Hofmeyr | 951d32b | 2019-11-11 19:20:42 +0100 | [diff] [blame] | 86 | int osmo_sockaddr_str_to_32h(const struct osmo_sockaddr_str *sockaddr_str, uint32_t *ip); |
Neels Hofmeyr | 0c7826e | 2019-02-25 02:45:06 +0100 | [diff] [blame] | 87 | int osmo_sockaddr_str_to_sockaddr_in(const struct osmo_sockaddr_str *sockaddr_str, struct sockaddr_in *dst); |
| 88 | int osmo_sockaddr_str_to_sockaddr_in6(const struct osmo_sockaddr_str *sockaddr_str, struct sockaddr_in6 *dst); |
| 89 | int osmo_sockaddr_str_to_sockaddr(const struct osmo_sockaddr_str *sockaddr_str, struct sockaddr_storage *dst); |
| 90 | |
Neels Hofmeyr | 951d32b | 2019-11-11 19:20:42 +0100 | [diff] [blame] | 91 | int osmo_sockaddr_str_from_32n(struct osmo_sockaddr_str *sockaddr_str, uint32_t ip, uint16_t port) |
| 92 | OSMO_DEPRECATED("osmo_sockaddr_str_from_32n() actually uses *host* byte order. Use osmo_sockaddr_str_from_32h() instead"); |
| 93 | int osmo_sockaddr_str_to_32n(const struct osmo_sockaddr_str *sockaddr_str, uint32_t *ip) |
| 94 | OSMO_DEPRECATED("osmo_sockaddr_str_to_32n() actually uses *host* byte order. Use osmo_sockaddr_str_to_32h() instead"); |
| 95 | |
Neels Hofmeyr | 0c7826e | 2019-02-25 02:45:06 +0100 | [diff] [blame] | 96 | /*! @} */ |