libosmocore  1.5.1
Osmocom core library
sockaddr_str.h
Go to the documentation of this file.
1 
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  *
23  * You should have received a copy of the GNU General Public License along
24  * with this program; if not, write to the Free Software Foundation, Inc.,
25  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26  *
27  */
28 
29 #pragma once
30 
31 #include <stdint.h>
32 #include <stdbool.h>
33 #include <arpa/inet.h>
34 #include <osmocom/core/defs.h>
35 
36 struct in_addr;
37 struct in6_addr;
38 struct sockaddr_storage;
39 struct sockaddr_in;
40 struct sockaddr_in6;
41 
47 int osmo_ip_str_type(const char *ip);
48 
51  int af;
53  char ip[INET6_ADDRSTRLEN];
55  uint16_t port;
56 };
57 
65 #define OSMO_SOCKADDR_STR_FMT "%s%s%s:%u"
66 #define OSMO_SOCKADDR_STR_FMT_ARGS(R) \
67  ((R) && (R)->af == AF_INET6)? "[" : "", \
68  (R)? (R)->ip : "NULL", \
69  ((R) && (R)->af == AF_INET6)? "]" : "", \
70  (R)? (R)->port : 0
71 
72 bool osmo_sockaddr_str_is_set(const struct osmo_sockaddr_str *sockaddr_str);
73 bool osmo_sockaddr_str_is_nonzero(const struct osmo_sockaddr_str *sockaddr_str);
74 int osmo_sockaddr_str_cmp(const struct osmo_sockaddr_str *a, const struct osmo_sockaddr_str *b);
75 
76 int osmo_sockaddr_str_from_str(struct osmo_sockaddr_str *sockaddr_str, const char *ip, uint16_t port);
77 int osmo_sockaddr_str_from_str2(struct osmo_sockaddr_str *sockaddr_str, const char *ip);
78 
79 int osmo_sockaddr_str_from_in_addr(struct osmo_sockaddr_str *sockaddr_str, const struct in_addr *addr, uint16_t port);
80 int osmo_sockaddr_str_from_in6_addr(struct osmo_sockaddr_str *sockaddr_str, const struct in6_addr *addr, uint16_t port);
81 int osmo_sockaddr_str_from_32(struct osmo_sockaddr_str *sockaddr_str, uint32_t ip, uint16_t port);
82 int osmo_sockaddr_str_from_32h(struct osmo_sockaddr_str *sockaddr_str, uint32_t ip, uint16_t port);
83 int osmo_sockaddr_str_from_sockaddr_in(struct osmo_sockaddr_str *sockaddr_str, const struct sockaddr_in *src);
84 int osmo_sockaddr_str_from_sockaddr_in6(struct osmo_sockaddr_str *sockaddr_str, const struct sockaddr_in6 *src);
85 int osmo_sockaddr_str_from_sockaddr(struct osmo_sockaddr_str *sockaddr_str, const struct sockaddr_storage *src);
86 
87 int osmo_sockaddr_str_to_in_addr(const struct osmo_sockaddr_str *sockaddr_str, struct in_addr *dst);
88 int osmo_sockaddr_str_to_in6_addr(const struct osmo_sockaddr_str *sockaddr_str, struct in6_addr *dst);
89 int osmo_sockaddr_str_to_32(const struct osmo_sockaddr_str *sockaddr_str, uint32_t *ip);
90 int osmo_sockaddr_str_to_32h(const struct osmo_sockaddr_str *sockaddr_str, uint32_t *ip);
91 int osmo_sockaddr_str_to_sockaddr_in(const struct osmo_sockaddr_str *sockaddr_str, struct sockaddr_in *dst);
92 int osmo_sockaddr_str_to_sockaddr_in6(const struct osmo_sockaddr_str *sockaddr_str, struct sockaddr_in6 *dst);
93 int osmo_sockaddr_str_to_sockaddr(const struct osmo_sockaddr_str *sockaddr_str, struct sockaddr_storage *dst);
94 
95 int osmo_sockaddr_str_from_32n(struct osmo_sockaddr_str *sockaddr_str, uint32_t ip, uint16_t port)
96  OSMO_DEPRECATED("osmo_sockaddr_str_from_32n() actually uses *host* byte order. Use osmo_sockaddr_str_from_32h() instead");
97 int osmo_sockaddr_str_to_32n(const struct osmo_sockaddr_str *sockaddr_str, uint32_t *ip)
98  OSMO_DEPRECATED("osmo_sockaddr_str_to_32n() actually uses *host* byte order. Use osmo_sockaddr_str_to_32h() instead");
99 
osmo_sockaddr_str_to_32
int osmo_sockaddr_str_to_32(const struct osmo_sockaddr_str *sockaddr_str, uint32_t *ip)
osmo_sockaddr_str_is_set
bool osmo_sockaddr_str_is_set(const struct osmo_sockaddr_str *sockaddr_str)
OSMO_DEPRECATED
#define OSMO_DEPRECATED(text)
Set the deprecated attribute with a message.
Definition: defs.h:41
osmo_sockaddr_str_from_sockaddr_in
int osmo_sockaddr_str_from_sockaddr_in(struct osmo_sockaddr_str *sockaddr_str, const struct sockaddr_in *src)
osmo_sockaddr_str_to_in6_addr
int osmo_sockaddr_str_to_in6_addr(const struct osmo_sockaddr_str *sockaddr_str, struct in6_addr *dst)
osmo_sockaddr_str_to_sockaddr_in6
int osmo_sockaddr_str_to_sockaddr_in6(const struct osmo_sockaddr_str *sockaddr_str, struct sockaddr_in6 *dst)
osmo_sockaddr_str_is_nonzero
bool osmo_sockaddr_str_is_nonzero(const struct osmo_sockaddr_str *sockaddr_str)
osmo_sockaddr_str::ip
char ip[INET6_ADDRSTRLEN]
NUL terminated string of the IPv4 or IPv6 address.
Definition: sockaddr_str.h:53
osmo_sockaddr_str_from_32n
int osmo_sockaddr_str_from_32n(struct osmo_sockaddr_str *sockaddr_str, uint32_t ip, uint16_t port) OSMO_DEPRECATED("osmo_sockaddr_str_from_32n() actually uses *host* byte order. Use osmo_sockaddr_str_from_32h() instead")
osmo_sockaddr_str_to_sockaddr_in
int osmo_sockaddr_str_to_sockaddr_in(const struct osmo_sockaddr_str *sockaddr_str, struct sockaddr_in *dst)
osmo_sockaddr_str_from_in6_addr
int osmo_sockaddr_str_from_in6_addr(struct osmo_sockaddr_str *sockaddr_str, const struct in6_addr *addr, uint16_t port)
osmo_sockaddr_str_from_str2
int osmo_sockaddr_str_from_str2(struct osmo_sockaddr_str *sockaddr_str, const char *ip)
osmo_sockaddr_str_from_32h
int osmo_sockaddr_str_from_32h(struct osmo_sockaddr_str *sockaddr_str, uint32_t ip, uint16_t port)
osmo_sockaddr_str_from_sockaddr_in6
int osmo_sockaddr_str_from_sockaddr_in6(struct osmo_sockaddr_str *sockaddr_str, const struct sockaddr_in6 *src)
osmo_sockaddr_str_from_in_addr
int osmo_sockaddr_str_from_in_addr(struct osmo_sockaddr_str *sockaddr_str, const struct in_addr *addr, uint16_t port)
osmo_sockaddr_str::af
int af
AF_INET for IPv4 address, or AF_INET6 for IPv6 address.
Definition: sockaddr_str.h:51
osmo_sockaddr_str_from_str
int osmo_sockaddr_str_from_str(struct osmo_sockaddr_str *sockaddr_str, const char *ip, uint16_t port)
osmo_sockaddr_str_to_32h
int osmo_sockaddr_str_to_32h(const struct osmo_sockaddr_str *sockaddr_str, uint32_t *ip)
osmo_sockaddr_str_from_32
int osmo_sockaddr_str_from_32(struct osmo_sockaddr_str *sockaddr_str, uint32_t ip, uint16_t port)
osmo_sockaddr_str_to_in_addr
int osmo_sockaddr_str_to_in_addr(const struct osmo_sockaddr_str *sockaddr_str, struct in_addr *dst)
osmo_sockaddr_str_from_sockaddr
int osmo_sockaddr_str_from_sockaddr(struct osmo_sockaddr_str *sockaddr_str, const struct sockaddr_storage *src)
osmo_ip_str_type
int osmo_ip_str_type(const char *ip)
defs.h
osmo_sockaddr_str_cmp
int osmo_sockaddr_str_cmp(const struct osmo_sockaddr_str *a, const struct osmo_sockaddr_str *b)
osmo_sockaddr_str_to_sockaddr
int osmo_sockaddr_str_to_sockaddr(const struct osmo_sockaddr_str *sockaddr_str, struct sockaddr_storage *dst)
osmo_sockaddr_str
Definition: sockaddr_str.h:49
osmo_sockaddr_str::port
uint16_t port
Port number.
Definition: sockaddr_str.h:55
osmo_sockaddr_str_to_32n
int osmo_sockaddr_str_to_32n(const struct osmo_sockaddr_str *sockaddr_str, uint32_t *ip) OSMO_DEPRECATED("osmo_sockaddr_str_to_32n() actually uses *host* byte order. Use osmo_sockaddr_str_to_32h() instead")