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         rte_spinlock_t lsc_lock;
 109
 110         uint16_t primary_port;                  /**< Primary Slave Port */
 111         uint16_t current_primary_port;          /**< Primary Slave Port */
 112         uint16_t user_defined_primary_port;
 113         /**< Flag for whether primary port is user defined or not */
 114
 115         uint8_t balance_xmit_policy;
 116         /**< Transmit policy - l2 / l23 / l34 for operation in balance mode */
 117         burst_xmit_hash_t burst_xmit_hash;
 118         /**< Transmit policy hash function */
 119
 120         uint8_t user_defined_mac;
 121         /**< Flag for whether MAC address is user defined or not */
 122         uint8_t promiscuous_en;
 123         /**< Enabled/disable promiscuous mode on bonding device */
 124
 125
 126         uint8_t link_status_polling_enabled;
 127         uint32_t link_status_polling_interval_ms;
 128
 129         uint32_t link_down_delay_ms;
 130         uint32_t link_up_delay_ms;
 131
 132         uint16_t nb_rx_queues;                  /**< Total number of rx queues */
 133         uint16_t nb_tx_queues;                  /**< Total number of tx queues*/
 134
 135         uint16_t active_slave;          /**< Next active_slave to poll */
 136         uint16_t active_slave_count;            /**< Number of active slaves */
 137         uint16_t active_slaves[RTE_MAX_ETHPORTS];    /**< Active slave list */
 138
 139         uint16_t slave_count;                   /**< Number of bonded slaves */
 140         struct bond_slave_details slaves[RTE_MAX_ETHPORTS];
 141         /**< Arary of bonded slaves details */
 142
 143         struct mode8023ad_private mode4;
 144         uint16_t tlb_slaves_order[RTE_MAX_ETHPORTS];
 145         /**< TLB active slaves send order */
 146         struct mode_alb_private mode6;
 147
 148         uint64_t rx_offload_capa;       /** Rx offload capability */
 149         uint64_t tx_offload_capa;       /** Tx offload capability */
 150         uint64_t rx_queue_offload_capa; /** per queue Rx offload capability */
 151         uint64_t tx_queue_offload_capa; /** per queue Tx offload capability */
 152
 153         /**< List of the configured flows */
 154         TAILQ_HEAD(sub_flows, rte_flow) flow_list;
 155
 156         /**< Flow isolation state */
 157         int flow_isolated;
 158         int flow_isolated_valid;
 159
 160         /** Bit mask of RSS offloads, the bit offset also means flow type */
 161         uint64_t flow_type_rss_offloads;
 162
 163         uint16_t reta_size;
 164         struct rte_eth_rss_reta_entry64 reta_conf[ETH_RSS_RETA_SIZE_512 /
 165                         RTE_RETA_GROUP_SIZE];
 166
 167         uint8_t rss_key[52];                            /**< 52-byte hash key buffer. */
 168         uint8_t rss_key_len;                            /**< hash key length in bytes. */
 169
 170         struct rte_kvargs *kvlist;
 171         uint8_t slave_update_idx;
 172
 173         uint32_t candidate_max_rx_pktlen;
 174         uint32_t max_rx_pktlen;
 175
 176         void *vlan_filter_bmpmem;               /* enabled vlan filter bitmap */
 177         struct rte_bitmap *vlan_filter_bmp;
 178 };
 179
 180 extern const struct eth_dev_ops default_dev_ops;
 181
 182 int
 183 check_for_master_bonded_ethdev(const struct rte_eth_dev *eth_dev);
 184
 185 int
 186 check_for_bonded_ethdev(const struct rte_eth_dev *eth_dev);
 187
 188 /* Search given slave array to find position of given id.
 189  * Return slave pos or slaves_count if not found. */
 190 static inline uint16_t
 191 find_slave_by_id(uint16_t *slaves, uint16_t slaves_count, uint16_t slave_id) {
 192
 193         uint16_t pos;
 194         for (pos = 0; pos < slaves_count; pos++) {
 195                 if (slave_id == slaves[pos])
 196                         break;
 197         }
 198
 199         return pos;
 200 }
 201
 202 int
 203 valid_port_id(uint16_t port_id);
 204
 205 int
 206 valid_bonded_port_id(uint16_t port_id);
 207
 208 int
 209 valid_slave_port_id(uint16_t port_id, uint8_t mode);
 210
 211 void
 212 deactivate_slave(struct rte_eth_dev *eth_dev, uint16_t port_id);
 213
 214 void
 215 activate_slave(struct rte_eth_dev *eth_dev, uint16_t port_id);
 216
 217 void
 218 link_properties_set(struct rte_eth_dev *bonded_eth_dev,
 219                 struct rte_eth_link *slave_dev_link);
 220 int
 221 link_properties_valid(struct rte_eth_dev *bonded_eth_dev,
 222                 struct rte_eth_link *slave_dev_link);
 223
 224 int
 225 mac_address_set(struct rte_eth_dev *eth_dev, struct ether_addr *new_mac_addr);
 226
 227 int
 228 mac_address_get(struct rte_eth_dev *eth_dev, struct ether_addr *dst_mac_addr);
 229
 230 int
 231 mac_address_slaves_update(struct rte_eth_dev *bonded_eth_dev);
 232
 233 int
 234 slave_add_mac_addresses(struct rte_eth_dev *bonded_eth_dev,
 235                 uint16_t slave_port_id);
 236
 237 int
 238 slave_remove_mac_addresses(struct rte_eth_dev *bonded_eth_dev,
 239                 uint16_t slave_port_id);
 240
 241 int
 242 bond_ethdev_mode_set(struct rte_eth_dev *eth_dev, int mode);
 243
 244 int
 245 slave_configure(struct rte_eth_dev *bonded_eth_dev,
 246                 struct rte_eth_dev *slave_eth_dev);
 247
 248 void
 249 slave_remove(struct bond_dev_private *internals,
 250                 struct rte_eth_dev *slave_eth_dev);
 251
 252 void
 253 slave_add(struct bond_dev_private *internals,
 254                 struct rte_eth_dev *slave_eth_dev);
 255
 256 void
 257 burst_xmit_l2_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
 258                 uint8_t slave_count, uint16_t *slaves);
 259
 260 void
 261 burst_xmit_l23_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
 262                 uint8_t slave_count, uint16_t *slaves);
 263
 264 void
 265 burst_xmit_l34_hash(struct rte_mbuf **buf, uint16_t nb_pkts,
 266                 uint8_t slave_count, uint16_t *slaves);
 267
 268
 269 void
 270 bond_ethdev_primary_set(struct bond_dev_private *internals,
 271                 uint16_t slave_port_id);
 272
 273 int
 274 bond_ethdev_lsc_event_callback(uint16_t port_id, enum rte_eth_event_type type,
 275                 void *param, void *ret_param);
 276
 277 int
 278 bond_ethdev_parse_slave_port_kvarg(const char *key,
 279                 const char *value, void *extra_args);
 280
 281 int
 282 bond_ethdev_parse_slave_mode_kvarg(const char *key,
 283                 const char *value, void *extra_args);
 284
 285 int
 286 bond_ethdev_parse_slave_agg_mode_kvarg(const char *key __rte_unused,
 287                 const char *value, void *extra_args);
 288
 289 int
 290 bond_ethdev_parse_socket_id_kvarg(const char *key,
 291                 const char *value, void *extra_args);
 292
 293 int
 294 bond_ethdev_parse_primary_slave_port_id_kvarg(const char *key,
 295                 const char *value, void *extra_args);
 296
 297 int
 298 bond_ethdev_parse_balance_xmit_policy_kvarg(const char *key,
 299                 const char *value, void *extra_args);
 300
 301 int
 302 bond_ethdev_parse_bond_mac_addr_kvarg(const char *key,
 303                 const char *value, void *extra_args);
 304
 305 int
 306 bond_ethdev_parse_time_ms_kvarg(const char *key,
 307                 const char *value, void *extra_args);
 308
 309 void
 310 bond_tlb_disable(struct bond_dev_private *internals);
 311
 312 void
 313 bond_tlb_enable(struct bond_dev_private *internals);
 314
 315 void
 316 bond_tlb_activate_slave(struct bond_dev_private *internals);
 317
 318 void
 319 bond_ethdev_stop(struct rte_eth_dev *eth_dev);
 320
 321 void
 322 bond_ethdev_close(struct rte_eth_dev *dev);
 323
 324 #endif