net/failsafe: use SPDX tags in 6WIND copyrighted files
[dpdk.git] / drivers / net / failsafe / failsafe_ether.c
index 7910952..4c6e938 100644 (file)
@@ -1,40 +1,73 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright 2017 6WIND S.A.
- *   Copyright 2017 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 2017 6WIND S.A.
+ * Copyright 2017 Mellanox.
  */
 
 #include <unistd.h>
 
+#include <rte_flow.h>
+#include <rte_flow_driver.h>
+#include <rte_cycles.h>
+
 #include "failsafe_private.h"
 
+/** Print a message out of a flow error. */
+static int
+fs_flow_complain(struct rte_flow_error *error)
+{
+       static const char *const errstrlist[] = {
+               [RTE_FLOW_ERROR_TYPE_NONE] = "no error",
+               [RTE_FLOW_ERROR_TYPE_UNSPECIFIED] = "cause unspecified",
+               [RTE_FLOW_ERROR_TYPE_HANDLE] = "flow rule (handle)",
+               [RTE_FLOW_ERROR_TYPE_ATTR_GROUP] = "group field",
+               [RTE_FLOW_ERROR_TYPE_ATTR_PRIORITY] = "priority field",
+               [RTE_FLOW_ERROR_TYPE_ATTR_INGRESS] = "ingress field",
+               [RTE_FLOW_ERROR_TYPE_ATTR_EGRESS] = "egress field",
+               [RTE_FLOW_ERROR_TYPE_ATTR] = "attributes structure",
+               [RTE_FLOW_ERROR_TYPE_ITEM_NUM] = "pattern length",
+               [RTE_FLOW_ERROR_TYPE_ITEM] = "specific pattern item",
+               [RTE_FLOW_ERROR_TYPE_ACTION_NUM] = "number of actions",
+               [RTE_FLOW_ERROR_TYPE_ACTION] = "specific action",
+       };
+       const char *errstr;
+       char buf[32];
+       int err = rte_errno;
+
+       if ((unsigned int)error->type >= RTE_DIM(errstrlist) ||
+                       !errstrlist[error->type])
+               errstr = "unknown type";
+       else
+               errstr = errstrlist[error->type];
+       ERROR("Caught error type %d (%s): %s%s\n",
+               error->type, errstr,
+               error->cause ? (snprintf(buf, sizeof(buf), "cause: %p, ",
+                               error->cause), buf) : "",
+               error->message ? error->message : "(no stated reason)");
+       return -err;
+}
+
+static int
+eth_dev_flow_isolate_set(struct rte_eth_dev *dev,
+                        struct sub_device *sdev)
+{
+       struct rte_flow_error ferror;
+       int ret;
+
+       if (!PRIV(dev)->flow_isolated) {
+               DEBUG("Flow isolation already disabled");
+       } else {
+               DEBUG("Enabling flow isolation");
+               ret = rte_flow_isolate(PORT_ID(sdev),
+                                      PRIV(dev)->flow_isolated,
+                                      &ferror);
+               if (ret) {
+                       fs_flow_complain(&ferror);
+                       return ret;
+               }
+       }
+       return 0;
+}
+
 static int
 fs_eth_dev_conf_apply(struct rte_eth_dev *dev,
                struct sub_device *sdev)
@@ -42,6 +75,8 @@ fs_eth_dev_conf_apply(struct rte_eth_dev *dev,
        struct rte_eth_dev *edev;
        struct rte_vlan_filter_conf *vfc1;
        struct rte_vlan_filter_conf *vfc2;
+       struct rte_flow *flow;
+       struct rte_flow_error ferror;
        uint32_t i;
        int ret;
 
@@ -141,6 +176,7 @@ fs_eth_dev_conf_apply(struct rte_eth_dev *dev,
 
                        ether_format_addr(ea_fmt, ETHER_ADDR_FMT_SIZE, ea);
                        ERROR("Adding MAC address %s failed", ea_fmt);
+                       return ret;
                }
        }
        /* VLAN filter */
@@ -177,9 +213,125 @@ fs_eth_dev_conf_apply(struct rte_eth_dev *dev,
        } else {
                DEBUG("VLAN filter already set");
        }
+       /* rte_flow */
+       if (TAILQ_EMPTY(&PRIV(dev)->flow_list)) {
+               DEBUG("rte_flow already set");
+       } else {
+               DEBUG("Resetting rte_flow configuration");
+               ret = rte_flow_flush(PORT_ID(sdev), &ferror);
+               if (ret) {
+                       fs_flow_complain(&ferror);
+                       return ret;
+               }
+               i = 0;
+               rte_errno = 0;
+               DEBUG("Configuring rte_flow");
+               TAILQ_FOREACH(flow, &PRIV(dev)->flow_list, next) {
+                       DEBUG("Creating flow #%" PRIu32, i++);
+                       flow->flows[SUB_ID(sdev)] =
+                               rte_flow_create(PORT_ID(sdev),
+                                               &flow->fd->attr,
+                                               flow->fd->items,
+                                               flow->fd->actions,
+                                               &ferror);
+                       ret = rte_errno;
+                       if (ret)
+                               break;
+               }
+               if (ret) {
+                       fs_flow_complain(&ferror);
+                       return ret;
+               }
+       }
        return 0;
 }
 
+static void
+fs_dev_remove(struct sub_device *sdev)
+{
+       int ret;
+
+       if (sdev == NULL)
+               return;
+       switch (sdev->state) {
+       case DEV_STARTED:
+               failsafe_rx_intr_uninstall_subdevice(sdev);
+               rte_eth_dev_stop(PORT_ID(sdev));
+               sdev->state = DEV_ACTIVE;
+               /* fallthrough */
+       case DEV_ACTIVE:
+               rte_eth_dev_close(PORT_ID(sdev));
+               sdev->state = DEV_PROBED;
+               /* fallthrough */
+       case DEV_PROBED:
+               ret = rte_eal_hotplug_remove(sdev->bus->name,
+                                            sdev->dev->name);
+               if (ret) {
+                       ERROR("Bus detach failed for sub_device %u",
+                             SUB_ID(sdev));
+               } else {
+                       rte_eth_dev_release_port(ETH(sdev));
+               }
+               sdev->state = DEV_PARSED;
+               /* fallthrough */
+       case DEV_PARSED:
+       case DEV_UNDEFINED:
+               sdev->state = DEV_UNDEFINED;
+               /* the end */
+               break;
+       }
+       failsafe_hotplug_alarm_install(sdev->fs_dev);
+}
+
+static void
+fs_dev_stats_save(struct sub_device *sdev)
+{
+       struct rte_eth_stats stats;
+       int err;
+
+       /* Attempt to read current stats. */
+       err = rte_eth_stats_get(PORT_ID(sdev), &stats);
+       if (err) {
+               uint64_t timestamp = sdev->stats_snapshot.timestamp;
+
+               WARN("Could not access latest statistics from sub-device %d.\n",
+                        SUB_ID(sdev));
+               if (timestamp != 0)
+                       WARN("Using latest snapshot taken before %"PRIu64" seconds.\n",
+                                (rte_rdtsc() - timestamp) / rte_get_tsc_hz());
+       }
+       failsafe_stats_increment(&PRIV(sdev->fs_dev)->stats_accumulator,
+                       err ? &sdev->stats_snapshot.stats : &stats);
+       memset(&sdev->stats_snapshot, 0, sizeof(sdev->stats_snapshot));
+}
+
+static inline int
+fs_rxtx_clean(struct sub_device *sdev)
+{
+       uint16_t i;
+
+       for (i = 0; i < ETH(sdev)->data->nb_rx_queues; i++)
+               if (FS_ATOMIC_RX(sdev, i))
+                       return 0;
+       for (i = 0; i < ETH(sdev)->data->nb_tx_queues; i++)
+               if (FS_ATOMIC_TX(sdev, i))
+                       return 0;
+       return 1;
+}
+
+void
+failsafe_dev_remove(struct rte_eth_dev *dev)
+{
+       struct sub_device *sdev;
+       uint8_t i;
+
+       FOREACH_SUBDEV_STATE(sdev, i, dev, DEV_ACTIVE)
+               if (sdev->remove && fs_rxtx_clean(sdev)) {
+                       fs_dev_stats_save(sdev);
+                       fs_dev_remove(sdev);
+               }
+}
+
 int
 failsafe_eth_dev_state_sync(struct rte_eth_dev *dev)
 {
@@ -188,28 +340,42 @@ failsafe_eth_dev_state_sync(struct rte_eth_dev *dev)
        int ret;
        uint8_t i;
 
+       if (PRIV(dev)->state < DEV_PARSED)
+               return 0;
+
+       ret = failsafe_args_parse_subs(dev);
+       if (ret)
+               goto err_remove;
+
        if (PRIV(dev)->state < DEV_PROBED)
                return 0;
        ret = failsafe_eal_init(dev);
        if (ret)
-               return ret;
+               goto err_remove;
        if (PRIV(dev)->state < DEV_ACTIVE)
                return 0;
        inactive = 0;
-       FOREACH_SUBDEV(sdev, i, dev)
-               if (sdev->state == DEV_PROBED)
+       FOREACH_SUBDEV(sdev, i, dev) {
+               if (sdev->state == DEV_PROBED) {
                        inactive |= UINT32_C(1) << i;
+                       ret = eth_dev_flow_isolate_set(dev, sdev);
+                       if (ret) {
+                               ERROR("Could not apply configuration to sub_device %d",
+                                     i);
+                               goto err_remove;
+                       }
+               }
+       }
        ret = dev->dev_ops->dev_configure(dev);
        if (ret)
-               return ret;
+               goto err_remove;
        FOREACH_SUBDEV(sdev, i, dev) {
                if (inactive & (UINT32_C(1) << i)) {
                        ret = fs_eth_dev_conf_apply(dev, sdev);
                        if (ret) {
                                ERROR("Could not apply configuration to sub_device %d",
                                      i);
-                               /* TODO: disable device */
-                               return ret;
+                               goto err_remove;
                        }
                }
        }
@@ -223,6 +389,71 @@ failsafe_eth_dev_state_sync(struct rte_eth_dev *dev)
                return 0;
        ret = dev->dev_ops->dev_start(dev);
        if (ret)
-               return ret;
+               goto err_remove;
        return 0;
+err_remove:
+       FOREACH_SUBDEV(sdev, i, dev)
+               if (sdev->state != PRIV(dev)->state)
+                       sdev->remove = 1;
+       return ret;
+}
+
+void
+failsafe_stats_increment(struct rte_eth_stats *to, struct rte_eth_stats *from)
+{
+       uint32_t i;
+
+       RTE_ASSERT(to != NULL && from != NULL);
+       to->ipackets += from->ipackets;
+       to->opackets += from->opackets;
+       to->ibytes += from->ibytes;
+       to->obytes += from->obytes;
+       to->imissed += from->imissed;
+       to->ierrors += from->ierrors;
+       to->oerrors += from->oerrors;
+       to->rx_nombuf += from->rx_nombuf;
+       for (i = 0; i < RTE_ETHDEV_QUEUE_STAT_CNTRS; i++) {
+               to->q_ipackets[i] += from->q_ipackets[i];
+               to->q_opackets[i] += from->q_opackets[i];
+               to->q_ibytes[i] += from->q_ibytes[i];
+               to->q_obytes[i] += from->q_obytes[i];
+               to->q_errors[i] += from->q_errors[i];
+       }
+}
+
+int
+failsafe_eth_rmv_event_callback(uint16_t port_id __rte_unused,
+                               enum rte_eth_event_type event __rte_unused,
+                               void *cb_arg, void *out __rte_unused)
+{
+       struct sub_device *sdev = cb_arg;
+
+       /* Switch as soon as possible tx_dev. */
+       fs_switch_dev(sdev->fs_dev, sdev);
+       /* Use safe bursts in any case. */
+       set_burst_fn(sdev->fs_dev, 1);
+       /*
+        * Async removal, the sub-PMD will try to unregister
+        * the callback at the source of the current thread context.
+        */
+       sdev->remove = 1;
+       return 0;
+}
+
+int
+failsafe_eth_lsc_event_callback(uint16_t port_id __rte_unused,
+                               enum rte_eth_event_type event __rte_unused,
+                               void *cb_arg, void *out __rte_unused)
+{
+       struct rte_eth_dev *dev = cb_arg;
+       int ret;
+
+       ret = dev->dev_ops->link_update(dev, 0);
+       /* We must pass on the LSC event */
+       if (ret)
+               return _rte_eth_dev_callback_process(dev,
+                                                    RTE_ETH_EVENT_INTR_LSC,
+                                                    NULL);
+       else
+               return 0;
 }