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