drivers/net/bonding/rte_eth_bond_private.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2017 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_ETH_BOND_PRIVATE_H_
   6 #define _RTE_ETH_BOND_PRIVATE_H_
   7
   8 #include <stdint.h>
   9 #include <sys/queue.h>
  10
  11 #include <rte_ethdev_driver.h>
  12 #include <rte_flow.h>
  13 #include <rte_spinlock.h>
  14 #include <rte_bitmap.h>
  15 #include <rte_flow_driver.h>
  16
  17 #include "rte_eth_bond.h"
  18 #include "rte_eth_bond_8023ad_private.h"
  19 #include "rte_eth_bond_alb.h"
  20
  21 #define PMD_BOND_SLAVE_PORT_KVARG                       ("slave")
  22 #define PMD_BOND_PRIMARY_SLAVE_KVARG            ("primary")
  23 #define PMD_BOND_MODE_KVARG                                     ("mode")
  24 #define PMD_BOND_AGG_MODE_KVARG                         ("agg_mode")
  25 #define PMD_BOND_XMIT_POLICY_KVARG                      ("xmit_policy")
  26 #define PMD_BOND_SOCKET_ID_KVARG                        ("socket_id")
  27 #define PMD_BOND_MAC_ADDR_KVARG                         ("mac")
  28 #define PMD_BOND_LSC_POLL_PERIOD_KVARG          ("lsc_poll_period_ms")
  29 #define PMD_BOND_LINK_UP_PROP_DELAY_KVARG       ("up_delay")
  30 #define PMD_BOND_LINK_DOWN_PROP_DELAY_KVARG     ("down_delay")
  31
  32 #define PMD_BOND_XMIT_POLICY_LAYER2_KVARG       ("l2")
  33 #define PMD_BOND_XMIT_POLICY_LAYER23_KVARG      ("l23")
  34 #define PMD_BOND_XMIT_POLICY_LAYER34_KVARG      ("l34")
  35
  36 extern int bond_logtype;
  37
  38 #define RTE_BOND_LOG(lvl, msg, ...)             \
  39         rte_log(RTE_LOG_ ## lvl, bond_logtype, \
  40                 "%s(%d) - " msg "\n", __func__, __LINE__, ##__VA_ARGS__)
  41
  42 #define BONDING_MODE_INVALID 0xFF
  43
  44 extern const char *pmd_bond_init_valid_arguments[];
  45
  46 extern struct rte_vdev_driver pmd_bond_drv;
  47
  48 extern const struct rte_flow_ops bond_flow_ops;
  49
  50 /** Port Queue Mapping Structure */
  51 struct bond_rx_queue {
  52         uint16_t queue_id;
  53         /**< Queue Id */
  54         struct bond_dev_private *dev_private;
  55         /**< Reference to eth_dev private structure */
  56         uint16_t nb_rx_desc;
  57         /**< Number of RX descriptors available for the queue */
  58         struct rte_eth_rxconf rx_conf;
  59         /**< Copy of RX configuration structure for queue */
  60         struct rte_mempool *mb_pool;
  61         /**< Reference to mbuf pool to use for RX queue */
  62 };
  63
  64 struct bond_tx_queue {
  65         uint16_t queue_id;
  66         /**< Queue Id */
  67         struct bond_dev_private *dev_private;
  68         /**< Reference to dev private structure */
  69         uint16_t nb_tx_desc;
  70         /**< Number of TX descriptors available for the queue */
  71         struct rte_eth_txconf tx_conf;
  72         /**< Copy of TX configuration structure for queue */
  73 };
  74
  75 /** Bonded slave devices structure */
  76 struct bond_ethdev_slave_ports {
  77         uint16_t slaves[RTE_MAX_ETHPORTS];      /**< Slave port id array */
  78         uint16_t slave_count;                           /**< Number of slaves */
  79 };
  80
  81 struct bond_slave_details {
  82         uint16_t port_id;
  83
  84         uint8_t link_status_poll_enabled;
  85         uint8_t link_status_wait_to_complete;
  86         uint8_t last_link_status;
  87         /**< Port Id of slave eth_dev */
  88         struct rte_ether_addr persisted_mac_addr;
  89
  90         uint16_t reta_size;
  91 };
  92
  93 struct rte_flow {
  94         TAILQ_ENTRY(rte_flow) next;
  95         /* Slaves flows */
  96         struct rte_flow *flows[RTE_MAX_ETHPORTS];
  97         /* Flow description for synchronization */
  98         struct rte_flow_conv_rule rule;
  99         uint8_t rule_data[];
 100 };
 101
 102 typedef void (*burst_xmit_hash_t)(struct rte_mbuf **buf, uint16_t nb_pkts,
 103                 uint16_t slave_count, uint16_t *slaves);
 104
 105 /** Link Bonding PMD device private configuration Structure */
 106 struct bond_dev_private {
 107         uint16_t port_id;                       /**< Port Id of Bonded Port */
 108         uint8_t mode;                                           /**< Link Bonding Mode */
 109
 110         rte_spinlock_t lock;
 111         rte_spinlock_t lsc_lock;
 112
 113         uint16_t primary_port;                  /**< Primary Slave Port */
 114         uint16_t current_primary_port;          /**< Primary Slave Port */
 115         uint16_t user_defined_primary_port;
 116         /**< Flag for whether primary port is user defined or not */
 117
 118         uint8_t balance_xmit_policy;
 119         /**< Transmit policy - l2 / l23 / l34 for operation in balance mode */
 120         burst_xmit_hash_t burst_xmit_hash;
 121         /**< Transmit policy hash function */
 122
 123         uint8_t user_defined_mac;
 124         /**< Flag for whether MAC address is user defined or not */
 125         uint8_t promiscuous_en;
 126         /**< Enabled/disable promiscuous mode on bonding device */
 127
 128
 129         uint8_t link_status_polling_enabled;
 130         uint32_t link_status_polling_interval_ms;
 131
 132         uint32_t link_down_delay_ms;
 133         uint32_t link_up_delay_ms;
 134
 135         uint16_t nb_rx_queues;                  /**< Total number of rx queues */
 136         uint16_t nb_tx_queues;                  /**< Total number of tx queues*/
 137
 138         uint16_t active_slave;          /**< Next active_slave to poll */
 139         uint16_t active_slave_count;            /**< Number of active slaves */
 140         uint16_t active_slaves[RTE_MAX_ETHPORTS];    /**< Active slave list */
 141
 142         uint16_t slave_count;                   /**< Number of bonded slaves */
 143         struct bond_slave_details slaves[RTE_MAX_ETHPORTS];
 144         /**< Arary of bonded slaves details */
 145
 146         struct mode8023ad_private mode4;
 147         uint16_t tlb_slaves_order[RTE_MAX_ETHPORTS];
 148         /**< TLB active slaves send order */
 149         struct mode_alb_private mode6;
 150
 151         uint64_t rx_offload_capa;       /** Rx offload capability */
 152         uint64_t tx_offload_capa;       /** Tx offload capability */
 153         uint64_t rx_queue_offload_capa; /** per queue Rx offload capability */
 154         uint64_t tx_queue_offload_capa; /** per queue Tx offload capability */
 155
 156         /**< List of the configured flows */
 157         TAILQ_HEAD(sub_flows, rte_flow) flow_list;
 158
 159         /**< Flow isolation state */
 160         int flow_isolated;
 161         int flow_isolated_valid;
 162
 163         /** Bit mask of RSS offloads, the bit offset also means flow type */
 164         uint64_t flow_type_rss_offloads;
 165
 166         struct rte_eth_rxconf default_rxconf;   /**< Default RxQ conf. */
 167         struct rte_eth_txconf default_txconf;   /**< Default TxQ conf. */
 168         struct rte_eth_desc_lim rx_desc_lim;    /**< Rx descriptor limits */
 169         struct rte_eth_desc_lim tx_desc_lim;    /**< Tx descriptor limits */
 170
 171         uint16_t reta_size;
 172         struct rte_eth_rss_reta_entry64 reta_conf[ETH_RSS_RETA_SIZE_512 /
 173                         RTE_RETA_GROUP_SIZE];
 174
 175         uint8_t rss_key[52];                            /**< 52-byte hash key buffer. */
 176         uint8_t rss_key_len;                            /**< hash key length in bytes. */
 177
 178         struct rte_kvargs *kvlist;
 179         uint8_t slave_update_idx;
 180
 181         uint32_t candidate_max_rx_pktlen;
 182         uint32_t max_rx_pktlen;
 183
 184         void *vlan_filter_bmpmem;               /* enabled vlan filter bitmap */
 185         struct rte_bitmap *vlan_filter_bmp;
 186 };
 187
 188 extern const struct eth_dev_ops default_dev_ops;
 189
 190 int
 191 check_for_master_bonded_ethdev(const struct rte_eth_dev *eth_dev);
 192
 193 int
 194 check_for_bonded_ethdev(const struct rte_eth_dev *eth_dev);
 195
 196 /* Search given slave array to find position of given id.
 197  * Return slave pos or slaves_count if not found. */
 198 static inline uint16_t
 199 find_slave_by_id(uint16_t *slaves, uint16_t slaves_count, uint16_t slave_id) {
 200
 201         uint16_t pos;
 202         for (pos = 0; pos < slaves_count; pos++) {
 203                 if (slave_id == slaves[pos])
 204                         break;
 205         }
 206
 207         return pos;
 208 }
 209
 210 int
 211 valid_port_id(uint16_t port_id);
 212
 213 int
 214 valid_bonded_port_id(uint16_t port_id);
 215
 216 int
 217 valid_slave_port_id(uint16_t port_id, uint8_t mode);
 218
 219 void
 220 deactivate_slave(struct rte_eth_dev *eth_dev, uint16_t port_id);
 221
 222 void
 223 activate_slave(struct rte_eth_dev *eth_dev, uint16_t port_id);
 224
 225 int
 226 mac_address_set(struct rte_eth_dev *eth_dev,
 227                 struct rte_ether_addr *new_mac_addr);
 228
 229 int
 230 mac_address_get(struct rte_eth_dev *eth_dev,
 231                 struct rte_ether_addr *dst_mac_addr);
 232
 233 int
 234 mac_address_slaves_update(struct rte_eth_dev *bonded_eth_dev);
 235
 236 int
 237 slave_add_mac_addresses(struct rte_eth_dev *bonded_eth_dev,
 238                 uint16_t slave_port_id);
 239
 240 int
 241 slave_remove_mac_addresses(struct rte_eth_dev *bonded_eth_dev,
 242                 uint16_t slave_port_id);
 243
 244 int
 245 bond_ethdev_mode_set(struct rte_eth_dev *eth_dev, int mode);
 246
 247 int
 248 slave_configure(struct rte_eth_dev *bonded_eth_dev,
 249                 struct rte_eth_dev *slave_eth_dev);
 250
 251 void
 252 slave_remove(struct bond_dev_private *internals,
 253                 struct rte_eth_dev *slave_eth_dev);
 254
 255 void
 256 slave_add(struct bond_dev_private *internals,
 257                 struct rte_eth_dev *slave_eth_dev);
 258
 259 void
 260 burst_xmit_l2_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
 261                 uint16_t slave_count, uint16_t *slaves);
 262
 263 void
 264 burst_xmit_l23_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
 265                 uint16_t slave_count, uint16_t *slaves);
 266
 267 void
 268 burst_xmit_l34_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
 269                 uint16_t slave_count, uint16_t *slaves);
 270
 271
 272 void
 273 bond_ethdev_primary_set(struct bond_dev_private *internals,
 274                 uint16_t slave_port_id);
 275
 276 int
 277 bond_ethdev_lsc_event_callback(uint16_t port_id, enum rte_eth_event_type type,
 278                 void *param, void *ret_param);
 279
 280 int
 281 bond_ethdev_parse_slave_port_kvarg(const char *key,
 282                 const char *value, void *extra_args);
 283
 284 int
 285 bond_ethdev_parse_slave_mode_kvarg(const char *key,
 286                 const char *value, void *extra_args);
 287
 288 int
 289 bond_ethdev_parse_slave_agg_mode_kvarg(const char *key __rte_unused,
 290                 const char *value, void *extra_args);
 291
 292 int
 293 bond_ethdev_parse_socket_id_kvarg(const char *key,
 294                 const char *value, void *extra_args);
 295
 296 int
 297 bond_ethdev_parse_primary_slave_port_id_kvarg(const char *key,
 298                 const char *value, void *extra_args);
 299
 300 int
 301 bond_ethdev_parse_balance_xmit_policy_kvarg(const char *key,
 302                 const char *value, void *extra_args);
 303
 304 int
 305 bond_ethdev_parse_bond_mac_addr_kvarg(const char *key,
 306                 const char *value, void *extra_args);
 307
 308 int
 309 bond_ethdev_parse_time_ms_kvarg(const char *key,
 310                 const char *value, void *extra_args);
 311
 312 void
 313 bond_tlb_disable(struct bond_dev_private *internals);
 314
 315 void
 316 bond_tlb_enable(struct bond_dev_private *internals);
 317
 318 void
 319 bond_tlb_activate_slave(struct bond_dev_private *internals);
 320
 321 void
 322 bond_ethdev_stop(struct rte_eth_dev *eth_dev);
 323
 324 void
 325 bond_ethdev_close(struct rte_eth_dev *dev);
 326
 327 #endif