16 Feb '22
neels has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-upf/+/27218 )
Change subject: libosmo-tlv: add auto dec/enc to/from structs
......................................................................
libosmo-tlv: add auto dec/enc to/from structs
Add osmo_tlv_coding: describe the value part of a TLV (decode and
encode), describe a struct with its members, and get/put readily decoded
structs from/to a raw PDU, directly.
With osmo_tlv_coding defined for a protocol's tags, we only deal with
encoded PDUs or fully decoded C structs, no TLV related
re-implementations clutter up the message handling code.
A usage example is given in tlv_dec_enc_test. The first real use will be
the PFCP protocol in osmo-upf.git.
With osmo_tlv_coding, there still is a lot of monkey work involved in
describing the decoded structs. A subsequent patch adds a generator for
osmo_tlv_coding and message structs from tag value lists.
Related: SYS#5599
Change-Id: I65de793105882a452124ee58adb0e58469e6e796
---
M include/osmocom/tlv/Makefile.am
A include/osmocom/tlv/tlv_dec_enc.h
M src/libosmo-tlv/Makefile.am
A src/libosmo-tlv/tlv_dec_enc.c
M tests/libosmo-tlv/Makefile.am
A tests/libosmo-tlv/tlv_dec_enc_test.c
A tests/libosmo-tlv/tlv_dec_enc_test.ok
M tests/testsuite.at
8 files changed, 1,268 insertions(+), 0 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/osmo-upf refs/changes/18/27218/1
diff --git a/include/osmocom/tlv/Makefile.am b/include/osmocom/tlv/Makefile.am
index f819a41..9843369 100644
--- a/include/osmocom/tlv/Makefile.am
+++ b/include/osmocom/tlv/Makefile.am
@@ -1,5 +1,6 @@
tlv_HEADERS = \
tlv.h \
+ tlv_dec_enc.h \
$(NULL)
tlvdir = $(includedir)/osmocom/tlv
diff --git a/include/osmocom/tlv/tlv_dec_enc.h b/include/osmocom/tlv/tlv_dec_enc.h
new file mode 100644
index 0000000..50a9842
--- /dev/null
+++ b/include/osmocom/tlv/tlv_dec_enc.h
@@ -0,0 +1,195 @@
+/* Decode and encode the value parts of a TLV structure */
+/*
+ * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de>
+ * All Rights Reserved.
+ *
+ * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de>
+ *
+ * SPDX-License-Identifier: GPL-2.0+
+ *
+ * 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+#pragma once
+
+#include <stdbool.h>
+
+#include <osmocom/tlv/tlv.h>
+
+struct value_string;
+
+/* User defined function to decode a single TLV value part. See struct osmo_tlv_coding.
+ * \param decoded_struct Pointer to the root struct, as context information, e.g. for logging.
+ * \param decode_to Pointer to the struct member, write the decoded value here.
+ * \param tlv TLV loader, pointing at a tlv->val of tlv->len bytes.
+ * \return 0 on success, nonzero on error, e.g. -EINVAL if the tlv->val is invalid.
+ */
+typedef int (*osmo_tlv_dec_func)(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv);
+
+/* User defined function to encode a single TLV value part. See struct osmo_tlv_coding.
+ * \param tlv TLV writer, pointing at a tlv->dst to msgb_put() data in.
+ * \param decoded_struct Pointer to the root struct, as context information, e.g. for logging.
+ * \param encode_from Pointer to the struct member, obtain the value to encode from here.
+ * \return 0 on success, nonzero on error, e.g. -EINVAL if encode_from has an un-encodable value.
+ */
+typedef int (*osmo_tlv_enc_func)(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from);
+
+/* Optional user defined function to convert a decoded IE struct (the Value part stored as C struct) to string. See
+ * struct osmo_tlv_coding.
+ * \param buf Return string in this buffer.
+ * \param buflen Size of buf.
+ * \param str_of Pointer to the struct member described by an osmo_tlv_coding, obtain the value to encode from here.
+ * \return number of characters that would be written if the buffer is large enough, like snprintf().
+ */
+typedef int (*osmo_tlv_enc_to_str_func)(char *buf, size_t buflen, void *str_of);
+
+/* Whether TLV structures nested inside the value data of an outer IE should be parsed in the same order. */
+enum osmo_tlv_coding_nested_ies_ordered {
+ OSMO_TLV_NESTED_IES_ORDERED_SAME = 0,
+ OSMO_TLV_NESTED_IES_ORDERED,
+ OSMO_TLV_NESTED_IES_UNORDERED,
+};
+
+#define OSMO_ARRAY_PITCH(arr) ((char*)(&(arr)[1]) - (char*)(arr))
+#define OSMO_MEMB_ARRAY_PITCH(obj_type, arr_memb) OSMO_ARRAY_PITCH(((obj_type*)0)->arr_memb)
+
+/*! Definition of how to decode/encode a IE to/from a struct.
+ * Kept in lists describing TLV structures, and nestable.
+ *
+ * Instance lists of this can be composed manually, or auto-generated using tlv_gen.c. Auto-generating has the benefit
+ * that the decoded structs to match the IEs are also generated at the same time and thus always match the message
+ * definitions. For an example, see tests/libosmo-tlv/test_tlv_gen/. */
+struct osmo_tlv_coding {
+ /*! the IEI value */
+ unsigned int tag;
+
+ /*! Decoding function callback. Invoked for each defined and present IE encountered in the message.
+ * Return 0 on success, negative on failure. */
+ osmo_tlv_dec_func dec_func;
+ /*! Encoding function callback. Invoked for each defined and present IE encountered in the message.
+ * Return 0 on success, negative on failure. */
+ osmo_tlv_enc_func enc_func;
+
+ /*! Means to output the decoded value to a human readable string, optional. */
+ osmo_tlv_enc_to_str_func enc_to_str_func;
+
+ /*! offsetof(decoded_struct_type, member_var): how far into the base struct you find a specific field for decoded
+ * value. For example, memb_ofs = offsetof(struct foo_msg, ies.bar_response.cause).
+ * When decoding, the decoded value is written here, when encoding it is read from here. */
+ unsigned int memb_ofs;
+ /*! For repeated IEs (.has_count = true), the array pitch / the offset to add to get to the next array index. */
+ unsigned int memb_array_pitch;
+
+ /*! True for optional/conditional IEs. */
+ bool has_presence_flag;
+ /* For optional/conditional IEs (has_presence_flag = true), the offset of the bool foo_present flag,
+ * For example, if there are
+ *
+ * struct foo_msg {
+ * struct baz baz;
+ * bool baz_present;
+ * };
+ *
+ * then set
+ * memb_ofs = offsetof(struct foo_msg, baz);
+ * has_presence_flag = true;
+ * presence_flag_ofs = offsetof(struct foo_msg, baz_present);
+ */
+ unsigned int presence_flag_ofs;
+
+ /*! True for repeated IEs, for array members:
+ *
+ * struct foo_msg {
+ * struct moo moo[10];
+ * unsigned int moo_count;
+ * };
+ *
+ * memb_ofs = offsetof(struct foo_msg, moo);
+ * has_count = true;
+ * count_ofs = offsetof(struct foo_msg, moo_count);
+ * max_count = 10;
+ */
+ bool has_count;
+ /*! For repeated IEs, the offset of the unsigned int foo_count indicator of how many array indexes are
+ * in use. See has_count. */
+ unsigned int count_ofs;
+ /*! Maximum array size for member_var[]. See has_count. */
+ unsigned int max_count;
+ /*! If nonzero, it is an error when less than this amount of the repeated IE have been decoded. */
+ unsigned int mandatory_count;
+
+ /*! For nested TLVs: if this IE's value part is itself a separate TLV structure, point this at the list of IE
+ * coding definitions for the inner IEs.
+ * In this example, the nested IEs decode/encode to different goo sub structs depending on the tag value.
+ *
+ * struct goo {
+ * int aaa;
+ * int bbb;
+ * };
+ *
+ * struct foo_msg {
+ * struct goo goo;
+ * struct goo other_goo;
+ * };
+ *
+ * struct osmo_tlv_coding goo_nested_ies[] = {
+ * { FOO_IEI_AAA, .memb_ofs = offsetof(struct goo, aaa), },
+ * { FOO_IEI_BBB, .memb_ofs = offsetof(struct goo, bbb), },
+ * {0}
+ * };
+ *
+ * struct osmo_tlv_coding foo_msg_ies[] = {
+ * { FOO_IEI_GOO, .memb_ofs = offsetof(struct foo_msg, goo), .nested_ies = goo_nested_ies, },
+ * { FOO_IEI_OTHER_GOO, .memb_ofs = offsetof(struct foo_msg, other_goo), .nested_ies = goo_nested_ies, },
+ * {0}
+ * };
+ */
+ const struct osmo_tlv_coding *nested_ies;
+
+ /*! If the nested TLV has a different tag/length size than the outer TLV structure, provide a different config
+ * here. If they are the same, just keep this NULL. */
+ const struct osmo_tlv_cfg *nested_ies_cfg;
+
+ /*! What to pass to osmo_tlvs_decode() for tlv_ordered parameter. */
+ enum osmo_tlv_coding_nested_ies_ordered nested_ies_ordered;
+};
+
+
+/*! User defined hook for error logging during TLV and value decoding.
+ * \param decoded_struct Pointer to the base struct describing this message, for context.
+ * \param file Source file of where the error occured.
+ * \param line Source file line of where the error occured.
+ * \param fmt Error message string format.
+ * \param ... Error message string args.
+ */
+typedef void (*osmo_tlv_err_cb)(void *decoded_struct, const char *file, int line, const char *fmt, ...);
+
+int osmo_tlvs_decode(void *decoded_struct, unsigned int obj_ofs, struct osmo_tlv_load *tlv, bool tlv_ordered,
+ const struct osmo_tlv_coding *ie_coding,
+ osmo_tlv_err_cb err_cb, const struct value_string *iei_strs);
+
+int osmo_tlvs_encode(struct osmo_tlv_put *tlv, void *decoded_struct, unsigned int obj_ofs,
+ const struct osmo_tlv_coding *ie_coding,
+ osmo_tlv_err_cb err_cb, const struct value_string *iei_strs);
+
+int osmo_tlvs_encode_to_str_buf(char *buf, size_t buflen, const void *decoded_struct, unsigned int obj_ofs,
+ const struct osmo_tlv_coding *ie_coding, const struct value_string *iei_strs);
+char *osmo_tlvs_encode_to_str_c(void *ctx, const void *decoded_struct, unsigned int obj_ofs,
+ const struct osmo_tlv_coding *ie_coding, const struct value_string *iei_strs);
+
+static inline bool osmo_tlv_coding_end(const struct osmo_tlv_coding *iec)
+{
+ return iec->dec_func == NULL && iec->enc_func == NULL && iec->nested_ies == NULL;
+}
diff --git a/src/libosmo-tlv/Makefile.am b/src/libosmo-tlv/Makefile.am
index 0f848d3..2b8a374 100644
--- a/src/libosmo-tlv/Makefile.am
+++ b/src/libosmo-tlv/Makefile.am
@@ -22,4 +22,5 @@
libosmo_tlv_a_SOURCES = \
tlv.c \
+ tlv_dec_enc.c \
$(NULL)
diff --git a/src/libosmo-tlv/tlv_dec_enc.c b/src/libosmo-tlv/tlv_dec_enc.c
new file mode 100644
index 0000000..44e0222
--- /dev/null
+++ b/src/libosmo-tlv/tlv_dec_enc.c
@@ -0,0 +1,512 @@
+/*
+ * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de>
+ * All Rights Reserved.
+ *
+ * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de>
+ *
+ * SPDX-License-Identifier: GPL-2.0+
+ *
+ * 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+#include <errno.h>
+#include <string.h>
+
+#include <osmocom/core/utils.h>
+
+#include <osmocom/tlv/tlv_dec_enc.h>
+
+/* Reverse offsetof(): return the address of the struct member for a given osmo_tlv_msg and member ofs_foo value. */
+#define MEMB(M, MEMB_OFS) ((void*)( (char*)(M) + (MEMB_OFS) ))
+
+#define RETURN_ERROR(RC, IEI, FMT, ARGS...) \
+ do {\
+ if (err_cb) \
+ err_cb(decoded_struct, __FILE__, __LINE__, "tag 0x%x = %s: " FMT " (%d: %s)\n", IEI, \
+ get_value_string(iei_strs, IEI), ##ARGS, RC, strerror((RC) > 0? (RC) : -(RC))); \
+ return RC; \
+ } while (0)
+
+
+/*! Decode a TLV structure from raw data to a decoded struct, for unordered TLV IEs.
+ * How to decode IE values and where to place them in the decoded struct, is defined by ie_coding, an array terminated
+ * by a '{0}' entry.
+ * The IEs may appear in any ordering in the TLV data.
+ * For unordered decoding, only IEs with has_presence_flag == true or has_count == true may repeat. Other IE definitions
+ * cause the last read TLV to overwrite all previous decodings, all into the first occurence in ie_coding.
+ * \param[out] decoded_struct Pointer to the struct to write parsed IE data to.
+ * \param[in] obj_ofs Pass as zero. Used for nested IEs: offset added to decoded_struct to get to a sub-struct.
+ * \param[in] tlv TLV data to parse, as given in tlv->msg.*. Must be ready for osmo_tlv_load_start().
+ * \param[in] ie_coding A list of permitted/expected IEI tags and instructions for decoding.
+ * \param[in] err_cb Function to call to report an error message, or NULL.
+ * \param[in] iei_strs value_string array to give IEI names in error messages passed to err_cb(), or NULL.
+ * \return 0 on success, negative on error.
+ */
+static int osmo_tlvs_decode_unordered(void *decoded_struct, unsigned int obj_ofs, struct osmo_tlv_load *tlv,
+ const struct osmo_tlv_coding *ie_coding,
+ osmo_tlv_err_cb err_cb, const struct value_string *iei_strs)
+{
+ void *obj = MEMB(decoded_struct, obj_ofs);
+ const struct osmo_tlv_coding *iec;
+ unsigned int *multi_count_p;
+
+ /* To check for presence of mandatory IEs, need to keep a flag stack of seen ie_coding entries. This array has
+ * to have at least the nr of entires that the ie_coding array has. Let's allow up to this many ie_coding
+ * entries to avoid dynamic allocation. Seems like enough. */
+ bool seen_ie_coding_entries[4096] = {0};
+ bool *seen_p;
+#define CHECK_SEEN(IEC) do { \
+ unsigned int ie_coding_idx = (IEC) - ie_coding; \
+ if (ie_coding_idx >= ARRAY_SIZE(seen_ie_coding_entries)) \
+ RETURN_ERROR(-ENOTSUP, tlv->tag, \
+ "Too many IE definitions for decoding an unordered TLV structure"); \
+ seen_p = &seen_ie_coding_entries[ie_coding_idx]; \
+ } while (0)
+
+
+ osmo_tlv_load_start(tlv);
+
+ /* IEs are allowed to come in any order. So traverse the TLV structure once, and find an IE parser for each (if
+ * any). */
+ for (;;) {
+ int rc;
+ bool *presence_flag_p;
+ unsigned int memb_next_array_idx;
+ unsigned int memb_ofs;
+ unsigned int ie_max_allowed_count;
+
+ rc = osmo_tlv_load_next(tlv);
+ if (rc)
+ RETURN_ERROR(rc, tlv->tag, "Decoding IEs failed on or after this tag");
+ if (!tlv->val) {
+ /* End of the TLV structure */
+ break;
+ }
+
+ /* ie_max_allowed_count counts how often the same IEI may appear in a message until all struct members
+ * that can store them are filled up. */
+ ie_max_allowed_count = 0;
+
+ do {
+ /* Find the IE coding for this tag */
+ for (iec = ie_coding; !osmo_tlv_coding_end(iec) && iec->tag != tlv->tag; iec++);
+ /* No such IE coding found. */
+ if (osmo_tlv_coding_end(iec))
+ break;
+
+ /* Keep track how often this tag can occur */
+ ie_max_allowed_count += iec->has_count ? iec->max_count : 1;
+
+ /* Was this iec instance already decoded? Then skip to the next one, if any. */
+ presence_flag_p = iec->has_presence_flag ? MEMB(obj, iec->presence_flag_ofs) : NULL;
+ multi_count_p = iec->has_count ? MEMB(obj, iec->count_ofs) : NULL;
+ if ((presence_flag_p && *presence_flag_p)
+ || (multi_count_p && *multi_count_p >= iec->max_count))
+ continue;
+ /* For IEs with a presence flag or a multi count, the decoded struct provides the information
+ * whether the IE has already been decoded. Do the same for mandatory IEs, using local state in
+ * seen_ie_coding_entries[]. */
+ CHECK_SEEN(iec);
+ if (*seen_p)
+ continue;
+ } while (0);
+ if (osmo_tlv_coding_end(iec)) {
+ if (ie_max_allowed_count) {
+ /* There have been IE definitions for this IEI, but all slots to decode it are already
+ * filled. */
+ RETURN_ERROR(-ENOTSUP, tlv->tag, "Only %u instances of this IE are supported per message",
+ ie_max_allowed_count);
+ }
+ /* No such IE defined in ie_coding, just skip the TLV. */
+ continue;
+ }
+
+ /* If this is a repeated IE, decode into the correct array index memb[idx],
+ * next idx == (*multi_count_p). We've already guaranteed above that *multi_count_p < max_count. */
+ memb_next_array_idx = multi_count_p ? *multi_count_p : 0;
+ memb_ofs = iec->memb_ofs + memb_next_array_idx * iec->memb_array_pitch;
+
+ /* Decode IE value part */
+ if (iec->nested_ies) {
+ /* A nested IE: the value part of this TLV is in turn a TLV structure. Decode the inner
+ * IEs. */
+ struct osmo_tlv_load inner_tlv = {
+ .cfg = iec->nested_ies_cfg ? : tlv->cfg,
+ .src = {
+ .data = tlv->val,
+ .len = tlv->len,
+ }
+ };
+ bool ordered;
+ switch (iec->nested_ies_ordered) {
+ case OSMO_TLV_NESTED_IES_ORDERED:
+ ordered = true;
+ break;
+ case OSMO_TLV_NESTED_IES_ORDERED_SAME:
+ case OSMO_TLV_NESTED_IES_UNORDERED:
+ ordered = false;
+ break;
+ default:
+ OSMO_ASSERT(0);
+ }
+ rc = osmo_tlvs_decode(decoded_struct, obj_ofs + memb_ofs, &inner_tlv, ordered, iec->nested_ies,
+ err_cb, iei_strs);
+ if (rc)
+ RETURN_ERROR(rc, tlv->tag, "Error while decoding TLV structure nested inside this IE");
+ } else {
+ /* Normal IE, decode the specific IE data. */
+ if (!iec->dec_func)
+ RETURN_ERROR(-EIO, tlv->tag, "IE definition lacks a dec_func()");
+ rc = iec->dec_func(decoded_struct, MEMB(obj, memb_ofs), tlv);
+ if (rc)
+ RETURN_ERROR(rc, tlv->tag, "Error while decoding this IE");
+ }
+
+ if (multi_count_p) {
+ /* A repeated IE, record that we've added one entry. This increments the foo_count value in the
+ * decoded osmo_tlv_msg.ies.*.
+ * For example, multi_count_p points at osmo_tlv_msg_session_est_req.create_pdr_count,
+ * and memb_ofs points at osmo_tlv_msg_session_est_req.create_pdr. */
+ (*multi_count_p)++;
+ }
+ if (presence_flag_p) {
+ *presence_flag_p = true;
+ }
+ CHECK_SEEN(iec);
+ *seen_p = true;
+ }
+
+ /* Check presence of mandatory IEs */
+ for (iec = ie_coding; !osmo_tlv_coding_end(iec); iec++) {
+ if (iec->has_presence_flag)
+ continue;
+ multi_count_p = iec->has_count ? MEMB(obj, iec->count_ofs) : NULL;
+ if (multi_count_p) {
+ if (*multi_count_p < iec->mandatory_count)
+ RETURN_ERROR(-EINVAL, iec->tag, "%u instances of this IE are mandatory, got %u",
+ iec->mandatory_count, *multi_count_p);
+ continue;
+ }
+ /* Neither an optional nor a multi member, hence it must be mandatory. */
+ CHECK_SEEN(iec);
+ if (!*seen_p)
+ RETURN_ERROR(-EINVAL, iec->tag, "Missing mandatory IE");
+ }
+ return 0;
+}
+
+/*! Decode a TLV structure from raw data to a decoded struct, for ordered TLV IEs.
+ * How to decode IE values and where to place them in the decoded struct, is defined by ie_coding, an array terminated
+ * by a '{0}' entry.
+ * The IEs in the TLV structure must appear in the same order as they are defined in ie_coding.
+ * cause the last read TLV to overwrite all previous decodings, all into the first occurence in ie_coding.
+ * \param[out] decoded_struct Pointer to the struct to write parsed IE data to.
+ * \param[in] obj_ofs Pass as zero. Used for nested IEs: offset added to decoded_struct to get to a sub-struct.
+ * \param[in] tlv TLV data to parse, as given in tlv->msg.*. Must be ready for osmo_tlv_load_start().
+ * \param[in] ie_coding A list of permitted/expected IEI tags and instructions for decoding.
+ * \param[in] err_cb Function to call to report an error message, or NULL.
+ * \param[in] iei_strs value_string array to give IEI names in error messages passed to err_cb(), or NULL.
+ * \return 0 on success, negative on error.
+ */
+static int osmo_tlvs_decode_ordered(void *decoded_struct, unsigned int obj_ofs, struct osmo_tlv_load *tlv,
+ const struct osmo_tlv_coding *ie_coding,
+ osmo_tlv_err_cb err_cb, const struct value_string *iei_strs)
+{
+ void *obj = MEMB(decoded_struct, obj_ofs);
+
+ osmo_tlv_load_start(tlv);
+
+ for (; !osmo_tlv_coding_end(ie_coding); ie_coding++) {
+ int rc;
+ bool *presence_flag = ie_coding->has_presence_flag ? MEMB(obj, ie_coding->presence_flag_ofs) : NULL;
+ unsigned int *multi_count = ie_coding->has_count ? MEMB(obj, ie_coding->count_ofs) : NULL;
+
+ rc = osmo_tlv_load_next_by_tag(tlv, ie_coding->tag);
+ switch (rc) {
+ case 0:
+ break;
+ case -ENOENT:
+ if (!presence_flag && (!multi_count || *multi_count < ie_coding->mandatory_count))
+ RETURN_ERROR(rc, ie_coding->tag, "Missing mandatory IE");
+ if (presence_flag)
+ *presence_flag = false;
+ continue;
+ default:
+ RETURN_ERROR(rc, ie_coding->tag, "Error in TLV structure");
+ }
+
+ for (;;) {
+ /* If this is a repeated IE, decode into the correct array index memb[idx],
+ * next idx == (*multi_count) */
+ unsigned int memb_next_array_idx = multi_count ? *multi_count : 0;
+ unsigned int memb_ofs = ie_coding->memb_ofs + memb_next_array_idx * ie_coding->memb_array_pitch;
+
+ if (multi_count && memb_next_array_idx >= ie_coding->max_count)
+ RETURN_ERROR(-ENOTSUP, ie_coding->tag, "Only %u instances of this IE are supported per message",
+ ie_coding->max_count);
+
+ /* Decode IE value part */
+ if (ie_coding->nested_ies) {
+ /* A nested IE: the value part of this TLV is in turn a TLV structure. Decode the inner
+ * IEs. */
+ struct osmo_tlv_load inner_tlv = {
+ .cfg = ie_coding->nested_ies_cfg ? : tlv->cfg,
+ .src = {
+ .data = tlv->val,
+ .len = tlv->len,
+ }
+ };
+ bool ordered;
+ switch (ie_coding->nested_ies_ordered) {
+ case OSMO_TLV_NESTED_IES_ORDERED_SAME:
+ case OSMO_TLV_NESTED_IES_ORDERED:
+ ordered = true;
+ break;
+ case OSMO_TLV_NESTED_IES_UNORDERED:
+ ordered = false;
+ break;
+ default:
+ OSMO_ASSERT(0);
+ }
+ rc = osmo_tlvs_decode(decoded_struct, obj_ofs + memb_ofs, &inner_tlv, ordered,
+ ie_coding->nested_ies, err_cb, iei_strs);
+ if (rc)
+ RETURN_ERROR(rc, ie_coding->tag,
+ "Error while decoding TLV structure nested inside this IE");
+ } else {
+ /* Normal IE, decode the specific IE data. */
+ if (!ie_coding->dec_func)
+ RETURN_ERROR(-EIO, ie_coding->tag, "IE definition lacks a dec_func()");
+ rc = ie_coding->dec_func(decoded_struct, MEMB(obj, memb_ofs), tlv);
+ if (rc)
+ RETURN_ERROR(rc, ie_coding->tag, "Error while decoding this IE");
+ }
+
+ if (presence_flag)
+ *presence_flag = true;
+
+ if (!multi_count) {
+ /* Not a repeated IE. */
+ break;
+ }
+
+ /* A repeated IE, record that we've added one entry. This increments the foo_count value in the
+ * decoded osmo_pfcp_msg.ies.*.
+ * For example, multi_count points at osmo_pfcp_msg_session_est_req.create_pdr_count,
+ * and memb_ofs points at osmo_pfcp_msg_session_est_req.create_pdr. */
+ (*multi_count)++;
+
+ /* Does another one of these IEs follow? */
+ if (osmo_tlv_load_peek_tag(tlv) != tlv->tag) {
+ /* Next tag is a different IE, end the repetition. */
+ break;
+ }
+
+ /* continue, parsing the next repetition of this tag. */
+ rc = osmo_tlv_load_next(tlv);
+ if (rc)
+ return rc;
+ }
+ /* continue parsing the next tag. */
+ }
+ return 0;
+}
+
+/*! Decode an entire TLV message from raw data to decoded struct.
+ * How to decode IE values and where to put them in the decoded struct is defined by ie_coding, an array terminated by
+ * a '{0}' entry.
+ * \param[out] decoded_struct Pointer to the struct to write parsed IE data to.
+ * \param[in] obj_ofs Pass as zero. Used for nested IEs: offset added to decoded_struct to get to a sub-struct.
+ * \param[in] tlv TLV data to parse, as given in tlv->msg.*. Must be ready for osmo_tlv_load_start().
+ * \param[in] ie_coding A list of permitted/expected IEI tags and instructions for decoding.
+ * \param[in] err_cb Function to call to report an error message, or NULL.
+ * \param[in] iei_strs value_string array to give IEI names in error messages passed to err_cb(), or NULL.
+ * \return 0 on success, negative on error.
+ */
+int osmo_tlvs_decode(void *decoded_struct, unsigned int obj_ofs, struct osmo_tlv_load *tlv, bool tlv_ordered,
+ const struct osmo_tlv_coding *ie_coding,
+ osmo_tlv_err_cb err_cb, const struct value_string *iei_strs)
+{
+ if (!ie_coding)
+ return -ENOTSUP;
+ if (tlv_ordered)
+ return osmo_tlvs_decode_ordered(decoded_struct, obj_ofs, tlv, ie_coding, err_cb, iei_strs);
+ else
+ return osmo_tlvs_decode_unordered(decoded_struct, obj_ofs, tlv, ie_coding, err_cb, iei_strs);
+}
+
+/*! Encode a TLV structure from decoded struct to raw data.
+ * How to encode IE values and where to read them in the decoded struct is defined by ie_coding, an array terminated by
+ * a '{0}' entry.
+ * The IEs will be encoded in the order they appear in ie_coding.
+ * \param[out] tlv Write data using this TLV definition to tlv->dst.
+ * \param[in] decoded_struct C struct data to encode.
+ * \param[in] obj_ofs Nesting offset, pass as 0.
+ * \param[in] ie_coding A {0} terminated list of IEI tags to encode (if present) and instructions for encoding.
+ * \param[in] err_cb Function to call to report an error message, or NULL.
+ * \param[in] iei_strs value_string array to give IEI names in error messages passed to err_cb(), or NULL.
+ * \return 0 on success, negative on error.
+ */
+int osmo_tlvs_encode(struct osmo_tlv_put *tlv, void *decoded_struct, unsigned int obj_ofs,
+ const struct osmo_tlv_coding *ie_coding,
+ osmo_tlv_err_cb err_cb, const struct value_string *iei_strs)
+{
+ void *obj = MEMB(decoded_struct, obj_ofs);
+
+ if (!ie_coding)
+ return -ENOTSUP;
+
+ for (; !osmo_tlv_coding_end(ie_coding); ie_coding++) {
+ int rc;
+ bool *presence_flag_p = ie_coding->has_presence_flag ? MEMB(obj, ie_coding->presence_flag_ofs) : NULL;
+ unsigned int *multi_count_p = ie_coding->has_count ? MEMB(obj, ie_coding->count_ofs) : NULL;
+ unsigned int n;
+ unsigned int i;
+
+ if (presence_flag_p && !*presence_flag_p)
+ continue;
+
+ if (multi_count_p) {
+ n = *multi_count_p;
+ if (!ie_coding->memb_array_pitch)
+ RETURN_ERROR(-EFAULT, ie_coding->tag,
+ "Error in protocol definition: The ie_coding lacks a memb_array_pitch"
+ " value, cannot be used as multi-IE\n");
+ } else {
+ n = 1;
+ }
+
+ for (i = 0; i < n; i++) {
+ unsigned int memb_ofs;
+
+ osmo_tlv_put_tl(tlv, ie_coding->tag, 0);
+
+ /* If this is a repeated IE, encode from the correct array index */
+ if (multi_count_p && i >= ie_coding->max_count)
+ RETURN_ERROR(-ENOTSUP, ie_coding->tag,
+ "Only %u instances of this IE are supported per message", ie_coding->max_count);
+ memb_ofs = ie_coding->memb_ofs + i * ie_coding->memb_array_pitch;
+
+ if (ie_coding->nested_ies) {
+ struct osmo_tlv_put nested_tlv = {
+ .cfg = ie_coding->nested_ies_cfg ? : tlv->cfg,
+ .dst = tlv->dst,
+ };
+ rc = osmo_tlvs_encode(&nested_tlv, decoded_struct, obj_ofs + memb_ofs,
+ ie_coding->nested_ies, err_cb, iei_strs);
+ if (rc)
+ RETURN_ERROR(rc, ie_coding->tag,
+ "Error while encoding TLV structure nested inside this IE");
+ } else {
+ rc = ie_coding->enc_func(tlv, decoded_struct, MEMB(obj, memb_ofs));
+ if (rc)
+ RETURN_ERROR(rc, ie_coding->tag, "Error while encoding this IE");
+ }
+
+ osmo_tlv_put_update_tl(tlv);
+ }
+ }
+ return 0;
+}
+
+/*! Compose a human readable string describing a decoded struct.
+ * How to encode IE values and where to read them in the decoded struct is defined by ie_coding, an array terminated by
+ * a '{0}' entry.
+ * The IEs will be encoded in the order they appear in ie_coding.
+ * \param[out] buf Return the string in this buffer.
+ * \param[in] buflen Size of buf.
+ * \param[in] decoded_struct C struct data to encode.
+ * \param[in] obj_ofs Nesting offset, pass as 0.
+ * \param[in] ie_coding A {0} terminated list of IEI tags to encode (if present) and instructions for encoding.
+ * \param[in] iei_strs value_string array to give IEI names in tag headers, or NULL.
+ * \return number of characters that would be written if the buffer is large enough, like snprintf().
+ */
+int osmo_tlvs_encode_to_str_buf(char *buf, size_t buflen, const void *decoded_struct, unsigned int obj_ofs,
+ const struct osmo_tlv_coding *ie_coding, const struct value_string *iei_strs)
+{
+ struct osmo_strbuf sb = { .buf = buf, .len = buflen };
+
+ void *obj = MEMB(decoded_struct, obj_ofs);
+
+ if (!ie_coding)
+ return -ENOTSUP;
+
+ for (; !osmo_tlv_coding_end(ie_coding); ie_coding++) {
+ bool *presence_flag_p = ie_coding->has_presence_flag ? MEMB(obj, ie_coding->presence_flag_ofs) : NULL;
+ unsigned int *multi_count_p = ie_coding->has_count ? MEMB(obj, ie_coding->count_ofs) : NULL;
+ unsigned int n;
+ unsigned int i;
+
+ if (presence_flag_p && !*presence_flag_p)
+ continue;
+
+ if (multi_count_p) {
+ n = *multi_count_p;
+ } else {
+ n = 1;
+ }
+
+ if (!n)
+ continue;
+
+ OSMO_STRBUF_PRINTF(sb, " %s=", get_value_string(iei_strs, ie_coding->tag));
+ if (multi_count_p)
+ OSMO_STRBUF_PRINTF(sb, "{ ");
+
+ for (i = 0; i < n; i++) {
+ unsigned int memb_ofs;
+
+ /* If this is a repeated IE, encode from the correct array index */
+ if (multi_count_p && i >= ie_coding->max_count)
+ return -ENOTSUP;
+ if (i > 0)
+ OSMO_STRBUF_PRINTF(sb, ", ");
+
+ memb_ofs = ie_coding->memb_ofs + i * ie_coding->memb_array_pitch;
+
+ if (ie_coding->nested_ies) {
+ OSMO_STRBUF_PRINTF(sb, "{");
+ OSMO_STRBUF_APPEND(sb, osmo_tlvs_encode_to_str_buf, decoded_struct, obj_ofs + memb_ofs,
+ ie_coding->nested_ies, iei_strs);
+ OSMO_STRBUF_PRINTF(sb, " }");
+ } else {
+ if (ie_coding->enc_to_str_func)
+ OSMO_STRBUF_APPEND(sb, ie_coding->enc_to_str_func, MEMB(obj, memb_ofs));
+ else
+ OSMO_STRBUF_PRINTF(sb, "(enc_to_str_func==NULL)");
+ }
+ }
+
+ if (multi_count_p)
+ OSMO_STRBUF_PRINTF(sb, " }");
+ }
+ return sb.chars_needed;
+}
+
+/*! Compose a human readable string describing a decoded struct.
+ * Like osmo_tlvs_encode_to_str_buf() but returns a talloc allocated string.
+ * \param[in] ctx talloc context to allocate from, e.g. OTC_SELECT.
+ * \param[in] decoded_struct C struct data to encode.
+ * \param[in] obj_ofs Nesting offset, pass as 0.
+ * \param[in] ie_coding A {0} terminated list of IEI tags to encode (if present) and instructions for encoding.
+ * \param[in] iei_strs value_string array to give IEI names in tag headers, or NULL.
+ * \return human readable string.
+ */
+char *osmo_tlvs_encode_to_str_c(void *ctx, const void *decoded_struct, unsigned int obj_ofs,
+ const struct osmo_tlv_coding *ie_coding, const struct value_string *iei_strs)
+{
+ OSMO_NAME_C_IMPL(ctx, 256, "ERROR", osmo_tlvs_encode_to_str_buf, decoded_struct, obj_ofs, ie_coding, iei_strs)
+}
diff --git a/tests/libosmo-tlv/Makefile.am b/tests/libosmo-tlv/Makefile.am
index 250dc5e..ff3fba9 100644
--- a/tests/libosmo-tlv/Makefile.am
+++ b/tests/libosmo-tlv/Makefile.am
@@ -10,10 +10,12 @@
noinst_PROGRAMS = \
tlv_test \
+ tlv_dec_enc_test \
$(NULL)
EXTRA_DIST = \
tlv_test.ok \
+ tlv_dec_enc_test.ok \
$(NULL)
tlv_test_SOURCES = \
@@ -25,6 +27,16 @@
$(LIBOSMOCORE_LIBS) \
$(NULL)
+tlv_dec_enc_test_SOURCES = \
+ tlv_dec_enc_test.c \
+ $(NULL)
+
+tlv_dec_enc_test_LDADD = \
+ $(top_builddir)/src/libosmo-tlv/libosmo-tlv.a \
+ $(LIBOSMOCORE_LIBS) \
+ $(NULL)
+
.PHONY: update_exp
update_exp:
$(builddir)/tlv_test >$(srcdir)/tlv_test.ok
+ $(builddir)/tlv_dec_enc_test >$(srcdir)/tlv_dec_enc_test.ok
diff --git a/tests/libosmo-tlv/tlv_dec_enc_test.c b/tests/libosmo-tlv/tlv_dec_enc_test.c
new file mode 100644
index 0000000..709eba8
--- /dev/null
+++ b/tests/libosmo-tlv/tlv_dec_enc_test.c
@@ -0,0 +1,413 @@
+/* (C) 2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de>
+ * All Rights Reserved
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation; either version 3 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 Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include <stdio.h>
+#include <errno.h>
+
+#include <osmocom/core/application.h>
+#include <osmocom/core/utils.h>
+#include <osmocom/core/msgb.h>
+
+#include <osmocom/tlv/tlv_dec_enc.h>
+
+void *ctx;
+
+enum tags {
+ TAG_FOO = 1,
+ TAG_BAR,
+ TAG_BAZ,
+ TAG_REPEAT_INT,
+ TAG_REPEAT_STRUCT,
+ TAG_NEST,
+};
+
+const struct value_string tag_names[] = {
+ { TAG_FOO, "FOO" },
+ { TAG_BAR, "BAR" },
+ { TAG_BAZ, "BAZ" },
+ { TAG_REPEAT_INT, "REPEAT_INT" },
+ { TAG_REPEAT_STRUCT, "REPEAT_STRUCT" },
+ { TAG_NEST, "NEST" },
+ {0}
+};
+
+struct bar {
+ char str[23];
+};
+
+struct baz {
+ int v_int;
+ bool v_bool;
+};
+
+enum repeat_enum {
+ R_A,
+ R_B,
+ R_C,
+};
+
+const struct value_string repeat_enum_names[] = {
+ OSMO_VALUE_STRING(R_A),
+ OSMO_VALUE_STRING(R_B),
+ OSMO_VALUE_STRING(R_C),
+ {0}
+};
+
+struct repeat {
+ int v_int;
+ bool v_bool;
+ enum repeat_enum v_enum;
+};
+
+struct nested_inner_msg {
+ int foo;
+ struct bar bar;
+ struct baz baz;
+};
+
+struct decoded_msg {
+ int foo;
+ struct bar bar;
+
+ bool baz_present;
+ struct baz baz;
+
+ unsigned int repeat_int_count;
+ int repeat_int[32];
+
+ unsigned int repeat_struct_count;
+ struct repeat repeat_struct[32];
+
+ bool nest_present;
+ struct nested_inner_msg nest;
+};
+
+int dec_u16(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv)
+{
+ int *foo = decode_to;
+ if (tlv->len != 2)
+ return -EINVAL;
+ *foo = osmo_load16be(tlv->val);
+ return 0;
+}
+
+int enc_u16(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from)
+{
+ int *foo = encode_from;
+ if (*foo > INT16_MAX)
+ return -EINVAL;
+ msgb_put_u16(tlv->dst, *foo);
+ return 0;
+}
+
+int enc_to_str_u16(char *buf, size_t buflen, void *encode_from)
+{
+ int *foo = encode_from;
+ return snprintf(buf, buflen, "%d", *foo);
+}
+
+int dec_bar(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv)
+{
+ struct bar *bar = decode_to;
+ if (tlv->len > sizeof(bar->str) - 1)
+ return -EINVAL;
+ osmo_strlcpy(bar->str, (const char*)tlv->val, OSMO_MIN(tlv->len + 1, sizeof(bar->str)));
+ return 0;
+}
+
+int enc_bar(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from)
+{
+ struct bar *bar = encode_from;
+ int len = strnlen(bar->str, sizeof(bar->str));
+ memcpy(msgb_put(tlv->dst, len), bar, len);
+ return 0;
+}
+
+int enc_to_str_bar(char *buf, size_t buflen, void *encode_from)
+{
+ struct bar *bar = encode_from;
+ return osmo_quote_str_buf3(buf, buflen, bar->str, -1);
+}
+
+int dec_baz(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv)
+{
+ struct baz *baz = decode_to;
+ uint16_t l;
+ if (tlv->len != 2)
+ return -EINVAL;
+ l = osmo_load16be(tlv->val);
+ baz->v_int = l & 0x7fff;
+ baz->v_bool = (l & 0x8000) ? true : false;
+ return 0;
+}
+
+int enc_baz(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from)
+{
+ struct baz *baz = encode_from;
+ if (baz->v_int > 0x7fff)
+ return -EINVAL;
+ msgb_put_u16(tlv->dst, (baz->v_bool ? 0x8000 : 0) + (baz->v_int & 0x7fff));
+ return 0;
+}
+
+int enc_to_str_baz(char *buf, size_t buflen, void *encode_from)
+{
+ struct baz *baz = encode_from;
+ return snprintf(buf, buflen, "{%d,%s}", baz->v_int, baz->v_bool ? "true" : "false");
+}
+
+int dec_repeat_struct(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv)
+{
+ struct repeat *repeat_struct = decode_to;
+ if (tlv->len != 3)
+ return -EINVAL;
+ repeat_struct->v_int = osmo_load16be(tlv->val);
+ repeat_struct->v_bool = tlv->val[2] & 0x80;
+ repeat_struct->v_enum = tlv->val[2] & 0x7f;
+ return 0;
+}
+
+int enc_repeat_struct(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from)
+{
+ struct repeat *repeat_struct = encode_from;
+ msgb_put_u16(tlv->dst, repeat_struct->v_int);
+ msgb_put_u8(tlv->dst, (repeat_struct->v_bool ? 0x80 : 0) + (repeat_struct->v_enum & 0x7f));
+ return 0;
+}
+
+int enc_to_str_repeat_struct(char *buf, size_t buflen, void *encode_from)
+{
+ struct repeat *repeat_struct = encode_from;
+ return snprintf(buf, buflen, "{%d,%s,%s}", repeat_struct->v_int, repeat_struct->v_bool ? "true" : "false",
+ get_value_string(repeat_enum_names, repeat_struct->v_enum));
+}
+
+struct osmo_tlv_coding nested_inner_msg_ies[] = {
+ {
+ .tag = TAG_FOO,
+ .dec_func = dec_u16,
+ .enc_func = enc_u16,
+ .enc_to_str_func = enc_to_str_u16,
+ .memb_ofs = offsetof(struct nested_inner_msg, foo),
+ },
+ {
+ .tag = TAG_BAR,
+ .dec_func = dec_bar,
+ .enc_func = enc_bar,
+ .enc_to_str_func = enc_to_str_bar,
+ .memb_ofs = offsetof(struct nested_inner_msg, bar),
+ },
+ {
+ .tag = TAG_BAZ,
+ .dec_func = dec_baz,
+ .enc_func = enc_baz,
+ .enc_to_str_func = enc_to_str_baz,
+ .memb_ofs = offsetof(struct nested_inner_msg, baz),
+ },
+ {0}
+};
+
+struct osmo_tlv_coding msg_ie_coding[] = {
+ {
+ .tag = TAG_FOO,
+ .dec_func = dec_u16,
+ .enc_func = enc_u16,
+ .enc_to_str_func = enc_to_str_u16,
+ .memb_ofs = offsetof(struct decoded_msg, foo),
+ },
+ {
+ .tag = TAG_BAR,
+ .dec_func = dec_bar,
+ .enc_func = enc_bar,
+ .enc_to_str_func = enc_to_str_bar,
+ .memb_ofs = offsetof(struct decoded_msg, bar),
+ },
+ {
+ .tag = TAG_BAZ,
+ .dec_func = dec_baz,
+ .enc_func = enc_baz,
+ .enc_to_str_func = enc_to_str_baz,
+ .memb_ofs = offsetof(struct decoded_msg, baz),
+ .has_presence_flag = true,
+ .presence_flag_ofs = offsetof(struct decoded_msg, baz_present),
+ },
+ {
+ .tag = TAG_REPEAT_INT,
+ .dec_func = dec_u16,
+ .enc_func = enc_u16,
+ .enc_to_str_func = enc_to_str_u16,
+ .memb_ofs = offsetof(struct decoded_msg, repeat_int),
+ .memb_array_pitch = OSMO_MEMB_ARRAY_PITCH(struct decoded_msg, repeat_int),
+ .has_count = true,
+ .count_ofs = offsetof(struct decoded_msg, repeat_int_count),
+ .max_count = ARRAY_SIZE( ((struct decoded_msg*)0)->repeat_int ),
+ },
+ {
+ .tag = TAG_REPEAT_STRUCT,
+ .dec_func = dec_repeat_struct,
+ .enc_func = enc_repeat_struct,
+ .enc_to_str_func = enc_to_str_repeat_struct,
+ .memb_ofs = offsetof(struct decoded_msg, repeat_struct),
+ .memb_array_pitch = OSMO_MEMB_ARRAY_PITCH(struct decoded_msg, repeat_struct),
+ .has_count = true,
+ .count_ofs = offsetof(struct decoded_msg, repeat_struct_count),
+ .max_count = ARRAY_SIZE( ((struct decoded_msg*)0)->repeat_struct ),
+ },
+ {
+ .tag = TAG_NEST,
+ .memb_ofs = offsetof(struct decoded_msg, nest),
+ .nested_ies = nested_inner_msg_ies,
+ .has_presence_flag = true,
+ .presence_flag_ofs = offsetof(struct decoded_msg, nest_present),
+ },
+ {0}
+};
+
+char *decoded_msg_to_str(const struct decoded_msg *m)
+{
+ return osmo_tlvs_encode_to_str_c(ctx, m, 0, msg_ie_coding, tag_names);
+}
+
+
+const struct decoded_msg enc_dec_tests[] = {
+ {
+ .foo = 23,
+ .bar = { "twentythree" },
+ },
+ {
+ .foo = 23,
+ .bar = { "twentythree" },
+
+ .baz_present = true,
+ .baz = {
+ .v_int = 2323,
+ .v_bool = true,
+ },
+ },
+ {
+ .foo = 23,
+ .bar = { "twentythree" },
+
+ .baz_present = true,
+ .baz = {
+ .v_int = 2323,
+ .v_bool = true,
+ },
+
+ .repeat_int_count = 3,
+ .repeat_int = { 1, 2, 0x7fff },
+ },
+ {
+ .foo = 23,
+ .bar = { "twentythree" },
+
+ .baz_present = true,
+ .baz = {
+ .v_int = 2323,
+ .v_bool = true,
+ },
+
+ .repeat_int_count = 3,
+ .repeat_int = { 1, 2, 0x7fff },
+
+ .repeat_struct_count = 2,
+ .repeat_struct = {
+ {
+ .v_int = 1001,
+ .v_bool = true,
+ .v_enum = R_A,
+ },
+ {
+ .v_int = 1002,
+ .v_bool = false,
+ .v_enum = R_B,
+ },
+ },
+
+ .nest_present = true,
+ .nest = {
+ .foo = 42,
+ .bar = { "fortytwo" },
+ .baz = {
+ .v_int = 4242,
+ .v_bool = false,
+ },
+ },
+ },
+};
+
+void err_cb(void *decoded_struct, const char *file, int line, const char *fmt, ...)
+{
+ va_list args;
+ va_start(args, fmt);
+ //printf("ERR: %s:%d ", file, line);
+ printf("ERR: ");
+ vprintf(fmt, args);
+ va_end(args);
+}
+
+void test_enc_dec(const char *label, const struct osmo_tlv_cfg *cfg, bool ordered)
+{
+ int i;
+ for (i = 0; i < ARRAY_SIZE(enc_dec_tests); i++) {
+ int rc;
+ const struct decoded_msg *orig = &enc_dec_tests[i];
+ struct decoded_msg parsed = {0};
+ struct osmo_tlv_load load;
+ struct osmo_tlv_put put;
+
+ printf("\n=== start %s %s[%d]\n", label, __func__, i);
+ printf("encoded: %s\n", decoded_msg_to_str(orig));
+
+ put = (struct osmo_tlv_put){
+ .cfg = cfg,
+ .dst = msgb_alloc(1024, __func__),
+ };
+ rc = osmo_tlvs_encode(&put, (void*)orig, 0, msg_ie_coding, err_cb, tag_names);
+ printf("osmo_tlvs_encode() rc = %d\n", rc);
+ printf("%s.\n", osmo_hexdump(put.dst->data, put.dst->len));
+
+ load = (struct osmo_tlv_load){
+ .cfg = cfg,
+ .src = { put.dst->data, put.dst->len },
+ };
+ rc = osmo_tlvs_decode(&parsed, 0, &load, ordered, msg_ie_coding, err_cb, tag_names);
+ printf("osmo_tlvs_decode() rc = %d\n", rc);
+ printf("decoded: %s\n", decoded_msg_to_str(&parsed));
+ if (strcmp(decoded_msg_to_str(orig), decoded_msg_to_str(&parsed))) {
+ printf(" ERROR: parsed != orig\n");
+ exit(1);
+ }
+ printf("=== end %s %s[%d]\n", label, __func__, i);
+ }
+}
+
+int main()
+{
+ ctx = talloc_named_const(NULL, 0, "tlv_test");
+ msgb_talloc_ctx_init(ctx, 0);
+
+ test_enc_dec("t8l8v ordered", &osmo_t8l8v_cfg, true);
+ test_enc_dec("t8l8v unordered", &osmo_t8l8v_cfg, false);
+
+ test_enc_dec("t16l16v ordered", &osmo_t16l16v_cfg, true);
+ test_enc_dec("t16l16v unordered", &osmo_t16l16v_cfg, false);
+
+ talloc_free(ctx);
+ return 0;
+}
diff --git a/tests/libosmo-tlv/tlv_dec_enc_test.ok b/tests/libosmo-tlv/tlv_dec_enc_test.ok
new file mode 100644
index 0000000..03f7375
--- /dev/null
+++ b/tests/libosmo-tlv/tlv_dec_enc_test.ok
@@ -0,0 +1,128 @@
+
+=== start t8l8v ordered test_enc_dec[0]
+encoded: FOO=23 BAR="twentythree"
+osmo_tlvs_encode() rc = 0
+01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 .
+osmo_tlvs_decode() rc = 0
+decoded: FOO=23 BAR="twentythree"
+=== end t8l8v ordered test_enc_dec[0]
+
+=== start t8l8v ordered test_enc_dec[1]
+encoded: FOO=23 BAR="twentythree" BAZ={2323,true}
+osmo_tlvs_encode() rc = 0
+01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 .
+osmo_tlvs_decode() rc = 0
+decoded: FOO=23 BAR="twentythree" BAZ={2323,true}
+=== end t8l8v ordered test_enc_dec[1]
+
+=== start t8l8v ordered test_enc_dec[2]
+encoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 }
+osmo_tlvs_encode() rc = 0
+01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff .
+osmo_tlvs_decode() rc = 0
+decoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 }
+=== end t8l8v ordered test_enc_dec[2]
+
+=== start t8l8v ordered test_enc_dec[3]
+encoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} }
+osmo_tlvs_encode() rc = 0
+01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff 05 03 03 e9 80 05 03 03 ea 01 06 12 01 02 00 2a 02 08 66 6f 72 74 79 74 77 6f 03 02 10 92 .
+osmo_tlvs_decode() rc = 0
+decoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} }
+=== end t8l8v ordered test_enc_dec[3]
+
+=== start t8l8v unordered test_enc_dec[0]
+encoded: FOO=23 BAR="twentythree"
+osmo_tlvs_encode() rc = 0
+01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 .
+osmo_tlvs_decode() rc = 0
+decoded: FOO=23 BAR="twentythree"
+=== end t8l8v unordered test_enc_dec[0]
+
+=== start t8l8v unordered test_enc_dec[1]
+encoded: FOO=23 BAR="twentythree" BAZ={2323,true}
+osmo_tlvs_encode() rc = 0
+01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 .
+osmo_tlvs_decode() rc = 0
+decoded: FOO=23 BAR="twentythree" BAZ={2323,true}
+=== end t8l8v unordered test_enc_dec[1]
+
+=== start t8l8v unordered test_enc_dec[2]
+encoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 }
+osmo_tlvs_encode() rc = 0
+01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff .
+osmo_tlvs_decode() rc = 0
+decoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 }
+=== end t8l8v unordered test_enc_dec[2]
+
+=== start t8l8v unordered test_enc_dec[3]
+encoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} }
+osmo_tlvs_encode() rc = 0
+01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff 05 03 03 e9 80 05 03 03 ea 01 06 12 01 02 00 2a 02 08 66 6f 72 74 79 74 77 6f 03 02 10 92 .
+osmo_tlvs_decode() rc = 0
+decoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} }
+=== end t8l8v unordered test_enc_dec[3]
+
+=== start t16l16v ordered test_enc_dec[0]
+encoded: FOO=23 BAR="twentythree"
+osmo_tlvs_encode() rc = 0
+00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 .
+osmo_tlvs_decode() rc = 0
+decoded: FOO=23 BAR="twentythree"
+=== end t16l16v ordered test_enc_dec[0]
+
+=== start t16l16v ordered test_enc_dec[1]
+encoded: FOO=23 BAR="twentythree" BAZ={2323,true}
+osmo_tlvs_encode() rc = 0
+00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 .
+osmo_tlvs_decode() rc = 0
+decoded: FOO=23 BAR="twentythree" BAZ={2323,true}
+=== end t16l16v ordered test_enc_dec[1]
+
+=== start t16l16v ordered test_enc_dec[2]
+encoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 }
+osmo_tlvs_encode() rc = 0
+00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff .
+osmo_tlvs_decode() rc = 0
+decoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 }
+=== end t16l16v ordered test_enc_dec[2]
+
+=== start t16l16v ordered test_enc_dec[3]
+encoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} }
+osmo_tlvs_encode() rc = 0
+00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff 00 05 00 03 03 e9 80 00 05 00 03 03 ea 01 00 06 00 18 00 01 00 02 00 2a 00 02 00 08 66 6f 72 74 79 74 77 6f 00 03 00 02 10 92 .
+osmo_tlvs_decode() rc = 0
+decoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} }
+=== end t16l16v ordered test_enc_dec[3]
+
+=== start t16l16v unordered test_enc_dec[0]
+encoded: FOO=23 BAR="twentythree"
+osmo_tlvs_encode() rc = 0
+00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 .
+osmo_tlvs_decode() rc = 0
+decoded: FOO=23 BAR="twentythree"
+=== end t16l16v unordered test_enc_dec[0]
+
+=== start t16l16v unordered test_enc_dec[1]
+encoded: FOO=23 BAR="twentythree" BAZ={2323,true}
+osmo_tlvs_encode() rc = 0
+00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 .
+osmo_tlvs_decode() rc = 0
+decoded: FOO=23 BAR="twentythree" BAZ={2323,true}
+=== end t16l16v unordered test_enc_dec[1]
+
+=== start t16l16v unordered test_enc_dec[2]
+encoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 }
+osmo_tlvs_encode() rc = 0
+00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff .
+osmo_tlvs_decode() rc = 0
+decoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 }
+=== end t16l16v unordered test_enc_dec[2]
+
+=== start t16l16v unordered test_enc_dec[3]
+encoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} }
+osmo_tlvs_encode() rc = 0
+00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff 00 05 00 03 03 e9 80 00 05 00 03 03 ea 01 00 06 00 18 00 01 00 02 00 2a 00 02 00 08 66 6f 72 74 79 74 77 6f 00 03 00 02 10 92 .
+osmo_tlvs_decode() rc = 0
+decoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} }
+=== end t16l16v unordered test_enc_dec[3]
diff --git a/tests/testsuite.at b/tests/testsuite.at
index 86ef4d3..3f7fcee 100644
--- a/tests/testsuite.at
+++ b/tests/testsuite.at
@@ -6,3 +6,9 @@
cat $abs_srcdir/libosmo-tlv/tlv_test.ok > expout
AT_CHECK([$abs_top_builddir/tests/libosmo-tlv/tlv_test], [], [expout], [ignore])
AT_CLEANUP
+
+AT_SETUP([tlv_dec_enc])
+AT_KEYWORDS([tlv_dec_enc])
+cat $abs_srcdir/libosmo-tlv/tlv_dec_enc_test.ok > expout
+AT_CHECK([$abs_top_builddir/tests/libosmo-tlv/tlv_dec_enc_test], [], [expout], [ignore])
+AT_CLEANUP
--
To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/27218
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-upf
Gerrit-Branch: master
Gerrit-Change-Id: I65de793105882a452124ee58adb0e58469e6e796
Gerrit-Change-Number: 27218
Gerrit-PatchSet: 1
Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de>
Gerrit-MessageType: newchange
1
0
Change in osmo-upf[master]: libosmo-tlv: add C code generator for IE structs and arrays
by neels 16 Feb '22
by neels 16 Feb '22
16 Feb '22
neels has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-upf/+/27219 )
Change subject: libosmo-tlv: add C code generator for IE structs and arrays
......................................................................
libosmo-tlv: add C code generator for IE structs and arrays
Defining a protocol of message types with lists of IEs bears a lot of
repetitive, copy-paste-error-prone writing out of data structures.
Add a third layer to libosmo-tlv, which allows helpful code generation.
By non-repetitive data structures that briefly describe the protocol's
messages and IEs, generate possibly repetitive IE list arrays and
decoded-struct definitions automatically, avoiding grunt work errors.
I tried C macros for this at first, but it became too convoluted.
Generating C code that can be read and grepped makes things easier.
A usage example is found in tests/libosmo-tlv/test_tlv_gen/.
Related: SYS#5599
Change-Id: Ifb3ea54d2797ce060b95834aa117725ec2d6c4cf
---
M configure.ac
M include/osmocom/tlv/Makefile.am
A include/osmocom/tlv/tlv_gen.h
M src/libosmo-tlv/Makefile.am
A src/libosmo-tlv/tlv_gen.c
M tests/libosmo-tlv/Makefile.am
A tests/libosmo-tlv/test_tlv_gen/Makefile.am
A tests/libosmo-tlv/test_tlv_gen/gen__myproto_ies_auto.c
A tests/libosmo-tlv/test_tlv_gen/myproto_ies_custom.c
A tests/libosmo-tlv/test_tlv_gen/myproto_ies_custom.h
A tests/libosmo-tlv/test_tlv_gen/tlv_gen_test.c
A tests/libosmo-tlv/test_tlv_gen/tlv_gen_test.ok
M tests/testsuite.at
13 files changed, 1,324 insertions(+), 0 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/osmo-upf refs/changes/19/27219/1
diff --git a/configure.ac b/configure.ac
index 70879e9..f9e85ce 100644
--- a/configure.ac
+++ b/configure.ac
@@ -205,6 +205,7 @@
tests/Makefile
tests/atlocal
tests/libosmo-tlv/Makefile
+ tests/libosmo-tlv/test_tlv_gen/Makefile
doc/Makefile
doc/examples/Makefile
doc/manuals/Makefile
diff --git a/include/osmocom/tlv/Makefile.am b/include/osmocom/tlv/Makefile.am
index 9843369..979bd13 100644
--- a/include/osmocom/tlv/Makefile.am
+++ b/include/osmocom/tlv/Makefile.am
@@ -1,6 +1,7 @@
tlv_HEADERS = \
tlv.h \
tlv_dec_enc.h \
+ tlv_gen.h \
$(NULL)
tlvdir = $(includedir)/osmocom/tlv
diff --git a/include/osmocom/tlv/tlv_gen.h b/include/osmocom/tlv/tlv_gen.h
new file mode 100644
index 0000000..9537371
--- /dev/null
+++ b/include/osmocom/tlv/tlv_gen.h
@@ -0,0 +1,111 @@
+/* Write h and c source files for TLV protocol definitions, based on very sparse TLV definitions.
+ * For a usage example see tests/libosmo-tlv/test_tlv_gen/. */
+#pragma once
+
+#include <stdbool.h>
+
+struct osmo_tlv_gen_ie;
+
+/*! Modifier for Mandatory/Optional/Multiple around an osmo_tlv_gen_ie. */
+struct osmo_tlv_gen_ie_o {
+ /*! Whether to add a bool foo_present, and to skip the coding if false. */
+ bool optional;
+ /*! If non-null, the member is an array: foo[123] with an unsigned int foo_count.
+ * Set to the maximum number of array elements. */
+ unsigned int multi;
+ /*! IE decoding / encoding instructions */
+ const struct osmo_tlv_gen_ie *ie;
+};
+
+/*! Define decoding and encoding of a single IE, i.e. one full TLV. */
+struct osmo_tlv_gen_ie {
+ /*! Member name.
+ * The C name of the member in a decoded struct.
+ * Some other names, if NULL, are derived from this name.
+ *
+ * For example, simply this
+ *
+ * struct osmo_tlv_gen_ie bar {
+ * .name = "bar",
+ * };
+ *
+ * Generates an osmo_tlv_coding entry of
+ *
+ * { MYPROTO_IEI_BAR,
+ * .memb_ofs = offsetof(struct myproto_foo, bar),
+ * .dec_func = myproto_dec_bar,
+ * .enc_func = myproto_enc_bar,
+ * }
+ */
+ const char *name;
+
+ /*! like "uint32_t".
+ * If NULL, auto-generate a "struct myproto_ie_foo" instead, useful only for an IE that contains nested IEs
+ * where the struct members can be derived from the nested_ies list.
+ */
+ const char *decoded_type;
+
+ /*! C name of this tag value, e.g. "MYPROTO_IEI_FOO". If NULL, take "MYPROTO_IEI_"+upper(name) instead. */
+ const char *tag_name;
+
+ /*! Name of the dec/enc functions. "foo" -> myproto_dec_foo(), myproto_enc_foo().
+ * These functions need to be implemented by the caller in a myproto_ies_custom.c. */
+ const char *dec_enc;
+
+ /*! Name of the enc_to_str function. "foo" -> myproto_enc_to_str_foo(). optional. */
+ const char *to_str;
+
+ /*! List of inner IEs terminated by {0}. If non-NULL, this is a "Grouped IE" with an inner TLV structure inside
+ * this IE's V part. */
+ const struct osmo_tlv_gen_ie_o *nested_ies;
+
+ /*! To place a spec comment in the generated code. */
+ const char *spec_ref;
+};
+
+/*! General TLV decoding and encoding definitions applying to all IEs (and nested IEs). */
+struct osmo_tlv_gen_cfg {
+ /*! Name of the protocol for use in C type or function names, like "myproto". */
+ const char *proto_name;
+
+ /*! When placing comments to spec references, prefix with this. For example, "3GPP TS 12.345 ". */
+ const char *spec_ref_prefix;
+
+ /*! The type to pass a message discriminator as, like 'enum myproto_message_types' */
+ const char *message_type_enum;
+ /*! To reference a message type discriminator like MYPROTO_MSGT_FOO, this would be "MYPROTO_MSGT_". */
+ const char *message_type_prefix;
+
+ /*! Type to use to represent tag IEI in decoded form.
+ * For example "enum foo_msg_iei". */
+ const char *tag_enum;
+ /*! The tag IEI enum value is uppercase(tag_prefix + (iedef->tag_name or iedef->name)).
+ * For example, with tag_prefix = "OSMO_FOO_IEI_", we would generate code like
+ * enum osmo_foo_iei tag = OSMO_FOO_IEI_BAR; */
+ const char *tag_prefix;
+
+ /*! When an osmo_tlv_gen_ie provides no decoded_type string, it is derived from .name and this prefix is
+ * added. For example, with decoded_type_prefix = "struct foo_ie_", the decoded_type defaults to
+ * struct foo_ie_bar for an IE definition with name = "bar". */
+ const char *decoded_type_prefix;
+
+ /*! To include user defined headers, set to something like "#include <osmocom/foo/foo_tlv_devs.h". This is put at
+ * the head of the generated .h file. */
+ const char *h_header;
+
+ /*! To include user defined headers, set to something like "#include <osmocom/foo/foo_msg.h". This is put at
+ * the head of the generated .c file. */
+ const char *c_header;
+
+ /*! Array of message IE definitions, indexed by message type. */
+ const struct osmo_tlv_gen_msg *msg_defs;
+};
+
+/*! For generating the outer union that composes a protocol's PDU variants, an entry of the list of message names and
+ * IEs in each message. */
+struct osmo_tlv_gen_msg {
+ const char *name;
+ const struct osmo_tlv_gen_ie_o *ies;
+};
+
+int osmo_tlv_gen_main(const struct osmo_tlv_gen_cfg *cfg, int argc, const char **argv);
diff --git a/src/libosmo-tlv/Makefile.am b/src/libosmo-tlv/Makefile.am
index 2b8a374..6c3b3d9 100644
--- a/src/libosmo-tlv/Makefile.am
+++ b/src/libosmo-tlv/Makefile.am
@@ -23,4 +23,5 @@
libosmo_tlv_a_SOURCES = \
tlv.c \
tlv_dec_enc.c \
+ tlv_gen.c \
$(NULL)
diff --git a/src/libosmo-tlv/tlv_gen.c b/src/libosmo-tlv/tlv_gen.c
new file mode 100644
index 0000000..17c5588
--- /dev/null
+++ b/src/libosmo-tlv/tlv_gen.c
@@ -0,0 +1,385 @@
+/* Write h and c source files for TLV protocol definitions, based on very sparse TLV definitions.
+ * For a usage example see tests/libosmo-tlv/test_tlv_gen/.
+ *
+ * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de>
+ * All Rights Reserved.
+ *
+ * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de>
+ *
+ * SPDX-License-Identifier: GPL-2.0+
+ *
+ * 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+#include <string.h>
+
+#include <osmocom/core/linuxlist.h>
+#include <osmocom/core/talloc.h>
+#include <osmocom/core/utils.h>
+
+#include <osmocom/tlv/tlv_gen.h>
+
+static const struct osmo_tlv_gen_cfg *g_cfg = NULL;
+
+/* Helps avoid redundant defintions of the same type. */
+struct seen_entry {
+ struct llist_head entry;
+ char str[256];
+};
+static LLIST_HEAD(seen_list);
+
+static bool seen(const char *str)
+{
+ struct seen_entry *s;
+ llist_for_each_entry(s, &seen_list, entry) {
+ if (!strcmp(s->str, str))
+ return true;
+ }
+ s = talloc_zero(NULL, struct seen_entry);
+ OSMO_STRLCPY_ARRAY(s->str, str);
+ llist_add(&s->entry, &seen_list);
+ return false;
+}
+static void clear_seen()
+{
+ struct seen_entry *s;
+ while ((s = llist_first_entry_or_null(&seen_list, struct seen_entry, entry))) {
+ llist_del(&s->entry);
+ talloc_free(s);
+ }
+}
+
+/* Return "struct foo_ie_bar" from g_cfg->decoded_type_prefix and ie. */
+static inline const char *decoded_type(const struct osmo_tlv_gen_ie *ie)
+{
+ static char b[255];
+ if (ie->decoded_type)
+ return ie->decoded_type;
+ /* "struct foo_ie_" + "bar" = struct foo_ie_bar*/
+ snprintf(b, sizeof(b), "%s%s", g_cfg->decoded_type_prefix, ie->tag_name ? : ie->name);
+ return b;
+}
+
+/* --- .h file --- */
+
+/* Write a listing of struct members like
+ * bool foo_present;
+ * int foo;
+ * struct myproto_ie_bar bar;
+ * struct abc abc[10];
+ * int abc_count;
+ */
+static void write_ie_members(const struct osmo_tlv_gen_ie_o ies[])
+{
+ for (; ies->ie; ies++) {
+ const struct osmo_tlv_gen_ie *ie = ies->ie;
+ if (ies->optional)
+ printf("\tbool %s_present;\n", ie->name);
+ printf("\t%s %s", decoded_type(ie), ie->name);
+ if (ies->multi) {
+ printf("[%u];\n", ies->multi);
+ printf("\tunsigned int %s_count", ie->name);
+ }
+ printf(";\n");
+ }
+}
+
+/* Traverse nesting levels in the message definitions and generate the structs for all as needed. */
+static void write_ie_auto_structs(const struct osmo_tlv_gen_ie_o ies[])
+{
+ if (!ies)
+ return;
+ for (; ies->ie; ies++) {
+ const struct osmo_tlv_gen_ie *ie = ies->ie;
+ if (!ie->nested_ies)
+ continue;
+ /* Recurse to write inner layers first, so that they can be referenced in outer layers. */
+ write_ie_auto_structs(ie->nested_ies);
+
+ /* Various IE definitions can use the same underlying type. Only generate each type once. */
+ if (seen(decoded_type(ie)))
+ continue;
+
+ /* Print:
+ *
+ * \* spec ref *\
+ * struct myproto_ie_goo {
+ * bool foo_present;
+ * int foo;
+ * struct myproto_ie_bar bar;
+ * struct abc abc[10];
+ * int abc_count;
+ * };
+ */
+ printf("\n");
+ if (ie->spec_ref)
+ printf("/* %s%s */\n", g_cfg->spec_ref_prefix, ie->spec_ref);
+ printf("%s {\n", decoded_type(ie));
+ write_ie_members(ie->nested_ies);
+ printf("};\n");
+ }
+}
+
+/* Write all auto-generated structs, starting with the outer message definitions and nesting into all contained IE
+ * definitions. */
+static void write_auto_structs()
+{
+ const struct osmo_tlv_gen_msg *gen_msg;
+ clear_seen();
+ for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) {
+ write_ie_auto_structs(gen_msg->ies);
+ }
+}
+
+/* Write the struct definitions for each message, i.e. for each entry in the outer PDU's message union, as well as the
+ * union itself.
+ *
+ * struct myproto_msg_foo {
+ * ...
+ * }:
+ * struct myproto_msg_goo {
+ * ...
+ * };
+ * union myproto_ies {
+ * myproto_msg_foo foo;
+ * myproto_msg_goo goo;
+ * };
+ */
+static void write_msg_union() {
+ const struct osmo_tlv_gen_msg *gen_msg;
+ for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) {
+ /* "struct foo_msg" + "_%s" { *
+ * struct foo_msg_goo_request { ... }; */
+ printf("\nstruct %s_msg_%s {\n",
+ g_cfg->proto_name,
+ gen_msg->name);
+ write_ie_members(gen_msg->ies);
+ printf("};\n");
+ }
+
+ printf("\nunion %s_ies {\n", g_cfg->proto_name);
+ for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) {
+ printf("\tstruct %s_msg_%s %s;\n", g_cfg->proto_name,
+ gen_msg->name, gen_msg->name);
+ }
+ printf("};\n");
+}
+
+/* Write the C header, myproto_ies_auto.h */
+static void write_h()
+{
+ printf("/* THIS FILE IS GENERATED FROM %s */\n", __FILE__);
+ printf("#include <stdint.h>\n");
+ printf("#include <osmocom/tlv/tlv_dec_enc.h>\n");
+ if (g_cfg->h_header)
+ printf("\n%s\n", g_cfg->h_header);
+ write_auto_structs();
+ write_msg_union();
+ printf("\nconst struct osmo_tlv_coding *%s_get_msg_coding(%s message_type);\n",
+ g_cfg->proto_name, g_cfg->message_type_enum ? : "int");
+ printf("\n"
+ "int %s_ies_decode(union %s_ies *dst, struct osmo_tlv_load *tlv, bool tlv_ordered,\n"
+ " %s message_type, osmo_tlv_err_cb err_cb, const struct value_string *iei_strs);\n",
+ g_cfg->proto_name, g_cfg->proto_name, g_cfg->message_type_enum ? : "int");
+ printf("\n"
+ "int %s_ies_encode(struct osmo_tlv_put *tlv, union %s_ies *src,\n"
+ " %s message_type, osmo_tlv_err_cb err_cb, const struct value_string *iei_strs);\n",
+ g_cfg->proto_name, g_cfg->proto_name, g_cfg->message_type_enum ? : "int");
+}
+
+/* --- .c file --- */
+
+/* Write a listing of:
+ * extern int myproto_dec_foo(...);
+ * extern int myproto_enc_foo(...);
+ */
+static void write_extern_dec_enc(const struct osmo_tlv_gen_ie_o *ies)
+{
+ for (; ies->ie; ies++) {
+ const struct osmo_tlv_gen_ie *ie = ies->ie;
+ const char *dec_enc = ie->dec_enc ? : (ie->tag_name ? : ie->name);
+ if (ie->nested_ies) {
+ write_extern_dec_enc(ie->nested_ies);
+ continue;
+ }
+ if (seen(dec_enc))
+ continue;
+ printf("extern int %s_dec_%s(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv);\n",
+ g_cfg->proto_name, dec_enc);
+ printf("extern int %s_enc_%s(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from);\n",
+ g_cfg->proto_name, dec_enc);
+ if (ie->to_str)
+ printf("extern int %s_enc_to_str_%s(char *buf, size_t buflen, void *encode_from);\n",
+ g_cfg->proto_name, ie->to_str);
+ }
+}
+
+/* For a nested IE, write the struct osmo_tlv_coding array of the inner IEs.
+ * { MYPROTO_IEI_BAR,
+ * .memb_ofs = offsetof(struct myproto_foo, bar),
+ * .dec_func = myproto_dec_bar,
+ * .enc_func = myproto_enc_bar,
+ * },
+ */
+static void write_ies_array(const char *indent, const struct osmo_tlv_gen_ie_o *ies, const char *obj_type, const char *substruct)
+{
+#define printi(FMT, ARGS...) printf("%s" FMT, indent, ##ARGS)
+
+ for (; ies->ie; ies++) {
+ const struct osmo_tlv_gen_ie *ie = ies->ie;
+ const char *tag_name = ie->tag_name ? : ie->name;
+ printi("{ %s%s,\n", g_cfg->tag_prefix, osmo_str_toupper(tag_name));
+ printi(" .memb_ofs = offsetof(%s, %s%s),\n", obj_type, substruct, ie->name);
+ if (ie->nested_ies) {
+ printi(" .nested_ies = ies_in_%s,\n", ie->name);
+ } else {
+ const char *dec_enc = ie->dec_enc ? : (ie->tag_name ? : ie->name);
+ printi(" .dec_func = %s_dec_%s,\n", g_cfg->proto_name, dec_enc);
+ printi(" .enc_func = %s_enc_%s,\n", g_cfg->proto_name, dec_enc);
+ if (ie->to_str)
+ printi(" .enc_to_str_func = %s_enc_to_str_%s,\n", g_cfg->proto_name, ie->to_str);
+ }
+ if (ies->multi) {
+ printi(" .memb_array_pitch = OSMO_MEMB_ARRAY_PITCH(%s, %s%s),\n",
+ obj_type, substruct, ie->name);
+ printi(" .has_count = true, .max_count = %u,\n", ies->multi);
+ printi(" .count_ofs = offsetof(%s, %s%s_count),\n", obj_type, substruct, ie->name);
+ }
+ if (ies->optional) {
+ printi(" .has_presence_flag = true,\n");
+ printi(" .presence_flag_ofs = offsetof(%s, %s%s_present),\n", obj_type, substruct, ie->name);
+ }
+ printi("},\n");
+ }
+}
+
+/* For a nested IE, write the struct osmo_tlv_coding array of the inner IEs.
+ * static const struct osmo_tlv_coding ies_in_foo[] = {
+ * { MYPROTO_IEI_BAR,
+ * .memb_ofs = offsetof(struct myproto_foo, bar),
+ * .dec_func = myproto_dec_bar,
+ * .enc_func = myproto_enc_bar,
+ * },
+ * ...
+ * };
+ */
+static void write_nested_ies_array(const struct osmo_tlv_gen_ie_o *ies)
+{
+ const char *indent = "\t";
+ for (; ies->ie; ies++) {
+ const struct osmo_tlv_gen_ie *ie = ies->ie;
+ if (!ie->nested_ies)
+ continue;
+ write_nested_ies_array(ie->nested_ies);
+
+ if (seen(ie->name))
+ continue;
+
+ printf("\nstatic const struct osmo_tlv_coding ies_in_%s[] = {\n", ie->name);
+ write_ies_array(indent, ie->nested_ies, decoded_type(ie), "");
+ printi("{0}\n");
+ printf("};\n");
+ }
+}
+
+/* Write the bulk of the C code: on the basis of the list of messages (g_cfg->msg_defs), write all dec/enc function
+ * declarations, all IEs arrays as well as the list of message types, first triggering to write the C code for any inner
+ * layers. */
+static void write_c()
+{
+ const struct osmo_tlv_gen_msg *gen_msg;
+
+ printf("/* THIS FILE IS GENERATED FROM %s */\n", __FILE__);
+ printf("#include <stddef.h>\n");
+ printf("#include <errno.h>\n");
+ printf("#include <osmocom/core/utils.h>\n");
+ printf("#include <osmocom/tlv/tlv.h>\n");
+ printf("#include <osmocom/tlv/tlv_dec_enc.h>\n");
+ printf("#include <osmocom/tlv/tlv_gen.h>\n");
+ if (g_cfg->c_header)
+ printf("\n%s\n", g_cfg->c_header);
+
+ printf("\n");
+ clear_seen();
+ for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) {
+ write_extern_dec_enc(gen_msg->ies);
+ }
+
+ clear_seen();
+ for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) {
+ write_nested_ies_array(gen_msg->ies);
+ }
+
+ for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) {
+ char *obj_type = talloc_asprintf(NULL, "union %s_ies", g_cfg->proto_name);
+ char *substruct = talloc_asprintf(NULL, "%s.", gen_msg->name);
+ printf("\nstatic const struct osmo_tlv_coding ies_in_msg_%s[] = {\n", gen_msg->name);
+ write_ies_array("\t", gen_msg->ies, obj_type, substruct);
+ printf("\t{0}\n};\n");
+ talloc_free(substruct);
+ talloc_free(obj_type);
+ }
+ printf("\nstatic const struct osmo_tlv_coding *msg_defs[] = {\n");
+ for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) {
+ printf("\t[%s%s] = ies_in_msg_%s,\n", g_cfg->message_type_prefix, osmo_str_toupper(gen_msg->name), gen_msg->name);
+ }
+ printf("};\n");
+
+ /* print this code snippet into the .c file, because only there can we do ARRAY_SIZE(foo_msg_coding). */
+ printf("\n"
+ "const struct osmo_tlv_coding *%s_get_msg_coding(%s message_type)\n"
+ "{\n"
+ " if (message_type >= ARRAY_SIZE(msg_defs))\n"
+ " return NULL;\n"
+ " return msg_defs[message_type];\n"
+ "}\n",
+ g_cfg->proto_name, g_cfg->message_type_enum ? : "int");
+
+ printf("\n"
+ "int %s_ies_decode(union %s_ies *dst, struct osmo_tlv_load *tlv, bool tlv_ordered,\n"
+ " %s message_type,\n"
+ " osmo_tlv_err_cb err_cb, const struct value_string *iei_strs)\n"
+ "{\n"
+ " return osmo_tlvs_decode(dst, 0, tlv, tlv_ordered, %s_get_msg_coding(message_type), err_cb, iei_strs);\n"
+ "}\n",
+ g_cfg->proto_name, g_cfg->proto_name, g_cfg->message_type_enum ? : "int", g_cfg->proto_name);
+ printf("\n"
+ "int %s_ies_encode(struct osmo_tlv_put *tlv, union %s_ies *src,\n"
+ " %s message_type, osmo_tlv_err_cb err_cb, const struct value_string *iei_strs)\n"
+ "{\n"
+ " return osmo_tlvs_encode(tlv, src, 0, %s_get_msg_coding(message_type), err_cb, iei_strs);\n"
+ "}\n",
+ g_cfg->proto_name, g_cfg->proto_name, g_cfg->message_type_enum ? : "int", g_cfg->proto_name);
+}
+
+/* Call this from your main(). */
+int osmo_tlv_gen_main(const struct osmo_tlv_gen_cfg *cfg, int argc, const char **argv)
+{
+ if (argc < 2)
+ return 1;
+
+ g_cfg = cfg;
+
+ if (strcmp(argv[1], "h") == 0)
+ write_h();
+ else if (strcmp(argv[1], "c") == 0)
+ write_c();
+ else
+ return 1;
+
+ clear_seen();
+ return 0;
+}
diff --git a/tests/libosmo-tlv/Makefile.am b/tests/libosmo-tlv/Makefile.am
index ff3fba9..64e3bdd 100644
--- a/tests/libosmo-tlv/Makefile.am
+++ b/tests/libosmo-tlv/Makefile.am
@@ -1,3 +1,7 @@
+SUBDIRS = \
+ test_tlv_gen \
+ $(NULL)
+
AM_CPPFLAGS = \
$(all_includes) \
-I$(top_srcdir)/include \
@@ -40,3 +44,4 @@
update_exp:
$(builddir)/tlv_test >$(srcdir)/tlv_test.ok
$(builddir)/tlv_dec_enc_test >$(srcdir)/tlv_dec_enc_test.ok
+ $(MAKE) -C test_tlv_gen update_exp
diff --git a/tests/libosmo-tlv/test_tlv_gen/Makefile.am b/tests/libosmo-tlv/test_tlv_gen/Makefile.am
new file mode 100644
index 0000000..79c925c
--- /dev/null
+++ b/tests/libosmo-tlv/test_tlv_gen/Makefile.am
@@ -0,0 +1,60 @@
+AM_CPPFLAGS = \
+ $(all_includes) \
+ -I$(top_srcdir)/include \
+ -I$(bulddir) \
+ $(NULL)
+
+AM_CFLAGS = \
+ -Wall \
+ $(LIBOSMOCORE_CFLAGS) \
+ $(NULL)
+
+noinst_PROGRAMS = \
+ gen__myproto_ies_auto \
+ tlv_gen_test \
+ $(NULL)
+
+EXTRA_DIST = \
+ myproto_ies_custom.h \
+ tlv_gen_test.ok \
+ $(NULL)
+
+BUILT_SOURCES = \
+ myproto_ies_auto.h \
+ myproto_ies_auto.c \
+ $(NULL)
+
+CLEANFILES = \
+ myproto_ies_auto.h \
+ myproto_ies_auto.c \
+ $(NULL)
+
+gen__myproto_ies_auto_SOURCES = \
+ gen__myproto_ies_auto.c \
+ myproto_ies_custom.c \
+ $(NULL)
+
+gen__myproto_ies_auto_LDADD = \
+ $(top_builddir)/src/libosmo-tlv/libosmo-tlv.a \
+ $(LIBOSMOCORE_LIBS) \
+ $(NULL)
+
+myproto_ies_auto.h: $(builddir)/gen__myproto_ies_auto
+ $(builddir)/gen__myproto_ies_auto h > $(builddir)/myproto_ies_auto.h
+myproto_ies_auto.c: $(builddir)/gen__myproto_ies_auto
+ $(builddir)/gen__myproto_ies_auto c > $(builddir)/myproto_ies_auto.c
+
+tlv_gen_test_SOURCES = \
+ tlv_gen_test.c \
+ myproto_ies_custom.c \
+ myproto_ies_auto.c \
+ $(NULL)
+
+tlv_gen_test_LDADD = \
+ $(top_builddir)/src/libosmo-tlv/libosmo-tlv.a \
+ $(LIBOSMOCORE_LIBS) \
+ $(NULL)
+
+.PHONY: update_exp
+update_exp:
+ $(builddir)/tlv_gen_test >$(srcdir)/tlv_gen_test.ok
diff --git a/tests/libosmo-tlv/test_tlv_gen/gen__myproto_ies_auto.c b/tests/libosmo-tlv/test_tlv_gen/gen__myproto_ies_auto.c
new file mode 100644
index 0000000..1d5ea4a
--- /dev/null
+++ b/tests/libosmo-tlv/test_tlv_gen/gen__myproto_ies_auto.c
@@ -0,0 +1,135 @@
+/*
+ * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de>
+ * All Rights Reserved.
+ *
+ * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de>
+ *
+ * SPDX-License-Identifier: GPL-2.0+
+ *
+ * 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+#include <stdbool.h>
+#include <stdio.h>
+#include <osmocom/core/utils.h>
+#include <osmocom/core/linuxlist.h>
+#include <osmocom/core/talloc.h>
+#include <osmocom/tlv/tlv_gen.h>
+
+#define O(IE_INST) { .optional = true, .ie = &IE_INST }
+#define M(IE_INST) { .ie = &(IE_INST) }
+#define MULTI(MAX, IE_INST) { .multi = MAX, .ie = &(IE_INST) }
+
+static const struct osmo_tlv_gen_ie foo = {
+ .name = "foo",
+ .decoded_type = "int", /* adds 'int foo;' to the struct */
+ .dec_enc = "u16", /* uses myproto_dec_u16() and myproto_enc_u16() for the TLV value part */
+ .to_str = "u16", /* uses myproto_enc_to_str_u16() */
+ .spec_ref = "an int coded as uint16_t",
+};
+
+static const struct osmo_tlv_gen_ie bar = {
+ .name = "bar",
+ /* uses 'struct ie_bar bar;' and dec_bar()/enc_bar() */
+ .to_str = "bar", /* uses myproto_enc_to_str_bar() */
+};
+
+static const struct osmo_tlv_gen_ie baz = {
+ .name = "baz",
+ /* uses 'struct ie_baz baz;' and dec_baz()/enc_baz() */
+ .to_str = "baz",
+};
+
+static const struct osmo_tlv_gen_ie repeat_int = {
+ .name = "repeat_int",
+ .decoded_type = "int", /* adds 'int repeat_int;' to the struct */
+ .dec_enc = "u16", /* uses dec_u16() and enc_u16() for the TLV value part */
+ .to_str = "u16",
+};
+
+static const struct osmo_tlv_gen_ie repeat_struct = {
+ .name = "repeat_struct",
+ .to_str = "repeat_struct",
+};
+
+static const struct osmo_tlv_gen_ie_o ies_in_moo_nest[] = {
+ M(foo),
+ M(bar),
+ M(baz),
+ {0}
+};
+
+static const struct osmo_tlv_gen_ie moo_nest = {
+ .name = "moo_nest",
+ .nested_ies = ies_in_moo_nest,
+};
+
+static const struct osmo_tlv_gen_ie val = {
+ .name = "val",
+ .decoded_type = "uint64_t",
+ .dec_enc = "u64",
+ .to_str = "u64",
+};
+
+static const struct osmo_tlv_gen_ie_o ies_in_goo_nest[] = {
+ O(val),
+ M(moo_nest),
+ {0}
+};
+
+static const struct osmo_tlv_gen_ie goo_nest = {
+ .name = "goo_nest",
+ .nested_ies = ies_in_goo_nest,
+};
+
+static const struct osmo_tlv_gen_ie_o ies_in_moo_msg[] = {
+ M(foo),
+ M(bar),
+ O(baz),
+ MULTI(32, repeat_int),
+ MULTI(32, repeat_struct),
+ O(moo_nest),
+ {0}
+};
+
+static const struct osmo_tlv_gen_ie_o ies_in_goo_msg[] = {
+ M(foo),
+ O(bar),
+ MULTI(8, goo_nest),
+ {0}
+};
+
+static const struct osmo_tlv_gen_msg msg_defs[] = {
+ { "moo", ies_in_moo_msg },
+ { "goo", ies_in_goo_msg },
+ {0}
+};
+
+int main(int argc, const char **argv)
+{
+ struct osmo_tlv_gen_cfg cfg = {
+ .proto_name = "myproto",
+ .message_type_enum = "enum myproto_msg_type",
+ .message_type_prefix = "MYPROTO_MSGT_",
+ .tag_enum = "enum myproto_iei",
+ .tag_prefix = "MYPROTO_IEI_",
+ .decoded_type_prefix = "struct myproto_ie_",
+ .h_header = "#include \"myproto_ies_custom.h\"",
+ .c_header = "#include <myproto_ies_auto.h>",
+ .msg_defs = msg_defs,
+ };
+ return osmo_tlv_gen_main(&cfg, argc, argv);
+}
diff --git a/tests/libosmo-tlv/test_tlv_gen/myproto_ies_custom.c b/tests/libosmo-tlv/test_tlv_gen/myproto_ies_custom.c
new file mode 100644
index 0000000..c45eae5
--- /dev/null
+++ b/tests/libosmo-tlv/test_tlv_gen/myproto_ies_custom.c
@@ -0,0 +1,156 @@
+#include <errno.h>
+#include <inttypes.h>
+
+#include <osmocom/core/bits.h>
+#include <osmocom/core/msgb.h>
+#include <osmocom/tlv/tlv.h>
+
+#include <myproto_ies_custom.h>
+
+int myproto_dec_u16(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv)
+{
+ int *foo = decode_to;
+ if (tlv->len != 2)
+ return -EINVAL;
+ *foo = osmo_load16be(tlv->val);
+ return 0;
+}
+
+int myproto_enc_u16(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from)
+{
+ int *foo = encode_from;
+ if (*foo > INT16_MAX)
+ return -EINVAL;
+ msgb_put_u16(tlv->dst, *foo);
+ return 0;
+}
+
+int myproto_enc_to_str_u16(char *buf, size_t buflen, void *encode_from)
+{
+ int *foo = encode_from;
+ return snprintf(buf, buflen, "%d", *foo);
+}
+
+int myproto_dec_u64(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv)
+{
+ uint64_t *val = decode_to;
+ if (tlv->len != sizeof(uint64_t))
+ return -EINVAL;
+ *val = osmo_load64be(tlv->val);
+ return 0;
+}
+
+int myproto_enc_u64(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from)
+{
+ uint64_t *val = encode_from;
+ osmo_store64be(*val, msgb_put(tlv->dst, sizeof(*val)));
+ return 0;
+}
+
+int myproto_enc_to_str_u64(char *buf, size_t buflen, void *encode_from)
+{
+ uint64_t *val = encode_from;
+ return snprintf(buf, buflen, "0x%"PRIx64, *val);
+}
+
+int myproto_dec_bar(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv)
+{
+ struct myproto_ie_bar *bar = decode_to;
+ if (tlv->len > sizeof(bar->str) - 1)
+ return -EINVAL;
+ osmo_strlcpy(bar->str, (const char*)tlv->val, OSMO_MIN(tlv->len + 1, sizeof(bar->str)));
+ return 0;
+}
+
+int myproto_enc_bar(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from)
+{
+ struct myproto_ie_bar *bar = encode_from;
+ int len = strnlen(bar->str, sizeof(bar->str));
+ memcpy(msgb_put(tlv->dst, len), bar, len);
+ return 0;
+}
+
+int myproto_enc_to_str_bar(char *buf, size_t buflen, void *encode_from)
+{
+ struct myproto_ie_bar *bar = encode_from;
+ return osmo_quote_str_buf3(buf, buflen, bar->str, -1);
+}
+
+int myproto_dec_baz(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv)
+{
+ struct myproto_ie_baz *baz = decode_to;
+ uint16_t l;
+ if (tlv->len != 2)
+ return -EINVAL;
+ l = osmo_load16be(tlv->val);
+ baz->v_int = l & 0x7fff;
+ baz->v_bool = (l & 0x8000) ? true : false;
+ return 0;
+}
+
+int myproto_enc_baz(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from)
+{
+ struct myproto_ie_baz *baz = encode_from;
+ if (baz->v_int > 0x7fff)
+ return -EINVAL;
+ msgb_put_u16(tlv->dst, (baz->v_bool ? 0x8000 : 0) + (baz->v_int & 0x7fff));
+ return 0;
+}
+
+int myproto_enc_to_str_baz(char *buf, size_t buflen, void *encode_from)
+{
+ struct myproto_ie_baz *baz = encode_from;
+ return snprintf(buf, buflen, "{%d,%s}", baz->v_int, baz->v_bool ? "true" : "false");
+}
+
+int myproto_dec_repeat_struct(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv)
+{
+ struct myproto_ie_repeat_struct *repeat_struct = decode_to;
+ if (tlv->len != 3)
+ return -EINVAL;
+ repeat_struct->v_int = osmo_load16be(tlv->val);
+ repeat_struct->v_bool = tlv->val[2] & 0x80;
+ repeat_struct->v_enum = tlv->val[2] & 0x7f;
+ return 0;
+}
+
+int myproto_enc_repeat_struct(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from)
+{
+ struct myproto_ie_repeat_struct *repeat_struct = encode_from;
+ msgb_put_u16(tlv->dst, repeat_struct->v_int);
+ msgb_put_u8(tlv->dst, (repeat_struct->v_bool ? 0x80 : 0) + (repeat_struct->v_enum & 0x7f));
+ return 0;
+}
+
+int myproto_enc_to_str_repeat_struct(char *buf, size_t buflen, void *encode_from)
+{
+ struct myproto_ie_repeat_struct *repeat_struct = encode_from;
+ return snprintf(buf, buflen, "{%d,%s,%s}",
+ repeat_struct->v_int, repeat_struct->v_bool ? "true" : "false",
+ get_value_string(myproto_repeat_enum_names, repeat_struct->v_enum));
+}
+
+const struct value_string myproto_msg_type_names[] = {
+ { MYPROTO_MSGT_MOO, "MOO" },
+ { MYPROTO_MSGT_GOO, "GOO" },
+ {0}
+};
+
+const struct value_string myproto_iei_names[] = {
+ { MYPROTO_IEI_FOO, "FOO" },
+ { MYPROTO_IEI_BAR, "BAR" },
+ { MYPROTO_IEI_BAZ, "BAZ" },
+ { MYPROTO_IEI_REPEAT_INT, "REPEAT_INT" },
+ { MYPROTO_IEI_REPEAT_STRUCT, "REPEAT_STRUCT" },
+ { MYPROTO_IEI_MOO_NEST, "MOO_NEST" },
+ { MYPROTO_IEI_VAL, "VAL" },
+ { MYPROTO_IEI_GOO_NEST, "GOO_NEST" },
+ {0}
+};
+
+const struct value_string myproto_repeat_enum_names[] = {
+ OSMO_VALUE_STRING(R_A),
+ OSMO_VALUE_STRING(R_B),
+ OSMO_VALUE_STRING(R_C),
+ {0}
+};
diff --git a/tests/libosmo-tlv/test_tlv_gen/myproto_ies_custom.h b/tests/libosmo-tlv/test_tlv_gen/myproto_ies_custom.h
new file mode 100644
index 0000000..bf65f4d
--- /dev/null
+++ b/tests/libosmo-tlv/test_tlv_gen/myproto_ies_custom.h
@@ -0,0 +1,47 @@
+/* Definitions for decoded message IEs, to be used by the auto-generated tlv_gen_test_tlv.c. */
+#pragma once
+
+#include <osmocom/core/utils.h>
+
+enum myproto_msg_type {
+ MYPROTO_MSGT_MOO = 1,
+ MYPROTO_MSGT_GOO = 7,
+};
+
+extern const struct value_string myproto_msg_type_names[];
+
+enum myproto_iei {
+ MYPROTO_IEI_FOO = 1,
+ MYPROTO_IEI_BAR,
+ MYPROTO_IEI_BAZ,
+ MYPROTO_IEI_REPEAT_INT,
+ MYPROTO_IEI_REPEAT_STRUCT,
+ MYPROTO_IEI_MOO_NEST,
+ MYPROTO_IEI_VAL,
+ MYPROTO_IEI_GOO_NEST,
+};
+
+extern const struct value_string myproto_iei_names[];
+
+struct myproto_ie_bar {
+ char str[23];
+};
+
+struct myproto_ie_baz {
+ int v_int;
+ bool v_bool;
+};
+
+enum myproto_repeat_enum {
+ R_A,
+ R_B,
+ R_C,
+};
+
+extern const struct value_string myproto_repeat_enum_names[];
+
+struct myproto_ie_repeat_struct {
+ int v_int;
+ bool v_bool;
+ enum myproto_repeat_enum v_enum;
+};
diff --git a/tests/libosmo-tlv/test_tlv_gen/tlv_gen_test.c b/tests/libosmo-tlv/test_tlv_gen/tlv_gen_test.c
new file mode 100644
index 0000000..4135f50
--- /dev/null
+++ b/tests/libosmo-tlv/test_tlv_gen/tlv_gen_test.c
@@ -0,0 +1,256 @@
+/* (C) 2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de>
+ * All Rights Reserved
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation; either version 3 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 Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include <stdio.h>
+#include <errno.h>
+
+#include <osmocom/core/application.h>
+#include <osmocom/core/utils.h>
+#include <osmocom/core/msgb.h>
+
+#include <osmocom/tlv/tlv.h>
+
+#include <myproto_ies_auto.h>
+
+struct myproto_msg {
+ enum myproto_msg_type type;
+ union myproto_ies ies;
+};
+
+static void err_cb(void *decoded_struct, const char *file, int line, const char *fmt, ...)
+{
+ va_list args;
+ va_start(args, fmt);
+ //printf("ERR: %s:%d ", file, line);
+ printf("ERR: ");
+ vprintf(fmt, args);
+ va_end(args);
+}
+
+static int myproto_msg_enc(struct msgb *dst, const struct myproto_msg *msg, const struct osmo_tlv_cfg *cfg)
+{
+ struct osmo_tlv_put tlv = {
+ .cfg = cfg,
+ .dst = dst,
+ };
+
+ msgb_put_u8(tlv.dst, msg->type);
+ return myproto_ies_encode(&tlv, (void*)&msg->ies, msg->type, err_cb, myproto_iei_names);
+}
+
+static int myproto_msg_dec(struct myproto_msg *msg, const uint8_t *data, size_t data_len,
+ const struct osmo_tlv_cfg *cfg, bool ordered)
+{
+ struct osmo_tlv_load tlv;
+ if (data_len < 1)
+ return -EINVAL;
+ msg->type = data[0];
+ tlv = (struct osmo_tlv_load){
+ .cfg = cfg,
+ .src = { data + 1, data_len - 1 },
+ };
+ return myproto_ies_decode(&msg->ies, &tlv, ordered, msg->type, err_cb, myproto_iei_names);
+}
+
+void *ctx;
+
+struct myproto_msg tests[] = {
+ {
+ MYPROTO_MSGT_MOO,
+ {
+ .moo = {
+ .foo = 23,
+ .bar = { "twentythree" },
+ },
+ },
+ },
+ {
+ MYPROTO_MSGT_MOO,
+ {
+ .moo = {
+ .foo = 23,
+ .bar = { "twentythree" },
+
+ .baz_present = true,
+ .baz = {
+ .v_int = 2323,
+ .v_bool = true,
+ },
+ },
+ },
+ },
+ {
+ MYPROTO_MSGT_MOO,
+ {
+ .moo = {
+ .foo = 23,
+ .bar = { "twentythree" },
+
+ .baz_present = true,
+ .baz = {
+ .v_int = 2323,
+ .v_bool = true,
+ },
+
+ .repeat_int_count = 3,
+ .repeat_int = { 1, 2, 0x7fff },
+ },
+ },
+ },
+ {
+ MYPROTO_MSGT_MOO,
+ {
+ .moo = {
+ .foo = 23,
+ .bar = { "twentythree" },
+
+ .baz_present = true,
+ .baz = {
+ .v_int = 2323,
+ .v_bool = true,
+ },
+
+ .repeat_int_count = 3,
+ .repeat_int = { 1, 2, 0x7fff },
+
+ .repeat_struct_count = 2,
+ .repeat_struct = {
+ {
+ .v_int = 1001,
+ .v_bool = true,
+ .v_enum = R_A,
+ },
+ {
+ .v_int = 1002,
+ .v_bool = false,
+ .v_enum = R_B,
+ },
+ },
+
+ .moo_nest_present = true,
+ .moo_nest = {
+ .foo = 42,
+ .bar = { "fortytwo" },
+ .baz = {
+ .v_int = 4242,
+ .v_bool = false,
+ },
+ },
+ },
+ },
+ },
+ {
+ MYPROTO_MSGT_GOO,
+ {
+ .goo = {
+ .foo = 17,
+
+ .bar_present = true,
+ .bar = { "gooei" },
+
+ .goo_nest_count = 2,
+ .goo_nest = {
+ {
+ .val_present = true,
+ .val = 0x0123456789abcdef,
+ .moo_nest = {
+ .foo = 11,
+ .bar = { "eleven" },
+ .baz = {
+ .v_int = 1111,
+ .v_bool = true,
+ },
+ },
+ },
+ {
+ .val_present = false,
+ .moo_nest = {
+ .foo = 12,
+ .bar = { "twelve" },
+ .baz = {
+ .v_int = 1212,
+ .v_bool = false,
+ },
+ },
+ },
+ },
+ },
+ },
+ },
+};
+
+int myproto_msg_to_str_buf(char *buf, size_t buflen, const struct myproto_msg *m)
+{
+ struct osmo_strbuf sb = { .buf = buf, .len = buflen };
+ OSMO_STRBUF_PRINTF(sb, "%s={", get_value_string(myproto_msg_type_names, m->type));
+ OSMO_STRBUF_APPEND(sb, osmo_tlvs_encode_to_str_buf, &m->ies, 0, myproto_get_msg_coding(m->type),
+ myproto_iei_names);
+ OSMO_STRBUF_PRINTF(sb, " }");
+ return sb.chars_needed;
+
+}
+
+char *myproto_msg_to_str(const struct myproto_msg *m)
+{
+ OSMO_NAME_C_IMPL(ctx, 256, "ERROR", myproto_msg_to_str_buf, m)
+}
+
+void test_enc_dec(const char *label, const struct osmo_tlv_cfg *cfg, bool ordered)
+{
+ int i;
+ for (i = 0; i < ARRAY_SIZE(tests); i++) {
+ int rc;
+ const struct myproto_msg *orig = &tests[i];
+ struct myproto_msg parsed = {0};
+ struct msgb *msg;
+
+ printf("\n=== start %s %s[%d]\n", label, __func__, i);
+ printf("encoded: %s\n", myproto_msg_to_str(orig));
+
+ msg = msgb_alloc(1024, __func__),
+ rc = myproto_msg_enc(msg, orig, cfg);
+ printf("myproto_msg_enc() rc = %d\n", rc);
+ printf("%s.\n", osmo_hexdump(msg->data, msg->len));
+
+ rc = myproto_msg_dec(&parsed, msg->data, msg->len, cfg, ordered);
+ printf("myproto_msg_dec() rc = %d\n", rc);
+ printf("decoded: %s\n", myproto_msg_to_str(&parsed));
+ if (strcmp(myproto_msg_to_str(orig), myproto_msg_to_str(&parsed))) {
+ printf(" ERROR: parsed != orig\n");
+ exit(1);
+ }
+
+ msgb_free(msg);
+ printf("=== end %s %s[%d]\n", label, __func__, i);
+ }
+}
+
+int main()
+{
+ ctx = talloc_named_const(NULL, 0, "test_gen_tlv");
+ msgb_talloc_ctx_init(ctx, 0);
+
+ test_enc_dec("t8l8v ordered", &osmo_t8l8v_cfg, true);
+ test_enc_dec("t8l8v unordered", &osmo_t8l8v_cfg, false);
+
+ test_enc_dec("t16l16v ordered", &osmo_t16l16v_cfg, true);
+ test_enc_dec("t16l16v unordered", &osmo_t16l16v_cfg, false);
+
+ talloc_free(ctx);
+ return 0;
+}
diff --git a/tests/libosmo-tlv/test_tlv_gen/tlv_gen_test.ok b/tests/libosmo-tlv/test_tlv_gen/tlv_gen_test.ok
new file mode 100644
index 0000000..9974d67
--- /dev/null
+++ b/tests/libosmo-tlv/test_tlv_gen/tlv_gen_test.ok
@@ -0,0 +1,160 @@
+
+=== start t8l8v ordered test_enc_dec[0]
+encoded: MOO={ FOO=23 BAR="twentythree" }
+myproto_msg_enc() rc = 0
+01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 .
+myproto_msg_dec() rc = 0
+decoded: MOO={ FOO=23 BAR="twentythree" }
+=== end t8l8v ordered test_enc_dec[0]
+
+=== start t8l8v ordered test_enc_dec[1]
+encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} }
+myproto_msg_enc() rc = 0
+01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 .
+myproto_msg_dec() rc = 0
+decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} }
+=== end t8l8v ordered test_enc_dec[1]
+
+=== start t8l8v ordered test_enc_dec[2]
+encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } }
+myproto_msg_enc() rc = 0
+01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff .
+myproto_msg_dec() rc = 0
+decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } }
+=== end t8l8v ordered test_enc_dec[2]
+
+=== start t8l8v ordered test_enc_dec[3]
+encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } MOO_NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } }
+myproto_msg_enc() rc = 0
+01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff 05 03 03 e9 80 05 03 03 ea 01 06 12 01 02 00 2a 02 08 66 6f 72 74 79 74 77 6f 03 02 10 92 .
+myproto_msg_dec() rc = 0
+decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } MOO_NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } }
+=== end t8l8v ordered test_enc_dec[3]
+
+=== start t8l8v ordered test_enc_dec[4]
+encoded: GOO={ FOO=17 BAR="gooei" GOO_NEST={ { VAL=0x123456789abcdef MOO_NEST={ FOO=11 BAR="eleven" BAZ={1111,true} } }, { MOO_NEST={ FOO=12 BAR="twelve" BAZ={1212,false} } } } }
+myproto_msg_enc() rc = 0
+07 01 02 00 11 02 05 67 6f 6f 65 69 08 1c 07 08 01 23 45 67 89 ab cd ef 06 10 01 02 00 0b 02 06 65 6c 65 76 65 6e 03 02 84 57 08 12 06 10 01 02 00 0c 02 06 74 77 65 6c 76 65 03 02 04 bc .
+myproto_msg_dec() rc = 0
+decoded: GOO={ FOO=17 BAR="gooei" GOO_NEST={ { VAL=0x123456789abcdef MOO_NEST={ FOO=11 BAR="eleven" BAZ={1111,true} } }, { MOO_NEST={ FOO=12 BAR="twelve" BAZ={1212,false} } } } }
+=== end t8l8v ordered test_enc_dec[4]
+
+=== start t8l8v unordered test_enc_dec[0]
+encoded: MOO={ FOO=23 BAR="twentythree" }
+myproto_msg_enc() rc = 0
+01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 .
+myproto_msg_dec() rc = 0
+decoded: MOO={ FOO=23 BAR="twentythree" }
+=== end t8l8v unordered test_enc_dec[0]
+
+=== start t8l8v unordered test_enc_dec[1]
+encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} }
+myproto_msg_enc() rc = 0
+01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 .
+myproto_msg_dec() rc = 0
+decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} }
+=== end t8l8v unordered test_enc_dec[1]
+
+=== start t8l8v unordered test_enc_dec[2]
+encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } }
+myproto_msg_enc() rc = 0
+01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff .
+myproto_msg_dec() rc = 0
+decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } }
+=== end t8l8v unordered test_enc_dec[2]
+
+=== start t8l8v unordered test_enc_dec[3]
+encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } MOO_NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } }
+myproto_msg_enc() rc = 0
+01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff 05 03 03 e9 80 05 03 03 ea 01 06 12 01 02 00 2a 02 08 66 6f 72 74 79 74 77 6f 03 02 10 92 .
+myproto_msg_dec() rc = 0
+decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } MOO_NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } }
+=== end t8l8v unordered test_enc_dec[3]
+
+=== start t8l8v unordered test_enc_dec[4]
+encoded: GOO={ FOO=17 BAR="gooei" GOO_NEST={ { VAL=0x123456789abcdef MOO_NEST={ FOO=11 BAR="eleven" BAZ={1111,true} } }, { MOO_NEST={ FOO=12 BAR="twelve" BAZ={1212,false} } } } }
+myproto_msg_enc() rc = 0
+07 01 02 00 11 02 05 67 6f 6f 65 69 08 1c 07 08 01 23 45 67 89 ab cd ef 06 10 01 02 00 0b 02 06 65 6c 65 76 65 6e 03 02 84 57 08 12 06 10 01 02 00 0c 02 06 74 77 65 6c 76 65 03 02 04 bc .
+myproto_msg_dec() rc = 0
+decoded: GOO={ FOO=17 BAR="gooei" GOO_NEST={ { VAL=0x123456789abcdef MOO_NEST={ FOO=11 BAR="eleven" BAZ={1111,true} } }, { MOO_NEST={ FOO=12 BAR="twelve" BAZ={1212,false} } } } }
+=== end t8l8v unordered test_enc_dec[4]
+
+=== start t16l16v ordered test_enc_dec[0]
+encoded: MOO={ FOO=23 BAR="twentythree" }
+myproto_msg_enc() rc = 0
+01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 .
+myproto_msg_dec() rc = 0
+decoded: MOO={ FOO=23 BAR="twentythree" }
+=== end t16l16v ordered test_enc_dec[0]
+
+=== start t16l16v ordered test_enc_dec[1]
+encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} }
+myproto_msg_enc() rc = 0
+01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 .
+myproto_msg_dec() rc = 0
+decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} }
+=== end t16l16v ordered test_enc_dec[1]
+
+=== start t16l16v ordered test_enc_dec[2]
+encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } }
+myproto_msg_enc() rc = 0
+01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff .
+myproto_msg_dec() rc = 0
+decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } }
+=== end t16l16v ordered test_enc_dec[2]
+
+=== start t16l16v ordered test_enc_dec[3]
+encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } MOO_NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } }
+myproto_msg_enc() rc = 0
+01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff 00 05 00 03 03 e9 80 00 05 00 03 03 ea 01 00 06 00 18 00 01 00 02 00 2a 00 02 00 08 66 6f 72 74 79 74 77 6f 00 03 00 02 10 92 .
+myproto_msg_dec() rc = 0
+decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } MOO_NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } }
+=== end t16l16v ordered test_enc_dec[3]
+
+=== start t16l16v ordered test_enc_dec[4]
+encoded: GOO={ FOO=17 BAR="gooei" GOO_NEST={ { VAL=0x123456789abcdef MOO_NEST={ FOO=11 BAR="eleven" BAZ={1111,true} } }, { MOO_NEST={ FOO=12 BAR="twelve" BAZ={1212,false} } } } }
+myproto_msg_enc() rc = 0
+07 00 01 00 02 00 11 00 02 00 05 67 6f 6f 65 69 00 08 00 26 00 07 00 08 01 23 45 67 89 ab cd ef 00 06 00 16 00 01 00 02 00 0b 00 02 00 06 65 6c 65 76 65 6e 00 03 00 02 84 57 00 08 00 1a 00 06 00 16 00 01 00 02 00 0c 00 02 00 06 74 77 65 6c 76 65 00 03 00 02 04 bc .
+myproto_msg_dec() rc = 0
+decoded: GOO={ FOO=17 BAR="gooei" GOO_NEST={ { VAL=0x123456789abcdef MOO_NEST={ FOO=11 BAR="eleven" BAZ={1111,true} } }, { MOO_NEST={ FOO=12 BAR="twelve" BAZ={1212,false} } } } }
+=== end t16l16v ordered test_enc_dec[4]
+
+=== start t16l16v unordered test_enc_dec[0]
+encoded: MOO={ FOO=23 BAR="twentythree" }
+myproto_msg_enc() rc = 0
+01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 .
+myproto_msg_dec() rc = 0
+decoded: MOO={ FOO=23 BAR="twentythree" }
+=== end t16l16v unordered test_enc_dec[0]
+
+=== start t16l16v unordered test_enc_dec[1]
+encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} }
+myproto_msg_enc() rc = 0
+01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 .
+myproto_msg_dec() rc = 0
+decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} }
+=== end t16l16v unordered test_enc_dec[1]
+
+=== start t16l16v unordered test_enc_dec[2]
+encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } }
+myproto_msg_enc() rc = 0
+01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff .
+myproto_msg_dec() rc = 0
+decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } }
+=== end t16l16v unordered test_enc_dec[2]
+
+=== start t16l16v unordered test_enc_dec[3]
+encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } MOO_NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } }
+myproto_msg_enc() rc = 0
+01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff 00 05 00 03 03 e9 80 00 05 00 03 03 ea 01 00 06 00 18 00 01 00 02 00 2a 00 02 00 08 66 6f 72 74 79 74 77 6f 00 03 00 02 10 92 .
+myproto_msg_dec() rc = 0
+decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } MOO_NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } }
+=== end t16l16v unordered test_enc_dec[3]
+
+=== start t16l16v unordered test_enc_dec[4]
+encoded: GOO={ FOO=17 BAR="gooei" GOO_NEST={ { VAL=0x123456789abcdef MOO_NEST={ FOO=11 BAR="eleven" BAZ={1111,true} } }, { MOO_NEST={ FOO=12 BAR="twelve" BAZ={1212,false} } } } }
+myproto_msg_enc() rc = 0
+07 00 01 00 02 00 11 00 02 00 05 67 6f 6f 65 69 00 08 00 26 00 07 00 08 01 23 45 67 89 ab cd ef 00 06 00 16 00 01 00 02 00 0b 00 02 00 06 65 6c 65 76 65 6e 00 03 00 02 84 57 00 08 00 1a 00 06 00 16 00 01 00 02 00 0c 00 02 00 06 74 77 65 6c 76 65 00 03 00 02 04 bc .
+myproto_msg_dec() rc = 0
+decoded: GOO={ FOO=17 BAR="gooei" GOO_NEST={ { VAL=0x123456789abcdef MOO_NEST={ FOO=11 BAR="eleven" BAZ={1111,true} } }, { MOO_NEST={ FOO=12 BAR="twelve" BAZ={1212,false} } } } }
+=== end t16l16v unordered test_enc_dec[4]
diff --git a/tests/testsuite.at b/tests/testsuite.at
index 3f7fcee..2df6e19 100644
--- a/tests/testsuite.at
+++ b/tests/testsuite.at
@@ -12,3 +12,9 @@
cat $abs_srcdir/libosmo-tlv/tlv_dec_enc_test.ok > expout
AT_CHECK([$abs_top_builddir/tests/libosmo-tlv/tlv_dec_enc_test], [], [expout], [ignore])
AT_CLEANUP
+
+AT_SETUP([tlv_gen])
+AT_KEYWORDS([tlv_gen])
+cat $abs_srcdir/libosmo-tlv/test_tlv_gen/tlv_gen_test.ok > expout
+AT_CHECK([$abs_top_builddir/tests/libosmo-tlv/test_tlv_gen/tlv_gen_test], [], [expout], [ignore])
+AT_CLEANUP
--
To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/27219
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-upf
Gerrit-Branch: master
Gerrit-Change-Id: Ifb3ea54d2797ce060b95834aa117725ec2d6c4cf
Gerrit-Change-Number: 27219
Gerrit-PatchSet: 1
Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de>
Gerrit-MessageType: newchange
1
0
16 Feb '22
neels has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-upf/+/27217 )
Change subject: libosmo-tlv: add versatile TLV de- and encoder
......................................................................
libosmo-tlv: add versatile TLV de- and encoder
An all new TLV parser supporting:
- Any size of T and L (determined by callback function),
- "Grouped IEs", so that an IE payload is a nested IE structure,
- optional/mandatory/multi-occurence IEs.
Will be used for PFCP message decoding and encoding, a T16L16V protocol
which requires above features.
Previously, the way we deal with TLVs causes a lot of code
re-implementation. The TL decoding is taken care of by the API, but for
encoding, we essentially re-implement the TL encoding for each protocol
and each encoded message. This API is an improvement in that we only
once implement the TL coding (or just use osmo_t8l8v_cfg /
osmo_t16l16v_cfg), get symmetric de- and encoding of the TL, and only
need to deal with the value part of each IE.
The common pattern of
- store TL preliminarily,
- write V data and
- update L after V is complete
is conveniently done by osmo_tlv_put_update_tl().
Related: SYS#5599
Change-Id: Ib0fd00d9f288ffe13b7e67701f3e47073587404a
---
M configure.ac
M include/osmocom/Makefile.am
A include/osmocom/tlv/Makefile.am
A include/osmocom/tlv/tlv.h
M src/Makefile.am
A src/libosmo-tlv/Makefile.am
A src/libosmo-tlv/tlv.c
M tests/Makefile.am
A tests/libosmo-tlv/Makefile.am
A tests/libosmo-tlv/tlv_test.c
A tests/libosmo-tlv/tlv_test.ok
M tests/testsuite.at
12 files changed, 1,260 insertions(+), 0 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/osmo-upf refs/changes/17/27217/1
diff --git a/configure.ac b/configure.ac
index 4995146..70879e9 100644
--- a/configure.ac
+++ b/configure.ac
@@ -197,11 +197,14 @@
AC_OUTPUT(
include/Makefile
include/osmocom/Makefile
+ include/osmocom/tlv/Makefile
include/osmocom/upf/Makefile
src/Makefile
+ src/libosmo-tlv/Makefile
src/osmo-upf/Makefile
tests/Makefile
tests/atlocal
+ tests/libosmo-tlv/Makefile
doc/Makefile
doc/examples/Makefile
doc/manuals/Makefile
diff --git a/include/osmocom/Makefile.am b/include/osmocom/Makefile.am
index 3f929f1..4d56df0 100644
--- a/include/osmocom/Makefile.am
+++ b/include/osmocom/Makefile.am
@@ -1,3 +1,4 @@
SUBDIRS = \
+ tlv \
upf \
$(NULL)
diff --git a/include/osmocom/tlv/Makefile.am b/include/osmocom/tlv/Makefile.am
new file mode 100644
index 0000000..f819a41
--- /dev/null
+++ b/include/osmocom/tlv/Makefile.am
@@ -0,0 +1,5 @@
+tlv_HEADERS = \
+ tlv.h \
+ $(NULL)
+
+tlvdir = $(includedir)/osmocom/tlv
diff --git a/include/osmocom/tlv/tlv.h b/include/osmocom/tlv/tlv.h
new file mode 100644
index 0000000..404bbba
--- /dev/null
+++ b/include/osmocom/tlv/tlv.h
@@ -0,0 +1,139 @@
+/*
+ * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de>
+ * All Rights Reserved.
+ *
+ * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de>
+ *
+ * SPDX-License-Identifier: GPL-2.0+
+ *
+ * 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+#pragma once
+
+#include <stdint.h>
+#include <stdio.h>
+
+struct msgb;
+struct osmo_tlv_load;
+struct osmo_tlv_put;
+
+/*! TL configuration for osmo_tlv_load*() and osmo_tlv_put*(). Depending on these implementations provided by the caller,
+ * osmo_tlv can load any sizes of tag and length fields (that don't surpass the value range of unsigned int and size_t,
+ * respectively), as well as TV (fixed-length) or TvLV (variable-sized length).
+ *
+ * See osmo_t8l8v_cfg and osmo_t16l16v_cfg, ready implementations for plain 8bit and 16bit TLV protocols.
+ *
+ * libosmo-pfcp serves as example for using this entire TLV API, uncluding de/encoding to structs and generating parts
+ * of the TLV parsing code based on message definitions. It uses osmo_t16l16v_cfg.
+ */
+struct osmo_tlv_cfg {
+ /*! The length in bytes of the shortest possible TL header (e.g. 4 for T16L16V, or 1 for 8bit tags where TV IEs
+ * without a length exist). A src_data_len passed to store_tl() below is guaranteed to be >= this value. If at
+ * any point there is remaining message data smaller than this value, a parsing error is returned.
+ */
+ size_t tl_min_size;
+
+ /*! Read one TL from the start of src_data.
+ * \param tag Return the T value read from src_data in *tag.
+ * \param len Return the L value read from src_data in *len.
+ * \param val Return the position just after the TL in *val. If there is V data, point at the start of the V
+ * data in src_data. If there is no V data, point at the byte just after the TL part in src_data.
+ * \param src_data Part of raw message being decoded.
+ * \param src_data_len Remaining message data length at src_data.
+ * \param tlv Backpointer to the osmo_tlv_load struct.
+ * \return 0 on success, negative on error.
+ */
+ int (*load_tl)(unsigned int *tag, size_t *len, const uint8_t **val,
+ const uint8_t *src_data, size_t src_data_len, struct osmo_tlv_load *tlv);
+
+ /*! Write a TL to dst_data, and return the size of the TL written.
+ * This is also invoked by osmo_tlv_put_update_tl() to overwrite a previous TL header. If the TL part's size
+ * can be different than the first time (e.g. due to a large L value in a TvLV protocol), an implementation can
+ * use the 'tlv' arg to figure out how to memmove the message data:
+ * When invoked by osmo_tlv_put_tl(), dst_data == tlv->dst->tail and dst_data_avail == msgb_tailroom().
+ * When invoked by osmo_tlv_put_update_tl(), dst_data < tlv->dst->tail, dst_data points at the start of the
+ * TL section written earlier by osmo_tlv_put_tl() and dst_data_avail == the size of the TL written earlier.
+ *
+ * \param dst_data Write TL data to the start of this buffer.
+ * \param dst_data_avail Remaining available space in dst_data.
+ * \param tag The T value to store in dst_data.
+ * \param len The L value to store in dst_data.
+ * \param tlv Backpointer to the osmo_tlv_put struct, including tlv->dst, the underlying msgb.
+ * \return the size of the TL part in bytes on success, -EINVAL if tag is invalid, -EMSGSIZE if len is too large
+ * or dst_data_avail is too small for the TL.
+ */
+ int (*store_tl)(uint8_t *dst_data, size_t dst_data_avail, unsigned int tag, size_t len, struct osmo_tlv_put *tlv);
+};
+
+/*! Configuration that allows parsing an 8bit tag and 8bit length TLV. */
+extern const struct osmo_tlv_cfg osmo_t8l8v_cfg;
+
+/*! Configuration that allows parsing a 16bit tag and 16bit length TLV (see for example PFCP). */
+extern const struct osmo_tlv_cfg osmo_t16l16v_cfg;
+
+/*! State for loading a TLV structure from raw data. */
+struct osmo_tlv_load {
+ /*! Caller-defined context pointer available for use by load_tl() and store_tl() implementations. */
+ void *priv;
+
+ /*! Definition of tag and length sizes (by function pointers). */
+ const struct osmo_tlv_cfg *cfg;
+
+ /*! Overall message buffer being parsed. */
+ struct {
+ const uint8_t *data;
+ size_t len;
+ } src;
+
+ /*! Return value from last invocation of osmo_tlv_load_next*(): tag value of parsed IE. */
+ unsigned int tag;
+ /*! Return value from last invocation of osmo_tlv_load_next*(): Start of the IE's payload data (after tag and
+ * length). If the end of the src buffer is reached, val == NULL. If a TLV contained no value part, len == 0,
+ * but this still points just after the TL. */
+ const uint8_t *val;
+ /*! Return value from last invocation of osmo_tlv_load_next*(): Length of the IE's payload data (without tag and
+ * length) */
+ size_t len;
+};
+
+/* Start or restart the tlv from the first IE in the overall TLV data. */
+static inline void osmo_tlv_load_start(struct osmo_tlv_load *tlv)
+{
+ tlv->val = NULL;
+}
+
+int osmo_tlv_load_next(struct osmo_tlv_load *tlv);
+int osmo_tlv_load_peek_tag(const struct osmo_tlv_load *tlv);
+int osmo_tlv_load_next_by_tag(struct osmo_tlv_load *tlv, unsigned int tag);
+
+/* State for storing a TLV structure into a msgb. */
+struct osmo_tlv_put {
+ /*! Caller-defined context pointer available for use by load_tl() and store_tl() implementations. */
+ void *priv;
+
+ /* Definition of tag and length sizes (by function pointers). */
+ const struct osmo_tlv_cfg *cfg;
+
+ /* msgb to append new TL to */
+ struct msgb *dst;
+ /* Where was the last TL head written */
+ unsigned int last_tag;
+ uint8_t *last_tl;
+ uint8_t *last_val;
+};
+
+int osmo_tlv_put_tl(struct osmo_tlv_put *tlv, unsigned int tag, size_t len);
+int osmo_tlv_put_update_tl(struct osmo_tlv_put *tlv);
diff --git a/src/Makefile.am b/src/Makefile.am
index a8ba763..0e44dcc 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -1,3 +1,4 @@
SUBDIRS = \
+ libosmo-tlv \
osmo-upf \
$(NULL)
diff --git a/src/libosmo-tlv/Makefile.am b/src/libosmo-tlv/Makefile.am
new file mode 100644
index 0000000..0f848d3
--- /dev/null
+++ b/src/libosmo-tlv/Makefile.am
@@ -0,0 +1,25 @@
+AM_CPPFLAGS = \
+ $(all_includes) \
+ -I$(top_srcdir)/include \
+ -I$(top_builddir) \
+ -I$(builddir) \
+ $(NULL)
+
+AM_CFLAGS = \
+ -Wall \
+ $(LIBOSMOCORE_CFLAGS) \
+ $(COVERAGE_CFLAGS) \
+ $(NULL)
+
+AM_LDFLAGS = \
+ $(LIBOSMOCORE_LIBS) \
+ $(COVERAGE_LDFLAGS) \
+ $(NULL)
+
+noinst_LIBRARIES = \
+ libosmo-tlv.a \
+ $(NULL)
+
+libosmo_tlv_a_SOURCES = \
+ tlv.c \
+ $(NULL)
diff --git a/src/libosmo-tlv/tlv.c b/src/libosmo-tlv/tlv.c
new file mode 100644
index 0000000..3426597
--- /dev/null
+++ b/src/libosmo-tlv/tlv.c
@@ -0,0 +1,284 @@
+/*
+ * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de>
+ * All Rights Reserved.
+ *
+ * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de>
+ *
+ * SPDX-License-Identifier: GPL-2.0+
+ *
+ * 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+#include <errno.h>
+
+#include <osmocom/core/bits.h>
+#include <osmocom/core/msgb.h>
+#include <osmocom/tlv/tlv.h>
+
+static int next_tl_valid(const struct osmo_tlv_load *tlv, const uint8_t **ie_start_p, size_t *buflen_left_p)
+{
+ const uint8_t *ie_start;
+ size_t buflen_left;
+
+ /* Start of next IE, or first IE for first invocation. */
+ if (!tlv->val)
+ ie_start = tlv->src.data;
+ else
+ ie_start = tlv->val + tlv->len;
+
+ /* Sanity */
+ if (ie_start < tlv->src.data || ie_start > tlv->src.data + tlv->src.len)
+ return -ENOSPC;
+
+ buflen_left = tlv->src.len - (ie_start - tlv->src.data);
+
+ /* Too short for parsing an IE? Check also against integer overflow. */
+ if (buflen_left && ((buflen_left < tlv->cfg->tl_min_size) || (buflen_left > tlv->src.len)))
+ return -EBADMSG;
+
+ *ie_start_p = ie_start;
+ *buflen_left_p = buflen_left;
+ return 0;
+}
+
+/* Return a TLV IE from a message buffer.
+ *
+ * Return the first or next TLV data found in the data buffer, based on the state of the tlv parameter.
+ * When tlv->val is NULL, return the first IE in the data buffer.
+ * Otherwise assume that tlv points at a valid IE in the data structure, and return the subsequent IE.
+ *
+ * Usage example:
+ *
+ * struct osmo_tlv tlv = {
+ * .cfg = osmo_t16l16v_cfg,
+ * .src = { .data = msgb_l3(msg), .len = msgb_l3len(msg) },
+ * };
+ * for (;;) {
+ * if (osmo_tlv_next(&tlv)) {
+ * printf("Error\n");
+ * break;
+ * }
+ * if (!tlv.val) {
+ * printf("End\n");
+ * break;
+ * }
+ * printf("Tag %u: %zu octets: %s\n", tlv.tag, tlv.len, osmo_hexdump(tlv.val, tlv.len));
+ * }
+ *
+ * \param[inout] tlv Buffer to return the IE data, and state for TLV parsing position. tlv->msg should indicate the
+ * overall message buffer. The other tlv members should be zero initialized before the first call, and
+ * remain unchanged between invocations of this function.
+ * \returns 0 on success, negative on TLV parsing error. The IE data is returned in tlv->tag, tlv->len and tlv->val;
+ * tlv->val == NULL if no more IEs remain in the buffer.
+ */
+int osmo_tlv_load_next(struct osmo_tlv_load *tlv)
+{
+ const uint8_t *ie_start;
+ const uint8_t *ie_end;
+ size_t buflen_left;
+ int rc;
+
+ rc = next_tl_valid(tlv, &ie_start, &buflen_left);
+ if (rc)
+ return rc;
+
+ /* No more IEs? */
+ if (!buflen_left) {
+ tlv->val = NULL;
+ return 0;
+ }
+
+ /* Locate next IE */
+ OSMO_ASSERT(tlv->cfg->load_tl);
+ rc = tlv->cfg->load_tl(&tlv->tag, &tlv->len, &tlv->val, ie_start, buflen_left, tlv);
+ if (rc)
+ return rc;
+
+ /* Sanity */
+ ie_end = tlv->val + tlv->len;
+ if (ie_end < tlv->src.data || ie_end > tlv->src.data + tlv->src.len)
+ return -EBADMSG;
+
+ return 0;
+}
+
+/* Return the tag of the IE that osmo_tlv_next() would yield, do not change the tlv state.
+ *
+ * \param[inout] tlv state for TLV parsing position.
+ * \returns the tag number on success, negative on TLV parsing error, -ENOENT when no more tags
+ * follow.
+ */
+int osmo_tlv_load_peek_tag(const struct osmo_tlv_load *tlv)
+{
+ const uint8_t *ie_start;
+ size_t buflen_left;
+ int rc;
+ unsigned int tag;
+ size_t len;
+ const uint8_t *val;
+ /* Guard against modification by load_tl(). */
+ struct osmo_tlv_load mtlv = *tlv;
+
+ rc = next_tl_valid(&mtlv, &ie_start, &buflen_left);
+ if (rc)
+ return rc;
+
+ if (!buflen_left)
+ return -ENOENT;
+
+ /* Return next IE tag*/
+ OSMO_ASSERT(mtlv.cfg->load_tl);
+ rc = tlv->cfg->load_tl(&tag, &len, &val, ie_start, buflen_left, &mtlv);
+ if (rc)
+ return -EBADMSG;
+ return tag;
+}
+
+/* Same as osmo_tlv_next(), but skip any IEs until the given tag is reached. Change the tlv state only when
+ * success is returned.
+ * \return 0 when the tag is found. Return -ENOENT when no such tag follows and keep the tlv unchanged. */
+int osmo_tlv_load_next_by_tag(struct osmo_tlv_load *tlv, unsigned int tag)
+{
+ struct osmo_tlv_load work = *tlv;
+ for (;;) {
+ int rc = osmo_tlv_load_next(&work);
+ if (rc)
+ return rc;
+ if (!work.val)
+ return -ENOENT;
+ if (work.tag == tag) {
+ *tlv = work;
+ return 0;
+ }
+ }
+}
+
+/* Put tag header and length at the end of the msgb.
+ * If the length is not known yet, it can be passed as 0 at first, and osmo_tlv_put_update_tl() can determine the
+ * resulting length after the value part was put into the msgb.
+ *
+ * Usage example:
+ *
+ * struct msgb *msg = msgb_alloc(1024, "foo"),
+ * struct osmo_tlv_put tlv = {
+ * .cfg = osmo_t16l16v_cfg,
+ * .dst = msg,
+ * }
+ *
+ * osmo_tlv_put_tl(tlv, 23, 0); // tag 23, length 0 = not known yet
+ *
+ * msgb_put(msg, 42);
+ * ...
+ * msgb_put(msg, 42);
+ * ...
+ * msgb_put(msg, 42);
+ *
+ * osmo_tlv_put_update_tl(tlv);
+ *
+ * Return 0 on success, -EINVAL if the tag value is invalid, -EMSGSIZE if len is too large.
+ */
+int osmo_tlv_put_tl(struct osmo_tlv_put *tlv, unsigned int tag, size_t len)
+{
+ int rc;
+ uint8_t *last_tl;
+ OSMO_ASSERT(tlv->cfg->store_tl);
+ last_tl = tlv->dst->tail;
+ rc = tlv->cfg->store_tl(tlv->dst->tail, msgb_tailroom(tlv->dst), tag, len, tlv);
+ if (rc < 0)
+ return rc;
+ if (rc > 0)
+ msgb_put(tlv->dst, rc);
+ tlv->last_tag = tag;
+ tlv->last_tl = last_tl;
+ tlv->last_val = tlv->dst->tail;
+ return 0;
+}
+
+/* Update the length of the last put IE header (last call to osmo_tlv_put_tl()) to match with the current
+ * tlv->dst->tail.
+ * Return 0 on success, -EMSGSIZE if the amount of data written since osmo_tlv_put_tl() is too large.
+ */
+int osmo_tlv_put_update_tl(struct osmo_tlv_put *tlv)
+{
+ size_t len = tlv->dst->tail - tlv->last_val;
+ int rc = tlv->cfg->store_tl(tlv->last_tl, tlv->last_val - tlv->last_tl, tlv->last_tag, len, tlv);
+ if (rc < 0)
+ return rc;
+ /* In case the TL has changed in size, hopefully the implementation has moved the msgb data. Make sure last_val
+ * points at the right place now. */
+ tlv->last_val = tlv->last_tl + rc;
+ return 0;
+}
+
+static int t8l8v_load_tl(unsigned int *tag, size_t *len, const uint8_t **val,
+ const uint8_t *src_data, size_t src_data_len, struct osmo_tlv_load *tlv)
+{
+ /* already validated in next_tl_valid(): src_data_len >= cfg->tl_min_size == 2. */
+ *tag = src_data[0];
+ *len = src_data[1];
+ *val = src_data + 2;
+ return 0;
+}
+
+static int t8l8v_store_tl(uint8_t *dst_data, size_t dst_data_avail, unsigned int tag, size_t len,
+ struct osmo_tlv_put *tlv)
+{
+ if (tag > UINT8_MAX)
+ return -EINVAL;
+ if (len > UINT8_MAX)
+ return -EMSGSIZE;
+ if (dst_data_avail < 2)
+ return -ENOSPC;
+ dst_data[0] = tag;
+ dst_data[1] = len;
+ return 2;
+}
+
+const struct osmo_tlv_cfg osmo_t8l8v_cfg = {
+ .tl_min_size = 2,
+ .load_tl = t8l8v_load_tl,
+ .store_tl = t8l8v_store_tl,
+};
+
+static int t16l16v_load_tl(unsigned int *tag, size_t *len, const uint8_t **val,
+ const uint8_t *src_data, size_t src_data_len, struct osmo_tlv_load *tlv)
+{
+ /* already validated in next_tl_valid(): src_data_len >= cfg->tl_min_size == 4. */
+ *tag = osmo_load16be(src_data);
+ *len = osmo_load16be(src_data + 2);
+ *val = src_data + 4;
+ return 0;
+}
+
+static int t16l16v_store_tl(uint8_t *dst_data, size_t dst_data_avail, unsigned int tag, size_t len,
+ struct osmo_tlv_put *tlv)
+{
+ if (tag > UINT16_MAX)
+ return -EINVAL;
+ if (len > UINT16_MAX)
+ return -EMSGSIZE;
+ if (dst_data_avail < 4)
+ return -ENOSPC;
+ osmo_store16be(tag, dst_data);
+ osmo_store16be(len, dst_data + 2);
+ return 4;
+}
+
+const struct osmo_tlv_cfg osmo_t16l16v_cfg = {
+ .tl_min_size = 4,
+ .load_tl = t16l16v_load_tl,
+ .store_tl = t16l16v_store_tl,
+};
diff --git a/tests/Makefile.am b/tests/Makefile.am
index 6d14cc0..fb1680e 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -1,4 +1,5 @@
SUBDIRS = \
+ libosmo-tlv \
$(NULL)
# The `:;' works around a Bash 3.2 bug when the output is not writeable.
diff --git a/tests/libosmo-tlv/Makefile.am b/tests/libosmo-tlv/Makefile.am
new file mode 100644
index 0000000..250dc5e
--- /dev/null
+++ b/tests/libosmo-tlv/Makefile.am
@@ -0,0 +1,30 @@
+AM_CPPFLAGS = \
+ $(all_includes) \
+ -I$(top_srcdir)/include \
+ $(NULL)
+
+AM_CFLAGS = \
+ -Wall \
+ $(LIBOSMOCORE_CFLAGS) \
+ $(NULL)
+
+noinst_PROGRAMS = \
+ tlv_test \
+ $(NULL)
+
+EXTRA_DIST = \
+ tlv_test.ok \
+ $(NULL)
+
+tlv_test_SOURCES = \
+ tlv_test.c \
+ $(NULL)
+
+tlv_test_LDADD = \
+ $(top_builddir)/src/libosmo-tlv/libosmo-tlv.a \
+ $(LIBOSMOCORE_LIBS) \
+ $(NULL)
+
+.PHONY: update_exp
+update_exp:
+ $(builddir)/tlv_test >$(srcdir)/tlv_test.ok
diff --git a/tests/libosmo-tlv/tlv_test.c b/tests/libosmo-tlv/tlv_test.c
new file mode 100644
index 0000000..ed3c12b
--- /dev/null
+++ b/tests/libosmo-tlv/tlv_test.c
@@ -0,0 +1,509 @@
+/* (C) 2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de>
+ * All Rights Reserved
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation; either version 3 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 Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include <stdio.h>
+#include <errno.h>
+
+#include <osmocom/core/application.h>
+#include <osmocom/core/utils.h>
+#include <osmocom/core/msgb.h>
+
+#include <osmocom/tlv/tlv.h>
+
+void *ctx;
+
+struct ie {
+ int tag;
+ const char *val;
+};
+
+/* write all IEs to a msgb */
+struct msgb *test_tlv_enc(const struct osmo_tlv_cfg *cfg, const struct ie *ies)
+{
+ const struct ie *ie;
+ struct osmo_tlv_put tlv = {
+ .cfg = cfg,
+ .dst = msgb_alloc(1024, __func__),
+ };
+
+ for (ie = ies; ie->val; ie++) {
+ /* put header without knowing length yet */
+ OSMO_ASSERT( osmo_tlv_put_tl(&tlv, ie->tag, 0) == 0);
+ /* put value data, as much as desired */
+ msgb_put(tlv.dst, osmo_hexparse(ie->val, tlv.dst->tail, msgb_tailroom(tlv.dst)));
+ /* update header len from amount of written data */
+ OSMO_ASSERT( osmo_tlv_put_update_tl(&tlv) == 0);
+ }
+
+ printf("- encoded: %s.\n", osmo_hexdump(tlv.dst->data, tlv.dst->len));
+ return tlv.dst;
+}
+
+/* read all IEs from the msgb, and verify that it matches the given list of IEs */
+void test_tlv_dec(const struct osmo_tlv_cfg *cfg, const struct ie *ies, struct msgb *msg)
+{
+ const struct ie *ie;
+ struct osmo_tlv_load tlv = {
+ .cfg = cfg,
+ .src = { msg->data, msg->len },
+ };
+
+ printf("- decoding:\n");
+ osmo_tlv_load_start(&tlv);
+
+ for (ie = ies; ie->val; ie++) {
+ int rc = osmo_tlv_load_next(&tlv);
+ if (rc) {
+ printf(" ERROR loading TLV structure: osmo_tlv_load_next() rc = %d\n", rc);
+ exit(1);
+ }
+ /* end of TLV structure? */
+ if (!tlv.val)
+ break;
+ printf(" T=%d L=%zu v=%s\n", tlv.tag, tlv.len, osmo_hexdump_nospc(tlv.val, tlv.len));
+ if (tlv.tag != ie->tag) {
+ printf(" ERROR loading TLV structure: expected tag %d, got tag %d\n", ie->tag, tlv.tag);
+ exit(1);
+ }
+ if (strcmp(ie->val, osmo_hexdump_nospc(tlv.val, tlv.len))) {
+ printf(" ERROR loading TLV structure: expected val %s, got val %s\n", ie->val,
+ osmo_hexdump_nospc(tlv.val, tlv.len));
+ exit(1);
+ }
+ }
+}
+
+void test_tlv_peek(const struct osmo_tlv_cfg *cfg, const struct ie *ies, struct msgb *msg)
+{
+ const struct ie *ie;
+ struct osmo_tlv_load tlv = {
+ .cfg = cfg,
+ .src = { msg->data, msg->len },
+ };
+
+ printf("- peeking:\n");
+ osmo_tlv_load_start(&tlv);
+
+ ie = ies;
+ while (1) {
+ int rc;
+ int next_tag = osmo_tlv_load_peek_tag(&tlv);
+ if (next_tag == -ENOENT)
+ printf(" peek T=-ENOENT\n");
+ else
+ printf(" peek T=%d\n", next_tag);
+
+ if (ie->val && next_tag != ie->tag) {
+ printf(" ERROR peeking tag: expected tag %d, got tag %d\n", ie->tag, next_tag);
+ exit(1);
+ }
+ if (!ie->val && next_tag != -ENOENT) {
+ printf(" ERROR peeking tag: expected -ENOENT, got tag %d\n", next_tag);
+ exit(1);
+ }
+
+ if (next_tag == -ENOENT)
+ break;
+
+ /* go to the next TLV */
+ rc = osmo_tlv_load_next(&tlv);
+ if (rc) {
+ printf(" ERROR loading TLV structure: osmo_tlv_load_next() rc = %d\n", rc);
+ exit(1);
+ }
+ if (ie->val)
+ ie++;
+ }
+}
+
+/* Decode TLV in random order, each time searching for a tag in the raw data */
+void test_tlv_dec_by_tag(const struct osmo_tlv_cfg *cfg, const struct ie *ies, struct msgb *msg)
+{
+ const struct ie *last_ie;
+ const struct ie *ie;
+ int rc;
+ struct osmo_tlv_load tlv = {
+ .cfg = cfg,
+ .src = { msg->data, msg->len },
+ };
+
+ printf("- decoding in reverse order:\n");
+
+ last_ie = ies;
+ while (last_ie->val) last_ie++;
+ last_ie--;
+
+ for (ie = last_ie; ie >= ies; ie--) {
+ /* each time, look from the beginning */
+ osmo_tlv_load_start(&tlv);
+ rc = osmo_tlv_load_next_by_tag(&tlv, ie->tag);
+ if (rc) {
+ printf(" ERROR loading TLV structure: osmo_tlv_load_next_by_tag(%d) rc = %d\n", ie->tag, rc);
+ exit(1);
+ }
+ if (!tlv.val) {
+ printf(" ERROR loading TLV structure: osmo_tlv_load_next_by_tag(%d) returned NULL val\n",
+ ie->tag);
+ exit(1);
+ }
+ if (tlv.tag != ie->tag) {
+ printf(" ERROR loading TLV structure: expected tag %d, got tag %d\n", ie->tag, tlv.tag);
+ exit(1);
+ }
+ if (strcmp(ie->val, osmo_hexdump_nospc(tlv.val, tlv.len))) {
+ while (1) {
+ printf(" (mismatch: T=%d L=%zu v=%s, checking for another occurence of T=%d)\n",
+ tlv.tag, tlv.len, osmo_hexdump_nospc(tlv.val, tlv.len), tlv.tag);
+ rc = osmo_tlv_load_next_by_tag(&tlv, ie->tag);
+ if (rc || !tlv.val) {
+ printf(" ERROR val not found\n");
+ exit(1);
+ }
+ if (strcmp(ie->val, osmo_hexdump_nospc(tlv.val, tlv.len)) == 0) {
+ break;
+ }
+ }
+ }
+ printf(" T=%d L=%zu v=%s\n", tlv.tag, tlv.len, osmo_hexdump_nospc(tlv.val, tlv.len));
+ }
+
+ printf("- decoding every second tag:\n");
+
+ osmo_tlv_load_start(&tlv);
+ for (ie = ies; ie->val; ie++) {
+ /* skip one tag */
+ ie++;
+ if (!ie->val)
+ break;
+
+ rc = osmo_tlv_load_next_by_tag(&tlv, ie->tag);
+ if (rc) {
+ printf(" ERROR loading TLV structure: osmo_tlv_load_next_by_tag(%d) rc = %d\n", ie->tag, rc);
+ exit(1);
+ }
+ if (!tlv.val) {
+ printf(" ERROR loading TLV structure: osmo_tlv_load_next_by_tag(%d) returned NULL val\n",
+ ie->tag);
+ exit(1);
+ }
+ if (tlv.tag != ie->tag) {
+ printf(" ERROR loading TLV structure: expected tag %d, got tag %d\n", ie->tag, tlv.tag);
+ exit(1);
+ }
+ if (strcmp(ie->val, osmo_hexdump_nospc(tlv.val, tlv.len))) {
+ while (1) {
+ printf(" (mismatch: T=%d L=%zu v=%s, checking for another occurence of T=%d)\n",
+ tlv.tag, tlv.len, osmo_hexdump_nospc(tlv.val, tlv.len), tlv.tag);
+ rc = osmo_tlv_load_next_by_tag(&tlv, ie->tag);
+ if (rc || !tlv.val) {
+ printf(" ERROR val not found\n");
+ exit(1);
+ }
+ if (strcmp(ie->val, osmo_hexdump_nospc(tlv.val, tlv.len)) == 0) {
+ break;
+ }
+ }
+ }
+ printf(" T=%d L=%zu v=%s\n", tlv.tag, tlv.len, osmo_hexdump_nospc(tlv.val, tlv.len));
+ }
+
+ printf("- enforcing order: without restart, a past tag is not parsed again:\n");
+ /* Try to read the first tag, expect that it isn't found because we're already halfway in the message data */
+ ie = ies;
+ rc = osmo_tlv_load_next_by_tag(&tlv, ie->tag);
+ printf(" osmo_tlv_load_next_by_tag(%d) rc=", ie->tag);
+ if (rc == -ENOENT) {
+ printf("-ENOENT\n");
+ } else {
+ printf("%d\n", rc);
+ printf(" ERROR: expected -ENOENT\n");
+ exit(1);
+ }
+}
+
+void test_tlv(const char *label, struct ie *tests[], size_t tests_len, const struct osmo_tlv_cfg *cfg)
+{
+ int i;
+ for (i = 0; i < tests_len; i++) {
+ const struct ie *ies = tests[i];
+ struct msgb *msg;
+ printf("\n=== start: %s[%d]\n", label, i);
+
+ msg = test_tlv_enc(cfg, ies);
+ test_tlv_dec(cfg, ies, msg);
+ test_tlv_peek(cfg, ies, msg);
+ test_tlv_dec_by_tag(cfg, ies, msg);
+
+ msgb_free(msg);
+
+ printf("=== end: %s[%d]\n", label, i);
+ }
+}
+
+struct ie t8l8v_test1[] = {
+ /* smallest T */
+ { 0, "2342" },
+ /* largest T */
+ { 255, "2342" },
+
+ /* smallest V (no V data) */
+ { 1, "" },
+ /* largest V, 255 bytes is the largest that an 8bit size length can express. */
+ { 123, "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
+ "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
+ "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
+ "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
+ "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
+ "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
+ "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
+ "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
+ },
+
+ /* arbitrary test data */
+ { 101, "11" },
+ { 102, "2222" },
+ { 103, "333333" },
+ {}
+};
+
+struct ie t8l8v_test_multi[] = {
+ { 42, "42" },
+ { 2, "0101" },
+ { 2, "2222" },
+ { 3, "11" },
+ { 3, "2222" },
+ { 3, "333333" },
+ { 23, "23" },
+ { 42, "666f72747974776f" },
+ { 23, "7477656e74797468726565" },
+ {}
+};
+
+struct ie *t8l8v_tests[] = {
+ t8l8v_test1,
+ t8l8v_test_multi,
+};
+
+void test_t8l8v()
+{
+ test_tlv("t8l8v_tests", t8l8v_tests, ARRAY_SIZE(t8l8v_tests), &osmo_t8l8v_cfg);
+}
+
+struct ie t16l16v_test1[] = {
+ /* smallest T */
+ { 0, "2342" },
+ /* largest T */
+ { 65535, "2342" },
+
+ /* smallest V (no V data) */
+ { 1, "" },
+ /* 256 bytes is one more than an 8bit size length can express. */
+ { 123, "0000000000000000000000000000000000000000000000000000000000000000"
+ "0000000000000000000000000000000000000000000000000000000000000000"
+ "0000000000000000000000000000000000000000000000000000000000000000"
+ "0000000000000000000000000000000000000000000000000000000000000000"
+ "0000000000000000000000000000000000000000000000000000000000000000"
+ "0000000000000000000000000000000000000000000000000000000000000000"
+ "0000000000000000000000000000000000000000000000000000000000000000"
+ "0000000000000000000000000000000000000000000000000000000000000000"
+ },
+
+ /* arbitrary test data */
+ { 1001, "11" },
+ { 1002, "2222" },
+ { 1003, "333333" },
+ {}
+};
+
+struct ie t16l16v_test_multi[] = {
+ { 1042, "42" },
+ { 102, "0101" },
+ { 102, "2222" },
+ { 103, "11" },
+ { 103, "2222" },
+ { 103, "333333" },
+ { 1023, "23" },
+ { 1042, "666f72747974776f" },
+ { 1023, "7477656e74797468726565" },
+ {}
+};
+
+struct ie *t16l16v_tests[] = {
+ t16l16v_test1,
+ t16l16v_test_multi,
+};
+
+void test_t16l16v()
+{
+ test_tlv("t16l16v_tests", t16l16v_tests, ARRAY_SIZE(t16l16v_tests), &osmo_t16l16v_cfg);
+}
+
+struct ie txlxv_test1[] = {
+ /* smallest T */
+ { 0, "2342" },
+ /* largest T that still fits in one encoded octet (highest bit serves as flag) */
+ { 0x7f, "2342" },
+ /* smallest T that needs two octets to be encoded (first octet = 0x80 flag + 0, second octet = 0x1) */
+ { 0x80, "2342" },
+ /* largest T that can be encoded in 16bit - one flag bit. */
+ { 0x7fff, "2342" },
+
+ /* smallest V (no V data) */
+ { 1, "" },
+ /* 256 bytes is one more than an 8bit size length can express. */
+ { 123, "0000000000000000000000000000000000000000000000000000000000000000"
+ "0000000000000000000000000000000000000000000000000000000000000000"
+ "0000000000000000000000000000000000000000000000000000000000000000"
+ "0000000000000000000000000000000000000000000000000000000000000000"
+ "0000000000000000000000000000000000000000000000000000000000000000"
+ "0000000000000000000000000000000000000000000000000000000000000000"
+ "0000000000000000000000000000000000000000000000000000000000000000"
+ "0000000000000000000000000000000000000000000000000000000000000000"
+ },
+
+ /* arbitrary test data */
+ { 1002, "2222" },
+ { 1003, "333333" },
+ {}
+};
+
+struct ie txlxv_test_multi[] = {
+ { 1042, "42" },
+ { 1002, "0101" },
+ { 1002, "2222" },
+ { 103, "11" },
+ { 103, "2222" },
+ { 103, "333333" },
+ { 1023, "23" },
+ { 1042, "666f72747974776f" },
+ { 1023, "7477656e74797468726565" },
+ {}
+};
+
+struct ie *txlxv_tests[] = {
+ txlxv_test1,
+ txlxv_test_multi,
+};
+
+/* Example of defining a variable TL, where size of T and L depend on the actual tag and length values: load. */
+int txlxv_load_tl(unsigned int *tag, size_t *len, const uint8_t **val, const uint8_t *src_data, size_t src_data_len,
+ struct osmo_tlv_load *tlv)
+{
+ const uint8_t *pos = src_data;
+ const uint8_t *end = src_data + src_data_len;
+ if (pos[0] & 0x80) {
+ if (pos + 2 > end)
+ return -EINVAL;
+ *tag = (((int)pos[1]) << 7) + (pos[0] & 0x7f);
+ pos += 2;
+ } else {
+ *tag = pos[0];
+ pos++;
+ }
+
+ switch (*tag) {
+ case 1002:
+ /* fixed-length IE */
+ *len = 2;
+ break;
+ case 123:
+ /* 16bit length IE */
+ if (pos + 2 > end)
+ return -EINVAL;
+ *len = osmo_load16be(pos);
+ pos += 2;
+ break;
+ default:
+ /* 8bit length IE */
+ if (pos + 1 > end)
+ return -EINVAL;
+ *len = *pos;
+ pos++;
+ break;
+ }
+ *val = pos;
+ return 0;
+}
+
+/* Example of defining a variable TL, where size of T and L depend on the actual tag and length values: store. */
+int txlxv_store_tl(uint8_t *dst_data, size_t dst_data_avail, unsigned int tag, size_t len, struct osmo_tlv_put *tlv)
+{
+ uint8_t *pos = dst_data;
+ uint8_t *end = dst_data + dst_data_avail;
+ if (tag < 0x80) {
+ if (pos + 1 > end)
+ return -ENOSPC;
+ pos[0] = tag;
+ pos++;
+ } else {
+ if (pos + 2 > end)
+ return -ENOSPC;
+ pos[0] = 0x80 + (tag & 0x7f);
+ pos[1] = tag >> 7;
+ pos += 2;
+ }
+
+ switch (tag) {
+ case 1002:
+ /* fixed-length IE, write no len */
+ break;
+ case 123:
+ /* 16bit length IE */
+ if (len > UINT16_MAX)
+ return -ERANGE;
+ if (pos + 2 > end)
+ return -ENOSPC;
+ osmo_store16be(len, pos);
+ pos += 2;
+ break;
+ default:
+ /* 8bit length IE */
+ if (len > UINT8_MAX)
+ return -ERANGE;
+ if (pos + 1 > end)
+ return -ENOSPC;
+ pos[0] = len;
+ pos++;
+ break;
+ }
+ return pos - dst_data;
+}
+
+const struct osmo_tlv_cfg txlxv_cfg = {
+ .tl_min_size = 1,
+ .load_tl = txlxv_load_tl,
+ .store_tl = txlxv_store_tl,
+};
+
+void test_txlxv()
+{
+ test_tlv("txlxv_tests", txlxv_tests, ARRAY_SIZE(txlxv_tests), &txlxv_cfg);
+}
+
+int main()
+{
+ ctx = talloc_named_const(NULL, 0, "tlv_test");
+ msgb_talloc_ctx_init(ctx, 0);
+
+ test_t8l8v();
+ test_t16l16v();
+ test_txlxv();
+
+ talloc_free(ctx);
+ return 0;
+}
diff --git a/tests/libosmo-tlv/tlv_test.ok b/tests/libosmo-tlv/tlv_test.ok
new file mode 100644
index 0000000..6ad7e7a
--- /dev/null
+++ b/tests/libosmo-tlv/tlv_test.ok
@@ -0,0 +1,256 @@
+
+=== start: t8l8v_tests[0]
+- encoded: 00 02 23 42 ff 02 23 42 01 00 7b ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff 65 01 11 66 02 22 22 67 03 33 33 33 .
+- decoding:
+ T=0 L=2 v=2342
+ T=255 L=2 v=2342
+ T=1 L=0 v=
+ T=123 L=255 v=ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
+ T=101 L=1 v=11
+ T=102 L=2 v=2222
+ T=103 L=3 v=333333
+- peeking:
+ peek T=0
+ peek T=255
+ peek T=1
+ peek T=123
+ peek T=101
+ peek T=102
+ peek T=103
+ peek T=-ENOENT
+- decoding in reverse order:
+ T=103 L=3 v=333333
+ T=102 L=2 v=2222
+ T=101 L=1 v=11
+ T=123 L=255 v=ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
+ T=1 L=0 v=
+ T=255 L=2 v=2342
+ T=0 L=2 v=2342
+- decoding every second tag:
+ T=255 L=2 v=2342
+ T=123 L=255 v=ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
+ T=102 L=2 v=2222
+- enforcing order: without restart, a past tag is not parsed again:
+ osmo_tlv_load_next_by_tag(0) rc=-ENOENT
+=== end: t8l8v_tests[0]
+
+=== start: t8l8v_tests[1]
+- encoded: 2a 01 42 02 02 01 01 02 02 22 22 03 01 11 03 02 22 22 03 03 33 33 33 17 01 23 2a 08 66 6f 72 74 79 74 77 6f 17 0b 74 77 65 6e 74 79 74 68 72 65 65 .
+- decoding:
+ T=42 L=1 v=42
+ T=2 L=2 v=0101
+ T=2 L=2 v=2222
+ T=3 L=1 v=11
+ T=3 L=2 v=2222
+ T=3 L=3 v=333333
+ T=23 L=1 v=23
+ T=42 L=8 v=666f72747974776f
+ T=23 L=11 v=7477656e74797468726565
+- peeking:
+ peek T=42
+ peek T=2
+ peek T=2
+ peek T=3
+ peek T=3
+ peek T=3
+ peek T=23
+ peek T=42
+ peek T=23
+ peek T=-ENOENT
+- decoding in reverse order:
+ (mismatch: T=23 L=1 v=23, checking for another occurence of T=23)
+ T=23 L=11 v=7477656e74797468726565
+ (mismatch: T=42 L=1 v=42, checking for another occurence of T=42)
+ T=42 L=8 v=666f72747974776f
+ T=23 L=1 v=23
+ (mismatch: T=3 L=1 v=11, checking for another occurence of T=3)
+ (mismatch: T=3 L=2 v=2222, checking for another occurence of T=3)
+ T=3 L=3 v=333333
+ (mismatch: T=3 L=1 v=11, checking for another occurence of T=3)
+ T=3 L=2 v=2222
+ T=3 L=1 v=11
+ (mismatch: T=2 L=2 v=0101, checking for another occurence of T=2)
+ T=2 L=2 v=2222
+ T=2 L=2 v=0101
+ T=42 L=1 v=42
+- decoding every second tag:
+ T=2 L=2 v=0101
+ T=3 L=1 v=11
+ (mismatch: T=3 L=2 v=2222, checking for another occurence of T=3)
+ T=3 L=3 v=333333
+ T=42 L=8 v=666f72747974776f
+- enforcing order: without restart, a past tag is not parsed again:
+ osmo_tlv_load_next_by_tag(42) rc=-ENOENT
+=== end: t8l8v_tests[1]
+
+=== start: t16l16v_tests[0]
+- encoded: 00 00 00 02 23 42 ff ff 00 02 23 42 00 01 00 00 00 7b 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 03 e9 00 01 11 03 ea 00 02 22 22 03 eb 00 03 33 33 33 .
+- decoding:
+ T=0 L=2 v=2342
+ T=65535 L=2 v=2342
+ T=1 L=0 v=
+ T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
+ T=1001 L=1 v=11
+ T=1002 L=2 v=2222
+ T=1003 L=3 v=333333
+- peeking:
+ peek T=0
+ peek T=65535
+ peek T=1
+ peek T=123
+ peek T=1001
+ peek T=1002
+ peek T=1003
+ peek T=-ENOENT
+- decoding in reverse order:
+ T=1003 L=3 v=333333
+ T=1002 L=2 v=2222
+ T=1001 L=1 v=11
+ T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
+ T=1 L=0 v=
+ T=65535 L=2 v=2342
+ T=0 L=2 v=2342
+- decoding every second tag:
+ T=65535 L=2 v=2342
+ T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
+ T=1002 L=2 v=2222
+- enforcing order: without restart, a past tag is not parsed again:
+ osmo_tlv_load_next_by_tag(0) rc=-ENOENT
+=== end: t16l16v_tests[0]
+
+=== start: t16l16v_tests[1]
+- encoded: 04 12 00 01 42 00 66 00 02 01 01 00 66 00 02 22 22 00 67 00 01 11 00 67 00 02 22 22 00 67 00 03 33 33 33 03 ff 00 01 23 04 12 00 08 66 6f 72 74 79 74 77 6f 03 ff 00 0b 74 77 65 6e 74 79 74 68 72 65 65 .
+- decoding:
+ T=1042 L=1 v=42
+ T=102 L=2 v=0101
+ T=102 L=2 v=2222
+ T=103 L=1 v=11
+ T=103 L=2 v=2222
+ T=103 L=3 v=333333
+ T=1023 L=1 v=23
+ T=1042 L=8 v=666f72747974776f
+ T=1023 L=11 v=7477656e74797468726565
+- peeking:
+ peek T=1042
+ peek T=102
+ peek T=102
+ peek T=103
+ peek T=103
+ peek T=103
+ peek T=1023
+ peek T=1042
+ peek T=1023
+ peek T=-ENOENT
+- decoding in reverse order:
+ (mismatch: T=1023 L=1 v=23, checking for another occurence of T=1023)
+ T=1023 L=11 v=7477656e74797468726565
+ (mismatch: T=1042 L=1 v=42, checking for another occurence of T=1042)
+ T=1042 L=8 v=666f72747974776f
+ T=1023 L=1 v=23
+ (mismatch: T=103 L=1 v=11, checking for another occurence of T=103)
+ (mismatch: T=103 L=2 v=2222, checking for another occurence of T=103)
+ T=103 L=3 v=333333
+ (mismatch: T=103 L=1 v=11, checking for another occurence of T=103)
+ T=103 L=2 v=2222
+ T=103 L=1 v=11
+ (mismatch: T=102 L=2 v=0101, checking for another occurence of T=102)
+ T=102 L=2 v=2222
+ T=102 L=2 v=0101
+ T=1042 L=1 v=42
+- decoding every second tag:
+ T=102 L=2 v=0101
+ T=103 L=1 v=11
+ (mismatch: T=103 L=2 v=2222, checking for another occurence of T=103)
+ T=103 L=3 v=333333
+ T=1042 L=8 v=666f72747974776f
+- enforcing order: without restart, a past tag is not parsed again:
+ osmo_tlv_load_next_by_tag(1042) rc=-ENOENT
+=== end: t16l16v_tests[1]
+
+=== start: txlxv_tests[0]
+- encoded: 00 02 23 42 7f 02 23 42 80 01 02 23 42 ff ff 02 23 42 01 00 7b 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ea 07 22 22 eb 07 03 33 33 33 .
+- decoding:
+ T=0 L=2 v=2342
+ T=127 L=2 v=2342
+ T=128 L=2 v=2342
+ T=32767 L=2 v=2342
+ T=1 L=0 v=
+ T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
+ T=1002 L=2 v=2222
+ T=1003 L=3 v=333333
+- peeking:
+ peek T=0
+ peek T=127
+ peek T=128
+ peek T=32767
+ peek T=1
+ peek T=123
+ peek T=1002
+ peek T=1003
+ peek T=-ENOENT
+- decoding in reverse order:
+ T=1003 L=3 v=333333
+ T=1002 L=2 v=2222
+ T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
+ T=1 L=0 v=
+ T=32767 L=2 v=2342
+ T=128 L=2 v=2342
+ T=127 L=2 v=2342
+ T=0 L=2 v=2342
+- decoding every second tag:
+ T=127 L=2 v=2342
+ T=32767 L=2 v=2342
+ T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
+ T=1003 L=3 v=333333
+- enforcing order: without restart, a past tag is not parsed again:
+ osmo_tlv_load_next_by_tag(0) rc=-ENOENT
+=== end: txlxv_tests[0]
+
+=== start: txlxv_tests[1]
+- encoded: 92 08 01 42 ea 07 01 01 ea 07 22 22 67 01 11 67 02 22 22 67 03 33 33 33 ff 07 01 23 92 08 08 66 6f 72 74 79 74 77 6f ff 07 0b 74 77 65 6e 74 79 74 68 72 65 65 .
+- decoding:
+ T=1042 L=1 v=42
+ T=1002 L=2 v=0101
+ T=1002 L=2 v=2222
+ T=103 L=1 v=11
+ T=103 L=2 v=2222
+ T=103 L=3 v=333333
+ T=1023 L=1 v=23
+ T=1042 L=8 v=666f72747974776f
+ T=1023 L=11 v=7477656e74797468726565
+- peeking:
+ peek T=1042
+ peek T=1002
+ peek T=1002
+ peek T=103
+ peek T=103
+ peek T=103
+ peek T=1023
+ peek T=1042
+ peek T=1023
+ peek T=-ENOENT
+- decoding in reverse order:
+ (mismatch: T=1023 L=1 v=23, checking for another occurence of T=1023)
+ T=1023 L=11 v=7477656e74797468726565
+ (mismatch: T=1042 L=1 v=42, checking for another occurence of T=1042)
+ T=1042 L=8 v=666f72747974776f
+ T=1023 L=1 v=23
+ (mismatch: T=103 L=1 v=11, checking for another occurence of T=103)
+ (mismatch: T=103 L=2 v=2222, checking for another occurence of T=103)
+ T=103 L=3 v=333333
+ (mismatch: T=103 L=1 v=11, checking for another occurence of T=103)
+ T=103 L=2 v=2222
+ T=103 L=1 v=11
+ (mismatch: T=1002 L=2 v=0101, checking for another occurence of T=1002)
+ T=1002 L=2 v=2222
+ T=1002 L=2 v=0101
+ T=1042 L=1 v=42
+- decoding every second tag:
+ T=1002 L=2 v=0101
+ T=103 L=1 v=11
+ (mismatch: T=103 L=2 v=2222, checking for another occurence of T=103)
+ T=103 L=3 v=333333
+ T=1042 L=8 v=666f72747974776f
+- enforcing order: without restart, a past tag is not parsed again:
+ osmo_tlv_load_next_by_tag(1042) rc=-ENOENT
+=== end: txlxv_tests[1]
diff --git a/tests/testsuite.at b/tests/testsuite.at
index 09a77c3..86ef4d3 100644
--- a/tests/testsuite.at
+++ b/tests/testsuite.at
@@ -1,2 +1,8 @@
AT_INIT
AT_BANNER([Regression tests.])
+
+AT_SETUP([tlv])
+AT_KEYWORDS([tlv])
+cat $abs_srcdir/libosmo-tlv/tlv_test.ok > expout
+AT_CHECK([$abs_top_builddir/tests/libosmo-tlv/tlv_test], [], [expout], [ignore])
+AT_CLEANUP
--
To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/27217
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-upf
Gerrit-Branch: master
Gerrit-Change-Id: Ib0fd00d9f288ffe13b7e67701f3e47073587404a
Gerrit-Change-Number: 27217
Gerrit-PatchSet: 1
Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de>
Gerrit-MessageType: newchange
1
0
Change in osmo-ci[master]: Use docker image debian-bullseye-erlang instead of debian-buster-erlang
by pespin 16 Feb '22
by pespin 16 Feb '22
16 Feb '22
pespin has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-ci/+/27216 )
Change subject: Use docker image debian-bullseye-erlang instead of debian-buster-erlang
......................................................................
Use docker image debian-bullseye-erlang instead of debian-buster-erlang
Let's use newer debian to avoid problems with older erlang. Furthermore,
the new image builds rebar3 to avoid issues with unmatching erlang
versions.
Change-Id: I7b1956c515daccf6ab1ff87031c6fec649cadb4b
---
M jobs/gerrit-verifications.yml
M scripts/osmo-ci-docker-rebuild.sh
2 files changed, 2 insertions(+), 2 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/osmo-ci refs/changes/16/27216/1
diff --git a/jobs/gerrit-verifications.yml b/jobs/gerrit-verifications.yml
index 84fe805..32c3e3b 100644
--- a/jobs/gerrit-verifications.yml
+++ b/jobs/gerrit-verifications.yml
@@ -41,7 +41,7 @@
-v "$PWD:/build" \
-v "$ARTIFACT_STORE:/artifact_store" \
docker_img: '$USER/debian-stretch-jenkins'
- docker_img_erlang: '$USER/debian-buster-erlang'
+ docker_img_erlang: '$USER/debian-bullseye-erlang'
timeout_cmd: '/usr/bin/timeout 30m'
cmd: '{docker_run} {docker_img} {timeout_cmd} /build/contrib/jenkins.sh'
gerrit_url: 'ssh://jenkins@gerrit.osmocom.org:29418'
diff --git a/scripts/osmo-ci-docker-rebuild.sh b/scripts/osmo-ci-docker-rebuild.sh
index 73b3508..cf0b102 100755
--- a/scripts/osmo-ci-docker-rebuild.sh
+++ b/scripts/osmo-ci-docker-rebuild.sh
@@ -5,7 +5,7 @@
docker_images_require \
"debian-stretch-jenkins" \
"debian-buster-jenkins" \
- "debian-buster-erlang" \
+ "debian-bullseye-erlang" \
if [ "$(arch)" = "x86_64" ]; then
docker_images_require \
--
To view, visit https://gerrit.osmocom.org/c/osmo-ci/+/27216
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-ci
Gerrit-Branch: master
Gerrit-Change-Id: I7b1956c515daccf6ab1ff87031c6fec649cadb4b
Gerrit-Change-Number: 27216
Gerrit-PatchSet: 1
Gerrit-Owner: pespin <pespin(a)sysmocom.de>
Gerrit-MessageType: newchange
1
0
pespin has uploaded this change for review. ( https://gerrit.osmocom.org/c/docker-playground/+/27215 )
Change subject: Remove debian-buster-erlang
......................................................................
Remove debian-buster-erlang
We don't need the image anymore, we use debian-bullseye-erlang.
Change-Id: I6f22642f5f67a173b17db55aa7a7bda3d9debd54
---
D debian-buster-erlang/Dockerfile
D debian-buster-erlang/Makefile
2 files changed, 0 insertions(+), 57 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/docker-playground refs/changes/15/27215/1
diff --git a/debian-buster-erlang/Dockerfile b/debian-buster-erlang/Dockerfile
deleted file mode 100644
index 10b2c88..0000000
--- a/debian-buster-erlang/Dockerfile
+++ /dev/null
@@ -1,54 +0,0 @@
-ARG REGISTRY=docker.io
-FROM ${REGISTRY}/debian:buster
-# Arguments used after FROM must be specified again
-ARG OSMOCOM_REPO_MIRROR="http://download.opensuse.org"
-ARG OSMOCOM_REPO_PATH="repositories/network:/osmocom:"
-
-MAINTAINER Harald Welte <laforge(a)gnumonks.org>
-
-ARG OSMOCOM_REPO="${OSMOCOM_REPO_MIRROR}/${OSMOCOM_REPO_PATH}/latest/Debian_10/"
-
-# install the erlang vm and rebar (2)
-RUN apt-get update && \
- apt-get upgrade -y && \
- apt-get -y install \
- erlang \
- rebar
-
-# add rebar3
-ADD https://s3.amazonaws.com/rebar3/rebar3 /usr/bin/rebar3
-RUN chmod 0755 /usr/bin/rebar3
-
-# install ninimal build utilities as well as system utilities
-RUN apt-get update && \
- apt-get -y install \
- build-essential \
- git \
- procps \
- tcpdump \
- vim \
- netcat-openbsd \
- wget \
- && \
- apt-get clean
-
-# install additional C-language / system dependencies of our Erlang projects
-RUN apt-get update && \
- apt-get -y install \
- libpcap-dev \
- && \
- apt-get clean
-
-# add osmocom latest repo, should we ever require packages from there
-RUN apt-get update && apt-get install -y \
- gnupg
-COPY .common/Release.key /tmp/Release.key
-RUN apt-key add /tmp/Release.key && \
- rm /tmp/Release.key && \
- echo "deb " $OSMOCOM_REPO " ./" > /etc/apt/sources.list.d/osmocom-latest.list
-ADD $OSMOCOM_REPO/Release /tmp/Release
-
-# add a non-root user under which we will normaly execute build tests
-RUN useradd -m build
-WORKDIR /home/build
-USER build
diff --git a/debian-buster-erlang/Makefile b/debian-buster-erlang/Makefile
deleted file mode 100644
index 67066b3..0000000
--- a/debian-buster-erlang/Makefile
+++ /dev/null
@@ -1,3 +0,0 @@
-UPSTREAM_DISTRO=debian:buster
-DISTRO=debian-buster
-include ../make/Makefile
--
To view, visit https://gerrit.osmocom.org/c/docker-playground/+/27215
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: docker-playground
Gerrit-Branch: master
Gerrit-Change-Id: I6f22642f5f67a173b17db55aa7a7bda3d9debd54
Gerrit-Change-Number: 27215
Gerrit-PatchSet: 1
Gerrit-Owner: pespin <pespin(a)sysmocom.de>
Gerrit-MessageType: newchange
1
0
Change in docker-playground[master]: debian-bullseye-erlang: Build rebar3 from source
by pespin 16 Feb '22
by pespin 16 Feb '22
16 Feb '22
pespin has uploaded this change for review. ( https://gerrit.osmocom.org/c/docker-playground/+/27214 )
Change subject: debian-bullseye-erlang: Build rebar3 from source
......................................................................
debian-bullseye-erlang: Build rebar3 from source
This way we ensure it is always built against the same erland OTP
installed in the system.
Change-Id: I6cd8a61ca52c7beda98b357f82ce42eba54e196b
---
M debian-bullseye-erlang/Dockerfile
1 file changed, 6 insertions(+), 2 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/docker-playground refs/changes/14/27214/1
diff --git a/debian-bullseye-erlang/Dockerfile b/debian-bullseye-erlang/Dockerfile
index b5d8f5b..15da137 100644
--- a/debian-bullseye-erlang/Dockerfile
+++ b/debian-bullseye-erlang/Dockerfile
@@ -16,8 +16,12 @@
rebar
# add rebar3
-ADD https://s3.amazonaws.com/rebar3/rebar3 /usr/bin/rebar3
-RUN chmod 0755 /usr/bin/rebar3
+ARG REBAR3_VERSION="3.18.0"
+ADD https://github.com/erlang/rebar3/archive/refs/tags/${REBAR3_VERSION}.tar.gz /tmp/rebar3.tar.gz
+RUN tar -zxf /tmp/rebar3.tar.gz && \
+ cd rebar3-${REBAR3_VERSION} && \
+ ./bootstrap && \
+ install -Dm0755 "rebar3" "/usr/bin/rebar3"
# install ninimal build utilities as well as system utilities
RUN apt-get update && \
--
To view, visit https://gerrit.osmocom.org/c/docker-playground/+/27214
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: docker-playground
Gerrit-Branch: master
Gerrit-Change-Id: I6cd8a61ca52c7beda98b357f82ce42eba54e196b
Gerrit-Change-Number: 27214
Gerrit-PatchSet: 1
Gerrit-Owner: pespin <pespin(a)sysmocom.de>
Gerrit-MessageType: newchange
1
0
16 Feb '22
pespin has uploaded this change for review. ( https://gerrit.osmocom.org/c/docker-playground/+/27213 )
Change subject: Add debian-bullseye-erlang docker image
......................................................................
Add debian-bullseye-erlang docker image
Copied from debian-buster-erlang, references to debian 10 and buster
modified to debian11 and bullseye.
Change-Id: I5c13eedcbfa721b7e1939e571470ea7044c00211
---
A debian-bullseye-erlang/Dockerfile
A debian-bullseye-erlang/Makefile
2 files changed, 57 insertions(+), 0 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/docker-playground refs/changes/13/27213/1
diff --git a/debian-bullseye-erlang/Dockerfile b/debian-bullseye-erlang/Dockerfile
new file mode 100644
index 0000000..b5d8f5b
--- /dev/null
+++ b/debian-bullseye-erlang/Dockerfile
@@ -0,0 +1,54 @@
+ARG REGISTRY=docker.io
+FROM ${REGISTRY}/debian:bullseye
+# Arguments used after FROM must be specified again
+ARG OSMOCOM_REPO_MIRROR="http://download.opensuse.org"
+ARG OSMOCOM_REPO_PATH="repositories/network:/osmocom:"
+
+MAINTAINER Harald Welte <laforge(a)gnumonks.org>
+
+ARG OSMOCOM_REPO="${OSMOCOM_REPO_MIRROR}/${OSMOCOM_REPO_PATH}/latest/Debian_11/"
+
+# install the erlang vm and rebar (2)
+RUN apt-get update && \
+ apt-get upgrade -y && \
+ apt-get -y install \
+ erlang \
+ rebar
+
+# add rebar3
+ADD https://s3.amazonaws.com/rebar3/rebar3 /usr/bin/rebar3
+RUN chmod 0755 /usr/bin/rebar3
+
+# install ninimal build utilities as well as system utilities
+RUN apt-get update && \
+ apt-get -y install \
+ build-essential \
+ git \
+ procps \
+ tcpdump \
+ vim \
+ netcat-openbsd \
+ wget \
+ && \
+ apt-get clean
+
+# install additional C-language / system dependencies of our Erlang projects
+RUN apt-get update && \
+ apt-get -y install \
+ libpcap-dev \
+ && \
+ apt-get clean
+
+# add osmocom latest repo, should we ever require packages from there
+RUN apt-get update && apt-get install -y \
+ gnupg
+COPY .common/Release.key /tmp/Release.key
+RUN apt-key add /tmp/Release.key && \
+ rm /tmp/Release.key && \
+ echo "deb " $OSMOCOM_REPO " ./" > /etc/apt/sources.list.d/osmocom-latest.list
+ADD $OSMOCOM_REPO/Release /tmp/Release
+
+# add a non-root user under which we will normaly execute build tests
+RUN useradd -m build
+WORKDIR /home/build
+USER build
diff --git a/debian-bullseye-erlang/Makefile b/debian-bullseye-erlang/Makefile
new file mode 100644
index 0000000..67066b3
--- /dev/null
+++ b/debian-bullseye-erlang/Makefile
@@ -0,0 +1,3 @@
+UPSTREAM_DISTRO=debian:buster
+DISTRO=debian-buster
+include ../make/Makefile
--
To view, visit https://gerrit.osmocom.org/c/docker-playground/+/27213
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: docker-playground
Gerrit-Branch: master
Gerrit-Change-Id: I5c13eedcbfa721b7e1939e571470ea7044c00211
Gerrit-Change-Number: 27213
Gerrit-PatchSet: 1
Gerrit-Owner: pespin <pespin(a)sysmocom.de>
Gerrit-MessageType: newchange
1
0
Change in libosmocore[master]: gsm0808: Test if we properly decode a SRVCC cell identifier list
by laforge 16 Feb '22
by laforge 16 Feb '22
16 Feb '22
laforge has uploaded this change for review. ( https://gerrit.osmocom.org/c/libosmocore/+/27212 )
Change subject: gsm0808: Test if we properly decode a SRVCC cell identifier list
......................................................................
gsm0808: Test if we properly decode a SRVCC cell identifier list
We don't handle this correctly, as we decided to overload the
meaning of 0b1011 in a cell identifier list (defined by 3GPP
as used in SRVCC) with something osmocom proprietary.
Change-Id: I608220e8e5dd5a44f85c6bc5ea04622a2cad24ec
---
M tests/gsm0808/gsm0808_test.c
1 file changed, 12 insertions(+), 0 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/12/27212/1
diff --git a/tests/gsm0808/gsm0808_test.c b/tests/gsm0808/gsm0808_test.c
index 3fff005..e0f8eb3 100644
--- a/tests/gsm0808/gsm0808_test.c
+++ b/tests/gsm0808/gsm0808_test.c
@@ -1072,6 +1072,17 @@
msgb_free(msg);
}
+static void test_gsm0808_dec_cell_id_list_srvcc()
+{
+ /* taken from a pcap file of a real-world 3rd party MSC (SYS#5838) */
+ const uint8_t enc_cil[] = { 0x0b, 0x2, 0xf2, 0x10, 0x4e, 0x20, 0x15, 0xbe};
+ struct gsm0808_cell_id_list2 dec_cil;
+ int rc;
+
+ rc = gsm0808_dec_cell_id_list2(&dec_cil, enc_cil, sizeof(enc_cil));
+ OSMO_ASSERT(rc == sizeof(dec_cil));
+}
+
static void test_gsm0808_enc_dec_cell_id_list_lac()
{
struct gsm0808_cell_id_list2 enc_cil;
@@ -2490,6 +2501,7 @@
test_gsm0808_enc_dec_cell_id_list_multi_ci();
test_gsm0808_enc_dec_cell_id_list_multi_lac_and_ci();
test_gsm0808_enc_dec_cell_id_list_multi_global();
+ test_gsm0808_dec_cell_id_list_srvcc();
test_cell_id_list_add();
--
To view, visit https://gerrit.osmocom.org/c/libosmocore/+/27212
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-Change-Id: I608220e8e5dd5a44f85c6bc5ea04622a2cad24ec
Gerrit-Change-Number: 27212
Gerrit-PatchSet: 1
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-MessageType: newchange
1
0
16 Feb '22
Attention is currently required from: iedemam.
neels has posted comments on this change. ( https://gerrit.osmocom.org/c/osmo-bsc/+/27081 )
Change subject: stats: New stats for lchan life duration.
......................................................................
Patch Set 8:
(1 comment)
Patchset:
PS8:
sorry for the weird formatting of my prev comment in gerrit, seems i can't edit the comment to fix it.
--
To view, visit https://gerrit.osmocom.org/c/osmo-bsc/+/27081
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-bsc
Gerrit-Branch: master
Gerrit-Change-Id: I1b0670c47cb5e0b7776eda89d1e71545ba0e3347
Gerrit-Change-Number: 27081
Gerrit-PatchSet: 8
Gerrit-Owner: iedemam <michael(a)kapsulate.com>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: neels <nhofmeyr(a)sysmocom.de>
Gerrit-CC: laforge <laforge(a)osmocom.org>
Gerrit-CC: pespin <pespin(a)sysmocom.de>
Gerrit-Attention: iedemam <michael(a)kapsulate.com>
Gerrit-Comment-Date: Tue, 15 Feb 2022 18:48:18 +0000
Gerrit-HasComments: Yes
Gerrit-Has-Labels: No
Gerrit-MessageType: comment
1
0
16 Feb '22
Attention is currently required from: iedemam.
neels has posted comments on this change. ( https://gerrit.osmocom.org/c/osmo-bsc/+/27081 )
Change subject: stats: New stats for lchan life duration.
......................................................................
Patch Set 8:
(11 comments)
Patchset:
PS8:
Hi Michael!
Good to see a patch from outside of sysmocom.
And what a patch it is. Reporting time durations in statistics is a head-spinning mathematically challenging topic. When reviewing the patch I went from "oh, that's simple" and "why didn't I think of this and went for all the effort with osmo_time_cc?" at first, all the way to "wait, no, how does this work again??" and to "oh that's why I wrote osmo_time_cc". This stuff can be really confusing.
Let me try to break down what I figured out so far:
This current patch has these flaws:
- (there should be no averaging, see below, but) The N to average over should be the released-count, not the currently-active-count, because the millis value is added only later upon channel release.
In stats, when we report the TCH_ACTIVE_MILLISECONDS_TOTAL and the BTS_CTR_CHAN_ACT_TCH, that gives an inaccurate metric, because N increments a long time before the millis increment.
The metric takes a dip upon each channel activation,
and un-dips on each channel release.
If there were a metric counting releases, the value would be much more accurate, updated only when a channel releases with the correct duration value.
- The value written on vty_out reflects an average over the process lifetime, not the current situation. A useful value would gradually "forget" the values of past time periods, literature seems to suggest averaging over an hour or 15 minutes. Instead osmocom offers rate_ctr. See below.
- For the ACTIVE_MILLISECONDS_TOTAL, a rate_ctr would be better suited. A stat item is designed for current absolute values that can decrease, like how many lchans are currently active. A rate counter reports increments of a value over-time, like how many releases have occured over time (per second, per minute, etc); this over-time is very desirable.
If we report the nr of channel releases as a rate counter as well as the sum of active milliseconds as a rate counter, a stats engine can form an accurate average over any time period it chooses.
However, think that a phone call is taking 2 hours to complete, then the trivial implementation would report those 2 hours worth of milliseconds only when the call is hung up. Or extrapolated, if *all* channels are occupied with calls going on for 2 hours, your dashboard will only flag a high Erlang value two hours after your entire network has become congested. With osmo_time_cc, the milliseconds count would gradually increase as the call continues, even before it is hung up, and the metric would also stay accurate the entire time (no dips from chan act).
No dips because no averaging:
IIUC for an Erlang we would not actually average, but simply add up all lchans.
We could put a separate osmo_time_cc for each lchan in place, and report the sum of those per BTS and chan type.
Then if we get 10 minutes of increase within one minute, that's 10 Erlangs, or 10 TCH were active concurrently. I think this is what we should go for. From explaining this, I've actually come to appreciate the simple yet powerful nature of the Erlang unit, had not realized this before.
In detail, I would:
- add a new rate counter per BTS and per chan type; each gradually reports the seconds of activity per second, added up over all lchans of that type. E.g. BTS_ACTIVE_TIME_TCH, _SDCCH,...
- we add one time_cc per lchan, and make all of them accumulate to the same BTS-wide rate counter
(one per channel type).
- in lchan_st_established_onenter() we set the time_cc = true, on established_onleave() to false.
Nothing else is required. The patch might actually become simpler this way.
(maybe there could also be separate rate counters for each TRX, and also globally over the entire BSC; a bit of implementation detail would be involved there, skipping that for now.)
I would advise against using the current patch as-is. It would provide an improved value, but there would still be the flaws I pointed out, and eventually we'd probably need to fix those and have compat issues with existing setups.
What do you think? Am I making sense?
(I could also imagine taking over, but not sure how soon that would work out; would need to ask about our current priorities).
I also wrote a bunch of code review on details of this patch. I'll keep some for sharing, in case you're interested in the style differences that come up.
File include/osmocom/bsc/gsm_data.h:
https://gerrit.osmocom.org/c/osmo-bsc/+/27081/comment/55df34cc_7eee50f1
PS8, Line 1130: unsigned long long gsm_lchan_active_duration_ms(const struct gsm_lchan *lchan);
(idea: use uint64_t for a fixed size independent from arch.
uint32_t spans 49 days of ms, uint64_t half a billion years)
File src/osmo-bsc/bts.c:
https://gerrit.osmocom.org/c/osmo-bsc/+/27081/comment/9e38af99_1efeb800
PS8, Line 1514: "Cummulative number of active milliseconds on TCH chans",
("Cumulative")
doc reads a bit weird, as if the milliseconds are active, also leaves a lot of guessing about the nature of the metric.
suggestion:
"Average lchan activity duration per TCH lchan activation in milliseconds"
File src/osmo-bsc/bts_trx_vty.c:
https://gerrit.osmocom.org/c/osmo-bsc/+/27081/comment/d479f6ec_6c688a6f
PS8, Line 574: uint duration_s = (gsm_lchan_active_duration_ms(lchan) + 500) / 1000;
the +500 acts as a round(), yet the reported descriptions below suggest that floor() should be used instead. IOW please drop the 500.
File src/osmo-bsc/bts_vty.c:
https://gerrit.osmocom.org/c/osmo-bsc/+/27081/comment/d3a14304_f147c16c
PS8, Line 3826: uint64_t activations_tch = rate_ctr_group_get_ctr(bts->bts_ctrs, BTS_CTR_CHAN_ACT_TCH)->current;
osmocom style dictates that local variables are declared at the start of the function (or scope)
File src/osmo-bsc/gsm_data.c:
https://gerrit.osmocom.org/c/osmo-bsc/+/27081/comment/6b1bdb85_9746e7b5
PS8, Line 348: /* Get duration of active time for this lchan in milliseconds */
Rather:
/* If the lchan is currently active, return the duration since activation in milliseconds. Otherwise return 0. */
https://gerrit.osmocom.org/c/osmo-bsc/+/27081/comment/73cb38ff_8091843b
PS8, Line 352: if (lchan->activate.concluded) {
osmocom style asks for early-exit:
struct timespec now;
if (!lchan->activate.concluded)
return 0;
osmo_clock_gettime
...
return elapsed.tv_sec * ...
https://gerrit.osmocom.org/c/osmo-bsc/+/27081/comment/cdcce2f6_c8642f83
PS8, Line 357: duration = elapsed.tv_sec * 1000LL + elapsed.tv_nsec / 1000000;
the LL on the 1000 has no effect, the first operand defines the integer size for calculation. So you want one of these:
(uint64_t)elapsed.tv_sec * 1000 + ...
or
1000LL * elapsed.tv_sec + ...
(i prefer the first)
File src/osmo-bsc/lchan_fsm.c:
https://gerrit.osmocom.org/c/osmo-bsc/+/27081/comment/af32bb7e_b5fe7283
PS8, Line 1810:
You should rather put this bit in a new lchan_st_established_onleave() function.
This is the single place that is absolutely guaranteed to be called whenever the lchan leaves the active state.
If you want to also count the time that the lchan release process takes (including any error timeouts that may be), then you'd instead put this in lchan_st_unused_onenter().
In lchan_fsm.c:1628, add a new onleave cb:
[LCHAN_ST_ESTABLISHED] = {
.onleave = lchan_st_established_onleave,
https://gerrit.osmocom.org/c/osmo-bsc/+/27081/comment/ad4f3c23_f4db6493
PS8, Line 1811: /* Add active milliseconds to cummulative counts per channel type */
/* Report how long this lchan was active, to add to the average activity duration metric. */
https://gerrit.osmocom.org/c/osmo-bsc/+/27081/comment/e0fc54f9_b83bf4f8
PS8, Line 1817: LOG_LCHAN(lchan, LOGL_INFO, "GSM_LCHAN_TCH was active for %llu milliseconds\n", duration_ms);
i would rather just have a single LOG_LCHAN() that uses gsm_chan_t_name() above the switch, because then you don't need to duplicate which names we use for channel types in logging, and you can drop the weird 'default:' case.
Also osmo_int_to_float_str() is nice.
/* "TCH/H was active for 1.23 seconds" */
LOG_LCHAN("%s was active for %s seconds", gsm_chan_t_name(lchan),
osmo_int_to_float_str_c(OTC_SELECT, millis, 3);
switch(lchan->type) {
osmo_stat_item_inc...
break
--
To view, visit https://gerrit.osmocom.org/c/osmo-bsc/+/27081
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-bsc
Gerrit-Branch: master
Gerrit-Change-Id: I1b0670c47cb5e0b7776eda89d1e71545ba0e3347
Gerrit-Change-Number: 27081
Gerrit-PatchSet: 8
Gerrit-Owner: iedemam <michael(a)kapsulate.com>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: neels <nhofmeyr(a)sysmocom.de>
Gerrit-CC: laforge <laforge(a)osmocom.org>
Gerrit-CC: pespin <pespin(a)sysmocom.de>
Gerrit-Attention: iedemam <michael(a)kapsulate.com>
Gerrit-Comment-Date: Tue, 15 Feb 2022 18:42:19 +0000
Gerrit-HasComments: Yes
Gerrit-Has-Labels: No
Gerrit-MessageType: comment
1
0