drivers/net/failsafe/failsafe_private.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2017 6WIND S.A.
   3  * Copyright 2017 Mellanox Technologies, Ltd
   4  */
   5
   6 #ifndef _RTE_ETH_FAILSAFE_PRIVATE_H_
   7 #define _RTE_ETH_FAILSAFE_PRIVATE_H_
   8
   9 #include <sys/queue.h>
  10 #include <pthread.h>
  11
  12 #include <rte_atomic.h>
  13 #include <rte_dev.h>
  14 #include <rte_ethdev_driver.h>
  15 #include <rte_devargs.h>
  16 #include <rte_interrupts.h>
  17
  18 #define FAILSAFE_DRIVER_NAME "Fail-safe PMD"
  19 #define FAILSAFE_OWNER_NAME "Fail-safe"
  20
  21 #define PMD_FAILSAFE_MAC_KVARG "mac"
  22 #define PMD_FAILSAFE_HOTPLUG_POLL_KVARG "hotplug_poll"
  23 #define PMD_FAILSAFE_PARAM_STRING       \
  24         "dev(<ifc>),"                   \
  25         "exec(<shell command>),"        \
  26         "fd(<fd number>),"              \
  27         "mac=mac_addr,"                 \
  28         "hotplug_poll=u64"              \
  29         ""
  30
  31 #define FAILSAFE_HOTPLUG_DEFAULT_TIMEOUT_MS 2000
  32
  33 #define FAILSAFE_MAX_ETHPORTS 2
  34 #define FAILSAFE_MAX_ETHADDR 128
  35
  36 #define DEVARGS_MAXLEN 4096
  37
  38 enum rxp_service_state {
  39         SS_NO_SERVICE = 0,
  40         SS_REGISTERED,
  41         SS_READY,
  42         SS_RUNNING,
  43 };
  44
  45 /* TYPES */
  46
  47 struct rx_proxy {
  48         /* epoll file descriptor */
  49         int efd;
  50         /* event vector to be used by epoll */
  51         struct rte_epoll_event *evec;
  52         /* rte service id */
  53         uint32_t sid;
  54         /* service core id */
  55         uint32_t scid;
  56         enum rxp_service_state sstate;
  57 };
  58
  59 struct rxq {
  60         struct fs_priv *priv;
  61         uint16_t qid;
  62         /* next sub_device to poll */
  63         struct sub_device *sdev;
  64         unsigned int socket_id;
  65         int event_fd;
  66         unsigned int enable_events:1;
  67         struct rte_eth_rxq_info info;
  68         rte_atomic64_t refcnt[];
  69 };
  70
  71 struct txq {
  72         struct fs_priv *priv;
  73         uint16_t qid;
  74         unsigned int socket_id;
  75         struct rte_eth_txq_info info;
  76         rte_atomic64_t refcnt[];
  77 };
  78
  79 struct rte_flow {
  80         TAILQ_ENTRY(rte_flow) next;
  81         /* sub_flows */
  82         struct rte_flow *flows[FAILSAFE_MAX_ETHPORTS];
  83         /* flow description for synchronization */
  84         struct rte_flow_desc *fd;
  85 };
  86
  87 enum dev_state {
  88         DEV_UNDEFINED,
  89         DEV_PARSED,
  90         DEV_PROBED,
  91         DEV_ACTIVE,
  92         DEV_STARTED,
  93 };
  94
  95 struct fs_stats {
  96         struct rte_eth_stats stats;
  97         uint64_t timestamp;
  98 };
  99
 100 struct sub_device {
 101         /* Exhaustive DPDK device description */
 102         struct sub_device *next;
 103         struct rte_devargs devargs;
 104         struct rte_bus *bus;
 105         struct rte_device *dev;
 106         struct rte_eth_dev *edev;
 107         uint8_t sid;
 108         /* Device state machine */
 109         enum dev_state state;
 110         /* Last stats snapshot passed to user */
 111         struct fs_stats stats_snapshot;
 112         /* Some device are defined as a command line */
 113         char *cmdline;
 114         /* Others are retrieved through a file descriptor */
 115         char *fd_str;
 116         /* fail-safe device backreference */
 117         struct rte_eth_dev *fs_dev;
 118         /* flag calling for recollection */
 119         volatile unsigned int remove:1;
 120         /* flow isolation state */
 121         int flow_isolated:1;
 122         /* RMV callback registration state */
 123         unsigned int rmv_callback:1;
 124         /* LSC callback registration state */
 125         unsigned int lsc_callback:1;
 126 };
 127
 128 struct fs_priv {
 129         struct rte_eth_dev *dev;
 130         /*
 131          * Set of sub_devices.
 132          * subs[0] is the preferred device
 133          * any other is just another slave
 134          */
 135         struct sub_device *subs;
 136         uint8_t subs_head; /* if head == tail, no subs */
 137         uint8_t subs_tail; /* first invalid */
 138         uint8_t subs_tx; /* current emitting device */
 139         uint8_t current_probed;
 140         /* flow mapping */
 141         TAILQ_HEAD(sub_flows, rte_flow) flow_list;
 142         /* current number of mac_addr slots allocated. */
 143         uint32_t nb_mac_addr;
 144         struct ether_addr mac_addrs[FAILSAFE_MAX_ETHADDR];
 145         uint32_t mac_addr_pool[FAILSAFE_MAX_ETHADDR];
 146         /* current capabilities */
 147         struct rte_eth_dev_info infos;
 148         struct rte_eth_dev_owner my_owner; /* Unique owner. */
 149         struct rte_intr_handle intr_handle; /* Port interrupt handle. */
 150         /*
 151          * Fail-safe state machine.
 152          * This level will be tracking state of the EAL and eth
 153          * layer at large as defined by the user application.
 154          * It will then steer the sub_devices toward the same
 155          * synchronized state.
 156          */
 157         enum dev_state state;
 158         struct rte_eth_stats stats_accumulator;
 159         /*
 160          * Rx interrupts/events proxy.
 161          * The PMD issues Rx events to the EAL on behalf of its subdevices,
 162          * it does that by registering an event-fd for each of its queues with
 163          * the EAL. A PMD service thread listens to all the Rx events from the
 164          * subdevices, when an Rx event is issued by a subdevice it will be
 165          * caught by this service with will trigger an Rx event in the
 166          * appropriate failsafe Rx queue.
 167          */
 168         struct rx_proxy rxp;
 169         pthread_mutex_t hotplug_mutex;
 170         /* Hot-plug mutex is locked by the alarm mechanism. */
 171         volatile unsigned int alarm_lock:1;
 172         unsigned int pending_alarm:1; /* An alarm is pending */
 173         /* flow isolation state */
 174         int flow_isolated:1;
 175 };
 176
 177 /* FAILSAFE_INTR */
 178
 179 int failsafe_rx_intr_install(struct rte_eth_dev *dev);
 180 void failsafe_rx_intr_uninstall(struct rte_eth_dev *dev);
 181 int failsafe_rx_intr_install_subdevice(struct sub_device *sdev);
 182 void failsafe_rx_intr_uninstall_subdevice(struct sub_device *sdev);
 183
 184 /* MISC */
 185
 186 int failsafe_hotplug_alarm_install(struct rte_eth_dev *dev);
 187 int failsafe_hotplug_alarm_cancel(struct rte_eth_dev *dev);
 188
 189 /* RX / TX */
 190
 191 void set_burst_fn(struct rte_eth_dev *dev, int force_safe);
 192
 193 uint16_t failsafe_rx_burst(void *rxq,
 194                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 195 uint16_t failsafe_tx_burst(void *txq,
 196                 struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
 197
 198 uint16_t failsafe_rx_burst_fast(void *rxq,
 199                 struct rte_mbuf **rx_pkts, uint16_t nb_pkts);
 200 uint16_t failsafe_tx_burst_fast(void *txq,
 201                 struct rte_mbuf **tx_pkts, uint16_t nb_pkts);
 202
 203 /* ARGS */
 204
 205 int failsafe_args_parse(struct rte_eth_dev *dev, const char *params);
 206 void failsafe_args_free(struct rte_eth_dev *dev);
 207 int failsafe_args_count_subdevice(struct rte_eth_dev *dev, const char *params);
 208 int failsafe_args_parse_subs(struct rte_eth_dev *dev);
 209
 210 /* EAL */
 211
 212 int failsafe_eal_init(struct rte_eth_dev *dev);
 213 int failsafe_eal_uninit(struct rte_eth_dev *dev);
 214
 215 /* ETH_DEV */
 216
 217 int failsafe_eth_dev_state_sync(struct rte_eth_dev *dev);
 218 void failsafe_eth_dev_unregister_callbacks(struct sub_device *sdev);
 219 void failsafe_dev_remove(struct rte_eth_dev *dev);
 220 void failsafe_stats_increment(struct rte_eth_stats *to,
 221                                 struct rte_eth_stats *from);
 222 int failsafe_eth_rmv_event_callback(uint16_t port_id,
 223                                     enum rte_eth_event_type type,
 224                                     void *arg, void *out);
 225 int failsafe_eth_lsc_event_callback(uint16_t port_id,
 226                                     enum rte_eth_event_type event,
 227                                     void *cb_arg, void *out);
 228 int failsafe_eth_new_event_callback(uint16_t port_id,
 229                                     enum rte_eth_event_type event,
 230                                     void *cb_arg, void *out);
 231
 232 /* GLOBALS */
 233
 234 extern const char pmd_failsafe_driver_name[];
 235 extern const struct eth_dev_ops failsafe_ops;
 236 extern const struct rte_flow_ops fs_flow_ops;
 237 extern uint64_t hotplug_poll;
 238 extern int mac_from_arg;
 239
 240 /* HELPERS */
 241
 242 /* dev: (struct rte_eth_dev *) fail-safe device */
 243 #define PRIV(dev) \
 244         ((struct fs_priv *)(dev)->data->dev_private)
 245
 246 /* sdev: (struct sub_device *) */
 247 #define ETH(sdev) \
 248         ((sdev)->edev)
 249
 250 /* sdev: (struct sub_device *) */
 251 #define PORT_ID(sdev) \
 252         (ETH(sdev)->data->port_id)
 253
 254 /* sdev: (struct sub_device *) */
 255 #define SUB_ID(sdev) \
 256         ((sdev)->sid)
 257
 258 /**
 259  * Stateful iterator construct over fail-safe sub-devices:
 260  * s:     (struct sub_device *), iterator
 261  * i:     (uint8_t), increment
 262  * dev:   (struct rte_eth_dev *), fail-safe ethdev
 263  * state: (enum dev_state), minimum acceptable device state
 264  */
 265 #define FOREACH_SUBDEV_STATE(s, i, dev, state)          \
 266         for (s = fs_find_next((dev), 0, state, &i);     \
 267              s != NULL;                                 \
 268              s = fs_find_next((dev), i + 1, state, &i))
 269
 270 /**
 271  * Iterator construct over fail-safe sub-devices:
 272  * s:   (struct sub_device *), iterator
 273  * i:   (uint8_t), increment
 274  * dev: (struct rte_eth_dev *), fail-safe ethdev
 275  */
 276 #define FOREACH_SUBDEV(s, i, dev)                       \
 277         FOREACH_SUBDEV_STATE(s, i, dev, DEV_UNDEFINED)
 278
 279 /* dev: (struct rte_eth_dev *) fail-safe device */
 280 #define PREFERRED_SUBDEV(dev) \
 281         (&PRIV(dev)->subs[0])
 282
 283 /* dev: (struct rte_eth_dev *) fail-safe device */
 284 #define TX_SUBDEV(dev)                                                    \
 285         (PRIV(dev)->subs_tx >= PRIV(dev)->subs_tail                ? NULL \
 286          : (PRIV(dev)->subs[PRIV(dev)->subs_tx].state < DEV_PROBED ? NULL \
 287          : &PRIV(dev)->subs[PRIV(dev)->subs_tx]))
 288
 289 /**
 290  * s:   (struct sub_device *)
 291  * ops: (struct eth_dev_ops) member
 292  */
 293 #define SUBOPS(s, ops) \
 294         (ETH(s)->dev_ops->ops)
 295
 296 /**
 297  * Atomic guard
 298  */
 299
 300 /**
 301  * a: (rte_atomic64_t)
 302  */
 303 #define FS_ATOMIC_P(a) \
 304         rte_atomic64_set(&(a), 1)
 305
 306 /**
 307  * a: (rte_atomic64_t)
 308  */
 309 #define FS_ATOMIC_V(a) \
 310         rte_atomic64_set(&(a), 0)
 311
 312 /**
 313  * s: (struct sub_device *)
 314  * i: uint16_t qid
 315  */
 316 #define FS_ATOMIC_RX(s, i) \
 317         rte_atomic64_read( \
 318          &((struct rxq *)((s)->fs_dev->data->rx_queues[i]))->refcnt[(s)->sid] \
 319         )
 320 /**
 321  * s: (struct sub_device *)
 322  * i: uint16_t qid
 323  */
 324 #define FS_ATOMIC_TX(s, i) \
 325         rte_atomic64_read( \
 326          &((struct txq *)((s)->fs_dev->data->tx_queues[i]))->refcnt[(s)->sid] \
 327         )
 328
 329 #ifdef RTE_EXEC_ENV_BSDAPP
 330 #define FS_THREADID_TYPE void*
 331 #define FS_THREADID_FMT  "p"
 332 #else
 333 #define FS_THREADID_TYPE unsigned long
 334 #define FS_THREADID_FMT  "lu"
 335 #endif
 336
 337 extern int failsafe_logtype;
 338
 339 #define LOG__(l, m, ...) \
 340         rte_log(RTE_LOG_ ## l, failsafe_logtype, \
 341                 "net_failsafe: " m "%c", __VA_ARGS__)
 342
 343 #define LOG_(level, ...) LOG__(level, __VA_ARGS__, '\n')
 344 #define DEBUG(...) LOG_(DEBUG, __VA_ARGS__)
 345 #define INFO(...) LOG_(INFO, __VA_ARGS__)
 346 #define WARN(...) LOG_(WARNING, __VA_ARGS__)
 347 #define ERROR(...) LOG_(ERR, __VA_ARGS__)
 348
 349 /* inlined functions */
 350
 351 static inline struct sub_device *
 352 fs_find_next(struct rte_eth_dev *dev,
 353              uint8_t sid,
 354              enum dev_state min_state,
 355              uint8_t *sid_out)
 356 {
 357         struct sub_device *subs;
 358         uint8_t tail;
 359
 360         subs = PRIV(dev)->subs;
 361         tail = PRIV(dev)->subs_tail;
 362         while (sid < tail) {
 363                 if (subs[sid].state >= min_state)
 364                         break;
 365                 sid++;
 366         }
 367         *sid_out = sid;
 368         if (sid >= tail)
 369                 return NULL;
 370         return &subs[sid];
 371 }
 372
 373 /*
 374  * Lock hot-plug mutex.
 375  * is_alarm means that the caller is, for sure, the hot-plug alarm mechanism.
 376  */
 377 static inline int
 378 fs_lock(struct rte_eth_dev *dev, unsigned int is_alarm)
 379 {
 380         int ret;
 381
 382         if (is_alarm) {
 383                 ret = pthread_mutex_trylock(&PRIV(dev)->hotplug_mutex);
 384                 if (ret) {
 385                         DEBUG("Hot-plug mutex lock trying failed(%s), will try"
 386                               " again later...", strerror(ret));
 387                         return ret;
 388                 }
 389                 PRIV(dev)->alarm_lock = 1;
 390         } else {
 391                 ret = pthread_mutex_lock(&PRIV(dev)->hotplug_mutex);
 392                 if (ret) {
 393                         ERROR("Cannot lock mutex(%s)", strerror(ret));
 394                         return ret;
 395                 }
 396         }
 397         DEBUG("Hot-plug mutex was locked by thread %" FS_THREADID_FMT "%s",
 398               (FS_THREADID_TYPE)pthread_self(),
 399               PRIV(dev)->alarm_lock ? " by the hot-plug alarm" : "");
 400         return ret;
 401 }
 402
 403 /*
 404  * Unlock hot-plug mutex.
 405  * is_alarm means that the caller is, for sure, the hot-plug alarm mechanism.
 406  */
 407 static inline void
 408 fs_unlock(struct rte_eth_dev *dev, unsigned int is_alarm)
 409 {
 410         int ret;
 411         unsigned int prev_alarm_lock = PRIV(dev)->alarm_lock;
 412
 413         if (is_alarm) {
 414                 RTE_ASSERT(PRIV(dev)->alarm_lock == 1);
 415                 PRIV(dev)->alarm_lock = 0;
 416         }
 417         ret = pthread_mutex_unlock(&PRIV(dev)->hotplug_mutex);
 418         if (ret)
 419                 ERROR("Cannot unlock hot-plug mutex(%s)", strerror(ret));
 420         else
 421                 DEBUG("Hot-plug mutex was unlocked by thread %" FS_THREADID_FMT "%s",
 422                       (FS_THREADID_TYPE)pthread_self(),
 423                       prev_alarm_lock ? " by the hot-plug alarm" : "");
 424 }
 425
 426 /*
 427  * Switch emitting device.
 428  * If banned is set, banned must not be considered for
 429  * the role of emitting device.
 430  */
 431 static inline void
 432 fs_switch_dev(struct rte_eth_dev *dev,
 433               struct sub_device *banned)
 434 {
 435         struct sub_device *txd;
 436         enum dev_state req_state;
 437
 438         req_state = PRIV(dev)->state;
 439         txd = TX_SUBDEV(dev);
 440         if (PREFERRED_SUBDEV(dev)->state >= req_state &&
 441             PREFERRED_SUBDEV(dev) != banned) {
 442                 if (txd != PREFERRED_SUBDEV(dev) &&
 443                     (txd == NULL ||
 444                      (req_state == DEV_STARTED) ||
 445                      (txd && txd->state < DEV_STARTED))) {
 446                         DEBUG("Switching tx_dev to preferred sub_device");
 447                         PRIV(dev)->subs_tx = 0;
 448                 }
 449         } else if ((txd && txd->state < req_state) ||
 450                    txd == NULL ||
 451                    txd == banned) {
 452                 struct sub_device *sdev = NULL;
 453                 uint8_t i;
 454
 455                 /* Using acceptable device */
 456                 FOREACH_SUBDEV_STATE(sdev, i, dev, req_state) {
 457                         if (sdev == banned)
 458                                 continue;
 459                         DEBUG("Switching tx_dev to sub_device %d",
 460                               i);
 461                         PRIV(dev)->subs_tx = i;
 462                         break;
 463                 }
 464                 if (i >= PRIV(dev)->subs_tail || sdev == NULL) {
 465                         DEBUG("No device ready, deactivating tx_dev");
 466                         PRIV(dev)->subs_tx = PRIV(dev)->subs_tail;
 467                 }
 468         } else {
 469                 return;
 470         }
 471         set_burst_fn(dev, 0);
 472         rte_wmb();
 473 }
 474
 475 /*
 476  * Adjust error value and rte_errno to the fail-safe actual error value.
 477  */
 478 static inline int
 479 fs_err(struct sub_device *sdev, int err)
 480 {
 481         /* A device removal shouldn't be reported as an error. */
 482         if (sdev->remove == 1 || err == -EIO)
 483                 return rte_errno = 0;
 484         return err;
 485 }
 486 #endif /* _RTE_ETH_FAILSAFE_PRIVATE_H_ */