lib/librte_pmd_bond/rte_eth_bond_private.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _RTE_ETH_BOND_PRIVATE_H_
  35 #define _RTE_ETH_BOND_PRIVATE_H_
  36
  37 #include <rte_ethdev.h>
  38 #include <rte_spinlock.h>
  39
  40 #include "rte_eth_bond.h"
  41 #include "rte_eth_bond_8023ad_private.h"
  42
  43 #define PMD_BOND_SLAVE_PORT_KVARG                       ("slave")
  44 #define PMD_BOND_PRIMARY_SLAVE_KVARG            ("primary")
  45 #define PMD_BOND_MODE_KVARG                                     ("mode")
  46 #define PMD_BOND_XMIT_POLICY_KVARG                      ("xmit_policy")
  47 #define PMD_BOND_SOCKET_ID_KVARG                        ("socket_id")
  48 #define PMD_BOND_MAC_ADDR_KVARG                         ("mac")
  49 #define PMD_BOND_LSC_POLL_PERIOD_KVARG          ("lsc_poll_period_ms")
  50 #define PMD_BOND_LINK_UP_PROP_DELAY_KVARG       ("up_delay")
  51 #define PMD_BOND_LINK_DOWN_PROP_DELAY_KVARG     ("down_delay")
  52
  53 #define PMD_BOND_XMIT_POLICY_LAYER2_KVARG       ("l2")
  54 #define PMD_BOND_XMIT_POLICY_LAYER23_KVARG      ("l23")
  55 #define PMD_BOND_XMIT_POLICY_LAYER34_KVARG      ("l34")
  56
  57 #define RTE_BOND_LOG(lvl, msg, ...)             \
  58         RTE_LOG(lvl, PMD, "%s(%d) - " msg "\n", __func__, __LINE__, ##__VA_ARGS__)
  59
  60 #define BONDING_MODE_INVALID 0xFF
  61
  62 extern const char *pmd_bond_init_valid_arguments[];
  63
  64 extern const char *driver_name;
  65
  66 /** Port Queue Mapping Structure */
  67 struct bond_rx_queue {
  68         int queue_id;
  69         /**< Queue Id */
  70         struct bond_dev_private *dev_private;
  71         /**< Reference to eth_dev private structure */
  72         uint16_t nb_rx_desc;
  73         /**< Number of RX descriptors available for the queue */
  74         struct rte_eth_rxconf rx_conf;
  75         /**< Copy of RX configuration structure for queue */
  76         struct rte_mempool *mb_pool;
  77         /**< Reference to mbuf pool to use for RX queue */
  78 };
  79
  80 struct bond_tx_queue {
  81         int queue_id;
  82         /**< Queue Id */
  83         struct bond_dev_private *dev_private;
  84         /**< Reference to dev private structure */
  85         uint16_t nb_tx_desc;
  86         /**< Number of TX descriptors available for the queue */
  87         struct rte_eth_txconf tx_conf;
  88         /**< Copy of TX configuration structure for queue */
  89 };
  90
  91 /** Bonded slave devices structure */
  92 struct bond_ethdev_slave_ports {
  93         uint8_t slaves[RTE_MAX_ETHPORTS];       /**< Slave port id array */
  94         uint8_t slave_count;                            /**< Number of slaves */
  95 };
  96
  97 struct bond_slave_details {
  98         uint8_t port_id;
  99
 100         uint8_t link_status_poll_enabled;
 101         uint8_t link_status_wait_to_complete;
 102         uint8_t last_link_status;
 103         /**< Port Id of slave eth_dev */
 104         struct ether_addr persisted_mac_addr;
 105 };
 106
 107
 108 typedef uint16_t (*xmit_hash_t)(const struct rte_mbuf *buf, uint8_t slave_count);
 109
 110 /** Link Bonding PMD device private configuration Structure */
 111 struct bond_dev_private {
 112         uint8_t port_id;                                        /**< Port Id of Bonded Port */
 113         uint8_t mode;                                           /**< Link Bonding Mode */
 114
 115         rte_spinlock_t lock;
 116
 117         uint8_t primary_port;                           /**< Primary Slave Port */
 118         uint8_t current_primary_port;           /**< Primary Slave Port */
 119         uint8_t user_defined_primary_port;
 120         /**< Flag for whether primary port is user defined or not */
 121
 122         uint8_t balance_xmit_policy;
 123         /**< Transmit policy - l2 / l23 / l34 for operation in balance mode */
 124         xmit_hash_t xmit_hash;
 125         /**< Transmit policy hash function */
 126
 127         uint8_t user_defined_mac;
 128         /**< Flag for whether MAC address is user defined or not */
 129         uint8_t promiscuous_en;
 130         /**< Enabled/disable promiscuous mode on bonding device */
 131         uint8_t link_props_set;
 132         /**< flag to denote if the link properties are set */
 133
 134         uint8_t link_status_polling_enabled;
 135         uint32_t link_status_polling_interval_ms;
 136
 137         uint32_t link_down_delay_ms;
 138         uint32_t link_up_delay_ms;
 139
 140         uint16_t nb_rx_queues;                  /**< Total number of rx queues */
 141         uint16_t nb_tx_queues;                  /**< Total number of tx queues*/
 142
 143         uint8_t active_slave_count;             /**< Number of active slaves */
 144         uint8_t active_slaves[RTE_MAX_ETHPORTS];        /**< Active slave list */
 145
 146         uint8_t slave_count;                    /**< Number of bonded slaves */
 147         struct bond_slave_details slaves[RTE_MAX_ETHPORTS];
 148         /**< Arary of bonded slaves details */
 149
 150         struct mode8023ad_private mode4;
 151
 152         uint32_t rx_offload_capa;            /** Rx offload capability */
 153         uint32_t tx_offload_capa;            /** Tx offload capability */
 154
 155         struct rte_kvargs *kvlist;
 156         uint8_t slave_update_idx;
 157 };
 158
 159 extern struct eth_dev_ops default_dev_ops;
 160
 161 int
 162 valid_bonded_ethdev(struct rte_eth_dev *eth_dev);
 163
 164 /* Search given slave array to find possition of given id.
 165  * Return slave pos or slaves_count if not found. */
 166 static inline uint8_t
 167 find_slave_by_id(uint8_t *slaves, uint8_t slaves_count, uint8_t slave_id) {
 168
 169         uint8_t pos;
 170         for (pos = 0; pos < slaves_count; pos++) {
 171                 if (slave_id == slaves[pos])
 172                         break;
 173         }
 174
 175         return pos;
 176 }
 177
 178 int
 179 valid_port_id(uint8_t port_id);
 180
 181 int
 182 valid_bonded_port_id(uint8_t port_id);
 183
 184 int
 185 valid_slave_port_id(uint8_t port_id);
 186
 187 void
 188 deactivate_slave(struct rte_eth_dev *eth_dev, uint8_t port_id);
 189
 190 void
 191 activate_slave(struct rte_eth_dev *eth_dev, uint8_t port_id);
 192
 193 void
 194 link_properties_set(struct rte_eth_dev *bonded_eth_dev,
 195                 struct rte_eth_link *slave_dev_link);
 196 void
 197 link_properties_reset(struct rte_eth_dev *bonded_eth_dev);
 198
 199 int
 200 link_properties_valid(struct rte_eth_link *bonded_dev_link,
 201                 struct rte_eth_link *slave_dev_link);
 202
 203 int
 204 mac_address_set(struct rte_eth_dev *eth_dev, struct ether_addr *new_mac_addr);
 205
 206 int
 207 mac_address_get(struct rte_eth_dev *eth_dev, struct ether_addr *dst_mac_addr);
 208
 209 int
 210 mac_address_slaves_update(struct rte_eth_dev *bonded_eth_dev);
 211
 212 uint8_t
 213 number_of_sockets(void);
 214
 215 int
 216 bond_ethdev_mode_set(struct rte_eth_dev *eth_dev, int mode);
 217
 218 int
 219 slave_configure(struct rte_eth_dev *bonded_eth_dev,
 220                 struct rte_eth_dev *slave_eth_dev);
 221
 222 void
 223 slave_remove(struct bond_dev_private *internals,
 224                 struct rte_eth_dev *slave_eth_dev);
 225
 226 void
 227 slave_add(struct bond_dev_private *internals,
 228                 struct rte_eth_dev *slave_eth_dev);
 229
 230 uint16_t
 231 xmit_l2_hash(const struct rte_mbuf *buf, uint8_t slave_count);
 232
 233 uint16_t
 234 xmit_l23_hash(const struct rte_mbuf *buf, uint8_t slave_count);
 235
 236 uint16_t
 237 xmit_l34_hash(const struct rte_mbuf *buf, uint8_t slave_count);
 238
 239 void
 240 bond_ethdev_primary_set(struct bond_dev_private *internals,
 241                 uint8_t slave_port_id);
 242
 243 void
 244 bond_ethdev_lsc_event_callback(uint8_t port_id, enum rte_eth_event_type type,
 245                 void *param);
 246
 247 int
 248 bond_ethdev_parse_slave_port_kvarg(const char *key __rte_unused,
 249                 const char *value, void *extra_args);
 250
 251 int
 252 bond_ethdev_parse_slave_mode_kvarg(const char *key __rte_unused,
 253                 const char *value, void *extra_args);
 254
 255 int
 256 bond_ethdev_parse_socket_id_kvarg(const char *key __rte_unused,
 257                 const char *value, void *extra_args);
 258
 259 int
 260 bond_ethdev_parse_primary_slave_port_id_kvarg(const char *key __rte_unused,
 261                 const char *value, void *extra_args);
 262
 263 int
 264 bond_ethdev_parse_balance_xmit_policy_kvarg(const char *key __rte_unused,
 265                 const char *value, void *extra_args);
 266
 267 int
 268 bond_ethdev_parse_bond_mac_addr_kvarg(const char *key __rte_unused,
 269                 const char *value, void *extra_args);
 270
 271 int
 272 bond_ethdev_parse_time_ms_kvarg(const char *key __rte_unused,
 273                 const char *value, void *extra_args);
 274
 275 #endif