[v2] telemetry: add support for dicts of dicts
Checks
Commit Message
Add support for dicts of dicts to telemetry library.
Signed-off-by: Declan Doherty <declan.doherty@intel.com>
Signed-off-by: Radu Nicolau <radu.nicolau@intel.com>
---
app/test/test_telemetry_data.c | 29 +++++++++++++++++++++++
lib/telemetry/telemetry.c | 43 +++++++++++++++++++++++++++++++---
lib/telemetry/telemetry_data.c | 3 ++-
3 files changed, 71 insertions(+), 4 deletions(-)
Comments
Hi Radu,
Thanks for adding the test, one more comment inline that I have just noticed.
>-----Original Message-----
>From: Nicolau, Radu <radu.nicolau@intel.com>
>Sent: Friday 10 September 2021 12:28
>To: Power, Ciara <ciara.power@intel.com>
>Cc: dev@dpdk.org; Richardson, Bruce <bruce.richardson@intel.com>; Nicolau,
>Radu <radu.nicolau@intel.com>; Doherty, Declan
><declan.doherty@intel.com>
>Subject: [PATCH v2] telemetry: add support for dicts of dicts
>
>Add support for dicts of dicts to telemetry library.
>
>Signed-off-by: Declan Doherty <declan.doherty@intel.com>
>Signed-off-by: Radu Nicolau <radu.nicolau@intel.com>
>---
> app/test/test_telemetry_data.c | 29 +++++++++++++++++++++++
> lib/telemetry/telemetry.c | 43 +++++++++++++++++++++++++++++++---
> lib/telemetry/telemetry_data.c | 3 ++-
> 3 files changed, 71 insertions(+), 4 deletions(-)
>
>diff --git a/app/test/test_telemetry_data.c b/app/test/test_telemetry_data.c
>index f34d691265..18b93db8ef 100644
>--- a/app/test/test_telemetry_data.c
>+++ b/app/test/test_telemetry_data.c
>@@ -200,6 +200,34 @@ test_dict_with_array_string_values(void)
> "[\"bbbb\"]}}");
> }
>
>+static int
>+test_dict_with_dict_values(void)
>+{
>+ struct rte_tel_data *dict_of_dicts = rte_tel_data_alloc();
>+ rte_tel_data_start_dict(dict_of_dicts);
>+
>+ struct rte_tel_data *child_data = rte_tel_data_alloc();
>+ rte_tel_data_start_array(child_data, RTE_TEL_STRING_VAL);
>+
>+ struct rte_tel_data *child_data2 = rte_tel_data_alloc();
>+ rte_tel_data_start_array(child_data2, RTE_TEL_STRING_VAL);
>+
>+ memset(&response_data, 0, sizeof(response_data));
>+ rte_tel_data_start_dict(&response_data);
>+
>+ rte_tel_data_add_array_string(child_data, "aaaa");
>+ rte_tel_data_add_array_string(child_data2, "bbbb");
>+ rte_tel_data_add_dict_container(dict_of_dicts, "dict_0",
>+ child_data, 0);
>+ rte_tel_data_add_dict_container(dict_of_dicts, "dict_1",
>+ child_data2, 0);
>+ rte_tel_data_add_dict_container(&response_data, "dict_of_dicts",
>+ dict_of_dicts, 0);
>+
>+ return TEST_OUTPUT("{\"/test\":{\"dict_of_dicts\":{\"dict_0\":"
>+ "[\"aaaa\"],\"dict_1\":[\"bbbb\"]}}}");
>+}
>+
> static int
> test_array_with_array_string_values(void)
> {
>@@ -355,6 +383,7 @@ test_telemetry_data(void)
> test_dict_with_array_int_values,
> test_dict_with_array_u64_values,
> test_dict_with_array_string_values,
>+ test_dict_with_dict_values,
> test_array_with_array_int_values,
> test_array_with_array_u64_values,
> test_array_with_array_string_values }; diff --git
>a/lib/telemetry/telemetry.c b/lib/telemetry/telemetry.c index
>8665db8d03..3f83476112 100644
>--- a/lib/telemetry/telemetry.c
>+++ b/lib/telemetry/telemetry.c
>@@ -24,7 +24,7 @@
> #include "telemetry_internal.h"
>
> #define MAX_CMD_LEN 56
>-#define MAX_HELP_LEN 64
>+#define MAX_HELP_LEN 128
This change will not do much - it will allow a longer help text to be given for the command on registration,
but when the user actually asks for help text for a command, there is a restriction on the size of the string value that is added to the dict reply,
which will truncate the help text:
In telemetry_data.c/rte_tel_data_add_dict_string:
vbytes = strlcpy(e->value.sval, val, RTE_TEL_MAX_STRING_LEN);
where RTE_TEL_MAX_STRING_LEN is 64
Maybe we could just increase RTE_TEL_MAX_STRING_LEN to 128 and replace use of MAX_HELP_LEN with that, to keep them aligned.
Thanks,
Ciara
@@ -200,6 +200,34 @@ test_dict_with_array_string_values(void)
"[\"bbbb\"]}}");
}
+static int
+test_dict_with_dict_values(void)
+{
+ struct rte_tel_data *dict_of_dicts = rte_tel_data_alloc();
+ rte_tel_data_start_dict(dict_of_dicts);
+
+ struct rte_tel_data *child_data = rte_tel_data_alloc();
+ rte_tel_data_start_array(child_data, RTE_TEL_STRING_VAL);
+
+ struct rte_tel_data *child_data2 = rte_tel_data_alloc();
+ rte_tel_data_start_array(child_data2, RTE_TEL_STRING_VAL);
+
+ memset(&response_data, 0, sizeof(response_data));
+ rte_tel_data_start_dict(&response_data);
+
+ rte_tel_data_add_array_string(child_data, "aaaa");
+ rte_tel_data_add_array_string(child_data2, "bbbb");
+ rte_tel_data_add_dict_container(dict_of_dicts, "dict_0",
+ child_data, 0);
+ rte_tel_data_add_dict_container(dict_of_dicts, "dict_1",
+ child_data2, 0);
+ rte_tel_data_add_dict_container(&response_data, "dict_of_dicts",
+ dict_of_dicts, 0);
+
+ return TEST_OUTPUT("{\"/test\":{\"dict_of_dicts\":{\"dict_0\":"
+ "[\"aaaa\"],\"dict_1\":[\"bbbb\"]}}}");
+}
+
static int
test_array_with_array_string_values(void)
{
@@ -355,6 +383,7 @@ test_telemetry_data(void)
test_dict_with_array_int_values,
test_dict_with_array_u64_values,
test_dict_with_array_string_values,
+ test_dict_with_dict_values,
test_array_with_array_int_values,
test_array_with_array_u64_values,
test_array_with_array_string_values };
@@ -24,7 +24,7 @@
#include "telemetry_internal.h"
#define MAX_CMD_LEN 56
-#define MAX_HELP_LEN 64
+#define MAX_HELP_LEN 128
#define MAX_OUTPUT_LEN (1024 * 16)
#define MAX_CONNECTIONS 10
@@ -157,8 +157,8 @@ container_to_json(const struct rte_tel_data *d, char *out_buf, size_t buf_len)
size_t used = 0;
unsigned int i;
- if (d->type != RTE_TEL_ARRAY_U64 && d->type != RTE_TEL_ARRAY_INT
- && d->type != RTE_TEL_ARRAY_STRING)
+ if (d->type != RTE_TEL_DICT && d->type != RTE_TEL_ARRAY_U64 &&
+ d->type != RTE_TEL_ARRAY_INT && d->type != RTE_TEL_ARRAY_STRING)
return snprintf(out_buf, buf_len, "null");
used = rte_tel_json_empty_array(out_buf, buf_len, 0);
@@ -177,6 +177,43 @@ container_to_json(const struct rte_tel_data *d, char *out_buf, size_t buf_len)
used = rte_tel_json_add_array_string(out_buf,
buf_len, used,
d->data.array[i].sval);
+ if (d->type == RTE_TEL_DICT)
+ for (i = 0; i < d->data_len; i++) {
+ const struct tel_dict_entry *v = &d->data.dict[i];
+ switch (v->type) {
+ case RTE_TEL_STRING_VAL:
+ used = rte_tel_json_add_obj_str(out_buf,
+ buf_len, used,
+ v->name, v->value.sval);
+ break;
+ case RTE_TEL_INT_VAL:
+ used = rte_tel_json_add_obj_int(out_buf,
+ buf_len, used,
+ v->name, v->value.ival);
+ break;
+ case RTE_TEL_U64_VAL:
+ used = rte_tel_json_add_obj_u64(out_buf,
+ buf_len, used,
+ v->name, v->value.u64val);
+ break;
+ case RTE_TEL_CONTAINER:
+ {
+ char temp[buf_len];
+ const struct container *cont =
+ &v->value.container;
+ if (container_to_json(cont->data,
+ temp, buf_len) != 0)
+ used = rte_tel_json_add_obj_json(
+ out_buf,
+ buf_len, used,
+ v->name, temp);
+ if (!cont->keep)
+ rte_tel_data_free(cont->data);
+ break;
+ }
+ }
+ }
+
return used;
}
@@ -155,7 +155,8 @@ rte_tel_data_add_dict_container(struct rte_tel_data *d, const char *name,
if (d->type != RTE_TEL_DICT || (val->type != RTE_TEL_ARRAY_U64
&& val->type != RTE_TEL_ARRAY_INT
- && val->type != RTE_TEL_ARRAY_STRING))
+ && val->type != RTE_TEL_ARRAY_STRING
+ && val->type != RTE_TEL_DICT))
return -EINVAL;
if (d->data_len >= RTE_TEL_MAX_DICT_ENTRIES)
return -ENOSPC;