rawdev: add telemetry callbacks
[dpdk.git] / lib / librte_rawdev / rte_rawdev.c
index a6d937c..ee6c087 100644 (file)
@@ -13,6 +13,7 @@
 #include <sys/types.h>
 #include <sys/queue.h>
 
+#include <rte_string_fns.h>
 #include <rte_byteorder.h>
 #include <rte_log.h>
 #include <rte_debug.h>
@@ -28,6 +29,9 @@
 #include <rte_common.h>
 #include <rte_malloc.h>
 #include <rte_errno.h>
+#ifdef RTE_LIBRTE_TELEMETRY
+#include <rte_telemetry.h>
+#endif
 
 #include "rte_rawdev.h"
 #include "rte_rawdev_pmd.h"
 /* dynamic log identifier */
 int librawdev_logtype;
 
-struct rte_rawdev rte_rawdevices[RTE_RAWDEV_MAX_DEVS];
+static struct rte_rawdev rte_rawdevices[RTE_RAWDEV_MAX_DEVS];
 
-struct rte_rawdev *rte_rawdevs = &rte_rawdevices[0];
+struct rte_rawdev *rte_rawdevs = rte_rawdevices;
 
 static struct rte_rawdev_global rawdev_globals = {
        .nb_devs                = 0
 };
 
-struct rte_rawdev_global *rte_rawdev_globals = &rawdev_globals;
-
 /* Raw device, northbound API implementation */
-uint8_t __rte_experimental
+uint8_t
 rte_rawdev_count(void)
 {
-       return rte_rawdev_globals->nb_devs;
+       return rawdev_globals.nb_devs;
 }
 
-uint16_t __rte_experimental
+uint16_t
 rte_rawdev_get_dev_id(const char *name)
 {
        uint16_t i;
@@ -60,7 +62,7 @@ rte_rawdev_get_dev_id(const char *name)
        if (!name)
                return -EINVAL;
 
-       for (i = 0; i < rte_rawdev_globals->nb_devs; i++)
+       for (i = 0; i < rawdev_globals.nb_devs; i++)
                if ((strcmp(rte_rawdevices[i].name, name)
                                == 0) &&
                                (rte_rawdevices[i].attached ==
@@ -69,7 +71,7 @@ rte_rawdev_get_dev_id(const char *name)
        return -ENODEV;
 }
 
-int __rte_experimental
+int
 rte_rawdev_socket_id(uint16_t dev_id)
 {
        struct rte_rawdev *dev;
@@ -80,7 +82,7 @@ rte_rawdev_socket_id(uint16_t dev_id)
        return dev->socket_id;
 }
 
-int __rte_experimental
+int
 rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info)
 {
        struct rte_rawdev *rawdev;
@@ -88,9 +90,6 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info)
        RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
        RTE_FUNC_PTR_OR_ERR_RET(dev_info, -EINVAL);
 
-       if (dev_info == NULL)
-               return -EINVAL;
-
        rawdev = &rte_rawdevs[dev_id];
 
        RTE_FUNC_PTR_OR_ERR_RET(*rawdev->dev_ops->dev_info_get, -ENOTSUP);
@@ -105,7 +104,7 @@ rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info)
        return 0;
 }
 
-int __rte_experimental
+int
 rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf)
 {
        struct rte_rawdev *dev;
@@ -134,7 +133,7 @@ rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf)
        return diag;
 }
 
-int __rte_experimental
+int
 rte_rawdev_queue_conf_get(uint16_t dev_id,
                          uint16_t queue_id,
                          rte_rawdev_obj_t queue_conf)
@@ -149,7 +148,7 @@ rte_rawdev_queue_conf_get(uint16_t dev_id,
        return 0;
 }
 
-int __rte_experimental
+int
 rte_rawdev_queue_setup(uint16_t dev_id,
                       uint16_t queue_id,
                       rte_rawdev_obj_t queue_conf)
@@ -163,7 +162,7 @@ rte_rawdev_queue_setup(uint16_t dev_id,
        return (*dev->dev_ops->queue_setup)(dev, queue_id, queue_conf);
 }
 
-int __rte_experimental
+int
 rte_rawdev_queue_release(uint16_t dev_id, uint16_t queue_id)
 {
        struct rte_rawdev *dev;
@@ -175,7 +174,19 @@ rte_rawdev_queue_release(uint16_t dev_id, uint16_t queue_id)
        return (*dev->dev_ops->queue_release)(dev, queue_id);
 }
 
-int __rte_experimental
+uint16_t
+rte_rawdev_queue_count(uint16_t dev_id)
+{
+       struct rte_rawdev *dev;
+
+       RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
+       dev = &rte_rawdevs[dev_id];
+
+       RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_count, -ENOTSUP);
+       return (*dev->dev_ops->queue_count)(dev);
+}
+
+int
 rte_rawdev_get_attr(uint16_t dev_id,
                    const char *attr_name,
                    uint64_t *attr_value)
@@ -189,7 +200,7 @@ rte_rawdev_get_attr(uint16_t dev_id,
        return (*dev->dev_ops->attr_get)(dev, attr_name, attr_value);
 }
 
-int __rte_experimental
+int
 rte_rawdev_set_attr(uint16_t dev_id,
                    const char *attr_name,
                    const uint64_t attr_value)
@@ -203,7 +214,7 @@ rte_rawdev_set_attr(uint16_t dev_id,
        return (*dev->dev_ops->attr_set)(dev, attr_name, attr_value);
 }
 
-int __rte_experimental
+int
 rte_rawdev_enqueue_buffers(uint16_t dev_id,
                           struct rte_rawdev_buf **buffers,
                           unsigned int count,
@@ -218,7 +229,7 @@ rte_rawdev_enqueue_buffers(uint16_t dev_id,
        return (*dev->dev_ops->enqueue_bufs)(dev, buffers, count, context);
 }
 
-int __rte_experimental
+int
 rte_rawdev_dequeue_buffers(uint16_t dev_id,
                           struct rte_rawdev_buf **buffers,
                           unsigned int count,
@@ -233,7 +244,7 @@ rte_rawdev_dequeue_buffers(uint16_t dev_id,
        return (*dev->dev_ops->dequeue_bufs)(dev, buffers, count, context);
 }
 
-int __rte_experimental
+int
 rte_rawdev_dump(uint16_t dev_id, FILE *f)
 {
        struct rte_rawdev *dev;
@@ -245,7 +256,135 @@ rte_rawdev_dump(uint16_t dev_id, FILE *f)
        return (*dev->dev_ops->dump)(dev, f);
 }
 
-int __rte_experimental
+static int
+xstats_get_count(uint16_t dev_id)
+{
+       struct rte_rawdev *dev = &rte_rawdevs[dev_id];
+
+       RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
+       return (*dev->dev_ops->xstats_get_names)(dev, NULL, 0);
+}
+
+int
+rte_rawdev_xstats_names_get(uint16_t dev_id,
+               struct rte_rawdev_xstats_name *xstats_names,
+               unsigned int size)
+{
+       const struct rte_rawdev *dev;
+       int cnt_expected_entries;
+
+       RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
+
+       cnt_expected_entries = xstats_get_count(dev_id);
+
+       if (xstats_names == NULL || cnt_expected_entries < 0 ||
+           (int)size < cnt_expected_entries || size <= 0)
+               return cnt_expected_entries;
+
+       dev = &rte_rawdevs[dev_id];
+
+       RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_names, -ENOTSUP);
+       return (*dev->dev_ops->xstats_get_names)(dev, xstats_names, size);
+}
+
+/* retrieve rawdev extended statistics */
+int
+rte_rawdev_xstats_get(uint16_t dev_id,
+                     const unsigned int ids[],
+                     uint64_t values[],
+                     unsigned int n)
+{
+       RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -ENODEV);
+       const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
+
+       RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get, -ENOTSUP);
+       return (*dev->dev_ops->xstats_get)(dev, ids, values, n);
+}
+
+uint64_t
+rte_rawdev_xstats_by_name_get(uint16_t dev_id,
+                             const char *name,
+                             unsigned int *id)
+{
+       RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, 0);
+       const struct rte_rawdev *dev = &rte_rawdevs[dev_id];
+       unsigned int temp = -1;
+
+       if (id != NULL)
+               *id = (unsigned int)-1;
+       else
+               id = &temp; /* driver never gets a NULL value */
+
+       /* implemented by driver */
+       RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_get_by_name, -ENOTSUP);
+       return (*dev->dev_ops->xstats_get_by_name)(dev, name, id);
+}
+
+int
+rte_rawdev_xstats_reset(uint16_t dev_id,
+                       const uint32_t ids[], uint32_t nb_ids)
+{
+       RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
+       struct rte_rawdev *dev = &rte_rawdevs[dev_id];
+
+       RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->xstats_reset, -ENOTSUP);
+       return (*dev->dev_ops->xstats_reset)(dev, ids, nb_ids);
+}
+
+int
+rte_rawdev_firmware_status_get(uint16_t dev_id, rte_rawdev_obj_t status_info)
+{
+       RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
+       struct rte_rawdev *dev = &rte_rawdevs[dev_id];
+
+       RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_status_get, -ENOTSUP);
+       return (*dev->dev_ops->firmware_status_get)(dev, status_info);
+}
+
+int
+rte_rawdev_firmware_version_get(uint16_t dev_id, rte_rawdev_obj_t version_info)
+{
+       RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
+       struct rte_rawdev *dev = &rte_rawdevs[dev_id];
+
+       RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_version_get, -ENOTSUP);
+       return (*dev->dev_ops->firmware_version_get)(dev, version_info);
+}
+
+int
+rte_rawdev_firmware_load(uint16_t dev_id, rte_rawdev_obj_t firmware_image)
+{
+       RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
+       struct rte_rawdev *dev = &rte_rawdevs[dev_id];
+
+       if (!firmware_image)
+               return -EINVAL;
+
+       RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_load, -ENOTSUP);
+       return (*dev->dev_ops->firmware_load)(dev, firmware_image);
+}
+
+int
+rte_rawdev_firmware_unload(uint16_t dev_id)
+{
+       RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
+       struct rte_rawdev *dev = &rte_rawdevs[dev_id];
+
+       RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->firmware_load, -ENOTSUP);
+       return (*dev->dev_ops->firmware_unload)(dev);
+}
+
+int
+rte_rawdev_selftest(uint16_t dev_id)
+{
+       RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, -EINVAL);
+       struct rte_rawdev *dev = &rte_rawdevs[dev_id];
+
+       RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_selftest, -ENOTSUP);
+       return (*dev->dev_ops->dev_selftest)(dev_id);
+}
+
+int
 rte_rawdev_start(uint16_t dev_id)
 {
        struct rte_rawdev *dev;
@@ -272,7 +411,7 @@ rte_rawdev_start(uint16_t dev_id)
        return 0;
 }
 
-void __rte_experimental
+void
 rte_rawdev_stop(uint16_t dev_id)
 {
        struct rte_rawdev *dev;
@@ -294,7 +433,7 @@ rte_rawdev_stop(uint16_t dev_id)
        dev->started = 0;
 }
 
-int __rte_experimental
+int
 rte_rawdev_close(uint16_t dev_id)
 {
        struct rte_rawdev *dev;
@@ -313,7 +452,7 @@ rte_rawdev_close(uint16_t dev_id)
        return (*dev->dev_ops->dev_close)(dev);
 }
 
-int __rte_experimental
+int
 rte_rawdev_reset(uint16_t dev_id)
 {
        struct rte_rawdev *dev;
@@ -340,7 +479,7 @@ rte_rawdev_find_free_device_index(void)
        return RTE_RAWDEV_MAX_DEVS;
 }
 
-struct rte_rawdev * __rte_experimental
+struct rte_rawdev *
 rte_rawdev_pmd_allocate(const char *name, size_t dev_priv_size, int socket_id)
 {
        struct rte_rawdev *rawdev;
@@ -360,20 +499,21 @@ rte_rawdev_pmd_allocate(const char *name, size_t dev_priv_size, int socket_id)
 
        rawdev = &rte_rawdevs[dev_id];
 
-       rawdev->dev_private = rte_zmalloc_socket("rawdev private",
+       if (dev_priv_size > 0) {
+               rawdev->dev_private = rte_zmalloc_socket("rawdev private",
                                     dev_priv_size,
                                     RTE_CACHE_LINE_SIZE,
                                     socket_id);
-       if (!rawdev->dev_private) {
-               RTE_RDEV_ERR("Unable to allocate memory to Skeleton dev");
-               return NULL;
+               if (!rawdev->dev_private) {
+                       RTE_RDEV_ERR("Unable to allocate memory for rawdev");
+                       return NULL;
+               }
        }
 
-
        rawdev->dev_id = dev_id;
        rawdev->socket_id = socket_id;
        rawdev->started = 0;
-       snprintf(rawdev->name, RTE_RAWDEV_NAME_MAX_LEN, "%s", name);
+       strlcpy(rawdev->name, name, RTE_RAWDEV_NAME_MAX_LEN);
 
        rawdev->attached = RTE_RAWDEV_ATTACHED;
        rawdev_globals.nb_devs++;
@@ -381,7 +521,7 @@ rte_rawdev_pmd_allocate(const char *name, size_t dev_priv_size, int socket_id)
        return rawdev;
 }
 
-int __rte_experimental
+int
 rte_rawdev_pmd_release(struct rte_rawdev *rawdev)
 {
        int ret;
@@ -407,12 +547,85 @@ rte_rawdev_pmd_release(struct rte_rawdev *rawdev)
        return 0;
 }
 
-RTE_INIT(librawdev_init_log);
+#ifdef RTE_LIBRTE_TELEMETRY
+static int
+handle_dev_list(const char *cmd __rte_unused,
+               const char *params __rte_unused,
+               struct rte_tel_data *d)
+{
+       int i;
+
+       rte_tel_data_start_array(d, RTE_TEL_INT_VAL);
+       for (i = 0; i < rawdev_globals.nb_devs; i++)
+               if (rte_rawdevices[i].attached == RTE_RAWDEV_ATTACHED)
+                       rte_tel_data_add_array_int(d, i);
+       return 0;
+}
+
+static int
+handle_dev_xstats(const char *cmd __rte_unused,
+               const char *params,
+               struct rte_tel_data *d)
+{
+       uint64_t *rawdev_xstats;
+       struct rte_rawdev_xstats_name *xstat_names;
+       int dev_id, num_xstats, i, ret;
+       unsigned int *ids;
+
+       if (params == NULL || strlen(params) == 0 || !isdigit(*params))
+               return -1;
+
+       dev_id = atoi(params);
+       if (!rte_rawdev_pmd_is_valid_dev(dev_id))
+               return -1;
+
+       num_xstats = xstats_get_count(dev_id);
+       if (num_xstats < 0)
+               return -1;
+
+       /* use one malloc for names, stats and ids */
+       rawdev_xstats = malloc((sizeof(uint64_t) +
+                       sizeof(struct rte_rawdev_xstats_name) +
+                       sizeof(unsigned int)) * num_xstats);
+       if (rawdev_xstats == NULL)
+               return -1;
+       xstat_names = (void *)&rawdev_xstats[num_xstats];
+       ids = (void *)&xstat_names[num_xstats];
+
+       ret = rte_rawdev_xstats_names_get(dev_id, xstat_names, num_xstats);
+       if (ret < 0 || ret > num_xstats) {
+               free(rawdev_xstats);
+               return -1;
+       }
+
+       for (i = 0; i < num_xstats; i++)
+               ids[i] = i;
+
+       ret = rte_rawdev_xstats_get(dev_id, ids, rawdev_xstats, num_xstats);
+       if (ret < 0 || ret > num_xstats) {
+               free(rawdev_xstats);
+               return -1;
+       }
+
+       rte_tel_data_start_dict(d);
+       for (i = 0; i < num_xstats; i++)
+               rte_tel_data_add_dict_u64(d, xstat_names[i].name,
+                               rawdev_xstats[i]);
+
+       free(rawdev_xstats);
+       return 0;
+}
+#endif
 
-static void
-librawdev_init_log(void)
+RTE_INIT(librawdev_init_log)
 {
        librawdev_logtype = rte_log_register("lib.rawdev");
        if (librawdev_logtype >= 0)
                rte_log_set_level(librawdev_logtype, RTE_LOG_INFO);
+#ifdef RTE_LIBRTE_TELEMETRY
+       rte_telemetry_register_cmd("/rawdev/list", handle_dev_list,
+                       "Returns list of available rawdev ports. Takes no parameters");
+       rte_telemetry_register_cmd("/rawdev/xstats", handle_dev_xstats,
+                       "Returns the xstats for a rawdev port. Parameters: int port_id");
+#endif
 }