@@ -69,6 +69,13 @@ New Features
``rte_event_dev_config::nb_single_link_event_port_queues`` parameter
required for eth_rx, eth_tx, crypto and timer eventdev adapters.
+* **Added support for reporting lcore usage in applications.**
+
+ * The ``/eal/lcore/list`` and ``/eal/lcore/info`` telemetry endpoints have
+ been added to provide information similar to ``rte_lcore_dump()``.
+ * Applications can register a callback at startup via
+ ``rte_lcore_register_usage_cb()`` to provide lcore usage information.
+
Removed Items
-------------
@@ -2,6 +2,7 @@
* Copyright(c) 2010-2014 Intel Corporation
*/
+#include <inttypes.h>
#include <stdlib.h>
#include <string.h>
@@ -437,20 +438,49 @@ lcore_role_str(enum rte_lcore_role_t role)
}
}
+static rte_lcore_usage_cb lcore_usage_cb;
+
+void
+rte_lcore_register_usage_cb(rte_lcore_usage_cb cb)
+{
+ lcore_usage_cb = cb;
+}
+
static int
lcore_dump_cb(unsigned int lcore_id, void *arg)
{
struct rte_config *cfg = rte_eal_get_configuration();
char cpuset[RTE_CPU_AFFINITY_STR_LEN];
+ struct rte_lcore_usage usage;
+ rte_lcore_usage_cb usage_cb;
+ char *usage_str = NULL;
FILE *f = arg;
int ret;
+ /* The callback may not set all the fields in the structure, so clear it here. */
+ memset(&usage, 0, sizeof(usage));
+ /*
+ * Guard against concurrent modification of lcore_usage_cb.
+ * rte_lcore_register_usage_cb() should only be called once at application init
+ * but nothing prevents and application to reset the callback to NULL.
+ */
+ usage_cb = lcore_usage_cb;
+ if (usage_cb != NULL && usage_cb(lcore_id, &usage) == 0) {
+ if (asprintf(&usage_str, ", busy cycles %"PRIu64"/%"PRIu64,
+ usage.busy_cycles, usage.total_cycles) < 0) {
+ return -ENOMEM;
+ }
+ }
ret = eal_thread_dump_affinity(&lcore_config[lcore_id].cpuset, cpuset,
sizeof(cpuset));
- fprintf(f, "lcore %u, socket %u, role %s, cpuset %s%s\n", lcore_id,
+ fprintf(f, "lcore %u, socket %u, role %s, cpuset %s%s%s\n", lcore_id,
rte_lcore_to_socket_id(lcore_id),
lcore_role_str(cfg->lcore_role[lcore_id]),
- cpuset, ret == 0 ? "" : "...");
+ cpuset, ret == 0 ? "" : "...",
+ usage_str ? usage_str : "");
+
+ free(usage_str);
+
return 0;
}
@@ -489,7 +519,9 @@ lcore_telemetry_info_cb(unsigned int lcore_id, void *arg)
{
struct rte_config *cfg = rte_eal_get_configuration();
struct lcore_telemetry_info *info = arg;
+ struct rte_lcore_usage usage;
struct rte_tel_data *cpuset;
+ rte_lcore_usage_cb usage_cb;
unsigned int cpu;
if (info->lcore_id != lcore_id)
@@ -508,6 +540,18 @@ lcore_telemetry_info_cb(unsigned int lcore_id, void *arg)
rte_tel_data_add_array_int(cpuset, cpu);
}
rte_tel_data_add_dict_container(info->d, "cpuset", cpuset, 0);
+ /* The callback may not set all the fields in the structure, so clear it here. */
+ memset(&usage, 0, sizeof(usage));
+ /*
+ * Guard against concurrent modification of lcore_usage_cb.
+ * rte_lcore_register_usage_cb() should only be called once at application init
+ * but nothing prevents and application to reset the callback to NULL.
+ */
+ usage_cb = lcore_usage_cb;
+ if (usage_cb != NULL && usage_cb(lcore_id, &usage) == 0) {
+ rte_tel_data_add_dict_u64(info->d, "total_cycles", usage.total_cycles);
+ rte_tel_data_add_dict_u64(info->d, "busy_cycles", usage.busy_cycles);
+ }
return 0;
}
@@ -328,6 +328,41 @@ typedef int (*rte_lcore_iterate_cb)(unsigned int lcore_id, void *arg);
int
rte_lcore_iterate(rte_lcore_iterate_cb cb, void *arg);
+/**
+ * lcore usage statistics.
+ */
+struct rte_lcore_usage {
+ /** The total amount of time since application start, in TSC cycles. */
+ uint64_t total_cycles;
+ /** The amount of busy time since application start, in TSC cycles. */
+ uint64_t busy_cycles;
+};
+
+/**
+ * Callback to allow applications to report lcore usage.
+ *
+ * @param [in] lcore_id
+ * The lcore to consider.
+ * @param [out] usage
+ * Counters representing this lcore usage. This can never be NULL.
+ * @return
+ * - 0 if fields in usage were updated successfully. The fields that the
+ * application does not support must not be modified.
+ * - a negative value if the information is not available or if any error occurred.
+ */
+typedef int (*rte_lcore_usage_cb)(unsigned int lcore_id, struct rte_lcore_usage *usage);
+
+/**
+ * Register a callback from an application to be called in rte_lcore_dump() and
+ * the /eal/lcore/info telemetry endpoint handler. Applications are expected to
+ * report lcore usage statistics via this callback.
+ *
+ * @param cb
+ * The callback function.
+ */
+__rte_experimental
+void rte_lcore_register_usage_cb(rte_lcore_usage_cb cb);
+
/**
* List all lcores.
*
@@ -440,6 +440,9 @@ EXPERIMENTAL {
rte_thread_detach;
rte_thread_equal;
rte_thread_join;
+
+ # added in 23.03
+ rte_lcore_register_usage_cb;
};
INTERNAL {