From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wr1-f51.google.com (mail-wr1-f51.google.com [209.85.221.51]) by dpdk.org (Postfix) with ESMTP id CBB2B1B57A for ; Fri, 3 Aug 2018 15:36:52 +0200 (CEST) Received: by mail-wr1-f51.google.com with SMTP id e7-v6so5433979wrs.9 for ; Fri, 03 Aug 2018 06:36:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to; bh=S6rV3tMI0FLqVOqherKocL4VRIZ/qnW7GgipmNuodTE=; b=GtLaQAve8Xr1UgTV/40+kim9hF/sh9Qbn16EqHBTQdQQmFfoJKJvUSMfi4ifLY7+Nw uTpUXf7FfXWwijDBYLQ4PQhktF9qOb4e65Ae9tLwwqQ7vcB7Tbjs8uQAahQtiDTs5Lbq VBWaZsWxmk9GZXy3iuWvreDd6RruGYNI/pQZHg1wskiOO+7RKHujhhrpXt2tVlNtvnnA JJ3mnZNoNpXgGosAncVQX0ZowcN/Gp6wcWNMUmGtI6T3K7XA/0IWd1x4UB+m2TLEKP7k nfl/LWZdJ7SgdI9pb/cTDTAJY5LfRsWaGAuESWD0eqi2g597IgdOVbq3RC9BvpgsvMyd YpRA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=S6rV3tMI0FLqVOqherKocL4VRIZ/qnW7GgipmNuodTE=; b=YsEOxy/+8PRC81hS6u2iEUMG+QCuecBgSpEHf/5Dz9PTI7z2hdKcVDBXx4i5HCMcaW oixACh8f8OweyoE8U+XaGmX9DPFrYlJ6jvSjj0fplKUWCKFgb3bpdsL8M8l9mtXMA6GI id5XTTa9v5GSwRj4UaPmCOs8sy49ntJoz3O+YCkV5i7ahkFsuS/EEQ9uktTgW/9WCYlw Y7XRq5dIxjjnSzYa+6veOy2vrdYNoal8PTKu/nZiwXhjcMk3bI+w4b8hDogTtTMSH55S Q0T/WU6O/WYVVhGcFGkXN2d+S9mbkvpc43ykISfCRmWkCLrdpsRn6G3KFkM2zv5jGWAU 7wrQ== X-Gm-Message-State: AOUpUlGnfNfIj3uPciBGPO9AkNMrJRv0GgnI7TvpUG3sRUmKMIvG4AbW VVVcKtLHmiyEueKmx4QN0L8KXA== X-Google-Smtp-Source: AAOMgpe7UztSRRVYxXprJx5/hoV+rA9c5vw3NuNLeOHjcMvP5WsgwR35uVZYhn6EaGTphFF0p40yqQ== X-Received: by 2002:adf:e190:: with SMTP id k16-v6mr2690423wri.36.1533303412465; Fri, 03 Aug 2018 06:36:52 -0700 (PDT) Received: from 6wind.com (host.78.145.23.62.rev.coltfrance.com. [62.23.145.78]) by smtp.gmail.com with ESMTPSA id o14-v6sm7342079wmd.35.2018.08.03.06.36.51 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 03 Aug 2018 06:36:51 -0700 (PDT) Date: Fri, 3 Aug 2018 15:36:34 +0200 From: Adrien Mazarguil To: Ferruh Yigit Cc: dev@dpdk.org, Thomas Monjalon , Andrew Rybchenko Message-ID: <20180803132032.29038-3-adrien.mazarguil@6wind.com> References: <20180803132032.29038-1-adrien.mazarguil@6wind.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20180803132032.29038-1-adrien.mazarguil@6wind.com> X-Mailer: git-send-email 2.11.0 Subject: [dpdk-dev] [PATCH v2 2/7] ethdev: add flow API item/action name conversion X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 03 Aug 2018 13:36:53 -0000 This provides a means for applications to retrieve the name of flow pattern items and actions. Signed-off-by: Adrien Mazarguil Cc: Thomas Monjalon Cc: Ferruh Yigit Cc: Andrew Rybchenko -- v2 changes: - Replaced rte_flow_conv_name_ptr() with extra is_ptr argument to rte_flow_conv_name() since both functions were almost identical. - Properly documented internal helper functions. --- doc/guides/prog_guide/rte_flow.rst | 1 + lib/librte_ethdev/rte_flow.c | 63 +++++++++++++++++++++++++++++++++ lib/librte_ethdev/rte_flow.h | 56 +++++++++++++++++++++++++++++ 3 files changed, 120 insertions(+) diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst index 964cf9ceb..1b17f6e01 100644 --- a/doc/guides/prog_guide/rte_flow.rst +++ b/doc/guides/prog_guide/rte_flow.rst @@ -2437,6 +2437,7 @@ operations include: - Attributes, pattern item or action duplication. - Duplication of an entire pattern or list of actions. - Duplication of a complete flow rule description. +- Pattern item or action name retrieval. Caveats ------- diff --git a/lib/librte_ethdev/rte_flow.c b/lib/librte_ethdev/rte_flow.c index 930fe09c8..5d487c108 100644 --- a/lib/librte_ethdev/rte_flow.c +++ b/lib/librte_ethdev/rte_flow.c @@ -11,6 +11,7 @@ #include #include #include +#include #include "rte_ethdev.h" #include "rte_flow_driver.h" #include "rte_flow.h" @@ -679,6 +680,60 @@ rte_flow_conv_rule(struct rte_flow_conv_rule *dst, return off; } +/** + * Retrieve the name of a pattern item/action type. + * + * @param is_action + * Nonzero when @p src represents an action type instead of a pattern item + * type. + * @param is_ptr + * Nonzero to write string address instead of contents into @p dst. + * @param[out] dst + * Destination buffer. Can be NULL if @p size is zero. + * @param size + * Size of @p dst in bytes. + * @param[in] src + * Depending on @p is_action, source pattern item or action type cast as a + * pointer. + * @param[out] error + * Perform verbose error reporting if not NULL. + * + * @return + * A positive value representing the number of bytes needed to store the + * name or its address regardless of @p size on success (@p buf contents + * are truncated to @p size if not large enough), a negative errno value + * otherwise and rte_errno is set. + */ +static int +rte_flow_conv_name(int is_action, + int is_ptr, + char *dst, + const size_t size, + const void *src, + struct rte_flow_error *error) +{ + struct desc_info { + const struct rte_flow_desc_data *data; + size_t num; + }; + static const struct desc_info info_rep[2] = { + { rte_flow_desc_item, RTE_DIM(rte_flow_desc_item), }, + { rte_flow_desc_action, RTE_DIM(rte_flow_desc_action), }, + }; + const struct desc_info *const info = &info_rep[!!is_action]; + unsigned int type = (uintptr_t)src; + + if (type >= info->num) + return rte_flow_error_set + (error, EINVAL, RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL, + "unknown object type to retrieve the name of"); + if (!is_ptr) + return strlcpy(dst, info->data[type].name, size); + if (size >= sizeof(const char **)) + *((const char **)dst) = info->data[type].name; + return sizeof(const char **); +} + /** Helper function to convert flow API objects. */ int rte_flow_conv(enum rte_flow_conv_op op, @@ -708,6 +763,14 @@ rte_flow_conv(enum rte_flow_conv_op op, return rte_flow_conv_actions(dst, size, src, 0, error); case RTE_FLOW_CONV_OP_RULE: return rte_flow_conv_rule(dst, size, src, error); + case RTE_FLOW_CONV_OP_ITEM_NAME: + return rte_flow_conv_name(0, 0, dst, size, src, error); + case RTE_FLOW_CONV_OP_ACTION_NAME: + return rte_flow_conv_name(1, 0, dst, size, src, error); + case RTE_FLOW_CONV_OP_ITEM_NAME_PTR: + return rte_flow_conv_name(0, 1, dst, size, src, error); + case RTE_FLOW_CONV_OP_ACTION_NAME_PTR: + return rte_flow_conv_name(1, 1, dst, size, src, error); } return rte_flow_error_set (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL, diff --git a/lib/librte_ethdev/rte_flow.h b/lib/librte_ethdev/rte_flow.h index 71dc30e4c..c48ea8a51 100644 --- a/lib/librte_ethdev/rte_flow.h +++ b/lib/librte_ethdev/rte_flow.h @@ -2043,6 +2043,62 @@ enum rte_flow_conv_op { * @code struct rte_flow_conv_rule * @endcode */ RTE_FLOW_CONV_OP_RULE, + + /** + * Convert item type to its name string. + * + * Writes a NUL-terminated string to @p dst. Like snprintf(), the + * returned value excludes the terminator which is always written + * nonetheless. + * + * - @p src type: + * @code (const void *)enum rte_flow_item_type @endcode + * - @p dst type: + * @code char * @endcode + **/ + RTE_FLOW_CONV_OP_ITEM_NAME, + + /** + * Convert action type to its name string. + * + * Writes a NUL-terminated string to @p dst. Like snprintf(), the + * returned value excludes the terminator which is always written + * nonetheless. + * + * - @p src type: + * @code (const void *)enum rte_flow_action_type @endcode + * - @p dst type: + * @code char * @endcode + **/ + RTE_FLOW_CONV_OP_ACTION_NAME, + + /** + * Convert item type to pointer to item name. + * + * Retrieves item name pointer from its type. The string itself is + * not copied; instead, a unique pointer to an internal static + * constant storage is written to @p dst. + * + * - @p src type: + * @code (const void *)enum rte_flow_item_type @endcode + * - @p dst type: + * @code const char ** @endcode + */ + RTE_FLOW_CONV_OP_ITEM_NAME_PTR, + + /** + * Convert action type to pointer to action name. + * + * Retrieves action name pointer from its type. The string itself is + * not copied; instead, a unique pointer to an internal static + * constant storage is written to @p dst. + * + * - @p src type: + * @code (const void *)enum rte_flow_action_type @endcode + * - @p dst type: + * @code const char ** @endcode + */ + RTE_FLOW_CONV_OP_ACTION_NAME_PTR, }; /** -- 2.11.0