ethdev: remove DUP action from flow API
[dpdk.git] / lib / librte_ether / rte_flow.c
index 95d9ee0..80f9cb6 100644 (file)
@@ -1,34 +1,6 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright 2016 6WIND S.A.
- *   Copyright 2016 Mellanox.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of 6WIND S.A. nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright 2016 6WIND S.A.
+ * Copyright 2016 Mellanox Technologies, Ltd
  */
 
 #include <errno.h>
@@ -81,6 +53,7 @@ static const struct rte_flow_desc_data rte_flow_desc_item[] = {
        MK_FLOW_ITEM(GRE, sizeof(struct rte_flow_item_gre)),
        MK_FLOW_ITEM(E_TAG, sizeof(struct rte_flow_item_e_tag)),
        MK_FLOW_ITEM(NVGRE, sizeof(struct rte_flow_item_nvgre)),
+       MK_FLOW_ITEM(GENEVE, sizeof(struct rte_flow_item_geneve)),
 };
 
 /** Generate flow_action[] entry. */
@@ -100,12 +73,23 @@ static const struct rte_flow_desc_data rte_flow_desc_action[] = {
        MK_FLOW_ACTION(QUEUE, sizeof(struct rte_flow_action_queue)),
        MK_FLOW_ACTION(DROP, 0),
        MK_FLOW_ACTION(COUNT, 0),
-       MK_FLOW_ACTION(DUP, sizeof(struct rte_flow_action_dup)),
        MK_FLOW_ACTION(RSS, sizeof(struct rte_flow_action_rss)), /* +queue[] */
        MK_FLOW_ACTION(PF, 0),
        MK_FLOW_ACTION(VF, sizeof(struct rte_flow_action_vf)),
 };
 
+static int
+flow_err(uint16_t port_id, int ret, struct rte_flow_error *error)
+{
+       if (ret == 0)
+               return 0;
+       if (rte_eth_dev_is_removed(port_id))
+               return rte_flow_error_set(error, EIO,
+                                         RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
+                                         NULL, rte_strerror(EIO));
+       return ret;
+}
+
 /* Get generic flow operations structure from a port. */
 const struct rte_flow_ops *
 rte_flow_ops_get(uint16_t port_id, struct rte_flow_error *error)
@@ -132,7 +116,7 @@ rte_flow_ops_get(uint16_t port_id, struct rte_flow_error *error)
 
 /* Check whether a flow rule can be created on a given port. */
 int
-rte_flow_validate(uint8_t port_id,
+rte_flow_validate(uint16_t port_id,
                  const struct rte_flow_attr *attr,
                  const struct rte_flow_item pattern[],
                  const struct rte_flow_action actions[],
@@ -144,27 +128,33 @@ rte_flow_validate(uint8_t port_id,
        if (unlikely(!ops))
                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 flow_err(port_id, ops->validate(dev, attr, pattern,
+                                                      actions, error), error);
+       return rte_flow_error_set(error, ENOSYS,
+                                 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
+                                 NULL, rte_strerror(ENOSYS));
 }
 
 /* Create a flow rule on a given port. */
 struct rte_flow *
-rte_flow_create(uint8_t port_id,
+rte_flow_create(uint16_t port_id,
                const struct rte_flow_attr *attr,
                const struct rte_flow_item pattern[],
                const struct rte_flow_action actions[],
                struct rte_flow_error *error)
 {
        struct rte_eth_dev *dev = &rte_eth_devices[port_id];
+       struct rte_flow *flow;
        const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
 
        if (unlikely(!ops))
                return NULL;
-       if (likely(!!ops->create))
-               return ops->create(dev, attr, pattern, actions, error);
+       if (likely(!!ops->create)) {
+               flow = ops->create(dev, attr, pattern, actions, error);
+               if (flow == NULL)
+                       flow_err(port_id, -rte_errno, error);
+               return flow;
+       }
        rte_flow_error_set(error, ENOSYS, RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
                           NULL, rte_strerror(ENOSYS));
        return NULL;
@@ -172,7 +162,7 @@ rte_flow_create(uint8_t port_id,
 
 /* Destroy a flow rule on a given port. */
 int
-rte_flow_destroy(uint8_t port_id,
+rte_flow_destroy(uint16_t port_id,
                 struct rte_flow *flow,
                 struct rte_flow_error *error)
 {
@@ -182,15 +172,16 @@ rte_flow_destroy(uint8_t port_id,
        if (unlikely(!ops))
                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 flow_err(port_id, ops->destroy(dev, flow, error),
+                               error);
+       return rte_flow_error_set(error, ENOSYS,
+                                 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
+                                 NULL, rte_strerror(ENOSYS));
 }
 
 /* Destroy all flow rules associated with a port. */
 int
-rte_flow_flush(uint8_t port_id,
+rte_flow_flush(uint16_t port_id,
               struct rte_flow_error *error)
 {
        struct rte_eth_dev *dev = &rte_eth_devices[port_id];
@@ -199,15 +190,15 @@ rte_flow_flush(uint8_t port_id,
        if (unlikely(!ops))
                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 flow_err(port_id, ops->flush(dev, error), error);
+       return rte_flow_error_set(error, ENOSYS,
+                                 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
+                                 NULL, rte_strerror(ENOSYS));
 }
 
 /* Query an existing flow rule. */
 int
-rte_flow_query(uint8_t port_id,
+rte_flow_query(uint16_t port_id,
               struct rte_flow *flow,
               enum rte_flow_action_type action,
               void *data,
@@ -219,15 +210,16 @@ rte_flow_query(uint8_t port_id,
        if (!ops)
                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 flow_err(port_id, ops->query(dev, flow, action, data,
+                                                   error), error);
+       return rte_flow_error_set(error, ENOSYS,
+                                 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
+                                 NULL, rte_strerror(ENOSYS));
 }
 
 /* Restrict ingress traffic to the defined flow rules. */
 int
-rte_flow_isolate(uint8_t port_id,
+rte_flow_isolate(uint16_t port_id,
                 int set,
                 struct rte_flow_error *error)
 {
@@ -237,66 +229,144 @@ rte_flow_isolate(uint8_t port_id,
        if (!ops)
                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 flow_err(port_id, ops->isolate(dev, set, error), error);
+       return rte_flow_error_set(error, ENOSYS,
+                                 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
+                                 NULL, rte_strerror(ENOSYS));
 }
 
-/** Compute storage space needed by item specification. */
-static void
-flow_item_spec_size(const struct rte_flow_item *item,
-                   size_t *size, size_t *pad)
+/* Initialize flow error structure. */
+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 (!item->spec) {
-               *size = 0;
-               goto empty;
+       if (error) {
+               *error = (struct rte_flow_error){
+                       .type = type,
+                       .cause = cause,
+                       .message = message,
+               };
        }
+       rte_errno = code;
+       return -code;
+}
+
+/** Pattern item specification types. */
+enum item_spec_type {
+       ITEM_SPEC,
+       ITEM_LAST,
+       ITEM_MASK,
+};
+
+/** Compute storage space needed by item specification and copy it. */
+static size_t
+flow_item_spec_copy(void *buf, const struct rte_flow_item *item,
+                   enum item_spec_type type)
+{
+       size_t size = 0;
+       const void *item_spec =
+               type == ITEM_SPEC ? item->spec :
+               type == ITEM_LAST ? item->last :
+               type == ITEM_MASK ? item->mask :
+               NULL;
+
+       if (!item_spec)
+               goto empty;
        switch (item->type) {
                union {
                        const struct rte_flow_item_raw *raw;
-               } spec;
+               } src;
+               union {
+                       struct rte_flow_item_raw *raw;
+               } dst;
 
-       /* Not a fall-through */
        case RTE_FLOW_ITEM_TYPE_RAW:
-               spec.raw = item->spec;
-               *size = offsetof(struct rte_flow_item_raw, pattern) +
-                       spec.raw->length * sizeof(*spec.raw->pattern);
+               src.raw = item_spec;
+               dst.raw = buf;
+               size = offsetof(struct rte_flow_item_raw, pattern) +
+                       src.raw->length * sizeof(*src.raw->pattern);
+               if (dst.raw)
+                       memcpy(dst.raw, src.raw, size);
                break;
        default:
-               *size = rte_flow_desc_item[item->type].size;
+               size = rte_flow_desc_item[item->type].size;
+               if (buf)
+                       memcpy(buf, item_spec, size);
                break;
        }
 empty:
-       *pad = RTE_ALIGN_CEIL(*size, sizeof(double)) - *size;
+       return RTE_ALIGN_CEIL(size, sizeof(double));
 }
 
-/** Compute storage space needed by action configuration. */
-static void
-flow_action_conf_size(const struct rte_flow_action *action,
-                     size_t *size, size_t *pad)
+/** Compute storage space needed by action configuration and copy it. */
+static size_t
+flow_action_conf_copy(void *buf, const struct rte_flow_action *action)
 {
-       if (!action->conf) {
-               *size = 0;
+       size_t size = 0;
+
+       if (!action->conf)
                goto empty;
-       }
        switch (action->type) {
                union {
                        const struct rte_flow_action_rss *rss;
-               } conf;
+               } src;
+               union {
+                       struct rte_flow_action_rss *rss;
+               } dst;
+               size_t off;
 
-       /* Not a fall-through. */
        case RTE_FLOW_ACTION_TYPE_RSS:
-               conf.rss = action->conf;
-               *size = offsetof(struct rte_flow_action_rss, queue) +
-                       conf.rss->num * sizeof(*conf.rss->queue);
+               src.rss = action->conf;
+               dst.rss = buf;
+               off = 0;
+               if (dst.rss)
+                       *dst.rss = (struct rte_flow_action_rss){
+                               .num = src.rss->num,
+                       };
+               off += offsetof(struct rte_flow_action_rss, queue);
+               if (src.rss->num) {
+                       size = sizeof(*src.rss->queue) * src.rss->num;
+                       if (dst.rss)
+                               memcpy(dst.rss->queue, src.rss->queue, size);
+                       off += size;
+               }
+               off = RTE_ALIGN_CEIL(off, sizeof(double));
+               if (dst.rss) {
+                       dst.rss->rss_conf = (void *)((uintptr_t)dst.rss + off);
+                       *(struct rte_eth_rss_conf *)(uintptr_t)
+                               dst.rss->rss_conf = (struct rte_eth_rss_conf){
+                               .rss_key_len = src.rss->rss_conf->rss_key_len,
+                               .rss_hf = src.rss->rss_conf->rss_hf,
+                       };
+               }
+               off += sizeof(*src.rss->rss_conf);
+               if (src.rss->rss_conf->rss_key_len) {
+                       off = RTE_ALIGN_CEIL(off, sizeof(double));
+                       size = sizeof(*src.rss->rss_conf->rss_key) *
+                               src.rss->rss_conf->rss_key_len;
+                       if (dst.rss) {
+                               ((struct rte_eth_rss_conf *)(uintptr_t)
+                                dst.rss->rss_conf)->rss_key =
+                                       (void *)((uintptr_t)dst.rss + off);
+                               memcpy(dst.rss->rss_conf->rss_key,
+                                      src.rss->rss_conf->rss_key,
+                                      size);
+                       }
+                       off += size;
+               }
+               size = off;
                break;
        default:
-               *size = rte_flow_desc_action[action->type].size;
+               size = rte_flow_desc_action[action->type].size;
+               if (buf)
+                       memcpy(buf, action->conf, size);
                break;
        }
 empty:
-       *pad = RTE_ALIGN_CEIL(*size, sizeof(double)) - *size;
+       return RTE_ALIGN_CEIL(size, sizeof(double));
 }
 
 /** Store a full rte_flow description. */
@@ -308,7 +378,6 @@ rte_flow_copy(struct rte_flow_desc *desc, size_t len,
 {
        struct rte_flow_desc *fd = NULL;
        size_t tmp;
-       size_t pad;
        size_t off1 = 0;
        size_t off2 = 0;
        size_t size = 0;
@@ -333,24 +402,26 @@ store:
                                dst = memcpy(fd->data + off1, item,
                                             sizeof(*item));
                        off1 += sizeof(*item);
-                       flow_item_spec_size(item, &tmp, &pad);
                        if (item->spec) {
                                if (fd)
-                                       dst->spec = memcpy(fd->data + off2,
-                                                          item->spec, tmp);
-                               off2 += tmp + pad;
+                                       dst->spec = fd->data + off2;
+                               off2 += flow_item_spec_copy
+                                       (fd ? fd->data + off2 : NULL, item,
+                                        ITEM_SPEC);
                        }
                        if (item->last) {
                                if (fd)
-                                       dst->last = memcpy(fd->data + off2,
-                                                          item->last, tmp);
-                               off2 += tmp + pad;
+                                       dst->last = fd->data + off2;
+                               off2 += flow_item_spec_copy
+                                       (fd ? fd->data + off2 : NULL, item,
+                                        ITEM_LAST);
                        }
                        if (item->mask) {
                                if (fd)
-                                       dst->mask = memcpy(fd->data + off2,
-                                                          item->mask, tmp);
-                               off2 += tmp + pad;
+                                       dst->mask = fd->data + off2;
+                               off2 += flow_item_spec_copy
+                                       (fd ? fd->data + off2 : NULL, item,
+                                        ITEM_MASK);
                        }
                        off2 = RTE_ALIGN_CEIL(off2, sizeof(double));
                } while ((item++)->type != RTE_FLOW_ITEM_TYPE_END);
@@ -375,12 +446,11 @@ store:
                                dst = memcpy(fd->data + off1, action,
                                             sizeof(*action));
                        off1 += sizeof(*action);
-                       flow_action_conf_size(action, &tmp, &pad);
                        if (action->conf) {
                                if (fd)
-                                       dst->conf = memcpy(fd->data + off2,
-                                                          action->conf, tmp);
-                               off2 += tmp + pad;
+                                       dst->conf = fd->data + off2;
+                               off2 += flow_action_conf_copy
+                                       (fd ? fd->data + off2 : NULL, action);
                        }
                        off2 = RTE_ALIGN_CEIL(off2, sizeof(double));
                } while ((action++)->type != RTE_FLOW_ACTION_TYPE_END);