drivers/net/failsafe/failsafe_private.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright 2017 6WIND S.A.
   5  *   Copyright 2017 Mellanox.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of 6WIND S.A. nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _RTE_ETH_FAILSAFE_PRIVATE_H_
  35 #define _RTE_ETH_FAILSAFE_PRIVATE_H_
  36
  37 #include <sys/queue.h>
  38
  39 #include <rte_atomic.h>
  40 #include <rte_dev.h>
  41 #include <rte_ethdev.h>
  42 #include <rte_devargs.h>
  43
  44 #define FAILSAFE_DRIVER_NAME "Fail-safe PMD"
  45
  46 #define PMD_FAILSAFE_MAC_KVARG "mac"
  47 #define PMD_FAILSAFE_HOTPLUG_POLL_KVARG "hotplug_poll"
  48 #define PMD_FAILSAFE_PARAM_STRING       \
  49         "dev(<ifc>),"                   \
  50         "exec(<shell command>),"        \
  51         "mac=mac_addr,"                 \
  52         "hotplug_poll=u64"              \
  53         ""
  54
  55 #define FAILSAFE_HOTPLUG_DEFAULT_TIMEOUT_MS 2000
  56
  57 #define FAILSAFE_MAX_ETHPORTS 2
  58 #define FAILSAFE_MAX_ETHADDR 128
  59
  60 /* TYPES */
  61
  62 struct rxq {
  63         struct fs_priv *priv;
  64         uint16_t qid;
  65         /* id of last sub_device polled */
  66         uint8_t last_polled;
  67         unsigned int socket_id;
  68         struct rte_eth_rxq_info info;
  69         rte_atomic64_t refcnt[];
  70 };
  71
  72 struct txq {
  73         struct fs_priv *priv;
  74         uint16_t qid;
  75         unsigned int socket_id;
  76         struct rte_eth_txq_info info;
  77         rte_atomic64_t refcnt[];
  78 };
  79
  80 struct rte_flow {
  81         TAILQ_ENTRY(rte_flow) next;
  82         /* sub_flows */
  83         struct rte_flow *flows[FAILSAFE_MAX_ETHPORTS];
  84         /* flow description for synchronization */
  85         struct rte_flow_desc *fd;
  86 };
  87
  88 enum dev_state {
  89         DEV_UNDEFINED,
  90         DEV_PARSED,
  91         DEV_PROBED,
  92         DEV_ACTIVE,
  93         DEV_STARTED,
  94 };
  95
  96 struct sub_device {
  97         /* Exhaustive DPDK device description */
  98         struct rte_devargs devargs;
  99         struct rte_bus *bus;
 100         struct rte_device *dev;
 101         struct rte_eth_dev *edev;
 102         uint8_t sid;
 103         /* Device state machine */
 104         enum dev_state state;
 105         /* Some device are defined as a command line */
 106         char *cmdline;
 107         /* fail-safe device backreference */
 108         struct rte_eth_dev *fs_dev;
 109         /* flag calling for recollection */
 110         volatile unsigned int remove:1;
 111 };
 112
 113 struct fs_priv {
 114         struct rte_eth_dev *dev;
 115         /*
 116          * Set of sub_devices.
 117          * subs[0] is the preferred device
 118          * any other is just another slave
 119          */
 120         struct sub_device *subs;
 121         uint8_t subs_head; /* if head == tail, no subs */
 122         uint8_t subs_tail; /* first invalid */
 123         uint8_t subs_tx; /* current emitting device */
 124         uint8_t current_probed;
 125         /* flow mapping */
 126         TAILQ_HEAD(sub_flows, rte_flow) flow_list;
 127         /* current number of mac_addr slots allocated. */
 128         uint32_t nb_mac_addr;
 129         struct ether_addr mac_addrs[FAILSAFE_MAX_ETHADDR];
 130         uint32_t mac_addr_pool[FAILSAFE_MAX_ETHADDR];
 131         /* current capabilities */
 132         struct rte_eth_dev_info infos;
 133         /*
 134          * Fail-safe state machine.
 135          * This level will be tracking state of the EAL and eth
 136          * layer at large as defined by the user application.
 137          * It will then steer the sub_devices toward the same
 138          * synchronized state.
 139          */
 140         enum dev_state state;
 141         unsigned int pending_alarm:1; /* An alarm is pending */
 142 };
 143
 144 /* MISC */
 145
 146 int failsafe_hotplug_alarm_install(struct rte_eth_dev *dev);
 147 int failsafe_hotplug_alarm_cancel(struct rte_eth_dev *dev);
 148
 149 /* RX / TX */
 150
 151 void set_burst_fn(struct rte_eth_dev *dev, int force_safe);
 152
 153 uint16_t failsafe_rx_burst(void *rxq,
 154                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 155 uint16_t failsafe_tx_burst(void *txq,
 156                 struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
 157
 158 uint16_t failsafe_rx_burst_fast(void *rxq,
 159                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 160 uint16_t failsafe_tx_burst_fast(void *txq,
 161                 struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
 162
 163 /* ARGS */
 164
 165 int failsafe_args_parse(struct rte_eth_dev *dev, const char *params);
 166 void failsafe_args_free(struct rte_eth_dev *dev);
 167 int failsafe_args_count_subdevice(struct rte_eth_dev *dev, const char *params);
 168 int failsafe_args_parse_subs(struct rte_eth_dev *dev);
 169
 170 /* EAL */
 171
 172 int failsafe_eal_init(struct rte_eth_dev *dev);
 173 int failsafe_eal_uninit(struct rte_eth_dev *dev);
 174
 175 /* ETH_DEV */
 176
 177 int failsafe_eth_dev_state_sync(struct rte_eth_dev *dev);
 178 void failsafe_dev_remove(struct rte_eth_dev *dev);
 179 int failsafe_eth_rmv_event_callback(uint8_t port_id,
 180                                     enum rte_eth_event_type type,
 181                                     void *arg, void *out);
 182
 183 /* GLOBALS */
 184
 185 extern const char pmd_failsafe_driver_name[];
 186 extern const struct eth_dev_ops failsafe_ops;
 187 extern const struct rte_flow_ops fs_flow_ops;
 188 extern uint64_t hotplug_poll;
 189 extern int mac_from_arg;
 190
 191 /* HELPERS */
 192
 193 /* dev: (struct rte_eth_dev *) fail-safe device */
 194 #define PRIV(dev) \
 195         ((struct fs_priv *)(dev)->data->dev_private)
 196
 197 /* sdev: (struct sub_device *) */
 198 #define ETH(sdev) \
 199         ((sdev)->edev)
 200
 201 /* sdev: (struct sub_device *) */
 202 #define PORT_ID(sdev) \
 203         (ETH(sdev)->data->port_id)
 204
 205 /* sdev: (struct sub_device *) */
 206 #define SUB_ID(sdev) \
 207         ((sdev)->sid)
 208
 209 /**
 210  * Stateful iterator construct over fail-safe sub-devices:
 211  * s:     (struct sub_device *), iterator
 212  * i:     (uint8_t), increment
 213  * dev:   (struct rte_eth_dev *), fail-safe ethdev
 214  * state: (enum dev_state), minimum acceptable device state
 215  */
 216 #define FOREACH_SUBDEV_STATE(s, i, dev, state)                          \
 217         for (i = fs_find_next((dev), 0, state);                         \
 218              i < PRIV(dev)->subs_tail && (s = &PRIV(dev)->subs[i]);     \
 219              i = fs_find_next((dev), i + 1, state))
 220
 221 /**
 222  * Iterator construct over fail-safe sub-devices:
 223  * s:   (struct sub_device *), iterator
 224  * i:   (uint8_t), increment
 225  * dev: (struct rte_eth_dev *), fail-safe ethdev
 226  */
 227 #define FOREACH_SUBDEV(s, i, dev)                       \
 228         FOREACH_SUBDEV_STATE(s, i, dev, DEV_UNDEFINED)
 229
 230 /* dev: (struct rte_eth_dev *) fail-safe device */
 231 #define PREFERRED_SUBDEV(dev) \
 232         (&PRIV(dev)->subs[0])
 233
 234 /* dev: (struct rte_eth_dev *) fail-safe device */
 235 #define TX_SUBDEV(dev)                                                    \
 236         (PRIV(dev)->subs_tx >= PRIV(dev)->subs_tail                ? NULL \
 237          : (PRIV(dev)->subs[PRIV(dev)->subs_tx].state < DEV_PROBED ? NULL \
 238          : &PRIV(dev)->subs[PRIV(dev)->subs_tx]))
 239
 240 /**
 241  * s:   (struct sub_device *)
 242  * ops: (struct eth_dev_ops) member
 243  */
 244 #define SUBOPS(s, ops) \
 245         (ETH(s)->dev_ops->ops)
 246
 247 /**
 248  * Atomic guard
 249  */
 250
 251 /**
 252  * a: (rte_atomic64_t)
 253  */
 254 #define FS_ATOMIC_P(a) \
 255         rte_atomic64_add(&(a), 1)
 256
 257 /**
 258  * a: (rte_atomic64_t)
 259  */
 260 #define FS_ATOMIC_V(a) \
 261         rte_atomic64_sub(&(a), 1)
 262
 263 /**
 264  * s: (struct sub_device *)
 265  * i: uint16_t qid
 266  */
 267 #define FS_ATOMIC_RX(s, i) \
 268         rte_atomic64_read( \
 269          &((struct rxq *)((s)->fs_dev->data->rx_queues[i]))->refcnt[(s)->sid] \
 270         )
 271 /**
 272  * s: (struct sub_device *)
 273  * i: uint16_t qid
 274  */
 275 #define FS_ATOMIC_TX(s, i) \
 276         rte_atomic64_read( \
 277          &((struct txq *)((s)->fs_dev->data->tx_queues[i]))->refcnt[(s)->sid] \
 278         )
 279
 280 #define LOG__(level, m, ...) \
 281         RTE_LOG(level, PMD, "net_failsafe: " m "%c", __VA_ARGS__)
 282 #define LOG_(level, ...) LOG__(level, __VA_ARGS__, '\n')
 283 #define DEBUG(...) LOG_(DEBUG, __VA_ARGS__)
 284 #define INFO(...) LOG_(INFO, __VA_ARGS__)
 285 #define WARN(...) LOG_(WARNING, __VA_ARGS__)
 286 #define ERROR(...) LOG_(ERR, __VA_ARGS__)
 287
 288 /* inlined functions */
 289
 290 static inline uint8_t
 291 fs_find_next(struct rte_eth_dev *dev, uint8_t sid,
 292                 enum dev_state min_state)
 293 {
 294         while (sid < PRIV(dev)->subs_tail) {
 295                 if (PRIV(dev)->subs[sid].state >= min_state)
 296                         break;
 297                 sid++;
 298         }
 299         if (sid >= PRIV(dev)->subs_tail)
 300                 return PRIV(dev)->subs_tail;
 301         return sid;
 302 }
 303
 304 /*
 305  * Switch emitting device.
 306  * If banned is set, banned must not be considered for
 307  * the role of emitting device.
 308  */
 309 static inline void
 310 fs_switch_dev(struct rte_eth_dev *dev,
 311               struct sub_device *banned)
 312 {
 313         struct sub_device *txd;
 314         enum dev_state req_state;
 315
 316         req_state = PRIV(dev)->state;
 317         txd = TX_SUBDEV(dev);
 318         if (PREFERRED_SUBDEV(dev)->state >= req_state &&
 319             PREFERRED_SUBDEV(dev) != banned) {
 320                 if (txd != PREFERRED_SUBDEV(dev) &&
 321                     (txd == NULL ||
 322                      (req_state == DEV_STARTED) ||
 323                      (txd && txd->state < DEV_STARTED))) {
 324                         DEBUG("Switching tx_dev to preferred sub_device");
 325                         PRIV(dev)->subs_tx = 0;
 326                 }
 327         } else if ((txd && txd->state < req_state) ||
 328                    txd == NULL ||
 329                    txd == banned) {
 330                 struct sub_device *sdev;
 331                 uint8_t i;
 332
 333                 /* Using acceptable device */
 334                 FOREACH_SUBDEV_STATE(sdev, i, dev, req_state) {
 335                         if (sdev == banned)
 336                                 continue;
 337                         DEBUG("Switching tx_dev to sub_device %d",
 338                               i);
 339                         PRIV(dev)->subs_tx = i;
 340                         break;
 341                 }
 342         } else if (txd && txd->state < req_state) {
 343                 DEBUG("No device ready, deactivating tx_dev");
 344                 PRIV(dev)->subs_tx = PRIV(dev)->subs_tail;
 345         } else {
 346                 return;
 347         }
 348         set_burst_fn(dev, 0);
 349         rte_wmb();
 350 }
 351
 352 #endif /* _RTE_ETH_FAILSAFE_PRIVATE_H_ */