From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm0-f50.google.com (mail-wm0-f50.google.com [74.125.82.50]) by dpdk.org (Postfix) with ESMTP id 320917D04 for ; Thu, 5 Oct 2017 11:49:21 +0200 (CEST) Received: by mail-wm0-f50.google.com with SMTP id 196so1087043wma.1 for ; Thu, 05 Oct 2017 02:49:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=rfovglumW0UtEc3+IXEh3JsBJ/AsYaL/MfyioAw5aog=; b=mG6bM6RWIpXyXDPTbHQAo3TP1JGk3yu8U88ySGvkpS/9rfiWjq6JE2HeE2GEZbuut5 o74uNagLJfh92wA9ttnzgX5Ns+vUXvB6UC0bifSPqvqlzZsdGHmWlDiHZ170gx3OSiLE QvwOcgs5CWcY1tzHEXTG99Htqe1fpzRBKx5+RZVufIbnJCQEUVJIJGaEet8/ARIkOu9M jHshvdtEKuuA1rpX7TjCYRqWx3e/AyPrAPeAYTxDAGJXKVYg4fGW0B8VID6fccWCltxl 7JkDHSoMVMkikZZ+jxESYFEClkOjD2oOZOkRBhdg7hiskSIcXO1+6fcjFYtTpd806QIR TDxA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=rfovglumW0UtEc3+IXEh3JsBJ/AsYaL/MfyioAw5aog=; b=M2giU3qYQS1A8t/VO45Thf91YV7RGHGS0R8tNAJr+tTghC6I4i9q4K6xQYE5Wn7jw9 MyJ0q47pfO7t5WpgJHNmOqGM/vuB6IREKmvQ3ejBy42wQ9FaQ0jFLkjoAIr1dK5QCueO moP0LXwgFlYup+z4WtHrWIKwxUd6WEGgoPLFyCZY2JRc7H03Orh51u2itkFXgCTg7KTf EzvPrUxPtwhwmB4G7mgMP7dsSntIrgKpE/MgY7YRy4iwq7b8dwL/rGQVqnzWY3D1Wim5 GZgc6LBm5IdGF/l6729difl9RV7HsnvrsgzOEnXdUqFM6bnuMxz54m4BpowBsj0W0V2E b+VA== X-Gm-Message-State: AHPjjUidugDW1rXNJ+zJ4j3UJ6jKN6XXHAhpBL6v/47s32SU2EoqArqR fybwjLKjNWHntJXKZ9bpQjax4Q== X-Google-Smtp-Source: AOwi7QCIFjaUyuOO2zF/RWssNphfkVvM4PtCB+f3/u+AT6jmD2KOz8KptZ+SJCrwl7n+tW4tBTDVMQ== X-Received: by 10.80.219.66 with SMTP id b2mr32556567edl.256.1507196961494; Thu, 05 Oct 2017 02:49:21 -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 e6sm15049856eda.66.2017.10.05.02.49.20 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 05 Oct 2017 02:49:20 -0700 (PDT) From: Adrien Mazarguil To: Ferruh Yigit , Gaetan Rivet Cc: dev@dpdk.org Date: Thu, 5 Oct 2017 11:49:02 +0200 Message-Id: <00db12469380e587ac434bfc5c63795e32cfddef.1507193185.git.adrien.mazarguil@6wind.com> X-Mailer: git-send-email 2.1.4 In-Reply-To: References: Subject: [dpdk-dev] [PATCH v1 1/7] ethdev: expose flow API error helper 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: Thu, 05 Oct 2017 09:49:22 -0000 rte_flow_error_set() is a convenient helper to initialize error objects. Since there is no fundamental reason to prevent applications from using it, expose it through the public interface after modifying its return value from positive to negative. This is done for consistency with the rest of the public interface. Documentation is updated accordingly. Signed-off-by: Adrien Mazarguil --- doc/guides/prog_guide/rte_flow.rst | 23 +++++++++++++++++--- drivers/net/mlx4/mlx4_flow.c | 6 +++--- drivers/net/tap/tap_flow.c | 2 +- lib/librte_ether/rte_flow.c | 30 +++++++++++++------------- lib/librte_ether/rte_flow.h | 36 +++++++++++++++++++++++++++++++ lib/librte_ether/rte_flow_driver.h | 38 --------------------------------- 6 files changed, 75 insertions(+), 60 deletions(-) diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst index 662a912..565a809 100644 --- a/doc/guides/prog_guide/rte_flow.rst +++ b/doc/guides/prog_guide/rte_flow.rst @@ -1678,6 +1678,25 @@ freed by the application, however its pointer can be considered valid only as long as its associated DPDK port remains configured. Closing the underlying device or unloading the PMD invalidates it. +Helpers +------- + +Error initializer +~~~~~~~~~~~~~~~~~ + +.. code-block:: c + + static inline int + rte_flow_error_set(struct rte_flow_error *error, + int code, + enum rte_flow_error_type type, + const void *cause, + const char *message); + +This function initializes ``error`` (if non-NULL) with the provided +parameters and sets ``rte_errno`` to ``code``. A negative error ``code`` is +then returned. + Caveats ------- @@ -1743,13 +1762,11 @@ the legacy filtering framework, which should eventually disappear. whatsoever). They only make sure these callbacks are non-NULL or return the ``ENOSYS`` (function not supported) error. -This interface additionally defines the following helper functions: +This interface additionally defines the following helper function: - ``rte_flow_ops_get()``: get generic flow operations structure from a port. -- ``rte_flow_error_set()``: initialize generic flow error structure. - More will be added over time. Device compatibility diff --git a/drivers/net/mlx4/mlx4_flow.c b/drivers/net/mlx4/mlx4_flow.c index 0885a91..018843b 100644 --- a/drivers/net/mlx4/mlx4_flow.c +++ b/drivers/net/mlx4/mlx4_flow.c @@ -955,9 +955,9 @@ mlx4_flow_isolate(struct rte_eth_dev *dev, mlx4_mac_addr_del(priv); } else if (mlx4_mac_addr_add(priv) < 0) { priv->isolated = 1; - return -rte_flow_error_set(error, rte_errno, - RTE_FLOW_ERROR_TYPE_UNSPECIFIED, - NULL, "cannot leave isolated mode"); + return rte_flow_error_set(error, rte_errno, + RTE_FLOW_ERROR_TYPE_UNSPECIFIED, + NULL, "cannot leave isolated mode"); } return 0; } diff --git a/drivers/net/tap/tap_flow.c b/drivers/net/tap/tap_flow.c index eefa868..a790946 100644 --- a/drivers/net/tap/tap_flow.c +++ b/drivers/net/tap/tap_flow.c @@ -1447,7 +1447,7 @@ tap_flow_isolate(struct rte_eth_dev *dev, return 0; error: pmd->flow_isolate = 0; - return -rte_flow_error_set( + return rte_flow_error_set( error, ENOTSUP, RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL, "TC rule creation failed"); } diff --git a/lib/librte_ether/rte_flow.c b/lib/librte_ether/rte_flow.c index 2001fbb..34ce516 100644 --- a/lib/librte_ether/rte_flow.c +++ b/lib/librte_ether/rte_flow.c @@ -145,9 +145,9 @@ rte_flow_validate(uint8_t port_id, return -rte_errno; if (likely(!!ops->validate)) return ops->validate(dev, attr, pattern, actions, error); - return -rte_flow_error_set(error, ENOSYS, - RTE_FLOW_ERROR_TYPE_UNSPECIFIED, - NULL, rte_strerror(ENOSYS)); + return rte_flow_error_set(error, ENOSYS, + RTE_FLOW_ERROR_TYPE_UNSPECIFIED, + NULL, rte_strerror(ENOSYS)); } /* Create a flow rule on a given port. */ @@ -183,9 +183,9 @@ rte_flow_destroy(uint8_t port_id, return -rte_errno; if (likely(!!ops->destroy)) return ops->destroy(dev, flow, error); - return -rte_flow_error_set(error, ENOSYS, - RTE_FLOW_ERROR_TYPE_UNSPECIFIED, - NULL, rte_strerror(ENOSYS)); + return rte_flow_error_set(error, ENOSYS, + RTE_FLOW_ERROR_TYPE_UNSPECIFIED, + NULL, rte_strerror(ENOSYS)); } /* Destroy all flow rules associated with a port. */ @@ -200,9 +200,9 @@ rte_flow_flush(uint8_t port_id, return -rte_errno; if (likely(!!ops->flush)) return ops->flush(dev, error); - return -rte_flow_error_set(error, ENOSYS, - RTE_FLOW_ERROR_TYPE_UNSPECIFIED, - NULL, rte_strerror(ENOSYS)); + return rte_flow_error_set(error, ENOSYS, + RTE_FLOW_ERROR_TYPE_UNSPECIFIED, + NULL, rte_strerror(ENOSYS)); } /* Query an existing flow rule. */ @@ -220,9 +220,9 @@ rte_flow_query(uint8_t port_id, return -rte_errno; if (likely(!!ops->query)) return ops->query(dev, flow, action, data, error); - return -rte_flow_error_set(error, ENOSYS, - RTE_FLOW_ERROR_TYPE_UNSPECIFIED, - NULL, rte_strerror(ENOSYS)); + return rte_flow_error_set(error, ENOSYS, + RTE_FLOW_ERROR_TYPE_UNSPECIFIED, + NULL, rte_strerror(ENOSYS)); } /* Restrict ingress traffic to the defined flow rules. */ @@ -238,9 +238,9 @@ rte_flow_isolate(uint8_t port_id, return -rte_errno; if (likely(!!ops->isolate)) return ops->isolate(dev, set, error); - return -rte_flow_error_set(error, ENOSYS, - RTE_FLOW_ERROR_TYPE_UNSPECIFIED, - NULL, rte_strerror(ENOSYS)); + return rte_flow_error_set(error, ENOSYS, + RTE_FLOW_ERROR_TYPE_UNSPECIFIED, + NULL, rte_strerror(ENOSYS)); } /** Compute storage space needed by item specification. */ diff --git a/lib/librte_ether/rte_flow.h b/lib/librte_ether/rte_flow.h index bba6169..ec42f02 100644 --- a/lib/librte_ether/rte_flow.h +++ b/lib/librte_ether/rte_flow.h @@ -43,6 +43,7 @@ */ #include +#include #include #include #include @@ -1270,6 +1271,41 @@ int rte_flow_isolate(uint8_t port_id, int set, struct rte_flow_error *error); /** + * Initialize flow error structure. + * + * @param[out] error + * Pointer to flow error structure (may be NULL). + * @param code + * Related error code (rte_errno). + * @param type + * Cause field and error types. + * @param cause + * Object responsible for the error. + * @param message + * Human-readable error message. + * + * @return + * Negative error code (errno value) and rte_errno is set. + */ +static inline int +rte_flow_error_set(struct rte_flow_error *error, + int code, + enum rte_flow_error_type type, + const void *cause, + const char *message) +{ + if (error) { + *error = (struct rte_flow_error){ + .type = type, + .cause = cause, + .message = message, + }; + } + rte_errno = code; + return -code; +} + +/** * Generic flow representation. * * This form is sufficient to describe an rte_flow independently from any diff --git a/lib/librte_ether/rte_flow_driver.h b/lib/librte_ether/rte_flow_driver.h index 4d95391..ea92fe7 100644 --- a/lib/librte_ether/rte_flow_driver.h +++ b/lib/librte_ether/rte_flow_driver.h @@ -45,7 +45,6 @@ #include -#include #include "rte_ethdev.h" #include "rte_flow.h" @@ -128,43 +127,6 @@ struct rte_flow_ops { }; /** - * Initialize generic flow error structure. - * - * This function also sets rte_errno to a given value. - * - * @param[out] error - * Pointer to flow error structure (may be NULL). - * @param code - * Related error code (rte_errno). - * @param type - * Cause field and error types. - * @param cause - * Object responsible for the error. - * @param message - * Human-readable error message. - * - * @return - * Error code. - */ -static inline int -rte_flow_error_set(struct rte_flow_error *error, - int code, - enum rte_flow_error_type type, - const void *cause, - const char *message) -{ - if (error) { - *error = (struct rte_flow_error){ - .type = type, - .cause = cause, - .message = message, - }; - } - rte_errno = code; - return code; -} - -/** * Get generic flow operations structure from a port. * * @param port_id -- 2.1.4