drivers/net/bonding/eth_bond_private.h

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