2/2: fixup: add osmo_gsup_peer_id with type enum and union
During code review it was requested to insert an ability to handle different
kinds of peer id, in order to be able to add a Global Title in the future.
Add this, but only in the publicly visible API. For osmo-hlr internal code, I
intend to push implementing this into the future, when a different peer
identification actually gets introduced.
This way we don't need to implement it now in all osmo-hlr code paths (save
time now), but still make all API users aware that this type may be extended in
the future.
Change-Id: Ide9dcdca283ab989240cfc6e53e9211862a199c5
diff --git a/src/gsupclient/Makefile.am b/src/gsupclient/Makefile.am
index 38b1582..a8674e4 100644
--- a/src/gsupclient/Makefile.am
+++ b/src/gsupclient/Makefile.am
@@ -9,7 +9,7 @@
lib_LTLIBRARIES = libosmo-gsup-client.la
libosmo_gsup_client_la_SOURCES = \
- ipa_name.c \
+ gsup_peer_id.c \
gsup_client.c \
gsup_req.c \
$(NULL)
diff --git a/src/gsupclient/gsup_peer_id.c b/src/gsupclient/gsup_peer_id.c
new file mode 100644
index 0000000..7b3efd5
--- /dev/null
+++ b/src/gsupclient/gsup_peer_id.c
@@ -0,0 +1,187 @@
+/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
+ *
+ * All Rights Reserved
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <errno.h>
+#include <string.h>
+#include <osmocom/core/utils.h>
+#include <osmocom/gsupclient/gsup_peer_id.h>
+
+bool osmo_ipa_name_is_empty(struct osmo_ipa_name *ipa_name)
+{
+ return (!ipa_name) || (!ipa_name->len);
+}
+
+int osmo_ipa_name_set(struct osmo_ipa_name *ipa_name, const uint8_t *val, size_t len)
+{
+ if (!val || !len) {
+ *ipa_name = (struct osmo_ipa_name){};
+ return 0;
+ }
+ if (len > sizeof(ipa_name->val))
+ return -ENOSPC;
+ ipa_name->len = len;
+ memcpy(ipa_name->val, val, len);
+ return 0;
+}
+
+static int osmo_ipa_name_set_str_va(struct osmo_ipa_name *ipa_name, const char *str_fmt, va_list ap)
+{
+ if (!str_fmt)
+ return osmo_ipa_name_set(ipa_name, NULL, 0);
+ vsnprintf((char*)(ipa_name->val), sizeof(ipa_name->val), str_fmt, ap);
+ ipa_name->len = strlen((char*)(ipa_name->val))+1;
+ return 0;
+}
+
+int osmo_ipa_name_set_str(struct osmo_ipa_name *ipa_name, const char *str_fmt, ...)
+{
+ va_list ap;
+ int rc;
+ va_start(ap, str_fmt);
+ rc = osmo_ipa_name_set_str_va(ipa_name, str_fmt, ap);
+ va_end(ap);
+ return rc;
+}
+
+int osmo_ipa_name_cmp(const struct osmo_ipa_name *a, const struct osmo_ipa_name *b)
+{
+ int cmp;
+ if (a == b)
+ return 0;
+ if (!a)
+ return -1;
+ if (!b)
+ return 1;
+ if (!a->len && !b->len)
+ return 0;
+ if (!a->len && b->len)
+ return -1;
+ if (!b->len && a->len)
+ return 1;
+
+ if (a->len == b->len)
+ return memcmp(a->val, b->val, a->len);
+ else if (a->len < b->len) {
+ cmp = memcmp(a->val, b->val, a->len);
+ if (!cmp)
+ cmp = -1;
+ return cmp;
+ } else {
+ /* a->len > b->len */
+ cmp = memcmp(a->val, b->val, b->len);
+ if (!cmp)
+ cmp = 1;
+ return cmp;
+ }
+}
+
+/* Call osmo_ipa_name_to_str_c with OTC_SELECT. */
+const char *osmo_ipa_name_to_str(const struct osmo_ipa_name *ipa_name)
+{
+ return osmo_ipa_name_to_str_c(OTC_SELECT, ipa_name);
+}
+
+/* Return an unquoted string, not including the terminating zero. Used for writing VTY config. */
+const char *osmo_ipa_name_to_str_c(void *ctx, const struct osmo_ipa_name *ipa_name)
+{
+ size_t len = ipa_name->len;
+ if (!len)
+ return talloc_strdup(ctx, "");
+ if (ipa_name->val[len-1] == '\0')
+ len--;
+ return osmo_escape_str_c(ctx, (char*)ipa_name->val, len);
+}
+
+bool osmo_gsup_peer_id_is_empty(struct osmo_gsup_peer_id *gsup_peer_id)
+{
+ if (!gsup_peer_id)
+ return true;
+ switch (gsup_peer_id->type) {
+ case OSMO_GSUP_PEER_ID_EMPTY:
+ return true;
+ case OSMO_GSUP_PEER_ID_IPA_NAME:
+ return osmo_ipa_name_is_empty(&gsup_peer_id->ipa_name);
+ default:
+ return false;
+ }
+}
+int osmo_gsup_peer_id_set(struct osmo_gsup_peer_id *gsup_peer_id, enum osmo_gsup_peer_id_type type,
+ const uint8_t *val, size_t len)
+{
+ gsup_peer_id->type = type;
+ switch (type) {
+ case OSMO_GSUP_PEER_ID_IPA_NAME:
+ return osmo_ipa_name_set(&gsup_peer_id->ipa_name, val, len);
+ default:
+ return -EINVAL;
+ }
+}
+
+int osmo_gsup_peer_id_set_str(struct osmo_gsup_peer_id *gsup_peer_id, enum osmo_gsup_peer_id_type type,
+ const char *str_fmt, ...)
+{
+ va_list ap;
+ int rc;
+
+ *gsup_peer_id = (struct osmo_gsup_peer_id){};
+
+ switch (type) {
+ case OSMO_GSUP_PEER_ID_IPA_NAME:
+ gsup_peer_id->type = OSMO_GSUP_PEER_ID_IPA_NAME;
+ va_start(ap, str_fmt);
+ rc = osmo_ipa_name_set_str_va(&gsup_peer_id->ipa_name, str_fmt, ap);
+ va_end(ap);
+ return rc;
+ default:
+ return -EINVAL;
+ }
+}
+
+int osmo_gsup_peer_id_cmp(const struct osmo_gsup_peer_id *a, const struct osmo_gsup_peer_id *b)
+{
+ if (a->type != b->type)
+ return OSMO_CMP(a->type, b->type);
+ switch (a->type) {
+ case OSMO_GSUP_PEER_ID_IPA_NAME:
+ return osmo_ipa_name_cmp(&a->ipa_name, &b->ipa_name);
+ default:
+ return -EINVAL;
+ }
+}
+
+const struct value_string osmo_gsup_peer_id_type_names[] = {
+ { OSMO_GSUP_PEER_ID_IPA_NAME, "IPA-name" },
+ {}
+};
+
+/* Call osmo_gsup_peer_id_to_str_c with OTC_SELECT */
+const char *osmo_gsup_peer_id_to_str(const struct osmo_gsup_peer_id *gpi)
+{
+ return osmo_gsup_peer_id_to_str_c(OTC_SELECT, gpi);
+}
+
+/* Return an unquoted string, not including the terminating zero. Used for writing VTY config. */
+const char *osmo_gsup_peer_id_to_str_c(void *ctx, const struct osmo_gsup_peer_id *gpi)
+{
+ switch (gpi->type) {
+ case OSMO_GSUP_PEER_ID_IPA_NAME:
+ return osmo_ipa_name_to_str_c(ctx, &gpi->ipa_name);
+ default:
+ return talloc_strdup(ctx, osmo_gsup_peer_id_type_name(gpi->type));
+ }
+}
diff --git a/src/gsupclient/gsup_req.c b/src/gsupclient/gsup_req.c
index df834eb..7cefbdf 100644
--- a/src/gsupclient/gsup_req.c
+++ b/src/gsupclient/gsup_req.c
@@ -44,7 +44,7 @@
* \param[inout] add_to_list List to which to append this request, or NULL for no list.
* \return a newly allocated osmo_gsup_req, or NULL on error.
*/
-struct osmo_gsup_req *osmo_gsup_req_new(void *ctx, const struct osmo_ipa_name *from_peer, struct msgb *msg,
+struct osmo_gsup_req *osmo_gsup_req_new(void *ctx, const struct osmo_gsup_peer_id *from_peer, struct msgb *msg,
osmo_gsup_req_send_response_t send_response_cb, void *cb_data,
struct llist_head *add_to_list)
{
@@ -54,7 +54,7 @@
if (!msgb_l2(msg) || !msgb_l2len(msg)) {
LOGP(DLGSUP, LOGL_ERROR, "Rx GSUP from %s: missing or empty L2 data\n",
- osmo_ipa_name_to_str(from_peer));
+ osmo_gsup_peer_id_to_str(from_peer));
msgb_free(msg);
return NULL;
}
@@ -70,7 +70,7 @@
req->source_name = *from_peer;
rc = osmo_gsup_decode(msgb_l2(req->msg), msgb_l2len(req->msg), (struct osmo_gsup_message*)&req->gsup);
if (rc < 0) {
- LOGP(DLGSUP, LOGL_ERROR, "Rx GSUP from %s: cannot decode (rc=%d)\n", osmo_ipa_name_to_str(from_peer), rc);
+ LOGP(DLGSUP, LOGL_ERROR, "Rx GSUP from %s: cannot decode (rc=%d)\n", osmo_gsup_peer_id_to_str(from_peer), rc);
osmo_gsup_req_free(req);
return NULL;
}
@@ -78,17 +78,18 @@
LOG_GSUP_REQ(req, LOGL_DEBUG, "new request: {%s}\n", osmo_gsup_message_to_str_c(OTC_SELECT, &req->gsup));
if (req->gsup.source_name_len) {
- if (osmo_ipa_name_set(&req->source_name, req->gsup.source_name, req->gsup.source_name_len)) {
+ if (osmo_gsup_peer_id_set(&req->source_name, OSMO_GSUP_PEER_ID_IPA_NAME,
+ req->gsup.source_name, req->gsup.source_name_len)) {
LOGP(DLGSUP, LOGL_ERROR,
"Rx GSUP from %s: failed to decode source_name, message is not routable\n",
- osmo_ipa_name_to_str(from_peer));
+ osmo_gsup_peer_id_to_str(from_peer));
osmo_gsup_req_respond_msgt(req, OSMO_GSUP_MSGT_ROUTING_ERROR, true);
return NULL;
}
/* The source of the GSUP message is not the immediate GSUP peer; the peer is our proxy for that source.
*/
- if (osmo_ipa_name_cmp(&req->source_name, from_peer))
+ if (osmo_gsup_peer_id_cmp(&req->source_name, from_peer))
req->via_proxy = *from_peer;
}
diff --git a/src/gsupclient/ipa_name.c b/src/gsupclient/ipa_name.c
deleted file mode 100644
index 2db069f..0000000
--- a/src/gsupclient/ipa_name.c
+++ /dev/null
@@ -1,97 +0,0 @@
-/* Copyright 2019 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
- *
- * All Rights Reserved
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-
-#include <errno.h>
-#include <string.h>
-#include <osmocom/core/utils.h>
-#include <osmocom/gsupclient/ipa_name.h>
-
-int osmo_ipa_name_set(struct osmo_ipa_name *ipa_name, const uint8_t *val, size_t len)
-{
- if (!val || !len) {
- *ipa_name = (struct osmo_ipa_name){};
- return 0;
- }
- if (len > sizeof(ipa_name->val))
- return -ENOSPC;
- ipa_name->len = len;
- memcpy(ipa_name->val, val, len);
- return 0;
-}
-
-int osmo_ipa_name_set_str(struct osmo_ipa_name *ipa_name, const char *str_fmt, ...)
-{
- va_list ap;
- if (!str_fmt)
- return osmo_ipa_name_set(ipa_name, NULL, 0);
-
- va_start(ap, str_fmt);
- vsnprintf((char*)(ipa_name->val), sizeof(ipa_name->val), str_fmt, ap);
- va_end(ap);
- ipa_name->len = strlen((char*)(ipa_name->val))+1;
- return 0;
-}
-
-int osmo_ipa_name_cmp(const struct osmo_ipa_name *a, const struct osmo_ipa_name *b)
-{
- int cmp;
- if (a == b)
- return 0;
- if (!a)
- return -1;
- if (!b)
- return 1;
- if (!a->len && !b->len)
- return 0;
- if (!a->len && b->len)
- return -1;
- if (!b->len && a->len)
- return 1;
-
- if (a->len == b->len)
- return memcmp(a->val, b->val, a->len);
- else if (a->len < b->len) {
- cmp = memcmp(a->val, b->val, a->len);
- if (!cmp)
- cmp = -1;
- return cmp;
- } else {
- /* a->len > b->len */
- cmp = memcmp(a->val, b->val, b->len);
- if (!cmp)
- cmp = 1;
- return cmp;
- }
-}
-
-/* Call osmo_ipa_name_to_str_c with OTC_SELECT. */
-const char *osmo_ipa_name_to_str(const struct osmo_ipa_name *ipa_name)
-{
- return osmo_ipa_name_to_str_c(OTC_SELECT, ipa_name);
-}
-
-/* Return an unquoted string, not including the terminating zero. Used for writing VTY config. */
-const char *osmo_ipa_name_to_str_c(void *ctx, const struct osmo_ipa_name *ipa_name)
-{
- size_t len = ipa_name->len;
- if (!len)
- return talloc_strdup(ctx, "");
- if (ipa_name->val[len-1] == '\0')
- len--;
- return osmo_escape_str_c(ctx, (char*)ipa_name->val, len);
-}