lib/librte_pmd_bond/rte_eth_bond.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_H_
  35 #define _RTE_ETH_BOND_H_
  36
  37 /**
  38  * @file rte_eth_bond.h
  39  *
  40  * RTE Link Bonding Ethernet Device
  41  * Link Bonding for 1GbE and 10GbE ports to allow the aggregation of multiple
  42  * (slave) NICs into a single logical interface. The bonded device processes
  43  * these interfaces based on the mode of operation specified and supported.
  44  * This implementation supports 4 modes of operation round robin, active backup
  45  * balance and broadcast. Providing redundant links, fault tolerance and/or
  46  * load balancing of network ports
  47  */
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 #include <rte_ether.h>
  54
  55 /* Supported modes of operation of link bonding library  */
  56
  57 #define BONDING_MODE_ROUND_ROBIN                (0)
  58 /**< Round Robin (Mode 0).
  59  * In this mode all transmitted packets will be balanced equally across all
  60  * active slaves of the bonded in a round robin fashion. */
  61 #define BONDING_MODE_ACTIVE_BACKUP              (1)
  62 /**< Active Backup (Mode 1).
  63  * In this mode all packets transmitted will be transmitted on the primary
  64  * slave until such point as the primary slave is no longer available and then
  65  * transmitted packets will be sent on the next available slaves. The primary
  66  * slave can be defined by the user but defaults to the first active slave
  67  * available if not specified. */
  68 #define BONDING_MODE_BALANCE                    (2)
  69 /**< Balance (Mode 2).
  70  * In this mode all packets transmitted will be balanced across the available
  71  * slaves using one of three available transmit policies - l2, l2+3 or l3+4.
  72  * See BALANCE_XMIT_POLICY macros definitions for further details on transmit
  73  * policies. */
  74 #ifdef RTE_MBUF_REFCNT
  75 #define BONDING_MODE_BROADCAST                  (3)
  76 /**< Broadcast (Mode 3).
  77  * In this mode all transmitted packets will be transmitted on all available
  78  * active slaves of the bonded. */
  79 #endif
  80 #define BONDING_MODE_8023AD                             (4)
  81 /**< 802.3AD (Mode 4).
  82  *
  83  * This mode provides auto negotiation/configuration
  84  * of peers and well as link status changes monitoring using out of band
  85  * LACP (link aggregation control protocol) messages. For further details of
  86  * LACP specification see the IEEE 802.3ad/802.1AX standards. It is also
  87  * described here
  88  * https://www.kernel.org/doc/Documentation/networking/bonding.txt.
  89  *
  90  * Important Usage Notes:
  91  * - for LACP mode to work the rx/tx burst functions must be invoked
  92  * at least once every 100ms, otherwise the out-of-band LACP messages will not
  93  * be handled with the expected latency and this may cause the link status to be
  94  * incorrectly marked as down or failure to correctly negotiate with peers.
  95  * - For optimal performance during initial handshaking the array of mbufs provided
  96  * to rx_burst should be at least 2 times the slave count size.
  97  *
  98  */
  99 /* Balance Mode Transmit Policies */
 100 #define BALANCE_XMIT_POLICY_LAYER2              (0)
 101 /**< Layer 2 (Ethernet MAC) */
 102 #define BALANCE_XMIT_POLICY_LAYER23             (1)
 103 /**< Layer 2+3 (Ethernet MAC + IP Addresses) transmit load balancing */
 104 #define BALANCE_XMIT_POLICY_LAYER34             (2)
 105 /**< Layer 3+4 (IP Addresses + UDP Ports) transmit load balancing */
 106
 107 /**
 108  * Create a bonded rte_eth_dev device
 109  *
 110  * @param name                  Name of new link bonding device.
 111  * @param mode                  Mode to initialize bonding device in.
 112  * @param socket_id             Socket Id on which to allocate eth_dev resources.
 113  *
 114  * @return
 115  *      Port Id of created rte_eth_dev on success, negative value otherwise
 116  */
 117 int
 118 rte_eth_bond_create(const char *name, uint8_t mode, uint8_t socket_id);
 119
 120 /**
 121  * Add a rte_eth_dev device as a slave to the bonded device
 122  *
 123  * @param bonded_port_id        Port ID of bonded device.
 124  * @param slave_port_id         Port ID of slave device.
 125  *
 126  * @return
 127  *      0 on success, negative value otherwise
 128  */
 129 int
 130 rte_eth_bond_slave_add(uint8_t bonded_port_id, uint8_t slave_port_id);
 131
 132 /**
 133  * Remove a slave rte_eth_dev device from the bonded device
 134  *
 135  * @param bonded_port_id        Port ID of bonded device.
 136  * @param slave_port_id         Port ID of slave device.
 137  *
 138  * @return
 139  *      0 on success, negative value otherwise
 140  */
 141 int
 142 rte_eth_bond_slave_remove(uint8_t bonded_port_id, uint8_t slave_port_id);
 143
 144 /**
 145  * Set link bonding mode of bonded device
 146  *
 147  * @param bonded_port_id        Port ID of bonded device.
 148  * @param mode                          Bonding mode to set
 149  *
 150  * @return
 151  *      0 on success, negative value otherwise
 152  */
 153 int
 154 rte_eth_bond_mode_set(uint8_t bonded_port_id, uint8_t mode);
 155
 156 /**
 157  * Get link bonding mode of bonded device
 158  *
 159  * @param bonded_port_id        Port ID of bonded device.
 160  *
 161  * @return
 162  *      link bonding mode on success, negative value otherwise
 163  */
 164 int
 165 rte_eth_bond_mode_get(uint8_t bonded_port_id);
 166
 167 /**
 168  * Set slave rte_eth_dev as primary slave of bonded device
 169  *
 170  * @param bonded_port_id        Port ID of bonded device.
 171  * @param slave_port_id         Port ID of slave device.
 172  *
 173  * @return
 174  *      0 on success, negative value otherwise
 175  */
 176 int
 177 rte_eth_bond_primary_set(uint8_t bonded_port_id, uint8_t slave_port_id);
 178
 179 /**
 180  * Get primary slave of bonded device
 181  *
 182  * @param bonded_port_id        Port ID of bonded device.
 183  *
 184  * @return
 185  *      Port Id of primary slave on success, -1 on failure
 186  */
 187 int
 188 rte_eth_bond_primary_get(uint8_t bonded_port_id);
 189
 190 /**
 191  * Populate an array with list of the slaves port id's of the bonded device
 192  *
 193  * @param bonded_port_id        Port ID of bonded eth_dev to interrogate
 194  * @param slaves                        Array to be populated with the current active slaves
 195  * @param len                           Length of slaves array
 196  *
 197  * @return
 198  *      Number of slaves associated with bonded device on success,
 199  *      negative value otherwise
 200  */
 201 int
 202 rte_eth_bond_slaves_get(uint8_t bonded_port_id, uint8_t slaves[], uint8_t len);
 203
 204 /**
 205  * Populate an array with list of the active slaves port id's of the bonded
 206  * device.
 207  *
 208  * @param bonded_port_id        Port ID of bonded eth_dev to interrogate
 209  * @param slaves                        Array to be populated with the current active slaves
 210  * @param len                           Length of slaves array
 211  *
 212  * @return
 213  *      Number of active slaves associated with bonded device on success,
 214  *      negative value otherwise
 215  */
 216 int
 217 rte_eth_bond_active_slaves_get(uint8_t bonded_port_id, uint8_t slaves[],
 218                 uint8_t len);
 219
 220 /**
 221  * Set explicit MAC address to use on bonded device and it's slaves.
 222  *
 223  * @param bonded_port_id        Port ID of bonded device.
 224  * @param mac_addr                      MAC Address to use on bonded device overriding
 225  *                                                      slaves MAC addresses
 226  *
 227  * @return
 228  *      0 on success, negative value otherwise
 229  */
 230 int
 231 rte_eth_bond_mac_address_set(uint8_t bonded_port_id,
 232                 struct ether_addr *mac_addr);
 233
 234 /**
 235  * Reset bonded device to use MAC from primary slave on bonded device and it's
 236  * slaves.
 237  *
 238  * @param bonded_port_id        Port ID of bonded device.
 239  *
 240  * @return
 241  *      0 on success, negative value otherwise
 242  */
 243 int
 244 rte_eth_bond_mac_address_reset(uint8_t bonded_port_id);
 245
 246 /**
 247  * Set the transmit policy for bonded device to use when it is operating in
 248  * balance mode, this parameter is otherwise ignored in other modes of
 249  * operation.
 250  *
 251  * @param bonded_port_id        Port ID of bonded device.
 252  * @param policy                        Balance mode transmission policy.
 253  *
 254  * @return
 255  *      0 on success, negative value otherwise.
 256  */
 257 int
 258 rte_eth_bond_xmit_policy_set(uint8_t bonded_port_id, uint8_t policy);
 259
 260 /**
 261  * Get the transmit policy set on bonded device for balance mode operation
 262  *
 263  * @param bonded_port_id        Port ID of bonded device.
 264  *
 265  * @return
 266  *      Balance transmit policy on success, negative value otherwise.
 267  */
 268 int
 269 rte_eth_bond_xmit_policy_get(uint8_t bonded_port_id);
 270
 271 /**
 272  * Set the link monitoring frequency (in ms) for monitoring the link status of
 273  * slave devices
 274  *
 275  * @param bonded_port_id        Port ID of bonded device.
 276  * @param internal_ms           Monitoring interval in milliseconds
 277  *
 278  * @return
 279  *      0 on success, negative value otherwise.
 280  */
 281
 282 int
 283 rte_eth_bond_link_monitoring_set(uint8_t bonded_port_id, uint32_t internal_ms);
 284
 285 /**
 286  * Get the current link monitoring frequency (in ms) for monitoring of the link
 287  * status of slave devices
 288  *
 289  * @param bonded_port_id        Port ID of bonded device.
 290  *
 291  * @return
 292  *      Monitoring interval on success, negative value otherwise.
 293  */
 294 int
 295 rte_eth_bond_link_monitoring_get(uint8_t bonded_port_id);
 296
 297
 298 /**
 299  * Set the period in milliseconds for delaying the disabling of a bonded link
 300  * when the link down status has been detected
 301  *
 302  * @param bonded_port_id        Port ID of bonded device.
 303  * @param delay_ms                      Delay period in milliseconds.
 304  *
 305  * @return
 306  *  0 on success, negative value otherwise.
 307  */
 308 int
 309 rte_eth_bond_link_down_prop_delay_set(uint8_t bonded_port_id, uint32_t delay_ms);
 310
 311 /**
 312  * Get the period in milliseconds set for delaying the disabling of a bonded
 313  * link when the link down status has been detected
 314  *
 315  * @param bonded_port_id        Port ID of bonded device.
 316  *
 317  * @return
 318  *  Delay period on success, negative value otherwise.
 319  */
 320 int
 321 rte_eth_bond_link_down_prop_delay_get(uint8_t bonded_port_id);
 322
 323 /**
 324  * Set the period in milliseconds for delaying the enabling of a bonded link
 325  * when the link up status has been detected
 326  *
 327  * @param bonded_port_id        Port ID of bonded device.
 328  * @param delay_ms                      Delay period in milliseconds.
 329  *
 330  * @return
 331  *  0 on success, negative value otherwise.
 332  */
 333 int
 334 rte_eth_bond_link_up_prop_delay_set(uint8_t bonded_port_id, uint32_t delay_ms);
 335
 336 /**
 337  * Get the period in milliseconds set for delaying the enabling of a bonded
 338  * link when the link up status has been detected
 339  *
 340  * @param bonded_port_id        Port ID of bonded device.
 341  *
 342  * @return
 343  *  Delay period on success, negative value otherwise.
 344  */
 345 int
 346 rte_eth_bond_link_up_prop_delay_get(uint8_t bonded_port_id);
 347
 348
 349 #ifdef __cplusplus
 350 }
 351 #endif
 352
 353 #endif