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