Add osmo_sockaddr_strs_to_str()

This will come in handy for working with multihomes sockets like SCTP.

Related: OS#5581
Change-Id: Ic0d7c08f669994e37a2314555ecac85d28c42c89

4 files changed, 115 insertions, 8 deletions

diff --git a/include/osmocom/core/sockaddr_str.h b/include/osmocom/core/sockaddr_str.h
index a46ad595..604f926d 100644
--- a/include/osmocom/core/sockaddr_str.h
+++ b/include/osmocom/core/sockaddr_str.h
@@ -59,12 +59,14 @@ struct osmo_sockaddr_str {
  *     struct osmo_sockaddr_str *my_sockaddr_str = ...;
  *     printf("got " OSMO_SOCKADDR_STR_FMT "\n", OSMO_SOCKADDR_STR_FMT_ARGS(my_sockaddr_str));
  */
-#define OSMO_SOCKADDR_STR_FMT "%s%s%s:%u"
-#define OSMO_SOCKADDR_STR_FMT_ARGS(R) \
-	((R) && (R)->af == AF_INET6)? "[" : "", \
-	(R)? (R)->ip : "NULL", \
-	((R) && (R)->af == AF_INET6)? "]" : "", \
-	(R)? (R)->port : 0
+#define OSMO_SOCKADDR_STR_NO_PORT_FMT "%s%s%s"
+#define OSMO_SOCKADDR_STR_NO_PORT_FMT_ARGS(R) \
+	((R) && (R)->af == AF_INET6) ? "[" : "", \
+	(R) ? (R)->ip : "NULL", \
+	((R) && (R)->af == AF_INET6) ? "]" : ""
+
+#define OSMO_SOCKADDR_STR_FMT OSMO_SOCKADDR_STR_NO_PORT_FMT ":%u"
+#define OSMO_SOCKADDR_STR_FMT_ARGS(R) OSMO_SOCKADDR_STR_NO_PORT_FMT_ARGS(R), (R) ? (R)->port : 0
 
 bool osmo_sockaddr_str_is_set(const struct osmo_sockaddr_str *sockaddr_str);
 bool osmo_sockaddr_str_is_nonzero(const struct osmo_sockaddr_str *sockaddr_str);
@@ -88,6 +90,7 @@ int osmo_sockaddr_str_to_32h(const struct osmo_sockaddr_str *sockaddr_str, uint3
 int osmo_sockaddr_str_to_sockaddr_in(const struct osmo_sockaddr_str *sockaddr_str, struct sockaddr_in *dst);
 int osmo_sockaddr_str_to_sockaddr_in6(const struct osmo_sockaddr_str *sockaddr_str, struct sockaddr_in6 *dst);
 int osmo_sockaddr_str_to_sockaddr(const struct osmo_sockaddr_str *sockaddr_str, struct sockaddr_storage *dst);
+int osmo_sockaddr_strs_to_str(char *buf, size_t buf_len, const struct osmo_sockaddr_str **sa_str, size_t sa_str_count);
 
 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");
diff --git a/src/sockaddr_str.c b/src/sockaddr_str.c
index 70927a70..b5007c3d 100644
--- a/src/sockaddr_str.c
+++ b/src/sockaddr_str.c
@@ -541,5 +541,48 @@ int osmo_sockaddr_str_to_sockaddr(const struct osmo_sockaddr_str *sockaddr_str,
 	}
 }
 
+/*! Convert array of osmo_sockaddr_str address strings into a string representation of the address set, in the form:
+ * buf_len == 0: "()"
+ * buf_len == 1: "hostA"
+ * buf_len >= 2: (hostA|hostB|...|...)
+ * The port information is ignored.
+ * \param[out] buf The buffer to store address set representation in.
+ * \param[in] buf_len The size of buffer for address set representation.
+ * \param[in] sa_str The array of osmo_sockaddr_str structs.
+ * \param[in] sa_str_count Number of osmo_sockaddr_str structs to convert.
+ * \return 0 on success, negative on error.
+ */
+int osmo_sockaddr_strs_to_str(char *buf, size_t buf_len, const struct osmo_sockaddr_str **sa_str, size_t sa_str_count)
+{
+	size_t i;
+	struct osmo_strbuf sb = { .buf = buf, .len = buf_len };
+	char *after;
+
+	if (buf_len < 3)
+		return -ENOMEM;
+
+	if (sa_str_count != 1)
+		OSMO_STRBUF_PRINTF(sb, "(");
+
+	for (i = 0; i < sa_str_count; i++) {
+		if (sa_str_count == 1)
+			after = "";
+		else
+			after = (i == (sa_str_count - 1)) ? ")" : "|";
+
+		if (sa_str[i])
+			OSMO_STRBUF_PRINTF(sb, OSMO_SOCKADDR_STR_NO_PORT_FMT "%s",
+							   OSMO_SOCKADDR_STR_NO_PORT_FMT_ARGS(sa_str[i]), after);
+	}
+
+	if (sa_str_count == 0)
+		OSMO_STRBUF_PRINTF(sb, ")");
+
+	if (sb.chars_needed >= buf_len)
+		return -ENOSPC;
+
+	return sb.chars_needed;
+}
+
 /*! @} */
 #endif // HAVE_NETINET_IN_H
diff --git a/tests/sockaddr_str/sockaddr_str_test.c b/tests/sockaddr_str/sockaddr_str_test.c
index 0d0674b6..8077b9a6 100644
--- a/tests/sockaddr_str/sockaddr_str_test.c
+++ b/tests/sockaddr_str/sockaddr_str_test.c
@@ -24,7 +24,10 @@
 #include <errno.h>
 #include <string.h>
 #include <osmocom/core/sockaddr_str.h>
+#include <osmocom/core/application.h>
+#include <osmocom/core/logging.h>
 #include <osmocom/core/utils.h>
+#include <osmocom/core/socket.h>
 #include <netinet/in.h>
 
 struct osmo_sockaddr_str oip_data[] = {
@@ -259,10 +262,62 @@ static void test_osmo_sockaddr_str_cmp()
 	}
 }
 
+static int test_sockaddr_strs_dump(void *ctx, struct osmo_sockaddr_str *xdata, size_t count)
+{
+	char buf[OSMO_SOCK_NAME_MAXLEN * OSMO_SOCK_MAX_ADDRS * 2];
+	struct osmo_sockaddr_str *sa_strs[OSMO_SOCK_MAX_ADDRS];
+	int i, j, rc;
+
+	for (i = 0, j = 0; j < count && i < OSMO_SOCK_MAX_ADDRS; j++) {//ARRAY_SIZE(oip_data)
+		sa_strs[i] = talloc_zero(ctx, struct osmo_sockaddr_str);
+		struct sockaddr_storage tmp;
+		if (osmo_sockaddr_str_to_sockaddr(&xdata[j], &tmp) == 0) {//&oip_data[j]
+			rc = osmo_sockaddr_str_from_sockaddr(sa_strs[i], &tmp);
+			if (rc < 0) {
+				printf("osmo_sockaddr_str_from_sockaddr(%d) failed on ", i);
+				dump_oip(&xdata[j]);//&oip_data[j]
+				return rc;
+			}
+			i++;
+		}
+	}
+	rc = osmo_sockaddr_strs_to_str(buf, sizeof(buf), (const struct osmo_sockaddr_str **)sa_strs, i);
+	printf("\nTest data [%d == %ld]: %s\n", rc, strlen(buf), buf);
+	return rc;
+}
+
+const struct log_info_cat default_categories[] = {
+};
+
+static struct log_info info = {
+	.cat = default_categories,
+	.num_cat = ARRAY_SIZE(default_categories),
+};
+
 int main(int argc, char **argv)
 {
+	int rc;
+	void *ctx = talloc_named_const(NULL, 0, "sockaddr_str__test");
+	osmo_init_logging2(ctx, &info);
+	log_set_use_color(osmo_stderr_target, 0);
+	log_set_print_filename2(osmo_stderr_target, LOG_FILENAME_NONE);
+	log_set_print_category(osmo_stderr_target, 0);
+	log_set_print_category_hex(osmo_stderr_target, 0);
+
 	sockaddr_str_test_conversions();
 	test_osmo_sockaddr_str_cmp();
-	return 0;
-}
 
+	rc = test_sockaddr_strs_dump(ctx, oip_data, ARRAY_SIZE(oip_data));
+	if (rc < 0)
+		return EXIT_FAILURE;
+
+	rc = test_sockaddr_strs_dump(ctx, oip_data, 1);
+	if (rc < 0)
+		return EXIT_FAILURE;
+
+	rc = test_sockaddr_strs_dump(ctx, oip_data, 0);
+	if (rc < 0)
+		return EXIT_FAILURE;
+
+	return EXIT_SUCCESS;
+}
diff --git a/tests/sockaddr_str/sockaddr_str_test.ok b/tests/sockaddr_str/sockaddr_str_test.ok
index 910e9195..504231c4 100644
--- a/tests/sockaddr_str/sockaddr_str_test.ok
+++ b/tests/sockaddr_str/sockaddr_str_test.ok
@@ -937,3 +937,9 @@ test_osmo_sockaddr_str_cmp
   osmo_sockaddr_str_cmp(): [0::]:5(zero) > 0.0.0.0:5(zero)
   osmo_sockaddr_str_cmp(): [0::]:5(zero) == [::]:5(zero)
   osmo_sockaddr_str_cmp(): [0::]:5(zero) == [0::]:5(zero)
+
+Test data [179 == 179]: (1.2.3.4|0.0.0.0|255.255.255.255|[1:2:3::4]|[::]|[::1]|[ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff]|[ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff]|1.2.3.4|[::1:a09:807]|0.0.0.0|[::]|[::])
+
+Test data [7 == 7]: 1.2.3.4
+
+Test data [2 == 2]: ()